rbs_activerecord 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4083cdfd1907ddd9ba845bf3535ed264504753c6fe80c08ac723891a0c990aa
-  data.tar.gz: 8825d942ba46a8b35cd4aa3d57ef723aa7fbc51333d7fe30bdca1b143ed73693
+  metadata.gz: ec157eccf748c923a3f44138390f064e4b3aea347fdfe9744be6a5fa9954a947
+  data.tar.gz: f6a433a5a7c3dc60806045240bd71ee4817fc8c1cf36a0af37fc66098821ff36
 SHA512:
-  metadata.gz: '07838fda26b2d56872fa91f7d3d9a89b2eb89c5c93591722547ca27af65d65ff72ae1703c8366d4c556559d18cbcc8668930c8c4e2bbb7c89aaaa3e1b7ec84a3'
-  data.tar.gz: 605694bc6458aa4f6076d89add3a162c66edceefd357f2402e989a093f898b853f1d363cf7d121a4e5e49befa4747bd99c2ae9a52f2a89502f25361ee1865ccf
+  metadata.gz: 8da50a2d1a78c22b997ab57c94476ee53abffb30688c4222982543dd84e9ed9dc97a99fd9a128a6fb4ba307f83d545e239291354ef67df0f66cfc7f4424b6d4c
+  data.tar.gz: 0fc67b6d496d3472a1f69ea3105d51da358d1ae3f48f1715bbcc24e02ffd229ff144319f493ecec23937f6b161ef00f11eaecba06e0b12fc49e480140bb9e1e8

data/.vscode/settings.json

@@ -7,6 +7,7 @@
     "cSpell.words": [
         "activerecord",
         "codebases",
-        "Cyclomatic"
+        "Cyclomatic",
+        "kaminari"
     ]
 }

data/README.md

@@ -6,23 +6,52 @@ rbs_activerecord is a RBSGenerator for models built with ActiveRecord.
 
 Add a new entry to your Gemfile and run `bundle install`:
 
-  group :development do
-    gem 'rbs_activerecord', require: false
-  end
+    group :development do
+      gem 'rbs_activerecord', require: false
+    end
 
 After the installation, please run rake task generator:
 
-  bundle exec rails g rbs_activerecord:install
+    bundle exec rails g rbs_activerecord:install
 
 ## Usage
 
 Run `rbs:activerecord:setup` task:
 
-  bundle exec rake rbs:activerecord:setup
+    bundle exec rake rbs:activerecord:setup
 
 Then rbs_activerecord will scan your code and generate RBS files into
 `sig/activerecord` directory.
 
+## The goal of rbs_activerecord
+
+rbs_activerecord is an experimental project to enhance the type generation for ActiveRecord models.
+It is strongly inspired by [rbs_rails](https://github.com/pocke/rbs_rails).
+
+The goal of this gem is to give feedbacks to the rbs_rails project, and improving rbs_rails.
+One of the large goals is merging this gem into rbs_rails.
+
+Main differences between rbs_activerecord and rbs_rails are:
+
+* New features
+    * Support Rails7 style enum definitions ([#268](https://github.com/pocke/rbs_rails/pull/268))
+    * Support STI (Single Table Inheritance) models ([#287](https://github.com/pocke/rbs_rails/pull/287))
+        * Inherits scope, enum and other definitions in the parent class to the child class
+    * Support has_and_belongs_to_many association ([#272](https://github.com/pocke/rbs_rails/pull/272))
+    * Support `alias_attribute` ([#263](https://github.com/pocke/rbs_rails/pull/263))
+    * Support generating model definitions within the concern module ([#209](https://github.com/pocke/rbs_rails/pull/209))
+    * Support extension ActiveRecord from 3rd party gems ([#254](https://github.com/pocke/rbs_rails/pull/254))
+        * ex. kaminari
+    * Support composite primary keys ([#275](https://github.com/pocke/rbs_rails/pull/275))
+    * Extend return types of #pluck ([#273](https://github.com/pocke/rbs_rails/pull/273))
+    * Override types of CollectionProxy ([#289](https://github.com/pocke/rbs_rails/pull/289))
+* Bug fixes
+    * [#286](https://github.com/pocke/rbs_rails/pull/286)
+    * [#285](https://github.com/pocke/rbs_rails/pull/285)
+    * [#278](https://github.com/pocke/rbs_rails/pull/278)
+    * [#277](https://github.com/pocke/rbs_rails/pull/277)
+    * [#233](https://github.com/pocke/rbs_rails/pull/233)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also

data/lib/rbs_activerecord/generator.rb

@@ -3,7 +3,7 @@
 require "rails"
 
 module RbsActiverecord
-  class Generator
+  class Generator # rubocop:disable Metrics/ClassLength
     include Utils
 
     attr_reader :klass #: singleton(ActiveRecord::Base)
@@ -17,7 +17,7 @@ module RbsActiverecord
       @model = Model.new(klass)
     end
 
-    def generate #: String  # rubocop:disable Metrics/AbcSize
+    def generate #: String  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       format <<~RBS
         #{header}
           #{Attributes.new(model).generate}
@@ -34,6 +34,21 @@ module RbsActiverecord
           #{Enum::Scopes.new(model, declarations).generate}
           #{Scopes.new(model, declarations).generate}
 
+          module GeneratedCollectionProxyInstanceMethods[Model, PrimaryKey]
+            def build: (?ActiveRecord::Associations::CollectionProxy::_EachPair attributes) ?{ () -> untyped } -> Model
+                     | (Array[ActiveRecord::Associations::CollectionProxy::_EachPair] attributes) ?{ () -> untyped } -> Array[Model]
+            def create: (?ActiveRecord::Associations::CollectionProxy::_EachPair attributes) ?{ () -> untyped } -> Model
+                      | (Array[ActiveRecord::Associations::CollectionProxy::_EachPair] attributes) ?{ () -> untyped } -> Array[Model]
+            def create!: (?ActiveRecord::Associations::CollectionProxy::_EachPair attributes) ?{ () -> untyped } -> Model
+                       | (Array[ActiveRecord::Associations::CollectionProxy::_EachPair] attributes) ?{ () -> untyped } -> Array[Model]
+            def reload: () -> Array[Model]
+            def replace: (Array[Model]) -> void
+            def delete: (*Model | PrimaryKey) -> Array[Model]
+            def destroy: (*Model | PrimaryKey) -> Array[Model]
+            def <<: (*Model | Array[Model]) -> self
+            def prepend: (*Model | Array[Model]) -> self
+          end
+
           class ActiveRecord_Relation < ::ActiveRecord::Relation
             include ::Enumerable[#{klass_name}]
             include ::ActiveRecord::Relation::Methods[#{klass_name}, #{primary_key_type}]
@@ -46,6 +61,7 @@ module RbsActiverecord
             include ::ActiveRecord::Relation::Methods[#{klass_name}, #{primary_key_type}]
             #{relation_methods}
             include GeneratedPluckOverloads
+            include GeneratedCollectionProxyInstanceMethods[#{klass_name}, #{primary_key_type}]
           end
 
           extend ::ActiveRecord::Base::ClassMethods[#{klass_name}, #{klass_name}::ActiveRecord_Relation, #{primary_key_type}]
@@ -74,7 +90,9 @@ module RbsActiverecord
       @declarations ||= begin
         filename = Rails.root.join(model.filename)
         if filename.exist?
-          Parser.parse(filename.to_s)
+          Parser.parse_file(filename.to_s).tap do |decls|
+            Parser::IncludeExpander.expand(model, decls)
+          end
         else
           {}
         end

data/lib/rbs_activerecord/parser/evaluator.rb

@@ -31,6 +31,11 @@ module RbsActiverecord
               [key, value]
             end
           end.to_h
+        when Prism::ConstantReadNode
+          node.name.to_s
+        when Prism::ConstantPathNode
+          parent = node.parent ? eval_node(node.parent) : nil
+          "#{parent}::#{node.name}"
         when Prism::KeywordHashNode
           node.elements.filter_map do |assoc|
             case assoc

data/lib/rbs_activerecord/parser/include_expander/module.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RbsActiverecord
+  module Parser
+    class IncludeExpander
+      class Module
+        attr_reader :mod #: ::Module
+        attr_reader :name #: String
+
+        # @rbs mod: ::Module
+        # @rbs name: String
+        def initialize(mod, name) #: void
+          @mod = mod
+          @name = name
+        end
+
+        def concern? #: bool
+          mod.is_a?(::ActiveSupport::Concern)
+        end
+
+        def included_blocks #: Array[Prism::CallNode]
+          return [] unless concern?
+
+          declarations.select { |node| node.name == :included }
+        end
+
+        private
+
+        # @rbs @declarations: Array[Prism::CallNode]
+
+        def declarations #: Array[Prism::CallNode]
+          @declarations ||= begin
+            path = source_location
+            return [] unless path && File.exist?(path)
+
+            declarations = Parser.parse_file(path)
+            declarations.fetch(name, [])
+          end
+        end
+
+        def source_location #: String?
+          Object.const_source_location(name)&.fetch(0)
+        end
+      end
+    end
+  end
+end

data/lib/rbs_activerecord/parser/include_expander.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RbsActiverecord
+  module Parser
+    class IncludeExpander
+      # @rbs model: RbsActiverecord::Model
+      # @rbs declarations: Hash[String, Array[Prism::CallNode]]
+      def self.expand(model, declarations) #: void
+        new(model, declarations).expand
+      end
+
+      attr_reader :model #: RbsActiverecord::Model
+      attr_reader :declarations #: Hash[String, Array[Prism::CallNode]]
+
+      # @rbs model: RbsActiverecord::Model
+      # @rbs declarations: Hash[String, Array[Prism::CallNode]]
+      def initialize(model, declarations) #: void
+        @model = model
+        @declarations = declarations
+      end
+
+      def expand #: void
+        declarations.each_value do |decls|
+          loop do
+            index = decls.index { |node| node.name == :include }
+            break unless index
+
+            included_module = decls.delete_at(index)
+            included_blocks = included_blocks_for(included_module)
+            included_blocks.reverse_each do |included|
+              decls.insert(index, *block_body_of(included))
+            end
+          end
+        end
+      end
+
+      private
+
+      # @rbs node: Prism::CallNode
+      def included_blocks_for(node) #: Array[Prism::CallNode]
+        modules = node.arguments&.arguments.to_a
+                      .map { |arg| Parser.eval_node(arg) }
+                      .select { |mod| mod.is_a?(String) }
+        modules.flat_map do |modname|
+          mod = const_get(modname)
+          next [] unless mod
+
+          Module.new(mod, modname).included_blocks
+        end
+      end
+
+      # @rbs name: String
+      def const_get(name) #: ::Module?
+        path = model.klass.name.to_s.split("::")
+
+        loop do
+          modname = (path + [name]).join("::")
+          return Object.const_get(modname) if Object.const_defined?(modname)
+          break if path.empty?
+
+          path.pop
+        end
+      end
+
+      # @rbs node: Prism::CallNode
+      def block_body_of(node) #: Array[Prism::CallNode]
+        case node.block
+        when Prism::BlockNode
+          case node.block.body
+          when Prism::StatementsNode
+            body = node.block.body.body #: Array[Prism::CallNode]
+            body.select { |n| n.is_a?(Prism::CallNode) }
+          else
+            []
+          end
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/rbs_activerecord/parser/visitor.rb

@@ -14,22 +14,7 @@ module RbsActiverecord
       end
 
       def current_namespace #: String
-        context.flat_map do |node|
-          namespace = [] #: Array[Symbol?]
-          path = node.constant_path #: Prism::Node?
-          loop do
-            case path
-            when Prism::ConstantPathNode
-              namespace << path.name
-              path = path.parent
-            when Prism::ConstantReadNode
-              namespace << path.name
-              break
-            end
-          end
-
-          namespace.compact.reverse
-        end.join("::")
+        context.map { |node| Parser.eval_node(node.constant_path) }.join("::")
       end
 
       # @rbs override

data/lib/rbs_activerecord/parser.rb

@@ -8,12 +8,13 @@ module RbsActiverecord
     #       refs: https://github.com/soutaro/rbs-inline/pull/118
     #
     # @rbs!
-    #   def self.parse: (String filename) -> Hash[String, Array[Prism::CallNode]]
+    #   def self.parse: (String code) -> Hash[String, Array[Prism::CallNode]]
+    #   def self.parse_file: (String filename) -> Hash[String, Array[Prism::CallNode]]
     #   def self.eval_node: (Prism::Node node) -> untyped
 
-    # @rbs filename: String
-    def parse(filename) #: Hash[String, Array[Prism::CallNode]]
-      result = Prism.parse_file(filename)
+    # @rbs code: String
+    def parse(code) #: Hash[String, Array[Prism::CallNode]]
+      result = Prism.parse(code)
 
       visitor = Visitor.new
       visitor.visit(result.value)
@@ -21,6 +22,11 @@ module RbsActiverecord
     end
     module_function :parse
 
+    def parse_file(filename) #: Hash[String, Array[Prism::CallNode]]
+      File.open(filename) { |f| parse(f.read) }
+    end
+    module_function :parse_file
+
     # @rbs node: Prism::Node
     def eval_node(node) #: untyped
       Evaluator.eval_node(node)

data/lib/rbs_activerecord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RbsActiverecord
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/rbs_activerecord.rb

@@ -18,6 +18,8 @@ require_relative "rbs_activerecord/generator/secure_password"
 require_relative "rbs_activerecord/model"
 require_relative "rbs_activerecord/parser"
 require_relative "rbs_activerecord/parser/evaluator"
+require_relative "rbs_activerecord/parser/include_expander"
+require_relative "rbs_activerecord/parser/include_expander/module"
 require_relative "rbs_activerecord/parser/visitor"
 require_relative "rbs_activerecord/version"
 

data/sig/rbs_activerecord/parser/include_expander/module.rbs

@@ -0,0 +1,29 @@
+# Generated from lib/rbs_activerecord/parser/include_expander/module.rb with RBS::Inline
+
+module RbsActiverecord
+  module Parser
+    class IncludeExpander
+      class Module
+        attr_reader mod: ::Module
+
+        attr_reader name: String
+
+        # @rbs mod: ::Module
+        # @rbs name: String
+        def initialize: (::Module mod, String name) -> void
+
+        def concern?: () -> bool
+
+        def included_blocks: () -> Array[Prism::CallNode]
+
+        private
+
+        @declarations: Array[Prism::CallNode]
+
+        def declarations: () -> Array[Prism::CallNode]
+
+        def source_location: () -> String?
+      end
+    end
+  end
+end

data/sig/rbs_activerecord/parser/include_expander.rbs

@@ -0,0 +1,32 @@
+# Generated from lib/rbs_activerecord/parser/include_expander.rb with RBS::Inline
+
+module RbsActiverecord
+  module Parser
+    class IncludeExpander
+      # @rbs model: RbsActiverecord::Model
+      # @rbs declarations: Hash[String, Array[Prism::CallNode]]
+      def self.expand: (RbsActiverecord::Model model, Hash[String, Array[Prism::CallNode]] declarations) -> void
+
+      attr_reader model: RbsActiverecord::Model
+
+      attr_reader declarations: Hash[String, Array[Prism::CallNode]]
+
+      # @rbs model: RbsActiverecord::Model
+      # @rbs declarations: Hash[String, Array[Prism::CallNode]]
+      def initialize: (RbsActiverecord::Model model, Hash[String, Array[Prism::CallNode]] declarations) -> void
+
+      def expand: () -> void
+
+      private
+
+      # @rbs node: Prism::CallNode
+      def included_blocks_for: (Prism::CallNode node) -> Array[Prism::CallNode]
+
+      # @rbs name: String
+      def const_get: (String name) -> ::Module?
+
+      # @rbs node: Prism::CallNode
+      def block_body_of: (Prism::CallNode node) -> Array[Prism::CallNode]
+    end
+  end
+end

data/sig/rbs_activerecord/parser.rbs

@@ -2,12 +2,16 @@
 
 module RbsActiverecord
   module Parser
-    def self.parse: (String filename) -> Hash[String, Array[Prism::CallNode]]
+    def self.parse: (String code) -> Hash[String, Array[Prism::CallNode]]
+
+    def self.parse_file: (String filename) -> Hash[String, Array[Prism::CallNode]]
 
     def self.eval_node: (Prism::Node node) -> untyped
 
-    # @rbs filename: String
-    def parse: (String filename) -> Hash[String, Array[Prism::CallNode]]
+    # @rbs code: String
+    def parse: (String code) -> Hash[String, Array[Prism::CallNode]]
+
+    def parse_file: (untyped filename) -> Hash[String, Array[Prism::CallNode]]
 
     # @rbs node: Prism::Node
     def eval_node: (Prism::Node node) -> untyped

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Takeshi KOMIYA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -85,6 +85,8 @@ files:
 - lib/rbs_activerecord/model.rb
 - lib/rbs_activerecord/parser.rb
 - lib/rbs_activerecord/parser/evaluator.rb
+- lib/rbs_activerecord/parser/include_expander.rb
+- lib/rbs_activerecord/parser/include_expander/module.rb
 - lib/rbs_activerecord/parser/visitor.rb
 - lib/rbs_activerecord/rake_task.rb
 - lib/rbs_activerecord/utils.rb
@@ -109,6 +111,8 @@ files:
 - sig/rbs_activerecord/model.rbs
 - sig/rbs_activerecord/parser.rbs
 - sig/rbs_activerecord/parser/evaluator.rbs
+- sig/rbs_activerecord/parser/include_expander.rbs
+- sig/rbs_activerecord/parser/include_expander/module.rbs
 - sig/rbs_activerecord/parser/visitor.rbs
 - sig/rbs_activerecord/rake_task.rbs
 - sig/rbs_activerecord/utils.rbs