tapioca 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9b10c318332131210706b023ccbe3a63a5889153e3b365a9c454ee7311d2498
-  data.tar.gz: 6c5a5ef82c6a952b535f6f04b3c3127968bca4d8d101e321e13e8e5968ea3222
+  metadata.gz: a6ca30be86eac3958354ca4204904993088bfeeef36c72d63b428ccc5ff3eff3
+  data.tar.gz: e218a8ed57c6eb6c46b00f423771fa1a4874a8f0a945d8f5683e849fe5ca9e91
 SHA512:
-  metadata.gz: f1df6d85dd2924d25e3d6460749cc5a5ce75022bf999e663c813d6dd483e130b6a1c9873872f2412046d6d15f87effc125bc2f3941323f0ac3eca27a0bfa89a7
-  data.tar.gz: f6b81c3d32e1cec689ed022c17f57ada8655c0594c944c396d26a481e32dce029b77ed8f877063bfee138405019f6bb5408f2de3148d437a2b8db01a699063c5
+  metadata.gz: 39b2b67d35896d998f0f11dcdeda386e6e8312e124b12d8e5e252650417ba3c8a452aedfe014059064ca69e465d97089bfad55f1801d6667612902a4edc24903
+  data.tar.gz: 0fa4fe00a45d1f0e870f6d2cf985291ee1ed3f78d339c1f27be5653cff99490de31c6907abc462f1c1c7c197d7eb3eba63c2a90764c56a89fd607fd950c4a493

data/Gemfile

@@ -11,6 +11,7 @@ group(:deployment, :development) do
 end
 
 gem("bundler", "~> 1.17")
+gem("yard", "~> 0.9.25")
 gem("pry-byebug")
 gem("minitest")
 gem("minitest-hooks")

data/README.md

@@ -97,6 +97,12 @@ Command: `tapioca todo`
 
 This will generate the file `sorbet/rbi/todo.rbi` defining all unresolved constants as empty modules.
 
+### Generate DSL RBI files
+
+Command: `tapioca dsl [constant...]`
+
+This will generate DSL RBIs for specified constants (or for all handled constants, if a constant name is not supplied). You can read about DSL RBI generators supplied by `tapioca` in [the manual](manual/generators.md).
+
 ### Flags
 
 - `--prerequire [file]`: A file to be required before `Bundler.require` is called.
@@ -105,10 +111,6 @@ This will generate the file `sorbet/rbi/todo.rbi` defining all unresolved consta
 - `--generate-command [command]`: The command to run to regenerate RBI files (used in header comment of the RBI files), defaults to the current command.
 - `--typed-overrides [gem:level]`: Overrides typed sigils for generated gem RBIs for gem `gem` to level `level` (`level` can be one of `ignore`, `false`, `true`, `strict`, or `strong`, see [the Sorbet docs](https://sorbet.org/docs/static#file-level-granularity-strictness-levels) for more details).
 
-### Strong typing option for ActiveRecord column methods
-
-`tapioca` gives you the option to generate stricter type signatures for your ActiveRecord column types. By default, methods generated for columns that are defined in the schema have signatures of T.untyped. However, if the object extends a module with name StrongTypeGeneration, tapioca will generate stricter signatures that follow closely with the types defined in the schema. Expectation is the StrongTypeGeneration module you define in your application won't allow objects to be initialized with "bad state". It will check all the attributes that are not nillable to ensure they are not nil.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/tapioca. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/Shopify/tapioca/blob/master/CODE_OF_CONDUCT.md) code of conduct.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+Dir['tasks/**/*.rake'].each { |t| load t }
 
 Rake.application.options.trace = false
 

data/lib/tapioca/compilers/dsl/action_controller_helpers.rb

@@ -42,6 +42,7 @@ module Tapioca
       #     # ...
       #   end
       # end
+      # ~~~
       #
       # this generator will produce an RBI file `user_controller.rbi` with the following content:
       #

data/lib/tapioca/compilers/dsl/active_record_columns.rb

@@ -17,6 +17,17 @@ module Tapioca
       # responsible for defining the attribute methods that would be created for the columns that
       # are defined in the Active Record model.
       #
+      # **Note:** This generator, by default, generates weak signatures for column methods and treats each
+      # column to be `T.untyped`. This is done on purpose to ensure that the nilability of Active Record
+      # columns do not make it hard for existing code to adopt gradual typing. It is possible, however, to
+      # generate stricter type signatures for your ActiveRecord column types. If your ActiveRecord model extends
+      # a module with name `StrongTypeGeneration`, this generator will generate stricter signatures that follow
+      # closely with the types defined in the schema.
+      #
+      # The `StrongTypeGeneration` module you define in your application should add an `after_initialize` callback
+      # to the model and ensure that all the non-nilable attributes of the model are actually initialized with non-`nil`
+      # values.
+      #
       # For example, with the following model class:
       #
       # ~~~rb

data/lib/tapioca/compilers/dsl/active_record_identity_cache.rb

@@ -16,7 +16,7 @@ module Tapioca
   module Compilers
     module Dsl
       # `Tapioca::Compilers::DSL::ActiveRecordIdentityCache` generates RBI files for ActiveRecord models
-      #  that use `include IdentityCache`
+      #  that use `include IdentityCache`.
       # `IdentityCache` is a blob level caching solution to plug into ActiveRecord. (see https://github.com/Shopify/identity_cache).
       #
       # For example, with the following ActiveRecord class:
@@ -61,7 +61,6 @@ module Tapioca
       #   def fetch_by_title_and_review_date(title, review_date, includes: nil); end
       # end
       # ~~~
-
       class ActiveRecordIdentityCache < Base
         extend T::Sig
 

data/lib/tapioca/compilers/dsl/active_record_scope.rb

@@ -37,7 +37,7 @@ module Tapioca
       # module Post::GeneratedRelationMethods
       #   sig { params(args: T.untyped, blk: T.untyped).returns(T.untyped) }
       #   def private_kind(*args, &blk); end
-
+      #
       #   sig { params(args: T.untyped, blk: T.untyped).returns(T.untyped) }
       #   def public_kind(*args, &blk); end
       # end

data/lib/tapioca/compilers/dsl/active_record_typed_store.rb

@@ -86,8 +86,6 @@ module Tapioca
       #   def saved_change_to_reviewed; end
       # end
       # ~~~
-      # end
-
       class ActiveRecordTypedStore < Base
         extend T::Sig
 

data/lib/tapioca/compilers/dsl/active_support_current_attributes.rb

@@ -34,7 +34,7 @@ module Tapioca
       #     # ...
       #   end
       # end
-      # ~~~rb
+      # ~~~
       #
       # this generator will produce an RBI file with the following content:
       # ~~~rbi

data/lib/tapioca/compilers/dsl/protobuf.rb

@@ -12,19 +12,19 @@ module Tapioca
   module Compilers
     module Dsl
       # `Tapioca::Compilers::Dsl::Protobuf` decorates RBI files for subclasses of
-      # `Google::Protobuf::MessageExts`.
-      # (see https://github.com/coinbase/protoc-gen-rbi).
+      # `Google::Protobuf::MessageExts` (see https://github.com/protocolbuffers/protobuf/tree/master/ruby).
       #
       # For example, with the following "cart.rb" file:
       #
       # ~~~rb
       # Google::Protobuf::DescriptorPool.generated_pool.build do
-      # add_file("cart.proto", :syntax => :proto3) do
-      #   add_message "MyCart" do
-      #     optional :shop_id, :int32, 1
-      #     optional :customer_id, :int64, 2
-      #     optional :number_value, :double, 3
-      #     optional :string_value, :string, 4
+      #   add_file("cart.proto", :syntax => :proto3) do
+      #     add_message "MyCart" do
+      #       optional :shop_id, :int32, 1
+      #       optional :customer_id, :int64, 2
+      #       optional :number_value, :double, 3
+      #       optional :string_value, :string, 4
+      #     end
       #   end
       # end
       # ~~~

data/lib/tapioca/compilers/dsl/url_helpers.rb

@@ -14,6 +14,74 @@ end
 module Tapioca
   module Compilers
     module Dsl
+      # `Tapioca::Compilers::Dsl::UrlHelpers` generates RBI files for classes that include or extend
+      # `Rails.application.routes.url_helpers`
+      # (see https://api.rubyonrails.org/v5.1.7/classes/ActionDispatch/Routing/UrlFor.html#module-ActionDispatch::Routing::UrlFor-label-URL+generation+for+named+routes).
+      #
+      # For example, with the following setup:
+      #
+      # ~~~rb
+      # # config/application.rb
+      # class Application < Rails::Application
+      #   routes.draw do
+      #     resource :index
+      #   end
+      # end
+      # ~~~
+      #
+      # ~~~rb
+      # app/models/post.rb
+      # class Post
+      #   include Rails.application.routes.url_helpers
+      # end
+      # ~~~
+      #
+      # this generator will produce the following RBI files:
+      #
+      # ~~~rbi
+      # # generated_path_helpers_module.rbi
+      # # typed: true
+      # module GeneratedPathHelpersModule
+      #   include ActionDispatch::Routing::PolymorphicRoutes
+      #   include ActionDispatch::Routing::UrlFor
+      #
+      #   sig { params(args: T.untyped).returns(String) }
+      #   def edit_index_path(*args); end
+      #
+      #   sig { params(args: T.untyped).returns(String) }
+      #   def index_path(*args); end
+      #
+      #   sig { params(args: T.untyped).returns(String) }
+      #   def new_index_path(*args); end
+      # end
+      # ~~~
+      #
+      # ~~~rbi
+      # # generated_url_helpers_module.rbi
+      # # typed: true
+      # module GeneratedUrlHelpersModule
+      #   include ActionDispatch::Routing::PolymorphicRoutes
+      #   include ActionDispatch::Routing::UrlFor
+      #
+      #   sig { params(args: T.untyped).returns(String) }
+      #   def edit_index_url(*args); end
+      #
+      #   sig { params(args: T.untyped).returns(String) }
+      #   def index_url(*args); end
+      #
+      #   sig { params(args: T.untyped).returns(String) }
+      #   def new_index_url(*args); end
+      # end
+      # ~~~
+      #
+      # ~~~rbi
+      # # post.rbi
+      # # typed: true
+      # class Post
+      #   include GeneratedPathHelpersModule
+      #   include GeneratedUrlHelpersModule
+      # end
+      # ~~~
       class UrlHelpers < Base
         extend T::Sig
 

data/lib/tapioca/compilers/symbol_table/symbol_generator.rb

@@ -383,8 +383,18 @@ module Tapioca
               indented("include(#{qualified_name_of(mod)})")
             end.join("\n")
 
-          mixed_in_module = dynamic_extends.find do |mod|
-            mod != constant && public_module?(mod)
+          ancestors = singleton_class_of(constant).ancestors
+          extends_as_concern = ancestors.any? do |mod|
+            qualified_name_of(mod) == "::ActiveSupport::Concern"
+          end
+          class_methods_module = resolve_constant("#{name_of(constant)}::ClassMethods")
+
+          mixed_in_module = if extends_as_concern && Module === class_methods_module
+            class_methods_module
+          else
+            dynamic_extends.find do |mod|
+              mod != constant && public_module?(mod)
+            end
           end
 
           return result if mixed_in_module.nil?
@@ -494,15 +504,16 @@ module Tapioca
           return if symbol_ignored?(symbol_name) && !method_in_gem?(method)
 
           signature = signature_of(method)
-          method = signature.method if signature
+          method = T.let(signature.method, UnboundMethod) if signature
 
           method_name = method.name.to_s
           return unless valid_method_name?(method_name)
           return if struct_method?(constant, method_name)
           return if method_name.start_with?("__t_props_generated_")
 
-          params = T.let(method.parameters, T::Array[T::Array[Symbol]])
-          parameters = params.map do |(type, name)|
+          parameters = T.let(method.parameters, T::Array[[Symbol, T.nilable(Symbol)]])
+
+          sanitized_parameters = parameters.map do |type, name|
             unless name
               # For attr_writer methods, Sorbet signatures have the name
               # of the method (without the trailing = sign) as the name of
@@ -512,14 +523,15 @@ module Tapioca
               # method and the parameter is required and there is a single
               # parameter and the signature also defines a single parameter and
               # the name of the method ends with a = character.
-              writer_method_with_sig = signature &&
-                type == :req &&
-                params.size == 1 &&
+              writer_method_with_sig = (
+                signature && type == :req &&
+                parameters.size == 1 &&
                 signature.arg_types.size == 1 &&
                 method_name[-1] == "="
+              )
 
               name = if writer_method_with_sig
-                method_name[0...-1].to_sym
+                T.must(method_name[0...-1]).to_sym
               else
                 :_
               end
@@ -528,6 +540,10 @@ module Tapioca
             # Sanitize param names
             name = name.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
 
+            [type, name]
+          end
+
+          parameter_list = sanitized_parameters.map do |type, name|
             case type
             when :req
               name
@@ -546,25 +562,30 @@ module Tapioca
             end
           end.join(', ')
 
-          parameters = "(#{parameters})" if parameters != ""
+          parameter_list = "(#{parameter_list})" if parameter_list != ""
+          signature_str = indented(compile_signature(signature, sanitized_parameters)) if signature
 
-          signature_str = indented(compile_signature(signature)) if signature
           [
             signature_str,
-            indented("def #{method_name}#{parameters}; end"),
+            indented("def #{method_name}#{parameter_list}; end"),
           ].compact.join("\n")
         end
 
         TYPE_PARAMETER_MATCHER = /T\.type_parameter\(:?([[:word:]]+)\)/
 
-        sig { params(signature: T.untyped).returns(String) }
-        def compile_signature(signature)
-          params = signature.arg_types
-          params += signature.kwarg_types.to_a
-          params << [signature.rest_name, signature.rest_type] if signature.has_rest
-          params << [signature.block_name, signature.block_type] if signature.block_name
+        sig { params(signature: T.untyped, parameters: T::Array[[Symbol, String]]).returns(String) }
+        def compile_signature(signature, parameters)
+          parameter_types = T.let(signature.arg_types.to_h, T::Hash[Symbol, T::Types::Base])
+          parameter_types.merge!(signature.kwarg_types)
+          parameter_types[signature.rest_name] = signature.rest_type if signature.has_rest
+          parameter_types[signature.keyrest_name] = signature.keyrest_type if signature.has_keyrest
+          parameter_types[signature.block_name] = signature.block_type if signature.block_name
+
+          params = parameters.map do |_, name|
+            type = parameter_types[name.to_sym]
+            "#{name}: #{type}"
+          end.join(", ")
 
-          params = params.compact.map { |name, type| "#{name}: #{type}" }.join(", ")
           returns = type_of(signature.return_type)
 
           type_parameters = (params + returns).scan(TYPE_PARAMETER_MATCHER).flatten.uniq.map { |p| ":#{p}" }.join(", ")

data/lib/tapioca/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Tapioca
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.7
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="