orthoses-rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620d49df1787f2c79e641435da0cf872d0d8604930729bc746a72ec787677b78
-  data.tar.gz: fc06f6c06c7941f5ca36bbc1aabf6730e641e7cac2ea2a4f7ee1242284ebb4de
+  metadata.gz: ec337b1da4ecda39f953797824239ede59c536c74da48cc1dbd01e46eed1d2b0
+  data.tar.gz: b146481d3fda9b3568a1593fd05608f09c811e1181356f2e36d2b010c30dd130
 SHA512:
-  metadata.gz: 63e8a69d07faab3bda23d71df987b87352e245b46d14cf824576c2a66502ad95e2523bc8f11eb8030e3325707b7b9b8e2e28103c560dba01bb0234ecf23fb54c
-  data.tar.gz: 13fd887d6564a51e19a0cdea17b80b5d3cfedd5a56f4096c1ec44a27dca3ba3e6a57c34dd22aa069a808fea34ec2eab1f265f0fa7d42f1394f8c00937642eb03
+  metadata.gz: 2bec23dc332048a010d10a2dc01754b969f76d2dd19bfa4b50393c1a764b3de496a35d018560aca04fe43630de497e900bb580774698bda3073ea33dcbf44bb5
+  data.tar.gz: e2dac22ee12a3bf049a73e5609d4a3ca1693c2dbc851c3bb06256e4566e9adad6c991fa9a60b0aaa7b22d6ea19e0c7cbc65c403cd136669d4c98b58deb7d90e7

data/README.md

@@ -5,9 +5,16 @@ Orthoses::Rails automatically generates RBS for methods added by Rails.
 
 ## Usage
 
+If you have never performed rbs collection initialization, you need to do it.
+
+```
+$ bundle exec rbs collection init
+$ bundle exec rbs collection install
+```
+
 Build your Rake task for RBS generation.
 
-```rb
+```
 $ bin/rails generate orthoses:rails:install
 ```
 

data/lib/generators/orthoses/rails/templates/rails.rake

@@ -0,0 +1,31 @@
+namespace :orthoses do
+  task :rails do
+    # Phase to load libraries
+    require Rails.root / "config/application"
+    require 'orthoses/rails'
+
+    # You can choose logger level
+    Orthoses.logger.level = :warn
+
+    # DSL for Orthoses.
+    Orthoses::Builder.new do
+      use Orthoses::CreateFileByName,
+        to: 'sig/orthoses', # Write to this dir. (require)
+        depth: 1,           # Group files by module name path depth. (default: nil)
+        rmtree: true        # Remove all `to` dir before generation. (default: false)
+
+      # Complement missing const name.
+      use Orthoses::MissingName
+
+      # You can load hand written RBS.
+      # use Orthoses::LoadRBS,
+      #   paths: Dir.glob(Rails.root / "sig/hand-written/**/*.rbs")
+
+      # Middleware package for rails application.
+      use Orthoses::Rails::Application
+
+      # Application code loaded here is the target of the analysis.
+      run Orthoses::Rails::Application::Loader.new
+    end.call
+  end
+end

data/lib/orthoses/active_record/secure_token.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveRecord
+    # def has_secure_token(attribute = :token, length: MINIMUM_TOKEN_LENGTH)
+    class SecureToken
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        has_secure_token = CallTracer::Lazy.new
+        store = has_secure_token.trace('ActiveRecord::SecureToken::ClassMethods#has_secure_token') do
+          @loader.call
+        end
+
+        has_secure_token.captures.each do |capture|
+          base_name = Utils.module_name(capture.method.receiver) or next
+          attribute = capture.argument[:attribute]
+
+          store[base_name] << "def regenerate_#{attribute}: () -> bool"
+        end
+
+        store
+      end
+    end
+  end
+end

data/lib/orthoses/active_record.rb

@@ -9,6 +9,7 @@ require_relative 'active_record/has_one'
 require_relative 'active_record/query_methods'
 require_relative 'active_record/relation'
 require_relative 'active_record/scope'
+require_relative 'active_record/secure_token'
 
 module Orthoses
   module ActiveRecord

data/lib/orthoses/active_storage/attached/model.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveStorage
+    module Attached
+      # <= 6.0
+      #   def has_one_attached(name, dependent: :purge_later)
+      # >= 6.1
+      #   def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
+      class Model
+        def initialize(loader)
+          @loader = loader
+        end
+
+        def call
+          store = @loader.call
+
+          ::ActiveRecord::Base.descendants.each do |base|
+            next if base.abstract_class?
+            next if base.reflect_on_all_attachments.empty?
+
+            base_name = Utils.module_name(base) or next
+            base.reflect_on_all_attachments.each do |reflection|
+              type =
+                case reflection
+                when ::ActiveStorage::Reflection::HasOneAttachedReflection
+                  "ActiveStorage::Attached::One"
+                when ::ActiveStorage::Reflection::HasManyAttachedReflection
+                  "ActiveStorage::Attached::Many"
+                else
+                  "untyped"
+                end
+              name = reflection.name
+
+              store[base_name].tap do |content|
+                content << "def #{name}: () -> #{type}"
+                content << "def #{name}=: (untyped attachable) -> untyped"
+              end
+            end
+          end
+
+          store
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/active_storage.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'active_storage/attached/model'

data/lib/orthoses/active_support/aliasing.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveSupport
+    # def alias_attribute(new_name, old_name)
+    class Aliasing
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        alias_attribute = CallTracer::Lazy.new
+
+        store =
+          alias_attribute.trace('Module#alias_attribute') do
+            @loader.call
+          end
+
+        alias_attribute.captures.each do |capture|
+          base_mod_name = Utils.module_name(capture.method.receiver) or next
+          new_name = capture.argument[:new_name]
+
+          content = store[base_mod_name]
+          # TODO: Shold use alias? But, it has risc of undefined method
+          content << "def #{new_name}: () -> untyped"
+          content << "def #{new_name}?: () -> bool"
+          content << "def #{new_name}=: (untyped) -> untyped"
+        end
+
+        store
+      end
+    end
+  end
+end

data/lib/orthoses/active_support/time_with_zone.rb

@@ -28,6 +28,13 @@ module Orthoses
         -
       ])
 
+      TIME_MODULES = [
+        TypeName("::Time"),
+        TypeName("::DateAndTime::Zones"),
+        TypeName("::DateAndTime::Calculations"),
+        TypeName("::DateAndTime::Compatibility")
+      ]
+
       def filter_decl(time_with_zone_store)
         writer = RBS::Writer.new(out: StringIO.new)
         time_with_zone_store.to_decl.members.each do |member|
@@ -64,8 +71,9 @@ module Orthoses
           next if twz_methods.has_key?(sym) && !TYPE_MERGE_METHODS.include?(sym)
           next if !definition_method.public?
 
-          definition_method.defs.reject! do |type_def|
-            type_def.implemented_in != type_name_time
+          # delegate to ::Time method
+          definition_method.defs.select! do |type_def|
+            TIME_MODULES.include?(type_def.implemented_in)
           end
           next if definition_method.defs.empty?
 

data/lib/orthoses/active_support.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'active_support/aliasing'
 require_relative 'active_support/class_attribute'
 require_relative 'active_support/concern'
 require_relative 'active_support/configurable'

data/lib/orthoses/rails/application.rb

@@ -3,6 +3,13 @@
 module Orthoses
   module Rails
     class Application
+      class Loader
+        def call
+          ::Rails.application.initialize!
+          ::Rails.application.eager_load!
+        end
+      end
+
       def initialize(loader)
         @loader = loader
       end
@@ -11,6 +18,7 @@ module Orthoses
         loader = @loader
         Orthoses::Builder.new do
           use Orthoses::ActiveModel::HasSecurePassword
+
           use Orthoses::ActiveRecord::BelongsTo
           use Orthoses::ActiveRecord::DelegatedType
           use Orthoses::ActiveRecord::Enum
@@ -19,7 +27,13 @@ module Orthoses
           use Orthoses::ActiveRecord::HasOne
           use Orthoses::ActiveRecord::Relation
           use Orthoses::ActiveRecord::Scope
+          use Orthoses::ActiveRecord::SecureToken
+
+          if defined?(::ActiveStorage)
+            use Orthoses::ActiveStorage::Attached::Model
+          end
 
+          use Orthoses::ActiveSupport::Aliasing
           use Orthoses::ActiveSupport::ClassAttribute
           use Orthoses::ActiveSupport::Concern
           use Orthoses::ActiveSupport::Delegation

data/lib/orthoses/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   module Rails
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/orthoses/rails.rb

@@ -4,6 +4,7 @@ require 'orthoses'
 
 require_relative 'active_model'
 require_relative 'active_record'
+require_relative 'active_storage'
 require_relative 'active_support'
 require_relative 'railties'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
 description: Orthoses middleware collection for Ruby on Rails
 email:
 - co000ri@gmail.com
@@ -35,6 +35,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/generators/orthoses/rails/install_generator.rb
+- lib/generators/orthoses/rails/templates/rails.rake
 - lib/orthoses-rails.rb
 - lib/orthoses/active_model.rb
 - lib/orthoses/active_model/has_secure_password.rb
@@ -48,7 +49,11 @@ files:
 - lib/orthoses/active_record/query_methods.rb
 - lib/orthoses/active_record/relation.rb
 - lib/orthoses/active_record/scope.rb
+- lib/orthoses/active_record/secure_token.rb
+- lib/orthoses/active_storage.rb
+- lib/orthoses/active_storage/attached/model.rb
 - lib/orthoses/active_support.rb
+- lib/orthoses/active_support/aliasing.rb
 - lib/orthoses/active_support/class_attribute.rb
 - lib/orthoses/active_support/concern.rb
 - lib/orthoses/active_support/configurable.rb