Merge pull request #423 from ignacio-chiazzo/rakefile-setup

Add rake tests and linter tasks

Author: alexrudall

README.md

@@ -12,47 +12,50 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
 
 # Table of Contents
 
-- [Installation](#installation)
-  - [Bundler](#bundler)
-  - [Gem Install](#gem-install)
-- [Usage](#usage)
-  - [Quickstart](#quickstart)
-  - [With Config](#with-config)
-  - [Custom timeout or base URI](#custom-timeout-or-base-uri)
-  - [Extra Headers per Client](#extra-headers-per-client)
-  - [Verbose Logging](#verbose-logging)
-  - [Azure](#azure)
-- [Counting Tokens](#counting-tokens)
-- [Models](#models)
-- [Chat](#chat)
-  - [Streaming Chat](#streaming-chat)
-- [Vision](#vision)
-- [JSON Mode](#json-mode)
-- [Functions](#functions)
-- [Edits](#edits)
-- [Embeddings](#embeddings)
-- [Files](#files)
-- [Finetunes](#finetunes)
-- [Assistants](#assistants)
-- [Threads and Messages](#threads-and-messages)
-- [Runs](#runs)
-  - [Runs involving function tools](#runs-involving-function-tools)
-- [Image Generation](#image-generation)
-  - [DALL·E 2](#dalle-2)
-  - [DALL·E 3](#dalle-3)
-- [Image Edit](#image-edit)
-- [Image Variations](#image-variations)
-- [Moderations](#moderations)
-- [Whisper](#whisper)
-  - [Translate](#translate)
-  - [Transcribe](#transcribe)
-  - [Speech](#speech)
-- [Errors](#errors)
-- [Development](#development)
-- [Release](#release)
-- [Contributing](#contributing)
-- [License](#license)
-- [Code of Conduct](#code-of-conduct)
+- [Ruby OpenAI](#ruby-openai)
+- [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+    - [Bundler](#bundler)
+    - [Gem install](#gem-install)
+  - [Usage](#usage)
+    - [Quickstart](#quickstart)
+    - [With Config](#with-config)
+      - [Custom timeout or base URI](#custom-timeout-or-base-uri)
+      - [Extra Headers per Client](#extra-headers-per-client)
+      - [Verbose Logging](#verbose-logging)
+      - [Azure](#azure)
+    - [Counting Tokens](#counting-tokens)
+    - [Models](#models)
+      - [Examples](#examples)
+    - [Chat](#chat)
+      - [Streaming Chat](#streaming-chat)
+      - [Vision](#vision)
+      - [JSON Mode](#json-mode)
+    - [Functions](#functions)
+    - [Edits](#edits)
+    - [Embeddings](#embeddings)
+    - [Files](#files)
+    - [Finetunes](#finetunes)
+    - [Assistants](#assistants)
+    - [Threads and Messages](#threads-and-messages)
+    - [Runs](#runs)
+      - [Runs involving function tools](#runs-involving-function-tools)
+    - [Image Generation](#image-generation)
+      - [DALL·E 2](#dalle-2)
+      - [DALL·E 3](#dalle-3)
+    - [Image Edit](#image-edit)
+    - [Image Variations](#image-variations)
+    - [Moderations](#moderations)
+    - [Whisper](#whisper)
+      - [Translate](#translate)
+      - [Transcribe](#transcribe)
+      - [Speech](#speech)
+    - [Errors](#errors)
+  - [Development](#development)
+  - [Release](#release)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -839,9 +842,10 @@ After checking out the repo, run `bin/setup` to install dependencies. You can ru
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-### Warning
+To run all tests, execute the command `bundle exec rake`, which will also run the linter (Rubocop). This repository uses [VCR](https://github.com/vcr/vcr) to log API requests.
 
-If you have an `OPENAI_ACCESS_TOKEN` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
+> [!WARNING]
+> If you have an `OPENAI_ACCESS_TOKEN` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
 
 ## Release
 

Rakefile

@@ -1,6 +1,19 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :default do
+  Rake::Task["test"].invoke
+  Rake::Task["lint"].invoke
+end
+
+task :test do
+  Rake::Task["spec"].invoke
+end
+
+task :lint do
+  RuboCop::RakeTask.new(:rubocop)
+  Rake::Task["rubocop"].invoke
+end