adornable 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962cc3a7645f1a3fb6d729907b0d51d57c5c246d194ce3618516085831625fff
-  data.tar.gz: cedbf0bed0c105d3ae2336e2da7c872b193c0706c7eef7b4d3f40d1437704d97
+  metadata.gz: 39c5f35488e69b6f4de57d24b3a4867552fdb7e72a59a98017cd59af19dbc7f7
+  data.tar.gz: 3d9998525bb6393c681cb2688d3ba3d2df321ae5e39f598e9c8ea7a3bed9cd8e
 SHA512:
-  metadata.gz: 41e131cde6f78b610f6417b8a7a2710f7be4fc13261db3902b97a4d8781880ea930a665392094868d733bd400bd0d66be1cb187f0c310240958200cb8808597e
-  data.tar.gz: b93c1072a77b5b1b667fea3493466c6fc5bcf544c4d750c1c8ae36c1f260ee0b4fcfe50c09255ac7c32dda287206b1f32130aede3867d7b2c4dd5296e26953ef
+  metadata.gz: 9a26ac80096736eaa6e20d6c63250686491b528e915603723f933879dfda9d10ce0e17e73531e7a4c46b7eb4d47efdbb152f9c0da78fab89850740a11fb6f8d2
+  data.tar.gz: 44ea1ed9f80932ea5214e7287bbbc40c5a385c10eb5b9dce52f34dc5e915fff6ff3d5da854084f0a342d6728657420f4ce940d1e27d94c3c3cb629bddbd9f272

data/.rubocop.yml

@@ -0,0 +1,59 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+# Layout
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_spec.rb'
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+# Metrics
+
+Metrics/AbcSize:
+  CountRepeatedAttributes: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_spec.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_spec.rb'
+
+# Rspec
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 10
+
+# Style
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Exclude:
+    - 'adornable.gemspec'
+
+Style/StringLiterals:
+  Enabled: false

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/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,35 @@
+# 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 = "Method decorators for Ruby"
+  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 "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"
 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,9 +1,13 @@
+# 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
@@ -27,9 +31,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 +44,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/decorators.rb

@@ -1,4 +1,10 @@
+# frozen_string_literal: true
+
 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)
@@ -12,7 +18,7 @@ module Adornable
       yield
     end
 
-    def self.memoize(method_receiver, method_name, arguments)
+    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

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,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'adornable/utils'
 require 'adornable/error'
 
 module Adornable
-  class Machinery
+  class Machinery # :nodoc:
     def register_decorator_receiver!(receiver)
       registered_decorator_receivers.unshift(receiver)
     end
@@ -16,7 +18,7 @@ module Adornable
       accumulated_decorators << decorator
     end
 
-    def has_accumulated_decorators?
+    def accumulated_decorators?
       Adornable::Utils.present?(accumulated_decorators)
     end
 
@@ -82,6 +84,7 @@ module Adornable
 
     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]
@@ -97,16 +100,19 @@ module Adornable
       end
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Layout/LineLength
     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)
@@ -120,5 +126,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/MethodLength, 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?)

data/lib/adornable/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adornable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Keegan Leitz
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !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'
 description: Method decorators for Ruby
 email:
 - kjleitz@gmail.com
@@ -61,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -88,7 +145,7 @@ 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:
   - - ">="