lou 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51db60239346e259c7378b093d95fb361c6eda85
-  data.tar.gz: f5615ce8a5d10e09edff99d390a7457664ab39c9
+  metadata.gz: 34aac868cb5bf73797d2b41155f717ee85ffe7fd
+  data.tar.gz: 5cc5bada947c03de042098b226b85179e394ed53
 SHA512:
-  metadata.gz: 564ad4209e2dbfecc4e251a4d85008462110faed41f0fc85973179ef73c5da2984dacc7d947cf873061898c3ef67ce86192519962081155622a0a9f1a1591863
-  data.tar.gz: 241c01bfa29c24bd457570534887aa1ba258918605b9480abff172adeb4d7dafd2b0dfc29c92d30e123461c79a7558f2ca9233b04fc5610bdbb224603513ebec
+  metadata.gz: c8d9d453b8dfd91ed8ad960a45086d042bedd7678d2231d99a9aa74ca5b587b825aa98c4447833a8672a0048744ac9670123524b0e788a1c5566bc9810a23984
+  data.tar.gz: 2451c3a54ea3c4ba91f5a3d031711882da48d34156e475e18cc1cc59bf9ed140a423630eeae252d4155b6eda5e8f095e2a40fd2721f8fb499f6fa13024310345

data/.gemfiles/activesupport3_0.gemfile

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

data/.gemfiles/activesupport3_1.gemfile

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

data/.gemfiles/activesupport3_2.gemfile

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

data/.gemfiles/activesupport4_0.gemfile

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

data/.gemfiles/activesupport4_1.gemfile

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

data/.travis.yml

@@ -5,3 +5,9 @@ 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

@@ -15,16 +15,16 @@ You can define transformations in their own class like this:
 require 'lou'
 
 class HashTransformer
-  extend Lou
+  extend Lou::Transformer
 
-  transform.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
 
-  transform.up do |x|
+  step.up do |x|
     x.flatten
   end.down do |x|
     Hash[*x]
@@ -41,9 +41,9 @@ original = HashTransformer.reverse(result)
 # {:an_old_key=>"this is old"}
 ~~~
 
-The transforms are applied in the order that they're defined using the ~apply~ function, with each transform receiving the result of the previous one. The process can be reversed using the ~reverse~ function.
+The transforms are applied in the order that they're defined using the ~apply~ function, with each transform receiving the result of the previous one. The process can be reversed using the ~reverse~ function. Note that for each step, the input is the result of the previous step.
 
-Note that for each transform, the input is the result of the previous step.
+Transformers inherit the steps of their parent class, so it's possible to reuse steps by using inheritance.
 
 Credits
 -------

data/lib/lou/transformer/step.rb

@@ -0,0 +1,23 @@
+module Lou
+  module Transformer
+    class Step
+      def up(&block)
+        @up = block
+        self
+      end
+
+      def down(&block)
+        @down = block
+        self
+      end
+
+      def apply(input)
+        @up.nil? ? input : @up.call(input)
+      end
+
+      def reverse(output)
+        @down.nil? ? output : @down.call(output)
+      end
+    end
+  end
+end

data/lib/lou/transformer.rb

@@ -1,21 +1,33 @@
+require 'active_support/core_ext/class/attribute'
+require 'lou/transformer/step'
+
 module Lou
-  class Transformer
-    def up(&block)
-      @up = block
-      self
+  module Transformer
+    def self.extended(base)
+      base.class_eval do
+        class_attribute(:steps)
+        self.steps = []
+      end
     end
 
-    def down(&block)
-      @down = block
-      self
+    def step
+      Step.new.tap do |t|
+        steps << t
+      end
     end
 
     def apply(input)
-      @up.nil? ? input : @up.call(input)
+      steps.each do |t|
+        input = t.apply(input)
+      end
+      input
     end
 
     def reverse(output)
-      @down.nil? ? output : @down.call(output)
+      steps.reverse_each do |t|
+        output = t.reverse(output)
+      end
+      output
     end
   end
 end

data/lib/lou/version.rb

@@ -1,3 +1,3 @@
 module Lou
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/lou.rb

@@ -2,35 +2,4 @@ require 'lou/version'
 require 'lou/transformer'
 
 module Lou
-  def self.extended(base)
-    base.class_eval do
-      @transforms = []
-    end
-  end
-
-  def transform
-    Transformer.new.tap do |t|
-      @transforms << t
-    end
-  end
-
-  def apply(input)
-    output = deep_clone(input)
-    @transforms.each do |t|
-      output = t.apply(output)
-    end
-    output
-  end
-
-  def reverse(output)
-    input = deep_clone(output)
-    @transforms.reverse_each do |t|
-      input = t.reverse(input)
-    end
-    input
-  end
-
-  def deep_clone(obj)
-    Marshal.load(Marshal.dump(obj))
-  end
 end

data/lou.gemspec

@@ -17,7 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9'
+
   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"
 end

data/spec/lou/transformer_spec.rb

@@ -0,0 +1,114 @@
+require 'lou/transformer'
+require 'spec_helper'
+
+module Lou
+  describe Transformer do
+    context 'with no steps defined' do
+      let(:klass) do
+        Class.new do
+          extend Lou::Transformer
+        end
+      end
+
+      describe '#apply' do
+        it 'returns the input' do
+          expect(klass.apply('this is the input')).to eq('this is the input')
+        end
+      end
+
+      describe '#reverse' do
+        it 'returns the input' do
+          expect(klass.reverse('this is the input')).to eq('this is the input')
+        end
+      end
+    end
+
+    context 'with one step' do
+      let(:klass) do
+        Class.new do
+          extend Lou::Transformer
+          step.up { |x| x.push 'world' }.down { |x| x.delete_if { |y| y == 'world' } }
+        end
+      end
+
+      describe '#apply' do
+        it 'applies the up step' do
+          expect(klass.apply(%w(hello))).to eq(%w(hello world))
+        end
+      end
+
+      describe '#reverse' do
+        it 'applies the down step' do
+          expect(klass.reverse(%w(hello world))).to eq(%w(hello))
+        end
+      end
+    end
+
+    context 'with two steps' do
+      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\.$/, '') }
+        end
+      end
+
+      describe '#apply' do
+        it 'applies all of the up steps in order' do
+          expect(klass.apply('To be')).to eq('To be, or not to be, that is the question.')
+        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')
+        end
+      end
+    end
+
+    context 'when extended from another transformer' do
+      let(:parent) do
+        Class.new do
+          extend Lou::Transformer
+          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 }
+        end
+      end
+      let(:grandchild) do
+        Class.new(child) do
+          step.up { |x| x.create; x }.down { |x| x.destroy; x }
+        end
+      end
+
+      let(:target) { instance_double('Target') }
+
+      describe '#apply' do
+        it 'applies the steps of the parent first, then the child' do
+          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
+          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)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lou
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Iain Beeston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !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'
 description: 
 email:
 - iain.beeston@gmail.com
@@ -59,6 +73,11 @@ 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
@@ -68,9 +87,10 @@ files:
 - Rakefile
 - lib/lou.rb
 - lib/lou/transformer.rb
+- lib/lou/transformer/step.rb
 - lib/lou/version.rb
 - lou.gemspec
-- spec/lou_spec.rb
+- spec/lou/transformer_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -84,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -97,5 +117,5 @@ signing_key:
 specification_version: 4
 summary: Flexible and reversible transforms using a declarative dsl
 test_files:
-- spec/lou_spec.rb
+- spec/lou/transformer_spec.rb
 - spec/spec_helper.rb

data/spec/lou_spec.rb

@@ -1,77 +0,0 @@
-require 'lou'
-require 'spec_helper'
-
-describe Lou do
-  context 'with no transformations defined' do
-    let(:klass) do
-      Class.new do
-        extend Lou
-      end
-    end
-
-    describe '#apply' do
-      it 'returns the input' do
-        expect(klass.apply('this is the input')).to eq('this is the input')
-      end
-    end
-
-    describe '#reverse' do
-      it 'returns the input' do
-        expect(klass.reverse('this is the input')).to eq('this is the input')
-      end
-    end
-  end
-
-  context 'with one transform' do
-    let(:klass) do
-      Class.new do
-        extend Lou
-        transform.up { |x| x.push 'world' }.down { |x| x.delete_if { |y| y == 'world' } }
-      end
-    end
-
-    describe '#apply' do
-      it 'applies the up transform' do
-        expect(klass.apply(%w(hello))).to eq(%w(hello world))
-      end
-
-      it 'does not change the input object' do
-        input = %w(hello)
-        expect { klass.apply(input) }.to_not change { input }
-      end
-    end
-
-    describe '#reverse' do
-      it 'applies the down transform' do
-        expect(klass.reverse(%w(hello world))).to eq(%w(hello))
-      end
-
-      it 'does not change the input object' do
-        input = %w(hello world)
-        expect { klass.reverse(input) }.to_not change { input }
-      end
-    end
-  end
-
-  context 'with two transforms' do
-    let(:klass) do
-      Class.new do
-        extend Lou
-        transform.up { |x| x + ', or not to be' }.down { |x| x.gsub(/, or not to be$/, '') }
-        transform.up { |x| x + ', that is the question.' }.down { |x| x.gsub(/, that is the question\.$/, '') }
-      end
-    end
-
-    describe '#apply' do
-      it 'applies all of the up transforms in order' do
-        expect(klass.apply('To be')).to eq('To be, or not to be, that is the question.')
-      end
-    end
-
-    describe '#reverse' do
-      it 'applies all of the down transforms in reverse order' do
-        expect(klass.reverse('To be, or not to be, that is the question.')).to eq('To be')
-      end
-    end
-  end
-end