modifiers 1.1.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 1c529f23f0c4fe7d0417b298daabad35a18c98ba
-  data.tar.gz: 4e26087e2b3d2a386417c3ae74bef0dfac9ef131
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yzc0Y2YyNjU3YjUyOTRjYWE1ZjcwMmQxZjFhN2FiNTgxNThiMjMwNg==
+  data.tar.gz: !binary |-
+    NGMyZTkyMzViNjM4NjUwYTE0ZWJmNmIxODg5ZjBhNmYzNzQyZmJiMw==
 SHA512:
-  metadata.gz: 7cae095e6a838c2e06094242f883ad3bd18db3841bd931abee97dcd8b507990ad5a1e851d241b85ddfa1de3d90ab5a465aac3b5bed809a4830317405a2cab543
-  data.tar.gz: b1649f83e589491f7da170b057be4121be762efc592f06cb7c228c92a2d2d3e74a871859b5cc2b6b80b777976f575b16d7c688e7c901699dbf8ddfef314ef183
+  metadata.gz: !binary |-
+    ZDIxNDVmYTFmNzY0ODQ3YWRkMjljOWZkNjk4Mjg0YTZmOTE4ZDZlY2RiZjUw
+    NDBkZjFiNmRiYzk3ODM4MTA3MTQzNmU1M2VlMmY3NTVjNTYyZGUwNzU1MTU0
+    NDEzOTM2MmQ1MDQyMDE0ZjczNTg4MWNiNGNiNmZmNWQ4Y2JkN2U=
+  data.tar.gz: !binary |-
+    NzcwMjZmNTA5MzJhYTdhMWM2MDM2NGM2OTQ5YzliZWNlZmVmM2Y1MGFmY2Ux
+    MDNkMDYyNjAyM2UxZGZlNGZlY2NkMmQ1YWY0ZDVlZjg1OTYxMzIxMTg1ZWRk
+    MTM3NzYxMjM3YzUzY2I4NTRiZTc5NDQ1NDZkYzhjNTZlNmVhMjc=

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: .rubocop_todo.yml
+Metrics/LineLength:
+  Max: 120
+Style/Documentation:
+  Exclude:
+    - spec/**/*.rb

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-09-20 01:40:17 +0000 using RuboCop version 0.26.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 11
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,12 +1,13 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
+- 2.0.0
+- 2.1.5
 deploy:
   provider: rubygems
   api_key:
-    secure: fewAgjCXLYSkbRq57EQYRTjwPn/LfQgpvSh1HBdVG1Vjds2OCL+yl3d6x30o4q28GU7dMLKjEl2BZrrQ9TwPgit3LRPUwlsoZRvGQj+oztdNfshpWansne6coBYa5vx/tQFBSDWkTMdE2RMH1w7qP20Iqn44c4yQU1tQiqWoZMQ=
+    secure: ZPeXm1QrIHsDx+ltW0aQ5mKK2vdeRHiHltBHO+KnnWMygHmeoe4ophwQetUhee/oH1LL9W1KdpLc+tSvt64PN0WooMdJtsbOA7M3DLOZGSrqNtTHM3b0xcLrQFIg8wLKDlp/0jx4xUFHybCIapsXT2N+Q8EdgtiS1lwRKEcN44I=
+  gem: modifiers
   on:
     tags: true
+    repo: nicknovitski/modifiers
+    all_branches: true

data/README.md

@@ -1,11 +1,11 @@
 # Modifiers
-[![Build Status](https://travis-ci.org/nicknovitski/modifiers.svg?branch=master)](https://travis-ci.org/nicknovitski/modifiers)
+[![Build Status](https://travis-ci.org/nicknovitski/modifiers.svg?branch=master)](https://travis-ci.org/nicknovitski/modifiers) [![Code Climate](https://codeclimate.com/github/nicknovitski/modifiers/badges/gpa.svg)](https://codeclimate.com/github/nicknovitski/modifiers)
 
 ## What is/are Modifiers?
 
-`Modifiers` is a collection of method modifiers, and a way to make more.
+`modifiers` is a collection of **method modifiers**, and a way to make more.
 
-_Method Modifiers_, obviously, modify methods.  Specifically, in Ruby
+Method modifiers, obviously, modify methods.  Specifically, in Ruby
 terms, they are class methods which:
 
 1. Take a symbol argument which names an instance method of the same class, _and_
@@ -27,10 +27,10 @@ end
 ```
 
 This method is quite small, but it still complects the concerns of counting
-ducks and of saving and reusing the result of a calculation, and that latter
-concern might be repeated any number of times in your codebase.
+ducks with that of saving and reusing the result of a calculation, and that latter
+concern might be duplicated any number of times across your codebase.
 
-With modifiers, we can encapsulate the implementation of the memoization, and
+With `modifiers`, you can encapsulate the implementation of the memoization, and
 keep the intent:
 ```ruby
 def count_ducks
@@ -67,7 +67,7 @@ And then execute:
 
 ## Usage
 
-### built-in modifiers
+### built-in method modifiers
 
 #### memoized
 
@@ -135,12 +135,12 @@ no side-effects.
 It may or may not be a good idea, but at least now it's easy to unambiguously
 indicate and enforce!
 
-First, a method modified by `command` will always return nil.  It's as trivial as it
-sounds.
+First, a method modified by `command` will always return `self`.  It's as
+trivial as it sounds.
 
-Conversely (?), a method modified by `query` will never change the state of
-anything non-global and in-process.  This is also trivial, but it might seem
-more impressive.
+Conversely (TODO: find out if this is actually what converse means), a method
+modified by `query` will never change the state of anything non-global and
+in-process.  This is also trivial, but it might seem more impressive.
 
 ```ruby
 require 'modifiers/command_query'
@@ -169,14 +169,14 @@ john = DuckFarmer.new(Array.new(3) { DuckHutch.new(rand(20)) })
 
 john.fullest_hutch # => #<struct DuckHutch num_eggs=11>
 
-john.hutches.any? { |h| h.ducks_disturbed? } # => false
+john.hutches.any?(&:ducks_disturbed?) # => false
 ```
 
 If this was an infomercial, now is when I would say something like "It's just
 that easy, Michael!", and you (your name is Michael in this scenario) would say
 "Now _that's_ incredible!" and the audience would applaud.
 
-### defining new modifiers
+### defining new method modifiers
 
 New modifiers can be defined in your own modules using the `define_modifier` method.
 
@@ -203,18 +203,20 @@ end
 ```
 
 Much as with `define_method`, the first argument to `define_modifier` gives us
-the name of the new modifier, and the block gives us the implementation of a
-given *modification*: a method which intercepts calls to the original method
-(in this case, `DuckFarm#farm`), does whatever it likes, then invokes the
-original method using `super`.
+the name of the new method modifier, and the block gives us the implementation
+of a given **modification**: a method which intercepts calls to the original
+method (in this case, `DuckFarm#farm`), does whatever it likes, then invokes
+that original method using `super`.
 
-(Sadly, just as with `define_method`, you have to use explicit arguments when
-calling `super`.  Sorry, doing otherwise involved too much oddity.)
+Sadly, just as with `define_method`, you have to use explicit arguments when
+calling `super`.  I genuinely and sincerely apologize for this leaky abstraction,
+and wish I knew a way to optimize for the common case of just calling through with
+unchanged arguments without adding significant implementation complexity.
 
-But maybe you don't want to call the original method at all!
+But hey, maybe I'm lucky and you don't want to call the original method at all!
 ```ruby
 module DuckFarmModifiers
-  define_modifier(:x) { }
+  define_modifier(:disabled) { }
 end
 ```
 
@@ -225,8 +227,10 @@ module DuckFarmModifiers
     super(*args.map(&:to_i), &block)
   end
 end
+```
 
-You can do things before, after, or even "around" the invocation.
+You can do things before, after, or even "around" the invocation; It's
+Just Ruby®!
 ```ruby
 module DuckFarmModifiers
   define_modifier(:perf_logged) do |*args, &block|
@@ -237,7 +241,7 @@ module DuckFarmModifiers
 end
 ```
 
-### Extending modifiers
+### Extending method modifiers
 
 The body of a modifier will be evaluated in the context of the receiver
 instance of the modified method, so you can refer to any other instance

data/Rakefile

@@ -1,6 +1,8 @@
-require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: %i(rubocop spec)

data/lib/modifiers/command.rb

@@ -3,6 +3,6 @@ require 'modifiers/define_modifier'
 module Modifiers
   define_modifier(:command) do |*args, &block|
     super(*args, &block)
-    nil
+    self
   end
 end

data/lib/modifiers/query.rb

@@ -9,10 +9,10 @@ module Modifiers
     end
 
     def duplicate_ivars!
-      ivars_hash.each { |k,v| instance_variable_set(k, Marshal.load(Marshal.dump(v))) }
+      ivars_hash.each { |k, v| instance_variable_set(k, Marshal.load(Marshal.dump(v))) }
     end
 
-    def set_ivars(hash)
+    def reset_ivars(hash)
       hash.each { |k, v| instance_variable_set(k, v) }
 
       in_state_but_not_hash = instance_variables.select { |i| hash[i].nil? }
@@ -24,7 +24,7 @@ module Modifiers
     orig_ivars = ivars_hash
     duplicate_ivars!
     return_value = super(*args, &block)
-    set_ivars(orig_ivars)
+    reset_ivars(orig_ivars)
     return_value
   end
 end

data/lib/modifiers/version.rb

@@ -1,3 +1,3 @@
 module Modifiers
-  VERSION = '1.1.0'
+  VERSION = '2.0.2'
 end

data/modifiers.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

data/spec/modifiers/command_spec.rb

@@ -16,8 +16,8 @@ RSpec.describe Modifiers do
   describe '#command' do
     it_behaves_like 'a modifier', :command, changes_return_value: true
 
-    it 'causes the method to always return nil' do
-      expect(doer.take_action).to be_nil
+    it 'causes the method to always return the receiver' do
+      expect(doer.take_action).to be doer
     end
   end
 end

data/spec/modifiers/define_modifier_spec.rb

@@ -29,7 +29,7 @@ class Foo
   bro :hello
 
   def poot
-   "I accidentally typed the name of this method but I think it's great"
+    "I accidentally typed the name of this method but I think it's great"
   end
   timed :poot
 end

data/spec/modifiers/deprecated_spec.rb

@@ -3,7 +3,7 @@ require 'modifiers/deprecated'
 
 RSpec.describe Modifiers do
   describe '#deprecated' do
-    context "with silenced warnings" do
+    context 'with silenced warnings' do
       around(:example) do |example|
         old_verbose, $VERBOSE = $VERBOSE, nil
         example.call

data/spec/modifiers/query_spec.rb

@@ -32,6 +32,7 @@ RSpec.describe Modifiers do
     def initialize
       @state_changes = []
     end
+
     def status
       @state_changes << :awake
     end

data/spec/shared_examples_for_modifiers.rb

@@ -1,6 +1,6 @@
 RSpec.shared_examples 'a modifier' do |modifier, changes_return_value: false|
   let(:test_class) do
-    klass = Class.new do
+    Class.new do
       extend Modifiers
 
       def public_method(arg = :foo)
@@ -19,9 +19,7 @@ RSpec.shared_examples 'a modifier' do |modifier, changes_return_value: false|
         #
       end
     end
-    Object.const_set(random_class_name, klass)
   end
-  let(:random_class_name) { (0...10).map { ('A'..'Z').to_a[rand(26)] }.join }
   subject(:instance) { test_class.new }
 
   it 'returns the symbol it is passed' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modifiers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Nick Novitski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,40 +16,54 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: A simple and composable way to add functionality to methods.
@@ -61,6 +75,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -93,17 +109,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Cute and Easy method modifiers (also called decorators)