adornable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5866ce4d639cd7201a6467800e5ac85fa9e6b823c57496e8ac670059b5d7f5a
+  data.tar.gz: '0418007247c26928a448fd069495b41cdd722d8902f7894185c7589ac8586d2e'
+SHA512:
+  metadata.gz: be5afe7b6f0eaadd690d4c1e62112a71d1e2f9d26481cec53bf4358a99394809d1d8f2b6a71bf464316320776753bb687bc65e71b96378aabe378da0f2065463
+  data.tar.gz: 250c536c81d0ad0b5c7388af95623e1fc563b0fc41522902542a1e7e2ff9ca0f3f25f6e39378cc1d780ce048e4f184ab4d8a75c2a2f5d1c4ca3621e1084b645d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.7
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in adornable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    adornable (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adornable!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,35 @@
+# Adornable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/adornable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adornable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adornable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/adornable.

data/Rakefile

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

data/adornable.gemspec

@@ -0,0 +1,29 @@
+
+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.summary       = "Method decorators for Ruby"
+  spec.description   = "Method decorators for Ruby"
+  spec.homepage      = "https://github.com/kjleitz/adornable"
+  spec.license       = "MIT"
+
+  # 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
+    `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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "adornable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adornable.rb

@@ -0,0 +1,50 @@
+require "adornable/version"
+require "adornable/utils"
+require "adornable/error"
+require "adornable/decorators"
+require "adornable/machinery"
+
+module Adornable
+  def adornable_machinery
+    @adornable_machinery ||= Adornable::Machinery.new
+  end
+
+  def decorate(decorator_name, from: nil, defer_validation: false)
+    if Adornable::Utils.blank?(name)
+      raise Adornable::Error::InvalidDecoratorArguments, "Decorator name must be provided."
+    end
+
+    adornable_machinery.accumulate_decorator!(
+      name: decorator_name,
+      receiver: from,
+      defer_validation: !!defer_validation
+    )
+  end
+
+  def add_decorators_from(receiver)
+    adornable_machinery.register_decorator_receiver!(receiver)
+  end
+
+  def method_added(method_name)
+    machinery = adornable_machinery # for local variable
+    return unless machinery.has_accumulated_decorators?
+    machinery.apply_accumulated_decorators_to_instance_method!(method_name)
+    original_method = self.instance_method(method_name)
+    define_method(method_name) do |*args|
+      bound_method = original_method.bind(self)
+      machinery.run_decorated_instance_method(bound_method, *args)
+    end
+    super
+  end
+
+  def singleton_method_added(method_name)
+    machinery = adornable_machinery # for local variable
+    return unless machinery.has_accumulated_decorators?
+    machinery.apply_accumulated_decorators_to_class_method!(method_name)
+    original_method = self.method(method_name)
+    define_singleton_method(method_name) do |*args|
+      machinery.run_decorated_class_method(original_method, *args)
+    end
+    super
+  end
+end

data/lib/adornable/decorators.rb

@@ -0,0 +1,29 @@
+module Adornable
+  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}`"
+      puts "Calling method #{full_name} with #{arguments_desc}"
+      yield
+    end
+
+    def self.memoize(method_receiver, method_name, arguments)
+      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)
+    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)
+    end
+  end
+end

data/lib/adornable/error.rb

@@ -0,0 +1,9 @@
+module Adornable
+  module Error
+    class Base < ::StandardError
+    end
+
+    class InvalidDecoratorArguments < Adornable::Error::Base
+    end
+  end
+end

data/lib/adornable/machinery.rb

@@ -0,0 +1,124 @@
+require 'adornable/utils'
+require 'adornable/error'
+
+module Adornable
+  class Machinery
+    def register_decorator_receiver!(receiver)
+      registered_decorator_receivers.unshift(receiver)
+    end
+
+    def accumulate_decorator!(name:, receiver:, defer_validation:)
+      name = name.to_sym
+      receiver ||= find_suitable_receiver_for(name)
+      validate_decorator!(name, receiver) unless defer_validation
+
+      decorator = { name: name, receiver: receiver }
+      accumulated_decorators << decorator
+    end
+
+    def has_accumulated_decorators?
+      Adornable::Utils.present?(accumulated_decorators)
+    end
+
+    def apply_accumulated_decorators_to_instance_method!(method_name)
+      set_instance_method_decorators!(method_name, accumulated_decorators)
+      clear_accumulated_decorators!
+    end
+
+    def apply_accumulated_decorators_to_class_method!(method_name)
+      set_class_method_decorators!(method_name, accumulated_decorators)
+      clear_accumulated_decorators!
+    end
+
+    def run_decorated_instance_method(bound_method, *args)
+      decorators = get_instance_method_decorators(bound_method.name)
+      run_decorators(decorators, bound_method, *args)
+    end
+
+    def run_decorated_class_method(bound_method, *args)
+      decorators = get_class_method_decorators(bound_method.name)
+      run_decorators(decorators, bound_method, *args)
+    end
+
+    private
+
+    def registered_decorator_receivers
+      @registered_decorator_receivers ||= [Adornable::Decorators]
+    end
+
+    def accumulated_decorators
+      @accumulated_decorators ||= []
+    end
+
+    def clear_accumulated_decorators!
+      @accumulated_decorators = []
+    end
+
+    def get_instance_method_decorators(method_name)
+      name = method_name.to_sym
+      @instance_method_decorators ||= {}
+      @instance_method_decorators[name] ||= []
+      @instance_method_decorators[name]
+    end
+
+    def set_instance_method_decorators!(method_name, decorators)
+      name = method_name.to_sym
+      @instance_method_decorators ||= {}
+      @instance_method_decorators[name] = decorators || []
+    end
+
+    def get_class_method_decorators(method_name)
+      name = method_name.to_sym
+      @class_method_decorators ||= {}
+      @class_method_decorators[name] ||= []
+      @class_method_decorators[name]
+    end
+
+    def set_class_method_decorators!(method_name, decorators)
+      name = method_name.to_sym
+      @class_method_decorators ||= {}
+      @class_method_decorators[name] = decorators || []
+    end
+
+    def run_decorators(decorators, bound_method, *args)
+      return bound_method.call(*args) 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)
+      end
+    end
+
+    def find_suitable_receiver_for(decorator_name)
+      registered_decorator_receivers.detect do |receiver|
+        receiver.respond_to?(decorator_name)
+      end
+    end
+
+    def validate_decorator!(decorator_name, decorator_receiver, bound_method = nil)
+      return if decorator_receiver.respond_to?(decorator_name)
+
+      location_hint = if bound_method
+        method_receiver = bound_method.receiver
+        method_full_name = method_receiver.is_a?(Class) ? "#{method_receiver}::#{method.name}" : "#{method_receiver.class}##{method.name}"
+        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)
+        class_name = decorator_receiver.inspect
+        "It is, however, an instance method of the class. To use this decorator method, either A) supply an instance of the `#{class_name}` class to the `found_on:` option (instead of the class itself), B) convert the instance method `#{class_name}##{decorator_name}` to a class method, or C) create a new class method on `#{class_name}` of the same decorator_name."
+      elsif !decorator_receiver.is_a?(Class) && decorator_receiver.class.methods.include?(decorator_name)
+        class_name = decorator_receiver.class.inspect
+        "It is, however, a method of this instance's class. To use this decorator method, either A) supply the `#{class_name}` class itself to the `found_on:` option (instead of an instance of that class), B) convert the class method `#{class_name}::#{decorator_name}` to an instance method, or C) create a new instance method on `#{class_name}` of the same name."
+      end
+
+      message = [location_hint, base_message, definition_hint].compact.join(" ")
+      raise Adornable::Error::InvalidDecoratorArguments, message
+    end
+  end
+end

data/lib/adornable/utils.rb

@@ -0,0 +1,17 @@
+module Adornable
+  class Utils
+    class << self
+      def blank?(value)
+        value.nil? || (value.respond_to?(:empty?) && value.empty?)
+      end
+
+      def present?(value)
+        !blank?(value)
+      end
+
+      def presence(value)
+        value if present?(value)
+      end
+    end
+  end
+end

data/lib/adornable/version.rb

@@ -0,0 +1,3 @@
+module Adornable
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: adornable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Keegan Leitz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: Method decorators for Ruby
+email:
+- kjleitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- adornable.gemspec
+- bin/console
+- bin/setup
+- lib/adornable.rb
+- lib/adornable/decorators.rb
+- lib/adornable/error.rb
+- lib/adornable/machinery.rb
+- lib/adornable/utils.rb
+- lib/adornable/version.rb
+homepage: https://github.com/kjleitz/adornable
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Method decorators for Ruby
+test_files: []