rbs_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9b730da55f64b177f506e6f29efa54bba6878e3cd36b49df76703ac749feb1a
+  data.tar.gz: c759ea33ab9071df4806b81f14b5ca125b2f2df04054c4f3a9d2eb6e305c92ab
+SHA512:
+  metadata.gz: 7a8fbf409f920b17353906c93d0f86d3c94b270801ab184e2e92b47ceb050659dfaa163cd3d0204e54e970db325826ddb7c6a6df5e380f8342bae760c7d0025c
+  data.tar.gz: 06a2387300377054f6ccc1cd9a5414cb64753adfb9ef5e109f95234ec50e8cc5a83b148aa46cc9140cfd47705eb9275c7ca762824564993a6226a77351f33102

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rbs_rails.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/README.md

@@ -0,0 +1,36 @@
+# RbsRails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbs_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbs_rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rbs_rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/rbs_rails.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/assets/sig/active_record.rbs

@@ -0,0 +1,126 @@
+class ActiveRecord::Base
+  def self.scope: (Symbol, ^(*untyped) -> untyped ) -> void
+                | (Symbol) { (*untyped) -> untyped } -> void
+  def self.belongs_to: (Symbol, ?untyped, **untyped) -> void
+  def self.has_many: (Symbol, ?untyped, **untyped) -> void
+  def self.has_one: (Symbol, ?untyped, **untyped) -> void
+  def self.transaction: [T] () { () -> T } -> T
+  def self.create!: (**untyped) -> instance
+  def self.validate: (*untyped) -> void
+  def self.validates: (*untyped) -> void
+  def self.enum: (Hash[Symbol, untyped]) -> void
+
+  # callbacks
+  def self.after_commit: (*untyped) -> void
+  def self.after_create: (*untyped) -> void
+  def self.after_destroy: (*untyped) -> void
+  def self.after_rollback: (*untyped) -> void
+  def self.after_save: (*untyped) -> void
+  def self.after_update: (*untyped) -> void
+  def self.after_validation: (*untyped) -> void
+  def self.around_create: (*untyped) -> void
+  def self.around_destroy: (*untyped) -> void
+  def self.around_save: (*untyped) -> void
+  def self.around_update: (*untyped) -> void
+  def self.before_create: (*untyped) -> void
+  def self.before_destroy: (*untyped) -> void
+  def self.before_save: (*untyped) -> void
+  def self.before_update: (*untyped) -> void
+  def self.before_validation: (*untyped) -> void
+
+  def will_save_change_to_attribute?: (String | Symbol attr_name, ?from: untyped, ?to: untyped) -> bool
+
+  def save!: () -> self
+  def save: () -> bool
+  def update!: (*untyped) -> self
+  def update: (*untyped) -> bool
+  def destroy!: () -> self
+  def destroy: () -> bool
+  def valid?: () -> bool
+  def invalid?: () -> bool
+  def errors: () -> untyped
+  def []: (Symbol) -> untyped
+  def []=: (Symbol, untyped) -> untyped
+end
+
+class ActiveRecord::Relation
+end
+
+class ActiveRecord::Associations::CollectionProxy
+end
+
+interface _ActiveRecord_Relation[Model]
+  def all: () -> self
+  def ids: () -> Array[Integer]
+  def none: () -> self
+  def pluck: (Symbol | String column) -> Array[untyped]
+           | (*Symbol | String columns) -> Array[Array[untyped]]
+  def where: (*untyped) -> self
+  def not: (*untyped) -> self
+  def exists?: (*untyped) -> bool
+  def order: (*untyped) -> self
+  def group: (*Symbol | String) -> untyped
+  def distinct: () -> self
+  def or: (self) -> self
+  def merge: (self) -> self
+  def joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_outer_joins: (*String | Symbol) -> self
+                      | (Hash[untyped, untyped]) -> self
+  def includes: (*String | Symbol) -> self
+              | (Hash[untyped, untyped]) -> self
+  def eager_load: (*String | Symbol) -> self
+                | (Hash[untyped, untyped]) -> self
+  def preload: (*String | Symbol) -> self
+             | (Hash[untyped, untyped]) -> self
+  def find_by: (*untyped) -> Model?
+  def find_by!: (*untyped) -> Model
+  def find: (Integer id) -> Model
+  def first: () -> Model
+           | (Integer count) -> Array[Model]
+  def find_each: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (Model) -> void } -> nil
+  def find_in_batches: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (self) -> void } -> nil
+  def destroy_all: () -> untyped
+  def delete_all: () -> untyped
+  def update_all: (*untyped) -> untyped
+  def each: () { (Model) -> void } -> self
+end
+
+interface _ActiveRecord_Relation_ClassMethods[Model, Relation]
+  def all: () -> Relation
+  def ids: () -> Array[Integer]
+  def none: () -> Relation
+  def pluck: (Symbol | String column) -> Array[untyped]
+           | (*Symbol | String columns) -> Array[Array[untyped]]
+  def where: (*untyped) -> Relation
+  def exists?: (*untyped) -> bool
+  def order: (*untyped) -> Relation
+  def group: (*Symbol | String) -> untyped
+  def distinct: () -> self
+  def or: (Relation) -> Relation
+  def merge: (Relation) -> Relation
+  def joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_joins: (*String | Symbol) -> self
+           | (Hash[untyped, untyped]) -> self
+  def left_outer_joins: (*String | Symbol) -> self
+                      | (Hash[untyped, untyped]) -> self
+  def includes: (*String | Symbol) -> self
+              | (Hash[untyped, untyped]) -> self
+  def eager_load: (*String | Symbol) -> self
+                | (Hash[untyped, untyped]) -> self
+  def preload: (*String | Symbol) -> self
+             | (Hash[untyped, untyped]) -> self
+  def find_by: (*untyped) -> Model?
+  def find_by!: (*untyped) -> Model
+  def find: (Integer id) -> Model
+  def first: () -> Model
+           | (Integer count) -> Array[Model]
+  def find_each: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (Model) -> void } -> nil
+  def find_in_batches: (?batch_size: Integer, ?start: Integer, ?finish: Integer, ?error_on_ignore: bool) { (self) -> void } -> nil
+  def destroy_all: () -> untyped
+  def delete_all: () -> untyped
+  def update_all: (*untyped) -> untyped
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rbs_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rbs_rails.rb

@@ -0,0 +1,15 @@
+require 'parser/current'
+
+require_relative "rbs_rails/version"
+require_relative 'rbs_rails/active_record'
+require_relative 'rbs_rails/path_helpers'
+
+module RbsRails
+  class Error < StandardError; end
+
+  def self.copy_signatures(to:)
+    from = Pathname(__dir__) / '../assets/sig/'
+    to = Pathname(to)
+    FileUtils.cp_r(from, to)
+  end
+end

data/lib/rbs_rails/active_record.rb

@@ -0,0 +1,272 @@
+module RbsRails
+  module ActiveRecord
+    def self.class_to_rbs(klass, mode:)
+      Generator.new(klass, mode: mode).generate
+    end
+
+    class Generator
+      def initialize(klass, mode:)
+        @klass = klass
+        @mode = mode
+      end
+
+      def generate
+        [
+          klass_decl,
+          relation_decl,
+          collection_proxy_decl,
+        ].join("\n")
+      end
+
+      private def klass_decl
+        <<~RBS
+          #{header}
+            extend _ActiveRecord_Relation_ClassMethods[#{klass.name}, #{relation_class_name}]
+
+          #{columns.indent(2)}
+          #{associations.indent(2)}
+          #{enum_instance_methods.indent(2)}
+          #{enum_scope_methods(singleton: true).indent(2)}
+          #{scopes(singleton: true).indent(2)}
+          end
+        RBS
+      end
+
+      private def relation_decl
+        <<~RBS
+          class #{relation_class_name} < ActiveRecord::Relation
+            include _ActiveRecord_Relation[#{klass.name}]
+            include Enumerable[#{klass.name}, self]
+          #{enum_scope_methods(singleton: false).indent(2)}
+          #{scopes(singleton: false).indent(2)}
+          end
+        RBS
+      end
+
+      private def collection_proxy_decl
+        <<~RBS
+          class #{klass.name}::ActiveRecord_Associations_CollectionProxy < ActiveRecord::Associations::CollectionProxy
+          end
+        RBS
+      end
+
+
+      private def header
+        case mode
+        when :extension
+          "extension #{klass.name} (RbsRails)"
+        when :class
+          "class #{klass.name} < #{klass.superclass.name}"
+        else
+          raise "unexpected mode: #{mode}"
+        end
+      end
+
+      private def associations
+        [
+          has_many,
+          has_one,
+          belongs_to,
+        ].join("\n")
+      end
+
+      private def has_many
+        klass.reflect_on_all_associations(:has_many).map do |a|
+          "def #{a.name}: () -> #{a.klass.name}::ActiveRecord_Associations_CollectionProxy"
+        end.join("\n")
+      end
+
+      private def has_one
+        klass.reflect_on_all_associations(:has_one).map do |a|
+          type = a.polymorphic? ? 'untyped' : a.klass.name
+          "def #{a.name}: () -> #{type}"
+        end.join("\n")
+      end
+
+      private def belongs_to
+        klass.reflect_on_all_associations(:belongs_to).map do |a|
+          type = a.polymorphic? ? 'untyped' : a.klass.name
+          "def #{a.name}: () -> #{type}"
+        end.join("\n")
+      end
+
+      private def enum_instance_methods
+        methods = []
+        enum_definitions.each do |hash|
+          hash.each do |name, values|
+            next if name == :_prefix || name == :_suffix
+
+            values.each do |label, value|
+              value_method_name = enum_method_name(hash, name, label)
+              methods << "def #{value_method_name}!: () -> bool"
+              methods << "def #{value_method_name}?: () -> bool"
+            end
+          end
+        end
+
+        methods.join("\n")
+      end
+
+      private def enum_scope_methods(singleton:)
+        methods = []
+        enum_definitions.each do |hash|
+          hash.each do |name, values|
+            next if name == :_prefix || name == :_suffix
+
+            values.each do |label, value|
+              value_method_name = enum_method_name(hash, name, label)
+              methods << "def #{singleton ? 'self.' : ''}#{value_method_name}: () -> #{relation_class_name}"
+            end
+          end
+        end
+        methods.join("\n")
+      end
+
+      private def enum_definitions
+        @enum_definitions ||= build_enum_definitions
+      end
+
+      # We need static analysis to detect enum.
+      # ActiveRecord has `defined_enums` method,
+      # but it does not contain _prefix and _suffix information.
+      private def build_enum_definitions
+        ast = parse_model_file
+        return [] unless ast
+
+        traverse(ast).map do |node|
+          next unless node.type == :send
+          next unless node.children[0].nil?
+          next unless node.children[1] == :enum
+
+          definitions = node.children[2]
+          next unless definitions
+          next unless definitions.type == :hash
+          next unless traverse(definitions).all? { |n| [:str, :sym, :int, :hash, :pair, :true, :false].include?(n.type) }
+
+          code = definitions.loc.expression.source
+          code = "{#{code}}" if code[0] != '{'
+          eval(code)
+        end.compact
+      end
+
+      private def enum_method_name(hash, name, label)
+        enum_prefix = hash[:_prefix]
+        enum_suffix = hash[:_suffix]
+
+        if enum_prefix == true
+          prefix = "#{name}_"
+        elsif enum_prefix
+          prefix = "#{enum_prefix}_"
+        end
+        if enum_suffix == true
+          suffix = "_#{name}"
+        elsif enum_suffix
+          suffix = "_#{enum_suffix}"
+        end
+
+        "#{prefix}#{label}#{suffix}"
+      end
+
+      private def scopes(singleton:)
+        ast = parse_model_file
+        return '' unless ast
+
+        traverse(ast).map do |node|
+          next unless node.type == :send
+          next unless node.children[0].nil?
+          next unless node.children[1] == :scope
+
+          name_node = node.children[2]
+          next unless name_node
+          next unless name_node.type == :sym
+
+          name = name_node.children[0]
+          body_node = node.children[3]
+          next unless body_node
+          next unless body_node.type == :block
+
+          args = args_to_type(body_node.children[1])
+          "def #{singleton ? 'self.' : ''}#{name}: (#{args}) -> #{relation_class_name}"
+        end.compact.join("\n")
+      end
+
+      private def args_to_type(args_node)
+        res = []
+        args_node.children.each do |node|
+          case node.type
+          when :arg
+            res << "untyped"
+          when :optarg
+            res << "?untyped"
+          when :kwarg
+            res << "#{node.children[0]}: untyped"
+          when :kwoptarg
+            res << "?#{node.children[0]}: untyped"
+          else
+            raise "unexpected: #{node}"
+          end
+        end
+        res.join(", ")
+      end
+
+      private def parse_model_file
+        return @parse_model_file if defined?(@parse_model_file)
+
+
+        path = Rails.root.join('app/models/', klass.name.underscore + '.rb')
+        return @parse_model_file = nil unless path.exist?
+        return [] unless path.exist?
+
+        ast = Parser::CurrentRuby.parse path.read
+        return @parse_model_file = nil unless path.exist?
+
+        @parse_model_file = ast
+      end
+
+      private def traverse(node, &block)
+        return to_enum(__method__, node) unless block_given?
+
+        block.call node
+        node.children.each do |child|
+          traverse(child, &block) if child.is_a?(Parser::AST::Node)
+        end
+      end
+
+      private def relation_class_name
+        "#{klass.name}::ActiveRecord_Relation"
+      end
+
+      private def columns
+        klass.columns.map do |col|
+          "attr_accessor #{col.name} (): #{sql_type_to_class(col.type)}"
+        end.join("\n")
+      end
+
+      private def sql_type_to_class(t)
+        case t
+        when :integer
+          Integer.name
+        when :string, :text, :uuid
+          String.name
+        when :datetime
+          # TODO
+          # ActiveSupport::TimeWithZone.name
+          Time.name
+        when :boolean
+          "TrueClass | FalseClass"
+        when :jsonb, :json
+          "untyped"
+        when :date
+          # TODO
+          # Date.name
+          'untyped'
+        else
+          raise "unexpected: #{t.inspect}"
+        end
+      end
+
+      private
+      attr_reader :klass, :mode
+    end
+  end
+end

data/lib/rbs_rails/path_helpers.rb

@@ -0,0 +1,31 @@
+module RbsRails
+  class PathHelpers
+    def self.generate(routes: Rails.application.routes)
+      new(routes: Rails.application.routes).generate
+    end
+
+    def initialize(routes:)
+      @routes = routes
+    end
+
+    def generate
+      methods = helpers.map do |helper|
+        # TODO: More restrict argument types
+        "def #{helper}: (*untyped) -> String"
+      end
+
+      <<~RBS
+        interface _RbsRailsPathHelpers
+        #{methods.join("\n").indent(2)}
+        end
+      RBS
+    end
+
+    private def helpers
+      routes.named_routes.helper_names
+    end
+
+    private
+    attr_reader :routes
+  end
+end

data/lib/rbs_rails/version.rb

@@ -0,0 +1,3 @@
+module RbsRails
+  VERSION = "0.1.0"
+end

data/rbs_rails.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/rbs_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rbs_rails"
+  spec.version       = RbsRails::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{A RBS files generator for Rails application}
+  spec.description   = %q{A RBS files generator for Rails application}
+  spec.homepage      = "https://github.com/pocke/rbs_rails"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'parser'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rbs_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RBS files generator for Rails application
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- assets/sig/active_record.rbs
+- bin/console
+- bin/setup
+- lib/rbs_rails.rb
+- lib/rbs_rails/active_record.rb
+- lib/rbs_rails/path_helpers.rb
+- lib/rbs_rails/version.rb
+- rbs_rails.gemspec
+homepage: https://github.com/pocke/rbs_rails
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pocke/rbs_rails
+  source_code_uri: https://github.com/pocke/rbs_rails
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.pre1
+signing_key: 
+specification_version: 4
+summary: A RBS files generator for Rails application
+test_files: []