transmogrifier 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDE3MWU3Yjc2NTU5ZjQ5NTNmMzhmZDU0YWU0N2NjZWExMjQzNmQwMA==
+    MmRlZjJhNjI1YTc0NWUyMGU0ZDM1NGYwNmRlNGJkYjg1MTI5ZDdhMg==
   data.tar.gz: !binary |-
-    ZTk1NTkyN2JlZTRkMzI2MTgxZTM3ZjY2OWFmZTY4YjRjYmUxZTQwOA==
+    NjQxOGFhOGYwNzhhNGVjNTJkNTllNDYxZjc2ZTkyNDZiZWE0MTFhMg==
 SHA512:
   metadata.gz: !binary |-
-    ZDQ3MDFkYzkyZTE2NDk1M2RlYmM1MjFlOTRhNzIxN2JmZWE4MWFlNDk5MDcw
-    NjhkMWVlZTBjZDllZTNhZjg2MWU1OWU2N2QxNDNmYWQyYzk3MWE2YjVjNDIy
-    YzJjNTM3NWVjNmU1YTQ3YjgxNGRhNTBlZTIxMzY4NTM4NGQzYTk=
+    YmQ3YmI3MTFjOGM1Y2I3ZGQ0NTc1NGE4MmEzNTgzMmUyMzllZWE1NGUyZmQ0
+    NzYzYWI0NGUwOTU4Y2Y3MjBkNDYzZTZjNDU5Njg2Mzk3M2RkNzRhNzRmMzEy
+    MDU5ODk1MWJkZmNkYTAyNjIxNmNmOWYzMzBiOGJhZmU4NzVjYjA=
   data.tar.gz: !binary |-
-    MDdhNWI1ODUwNDcxNDQ0YTFmZDBmMjI4MzMwNTgzMjFiNDhlMGYxZDQ2MTVl
-    NjJhMDhkZTMzOTE3NDBhMjk5YzgwNjY0OTMyYWI1MWIxYTFkZmE0NjllOTgy
-    ZjdjZWM5YThjY2ZiMWYzNmNkNmJiZWE0MzA4ZDRjNzFhZDg5MTQ=
+    YzI4MzZlODAyNDZjNTA4MDEyNGVkNjFlYWI5NWJlNzk2YWQ3MjU1YTdhMWVj
+    ZTc2ZWFkY2JjNDFlYTcwYmVhYWM4NTVmYTUyZDc1MjU1OTk4YTg1ZTQ5ZmYz
+    ZTEzNGZiZjE1OGU5OGNlNGJhY2MwNTNkMDliYjdlZGE4MDczODk=

data/README.md

@@ -1,13 +1,15 @@
 # Transmogrifier
 
+[![Build Status](https://travis-ci.org/jfoley/transmogrifier.png)](https://travis-ci.org/jfoley/transmogrifier)
+
 Transmogrifier is a tool that allows you to decalaritively migrate a hash from one schema to another. It works by specifying a set of rules to apply to the hash and then running them in order.
 
 ## Usage
 ### Available Rules
-#### Appending a key
+#### Appending a node
 ```ruby
 engine = Transmogrifier::Engine.new
-append = Transmogrifier::Rules::Append.new("", "new_key", "new_value")
+append = Transmogrifier::Rules::Append.new("", { "new_key" => "new_value" })
 
 engine.add_rule(append)
 
@@ -17,23 +19,37 @@ output_hash = engine.run(input_hash)
 # output_hash => {"key" => "value", "new_key" => "new_value"}
 ```
 
-#### Copying a key
+### Updating a node
 ```ruby
 engine = Transmogrifier::Engine.new
-move = Transmogrifier::Rules::Copy.new("", "key", "nested")
+update = Transmogrifier::Rules::Update.new("nested.nested_key", "updated-value")
 
-engine.add_rule(:copy, "", "key", "nested")
+engine.add_rule(update)
 
 input_hash = {"key" => "value", "nested" => {"nested_key" => "nested_value"}}
-output_hash = transmogrifier.run(input_hash)
+output_hash = engine.run(input_hash)
 
-# output_hash => {"key" => "value", "nested" => {"nested_key" => "nested_value", "key" => "value"}}
+# output_hash => {"key" => "value", "nested" => {"nested_key" => "updated-value"}}
 ```
 
-#### Deleting  a key
+#### Copying a node
 ```ruby
 engine = Transmogrifier::Engine.new
-delete = Transmogrifier::Rules::Delete("", "extra_key")
+copy = Transmogrifier::Rules::Copy.new("", "key", "nested.nested_key2")
+
+engine.add_rule(copy)
+
+input_hash = {"key" => "value", "nested" => {"nested_key" => "nested_value"}}
+output_hash = engine.run(input_hash)
+
+# output_hash => {"key" => "value", "nested" => {"nested_key" => "nested_value", "nested_key2" => "value"}}
+```
+If the node to be copied does not exist, then this operation will no-op leaving the hash unchanged.
+
+#### Deleting  a node
+```ruby
+engine = Transmogrifier::Engine.new
+delete = Transmogrifier::Rules::Delete.new("", "extra_key")
 
 engine.add_rule(delete)
 
@@ -43,20 +59,20 @@ output_hash = engine.run(input_hash)
 # output_hash => {"key" => "value"}
 ```
 
-#### Modifying a value
+#### Modifying a node's value
 ```ruby
 engine = Transmogrifier::Engine.new
-move = Transmogrifier::Rules::Modify.new("", "key", "nested")
+move = Transmogrifier::Rules::Modify.new("key", "al", "og")
 
-engine.add_rule(:modify, "key", "al", "og")
+engine.add_rule(move)
 
-input_hash = {"key" => "value", "nested" => {"nested_key" => "nested_value"}}
-output_hash = transmogrifier.run(input_hash)
+input_hash = {"key" => "value"}
+output_hash = engine.run(input_hash)
 
-# output_hash => {"key" => "vogue", "nested" => {"nested_key" => "nested_value"}}
+# output_hash => {"key" => "vogue"}
 ```
 
-#### Moving a key
+#### Moving a node
 ```ruby
 engine = Transmogrifier::Engine.new
 move = Transmogrifier::Rules::Move.new("", "key", "nested")
@@ -64,7 +80,7 @@ move = Transmogrifier::Rules::Move.new("", "key", "nested")
 engine.add_rule(:move, "", "key", "nested")
 
 input_hash = {"key" => "value", "nested" => {"nested_key" => "nested_value"}}
-output_hash = transmogrifier.run(input_hash)
+output_hash = engine.run(input_hash)
 
 # output_hash => {"nested" => {"nested_key" => "nested_value", "key" => "value"}}
 ```

data/lib/transmogrifier/nodes/hash_node.rb

@@ -22,8 +22,6 @@ module Transmogrifier
 
     def clone(key)
       matching_node = @hash[key]
-      raise "Multiple nodes match #{key}, clone criteria ambiguous" if matching_node.nil?
-
       Marshal.load(Marshal.dump(matching_node))
     end
 

data/lib/transmogrifier/rules/append.rb

@@ -1,8 +1,8 @@
 module Transmogrifier
   module Rules
     class Append
-      def initialize(parent_selector, hash)
-        @parent_selector, @hash = parent_selector, hash
+      def initialize(parent_selector, new_hash)
+        @parent_selector, @hash = parent_selector, new_hash
       end
 
       def apply!(input_hash)

data/lib/transmogrifier/rules/copy.rb

@@ -14,6 +14,7 @@ module Transmogrifier
         parents.each do |parent|
           to_parent = parent.find_all(to_keys).first
           object = parent.find_all(from_keys).first.clone(from_key)
+          next if object.nil?
 
           if to_child = to_parent.find_all([to_key]).first
             to_child.append(object)

data/lib/transmogrifier/rules/update.rb

@@ -0,0 +1,30 @@
+module Transmogrifier
+  module Rules
+    class Update
+      def initialize(selector, new_value)
+        @selector, @new_value = selector, new_value
+      end
+
+      def apply!(input_hash)
+        top = Node.for(input_hash)
+        *parent_keys, child_key = Selector.from_string(@selector).keys
+
+        parents = top.find_all(parent_keys)
+        raise SelectorNotFoundError, "#{parent_keys} does not select a node" unless parents.length > 0
+
+        parents.each do |parent|
+          if parent.class == HashNode
+            raise SelectorNotFoundError, "no mapping for #{child_key} in parent node" unless parent.raw.has_key?(child_key)
+            parent.append({child_key => @new_value})
+          elsif parent.class == ArrayNode
+            deleted_node = parent.delete(child_key)
+            raise SelectorNotFoundError, "no node found with specified attributes" if deleted_node.nil?
+            parent.append(@new_value)
+          end
+        end
+
+        top.raw
+      end
+    end
+  end
+end

data/lib/transmogrifier/selector.rb

@@ -1,4 +1,6 @@
 module Transmogrifier
+  class SelectorNotFoundError < RuntimeError; end
+
   class Selector
     FILTER_REGEX = /\[(.*)\]/
     OPERATORS = ["!=", "="]

data/lib/transmogrifier/version.rb

@@ -1,3 +1,3 @@
 module Transmogrifier
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/nodes/hash_node_spec.rb

@@ -66,14 +66,25 @@ module Transmogrifier
     end
 
     describe "#clone" do
-      it "returns a copy of value" do
-        value = "other_value"
-        hash = {"key" => "value", "extra_key" => value}
-        node = HashNode.new(hash)
+      context "when key exists" do
+        it "returns a copy of value" do
+          value = "other_value"
+          hash = {"key" => "value", "extra_key" => value}
+          node = HashNode.new(hash)
+
+          expect(node.clone("extra_key")).to eql(value)
+          expect(node.clone("extra_key")).to_not be(value)
+          expect(node.raw).to eq("key" => "value", "extra_key" => "other_value")
+        end
+      end
+
+      context "when key does not exist" do
+        it "returns nil" do
+          hash = {"key" => "value"}
+          node = HashNode.new(hash)
 
-        expect(node.clone("extra_key")).to eql(value)
-        expect(node.clone("extra_key")).to_not be(value)
-        expect(node.raw).to eq("key" => "value", "extra_key" => "other_value")
+          expect(node.clone("extra_key")).to be_nil
+        end
       end
     end
 

data/spec/rules/copy_spec.rb

@@ -96,4 +96,22 @@ describe Transmogrifier::Rules::Copy do
       })
     end
   end
+
+  context "when the selector does not find a node" do
+    context "when the parent node is a HashNode" do
+      subject(:copy) { described_class.new("", "missing_key", "nested") }
+
+      it "does not modify the input hash" do
+        expect(copy.apply!(input_hash)).to eq(input_hash)
+      end
+    end
+
+    context "when the parent node is an ArrayNode" do
+      subject(:copy) { described_class.new("", "array.[inside=missing_value]", "nested") }
+
+      it "does not modify the input hash" do
+        expect(copy.apply!(input_hash)).to eq(input_hash)
+      end
+    end
+  end
 end

data/spec/rules/modify_spec.rb

@@ -19,7 +19,7 @@ describe Transmogrifier::Rules::Modify do
   context "when the selector finds a HashNode" do
     subject(:modify) { described_class.new("", "al", "og") }
 
-    it "appends to the hash" do
+    it "raises an error" do
       expect{modify.apply!(input_hash)}.to raise_error(NotImplementedError)
     end
   end
@@ -27,7 +27,7 @@ describe Transmogrifier::Rules::Modify do
   context "when the selector finds an ArrayNode" do
     subject(:modify) { described_class.new("array", "al", "og") }
 
-    it "appends to the array" do
+    it "raises an error" do
       expect{modify.apply!(input_hash)}.to raise_error(NotImplementedError)
     end
   end

data/spec/rules/update_spec.rb

@@ -0,0 +1,101 @@
+require "transmogrifier"
+
+describe Transmogrifier::Rules::Update do
+  let(:input_hash) do
+    {
+      "key" => "value",
+      "hash" => { "nested" => "hash-value" },
+      "array" => [{"name" => "array-value"}],
+    }
+  end
+
+  context "when the key specifies a ValueNode" do
+    subject(:update) { described_class.new("key", "new-value") }
+
+    it "replaces the value with the new value" do
+      expect(update.apply!(input_hash)).to eq({
+        "key" => "new-value",
+        "hash" => { "nested" => "hash-value" },
+        "array" => [{"name" => "array-value"}],
+      })
+    end
+  end
+
+  context "when the key specifies a HashNode" do
+    subject(:update) { described_class.new("hash", "new-value") }
+
+    it "replaces the value of the hash with the new value" do
+      expect(update.apply!(input_hash)).to eq({
+          "key" => "value",
+          "hash" => "new-value",
+          "array" => [{"name" => "array-value"}],
+      })
+    end
+  end
+
+  context "when the key specifies an ArrayNode" do
+    subject(:update) { described_class.new("array", "new-value") }
+
+    it "replaces the value of the array with the new value" do
+      expect(update.apply!(input_hash)).to eq({
+          "key" => "value",
+          "hash" => { "nested" => "hash-value" },
+          "array" => "new-value",
+      })
+    end
+  end
+
+  context "when the selector specifies a node inside of an array" do
+    let(:input_hash) do
+      {
+          "array" => [
+            { "name" => "value-to-modify", "other" => "properties", "get" => "overwritten" },
+            { "name" => "leave-me-alone" },
+          ],
+      }
+    end
+
+    subject(:update) { described_class.new("array.[name=value-to-modify]", { "name" => "new-value"}) }
+
+    it "replaces the value of the array's node with the new value" do
+      expect(update.apply!(input_hash)).to eq({
+        "array" => [
+          { "name" => "leave-me-alone" },
+          { "name" => "new-value" },
+        ],
+      })
+    end
+  end
+
+  context "when the selector does not find a node" do
+    context "when the selector finds a hash as the parent" do
+      subject(:update) { described_class.new("non-existant-key", "new-value") }
+
+      it "raises a SelectorNotFoundError" do
+        expect {
+          update.apply!(input_hash)
+        }.to raise_error(Transmogrifier::SelectorNotFoundError)
+      end
+    end
+
+    context "when the selector finds an array as the parent" do
+      subject(:update) { described_class.new("array.[name=non-existant-key]", "new-value") }
+
+      it "raises a SelectorNotFoundError" do
+        expect {
+          update.apply!(input_hash)
+        }.to raise_error(Transmogrifier::SelectorNotFoundError)
+      end
+    end
+
+    context "when the selector does not find a parent" do
+      subject(:update) { described_class.new("wrong.key", "new-value") }
+
+      it "raises a SelectorNotFoundError" do
+        expect {
+          update.apply!(input_hash)
+        }.to raise_error(Transmogrifier::SelectorNotFoundError)
+      end
+    end
+  end
+end

data/spec/transmogrifier_spec.rb

@@ -180,6 +180,24 @@ describe Transmogrifier::Engine do
             })
           end
         end
+
+        context "when the selector does not find a node" do
+          context "when the parent node is a HashNode" do
+            subject(:rules) { [ {"type" => "copy", "selector" => "", "from" => "missing_key", "to" => "nested"} ] }
+
+            it "does not modify the input hash" do
+              expect(engine.run(input_hash)).to eq(input_hash)
+            end
+          end
+
+          context "when the parent node is an ArrayNode" do
+            subject(:rules) { [ {"type" => "copy", "selector" => "", "from" => "array.[inside=missing_value]", "to" => "nested"} ] }
+
+            it "does not modify the input hash" do
+              expect(engine.run(input_hash)).to eq(input_hash)
+            end
+          end
+        end
       end
 
       describe "deleting keys" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transmogrifier
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John Foley
@@ -72,6 +72,7 @@ files:
 - lib/transmogrifier/rules/delete.rb
 - lib/transmogrifier/rules/modify.rb
 - lib/transmogrifier/rules/move.rb
+- lib/transmogrifier/rules/update.rb
 - lib/transmogrifier/selector.rb
 - lib/transmogrifier/version.rb
 - README.md
@@ -87,6 +88,7 @@ files:
 - spec/rules/delete_spec.rb
 - spec/rules/modify_spec.rb
 - spec/rules/move_spec.rb
+- spec/rules/update_spec.rb
 - spec/selector_spec.rb
 - spec/transmogrifier_spec.rb
 homepage: http://github.com/jfoley/transmogrifier
@@ -124,6 +126,7 @@ test_files:
 - spec/rules/delete_spec.rb
 - spec/rules/modify_spec.rb
 - spec/rules/move_spec.rb
+- spec/rules/update_spec.rb
 - spec/selector_spec.rb
 - spec/transmogrifier_spec.rb
 has_rdoc: