transformator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d12867ec6be626559c324f81d2de7763d6d5276
+  data.tar.gz: 6dc48981be819de4302d2432953f6f7183a48b63
+SHA512:
+  metadata.gz: b8d5164a191183bf62501b67eff5560d2389b5a4c9a863828e0ff88d5b04d5a1127d3501f6aa831982d45c94094be6ae23488224d2eeb04b2df9865c2b19b8ae
+  data.tar.gz: bae53fd9cf275ffb45a5e306792d0b1eea195bcdd4064cd69a0474140810dd631e200e14d30c2792fa8d53e5d48dec315810d4ff16efa29601fea6791e35cf2f

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
+--format documentation
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xml_transformer.gemspec
+gemspec
+
+gem "pry",                "~> 0.9.12.6"
+gem "pry-byebug",         "<= 1.3.2"
+gem "pry-stack_explorer", "~> 0.4.9.1"
+gem "pry-syntax-hacks",   "~> 0.0.6"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Sievers
+
+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,29 @@
+# Transformator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transformator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transformator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/transformator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

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/transformator/transformation.rb

@@ -0,0 +1,41 @@
+require "ox"
+
+class Transformator::Transformation
+  def initialize(options = {}, &block)
+    @context = options[:context]
+    @rules = []
+    self.instance_eval(&block) if block
+  end
+
+  def apply_to(source, options = {})
+    source = Ox.parse(source) if source.is_a?(String)
+    result = Ox::Document.new(version: "1.0", encoding: "UTF-8").tap do |target|
+      @rules.each do |rule|
+        apply_rule(rule, source, target, options)
+      end
+    end
+
+    Ox.dump(result, with_xml: true)
+  end
+
+  private
+
+  def process(path, options = {}, &block)
+    @rules.push({ callable: block, path: path }.merge(options))
+    self
+  end
+
+  def apply_rule(rule, source, target, options = {})
+    value =
+    if rule[:path].is_a?(Array)
+      rule[:path].inject({}) do |hash, path|
+        hash[path] = source.locate(path)
+        memo
+      end
+    else
+      source.locate(rule[:path])
+    end
+
+    (options[:context] || @context || self).instance_exec(value, target, &rule[:callable])
+  end
+end

data/lib/transformator/version.rb

@@ -0,0 +1,3 @@
+module Transformator
+  VERSION = "0.0.1"
+end

data/lib/transformator.rb

@@ -0,0 +1,5 @@
+require "transformator/version"
+
+module Transformator
+  require_relative "./transformator/transformation"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "active_support/core_ext"
+require "transformator"
+
+# require pry if possible
+begin
+  require "pry"
+rescue LoadError
+end
+
+RSpec.configure do |config|
+  # begin --- rspec 3.1 generator
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  # end --- rspec 3.1 generator
+end

data/spec/transformator/transformation_spec.rb

@@ -0,0 +1,189 @@
+describe Transformator::Transformation do
+  let(:source_xml) do
+    <<-xml.strip_heredoc
+      <?xml version="1.0" encoding="UTF-8"?>
+      <foo>
+        <bar>muff</bar>
+      </foo>
+    xml
+  end
+
+  let(:transformed_xml) do
+    <<-xml.strip_heredoc
+      <?xml version="1.0" encoding="UTF-8"?>
+      <muff>muff</muff>
+    xml
+  end
+
+  describe "#new" 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
+        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
+    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
+        end
+      end
+
+      expect(mapping.apply_to({source: "1"}, context: context)).to eq({target: 1})
+    end
+  end
+=end
+end

data/spec/transformator_spec.rb

@@ -0,0 +1,2 @@
+describe Transformator do
+end

data/transformator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "transformator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "transformator"
+  spec.version       = Transformator::VERSION
+  spec.authors       = ["Michael Sievers"]
+  spec.summary       = %q{A ruby dsl for transforming hashes or json/xml documents}
+  spec.homepage      = "https://github.com/ubpb/transformator"
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ox", ">= 2.0.0", "< 3.0.0"
+
+  spec.add_development_dependency "activesupport", ">= 3.0.0", "< 5.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"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: transformator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.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
+- !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.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.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: 4.0.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transformator.rb
+- lib/transformator/transformation.rb
+- lib/transformator/version.rb
+- spec/spec_helper.rb
+- spec/transformator/transformation_spec.rb
+- spec/transformator_spec.rb
+- transformator.gemspec
+homepage: https://github.com/ubpb/transformator
+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: A ruby dsl for transforming hashes or json/xml documents
+test_files:
+- spec/spec_helper.rb
+- spec/transformator/transformation_spec.rb
+- spec/transformator_spec.rb