lou 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a7d9a55a3b09cd2c50686004aff9772c89ef4b4
+  data.tar.gz: a04237531093015a68b9d574c179a44297281f1d
+SHA512:
+  metadata.gz: 407f3f4f1dc67eb69414c5ebaf22e07282798c1b764dfd8abe30d09268e5767a4d9e6518ab9d87689241ba3998f433ef02da185eebeb62636b41e30998857cbe
+  data.tar.gz: 509306962cc37c18f6ee4bbbd6e7c43463b74a19787821829428c82c9a77f7aa841a4087136e8840b34bbd72543cd92a463ebc496b22fcbb28fc210b0ff76704

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - jruby-1.7
+  - rbx-2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lou.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Iain Beeston
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+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.
+
+Usage
+-----
+
+You can define transformations in their own class like this:
+
+~~~ruby
+require 'lou'
+
+class HashTransformer
+  extend Lou
+
+  transform forward do |x|
+    x.merge(a_new_key: 'this is new')
+  end.backward do |x|
+   x.delete(:a_new_key)
+   x
+  end
+
+  transform forward do |x|
+    x.flatten
+  end.backward do |x|
+    Hash[*x]
+  end
+end
+~~~
+
+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)
+# {: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.
+
+Credits
+-------
+
+Lou is heavily inspired by [Hash Mapper](http://github.com/ismasan) by [Ismael Celis](http://github.com/ismasan).

data/Rakefile

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

data/lib/lou/version.rb

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

data/lib/lou.rb

@@ -0,0 +1,62 @@
+require 'lou/version'
+
+module Lou
+  def self.extended(base)
+    base.class_eval do
+      @transforms = []
+    end
+  end
+
+  def transform(mapping)
+    @transforms << mapping
+    self
+  end
+
+  def apply(input)
+    output = deep_clone(input)
+    @transforms.each do |t|
+      output = t.apply(output)
+    end
+    output
+  end
+
+  def undo(output)
+    input = deep_clone(output)
+    @transforms.reverse_each do |t|
+      input = t.undo(input)
+    end
+    input
+  end
+
+  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/lou.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lou/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lou"
+  spec.version       = Lou::VERSION
+  spec.authors       = ["Iain Beeston"]
+  spec.email         = ["iain.beeston@gmail.com"]
+  spec.summary       = %q{Flexible and reversible transforms using a declarative dsl}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

data/spec/lou_spec.rb

@@ -0,0 +1,77 @@
+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 '#undo' do
+      it 'returns the input' do
+        expect(klass.undo('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 forward { |x| x.push 'world' }.backward { |x| x.delete_if { |y| y == 'world' } }
+      end
+    end
+
+    describe '#apply' do
+      it 'applies the forward 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 '#undo' do
+      it 'applies the backward transform' do
+        expect(klass.undo(%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 }
+      end
+    end
+  end
+
+  context 'with two transforms' 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\.$/, '') }
+      end
+    end
+
+    describe '#apply' do
+      it 'applies all of the forward 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')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: lou
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Iain Beeston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 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: 
+email:
+- iain.beeston@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lou.rb
+- lib/lou/version.rb
+- lou.gemspec
+- spec/lou_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Flexible and reversible transforms using a declarative dsl
+test_files:
+- spec/lou_spec.rb
+- spec/spec_helper.rb