aasm_rbs 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fbdb030fb9e8f7ad127801029354cde4f093b439a79a6ee6f6e34ecf434c743
-  data.tar.gz: 94313e1c7b7d87c81a3cb60707828bfe29e0d1b912f99f23e57371e7afaff250
+  metadata.gz: d13405faad77a8c8a21b0ee27b74c3b57acfc470c444ceed6c485421607a13b3
+  data.tar.gz: 9578eea618f8dc30c6164f90712435b616562bb2af422db57b951d792a2f07f8
 SHA512:
-  metadata.gz: 3cef3ef97abc72ae1d60fafe2fc0eb8161a833f1178ca0bb394a5171b54f98fa30373c4b369cec0326730bc578cc549d5b588766fd4a985d346801cf81171fe9
-  data.tar.gz: 670b68f23ab091ab8d48789c793b8abd337621f92cf1e1e9037bdaa7dc229c40aaba5e2630923362ed65831da6143f62acc2117088d1be01a4538f0238a4b9a8
+  metadata.gz: f3a0b8d07358a4381579f2e5a42c6b2c633c73263a8cc0b7cc23de615e343c2cb1ea99ea1470e1a9a062e50e16584fed392aa67a268e8fe3aa38f04f3e572043
+  data.tar.gz: 7c84da47ecb1afc0b4443c13628e2ceb0efff26038d2e5fde2602dffa3a001c38da9c31a6675a0d62124d576f95b888c924ea51ffee5aac06925054fe76d722a

data/README.md

@@ -1,4 +1,7 @@
 # AASM RBS Generator
+
+[![Gem Version](https://badge.fury.io/rb/aasm_rbs.svg)](https://badge.fury.io/rb/aasm_rbs) [![Gem Downloads](https://badgen.net/rubygems/dt/aasm_rbs)](https://rubygems.org/gems/aasm_rbs) [![Linters](https://github.com/Uaitt/aasm_rbs/actions/workflows/linters.yml/badge.svg)](https://github.com/Uaitt/aasm_rbs/actions/workflows/linters.yml) [![Specs](https://github.com/Uaitt/aasm_rbs/actions/workflows/specs.yml/badge.svg)](https://github.com/Uaitt/aasm_rbs/actions/workflows/specs.yml)
+
 Easily generate RBS signatures for all the AASM automatically generated methods and constants of your ruby classes.
 
 ## Description
@@ -26,11 +29,30 @@ gem 'aasm_rbs'
 Then, execute `bundle install` in order to load the gem's code.
 
 ## Usage
+At the moment AASM RBS only supports pure-ruby projects or Rails applications.
+
+This gem assumes that your project is arranged with a traditional structure:
+- If dealing with a Rails app, your classes should be in any folder nested inside of `app/` or `lib/`
+- If dealing with a Ruby project, your actual classes should go inside of `lib/` and arranged as:
+  ```
+  lib/
+  ├── foo/
+  │   ├── bar.rb # contains Foo::Bar
+  │   ├── baz.rb # contains Foo::Baz
+  │── foo.rb # contains Foo
+  ```
+
+For more information about how to structure your projects, take a look at the following articles:
+- [Autoloading and reloading constants](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html) from the Rails guides
+- [Exploring the structure of a Ruby gem](https://www.cloudbees.com/blog/exploring-structure-ruby-gems) fantastic article from cloudbees (a little bit old but still relevant)
+
 Generating the RBS signatures is as easy as launching the following command from the command-line:
 ```
-bundle exec aasm_rbs ClassName
+bundle exec aasm_rbs Namespace::ClassName
 ```
 
+If your class is namespaced inside of other modules/classes, please pass the whole name as you see in the previous command to AASM RBS or it won't be able to infer the path.
+
 The generated signatures will appear in `stdout`.
 
 

data/exe/aasm_rbs

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 
 unless File.exist?('./Rakefile') || File.exist?('./Gemfile')
-  abort 'Please run aasm_rbs from the project root.'
+  abort('Please run aasm_rbs from the project root.')
 end
 
 require_relative '../lib/aasm_rbs'
 
-AasmRbs.load_constants(ARGV[0])
+AasmRbs.load_constants(ARGV[0] || '')
 
 $stdout.puts ''
 $stdout.puts AasmRbs.run(ARGV[0] || '')

data/lib/aasm_rbs/output.rb

@@ -2,17 +2,17 @@
 
 module AasmRbs
   class Output
+    attr_reader :data
+
     def initialize(klass)
       @klass = klass
       superclass = klass.superclass == Object ? nil : " < #{klass.superclass}"
       self.data = "class #{klass}#{superclass}\n"
     end
 
-    def add_states(states)
+    def add_states(states, opts = {})
       add_state_constants(states)
-      create_scopes = klass.aasm.state_machine.config.create_scopes
-      active_record_model = klass.respond_to?(:aasm_create_scope)
-      add_state_scopes(states) if active_record_model && create_scopes
+      add_state_scopes(states) if opts[:scopes]
       add_predicate_states_methods(states)
     end
 
@@ -25,6 +25,16 @@ module AasmRbs
       end
     end
 
+    def add_active_record_relation
+      self.data += <<-RBS
+  class ActiveRecord_Relation < ::ActiveRecord::Relation
+    include GeneratedRelationMethods
+    include _ActiveRecord_Relation[#{klass}, Integer]
+    include Enumerable[#{klass}]
+  end
+      RBS
+    end
+
     def new_line
       self.data += "\n"
     end
@@ -36,20 +46,21 @@ module AasmRbs
     private
 
     attr_reader :klass
-    attr_accessor :data
+    attr_writer :data
 
     def add_state_constants(states)
       states.each { |state| self.data += "  STATE_#{state.upcase}: String\n" }
-      self.data += "\n"
+      new_line
     end
 
     def add_state_scopes(states)
-      states.each { |state| self.data += "  def self.#{state}: () -> ::ActiveRecord_Relation\n" }
-      self.data += "\n"
+      states.each { |state| self.data += "  def self.#{state}: () -> ActiveRecord_Relation\n" }
+      new_line
     end
 
     def add_predicate_states_methods(states)
       states.each { |state| self.data += "  def #{state}?: () -> bool\n" }
+      new_line
     end
   end
 end

data/lib/aasm_rbs/version.rb

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

data/lib/aasm_rbs.rb

@@ -4,7 +4,7 @@ require_relative 'aasm_rbs/output'
 
 module AasmRbs
   def self.load_constants(klass_name)
-    load './Rakefile' if File.exist?('./Rakefile')
+    load('./Rakefile') if File.exist?('./Rakefile')
     begin
       Rake::Task[:environment].invoke
     rescue StandardError
@@ -17,21 +17,26 @@ module AasmRbs
     begin
       require file
     rescue LoadError
-      abort puts 'There was a problem loading the class file'
+      abort('There was a problem loading the class file.')
     end
   end
 
-  def self.run(klass_name)
+  def self.run(klass_name, opts = {})
     klass = Object.const_get(klass_name)
+    output = Output.new(klass)
+
     states = klass.aasm.states.map(&:name)
     events = klass.aasm.events.map(&:name)
 
-    output = Output.new(klass)
-    output.add_states(states)
-    output.new_line
+    create_scopes = klass.aasm.state_machine.config.create_scopes
+    active_record_model = klass.respond_to?(:aasm_create_scope)
+    opts[:scopes] = true if create_scopes && active_record_model
+
+    output.add_states(states, opts)
     output.add_events(events)
+    output.new_line && output.add_active_record_relation if opts[:scopes]
     output.finalize
   rescue StandardError
-    print "aasm_rbs received an invalid class name."
+    abort('aasm_rbs received an invalid class name.')
   end
 end

data/sig/aasm_rbs/output.rbs

@@ -1,9 +1,12 @@
 module AasmRbs
   class Output
-    def initialize: (Class) -> String
+    attr_reader data: String
 
-    def add_states: (Array[String]) -> Array[String]
-    def add_events: (Array[String]) -> Array[String]
+    def initialize: (Class klass) -> String
+
+    def add_states: (Array[String] states, ?::Hash[untyped, untyped] opts) -> String
+    def add_events: (Array[String] events) -> Array[String]
+    def add_active_record_relation: () -> String
 
     def new_line: () -> String
     def finalize: () -> String
@@ -11,10 +14,10 @@ module AasmRbs
     private
 
     attr_reader klass: Class
-    attr_accessor data: String
+    attr_writer data: String
 
-    def add_state_constants: (Array[String]) -> String
-    def add_state_scopes: (Array[String]) -> String
-    def add_predicate_states_methods: (Array[String]) -> Array[String]
+    def add_state_constants: (Array[String] states) -> String
+    def add_state_scopes: (Array[String] states) -> String
+    def add_predicate_states_methods: (Array[String] states) -> String
   end
 end

data/sig/aasm_rbs.rbs

@@ -1,5 +1,8 @@
 module AasmRbs
-  def self.run: (String) -> String?
+  Rake: untyped # there is yet no Rake official RBS
+
+  def self.load_constants: (String klass_name) -> void
+  def self.run: (String klass_name, ?::Hash[untyped, untyped] opts) -> String?
 end
 
 # There are yet no official RBS signatures for the AASM module that gets

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aasm_rbs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Lorenzo Zabot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -67,5 +67,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: AASM RBS
+summary: RBS signatures for AASM classes
 test_files: []