adornable 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bea3ddf067bcb43aee2c2c9cd380297f6f741dc358572d65903a20fd1a0e1ec
-  data.tar.gz: a12b2559a2a647ff58c36f072d4ad0bf71180f3382cffd69d2f43e4fd2d3a040
+  metadata.gz: dc81717998b4dc097647c96e4b7c89664b2d0c6969100dd22d713ba9c1720619
+  data.tar.gz: a3998df4caeb6db3823a218fc77ac3d1d56949e3f9a66cc340f65465d9037686
 SHA512:
-  metadata.gz: 65d7e3170d90c2388a4e2a9610a6a2d2cfeb872153bb883791bf975d7f18eae4841ce3550010cfb0f17419b9bec7beeecd0d0553d9b2c46d35e6546ff0a23377
-  data.tar.gz: f3e79890b4d421628bbbf21680d676a83446915b34a067eb1d25fe45806ed4e78f8729be5a15f4308d1f50cfb51911c7235e05762841dd0ca264df997f3b5538
+  metadata.gz: 4aaf8fe2928bb4652dc5a7b1f235fadc7114580cfc29d91a9fdf508edbba15cccc09627b6a097552774c73babede934ca77a9388fa7ce1bfdbfb5975ab0661da
+  data.tar.gz: cc2ec1780014bfb5043a44857a2d9fc6eb7957ec245fef03accbe64436c11cc9f2596105d25d5e888b136ca27d57565ec414f9fbb466f72fc425744d6fe69af2

data/.rubocop.yml

@@ -0,0 +1,96 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+# Globals
+
+AllCops:
+  NewCops: enable
+
+# Layout
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+# Metrics
+
+Metrics/AbcSize:
+  CountRepeatedAttributes: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/ClassLength:
+  Max: 150
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/MethodLength:
+  Max: 20
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/ModuleLength:
+  Max: 150
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+# Rspec
+
+RSpec/ExampleLength:
+  Max: 25
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 10
+
+# Style
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Exclude:
+    - 'adornable.gemspec'
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -1,6 +1,6 @@
 # Adornable
 
-Adornable provides method decorators in Ruby... 'nuff said.
+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.
 
 ## Installation
 
@@ -26,8 +26,6 @@ Alternatively, install it globally:
 gem install adornable
 ```
 
-...but why would you do that?
-
 ## Usage
 
 ### The basics
@@ -75,9 +73,9 @@ value2 = random_value_generator.value
 #=> 0.4196007135344746
 ```
 
-...but you have a million more methods to write, and if you refactor, you'll have to screw around with a whole metric butt-load of method definitions across your app.
+However, you have a million more methods to write, and if you refactor, you'll have to screw around with a slew of method definitions across your app.
 
-How about this instead?
+What if you could do this, instead, to achieve the same result?
 
 ```rb
 class RandomValueGenerator
@@ -90,33 +88,11 @@ class RandomValueGenerator
   end
 
   decorate :log
-  decorate :memoize_for_arguments
+  decorate :memoize
   def values(max)
     (1..max).map { rand }
   end
 end
-
-random_value_generator = RandomValueGenerator.new
-
-values1 = random_value_generator.values(1000)
-# Calling method `RandomValueGenerator#values` with arguments `[1000]`
-#=> [0.7044444114998132, 0.401953296596267, 0.3023797513191562, ...]
-
-values1 = random_value_generator.values(1000)
-# Calling method `RandomValueGenerator#values` with arguments `[1000]`
-#=> [0.7044444114998132, 0.401953296596267, 0.3023797513191562, ...]
-
-values3 = random_value_generator.values(5000)
-# Calling method `RandomValueGenerator#values` with arguments `[5000]`
-#=> [0.9916088057511011, 0.04466750434972333, 0.6073659341272127]
-
-value1 = random_value_generator.value
-# Calling method `RandomValueGenerator#value` with no arguments
-#=> 0.4196007135344746
-
-value2 = random_value_generator.value
-# Calling method `RandomValueGenerator#value` with no arguments
-#=> 0.4196007135344746
 ```
 
 Nice, right?
@@ -141,7 +117,7 @@ Use the `decorate` macro to decorate methods.
 
 #### Using built-in decorators
 
-There are a few built-in decorators:
+There are a couple of built-in decorators for common use-cases (these can be overridden if you so choose):
 
 ```rb
 class Foo
@@ -149,56 +125,64 @@ class Foo
 
   decorate :log
   def some_method
-    # ...
+    # the method name (Foo#some_method) and arguments will be logged
   end
 
   decorate :memoize
   def some_other_method
-    # ...
+    # the return value will be cached
   end
 
-  decorate :memoize_for_arguments
+  decorate :memoize
   def yet_another_method(some_arg, some_other_arg = true, key_word_arg:, key_word_arg_with_default: 123)
-    # ...
+    # the return value will be cached based on the arguments the method receives
   end
 
   decorate :log
-  decorate :memoize_for_arguments
+  decorate :memoize, for_any_arguments: true
   def oh_boy_another_method(some_arg, some_other_arg = true, key_word_arg:, key_word_arg_with_default: 123)
-    # ...
+    # the method name (Foo#oh_boy_another_method) and arguments will be logged
+    # the return value will be cached regardless of the arguments received
   end
 
   decorate :log
   def self.yeah_it_works_on_class_methods_too
-    # ...
+    # the method name (Foo::yeah_it_works_on_class_methods_too) and arguments
+    # will be logged
   end
 end
 ```
 
 - `decorate :log` logs the method name and any passed arguments to the console
-- `decorate :memoize` caches the result of the first call and returns that initial result (and does not execute the method again) for any additional calls
-- `decorate :memoize_for_arguments` acts like `decorate :memoize` but it namespaces that cache by the arguments passed, so it will re-compute (and cache the result) only if the arguments change... if the arguments are the same as any previous time the method was called, it will return the cached result instead
+- `decorate :memoize` caches the result of the first call and returns that initial result (and does not execute the method again) for any additional calls. By default, it namespaces the cache by the arguments passed to the method, so it will re-compute  only if the arguments change; if the arguments are the same as any previous time the method was called, it will return the cached result instead.
+  - pass the `for_any_arguments: true` option (e.g., `decorate :memoize, for_any_arguments: true`) to ignore the arguments in the caching process and simply memoize the result no matter what
+  - a `nil` value returned from a memoized method will still be cached like any other value
 
 > **Note:** in the case of multiple decorators decorating a method, each is executed from top to bottom.
 
-#### Using custom decorators explicitly
+#### Writing custom decorators and using them _explicitly_
 
 You can reference any decorator method you write, like so:
 
 ```rb
 class FooDecorators
-  # Note: this is a class method
-  def self.blast_it(method_receiver, method_name, arguments)
+  # Note: this is defined as a CLASS method, but it can be applied to both class
+  #       and instance methods. The only difference is in how you source the
+  #       decorator when doing the decoration; see below for more info.
+  def self.blast_it(context)
     puts "Blasting it!"
     value = yield
     "#{value}!"
   end
 
-  # Note: this is an instance method
-  def wait_for_it(method_receiver, method_name, arguments)
-    puts "Waiting..."
+  # Note: this is defined as an INSTANCE method, but it can be applied to both
+  #       class and instance methods. The only difference is in how you source
+  #       the decorator when doing the decoration; see below for more info.
+  def wait_for_it(context, dot_count: 3)
+    ellipsis = dot_count.times.map { '.' }.join
+    puts "Waiting for it#{ellipsis}"
     value = yield
-    "#{value}..."
+    "#{value}#{ellipsis}"
   end
 end
 
@@ -238,60 +222,73 @@ foo.yet_another_method(123, bloop: "bleep")
 #=> "haha I'm yet another method"
 ```
 
-Use the `from:` option to specify what should receive the decorator method. Keep in mind that the decorator method will be called on the thing specified by `from:`... so, if you provide a class, it better be a class method, and if you supply an instance, it better be an instance method.
+Use the `from:` option to specify what should receive the decorator method. Keep in mind that the decorator method will be called on the thing specified by `from:`... so, if you provide a class, it better be a class method on that thing, and if you supply an instance, it better be an instance method on that thing.
 
-Every decorator method must take the following arguments:
+Every custom decorator method that you define must take one required argument (`context`) and any number of keyword arguments. It should also `yield` (or take a block argument and invoke it) at some point in the body of the method. The point at which you `yield` will be the point at which the decorated method will execute (or, if there are multiple decorators on the method, each following decorator will be invoked until the decorators have been exhausted and the decorated method is finally executed).
 
-- `method_receiver`: the actual object that the [decorated] method is being called on (an object/class); e.g., `Foo` or an instance of `Foo`
-- `method_name`: the name of the [decorated] method being called on `method_receiver` (a symbol); e.g., `:some_method` or `:other_method`
-- `arguments`: an array of arguments passed to the [decorated] method, including keyword arguments; e.g., if `:yet_another_method` was called like `Foo.new.yet_another_method(123, bar: true)` then `arguments` would be `[123, {:bar=>true}]`
+##### The required argument (`context`)
 
-> **Note:** Every decorator method _should_ also probably `yield` at some point in the method body. I say _"should"_ because, technically, you don't have to, but if you don't then the original method will never be called. That's a valid use-case, but 99% of the time you're gonna want to `yield`.
->
-> **Note:** the return value of your decorator **will replace the return value of the decorated method,** so _also_ you should probably return whatever value `yield` returned. Again, it is a valid use case to return something _else,_ but 99% of the time you probably want to return the value returned by the wrapped method.
+The **required argument** is an instance of `Adornable::Context`, which has some useful information about the decorated method being called
 
-Contrived example of when you might want to muck around with the return value:
+- `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}]`)
 
-```rb
-class FooDecorators
-  def self.coerce_to_int(method_receiver, method_name, arguments)
-    value = yield
-    new_value = value.strip.to_i
-    puts "New value: #{value.inspect} (class: #{value.class})"
-    new_value
-  end
-end
+##### Custom keyword arguments (optional)
 
-class Foo
-  extend Adornable
+The **optional keyword arguments** are any parameters you want to be able to pass to the decorator method when decorating a method with `::decorate`:
 
-  decorate :coerce_to_int, from: FooDecorators
-  def get_number_from_user
-    print "Enter a number: "
-    value = gets
-    puts "Value: #{value.inspect} (class: #{value.class})"
-    value
-  end
-end
+- If you define a decorator like `def self.some_decorator(context)` then it takes no options when it is used: `decorate :some_decorator`.
+- If you define a decorator like `def self.some_decorator(context, some_option:)` then it takes one _required_ keyword argument when it is used: `decorate :some_decorator, some_option: 123` (so that `::some_decorator` will receive `123` as the `some_option` parameter every time the decorated method is called). You can customize functionality of the decorator this way.
+- Similarly, if you define a decorator like `def self.some_decorator(context, some_option: 456)`, then it takes one _optional_ keyword argument when it is used: `decorate :some_decorator` is valid (and implies `some_option: 456` since it has a default), and `decorate :some_decorator, some_option: 789` is valid as well.
 
-foo = Foo.new
+##### Yielding to the next decorator/decorated method
 
-foo.get_number_from_user
-# Enter a number
-# > 123
-# Value: "123" (class: String)
-# New value: 123 (class: Integer)
-#=> 123
-```
+Every decorator method **should also probably `yield`** at some point in the method body. I say _"should"_ because, technically, you don't have to, but if you don't then the original method will never be called. That's a valid use-case, but 99% of the time you're gonna want to `yield`.
+
+> **Note:** the return value of your decorator **will replace the return value of the decorated method,** so _also_ you should probably return whatever value `yield` returned. Again, it is a valid use case to return something _else,_ but 99% of the time you probably want to return the value returned by the wrapped method.
+>
+> A contrived example of when you might want to muck around with the return value:
+>
+> ```rb
+> class FooDecorators
+>   def self.coerce_to_int(context)
+>     value = yield
+>     new_value = value.strip.to_i
+>     puts "New value: #{value.inspect} (class: #{value.class})"
+>     new_value
+>   end
+> end
+>
+> class Foo
+>   extend Adornable
+>
+>   decorate :coerce_to_int, from: FooDecorators
+>   def get_number_from_user
+>     print "Enter a number: "
+>     value = gets
+>     puts "Value: #{value.inspect} (class: #{value.class})"
+>     value
+>   end
+> end
+>
+> foo = Foo.new
+>
+> foo.get_number_from_user
+> # Enter a number
+> # > 123
+> # Value: "123" (class: String)
+> # New value: 123 (class: Integer)
+> #=> 123
+> ```
 
-#### Using custom decorators implicitly
+#### Writing custom decorators and using them _implicitly_
 
 You can also register decorator receivers so that you don't have to reference them with the `from:` option:
 
 ```rb
 class FooDecorators
-  # Note: this is a class method
-  def self.blast_it(method_receiver, method_name, arguments)
+  def self.blast_it(context)
     puts "Blasting it!"
     value = yield
     "#{value}!"
@@ -299,11 +296,11 @@ class FooDecorators
 end
 
 class MoreFooDecorators
-  # Note: this is a class method
-  def self.wait_for_it(method_receiver, method_name, arguments)
-    puts "Waiting for it..."
+  def wait_for_it(context, dot_count: 3)
+    ellipsis = dot_count.times.map { '.' }.join
+    puts "Waiting for it#{ellipsis}"
     value = yield
-    "#{value}..."
+    "#{value}#{ellipsis}"
   end
 end
 
@@ -311,10 +308,10 @@ class Foo
   extend Adornable
 
   add_decorators_from FooDecorators
-  add_decorators_from MoreFooDecorators
+  add_decorators_from MoreFooDecorators.new
 
   decorate :blast_it
-  decorate :wait_for_it
+  decorate :wait_for_it, dot_count: 9
   def some_method
     "haha I'm a method"
   end
@@ -324,12 +321,14 @@ foo = Foo.new
 
 foo.some_method
 # Blasting it!
-# Waiting for it...
-#=> "haha I'm a method!..."
+# Waiting for it.........
+#=> "haha I'm a method!........."
 ```
 
-> **Note:** In the case of duplicate decorator methods, later receivers registered with `::add_decorators_from` will override any duplicate decorators from earlier registered receivers.
->
+> **Note:** All the rest of the stuff from the previous section (using decorators explicitly) also applies here (using decorators implicitly).
+
+> **Note:** In the case of duplicate decorator methods, later receivers registered with `::add_decorators_from` will override any decorators by the same name from earlier registered receivers.
+
 > **Note:** in the case of multiple decorators decorating a method, each is executed from top to bottom; i.e., the top wraps the next, which wraps the next, and so on, until the method itself is wrapped.
 
 ## Development
@@ -340,12 +339,18 @@ foo.some_method
 bin/setup
 ```
 
-### Run testss
+### Run the tests
 
 ```bash
 rake spec
 ```
 
+### Run the linter
+
+```bash
+rubocop
+```
+
 ### Create release
 
 ```

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/adornable.gemspec

@@ -1,29 +1,36 @@
+# frozen_string_literal: true
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "adornable/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "adornable"
-  spec.version       = Adornable::VERSION
-  spec.authors       = ["Keegan Leitz"]
-  spec.email         = ["kjleitz@gmail.com"]
+  spec.name = "adornable"
+  spec.version = Adornable::VERSION
+  spec.authors = ["Keegan Leitz"]
+  spec.email = ["kjleitz@gmail.com"]
 
-  spec.summary       = "Method decorators for Ruby"
-  spec.description   = "Method decorators for Ruby"
-  spec.homepage      = "https://github.com/kjleitz/adornable"
-  spec.license       = "MIT"
+  spec.summary = "Method decorators for Ruby"
+  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"
 
   # 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.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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"
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "adornable"

data/lib/adornable.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 require "adornable/version"
 require "adornable/utils"
 require "adornable/error"
 require "adornable/decorators"
 require "adornable/machinery"
 
+# Extend the `Adornable` module in your class in order to have access to the
+# `decorate` and `add_decorators_from` macros.
 module Adornable
   def adornable_machinery
     @adornable_machinery ||= Adornable::Machinery.new
   end
 
-  def decorate(decorator_name, from: nil, defer_validation: false)
+  def decorate(decorator_name, from: nil, defer_validation: false, **decorator_options)
     if Adornable::Utils.blank?(name)
       raise Adornable::Error::InvalidDecoratorArguments, "Decorator name must be provided."
     end
@@ -17,7 +21,8 @@ module Adornable
     adornable_machinery.accumulate_decorator!(
       name: decorator_name,
       receiver: from,
-      defer_validation: !!defer_validation
+      defer_validation: !!defer_validation,
+      decorator_options: decorator_options,
     )
   end
 
@@ -27,9 +32,10 @@ module Adornable
 
   def method_added(method_name)
     machinery = adornable_machinery # for local variable
-    return unless machinery.has_accumulated_decorators?
+    return unless machinery.accumulated_decorators?
+
     machinery.apply_accumulated_decorators_to_instance_method!(method_name)
-    original_method = self.instance_method(method_name)
+    original_method = instance_method(method_name)
     define_method(method_name) do |*args|
       bound_method = original_method.bind(self)
       machinery.run_decorated_instance_method(bound_method, *args)
@@ -39,9 +45,10 @@ module Adornable
 
   def singleton_method_added(method_name)
     machinery = adornable_machinery # for local variable
-    return unless machinery.has_accumulated_decorators?
+    return unless machinery.accumulated_decorators?
+
     machinery.apply_accumulated_decorators_to_class_method!(method_name)
-    original_method = self.method(method_name)
+    original_method = method(method_name)
     define_singleton_method(method_name) do |*args|
       machinery.run_decorated_class_method(original_method, *args)
     end

data/lib/adornable/context.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Adornable
+  # A context object is passed to the decorator method, and contains information
+  # about the decorated method being called.
+  class Context
+    attr_reader(*%i[
+      method_receiver
+      method_name
+      method_arguments
+      decorator_name
+      decorator_options
+    ])
+
+    def initialize(method_receiver:, method_name:, method_arguments:, decorator_name:, decorator_options:)
+      @method_receiver = method_receiver
+      @method_name = method_name
+      @method_arguments = method_arguments
+      @decorator_name = decorator_name
+      @decorator_options = decorator_options
+    end
+  end
+end

data/lib/adornable/decorators.rb

@@ -1,29 +1,47 @@
+# frozen_string_literal: true
+
+require 'adornable/utils'
+
 module Adornable
+  # `Adornable::Decorators` is used as the default namespace for decorator
+  # methods when a decorator method that is neither explicitly sourced (via the
+  # `decorate from: <receiver>` option) nor implicitly sourced (via the
+  # `add_decorators_from <receiver>` macro).
   class Decorators
-    def self.log(method_receiver, method_name, arguments)
-      receiver_name, name_delimiter = if method_receiver.is_a?(Class)
-        [method_receiver.to_s, '::']
-      else
-        [method_receiver.class.to_s, '#']
-      end
-      full_name = "`#{receiver_name}#{name_delimiter}#{method_name}`"
-      arguments_desc = arguments.empty? ? "no arguments" : "arguments `#{arguments}`"
+    def self.log(context)
+      method_receiver = context.method_receiver
+      method_name = context.method_name
+      method_args = context.method_arguments
+      full_name = Adornable::Utils.formal_method_name(method_receiver, method_name)
+      arguments_desc = method_args.empty? ? "no arguments" : "arguments `#{method_args.inspect}`"
       puts "Calling method #{full_name} with #{arguments_desc}"
       yield
     end
 
-    def self.memoize(method_receiver, method_name, arguments)
+    def self.memoize(context, for_any_arguments: false, &block)
+      return memoize_for_arguments(context, &block) unless for_any_arguments
+
+      method_receiver = context.method_receiver
+      method_name = context.method_name
       memo_var_name = :"@adornable_memoized_#{method_receiver.object_id}_#{method_name}"
-      existing = instance_variable_get(memo_var_name)
-      value = existing.nil? ? yield : existing
-      instance_variable_set(memo_var_name, value)
+
+      if instance_variable_defined?(memo_var_name)
+        instance_variable_get(memo_var_name)
+      else
+        instance_variable_set(memo_var_name, yield)
+      end
     end
 
-    def self.memoize_for_arguments(method_receiver, method_name, arguments)
-      memo_var_name = :"@adornable_memoized_#{method_receiver.object_id}__#{method_name}__#{arguments}"
-      existing = instance_variable_get(memo_var_name)
-      value = existing.nil? ? yield : existing
-      instance_variable_set(memo_var_name, value)
+    def self.memoize_for_arguments(context)
+      method_receiver = context.method_receiver
+      method_name = context.method_name
+      method_args = context.method_arguments
+      memo_var_name = :"@adornable_memoized_for_arguments_#{method_receiver.object_id}_#{method_name}"
+      memo = instance_variable_get(memo_var_name) || {}
+      instance_variable_set(memo_var_name, memo)
+      args_key = method_args.inspect
+      memo[args_key] = yield unless memo.key?(args_key)
+      memo[args_key]
     end
   end
 end

data/lib/adornable/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Adornable
   module Error
     class Base < ::StandardError

data/lib/adornable/machinery.rb

@@ -1,22 +1,30 @@
+# frozen_string_literal: true
+
 require 'adornable/utils'
 require 'adornable/error'
+require 'adornable/context'
 
 module Adornable
-  class Machinery
+  class Machinery # :nodoc:
     def register_decorator_receiver!(receiver)
       registered_decorator_receivers.unshift(receiver)
     end
 
-    def accumulate_decorator!(name:, receiver:, defer_validation:)
+    def accumulate_decorator!(name:, receiver:, defer_validation:, decorator_options:)
       name = name.to_sym
       receiver ||= find_suitable_receiver_for(name)
       validate_decorator!(name, receiver) unless defer_validation
 
-      decorator = { name: name, receiver: receiver }
+      decorator = {
+        name: name,
+        receiver: receiver,
+        options: decorator_options || {},
+      }
+
       accumulated_decorators << decorator
     end
 
-    def has_accumulated_decorators?
+    def accumulated_decorators?
       Adornable::Utils.present?(accumulated_decorators)
     end
 
@@ -80,14 +88,31 @@ module Adornable
       @class_method_decorators[name] = decorators || []
     end
 
-    def run_decorators(decorators, bound_method, *args)
-      return bound_method.call(*args) if Adornable::Utils.blank?(decorators)
+    def run_decorators(decorators, bound_method, *method_arguments)
+      return bound_method.call(*method_arguments) if Adornable::Utils.blank?(decorators)
+
       decorator, *remaining_decorators = decorators
-      name = decorator[:name]
-      receiver = decorator[:receiver]
-      validate_decorator!(name, receiver, bound_method)
-      receiver.send(name, bound_method.receiver, bound_method.name, args) do
-        run_decorators(remaining_decorators, bound_method, *args)
+      decorator_name = decorator[:name]
+      decorator_receiver = decorator[:receiver]
+      decorator_options = decorator[:options]
+      validate_decorator!(decorator_name, decorator_receiver, bound_method)
+
+      context = Adornable::Context.new(
+        method_receiver: bound_method.receiver,
+        method_name: bound_method.name,
+        method_arguments: method_arguments,
+        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)
       end
     end
 
@@ -97,6 +122,7 @@ module Adornable
       end
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Layout/LineLength
     def validate_decorator!(decorator_name, decorator_receiver, bound_method = nil)
       return if decorator_receiver.respond_to?(decorator_name)
 
@@ -106,7 +132,7 @@ module Adornable
         method_location = bound_method.source_location
         "Cannot decorate `#{method_full_name}` (defined at `#{method_location.first}:#{method_location.second})."
       end
-      
+
       base_message = "Decorator method `#{decorator_name.inspect}` cannot be found on `#{decorator_receiver.inspect}`."
 
       definition_hint = if decorator_receiver.is_a?(Class) && decorator_receiver.instance_methods.include?(decorator_name)
@@ -120,5 +146,6 @@ module Adornable
       message = [location_hint, base_message, definition_hint].compact.join(" ")
       raise Adornable::Error::InvalidDecoratorArguments, message
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Layout/LineLength
   end
 end

data/lib/adornable/utils.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Adornable
-  class Utils
+  class Utils # :nodoc:
     class << self
       def blank?(value)
         value.nil? || (value.respond_to?(:empty?) && value.empty?)
@@ -12,6 +14,15 @@ module Adornable
       def presence(value)
         value if present?(value)
       end
+
+      def formal_method_name(method_receiver, method_name)
+        receiver_name, name_delimiter = if method_receiver.is_a?(Class)
+          [method_receiver.to_s, '::']
+        else
+          [method_receiver.class.to_s, '#']
+        end
+        "`#{receiver_name}#{name_delimiter}#{method_name}`"
+      end
     end
   end
 end

data/lib/adornable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adornable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Keegan Leitz
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,83 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Method decorators for Ruby
+- !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'
+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.
 email:
 - kjleitz@gmail.com
 executables: []
@@ -61,9 +137,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -71,6 +147,7 @@ files:
 - bin/console
 - bin/setup
 - lib/adornable.rb
+- lib/adornable/context.rb
 - lib/adornable/decorators.rb
 - lib/adornable/error.rb
 - lib/adornable/machinery.rb
@@ -80,7 +157,7 @@ homepage: https://github.com/kjleitz/adornable
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -88,15 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.0.9
+signing_key: 
 specification_version: 4
 summary: Method decorators for Ruby
 test_files: []