shapeshifter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24ea440ce974a1b51f22398d4e9d11948208a12c
-  data.tar.gz: 4317404d75d4ee54caddff085b1cec73d4bf5a61
+  metadata.gz: 14c8515972508e77d7733808003b3868fbcac5cc
+  data.tar.gz: 333baf056a7df6e54604f7687458e30da4e3af93
 SHA512:
-  metadata.gz: 9a1480841cec56239fc71df4b2bd9ca3cc861ee4be9a005c6e446105fb40d43f8421bf18160b2c714bfed9f2c3f5b36f0b4e412b86728dabd5bb88d00d9cc4b0
-  data.tar.gz: b64cc78d67df860e33c7918060f08c416c262cd46c33293b10574833635d269cba2a297d03dc2a84a1102af5ddd9be4a3406423fe56a2bc6dc18fbb17724a65a
+  metadata.gz: eedf79536b7d0a84901371b05d8a0ea17540e6e9ebfe2c650ef5f55f23f5d142111a9a26c10eca1779eec650cb059def453b6b39a6aaa834acd5929fe560fe2d
+  data.tar.gz: 1bc7a8d13c0b36e43f459f18b2b133ec1c24c8a9f69eeecb067e113796f47752686af7976bc4fb00643027c167184d73dccb00139750dc945c96cf17e2ac8cde

data/README.md

@@ -1,6 +1,7 @@
 # Shapeshifter
 
-TODO: Write a gem description
+Shapeshifter is a simple pattern for transforming data from
+one format to another.
 
 ## Installation
 
@@ -20,7 +21,91 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#A Simple Shifter
+
+```ruby
+class SimpleShifter < Shapeshifter::Shifter
+  def shift(target_object)
+    # Transform target_object using source_object
+    targeting_object # Return the transformed target
+  end
+
+  def revert(target_object)
+    # Transform target_object using source_object
+    targeting_object # Return the transformed target
+  end
+end
+```
+
+A shifter consists of two methods: `shift` and `revert`. Both
+follow the same pattern in that the shifter is instantiated with
+a source object and each method receives a target object to manipulate
+using the data of the source.
+
+#Chaining
+
+The shifter by itself is not particularly interesting, but where it
+gets fun is that they can be chained together to break complex
+data manipulations down into simple small chunks.
+
+
+```ruby
+shift_chain = SimpleShifter
+                .chain(SimpleShifter2)
+                .chain(SimpleShifter3)
+```
+
+This shift chain can then be easily reused for both shifting 'forward'
+and reverting 'backwards'.
+
+```ruby
+shift_chain.shift(source_object, target_object)
+shift_chain.revert(source_object, target_object)
+```
+
+When running a forward shift the shifters will be run in
+sequence `SimpleShifter -> SimpleShifter2 -> SimpleShifter3` each
+being instantiated with the source object (then available as
+an `attr_reader` within the instance) and then being sent the
+`shift` message with the target object as an argument. The target object
+will therefore change as it passes through the chain allowing you
+to have shifters that operate differently based on its contents.
+
+Revert operates in the same fashion except it runs through the
+chain in reverse, starting at `SimpleShifter3` and finishing at
+`SimpleShifter` calling the revert method on each instance as
+it traverses the chain.
+
+#Nesting
+
+One of the nice side effects is that you can nest shifters calls
+within other shifters, e.g.
+
+```ruby
+class ComplexShifter < Shapeshifter::Shifter
+  def shift(target_object)
+    sub_object = source_object.sub_object
+    partial_target = internal_chain.shift(sub_object, {})
+    target_object.merge(partial_target: partial_target)
+  end
+
+  def revert(target_object)
+    #...
+    internal_chain.revert(sub_object, {})
+    #...
+    target_object
+  end
+
+  def internal_chain
+    SimpleShifter
+      .chain(SimpleShifter2)
+      .chain(SimpleShifter3)
+  end
+end
+```
+
+This allows you to build quite complex data manipulations in small
+easily testable chunks.
 
 ## Contributing
 

data/lib/shapeshifter.rb

@@ -5,4 +5,3 @@ end
 
 require "shapeshifter/shifter"
 require "shapeshifter/shift_chain"
-require 'shapeshifter/null_shifter'

data/lib/shapeshifter/shifter.rb

@@ -20,6 +20,7 @@ module Shapeshifter
       end
     end
     
+    # :nocov:
     def shift(_)
       raise NoMethodError.new('Should be overridden')
     end
@@ -27,5 +28,6 @@ module Shapeshifter
     def revert(_)
       raise NoMethodError.new('Should be overridden')
     end
+    # :nocov:
   end
 end

data/lib/shapeshifter/version.rb

@@ -1,3 +1,3 @@
 module Shapeshifter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/shapeshifter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["max@driftrock.com"]
   spec.summary       = %q{Shapeshifter allows you to transform data types}
   spec.description   = %q{}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/Driftrock/shapeshifter"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/shapeshifter/shifter_spec.rb

@@ -28,6 +28,24 @@ module Shapeshifter
       end
     end
 
+    context 'when a reversion is made' do
+      before do
+        test_shifter = double(TestShifter)
+        allow(TestShifter).to receive(:new).and_return(test_shifter)
+        allow(test_shifter).to receive(:revert) do |target|
+          target[:a] = Array(target[:a]).concat(target[:b])
+          target
+        end
+      end
+
+      it 'should change the passed target' do
+        target = { a: 1, b: [2, 3] }
+        expect do
+          TestShifter.revert({}, target)
+        end.to change { target }.to eq ({ a: [1, 2, 3], b: [2, 3] })
+      end
+    end
+
     context 'when a shift is made' do
       before do
         test_shifter = double(TestShifter)
@@ -45,11 +63,5 @@ module Shapeshifter
         end.to change { target }.to eq ({ a: [1, 2, 3], b: [2, 3] })
       end
     end
-  #
-  #class TestShifter < Shifter
-  #  def shift(old_object, new_object)
-  #    new_oib
-  #  end
-  #end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shapeshifter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Max
@@ -94,7 +94,6 @@ files:
 - README.md
 - Rakefile
 - lib/shapeshifter.rb
-- lib/shapeshifter/null_shifter.rb
 - lib/shapeshifter/shift_chain.rb
 - lib/shapeshifter/shifter.rb
 - lib/shapeshifter/version.rb
@@ -103,7 +102,7 @@ files:
 - spec/fixtures/test_shifter2.rb
 - spec/shapeshifter/shifter_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/Driftrock/shapeshifter
 licenses:
 - MIT
 metadata: {}

data/lib/shapeshifter/null_shifter.rb

@@ -1,7 +0,0 @@
-module Shapeshifter
-  class NullShifter < Shifter
-    def shift(res)
-      res
-    end
-  end
-end