modifiers 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faba910e56e4a55c7099c4b1ff3220fba30e9128
-  data.tar.gz: 2cdc9f5a50ab604b3696dcdc76169100c0bfdfd8
+  metadata.gz: 1362dad9adfb0a9ac28f10588f0f233f00472038
+  data.tar.gz: 22c39749a7f5ae6c411754899ae57db54fd7e52a
 SHA512:
-  metadata.gz: de75437da106da90335181f2ac230497be4b6a1e4a58fe7223cb232d0ba7fcdabaf13f2455d6e09b51f9c12e0f574af203eac97e3b8483a458a2af3d8bdc1a35
-  data.tar.gz: 44fb0c587838f51a93ca018c5bb2baf3bb5750545310ba7c1ef29e1a8a346802b1a0ee56e4a131bbfdb2927956ccbad1b0dc1c90f1b84cd7fe39eb4a123b6a8c
+  metadata.gz: 3bebfb125f3104c010eb94e4ee1b9de4c40cdeec0f9f542c45d5cb074631a4b3ef93f86ba7b07d6391d16387fb6db8d479144d0ba37e5baa671cabe483b6c9f0
+  data.tar.gz: 27007ced57e661678ceba35749a1cdad47c764375cafeab094482626677a8a547cda788209a145fc21ae12449161cf520ec78f7da2d05f9a0b76d359f08666b3

data/.rspec

@@ -0,0 +1 @@
+--order rand

data/.travis.yml

@@ -1,5 +1,13 @@
-nguage: ruby
+language: ruby
 rvm:
+  - 2.0.0
   - 2.1.0
   - 2.1.1
   - 2.1.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: fewAgjCXLYSkbRq57EQYRTjwPn/LfQgpvSh1HBdVG1Vjds2OCL+yl3d6x30o4q28GU7dMLKjEl2BZrrQ9TwPgit3LRPUwlsoZRvGQj+oztdNfshpWansne6coBYa5vx/tQFBSDWkTMdE2RMH1w7qP20Iqn44c4yQU1tQiqWoZMQ=
+  on:
+    tags: true
+    repo: nicknovitski/modifiers

data/README.md

@@ -1,3 +1,6 @@
+# Modifiers
+[![Build Status](https://travis-ci.org/nicknovitski/modifiers.svg?branch=master)](https://travis-ci.org/nicknovitski/modifiers)
+
 ## What is/are Modifiers?
 
 `Modifiers` is a collection of method modifiers, and a way to make more.
@@ -122,7 +125,7 @@ class DuckFarmer < Struct.new(:hutches)
   extend Modifiers
 
   query def fullest_hutch
-    hutches.max { |h1,h2| h1.count_eggs - h2.count_eggs
+    hutches.max { |h1,h2| h1.count_eggs - h2.count_eggs }
   end
 end
 

data/lib/modifiers/command.rb

@@ -1,8 +1,8 @@
 require 'modifiers/define_modifier'
 
 module Modifiers
-  define_modifier(:command) do |invocation|
-    invocation.invoke
+  define_modifier(:command) do |*args, &block|
+    super(*args, &block)
     nil
   end
 end

data/lib/modifiers/define_modifier.rb

@@ -1,11 +1,11 @@
 require 'modifiers/modification'
 
 module Modifiers
-  def define_modifier(name, &block)
-    define_method(name) do |sym|
-      mod = Modification.new(klass: self, method: sym)
-      define_method(sym) { |*args| mod.call(self, *args, &block) }
-      send(mod.original_visibility, sym)
+  def define_modifier(modifier, helper = nil, &method_body)
+    define_method(modifier) do |modified|
+      mod = Modification.new(modifier, self, modified, method_body)
+      mod.send(:include, helper) if helper
+      prepend mod
     end
   end
   module_function :define_modifier

data/lib/modifiers/deprecated.rb

@@ -1,8 +1,36 @@
 require 'modifiers/define_modifier'
 
 module Modifiers
-  define_modifier(:deprecated) do |invocation|
-    warn "deprecated method #{invocation.method_identifier} called from #{invocation.location.join(':')}"
-    invocation.invoke
+  module Deprecated
+    private
+
+    def kaller
+      caller[4]
+    end
+
+    def file
+      match_caller(/(.*?):/i)
+    end
+
+    def line
+      match_caller(/:(\d+).*?$/i)
+    end
+
+    def match_caller(pattern)
+      kaller.match(pattern)[1].to_s
+    end
+
+    def location
+      [file, line].join(':')
+    end
+
+    def target
+      is_a?(Module) ? "#{self}." : "#{self.class}#"
+    end
+  end
+
+  define_modifier(:deprecated, Deprecated) do |*args, &block|
+    warn "deprecated method #{target}#{__method__} called from #{location}"
+    super(*args, &block)
   end
 end

data/lib/modifiers/memoized.rb

@@ -1,12 +1,28 @@
 require 'modifiers/define_modifier'
 
 module Modifiers
-  define_modifier(:memoized) do |invocation|
-    ivar = "@#{invocation.method_name}".to_sym
+  module Memoized
+    private
 
-    instance_variable_set(ivar, {}) unless instance_variable_defined?(ivar)
+    def ivar(method_name)
+      "@#{method_name}".to_sym
+    end
 
-    memoizer = instance_variable_get(ivar)
-    memoizer.fetch(invocation.arguments) { memoizer[invocation.arguments] = invocation.invoke }
+    def init_memo(method_name)
+      instance_variable_set(ivar(method_name), {}) unless instance_variable_defined?(ivar(method_name))
+    end
+
+    def memoizer_for(method_name)
+      instance_variable_get(ivar(method_name))
+    end
+
+    def memoizer_fetch(method_name, key, &block)
+      memoizer_for(method_name).fetch(key, &block)
+    end
+  end
+
+  define_modifier(:memoized, Memoized) do |*args, &block|
+    init_memo(__method__)
+    memoizer_fetch(__method__, args) { memoizer_for(__method__)[args] = super(*args, &block) }
   end
 end

data/lib/modifiers/modification.rb

@@ -1,42 +1,28 @@
-require 'modifiers/method_invocation'
-
-module Modifiers
-  class Modification
-    def initialize(klass:, method:)
-      @klass = klass
-      @original_method = klass.send(:instance_method, method)
-      @original_visibility = visibility_on(klass)
-    end
-
-    attr_reader :original_visibility
-
-    def call(instance, *args, &block)
-      invocation = MethodInvocation.new(method: original_method, receiver: instance, arguments: args)
-      if block
-        instance.instance_exec(invocation, &block)
-      else
-        invocation.invoke
-      end
+class Modification < Module
+  def initialize(name, receiver, method_name, method_body)
+    @name, @receiver, @method_name = name, receiver, method_name
+    super() do
+      define_method(method_name, &method_body)
+      set_visibility
     end
+  end
 
-    private
+  private
 
-    attr_reader :original_method, :klass
+  attr_reader :receiver, :method_name
 
-    def visibility_on(klass)
-      if klass.private_method_defined?(original_method.name)
-        :private
-      elsif klass.protected_method_defined?(original_method.name)
-        :protected
-      else
-        :public
-      end
+  def set_visibility
+    case
+    when private? then private(method_name)
+    when protected? then protected(method_name)
     end
+  end
 
-    def instance
-      klass.new
-    rescue TypeError # klass is a singleton metaclass
-      ObjectSpace.each_object(klass).first
-    end
+  def protected?
+    receiver.protected_method_defined?(method_name)
+  end
+
+  def private?
+    receiver.private_method_defined?(method_name)
   end
 end

data/lib/modifiers/query.rb

@@ -1,7 +1,30 @@
 require 'modifiers/define_modifier'
 
 module Modifiers
-  define_modifier(:query) do |invocation|
-    invocation.invoke(Marshal.load(Marshal.dump(self)))
+  module Querying
+    def ivars_hash
+      instance_variables.each_with_object({}) do |ivar, hash|
+        hash[ivar] = instance_variable_get(ivar)
+      end
+    end
+
+    def duplicate_ivars!
+      ivars_hash.each { |k,v| instance_variable_set(k, Marshal.load(Marshal.dump(v))) }
+    end
+
+    def set_ivars(hash)
+      hash.each { |k, v| instance_variable_set(k, v) }
+
+      in_state_but_not_hash = instance_variables.select { |i| hash[i].nil? }
+      in_state_but_not_hash.each { |i| remove_instance_variable(i) }
+    end
+  end
+
+  define_modifier(:query, Querying) do |*args, &block|
+    orig_ivars = ivars_hash
+    duplicate_ivars!
+    return_value = super(*args, &block)
+    set_ivars(orig_ivars)
+    return_value
   end
 end

data/lib/modifiers/version.rb

@@ -1,3 +1,3 @@
 module Modifiers
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

data/modifiers.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^spec\//)
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'

data/spec/modifiers/command_spec.rb

@@ -4,10 +4,11 @@ require 'modifiers/command'
 RSpec.describe Modifiers do
   class Doer
     extend Modifiers
-    command def take_action
+    def take_action
       # lots of side-effectful-operations
       2 + 2
     end
+    command :take_action
   end
 
   subject(:doer) { Doer.new }

data/spec/modifiers/define_modifier_spec.rb

@@ -3,21 +3,45 @@ require 'modifiers/define_modifier'
 
 module MyModifier
   extend Modifiers
-  define_modifier(:bro) { |i| i.invoke + ', bro' }
+  define_modifier(:bro) do |*args, &block|
+    super(*args, &block) + ', bro'
+  end
+
+  module Watch
+    private
+
+    def timestamp
+      Time.now
+    end
+  end
+
+  define_modifier(:timed, Watch) do |*args, &block|
+    super(*args, &block) + "(#{__method__} called at #{timestamp})"
+  end
 end
 
 class Foo
   extend MyModifier
 
-  bro def hello(name = 'world')
+  def hello(name = 'world')
     "hello, #{name}"
   end
+  bro :hello
+
+  def poot
+   "I accidentally typed the name of this method but I think it's great"
+  end
+  timed :poot
 end
 
 RSpec.describe Modifiers do
   describe '.define_modifier' do
     it 'can make new modifiers in new modules' do
-      expect(Foo.new.hello).to eq('hello, world, bro')
+      expect(Foo.new.hello('modified')).to eq('hello, modified, bro')
+    end
+
+    it 'can include helper modules' do
+      expect(Foo.new.poot).to match(/\(poot called at/)
     end
   end
 end

data/spec/modifiers/deprecated_spec.rb

@@ -3,41 +3,47 @@ require 'modifiers/deprecated'
 
 RSpec.describe Modifiers do
   describe '#deprecated' do
-    it_behaves_like 'a modifier', :deprecated
+    context "with silenced warnings" do
+      around(:example) do |example|
+        old_verbose, $VERBOSE = $VERBOSE, nil
+        example.call
+        $VERBOSE = old_verbose
+      end
 
-    let(:test_class) do
-      class Test
-        extend Modifiers
+      it_behaves_like 'a modifier', :deprecated
+    end
 
-        deprecated def method
-          # something you shouldn't be using
-        end
+    class Test
+      extend Modifiers
+
+      def method
+        # something you shouldn't be using
       end
+      deprecated :method
     end
-    subject(:test_instance) { test_class.new }
 
-    around(:example) do |example|
-      old_verbose, $VERBOSE = $VERBOSE, nil
-      example.call
-      $VERBOSE = old_verbose
+    subject(:test_instance) do
+      s = Test.new
+      allow(s).to receive(:warn)
+      s
     end
 
     it 'changes the method to warn it has been deprecated' do
-      expect(subject).to receive(:warn).with(/deprecated/)
-
       subject.method
+
+      expect(subject).to have_received(:warn).with(/deprecated/)
     end
 
     it 'includes the name of the method in the warning' do
-      expect(subject).to receive(:warn).with(/Test\#method/)
-
       subject.method
+
+      expect(subject).to have_received(:warn).with(/Test\#method/)
     end
 
     it 'includes the location of the call in the warning' do
-      expect(subject).to receive(:warn).with(/deprecated_spec.rb/)
-
       subject.method
+
+      expect(subject).to have_received(:warn).with(/deprecated_spec.rb/)
     end
 
     context 'class methods' do
@@ -45,17 +51,18 @@ RSpec.describe Modifiers do
         class Test
           class << self
             extend Modifiers
-            deprecated def class_method
+            def class_method
               #
             end
+            deprecated :class_method
           end
         end
       end
 
       it 'names the method correctly in the warning' do
-        expect(test_class).to receive(:warn).with(/Test\.class_method/)
+        expect(Test).to receive(:warn).with(/Test\.class_method/)
 
-        test_class.class_method
+        Test.class_method
       end
     end
   end

data/spec/modifiers/memoized_spec.rb

@@ -11,9 +11,10 @@ RSpec.describe Modifiers do
   class Client
     extend Modifiers
 
-    memoized def call_service
+    def call_service
       Service.expensive_operation
     end
+    memoized :call_service
   end
 
   subject(:client) { Client.new }

data/spec/modifiers/query_spec.rb

@@ -12,22 +12,28 @@ RSpec.describe Modifiers do
 
     attr_reader :memo, :enum
 
-    query def fooer?
+    def fooer?
       @memo ||= true
     end
+    query :fooer?
 
-    query def insertable?(val)
+    def insertable?(val)
       @enum << val
     end
+    query :insertable?
 
-    query def child_status
+    def child_status
       @sub_test.status
     end
+    query :child_status
   end
 
   class SubTest
+    def initialize
+      @state_changes = []
+    end
     def status
-      @status ||= :awake
+      @state_changes << :awake
     end
   end
 
@@ -46,7 +52,7 @@ RSpec.describe Modifiers do
     end
 
     it 'prevents the method from altering linked objects' do
-      expect { instance.child_status }.not_to change { child.instance_variables }
+      expect { instance.child_status }.not_to change { child.instance_variable_get(:@state_changes) }
     end
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: modifiers
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Nick Novitski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-19 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !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'
 description: A simple and composable way to add functionality to methods.
@@ -59,8 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,7 +72,6 @@ files:
 - lib/modifiers/define_modifier.rb
 - lib/modifiers/deprecated.rb
 - lib/modifiers/memoized.rb
-- lib/modifiers/method_invocation.rb
 - lib/modifiers/modification.rb
 - lib/modifiers/query.rb
 - lib/modifiers/version.rb
@@ -93,17 +93,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Cute and Easy method modifiers (also called decorators)

data/lib/modifiers/method_invocation.rb

@@ -1,51 +0,0 @@
-module Modifiers
-  class MethodInvocation
-    def initialize(method:, receiver:, arguments:)
-      @method = method
-      @receiver = receiver
-      @arguments = arguments
-    end
-
-    attr_reader :arguments
-
-    def invoke(context = receiver)
-      method.bind(context).call(*arguments)
-    end
-
-    def location
-      [file, line_no]
-    end
-
-    def method_name
-      method.name
-    end
-
-    def method_identifier
-      target + method_name.to_s
-    end
-
-    private
-
-    def target
-      receiver.is_a?(Module) ? "#{receiver}." : "#{receiver.class}#"
-    end
-
-    def file
-      match_caller(/(.*?):/i)
-    end
-
-    def line_no
-      match_caller(/:(\d+).*?$/i)
-    end
-
-    def match_caller(regex)
-      method_caller.match(regex).to_s
-    end
-
-    def method_caller
-      caller[7]
-    end
-
-    attr_reader :method, :receiver
-  end
-end