rbs_goose 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf73d7a4ddd606fd157daf05a360724de91c45167bc05a3e170a5eb0c98630ad
-  data.tar.gz: 62bd3b303be0b22fe0b5c1dfc470035e80e7494072abca2a3c2da460c0edffed
+  metadata.gz: bfba03266529804e3cd1123057d193e3362495c21686f596d6e88acd48da4862
+  data.tar.gz: b118cb15e016f8a678410df2b36c7e4079fecceebb512491935320197e193e32
 SHA512:
-  metadata.gz: d011a72db8c5ba4d9823cf5e4af4fd6aa17c72b0fca9e9984da237697329b113d132e87a446f7e988a6858520066a297d008072d4dc82add618008fd89f4350b
-  data.tar.gz: 19e5c359436f5aee963abf6406dac507a6047fd008b045833d688efda26cc681a9ebc759f3a16787850db20de55290dca09325b6ea4ac3fa4704ea100624e353
+  metadata.gz: bba1f1b303559ea88caa1899b66875139add68526b9d4236c56b8562fd32fac460711ed5e51354ef1df7b3ac5fb962a34868cafaa4d603d35bcfd753deb3bc48
+  data.tar.gz: 2267ed274906716dfa4e7234ac7c1dfe9d633d8f0308b9311d6545d280085a82392a6fe2154de2763298b66a2d6f89963cdeeade666c2590c58aea46e39711a2

data/Gemfile

@@ -14,7 +14,7 @@ gem 'rubocop', '~> 1.21'
 gem 'rubocop-factory_bot', '~> 2.25.1'
 gem 'rubocop-rake', '~> 0.6.0'
 gem 'rubocop-rspec', '~> 2.22'
-gem 'ruby-openai', '~> 6.1.0'
+gem 'ruby-openai', '~> 6.3.0'
 gem 'steep', '~> 1.6.0'
 gem 'vcr', '~> 6.2.0'
-gem 'webmock', '~> 3.18.1'
+gem 'webmock', '~> 3.19.0'

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    rbs_goose (0.1.0)
-      langchainrb (~> 0.8.2)
-      ruby-openai (~> 6.1.0)
+    rbs_goose (0.1.1)
+      langchainrb (>= 0.8.2, < 1.0.0)
+      ruby-openai (>= 6.1.0, < 7.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     abbrev (0.1.2)
-    activesupport (7.1.2)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -19,37 +19,38 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.4)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     baran (0.1.10)
     base64 (0.2.0)
-    bigdecimal (3.1.5)
+    bigdecimal (3.1.6)
     colorize (0.8.1)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    crack (0.4.5)
+    crack (0.4.6)
+      bigdecimal
       rexml
     csv (3.2.8)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
     drb (2.2.0)
       ruby2_keywords
-    event_stream_parser (0.3.0)
-    factory_bot (6.4.5)
+    event_stream_parser (1.0.0)
+    factory_bot (6.4.6)
       activesupport (>= 5.0.0)
-    faraday (2.7.9)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.0.2)
+    faraday-net_http (3.1.0)
+      net-http
     ffi (1.16.3)
     fileutils (1.7.2)
-    hashdiff (1.0.1)
+    hashdiff (1.1.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
+    json (2.7.1)
     json-schema (4.0.0)
       addressable (>= 2.8)
     langchainrb (0.8.2)
@@ -67,29 +68,31 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.6.0)
     matrix (0.4.2)
-    minitest (5.21.1)
+    minitest (5.21.2)
     multipart-post (2.3.0)
     mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
     orthoses (1.13.0)
       rbs (~> 3.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pragmatic_segmenter (0.3.23)
       unicode
-    public_suffix (5.0.1)
-    racc (1.7.1)
+    public_suffix (5.0.4)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rb_sys (0.9.86)
     rbs (3.4.1)
       abbrev
-    regexp_parser (2.8.1)
-    rexml (3.2.5)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -103,31 +106,31 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.53.1)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.22.0)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
-    ruby-openai (6.1.0)
-      event_stream_parser (>= 0.3.0, < 1.0.0)
+    ruby-openai (6.3.1)
+      event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
     ruby-progressbar (1.13.0)
@@ -157,9 +160,10 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode (0.4.4.4)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
     vcr (6.2.0)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -181,10 +185,10 @@ DEPENDENCIES
   rubocop-factory_bot (~> 2.25.1)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.22)
-  ruby-openai (~> 6.1.0)
+  ruby-openai (~> 6.3.0)
   steep (~> 1.6.0)
   vcr (~> 6.2.0)
-  webmock (~> 3.18.1)
+  webmock (~> 3.19.0)
 
 BUNDLED WITH
    2.4.10

data/README-EN-US.md

@@ -5,40 +5,47 @@
 [![en-US README](https://img.shields.io/badge/Multilingual_README-en--US-blue.svg)](/README-EN-US.md)
 [![en-JP README](https://img.shields.io/badge/Multilingual_README-ja--JP-orangered.svg)](/README.md)
 
-[![Ruby](https://github.com/kokuyouwind/rbs_goose/actions/workflows/main.yml/badge.svg)](https://github.com/kokuyouwind/rbs_goose/) actions/workflows/main.yml)
+[![Ruby](https://github.com/kokuyouwind/rbs_goose/actions/workflows/main.yml/badge.svg)](https://github.com/kokuyouwind/rbs_goose/actions/workflows/main.yml)
 
 RBS Goose is a tool that uses ChatGPT and other large language models to infer the RBS signature of Ruby code.
 
-> [!CAUTION].
+> [!CAUTION]
 > Currently undergoing technical validation, so you may get little or no output of the appropriate types.
 > Also, the tool uses ChatGPT API and other tools to infer RBS signatures, so depending on the size of your code, the usage fee may be expensive.
 
 ## Installation
 
 ```bash
-$ gem install rbs-goose
+$ gem install rbs_goose
+## Depending on the LangChain LLM you are using, install the corresponding gem
+$ gem install ruby-openai
 ```
 
 If you use `bundler`, add the following to your `Gemfile` instead.
 
 ```ruby
-gem 'rbs-goose'.
+gem 'rbs_goose'.
+# Depending on your LangChain LLM, install the corresponding gem
+gem 'ruby-openai'
 ```
 
 ## Usage
 
-Currently, the command line tool is not yet available, so please call `RbsGoose.run` directly from `Rakefile` or other sources.
+Currently, command line tools are not yet available, so please call `RbsGoose.run` directly from `Rakefile` or other sources.
 
 If you use [OpenAI API](https://openai.com/blog/openai-api), do the following.
 
 ```ruby
-  desc 'refine RBS files in sig directory'
-  task :refine do
-    RbsGoose.configure do |c|
-      c.use_open_ai(ENV.fetch('OPENAI_ACCESS_TOKEN'))
-    end
-    RbsGoose.run
+require 'rbs_goose'
+require 'openai'
+
+desc 'refine RBS files in sig directory' ```ruby require 'rbs_goose' require 'openai'
+task :refine do
+  RbsGoose.configure do |c|
+    c.use_open_ai(ENV.fetch('OPENAI_ACCESS_TOKEN'))
   end
+  RbsGoose.run
+end
 ```
 
 Running this task will reference the Ruby code under `lib` and the RBS signature under `sig` and override the guessed signature.

data/README.md

@@ -16,13 +16,17 @@ RBS Goose は ChatGPT などの大規模言語モデルを利用して、 Ruby
 ## Installation
 
 ```bash
-$ gem install rbs-goose
+$ gem install rbs_goose
+# 利用する LangChain LLM に応じて、対応する gem を合わせてインストールします
+$ gem install ruby-openai
 ```
 
 `bundler` を利用する場合は、代わりに以下を `Gemfile` に追加してください。
 
 ```ruby
-gem 'rbs-goose'
+gem 'rbs_goose'
+# 利用する LangChain LLM に応じて、対応する gem を合わせてインストールします
+gem 'ruby-openai'
 ```
 
 ## Usage
@@ -32,13 +36,16 @@ gem 'rbs-goose'
 [OpenAI API](https://openai.com/blog/openai-api) を利用する場合は以下のようにします。
 
 ```ruby
-  desc 'refine RBS files in sig directory'
-  task :refine do
-    RbsGoose.configure do |c|
-      c.use_open_ai(ENV.fetch('OPENAI_ACCESS_TOKEN'))
-    end
-    RbsGoose.run
+require 'rbs_goose'
+require 'openai'
+
+desc 'refine RBS files in sig directory'
+task :refine do
+  RbsGoose.configure do |c|
+    c.use_open_ai(ENV.fetch('OPENAI_ACCESS_TOKEN'))
   end
+  RbsGoose.run
+end
 ```
 
 このタスクを実行すると、 `lib` 以下の Ruby コードと `sig` 以下の RBS シグニチャを参照し、推測したシグニチャを上書きします。

data/Rakefile

@@ -24,7 +24,7 @@ task :'spec:record' do
   Rake::Task['spec'].invoke
 end
 
-namespace :sig do # rubocop:disable Metrics/BlockLength
+namespace :sig do
   desc 'build RBS prototypes to sig directory'
   task :prototype do
     require 'orthoses'
@@ -49,12 +49,7 @@ namespace :sig do # rubocop:disable Metrics/BlockLength
     require_relative 'lib/rbs_goose'
 
     RbsGoose.configure do |c|
-      c.use_open_ai(
-        ENV.fetch('OPENAI_ACCESS_TOKEN'),
-        default_options: {
-          completion_model_name: 'gpt-3.5-turbo-1106'
-        }
-      )
+      c.use_open_ai(ENV.fetch('OPENAI_ACCESS_TOKEN'))
     end
     RbsGoose.run
   end

data/lib/rbs_goose/configuration.rb

@@ -18,8 +18,8 @@ module RbsGoose
       @llm = ::Langchain::LLM::OpenAI.new(
         api_key: open_ai_access_token,
         default_options: {
-          completion_model_name: 'gpt-3.5-turbo-0613',
-          chat_completion_model_name: 'gpt-3.5-turbo-0613'
+          completion_model_name: 'gpt-3.5-turbo-1106',
+          chat_completion_model_name: 'gpt-3.5-turbo-1106'
         }.merge(default_options)
       )
     end

data/lib/rbs_goose/examples/rbs_samples/lib/person.rb

@@ -8,6 +8,10 @@ class Person
     @contacts = []
   end
 
+  def name=(name)
+    @name = name
+  end
+
   def guess_country()
     contacts.map do |contact|
       case contact

data/lib/rbs_goose/examples/rbs_samples/refined/sig/person.rbs

@@ -9,5 +9,7 @@ class Person
 
   def initialize: (name: String) -> void
 
+  def name=: (String name) -> void
+
   def guess_country: () -> (String | nil)
 end

data/lib/rbs_goose/examples/rbs_samples/sig/person.rbs

@@ -9,5 +9,7 @@ class Person
 
   def initialize: (name: untyped) -> void
 
+  def name=: (untyped name) -> void
+
   def guess_country: () -> untyped
 end

data/lib/rbs_goose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RbsGoose
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rbs_goose
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kokuyouwind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: langchainrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 description: RBS type inferrer with LLM
 email:
 - kokuyouwind@gmail.com