transformator 0.0.1 → 0.1.0

data/spec/transformator/dsl_spec.rb

@@ -0,0 +1,187 @@
+describe Transformator::Dsl do
+  let(:dsl) do
+    Module.new.extend(described_class)
+  end
+
+  #
+  # array
+  #
+  describe "#array" do
+    it "creates a new element with attribute \"type\" == \"array\"" do
+      expect(dsl.array(:foo)["type"]).to eq("array")
+    end
+
+    context "when called with a block" do
+      describe "passes an array accumulator to the block" do
+        it "allows appending elements to the array so that it's activesupport Hash.from_xml compatble" do
+          array_with_one_element = dsl.array(:foo) do |arr|
+            arr << dsl.element(:bar)
+          end
+
+          expect(dsl.find(array_with_one_element, "foo/bar")).not_to be_nil
+        end
+      end
+    end
+  end
+
+  #
+  # element
+  #
+  describe "#element" do
+    it "creates a new element with the given name" do
+      expect(dsl.element(:foo).value).to eq("foo")
+    end
+
+    context "when called with an \"attributes\" option" do
+      it "sets the attributes of the newly created element accordingly" do
+        attributes = { attr1: 1, attr2: "2", "attr3" => true }
+        expect(dsl.element(:foo, attributes: attributes).attributes).to eq({
+          "attr1" => "1",
+          "attr2" => "2",
+          "attr3" => "true"
+        })
+      end
+    end
+
+    context "when called with a \"text\" option" do
+      it "adds a text node to the newly created element" do
+        expect(dsl.element(:foo, text: "bar").text).to eq("bar")
+      end
+    end
+
+    context "when called with a \"type\" option" do
+      it "adds an attribute named \"type\" with the given value" do
+        expect(dsl.element(:foo, text: 1, type: :integer).attributes).to include({"type" => "integer"})
+      end
+    end
+  end
+
+  #
+  # elements_from_hash
+  #
+  describe "#elements_from_hash" do
+    let(:hash) do
+      {
+        key1: "value1",
+        key2: [
+          {
+            subkey: "subvalue"
+          }
+        ]
+      }
+    end
+
+    it "creates elements from the given hash" do
+      elements = dsl.elements_from_hash(hash)
+      expect(elements[0].value).to eq("key1")
+      expect(dsl.find(elements[1], "key2/subkey").text).to eq("subvalue") # key2 ist found due to the additional array element encoding
+    end
+  end
+
+  #
+  # elements_from_xml
+  #
+  describe "#elements_from_xml" do
+    let(:xml) do
+      <<-xml.strip_heredoc
+        <key1>value1</key1>
+        <key2>
+          <subkey>subvalue</subkey>
+        </key2>
+      xml
+    end
+
+    it "creates elements from the given xml string" do
+      elements = dsl.elements_from_xml(xml)
+      expect(elements[0].value).to eq("key1")
+      expect(dsl.find(elements[1], "subkey").text).to eq("subvalue")
+    end
+  end
+
+  #
+  # find
+  #
+  describe "#find" do
+    let(:node) do
+      dsl.element(:root) do |root|
+        root << dsl.element(:foo, text: "1")
+        root << dsl.element(:foo, text: "2")
+      end
+    end
+
+    describe "is a shortcut for find_all(..)[0]" do
+      context "when there are elements matching the given path" do
+        it "returns the first element found" do
+          expect(dsl.find(node, "foo").text).to eq("1")
+        end
+      end
+
+      context "when there are no elements matching the given path" do
+        it "returns nil" do
+          expect(dsl.find(node, "nope")).to be_nil
+        end
+      end
+    end
+  end
+
+  #
+  # find_all
+  #
+  describe "#find_all" do
+    let(:node) do
+      dsl.element(:root) do |root|
+        root << dsl.element(:foo, text: "1")
+        root << dsl.element(:foo, text: "2")
+        root << dsl.element(:bar) do |bar|
+          bar << dsl.element(:muff) do |muff|
+            muff << dsl.element(:key, text: "value")
+          end
+        end
+      end
+    end
+
+    it "understands xpath like path expressions" do
+      expect(dsl.find_all(node, "//key")).not_to be_nil
+    end
+
+    describe "finds all elements by the given path" do
+      context "when there are elements matching the given path" do
+        it "returns all elements found" do
+          expect(dsl.find_all(node, "foo").map(&:text)).to eq(["1", "2"])
+        end
+      end
+
+      context "when there are no elements matching the given path" do
+        it "returns an empty array" do
+          expect(dsl.find_all(node, "nope")).to eq([])
+        end
+      end
+    end
+
+    context "when called with a block" do
+      context "when there are elements matching the given path" do
+        it "calls the block with resulting array" do
+          variable_changed_inside_block = false
+
+          dsl.find_all(node, "foo") do |result|
+            variable_changed_inside_block = true if result.length == 2
+          end
+
+          expect(variable_changed_inside_block).to be(true)
+        end
+      end
+
+      context "when there are no elements matching the given path" do
+        it "the block is not called" do
+          variable_changed_inside_block = false
+
+          dsl.find_all(node, "nope") do |foo|
+            variable_changed_inside_block = true 
+          end
+
+          expect(variable_changed_inside_block).to be(false)
+        end
+      end
+    end
+  end
+end

data/spec/transformator/format_converter/hash_from_document_spec.rb

@@ -0,0 +1,42 @@
+describe Transformator::FormatConverter::HashFromDocument do
+  let(:transformator) do
+    Module.new.tap do |mod|
+      mod.extend Transformator::FormatConverter::HashFromDocument
+      mod.extend Transformator::FormatConverter::DocumentFromHash
+    end
+  end
+
+  let(:hash) do
+    {
+      "key1" => "value1",
+      "key2" => 1,
+      "key3" => 1.5,
+      "key4" => true,
+      "key5" => nil,
+      "key6" => {
+        "key6_1" => "value6_1"
+      },
+      "key7" => [
+        "1",
+        2,
+        true,
+        {
+          "key_arr_obj1" => [
+            "nested_element1",
+            {
+              "nested_key" => "nested_value"
+            }
+          ]
+        }
+      ]
+    }     
+  end
+
+  let(:document) do
+    transformator.document_from_hash(hash)
+  end
+
+  it "converts a document to its corresponding hash" do
+    expect(transformator.hash_from_document(document)).to eq(hash)
+  end
+end

data/spec/transformator/transformation_spec.rb

@@ -16,174 +16,28 @@ describe Transformator::Transformation do
   end
 
   describe "#new" do
-    it "can be called with a block, containing the mapping described by the DSL" do
+    it "can be called with a block, containing the mapping described by the dsl" do
       transformation = described_class.new do
-        process "foo/bar" do |elements, target|
-          target_elements = elements.map do |element|
-            Ox::Element.new("muff").tap do |new_element|
-              element.nodes.each do |node|
-                new_element << node
-              end
-            end
-          end
-
-          target << target_elements.first
-          binding.pry
+        process "foo/bar" do |element, target|
+          target << element("muff", nodes: element.nodes)
         end
       end
 
-      expect(transformation.apply_to(source_xml)).to eq(transformed_xml)
-    end
-=begin
-    context "when called with a \"context\" option" do
-      it "passes methods from withing the mapping (e.g. procs/lambdas) to the context" do
-        some_class = Class.new do
-          require "yahm"
-
-          def some_method(value)
-            value.to_s + "bar"
-          end
-
-          def mapping
-            @mapping ||= Yahm::Mapping.new(context: self) do
-              map "/foo", to: "/bar", processed_by: lambda { |v| some_method(v) }
-            end
-          end
-
-          def apply_mapping_to(hash)
-            mapping.apply_to(hash)
-          end
-        end
-       
-        expect(some_class.new.apply_mapping_to({foo: "foo"})).to eq({:bar=>"foobar"})
-      end
+      expect(transformation.apply(to: source_xml)).to eq(transformed_xml)
     end
-=end
   end
-=begin
-  describe ".apply_to" do
-    let(:mapping) do
-      Yahm::Mapping.new do
-        map "/record_id",          to: "/id"
-        map "/record/title",       to: "/title"
-        map "/record/isbns",       to: "/my_data/isbns"
-        map "/record/isbns[1]",    to: "/main_isbn"                     # when an array, one can specifiy which element to choose
-        map "/record/count",       to: "/count", processed_by: lambda { |v| v.to_i }
-        map "/record/languages",   to: "/languages", force_array: true
-        map "/record/authors",     to: "/authors", split_by: ";"
-        map "/record/version",     to: "/version", default: 1
-        map "/record/creators",    to: "/creators", force_array: true   # when source value is nil, there should be an empty array in the target hash
-        map "/record/publishers",  to: "/publishers", split_by: ";"     # if there are is no source value, this should result to nil in the target hash
-      end
-    end
-
-    let(:input_hash) do
-      {
-        record_id: "some_id123",
-        record: {
-          title: "some title",
-          isbns: [
-            "3-86680-192-0",
-            "3-680-08783-7"
-          ],
-          count: "3",
-          languages: "ger",
-          authors: "John Doe; Jane Doe"
-        }
-      }
-    end
-
-    let(:expected_result) do
-      {
-        :id=>"some_id123",
-        :title=>"some title",
-        :my_data=>{:isbns=>["3-86680-192-0", "3-680-08783-7"]},
-        :main_isbn=>"3-680-08783-7",
-        :count=>3,
-        :languages=>["ger"],
-        :authors=>["John Doe", "Jane Doe"],
-        :version=>1,
-        :creators=>[],
-        :publishers=>nil
-      }
-    end
-
-    it "translates a given hash according to @rules" do
-      expect(mapping.apply_to(input_hash)).to eq(expected_result)
-    end
-
-    context "when threading is enabled" do
-      it "translates a given hash according to @rules" do
-        mapping.use_threads = true
-        expect(mapping.apply_to(input_hash)).to eq(expected_result)
-      end
-    end
     
-    it "does not apply \"split_by\" if source value is an array" do
-      expect(Yahm::Mapping.new { map "/source/value", to: "/target", split_by: ";" }.apply_to(source: { value: ["foo", "foo;bar"] }))
-      .to eq({
-        :target => ["foo", "foo;bar"]
-      })
-    end
-
-    it "processes the source value by the lambda/proc given by \"processed_by\"" do
-      expect(Yahm::Mapping.new { map "/source/value", to: "/target", processed_by: lambda { |v| v.downcase } }.apply_to(source: { value: "A STRING" }))
-      .to eq({
-        :target => "a string"
-      })
-
-      expect(Yahm::Mapping.new { map "/source/value", to: "/target", processed_by: proc { |v| v.downcase } }.apply_to(source: { value: "A STRING" }))
-      .to eq({
-        :target => "a string"
-      })
-    end
-
-    it "returns nil if the source path does not exist" do
-      expect(Yahm::Mapping.new { map "/source/value/min", to: "/target" }.apply_to(foo: "bar")).to eq({
-        :target => nil
-      })
-    end
-
-    it "accepts a lambda/proc as :to option" do
-      expect(Yahm::Mapping.new { map "/source", to: lambda { |v, result| result.merge!(target: true) } }.apply_to(foo: "bar"))
-      .to eq({
-        :target => true
-      })
-    end
-
-    it "provides multiple values as an array of values to lambdas/procs" do
-      expect(Yahm::Mapping.new { map "/source", to: "/array_length",  processed_by: lambda { |v| v.length } }.apply_to(source: ["bar", "moep"]))
-      .to eq({
-        :array_length => 2
-      })
-    end
-
-    it "can map multiple input fields to one output field" do
-      mapping = Yahm::Mapping.new do
-        map ["/hello", "/world", "/foo"], to: "/combined", processed_by: lambda { |v| v.values.compact.join(" ") }
-      end
-
-      expect(mapping.apply_to({
-        hello: "hello",
-        world: "world"
-      })).to eq({
-        combined: "hello world"
-      })
-    end
-
-    it "can be called with a \"context\" option to set/overwrite the mapping context" do
-      mapping = Yahm::Mapping.new do
-        map "/source", to: "/target", processed_by: lambda { |v| process_value(v) }
-      end
-
-      context = Module.new do
-        def self.process_value(v)
-          v.to_i
+  describe ".process" do
+    context "when called with the special path :document" do
+      it "provides the whole input document to the block" do
+        transformation = described_class.new do
+          process :document do |document, target|
+            target << element("muff", nodes: ["muff"]) if document.nodes.empty?
+          end
         end
-      end
 
-      expect(mapping.apply_to({source: "1"}, context: context)).to eq({target: 1})
+        expect(transformation.apply(to: nil, output_format: :xml)).to eq(transformed_xml)
+      end
     end
   end
-=end
 end

data/spec/transformator_spec.rb

@@ -1,2 +1,10 @@
 describe Transformator do
+  describe "#oxify_path" do
+    it "maps xpath like path expressions to Ox compatible ones" do
+      expect(described_class.oxify_path("/foo")).to eq("?/foo")
+      expect(described_class.oxify_path("/foo/bar")).to eq("?/foo/bar")
+      expect(described_class.oxify_path("//bar")).to eq("*/bar")
+      expect(described_class.oxify_path("/foo//bar")).to eq("?/foo/*/bar")
+    end
+  end
 end

data/transformator.gemspec

@@ -16,9 +16,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ox", ">= 2.0.0", "< 3.0.0"
+  spec.add_dependency "activesupport", ">= 3"
+  spec.add_dependency "builder",       ">= 3"
+  spec.add_dependency "libxml-ruby",   ">= 0.9.7"
+  spec.add_dependency "ox",            ">= 2"
 
-  spec.add_development_dependency "activesupport", ">= 3.0.0", "< 5.0.0"
+  spec.add_development_dependency "benchmark-ips", ">= 2.0.0"
   spec.add_development_dependency "bundler",       "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec",         ">= 3.0.0", "< 4.0.0"

metadata

@@ -1,55 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: transformator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael Sievers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ox
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - "<"
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - "<"
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.7
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: ox
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,10 +140,25 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/primo_search_response.xml
+- assets/primo_search_response_1.xml
+- examples/primo_search_response_transformation.rb
+- examples/search_request_transformation.rb
 - lib/transformator.rb
+- lib/transformator/dsl.rb
+- lib/transformator/format_converter.rb
+- lib/transformator/format_converter/document_from_hash.rb
+- lib/transformator/format_converter/document_from_object.rb
+- lib/transformator/format_converter/document_from_xml.rb
+- lib/transformator/format_converter/hash_from_document.rb
+- lib/transformator/format_converter/xml_from_document.rb
 - lib/transformator/transformation.rb
 - lib/transformator/version.rb
+- spec/examples/primo_search_response_transformation_spec.rb
+- spec/examples/search_request_transformation_spec.rb
 - spec/spec_helper.rb
+- spec/transformator/dsl_spec.rb
+- spec/transformator/format_converter/hash_from_document_spec.rb
 - spec/transformator/transformation_spec.rb
 - spec/transformator_spec.rb
 - transformator.gemspec
@@ -137,11 +182,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: A ruby dsl for transforming hashes or json/xml documents
 test_files:
+- spec/examples/primo_search_response_transformation_spec.rb
+- spec/examples/search_request_transformation_spec.rb
 - spec/spec_helper.rb
+- spec/transformator/dsl_spec.rb
+- spec/transformator/format_converter/hash_from_document_spec.rb
 - spec/transformator/transformation_spec.rb
 - spec/transformator_spec.rb