adornable 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc81717998b4dc097647c96e4b7c89664b2d0c6969100dd22d713ba9c1720619
-  data.tar.gz: a3998df4caeb6db3823a218fc77ac3d1d56949e3f9a66cc340f65465d9037686
+  metadata.gz: f70e9c6dc00ff446a979d776bb8effbe0063b8e3cb1269081fe3dd78749b1a6d
+  data.tar.gz: dd2ee8ef02b67f5c1c48f83d3f04e9869bac1705c8eb12101c5e90e06274e6d8
 SHA512:
-  metadata.gz: 4aaf8fe2928bb4652dc5a7b1f235fadc7114580cfc29d91a9fdf508edbba15cccc09627b6a097552774c73babede934ca77a9388fa7ce1bfdbfb5975ab0661da
-  data.tar.gz: cc2ec1780014bfb5043a44857a2d9fc6eb7957ec245fef03accbe64436c11cc9f2596105d25d5e888b136ca27d57565ec414f9fbb466f72fc425744d6fe69af2
+  metadata.gz: 4cc9f4866c9e130ca8fc7d8cf2988a43c252604bf9030b919526d289badc3554d91c2eb4f825462ff6ac491f0f6519aaacff2e2bdd5c5c8a16dda33bd865c735
+  data.tar.gz: 1ecc141ccfff6820a76811bef1427ff90ca4072c35690b732dfbae24a45c6f7c901b8aa83e8172e57d69ad3eca84a50736f8835cfaf3339b56b980a1b72dd1c6

data/.github/workflows/main.yml

@@ -0,0 +1,48 @@
+name: Test and lint
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Run RSpec tests and RuboCop lints
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - 3.2
+          - 3.1
+          - 3.0
+          - 2.7
+          - 2.6
+          - 2.5
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby v${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rake spec
+
+      - name: Run RuboCop lints
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -7,6 +7,12 @@ require:
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.5
+
+# Gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 
 # Layout
 
@@ -24,6 +30,7 @@ Layout/FirstArrayElementIndentation:
 # Metrics
 
 Metrics/AbcSize:
+  Max: 20
   CountRepeatedAttributes: false
   Exclude:
     - 'spec/**/*_spec.rb'
@@ -60,10 +67,13 @@ Metrics/ModuleLength:
   Exclude:
     - 'spec/**/*_spec.rb'
 
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
 # Rspec
 
 RSpec/ExampleLength:
-  Max: 25
+  Max: 40
 
 RSpec/MessageSpies:
   Enabled: false

data/Gemfile

@@ -6,3 +6,15 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in adornable.gemspec
 gemspec
+
+group :development, :test do
+  gem "bundler", "~> 2.2"
+  gem "pry"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.10"
+  gem "rubocop-performance", "~> 1.9"
+  gem "rubocop-rake", "~> 0.5"
+  gem "rubocop-rspec", "~> 2.2"
+  gem "solargraph"
+end

data/README.md

@@ -4,6 +4,8 @@ Adornable provides the ability to cleanly decorate methods in Ruby. You can make
 
 ## Installation
 
+**NOTE:** This library is tested with Ruby versions 2.5.x through 3.2.x.
+
 ### Locally (to your application)
 
 Add the gem to your application's `Gemfile`:
@@ -232,7 +234,9 @@ The **required argument** is an instance of `Adornable::Context`, which has some
 
 - `Adornable::Context#method_name`: the name of the decorated method being called (a symbol; e.g., `:some_method` or `:other_method`)
 - `Adornable::Context#method_receiver`: the actual object that the decorated method (the `#method_name`) belongs to/is being called on (an object/class; e.g., the class `Foo` if it's a decorated class method, or an instance of `Foo` if it's a decorated instance method)
-- `Adornable::Context#method_arguments`: an array of arguments passed to the decorated method, including keyword arguments as a final hash (e.g., if `:yet_another_method` was called like `Foo.new.yet_another_method(123, bar: true)` then `arguments` would be `[123, {:bar=>true}]`)
+- `Adornable::Context#method_arguments`: an array of arguments passed to the decorated method, including keyword arguments as a final hash (e.g., if `:yet_another_method` was called like `Foo.new.yet_another_method(123, bar: true, baz: 456)` then `method_arguments` would be `[123, {:bar=>true,:baz=>456}]`)
+- `Adornable::Context#method_positional_args`: an array of just the positional arguments passed to the decorated method, excluding keyword arguments (e.g., if `:yet_another_method` was called like `Foo.new.yet_another_method(123, bar: true, baz: 456)` then `method_positional_args` would be `[123]`)
+- `Adornable::Context#method_kwargs`: a hash of just the keyword arguments passed to the decorated method (e.g., if `:yet_another_method` was called like `Foo.new.yet_another_method(123, { bam: "hi" }, bar: true, baz: 456)` then `method_kwargs` would be `{:bar=>true,:baz=>456}`)
 
 ##### Custom keyword arguments (optional)
 
@@ -351,12 +355,6 @@ rake spec
 rubocop
 ```
 
-### Create release
-
-```
-rake release
-```
-
 ## Contributing
 
 Bug reports and pull requests for this project are welcome at its [GitHub page](https://github.com/kjleitz/adornable). If you choose to contribute, please be nice so I don't have to run out of bubblegum, etc.

data/adornable.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description = "Adornable provides the ability to cleanly decorate methods in Ruby. You can make and use your own decorators, and you can also use some of the built-in ones that the gem provides. _Decorating_ methods is as simple as slapping a `decorate :some_decorator` above your method definition. _Defining_ decorators can be as simple as defining a method that yields to a block, or as complex as manipulating the decorated method's receiver and arguments, and/or changing the functionality of the decorator based on custom options supplied to it when initially applying the decorator." # rubocop:disable Layout/LineLength
   spec.homepage = "https://github.com/kjleitz/adornable"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.4.7"
+  spec.required_ruby_version = ">= 2.5.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -24,13 +24,5 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 2.2"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.10"
-  spec.add_development_dependency "rubocop-performance", "~> 1.9"
-  spec.add_development_dependency "rubocop-rake", "~> 0.5"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.2"
-  spec.add_development_dependency "solargraph"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/bin/asdf_switch

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# First argument should be desired ruby version. If a partial version is given
+# (e.g., 2.6) and multiple versions are found to be installed (e.g., 2.6.9 and
+# 2.6.10), then the highest version (in semver version order) will be selected.
+SELECTED_RUBY_VERSION=$(asdf list ruby | sort -V | sed -e 's/^[[:space:]]*//' | grep "^$1" | tail -n 1)
+
+if [ -z "$SELECTED_RUBY_VERSION" ]; then
+  echo "Ruby version $1 is not installed. Try running:"
+  echo "  asdf install ruby $1"
+  exit 1
+fi
+
+echo "Using Ruby version $SELECTED_RUBY_VERSION"
+
+echo "(setting global Ruby)"
+asdf global ruby $SELECTED_RUBY_VERSION
+
+echo "(reshimming for this version)"
+asdf reshim ruby $SELECTED_RUBY_VERSION
+
+echo "(reinstalling bundled gems)"
+bundle install --redownload
+

data/lib/adornable/context.rb

@@ -8,14 +8,26 @@ module Adornable
       method_receiver
       method_name
       method_arguments
+      method_positional_args
+      method_kwargs
       decorator_name
       decorator_options
     ])
 
-    def initialize(method_receiver:, method_name:, method_arguments:, decorator_name:, decorator_options:)
+    def initialize(
+      method_receiver:,
+      method_name:,
+      method_arguments:,
+      method_positional_args:,
+      method_kwargs:,
+      decorator_name:,
+      decorator_options:
+    )
       @method_receiver = method_receiver
       @method_name = method_name
       @method_arguments = method_arguments
+      @method_positional_args = method_positional_args
+      @method_kwargs = method_kwargs
       @decorator_name = decorator_name
       @decorator_options = decorator_options
     end

data/lib/adornable/machinery.rb

@@ -38,14 +38,14 @@ module Adornable
       clear_accumulated_decorators!
     end
 
-    def run_decorated_instance_method(bound_method, *args)
+    def run_decorated_instance_method(bound_method, *args, **kwargs)
       decorators = get_instance_method_decorators(bound_method.name)
-      run_decorators(decorators, bound_method, *args)
+      run_decorators(decorators, bound_method, *args, **kwargs)
     end
 
-    def run_decorated_class_method(bound_method, *args)
+    def run_decorated_class_method(bound_method, *args, **kwargs)
       decorators = get_class_method_decorators(bound_method.name)
-      run_decorators(decorators, bound_method, *args)
+      run_decorators(decorators, bound_method, *args, **kwargs)
     end
 
     private
@@ -88,8 +88,10 @@ module Adornable
       @class_method_decorators[name] = decorators || []
     end
 
-    def run_decorators(decorators, bound_method, *method_arguments)
-      return bound_method.call(*method_arguments) if Adornable::Utils.blank?(decorators)
+    def run_decorators(decorators, bound_method, *method_positional_args, **method_kwargs)
+      if Adornable::Utils.blank?(decorators)
+        return Adornable::Utils.empty_aware_send(bound_method, :call, method_positional_args, method_kwargs)
+      end
 
       decorator, *remaining_decorators = decorators
       decorator_name = decorator[:name]
@@ -97,22 +99,30 @@ module Adornable
       decorator_options = decorator[:options]
       validate_decorator!(decorator_name, decorator_receiver, bound_method)
 
+      # This is for backwards-compatibility between Ruby 2.x and Ruby 3.x; in v3
+      # keyword arguments are treated differently than in v2 with respect to
+      # hash parameter equivalency. Previously, it was easy to just assume
+      # `method_arguments` could be an array with a hash at the end representing
+      # any given keyword arguments. However, in Ruby 3.x, we have to be able to
+      # distinguish between kwargs and trailing positional args of type `Hash`,
+      # so we'll shim `Adornable::Context#method_arguments` to look like it used
+      # to and then provide two new properties, `#method_positional_args` and
+      # `#method_kwargs`, to `Adornable::Context` for explicitness.
+      method_arguments = method_positional_args.dup
+      method_arguments << method_kwargs if Adornable::Utils.present?(method_kwargs)
+
       context = Adornable::Context.new(
         method_receiver: bound_method.receiver,
         method_name: bound_method.name,
         method_arguments: method_arguments,
+        method_positional_args: method_positional_args,
+        method_kwargs: method_kwargs,
         decorator_name: decorator_name,
         decorator_options: decorator_options,
       )
 
-      send_parameters = if Adornable::Utils.present?(decorator_options)
-        [decorator_name, context, decorator_options]
-      else
-        [decorator_name, context]
-      end
-
-      decorator_receiver.send(*send_parameters) do
-        run_decorators(remaining_decorators, bound_method, *method_arguments)
+      Adornable::Utils.empty_aware_send(decorator_receiver, decorator_name, [context], decorator_options) do
+        run_decorators(remaining_decorators, bound_method, *method_positional_args, **method_kwargs)
       end
     end
 

data/lib/adornable/utils.rb

@@ -23,6 +23,29 @@ module Adornable
         end
         "`#{receiver_name}#{name_delimiter}#{method_name}`"
       end
+
+      # This craziness is here because Ruby 2.6 and below don't like when you
+      # pass even _empty_ arguments to `#call` or `#send` or any other method
+      # with a splat, for callables that take no arguments. For example, this
+      # takes the place of:
+      #
+      #   receiver.send(method_name, *splat_args, **splat_kwargs)
+      #
+      # ...or:
+      #
+      #   receiver.some_method(*splat_args, **splat_kwargs)
+      #
+      # ...which is not cool <= 2.6.x apparently, if `#some_method` takes zero
+      # arguments even if both `splat_args` and `splat_kwargs` are empty (thus
+      # passing it zero arguments in actuality). Oh well.
+      #
+      def empty_aware_send(receiver, method_name, splat_args, splat_kwargs, &block)
+        return receiver.send(method_name, &block) if splat_args.empty? && splat_kwargs.empty?
+        return receiver.send(method_name, *splat_args, &block) if splat_kwargs.empty?
+        return receiver.send(method_name, **splat_kwargs, &block) if splat_args.empty?
+
+        receiver.send(method_name, *splat_args, **splat_kwargs, &block)
+      end
     end
   end
 end

data/lib/adornable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Adornable
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/adornable.rb

@@ -14,7 +14,7 @@ module Adornable
   end
 
   def decorate(decorator_name, from: nil, defer_validation: false, **decorator_options)
-    if Adornable::Utils.blank?(name)
+    if Adornable::Utils.blank?(decorator_name)
       raise Adornable::Error::InvalidDecoratorArguments, "Decorator name must be provided."
     end
 
@@ -36,10 +36,16 @@ module Adornable
 
     machinery.apply_accumulated_decorators_to_instance_method!(method_name)
     original_method = instance_method(method_name)
-    define_method(method_name) do |*args|
+
+    # NB: If you only supply `*args` to the block, you get kwargs as a trailing
+    # Hash member in the `args` array. If you supply both `*args, **kwargs` to
+    # the block, kwargs are excluded from the `args` array and only appear in
+    # the `kwargs` argument as a Hash.
+    define_method(method_name) do |*args, **kwargs|
       bound_method = original_method.bind(self)
-      machinery.run_decorated_instance_method(bound_method, *args)
+      machinery.run_decorated_instance_method(bound_method, *args, **kwargs)
     end
+
     super
   end
 
@@ -49,9 +55,15 @@ module Adornable
 
     machinery.apply_accumulated_decorators_to_class_method!(method_name)
     original_method = method(method_name)
-    define_singleton_method(method_name) do |*args|
-      machinery.run_decorated_class_method(original_method, *args)
+
+    # NB: If you only supply `*args` to the block, you get kwargs as a trailing
+    # Hash member in the `args` array. If you supply both `*args, **kwargs` to
+    # the block, kwargs are excluded from the `args` array and only appear in
+    # the `kwargs` argument as a Hash.
+    define_singleton_method(method_name) do |*args, **kwargs|
+      machinery.run_decorated_class_method(original_method, *args, **kwargs)
     end
+
     super
   end
 end

metadata

@@ -1,127 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: adornable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Keegan Leitz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: solargraph
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2023-07-10 00:00:00.000000000 Z
+dependencies: []
 description: Adornable provides the ability to cleanly decorate methods in Ruby. You
   can make and use your own decorators, and you can also use some of the built-in
   ones that the gem provides. _Decorating_ methods is as simple as slapping a `decorate
@@ -135,6 +23,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -144,6 +33,7 @@ files:
 - README.md
 - Rakefile
 - adornable.gemspec
+- bin/asdf_switch
 - bin/console
 - bin/setup
 - lib/adornable.rb
@@ -156,7 +46,8 @@ files:
 homepage: https://github.com/kjleitz/adornable
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -165,14 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.7
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Method decorators for Ruby