lou 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a7d9a55a3b09cd2c50686004aff9772c89ef4b4
-  data.tar.gz: a04237531093015a68b9d574c179a44297281f1d
+  metadata.gz: 51db60239346e259c7378b093d95fb361c6eda85
+  data.tar.gz: f5615ce8a5d10e09edff99d390a7457664ab39c9
 SHA512:
-  metadata.gz: 407f3f4f1dc67eb69414c5ebaf22e07282798c1b764dfd8abe30d09268e5767a4d9e6518ab9d87689241ba3998f433ef02da185eebeb62636b41e30998857cbe
-  data.tar.gz: 509306962cc37c18f6ee4bbbd6e7c43463b74a19787821829428c82c9a77f7aa841a4087136e8840b34bbd72543cd92a463ebc496b22fcbb28fc210b0ff76704
+  metadata.gz: 564ad4209e2dbfecc4e251a4d85008462110faed41f0fc85973179ef73c5da2984dacc7d947cf873061898c3ef67ce86192519962081155622a0a9f1a1591863
+  data.tar.gz: 241c01bfa29c24bd457570534887aa1ba258918605b9480abff172adeb4d7dafd2b0dfc29c92d30e123461c79a7558f2ca9233b04fc5610bdbb224603513ebec

data/README.md

@@ -4,7 +4,7 @@ Lou
 [![Build Status](https://travis-ci.org/iainbeeston/lou.svg?branch=master)](https://travis-ci.org/iainbeeston/lou)
 [![Code Climate](https://codeclimate.com/github/iainbeeston/lou/badges/gpa.svg)](https://codeclimate.com/github/iainbeeston/lou)
 
-Lou lets you define a pipeline of reversible transformations, that you can apply to any ruby object. For example, you might want to define a pipeline of [ImageMagick](http://www.imagemagick.org) operations on an image, or a sequence of API calls.
+Lou lets you define a pipeline of reversible transformations, that you can apply to any ruby object. It assumes nothing about your business logic or the objects that you're using. For example, you might want to define a pipeline of [ImageMagick](http://www.imagemagick.org) operations on an image, or a sequence of API calls. You could even use Lou as a replacement for ActiveRecord migrations.
 
 Usage
 -----
@@ -17,16 +17,16 @@ require 'lou'
 class HashTransformer
   extend Lou
 
-  transform forward do |x|
+  transform.up do |x|
     x.merge(a_new_key: 'this is new')
-  end.backward do |x|
+  end.down do |x|
    x.delete(:a_new_key)
    x
   end
 
-  transform forward do |x|
+  transform.up do |x|
     x.flatten
-  end.backward do |x|
+  end.down do |x|
     Hash[*x]
   end
 end
@@ -37,11 +37,13 @@ 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.undo(result)
+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 ~undo~ 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 transform, the input is the result of the previous step.
 
 Credits
 -------

data/lib/lou/transformer.rb

@@ -0,0 +1,21 @@
+module Lou
+  class Transformer
+    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

data/lib/lou/version.rb

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

data/lib/lou.rb

@@ -1,4 +1,5 @@
 require 'lou/version'
+require 'lou/transformer'
 
 module Lou
   def self.extended(base)
@@ -7,9 +8,10 @@ module Lou
     end
   end
 
-  def transform(mapping)
-    @transforms << mapping
-    self
+  def transform
+    Transformer.new.tap do |t|
+      @transforms << t
+    end
   end
 
   def apply(input)
@@ -20,10 +22,10 @@ module Lou
     output
   end
 
-  def undo(output)
+  def reverse(output)
     input = deep_clone(output)
     @transforms.reverse_each do |t|
-      input = t.undo(input)
+      input = t.reverse(input)
     end
     input
   end
@@ -31,32 +33,4 @@ module Lou
   def deep_clone(obj)
     Marshal.load(Marshal.dump(obj))
   end
-
-  def forward(&block)
-    Transformer.new(&block)
-  end
-
-  class Transformer
-    def initialize(&block)
-      forward(&block)
-    end
-
-    def forward(&block)
-      @forward = block
-      self
-    end
-
-    def backward(&block)
-      @backward = block
-      self
-    end
-
-    def apply(input)
-      @forward.nil? ? input : @forward.call(input)
-    end
-
-    def undo(output)
-      @backward.nil? ? output : @backward.call(output)
-    end
-  end
 end

data/spec/lou_spec.rb

@@ -15,9 +15,9 @@ describe Lou do
       end
     end
 
-    describe '#undo' do
+    describe '#reverse' do
       it 'returns the input' do
-        expect(klass.undo('this is the input')).to eq('this is the input')
+        expect(klass.reverse('this is the input')).to eq('this is the input')
       end
     end
   end
@@ -26,12 +26,12 @@ describe Lou do
     let(:klass) do
       Class.new do
         extend Lou
-        transform forward { |x| x.push 'world' }.backward { |x| x.delete_if { |y| y == 'world' } }
+        transform.up { |x| x.push 'world' }.down { |x| x.delete_if { |y| y == 'world' } }
       end
     end
 
     describe '#apply' do
-      it 'applies the forward transform' do
+      it 'applies the up transform' do
         expect(klass.apply(%w(hello))).to eq(%w(hello world))
       end
 
@@ -41,14 +41,14 @@ describe Lou do
       end
     end
 
-    describe '#undo' do
-      it 'applies the backward transform' do
-        expect(klass.undo(%w(hello world))).to eq(%w(hello))
+    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.undo(input) }.to_not change { input }
+        expect { klass.reverse(input) }.to_not change { input }
       end
     end
   end
@@ -57,20 +57,20 @@ describe Lou do
     let(:klass) do
       Class.new do
         extend Lou
-        transform forward { |x| x + ', or not to be' }.backward { |x| x.gsub(/, or not to be$/, '') }
-        transform forward { |x| x + ', that is the question.' }.backward { |x| x.gsub(/, that is the question\.$/, '') }
+        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 forward transforms in order' 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 '#undo' do
-      it 'applies all of the backward transforms in reverse order' do
-        expect(klass.undo('To be, or not to be, that is the question.')).to eq('To be')
+    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

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: lou
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Iain Beeston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-08-06 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: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 description: 
@@ -59,14 +59,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/lou.rb
+- lib/lou/transformer.rb
 - lib/lou/version.rb
 - lou.gemspec
 - spec/lou_spec.rb
@@ -81,12 +82,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []