lou 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28c63ebde579744fcaee08a01ce150a25dae1327
-  data.tar.gz: 9bfc1ce762996482145ee8e5c7ba443a780e46a9
+  metadata.gz: d4e9da0024d50ac97f6475a747331b461913f9af
+  data.tar.gz: 22ed73a5d3655e207b34ef4f3b5464de39c8a3eb
 SHA512:
-  metadata.gz: 0e4caa193f4612fa1ad5720b77cfb81e220e825a1b664f97851433220a06db1a1a32210d0e92a9791b52a2376e6062756b53a1c295aa762aceb10485621812c7
-  data.tar.gz: 146ad87b42954dabd6066cb7955316ae0ca041a708f18660a9d4b245ddf919caad9d4d8dfbb936eb5c1a7192847a6a75d7b660f9dd439c82fa8326c0e804c728
+  metadata.gz: 8996c9b19efda37c3045f5a31ede025978ccc868f7dd6de4fb1a14b5aa87697d7707dffd52e1df6ba8d56a5f352ac5b7a1c5b21902f104c24bd19f02d03e62cd
+  data.tar.gz: a8e59536b841561dd694e08456b91d53671e503302765a6cfee64852a5eb429081bc2128b15533653654705088d52a1e1efe833ec51bb5643971e6549db6cf36

data/.travis.yml

@@ -5,9 +5,3 @@ rvm:
   - 2.1
   - jruby-1.7
   - rbx-2
-gemfile:
-  - .gemfiles/activesupport3_0.gemfile
-  - .gemfiles/activesupport3_1.gemfile
-  - .gemfiles/activesupport3_2.gemfile
-  - .gemfiles/activesupport4_0.gemfile
-  - .gemfiles/activesupport4_1.gemfile

data/README.md

@@ -18,16 +18,16 @@ class HashTransformer
   extend Lou::Transformer
 
   # optional
-  reverse_on RuntimeError
+  revert_on RuntimeError
 
-  step.up do |x|
+  step up do |x|
     x.merge(a_new_key: 'this is new')
   end.down do |x|
    x.delete(:a_new_key)
    x
   end
 
-  step.up do |x|
+  step up do |x|
     x.flatten
   end.down do |x|
     Hash[*x]
@@ -40,15 +40,15 @@ Then you can use it like this:
 ~~~ruby
 result = HashTransformer.apply(an_old_key: 'this is old')
 # [:an_old_key, "this is old", :a_new_key, "this is new"]
-original = HashTransformer.reverse(result)
+original = HashTransformer.revert(result)
 # {:an_old_key=>"this is old"}
 ~~~
 
-The steps are applied in the order that they're defined, when the `apply` method is called, with each step receiving the result of the previous one. The process can be reversed using the `reverse` method. Note that for each step, the input is the result of the previous step.
+The steps are applied in the order that they're defined, when the `apply` method is called, with each step receiving the result of the previous one. The process can be reversed using the `revert` method. Note that for each step, the input is the result of the previous step.
 
-If `reverse_on` is defined, then any completed steps will be reversed if the exception specified is raised.
+If `revert_on` is defined, then any completed steps will be reversed if the exception specified is raised.
 
-Transformers inherit the steps of their parent class, so it's possible to reuse steps by using inheritance.
+Transformers can reuse other transformers as steps. In fact, any object that defines an `apply` method and a `revert` method can be used as a step.
 
 Credits
 -------

data/lib/lou/transformer.rb

@@ -1,4 +1,3 @@
-require 'active_support/core_ext/class/attribute'
 require 'lou/transformer/step'
 
 module Lou
@@ -8,49 +7,59 @@ module Lou
 
     def self.extended(base)
       base.class_eval do
-        class_attribute :steps
-        self.steps = []
-        class_attribute :error_class
-        self.error_class = Lou::Transformer::NeverError
+        self.transformer_steps = []
+        self.transformer_error_class = Lou::Transformer::NeverError
       end
     end
 
-    def reverse_on(error)
-      self.error_class = error
+    def revert_on(error)
+      self.transformer_error_class = error
     end
 
-    def step
-      Step.new.tap do |t|
-        self.steps += [t]
+    def step(transformer)
+      transformer.tap do |t|
+        self.transformer_steps += [t]
       end
     end
 
-    def apply(input, total_steps = steps.count)
+    def up(&block)
+      Transformer::Step.new.up(&block)
+    end
+
+    def down(&block)
+      Transformer::Step.new.down(&block)
+    end
+
+    def apply(input, total_steps = transformer_steps.count)
       applied_steps = 0
       begin
-        steps.last(total_steps).each do |t|
+        transformer_steps.last(total_steps).each do |t|
           input = t.apply(input)
           applied_steps += 1
         end
-      rescue error_class => e
-        reverse(input, applied_steps) if total_steps == steps.count
+      rescue transformer_error_class => e
+        revert(input, applied_steps) if total_steps == transformer_steps.count
         raise e
       end
       input
     end
 
-    def reverse(output, total_steps = steps.count)
+    def revert(output, total_steps = transformer_steps.count)
       reversed_steps = 0
       begin
-        steps.first(total_steps).reverse_each do |t|
-          output = t.reverse(output)
+        transformer_steps.first(total_steps).reverse_each do |t|
+          output = t.revert(output)
           reversed_steps += 1
         end
-      rescue error_class => e
-        apply(output, reversed_steps) if total_steps == steps.count
+      rescue transformer_error_class => e
+        apply(output, reversed_steps) if total_steps == transformer_steps.count
         raise e
       end
       output
     end
+
+    protected
+
+    attr_accessor :transformer_steps, :transformer_error_class
   end
 end

data/lib/lou/transformer/step.rb

@@ -2,22 +2,26 @@ module Lou
   module Transformer
     class Step
       def up(&block)
-        @up = block
+        self.up_blk = block
         self
       end
 
       def down(&block)
-        @down = block
+        self.down_blk = block
         self
       end
 
       def apply(input)
-        @up.nil? ? input : @up.call(input)
+        up_blk.nil? ? input : up_blk.call(input)
       end
 
-      def reverse(output)
-        @down.nil? ? output : @down.call(output)
+      def revert(output)
+        down_blk.nil? ? output : down_blk.call(output)
       end
+
+      protected
+
+      attr_accessor :up_blk, :down_blk
     end
   end
 end

data/lib/lou/version.rb

@@ -1,3 +1,3 @@
 module Lou
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/lou.gemspec

@@ -21,7 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 3.0"
-
-  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/spec/lou/transformer_spec.rb

@@ -16,9 +16,9 @@ module Lou
         end
       end
 
-      describe '#reverse' do
+      describe '#revert' do
         it 'returns the input' do
-          expect(klass.reverse('this is the input')).to eq('this is the input')
+          expect(klass.revert('this is the input')).to eq('this is the input')
         end
       end
     end
@@ -27,7 +27,7 @@ module Lou
       let!(:klass) do
         Class.new do
           extend Lou::Transformer
-          step.up { |x| x.push 'world' }.down { |x| x.delete_if { |y| y == 'world' } }
+          step up { |x| x.push 'world' }.down { |x| x.delete_if { |y| y == 'world' } }
         end
       end
 
@@ -37,9 +37,9 @@ module Lou
         end
       end
 
-      describe '#reverse' do
+      describe '#revert' do
         it 'applies the down step' do
-          expect(klass.reverse(%w(hello world))).to eq(%w(hello))
+          expect(klass.revert(%w(hello world))).to eq(%w(hello))
         end
       end
     end
@@ -48,8 +48,8 @@ module Lou
       let!(:klass) do
         Class.new do
           extend Lou::Transformer
-          step.up { |x| x + ', or not to be' }.down { |x| x.gsub(/, or not to be$/, '') }
-          step.up { |x| x + ', that is the question.' }.down { |x| x.gsub(/, that is the question\.$/, '') }
+          step up { |x| x + ', or not to be' }.down { |x| x.gsub(/, or not to be$/, '') }
+          step up { |x| x + ', that is the question.' }.down { |x| x.gsub(/, that is the question\.$/, '') }
         end
       end
 
@@ -59,28 +59,34 @@ module Lou
         end
       end
 
-      describe '#reverse' do
-        it 'applies all of the down steps in reverse order' do
-          expect(klass.reverse('To be, or not to be, that is the question.')).to eq('To be')
+      describe '#revert' do
+        it 'applies all of the down steps in revert order' do
+          expect(klass.revert('To be, or not to be, that is the question.')).to eq('To be')
         end
       end
     end
 
-    context 'when extended from another transformer' do
-      let!(:parent) do
-        Class.new do
+    context 'when one of the steps is another transformer' do
+      let!(:grandchild) do
+        parent = Class.new do
           extend Lou::Transformer
-          step.up { |x| x.create; x }.down { |x| x.destroy; x }
+          step up { |x| x.create; x }.down { |x| x.destroy; x }
         end
-      end
-      let!(:child) do
-        Class.new(parent) do
-          step.up { |x| x.create; x }.down { |x| x.destroy; x }
+
+        child = Class.new do
+          extend Lou::Transformer
+
+          step(parent)
+
+          step up { |x| x.create; x }.down { |x| x.destroy; x }
         end
-      end
-      let!(:grandchild) do
-        Class.new(child) do
-          step.up { |x| x.create; x }.down { |x| x.destroy; x }
+
+        Class.new do
+          extend Lou::Transformer
+
+          step(child)
+
+          step up { |x| x.create; x }.down { |x| x.destroy; x }
         end
       end
 
@@ -91,22 +97,12 @@ module Lou
           expect(target).to receive(:create).exactly(3).times
           grandchild.apply(target)
         end
-
-        it 'does not alter the up steps of the parent' do
-          expect(target).to receive(:create).exactly(1).times
-          parent.apply(target)
-        end
       end
 
-      describe '#reverse' do
-        it 'reverses the steps of the child first, then the parent' do
+      describe '#revert' do
+        it 'reverts the steps of the child first, then the parent' do
           expect(target).to receive(:destroy).exactly(3).times
-          grandchild.reverse(target)
-        end
-
-        it 'does not alter the down steps of the parent' do
-          expect(target).to receive(:destroy).exactly(1).times
-          parent.reverse(target)
+          grandchild.revert(target)
         end
       end
     end
@@ -115,7 +111,7 @@ module Lou
       let!(:klass) do
         Class.new do
           extend Lou::Transformer
-          step.up { |_| fail 'error on up' }.down { |_| fail 'error on down' }
+          step up { |_| fail 'error on up' }.down { |_| fail 'error on down' }
         end
       end
 
@@ -125,86 +121,85 @@ module Lou
         end
       end
 
-      describe '#reverse' do
+      describe '#revert' do
         it 'raises the exception' do
-          expect { klass.reverse('bar') }.to raise_error('error on down')
+          expect { klass.revert('bar') }.to raise_error('error on down')
         end
       end
     end
 
-    context 'when #reverse_on has been set' do
+    context 'when #revert_on has been set' do
       let!(:error_class) do
         class SpecialError < StandardError; end
       end
 
-      let!(:parent) do
-        Class.new do
-          extend Lou::Transformer
-
-          reverse_on SpecialError
-        end
-      end
-
       let(:target) { instance_double('Target') }
 
       context 'and an error is raised on the first step' do
         let!(:klass) do
-          Class.new(parent) do
-            step.up { |_| fail SpecialError }.down { |x| x.destroy(1); x  }
-            step.up { |x| x.create(2); x }.down { |_| fail SpecialError }
+          Class.new do
+            extend Lou::Transformer
+            revert_on(SpecialError)
+
+            step up { |_| fail SpecialError }.down { |x| x.destroy(1); x  }
+            step up { |x| x.create(2); x }.down { |_| fail SpecialError }
           end
         end
 
         describe '#apply' do
-          it 'reverses no steps when the specified error is raised' do
+          it 'reverts no steps when the specified error is raised' do
             expect(target).to_not receive(:create)
             expect(target).to_not receive(:destroy)
             expect { klass.apply(target) }.to raise_error(SpecialError)
           end
         end
 
-        describe '#reverse' do
+        describe '#revert' do
           it 'applies no steps when the specified error is raised' do
             expect(target).to_not receive(:destroy)
             expect(target).to_not receive(:create)
-            expect { klass.reverse(target) }.to raise_error(SpecialError)
+            expect { klass.revert(target) }.to raise_error(SpecialError)
           end
         end
       end
 
       context 'and an error is raised part-way through the transform' do
         let!(:klass) do
-          Class.new(parent) do
-            step.up { |x| x.create(1); x }.down { |x| x.destroy(1); x }
-            step.up { |_| fail SpecialError }.down { |_| fail SpecialError }
-            step.up { |x| x.create(3); x }.down { |x| x.destroy(3); x }
+          Class.new do
+            extend Lou::Transformer
+            revert_on(SpecialError)
+
+            step up { |x| x.create(1); x }.down { |x| x.destroy(1); x }
+            step up { |_| fail SpecialError }.down { |_| fail SpecialError }
+            step up { |x| x.create(3); x }.down { |x| x.destroy(3); x }
           end
         end
 
-        let(:target) { instance_double('Target') }
-
         describe '#apply' do
-          it 'reverses all successfully applied steps before raising the error when the specified error is raised' do
+          it 'reverts all successfully applied steps before raising the error when the specified error is raised' do
             expect(target).to receive(:create).once.with(1).ordered
             expect(target).to receive(:destroy).once.with(1).ordered
             expect { klass.apply(target) }.to raise_error(SpecialError)
           end
         end
 
-        describe '#reverse' do
-          it 'reapplies all successfully reversed steps before raising the error when the specified error is raised' do
+        describe '#revert' do
+          it 'reapplies all successfully revertd steps before raising the error when the specified error is raised' do
             expect(target).to receive(:destroy).once.with(3).ordered
             expect(target).to receive(:create).once.with(3).ordered
-            expect { klass.reverse(target) }.to raise_error(SpecialError)
+            expect { klass.revert(target) }.to raise_error(SpecialError)
           end
         end
       end
 
       context 'and the up and down steps should lead to an infinite loop' do
         let!(:klass) do
-          Class.new(parent) do
-            step.up { |x| x.create(1); x }.down { |_| fail SpecialError, 'fail on down' }
-            step.up { |_| fail SpecialError, 'fail on up' }.down { |x| x.destroy(2); x }
+          Class.new do
+            extend Lou::Transformer
+            revert_on(SpecialError)
+
+            step up { |x| x.create(1); x }.down { |_| fail SpecialError, 'fail on down' }
+            step up { |_| fail SpecialError, 'fail on up' }.down { |x| x.destroy(2); x }
           end
         end
 
@@ -215,10 +210,10 @@ module Lou
           end
         end
 
-        describe '#reverse' do
+        describe '#revert' do
           it 'raises the error from the up step' do
             expect(target).to receive(:destroy).once.with(2)
-            expect { klass.reverse(target) }.to raise_error(SpecialError, 'fail on up')
+            expect { klass.revert(target) }.to raise_error(SpecialError, 'fail on up')
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lou
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Iain Beeston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,30 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 description: 
 email:
 - iain.beeston@gmail.com
@@ -73,11 +59,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gemfiles/activesupport3_0.gemfile
-- .gemfiles/activesupport3_1.gemfile
-- .gemfiles/activesupport3_2.gemfile
-- .gemfiles/activesupport4_0.gemfile
-- .gemfiles/activesupport4_1.gemfile
 - .gitignore
 - .rspec
 - .travis.yml

data/.gemfiles/activesupport3_0.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activesupport', '~> 3.0.0'
-# Specify your gem's dependencies in ../lou.gemspec
-gemspec path: '../'

data/.gemfiles/activesupport3_1.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activesupport', '~> 3.1.0'
-# Specify your gem's dependencies in ../lou.gemspec
-gemspec path: '../'

data/.gemfiles/activesupport3_2.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activesupport', '~> 3.2.0'
-# Specify your gem's dependencies in ../lou.gemspec
-gemspec path: '../'

data/.gemfiles/activesupport4_0.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activesupport', '~> 4.0.0'
-# Specify your gem's dependencies in ../lou.gemspec
-gemspec path: '../'

data/.gemfiles/activesupport4_1.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activesupport', '~> 4.1.0'
-# Specify your gem's dependencies in ../lou.gemspec
-gemspec path: '../'