aasm_rbs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87a7a8d08d3f0fc893a4c567028f4580fb8c16bd34855d7a852acfa72e4af9cd
+  data.tar.gz: 338bc773165c1d7d198fdb757c721bdb4b9729069537df45a69339adfaa5da22
+SHA512:
+  metadata.gz: a2fa51357cfd06f334f3a10b331db7cf603ee06cb444e34aac5b3d8b6194a746b4e6b688cce6a4c07ebe541ab68cf3704c9e9fef329095c2ec88705816dea0f3
+  data.tar.gz: 8b293ace47666124f8159ffa56f0d40ab50f8ac0c844230d98c53293b074da923ada7bcd3639f5037452f45f81d68cca5910e2353289c81ed2feaae594a4b3e0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Lorenzo Zabot
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# AASM RBS Generator
+Easily generate RBS signatures for all the AASM automatically generated methods and constants of your ruby classes.
+
+## Description
+If you have found this gem, you probably are adding a type system with RBS on top of your Ruby project or Rails application, and you are managing the state of some of your classes with the AASM gem.
+
+If you have no idea about what AASM is, I encourage you to take a look at their [README](https://github.com/aasm/aasm) first.
+
+You should now know that when you `include AASM` inside of a Ruby class and you define states, events and transitions, your classes will automatically get a few things, including:
+- a constant for every state
+- instance methods for every state
+- scopes for every state if the class is an `ActiveRecord` model and the [automatic scopes](https://github.com/aasm/aasm#automatic-scopes) feature was not disabled manually
+- instance methods for every event
+
+The problem is that when writing RBS you should write the signatures for the previous things one-by-one and it can get really frustrating/boring when dealing with large classes.
+
+With this small gem, you can now generate all those signatures automatically with a single command, and save time for doing something more meaningful.
+
+## Installation
+Add the following line to your application's `Gemfile` in the `development` group:
+
+```rb
+gem 'aasm_rbs'
+```
+
+Then, execute `bundle install` in order to load the gem's code.
+
+## Usage
+Generating the RBS signatures is as easy as launching the following command from the command-line:
+```
+bundle exec aasm_rbs ClassName
+```
+
+The generated signatures will appear in `stdout`.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/license/mit/).

data/exe/aasm_rbs

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/aasm_rbs'
+
+$stdout.puts ''
+$stdout.puts AasmRbs.run(ARGV[0] || '')
+$stdout.puts ''

data/lib/aasm_rbs/output.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module AasmRbs
+  class Output
+    def initialize(klass)
+      @klass = klass
+      superclass = klass.superclass == Object ? nil : " < #{klass.superclass}"
+      self.data = "class #{klass}#{superclass}\n"
+    end
+
+    def add_states(states)
+      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_predicate_states_methods(states)
+    end
+
+    def add_events(events)
+      events.each do |event|
+        self.data += "  def #{event}: (*untyped) -> bool\n"
+        self.data += "  def #{event}!: (*untyped) -> bool\n"
+        self.data += "  def #{event}_without_validation!: (*untyped) -> bool\n"
+        self.data += "  def may_#{event}?: (*untyped) -> bool\n"
+      end
+    end
+
+    def new_line
+      self.data += "\n"
+    end
+
+    def finalize
+      self.data += "end\n"
+    end
+
+    private
+
+    attr_reader :klass
+    attr_accessor :data
+
+    def add_state_constants(states)
+      states.each { |state| self.data += "  STATE_#{state.upcase}: String\n" }
+      self.data += "\n"
+    end
+
+    def add_state_scopes(states)
+      states.each { |state| self.data += "  def self.#{state}: () -> ::ActiveRecord_Relation\n" }
+      self.data += "\n"
+    end
+
+    def add_predicate_states_methods(states)
+      states.each { |state| self.data += "  def #{state}?: () -> bool\n" }
+    end
+  end
+end

data/lib/aasm_rbs/version.rb

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

data/lib/aasm_rbs.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'aasm_rbs/output'
+
+module AasmRbs
+  def self.run(klass_name)
+    klass = Object.const_get(klass_name)
+    states = klass.aasm.states.map(&:name)
+    events = klass.aasm.events.map(&:name)
+
+    output = Output.new(klass)
+    output.add_states(states)
+    output.new_line
+    output.add_events(events)
+    output.finalize
+  rescue StandardError
+    print "aasm_rbs received an invalid class name."
+  end
+end

data/sig/aasm_rbs/output.rbs

@@ -0,0 +1,20 @@
+module AasmRbs
+  class Output
+    def initialize: (Class) -> String
+
+    def add_states: (Array[String]) -> Array[String]
+    def add_events: (Array[String]) -> Array[String]
+
+    def new_line: () -> String
+    def finalize: () -> String
+
+    private
+
+    attr_reader klass: Class
+    attr_accessor 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]
+  end
+end

data/sig/aasm_rbs.rbs

@@ -0,0 +1,10 @@
+module AasmRbs
+  def self.run: (String) -> String?
+end
+
+# There are yet no official RBS signatures for the AASM module that gets
+# included in our classes. Therefore, the only thing we can do in order to not
+# make Steep unhappy is to declare a dummy signature ourself for the #aasm method.
+class Class
+  def aasm: () -> untyped
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: aasm_rbs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lorenzo Zabot
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Easily generate RBS signatures for all the AASM automatically generated
+  methods and constants of your ruby classes.
+email:
+- lorenzozabot@gmail.com
+executables:
+- aasm_rbs
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/aasm_rbs
+- lib/aasm_rbs.rb
+- lib/aasm_rbs/output.rb
+- lib/aasm_rbs/version.rb
+- sig/aasm_rbs.rbs
+- sig/aasm_rbs/output.rbs
+homepage: https://github.com/Uaitt/aasm_rbs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Uaitt/aasm_rbs
+  source_code_uri: https://github.com/Uaitt/aasm_rbs
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: AASM RBS
+test_files: []