alchemrest 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d7990fc6f122f5563b87c143e2290e775266f3a91924565a8d29e4e493d97f
-  data.tar.gz: fbeed8b1ebc422f6f493adcdd81b9ddf16f8d717fb5016c7118590a9ceac4d4a
+  metadata.gz: e9985b9a29061ef219e09bcaf3613f0869442c425ebdef8a9c97cc4f31a40fa6
+  data.tar.gz: e1aacc36591d0dfe16fe59d7099a5b06fb4a1e076f8f61c8b8e7cbda0d72c7c7
 SHA512:
-  metadata.gz: c273a26594c284ed543f58b5407d2f831026ca6398f381b9721dae5d6fd24aae212da750a59f1f75c92d5992dd8148e5ef9c7541743d56365b611ccd5cf309fc
-  data.tar.gz: 34a0f36667395cda30c861a39b9e276390e63da3bc60372e3da354837095a9918cd36fdeae450944c45aecb7a9ff56c2a6b7493b66a22ed62bfb96efc079fa93
+  metadata.gz: c6f28199a64154cd0b91c830090e0b3aede1b8a073ecbd91f855975fca7535c4bad52b516649b4c9df8ccd5d3da96631aad1a26f6a09389728517dcebe79ac3a
+  data.tar.gz: 8aa2a756be73f88871b955cb11b8c7c56e750ebed26f570cca95a67b0df58dfff1fd41e04e8d2053bfa9dc70391f46eab36b2f0b6b75074b02662b9505f39bd7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alchemrest (3.2.3)
+    alchemrest (3.3.0)
       activerecord (>= 7.2, < 8.1)
       activesupport (>= 7.2, < 8.1)
       circuitbox (~> 2.0.0)
@@ -93,7 +93,7 @@ GEM
     crack (1.0.0)
       bigdecimal
       rexml
-    crass (1.0.6)
+    crass (1.0.7)
     date (3.4.1)
     diff-lcs (1.6.2)
     drb (2.2.3)
@@ -120,7 +120,7 @@ GEM
     json (2.9.1)
     language_server-protocol (3.17.0.3)
     logger (1.7.0)
-    loofah (2.24.0)
+    loofah (2.25.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     memoizable (0.4.2)
@@ -203,8 +203,8 @@ GEM
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
+    rails-html-sanitizer (1.7.1)
+      loofah (~> 2.25, >= 2.25.2)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     railties (8.0.4.1)
       actionpack (= 8.0.4.1)
@@ -325,7 +325,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.42)
+    yard (0.9.44)
     yard-sorbet (0.9.0)
       sorbet-runtime
       yard

data/gemfiles/faraday_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    alchemrest (3.2.3)
+    alchemrest (3.3.0)
       activerecord (>= 7.2, < 8.1)
       activesupport (>= 7.2, < 8.1)
       circuitbox (~> 2.0.0)

data/gemfiles/rails_7_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    alchemrest (3.2.3)
+    alchemrest (3.3.0)
       activerecord (>= 7.2, < 8.1)
       activesupport (>= 7.2, < 8.1)
       circuitbox (~> 2.0.0)

data/gemfiles/rails_8_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    alchemrest (3.2.3)
+    alchemrest (3.3.0)
       activerecord (>= 7.2, < 8.1)
       activesupport (>= 7.2, < 8.1)
       circuitbox (~> 2.0.0)

data/lib/alchemrest/request_definition.rb

@@ -5,7 +5,7 @@ module Alchemrest
   # we want to create, and block that can extract default parameters from an Alchemrest::Root. When we want to build an
   # instance of the request, call `build_request` and pass in the root as context, with any additional parameters.
   class RequestDefinition
-    attr_reader :name
+    attr_reader :name, :request_class, :builder_block
 
     def initialize(name, request_class, &block)
       @name = name

data/lib/alchemrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alchemrest
-  VERSION = "3.2.3"
+  VERSION = "3.3.0"
 end

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

@@ -3,28 +3,44 @@
 
 require 'active_support/core_ext/enumerable'
 require 'alchemrest'
+require 'prism'
 
 module Tapioca
   module Dsl
     module Compilers
       # This compiler generates RBI files for classes that inherit from `Alchemrest::Root`.
       #
-      # For example, given the following class:
+      # For example, given the following classes:
+      #
+      #   class UpdateProfile < Alchemrest::Request
+      #     extend T::Sig
+      #
+      #     sig { params(id: Integer, name: String).void }
+      #     def initialize(id:, name:)
+      #       ...
+      #     end
+      #
+      #     returns Profile
+      #   end
       #
       #   class Root < Alchemrest::Root
-      #     define_request :get_profile, Requests::GetProfile
+      #     define_request :update_profile, UpdateProfile do |request|
+      #       request.defaults = { id: }
+      #     end
       #   end
       #
       # This compiler will generate an RBI file `root.rbi` with the following content:
       #
-      #   sig { params(params: T::Hash[Symbol, T.untyped]).returns(::Alchemrest::Result[::Profile]) }
-      #   def get_profile(params = {}); end
+      #   sig { params(name: ::String, id: ::Integer).returns(::Alchemrest::Result[::Profile]) }
+      #   def update_profile(name:, id: T.unsafe(nil)); end
       #
       class AlchemrestRoot < Tapioca::Dsl::Compiler
         extend T::Sig
 
         ConstantType = type_member { { upper: T.class_of(Alchemrest::Root) } }
 
+        KEYWORD_PARAM_TYPES = [RBI::KwParam, RBI::KwOptParam, RBI::KwRestParam].freeze
+
         sig { override.returns(T::Enumerable[Module]) }
         def self.gather_constants
           descendants_of(Alchemrest::Root)
@@ -36,7 +52,7 @@ module Tapioca
             constant.request_definitions.each do |name, definition|
               rbi.create_method(
                 name.to_s,
-                parameters: [create_opt_param('params', type: 'T::Hash[Symbol, T.untyped]', default: '{}')],
+                parameters: parameters_for(definition),
                 return_type: return_type_for(definition),
               )
             end
@@ -45,6 +61,63 @@ module Tapioca
 
         private
 
+        sig { params(definition: Alchemrest::RequestDefinition).returns(T::Array[RBI::TypedParam]) }
+        def parameters_for(definition)
+          parameters = compile_method_parameters_to_rbi(definition.request_class.instance_method(:initialize))
+
+          if parameters.all? { |typed_param| KEYWORD_PARAM_TYPES.include?(typed_param.param.class) }
+            optional_keys = defaulted_keys_for(definition) || parameters.map { |typed_param| typed_param.param.name }
+            with_optional_keys(parameters, optional_keys)
+          else
+            [create_opt_param('params', type: 'T::Hash[Symbol, T.untyped]', default: '{}')]
+          end
+        end
+
+        sig { params(parameters: T::Array[RBI::TypedParam], optional_keys: T::Array[String]).returns(T::Array[RBI::TypedParam]) }
+        def with_optional_keys(parameters, optional_keys)
+          parameters = parameters.map do |typed_param|
+            param = typed_param.param
+
+            if param.is_a?(RBI::KwParam) && optional_keys.include?(param.name)
+              create_kw_opt_param(param.name, type: typed_param.type, default: 'T.unsafe(nil)')
+            else
+              typed_param
+            end
+          end
+
+          required, optional = parameters.partition { |typed_param| typed_param.param.is_a?(RBI::KwParam) }
+          required + optional
+        end
+
+        sig { params(definition: Alchemrest::RequestDefinition).returns(T.nilable(T::Array[String])) }
+        def defaulted_keys_for(definition)
+          if definition.builder_block
+            literal_defaults_keys(block_node_for(definition.builder_block))
+          else
+            []
+          end
+        end
+
+        sig { params(block_node: T.nilable(Prism::Node)).returns(T.nilable(T::Array[String])) }
+        def literal_defaults_keys(block_node)
+          case block_node
+          in { body: { body: [Prism::CallNode[name: :defaults=, arguments: { arguments: [Prism::HashNode[elements:]] }]] } }
+            symbol_keys = elements.grep(Prism::AssocNode).map(&:key).grep(Prism::SymbolNode)
+            symbol_keys.map(&:unescaped) if symbol_keys.size == elements.size
+          else
+            nil
+          end
+        end
+
+        sig { params(builder_block: Proc).returns(T.nilable(Prism::Node)) }
+        def block_node_for(builder_block)
+          file, line = builder_block.source_location
+
+          if file && File.exist?(file)
+            Prism.parse_file(file).value.breadth_first_search { |node| node.is_a?(Prism::BlockNode) && node.location.start_line == line }
+          end
+        end
+
         sig { params(definition: Alchemrest::RequestDefinition).returns(String) }
         def return_type_for(definition)
           transform = extract_transform(definition)
@@ -58,8 +131,7 @@ module Tapioca
 
         sig { params(definition: Alchemrest::RequestDefinition).returns(T.nilable(Alchemrest::Transforms::Typed)) }
         def extract_transform(definition)
-          request_class = definition.instance_variable_get(:@request_class)
-          returns_modules = request_class.ancestors.grep(Alchemrest::Request::Returns)
+          returns_modules = definition.request_class.ancestors.grep(Alchemrest::Request::Returns)
           returns_modules.sole.domain_type.const_get(:TRANSFORM) if returns_modules.one?
         end
       end

data/sorbet/rbi/gems/{crass@1.0.6.rbi → crass@1.0.7.rbi}

@@ -8,87 +8,90 @@
 # source://crass//lib/crass/token-scanner.rb#3
 module Crass
   class << self
-    # source://crass//lib/crass.rb#10
+    # source://crass//lib/crass.rb#22
     def parse(input, options = T.unsafe(nil)); end
 
-    # source://crass//lib/crass.rb#18
+    # source://crass//lib/crass.rb#30
     def parse_properties(input, options = T.unsafe(nil)); end
   end
 end
 
 # source://crass//lib/crass/parser.rb#10
 class Crass::Parser
-  # source://crass//lib/crass/parser.rb#126
+  # source://crass//lib/crass/parser.rb#140
   def initialize(input, options = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#137
+  # source://crass//lib/crass/parser.rb#153
   def consume_at_rule(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#184
+  # source://crass//lib/crass/parser.rb#200
   def consume_component_value(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#209
+  # source://crass//lib/crass/parser.rb#225
   def consume_declaration(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#276
+  # source://crass//lib/crass/parser.rb#292
   def consume_declarations(input = T.unsafe(nil), options = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#326
+  # source://crass//lib/crass/parser.rb#342
   def consume_function(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#357
+  # source://crass//lib/crass/parser.rb#383
   def consume_qualified_rule(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#398
+  # source://crass//lib/crass/parser.rb#424
   def consume_rules(flags = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#434
+  # source://crass//lib/crass/parser.rb#460
   def consume_simple_block(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#458
+  # source://crass//lib/crass/parser.rb#526
   def create_node(type, properties = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#466
+  # source://crass//lib/crass/parser.rb#534
   def create_selector(input); end
 
-  # source://crass//lib/crass/parser.rb#474
+  # source://crass//lib/crass/parser.rb#542
   def create_style_rule(rule); end
 
-  # source://crass//lib/crass/parser.rb#483
+  # source://crass//lib/crass/parser.rb#501
+  def discard_block(input); end
+
+  # source://crass//lib/crass/parser.rb#551
   def parse_component_value(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#510
+  # source://crass//lib/crass/parser.rb#578
   def parse_component_values(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#524
+  # source://crass//lib/crass/parser.rb#592
   def parse_declaration(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#552
+  # source://crass//lib/crass/parser.rb#620
   def parse_declarations(input = T.unsafe(nil), options = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#560
+  # source://crass//lib/crass/parser.rb#628
   def parse_properties(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#586
+  # source://crass//lib/crass/parser.rb#654
   def parse_rule(input = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/parser.rb#615
+  # source://crass//lib/crass/parser.rb#683
   def parse_value(nodes); end
 
-  # source://crass//lib/crass/parser.rb#120
+  # source://crass//lib/crass/parser.rb#134
   def tokens; end
 
   class << self
-    # source://crass//lib/crass/parser.rb#25
+    # source://crass//lib/crass/parser.rb#39
     def parse_properties(input, options = T.unsafe(nil)); end
 
-    # source://crass//lib/crass/parser.rb#36
+    # source://crass//lib/crass/parser.rb#50
     def parse_rules(input, options = T.unsafe(nil)); end
 
-    # source://crass//lib/crass/parser.rb#54
+    # source://crass//lib/crass/parser.rb#68
     def parse_stylesheet(input, options = T.unsafe(nil)); end
 
-    # source://crass//lib/crass/parser.rb#74
+    # source://crass//lib/crass/parser.rb#88
     def stringify(nodes, options = T.unsafe(nil)); end
   end
 end
@@ -96,27 +99,30 @@ end
 # source://crass//lib/crass/parser.rb#11
 Crass::Parser::BLOCK_END_TOKENS = T.let(T.unsafe(nil), Hash)
 
+# source://crass//lib/crass/parser.rb#29
+Crass::Parser::DEFAULT_MAXIMUM_DEPTH = T.let(T.unsafe(nil), Integer)
+
 # source://crass//lib/crass/scanner.rb#8
 class Crass::Scanner
-  # source://crass//lib/crass/scanner.rb#25
+  # source://crass//lib/crass/scanner.rb#29
   def initialize(input); end
 
-  # source://crass//lib/crass/scanner.rb#34
+  # source://crass//lib/crass/scanner.rb#38
   def consume; end
 
-  # source://crass//lib/crass/scanner.rb#46
+  # source://crass//lib/crass/scanner.rb#50
   def consume_rest; end
 
   # source://crass//lib/crass/scanner.rb#11
   def current; end
 
-  # source://crass//lib/crass/scanner.rb#57
+  # source://crass//lib/crass/scanner.rb#66
   def eos?; end
 
-  # source://crass//lib/crass/scanner.rb#63
+  # source://crass//lib/crass/scanner.rb#72
   def mark; end
 
-  # source://crass//lib/crass/scanner.rb#69
+  # source://crass//lib/crass/scanner.rb#79
   def marked; end
 
   # source://crass//lib/crass/scanner.rb#15
@@ -125,28 +131,28 @@ class Crass::Scanner
   # source://crass//lib/crass/scanner.rb#15
   def marker=(_arg0); end
 
-  # source://crass//lib/crass/scanner.rb#80
+  # source://crass//lib/crass/scanner.rb#91
   def peek(length = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/scanner.rb#19
+  # source://crass//lib/crass/scanner.rb#23
   def pos; end
 
-  # source://crass//lib/crass/scanner.rb#19
+  # source://crass//lib/crass/scanner.rb#23
   def pos=(_arg0); end
 
-  # source://crass//lib/crass/scanner.rb#87
+  # source://crass//lib/crass/scanner.rb#103
   def reconsume; end
 
-  # source://crass//lib/crass/scanner.rb#93
+  # source://crass//lib/crass/scanner.rb#109
   def reset; end
 
-  # source://crass//lib/crass/scanner.rb#103
+  # source://crass//lib/crass/scanner.rb#122
   def scan(pattern); end
 
-  # source://crass//lib/crass/scanner.rb#115
+  # source://crass//lib/crass/scanner.rb#134
   def scan_until(pattern); end
 
-  # source://crass//lib/crass/scanner.rb#22
+  # source://crass//lib/crass/scanner.rb#26
   def string; end
 end
 
@@ -188,55 +194,55 @@ class Crass::Tokenizer
   # source://crass//lib/crass/tokenizer.rb#70
   def consume; end
 
-  # source://crass//lib/crass/tokenizer.rb#275
+  # source://crass//lib/crass/tokenizer.rb#276
   def consume_bad_url; end
 
-  # source://crass//lib/crass/tokenizer.rb#301
+  # source://crass//lib/crass/tokenizer.rb#302
   def consume_comments; end
 
-  # source://crass//lib/crass/tokenizer.rb#326
+  # source://crass//lib/crass/tokenizer.rb#327
   def consume_escaped; end
 
-  # source://crass//lib/crass/tokenizer.rb#350
+  # source://crass//lib/crass/tokenizer.rb#351
   def consume_ident; end
 
-  # source://crass//lib/crass/tokenizer.rb#375
+  # source://crass//lib/crass/tokenizer.rb#376
   def consume_name; end
 
-  # source://crass//lib/crass/tokenizer.rb#407
+  # source://crass//lib/crass/tokenizer.rb#408
   def consume_number; end
 
-  # source://crass//lib/crass/tokenizer.rb#430
+  # source://crass//lib/crass/tokenizer.rb#431
   def consume_numeric; end
 
-  # source://crass//lib/crass/tokenizer.rb#469
+  # source://crass//lib/crass/tokenizer.rb#470
   def consume_string(ending = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/tokenizer.rb#510
+  # source://crass//lib/crass/tokenizer.rb#511
   def consume_unicode_range; end
 
-  # source://crass//lib/crass/tokenizer.rb#542
+  # source://crass//lib/crass/tokenizer.rb#543
   def consume_url; end
 
-  # source://crass//lib/crass/tokenizer.rb#590
+  # source://crass//lib/crass/tokenizer.rb#591
   def convert_string_to_number(str); end
 
-  # source://crass//lib/crass/tokenizer.rb#616
+  # source://crass//lib/crass/tokenizer.rb#643
   def create_token(type, properties = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/tokenizer.rb#627
+  # source://crass//lib/crass/tokenizer.rb#654
   def preprocess(input); end
 
-  # source://crass//lib/crass/tokenizer.rb#642
+  # source://crass//lib/crass/tokenizer.rb#669
   def start_identifier?(text = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/tokenizer.rb#666
+  # source://crass//lib/crass/tokenizer.rb#693
   def start_number?(text = T.unsafe(nil)); end
 
-  # source://crass//lib/crass/tokenizer.rb#685
+  # source://crass//lib/crass/tokenizer.rb#712
   def tokenize; end
 
-  # source://crass//lib/crass/tokenizer.rb#702
+  # source://crass//lib/crass/tokenizer.rb#729
   def valid_escape?(text = T.unsafe(nil)); end
 
   class << self