rbs_rails 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb24ff75184c9065e46c16a3dc7b5822320255c0d7045ac82dae766b753c6638
-  data.tar.gz: 23ed2ffdbfe910c0140610016b2a6d7671a99a6bc72e569c03dfd77b9418e78f
+  metadata.gz: a7d71f04b224c69937d2e7c3fca24a085a5475ec09425baa810577d8dc403600
+  data.tar.gz: b5e4959c6afaf50ac5c9569cb095ef52eb4c54b38a48083337c177297afb05e2
 SHA512:
-  metadata.gz: 9f3c61ac885a8a3a8c607a9452ac21ce216a77aec13a84a2e77ec9285fdfcb4c7e43a6ff712825d538c297e29c611fad4978ef0cdebdca166c042dfb6cab8a2d
-  data.tar.gz: 2301cbe92bf518435e5f4323e3cc5bfbba5a4b01bfe6511916bdbfbb8f2a034421e41dc90f61035e8db8dad3bffc0108454ca62c7cf380edee967aa3ba35694e
+  metadata.gz: 3f23018664d11f5bd9a94451830f0370e5f295bb0571ae5fc7927d7e8afe05a697bc0f51be10794924001319b8440aa0ab7ef0381f8d0df811ef8135a1162dd3
+  data.tar.gz: 37725067cf0c61a72b173f7faad77381652f04a4f8948855c318d88022ae50b34cfb277369b3ca0bbb09c1be6be4fa553b1c40a8ae70acd52c5f2ab90237e933

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, '3.0', 3.1, head]
+        ruby: ['3.2', '3.3', '3.4', '4.0', head]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "lib/rbs_rails/version.rb"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0"
+          bundler-cache: true
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@v1

data/CHANGELOG.md

@@ -2,6 +2,70 @@
 
 ## master (unreleased)
 
+## 0.13
+
+### New features
+
+* Enable type generation for models with composite primary keys [#358](https://github.com/pocke/rbs_rails/pull/358)
+* Add optional arguments for column_changed? and column_previously_changed? [#357](https://github.com/pocke/rbs_rails/pull/357)
+* Check database migrations before generating types for models [#342](https://github.com/pocke/rbs_rails/pull/342)
+* Integrate model_dependencies.rbs to each model signatures [#345](https://github.com/pocke/rbs_rails/pull/345)
+* Do not update RBS file if the signature nothing changed [#346](https://github.com/pocke/rbs_rails/pull/346)
+* support alias attribute in enum definitions [#325](https://github.com/pocke/rbs_rails/pull/325)
+* active_record: Support #id_value alias for #id column [#350](https://github.com/pocke/rbs_rails/pull/350)
+* Allow overrides methods in subclasses [#317](https://github.com/pocke/rbs_rails/pull/317)
+* feat: Add command line interface for rbs_rails [#335](https://github.com/pocke/rbs_rails/pull/335)
+* feat: Display class name when RBS generation fails [#334](https://github.com/pocke/rbs_rails/pull/334)
+* Support no-arguments in create_** method for has_one associations [#333](https://github.com/pocke/rbs_rails/pull/333)
+* Add #{attribute}_before_type_cast and #{attribute}_for_database methods for attributes [#322](https://github.com/pocke/rbs_rails/pull/322)
+* Support has_and_belongs_to_many [#272](https://github.com/pocke/rbs_rails/pull/272)
+* Support special directory structures, such as when using packs-rails [#323](https://github.com/pocke/rbs_rails/pull/323)
+* enum: Support Rails 7 style enum definitions [#311](https://github.com/pocke/rbs_rails/pull/311)
+* add generate columns aliased by alias_attibute [#318](https://github.com/pocke/rbs_rails/pull/318)
+* Add additional enum methods [#312](https://github.com/pocke/rbs_rails/pull/312)
+* enum: Support array-style enum declarations [#310](https://github.com/pocke/rbs_rails/pull/310)
+* Support resolve-type-names header [#304](https://github.com/pocke/rbs_rails/pull/304)
+* Install _RbsRailsPathHelpers to ActionController::Base by default [#279](https://github.com/pocke/rbs_rails/pull/279)
+* Override types of CollectionProxy [#289](https://github.com/pocke/rbs_rails/pull/289)
+* path_helpers: Support Rails 8.0 [#283](https://github.com/pocke/rbs_rails/pull/283)
+* Reimplement enum inspector via spy  [#296](https://github.com/pocke/rbs_rails/pull/296)
+* generated rbs for activerecord models respects serialize (common cases) [#293](https://github.com/pocke/rbs_rails/pull/293)
+
+### Bug fixes
+
+* Avoid reusing the same object when generating attribute aliases [#361](https://github.com/pocke/rbs_rails/pull/361)
+* Use Prism instead of parser/current to suppress warnings [#362](https://github.com/pocke/rbs_rails/pull/362)
+* Fix: Ruby::UnresolvedOverloading error when calling ::ActiveRecord::Relation#select [#353](https://github.com/pocke/rbs_rails/pull/353)
+* CI: Fix broken testcases [#336](https://github.com/pocke/rbs_rails/pull/336)
+* fix: external library models not saved to correct path structure [#324](https://github.com/pocke/rbs_rails/pull/324)
+* Fix [#{](https://github.com/pocke/rbs_rails/pull/{)attribute}_before_type_cast and {#attribute}_for_database methods test #330
+* test: Adjust expectations for Blog model [#327](https://github.com/pocke/rbs_rails/pull/327)
+* Fix [#233](https://github.com/pocke/rbs_rails/pull/233): Support enum name including unexpected characters #285
+* test: Update db/schema.rb on test app [#307](https://github.com/pocke/rbs_rails/pull/307)
+* Fix [#277](https://github.com/pocke/rbs_rails/pull/277): CollectionProxy should include Enumerable explicitly #278
+
+### misc
+
+* CI: Hello Ruby 4.0! [#359](https://github.com/pocke/rbs_rails/pull/359)
+* deps: Drop Rails 6 support [#355](https://github.com/pocke/rbs_rails/pull/355)
+* test: Share build results across tests to reduce build times [#337](https://github.com/pocke/rbs_rails/pull/337)
+* CI: Add GitHub Actions workflow for releasing gem [#309](https://github.com/pocke/rbs_rails/pull/309)
+* test: Upgrade testing Rails app to 7.2  [#321](https://github.com/pocke/rbs_rails/pull/321)
+* Manage types of this gem using RBS::Inline [#300](https://github.com/pocke/rbs_rails/pull/300)
+* rake: Remove deprecated --silent option from rbs validate [#306](https://github.com/pocke/rbs_rails/pull/306)
+* CI: Test with ruby 3.4 💎 [#301](https://github.com/pocke/rbs_rails/pull/301)
+* sig: Remove sig/rake.rbs  [#295](https://github.com/pocke/rbs_rails/pull/295)
+* Add path helper method tests [#292](https://github.com/pocke/rbs_rails/pull/292)
+* deps: Add benchmark gem to test/app/Gemfile [#294](https://github.com/pocke/rbs_rails/pull/294)
+
+## 0.12.1
+
+* Drop support for old Rubies. [#284](https://github.com/pocke/rbs_rails/pull/284)
+* Make type names absolute to avoid referring to incorrect class. [#265](https://github.com/pocke/rbs_rails/pull/265)
+* Avoid to create directory on initialization. [#261](https://github.com/pocke/rbs_rails/pull/261)
+* Make `build_*` methods parameters optional. [#258](https://github.com/pocke/rbs_rails/pull/258)
+* Skip to define rake tasks when rbs_rails is not able to load. [#251](https://github.com/pocke/rbs_rails/pull/251)
+
 ## 0.12.0
 
 * Support RBS v3. [#246](https://github.com/pocke/rbs_rails/pull/246)

data/Gemfile

@@ -6,7 +6,13 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem "rake", "~> 13.0"
-gem 'rails', '< 7', '>= 6.0'
-gem 'rbs', '>= 2'
-gem 'steep'
+gem 'rails', '>= 7.0'
+gem 'rbs', '>= 3'
+gem 'rbs-inline', require: false
+gem 'steep', '>= 1.4', require: false
 gem 'minitest'
+gem 'minitest-hooks'
+
+# Temporary workaround for Ruby 4.1+ where tsort is no longer bundled.
+# Can be removed once rbs adds tsort as a runtime dependency.
+gem 'tsort'

data/Gemfile.lock

@@ -1,176 +1,249 @@
 PATH
   remote: .
   specs:
-    rbs_rails (0.12.0)
+    rbs_rails (0.13.0)
       parser
+      prism
       rbs (>= 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.5)
-      actionpack (= 6.1.5)
-      activesupport (= 6.1.5)
+    actioncable (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.5)
-      actionpack (= 6.1.5)
-      activejob (= 6.1.5)
-      activerecord (= 6.1.5)
-      activestorage (= 6.1.5)
-      activesupport (= 6.1.5)
-      mail (>= 2.7.1)
-    actionmailer (6.1.5)
-      actionpack (= 6.1.5)
-      actionview (= 6.1.5)
-      activejob (= 6.1.5)
-      activesupport (= 6.1.5)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.1.5)
-      actionview (= 6.1.5)
-      activesupport (= 6.1.5)
-      rack (~> 2.0, >= 2.0.9)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activestorage (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      mail (>= 2.8.0)
+    actionmailer (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      actionview (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.2.2.2)
+      actionview (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4, < 3.2)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.5)
-      actionpack (= 6.1.5)
-      activerecord (= 6.1.5)
-      activestorage (= 6.1.5)
-      activesupport (= 6.1.5)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activestorage (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.5)
-      activesupport (= 6.1.5)
+    actionview (7.2.2.2)
+      activesupport (= 7.2.2.2)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.5)
-      activesupport (= 6.1.5)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.2.2.2)
+      activesupport (= 7.2.2.2)
       globalid (>= 0.3.6)
-    activemodel (6.1.5)
-      activesupport (= 6.1.5)
-    activerecord (6.1.5)
-      activemodel (= 6.1.5)
-      activesupport (= 6.1.5)
-    activestorage (6.1.5)
-      actionpack (= 6.1.5)
-      activejob (= 6.1.5)
-      activerecord (= 6.1.5)
-      activesupport (= 6.1.5)
+    activemodel (7.2.2.2)
+      activesupport (= 7.2.2.2)
+    activerecord (7.2.2.2)
+      activemodel (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      timeout (>= 0.4.0)
+    activestorage (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
       marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (6.1.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (7.2.2.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.9)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
     crass (1.0.6)
-    erubi (1.10.0)
-    ffi (1.15.5)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.10.0)
+    csv (3.3.4)
+    date (3.4.1)
+    drb (2.2.3)
+    erubi (1.13.1)
+    ffi (1.17.2)
+    fileutils (1.7.3)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    language_server-protocol (3.16.0.3)
-    listen (3.7.1)
+    io-console (0.7.2)
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
+    listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.15.0)
+    logger (1.7.0)
+    loofah (2.24.1)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.15.0)
-    nio4r (2.5.8)
-    nokogiri (1.13.3)
-      mini_portile2 (~> 2.8.0)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
+    minitest (5.27.0)
+    minitest-hooks (1.5.2)
+      minitest (> 5.3)
+    mutex_m (0.3.0)
+    net-imap (0.5.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.9)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.1.5)
-      actioncable (= 6.1.5)
-      actionmailbox (= 6.1.5)
-      actionmailer (= 6.1.5)
-      actionpack (= 6.1.5)
-      actiontext (= 6.1.5)
-      actionview (= 6.1.5)
-      activejob (= 6.1.5)
-      activemodel (= 6.1.5)
-      activerecord (= 6.1.5)
-      activestorage (= 6.1.5)
-      activesupport (= 6.1.5)
+      racc
+    prism (1.2.0)
+    psych (5.1.2)
+      stringio
+    racc (1.8.1)
+    rack (3.1.18)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.0)
+      rack (>= 3)
+    rails (7.2.2.2)
+      actioncable (= 7.2.2.2)
+      actionmailbox (= 7.2.2.2)
+      actionmailer (= 7.2.2.2)
+      actionpack (= 7.2.2.2)
+      actiontext (= 7.2.2.2)
+      actionview (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activemodel (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activestorage (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
       bundler (>= 1.15.0)
-      railties (= 6.1.5)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.2.2.2)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (6.1.5)
-      actionpack (= 6.1.5)
-      activesupport (= 6.1.5)
-      method_source
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rb-fsevent (0.11.1)
-    rb-inotify (0.10.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rbs (2.2.2)
-    sprockets (4.0.3)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.4.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      sprockets (>= 3.0.0)
-    steep (0.49.1)
+    rbs (3.9.5)
+      logger
+    rbs-inline (0.11.0)
+      prism (>= 0.29, < 1.3)
+      rbs (>= 3.5.0)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.10)
+      io-console (~> 0.5)
+    securerandom (0.4.1)
+    steep (1.10.0)
       activesupport (>= 5.1)
-      language_server-protocol (>= 3.15, < 4.0)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.17.0.4, < 4.0)
       listen (~> 3.0)
-      parallel (>= 1.0.0)
-      parser (>= 3.0)
+      logger (>= 1.3.0)
+      mutex_m (>= 0.3.0)
+      parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.2.0)
-      terminal-table (>= 2, < 4)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
-    tzinfo (2.0.4)
+      rbs (~> 3.9)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 5)
+      uri (>= 0.12.0)
+    stringio (3.1.1)
+    strscan (3.1.4)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    websocket-driver (0.7.5)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.2.0)
+    uri (1.0.4)
+    useragent (0.16.11)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   minitest
-  rails (>= 6.0, < 7)
+  minitest-hooks
+  rails (>= 7.0)
   rake (~> 13.0)
-  rbs (>= 2)
+  rbs (>= 3)
+  rbs-inline
   rbs_rails!
-  steep
+  steep (>= 1.4)
+  tsort
 
 BUNDLED WITH
-   2.3.9
+   2.4.13

data/README.md

@@ -32,6 +32,18 @@ Then, the following three tasks are available.
 * `rbs_rails:generate_rbs_for_path_helpers`: Generate RBS files for path helpers
 * `rbs_rails:all`: Execute all tasks of RBS Rails
 
+You can also run rbs_rails from command line:
+
+```console
+# Generate all RBS files
+$ bundle exec rbs_rails all
+
+# Generate RBS files for models
+$ bundle exec rbs_rails models
+
+# Generate RBS files for path helpers
+$ bundle exec rbs_rails path_helpers
+```
 
 ### Install RBS for `rails` gem
 
@@ -41,9 +53,40 @@ You need to install `rails` gem's RBS files. I highly recommend using `rbs colle
 1. Then execute the following commands
    ```console
    $ bundle install
+   $ bundle exec rbs collection init
    $ bundle exec rbs collection install
    ```
 
+### Configuration
+
+You can customize the behavior of rbs_rails via configuration file. Place one of the following files in your project:
+
+* `.rbs_rails.rb` (in the project root)
+* `config/rbs_rails.rb`
+
+```ruby
+RbsRails.configure do |config|
+  # Specify the directory where RBS signatures will be generated
+  # Default: Rails.root.join("sig/rbs_rails")
+  config.signature_root_dir = "sig/rbs_rails"
+
+  # Enable or disable checking for database migrations.
+  # If enabled, rbs_rails stops to generate RBS files if database is not migrated to the latest version.
+  # Default: enabled
+  check_db_migrations = true
+
+  # Define which models should be ignored during generation
+  config.ignore_model_if do |klass|
+    # Example: Ignore test models
+    klass.name.start_with?("Test") ||
+    # Example: Ignore models in specific namespaces
+    klass.name.start_with?("Admin::") ||
+    # Example: Ignore models without database tables
+    !klass.table_exists?
+  end
+end
+```
+
 ### Steep integration
 
 Put the following code as `Steepfile`.
@@ -64,7 +107,10 @@ After checking out the repo, run `bin/setup` to install dependencies.
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+This gem uses [RBS::Inline](https://github.com/soutaro/rbs-inline) to generate RBS files.  Please mark up your code with RBS comments.
+And then, run `bundle exec rake rbs_update` to reflect the type definitions to the RBS files.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and push it to the GitHub (via Pull Request).  Then, GitHub Actions will automatically create a release tag and publish the gem to rubygems.org.
 
 ## Contributing
 

data/Rakefile

@@ -1,18 +1,23 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-task :default => [:rbs_validate, :steep, :test]
+task :default => [:rbs_update, :rbs_validate, :steep, :test]
 
 desc 'run Steep'
 task :steep do
   sh 'steep', 'check'
 end
 
+task :rbs_update do
+  rm_rf('sig/rbs_rails')
+  sh 'rbs-inline', '--opt-out', '--output=sig/', 'lib'
+end
+
 task :rbs_validate do
   repo = ENV['RBS_REPO_DIR']&.then do |env|
     "--repo=#{env}"
   end
-  sh "rbs #{repo} validate --silent"
+  sh "rbs #{repo} validate"
 end
 
 Rake::TestTask.new do |test|

data/Steepfile

@@ -1,7 +1,12 @@
+D = Steep::Diagnostic
 target :lib do
   signature "sig"
   signature 'assets/sig'
 
   check "lib"                       # Directory name
   repo_path ENV['RBS_REPO_DIR'] if ENV['RBS_REPO_DIR']
+
+  configure_code_diagnostics do |hash|
+    hash[D::Ruby::UnreachableBranch] = :information
+  end
 end

data/example/rbs_rails.rb

@@ -0,0 +1,27 @@
+# Example configuration file for rbs_rails
+#
+# Place this file in the root of your Rails project or in config/rbs_rails.rb
+
+RbsRails.configure do |config|
+  # Specify the directory where RBS signatures will be generated
+  # Default: Rails.root.join("sig/rbs_rails")
+  config.signature_root_dir = "sig/rbs_rails"
+
+  # Enable or disable checking for database migrations.
+  # If enabled, rbs_rails stops to generate RBS files if database is not migrated to the latest version.
+  # Default: enabled
+  check_db_migrations = true
+
+  # Define a proc to determine which models should be ignored during generation
+  # The proc receives a model class and should return true if the model should be ignored
+  config.ignore_model_if do |klass|
+    # Example: Ignore test models
+    klass.name.start_with?("Test") ||
+    # Example: Ignore models in the Admin namespace
+    klass.name.start_with?("Admin::") ||
+    # Example: Ignore models that are not backed by a database table
+    !klass.table_exists? ||
+    # Example: Ignore anonymous classes
+    klass.name.blank?
+  end
+end