aasm_rbs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a7a8d08d3f0fc893a4c567028f4580fb8c16bd34855d7a852acfa72e4af9cd
-  data.tar.gz: 338bc773165c1d7d198fdb757c721bdb4b9729069537df45a69339adfaa5da22
+  metadata.gz: 5ddfc302bf61720f7444bbd35a41071341e1bccf688c1c2132c3e87545360125
+  data.tar.gz: d4b4678955f896fef85efd6d9011563df8f09c79d36e84979f22d4f009a226ec
 SHA512:
-  metadata.gz: a2fa51357cfd06f334f3a10b331db7cf603ee06cb444e34aac5b3d8b6194a746b4e6b688cce6a4c07ebe541ab68cf3704c9e9fef329095c2ec88705816dea0f3
-  data.tar.gz: 8b293ace47666124f8159ffa56f0d40ab50f8ac0c844230d98c53293b074da923ada7bcd3639f5037452f45f81d68cca5910e2353289c81ed2feaae594a4b3e0
+  metadata.gz: fb93b9cf0fa7a90dc315ebcf13d48cab132539f01cd4235784e16224a6ea6fe8dd72834e083f561e54d341399d00647ccb11305d18ce7a4c7e3dd7a4a6588566
+  data.tar.gz: a0488476811cd0bcc2a1aefddd06c96a34ade62c8aeb797d8df7aea13354111b72f8a002a0a91a612015376010f2332217408513123658bcc55967f54b45b9ae

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

data/lib/aasm_rbs/version.rb

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

data/lib/aasm_rbs.rb

@@ -3,6 +3,24 @@
 require_relative 'aasm_rbs/output'
 
 module AasmRbs
+  def self.load_constants(klass_name)
+    load './Rakefile' if File.exist?('./Rakefile')
+    begin
+      Rake::Task[:environment].invoke
+    rescue StandardError
+      nil
+    end
+    return if defined?(Rails)
+
+    # not in a Rails project, load the file manually
+    file = Dir.pwd + "/lib/#{klass_name.split('::').join('/').downcase}"
+    begin
+      require file
+    rescue LoadError
+      abort 'There was a problem loading the class file'
+    end
+  end
+
   def self.run(klass_name)
     klass = Object.const_get(klass_name)
     states = klass.aasm.states.map(&:name)

data/sig/aasm_rbs.rbs

@@ -1,4 +1,7 @@
 module AasmRbs
+  Rake: untyped # there is yet no Rake official RBS
+
+  def self.load_constants: (String) -> void
   def self.run: (String) -> String?
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aasm_rbs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lorenzo Zabot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm