alchemrest 3.2.3 → 3.4.0

data/gemfiles/rails_8_1.gemfile.lock

@@ -0,0 +1,387 @@
+PATH
+  remote: ..
+  specs:
+    alchemrest (3.4.0)
+      activerecord (>= 7.2, < 8.2)
+      activesupport (>= 7.2, < 8.2)
+      circuitbox (~> 2.0.0)
+      faraday (>= 1.10, < 3.0)
+      memosa (>= 0.8.2)
+      money (>= 6.0)
+      morpher (>= 0.4.1)
+      multi_json (~> 1.0)
+      mustermann-contrib (>= 1.0)
+      railties (>= 7.2, < 8.2)
+      sentry-ruby
+      sorbet-runtime (>= 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    actionpack (8.1.4.1)
+      actionview (= 8.1.4.1)
+      activesupport (= 8.1.4.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.1.4.1)
+      activesupport (= 8.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6, >= 1.7.2)
+    activemodel (8.1.4.1)
+      activesupport (= 8.1.4.1)
+    activerecord (8.1.4.1)
+      activemodel (= 8.1.4.1)
+      activesupport (= 8.1.4.1)
+      timeout (>= 0.4.0)
+    activesupport (8.1.4.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    anima (0.3.2)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2)
+      equalizer (~> 0.0.11)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    betterlint (1.18.0)
+      rubocop (~> 1.71)
+      rubocop-graphql (~> 1.5)
+      rubocop-performance (~> 1.23)
+      rubocop-rails (~> 2.29)
+      rubocop-rake (~> 0.6)
+      rubocop-rspec (~> 2.29)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    circuitbox (2.0.0)
+    coderay (1.1.3)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concord (0.1.6)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.2)
+    drb (2.2.1)
+    equalizer (0.0.11)
+    erubi (1.13.1)
+    factory_bot (6.5.0)
+      activesupport (>= 5.0.0)
+    faraday (1.10.4)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (1.0.2)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hansi (0.2.1)
+    hashdiff (1.1.2)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.5)
+    loofah (2.25.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.19.5)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    memosa (0.8.2)
+    method_source (1.1.0)
+    minitest (5.25.4)
+    moneta (1.6.0)
+    money (6.19.0)
+      i18n (>= 0.6.4, <= 2)
+    morpher (0.4.2)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      concord (~> 0.1.5)
+      equalizer (~> 0.0.9)
+      mprelude (~> 0.1.0)
+      procto (~> 0.0.2)
+    mprelude (0.1.0)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.1)
+      procto (~> 0.0.2)
+    multi_json (1.15.0)
+    multipart-post (2.4.1)
+    mustermann (3.0.3)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-contrib (3.0.3)
+      hansi (~> 0.2.0)
+      mustermann (= 3.0.3)
+    mutant (0.13.4)
+      diff-lcs (~> 1.3)
+      irb (~> 1.15.2)
+      parser (~> 3.3.0)
+      regexp_parser (~> 2.10)
+      sorbet-runtime (~> 0.5.0)
+      unparser (~> 0.8.0)
+    mutant-rspec (0.13.4)
+      mutant (= 0.13.4)
+      rspec-core (>= 3.8.0, < 4.0.0)
+    netrc (0.11.0)
+    nokogiri (1.19.7-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.7-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.19.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.19.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.19.7-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.7-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.9)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.5.1)
+    procto (0.0.3)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (5.2.3)
+      date
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.14)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.7.2)
+      loofah (~> 2.25, >= 2.25.3)
+      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.1.4.1)
+      actionpack (= 8.1.4.1)
+      activesupport (= 8.1.4.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbi (0.2.3)
+      prism (~> 1.0)
+      sorbet-runtime (>= 0.5.9204)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.11.3)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rexml (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.71.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-graphql (1.5.4)
+      rubocop (>= 1.50, < 2)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.29.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
+    sentry-ruby (5.22.1)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+    sorbet (0.5.11763)
+      sorbet-static (= 0.5.11763)
+    sorbet-runtime (0.5.11763)
+    sorbet-static (0.5.11763-aarch64-linux)
+    sorbet-static (0.5.11763-universal-darwin)
+    sorbet-static (0.5.11763-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11763)
+      sorbet (= 0.5.11763)
+      sorbet-runtime (= 0.5.11763)
+    spoom (1.5.1)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    stringio (3.1.2)
+    tapioca (0.16.8)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    thread_safe (0.3.6)
+    timecop (0.9.10)
+    timeout (0.4.3)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    unparser (0.8.0)
+      diff-lcs (~> 1.6)
+      parser (>= 3.3.0)
+      prism (>= 1.4)
+    uri (1.0.3)
+    useragent (0.16.11)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
+    zeitwerk (2.7.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  activemodel
+  activerecord (~> 8.1.0)
+  activesupport (~> 8.1.0)
+  alchemrest!
+  appraisal
+  betterlint
+  combustion
+  factory_bot
+  faraday (~> 1.10)
+  moneta
+  mutant-rspec (~> 0.13.4)
+  pg
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  rubocop
+  rubocop-rspec
+  sorbet
+  tapioca (>= 0.16.6)
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.6.9

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.4.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