data_maps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ff13a28428388b271443275bd30d17178780d23
+  data.tar.gz: 1e501af25f3bed2e788332d01374440ce2a45286
+SHA512:
+  metadata.gz: 83fbf366ee2287b51444a37253b285854d669b4e47279fbc45c16a26593c0533d90bb3f899961c0e26774e0b0d15255dd3ea0ac1fc92ef4ca57c8d56edef3c12
+  data.tar.gz: 621c5f21a176a058321f76eb758e8d55f71ccfd5851e96bc5d77a71848b652d8d503c7d7e2a42fba5fb32704787d02725da9ff0d77cf34b52726763abaa04842

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.3
+addons:
+  code_climate:
+    repo_token: 2111a70b2a7d70a9ec1c1d386e9dbd2f1bceec2cd16524393fcce14c280b571c

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_maps.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    data_maps (0.1.0)
+      activesupport (~> 3.2.21)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.21)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    codeclimate-test-reporter (0.4.6)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    multi_json (1.10.1)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter
+  data_maps!
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  simplecov (~> 0.9.1)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Axel Wahlen
+
+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,264 @@
+DataMaps
+=================
+[![Build Status](https://travis-ci.org/dino115/data_maps.svg?branch=master)](https://travis-ci.org/dino115/data_maps)
+[![Code Climate](https://codeclimate.com/github/dino115/data_maps/badges/gpa.svg)](https://codeclimate.com/github/dino115/data_maps)
+[![Test Coverage](https://codeclimate.com/github/dino115/data_maps/badges/coverage.svg)](https://codeclimate.com/github/dino115/data_maps)
+
+Create great mappings to convert structured data into your own format!
+
+**Attention:** This gem is currently under development and can't be used yet!
+
+## Installation
+
+Add this line to your applications' Gemfile:
+
+```ruby
+gem 'data_maps'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install data_maps
+
+## Usage
+
+### Mapper
+The DataMaps::Mapper converts data from a ruby hash to another.
+
+```ruby
+mapper = DataMaps::Mapper.new(mapping)
+
+converted_data = your_data.map do |data_row|
+  mapper.convert(data_row)
+end
+```
+
+### Mapping
+Create mappings.
+
+#### Simple field mapping
+```ruby
+mapping = DataMaps::Mapping.new({
+  'field' => {
+    from: 'source'
+  }
+  # or simple: 'field' => 'source'
+})
+```
+
+#### Conditions
+Conditions must always have a when and then command. All condition statements are executed procedural.
+The only exception is when using `then: { filter: true }`, then the execution breaks immediately and removes the whole field from result data.
+
+```ruby
+  'field' => {
+    from: 'source' # or array of source fields
+    conditions: [
+      { when: { empty: true }, then: { set: 'something' },
+      { when: { regex: /[1-9]{5}/i }, then: { convert: { numeric: 'Integer' } } }
+    ]
+  }
+```
+
+##### Possible when's
+
+- **When: empty**
+  Possible options for the empty conditions are `true` or `false`.
+  The condition is true when `data.empty? == result`
+
+  ```ruby
+    empty: true # or false
+  ```
+- **When: regex**
+  Define a regular expression condition.
+  The condition is true when `data.match regex`. Only works with strings.
+
+  ```ruby
+    regex: /[a-z]/i
+  ```
+- **When: gt, gte**
+  Check if data is *greater* or *greater or equal* than the given value. Only works with comparable objects.
+
+  ```ruby
+    gt: 5
+    gte 5
+  ```
+- **When: lt, lte**
+  Check if data is *lower* or *lower or equal* than the given value. Only works with comparable objects.
+
+  ```ruby
+    lt: 5
+    lte: 5
+  ```
+- **When: eq, neq**
+  Check if data is *equal* or *not equal* to the given value. Only works with comparable objects.
+
+  ```ruby
+    eq: 10
+    neq: 'a-value'
+  ```
+- **When: in, nin**
+  Check if data is *in* or *not in* the set of given values. Doesn't work for a collection of values.
+
+  ```ruby
+    in: ['a', 'b', 'c']
+    nin: ['x', 'y', 'z']
+  ```
+- **When: custom**
+  Define your own condition class by defining them in the `DataMaps::When` module.
+  Your `When` must implement a `execute` method which returns `true` or `false`.
+  You have to extend the `DataMaps::When::Base` class. Then all options are available via the `option` attribute reader.
+
+  ```ruby
+    class DataMaps::When::IsZip < DataMaps::When::Base
+      def execute(data)
+        !!data.match(/\d{5}/)
+      end
+    end
+  ```
+
+  ```ruby
+    is_zip: true # option isn't used, you can pass anything, for example and readability true
+  ```
+
+##### Possible then's
+
+- **Then: set**
+  Set the value to given value.
+
+  ```ruby
+    set: 'to this value'
+  ```
+- **Then: convert**
+  Apply the configured converter. See converter section for more information.
+
+  ```ruby
+    convert: {
+      numeric: 'Integer'
+    }
+  ```
+- **Then: filter**
+  When this is set to true then the whole field will filtered.
+
+  ```ruby
+    filter: true
+  ```
+- **Then: custom**
+  Define your own *then* by defining them in the `DataMaps::Then` module.
+  Your `Then` must implement a `execute` method. The return of this method is set as data.
+  You have to extend the `DataMaps::Then::Base` class. Then all options are available via the `option` attribute reader.
+
+  ```ruby
+    class DataMaps::Then::SendEmail < DataMaps::Then::Base
+      def execute(data)
+        MyFramework::Email.send(to: option)
+        data
+      end
+    end
+  ```
+
+  ```ruby
+    send_email: me@example.com
+  ```
+
+#### Converter
+Apply one or many converters to the input data. Converters applied procedural.
+
+```ruby
+  'field' => {
+    from: 'source',
+    convert: {
+      map: {
+        1: 'A',
+        2: 'B'
+      }
+    }
+  }
+```
+
+##### Possible converter
+
+- **Converter: map**
+  A simple value mapping. Maps are converted to a `HashWithIndifferentAccess`.
+  Works with flat values, hashes and arrays.
+  For arrays and hashes it returns nil if the value is not in the mapping. For flat values it returns the original data.
+
+  ```ruby
+    map: {
+      from: to
+    }
+  ```
+- **Converter: numeric**
+  Cast data to a numeric value. Possible options are 'Integer', 'Float' or a number, then it is casted to float and rounded. Doesn't work with collections.
+  Can raise an error if the value is not convertable.
+
+  ```ruby
+    numeric: 'Integer'
+    numeric: 'Float'
+    numeric: 2
+  ```
+- **Converter: String**
+  Cast explicit to string. Doesn't work with collections.
+  Can raise error if the value is not convertable.
+
+  ```ruby
+    string: true
+  ```
+- **Converter: Boolean**
+  Cast explicit to bool (by double negotiation). Doesn't work with collections.
+  Can return unexpected values, e.g. a double negotiated empty array is true! `!![] #=> true`
+
+  ```ruby
+    bool: true
+  ```
+- **Converter: keys**
+  This maps the hash keys when the input data is a hash or when you select multiple *from* fields. Only works with hashes.
+  Return the original data when the data isn't a hash.
+
+  ```ruby
+    keys: {
+      'address1' => 'street'
+    }
+  ```
+- **Converter: Prefix**
+  This prefixes the data with a given value. Call `to_s` on data and always returns a string.
+
+  ```ruby
+    prefix: '$'
+  ```
+- **Converter: Postfix**
+  This postfixes the data with a given value. Call `to_s` on data and always returns a string.
+
+  ```ruby
+    postfix: '€'
+  ```
+- **Converter: ruby**
+  Apply any method on the current data object.
+
+  ```ruby
+    ruby: :upcase
+    ruby: [:slice, 5]
+    ruby: [:join, ', ']
+  ```
+- **Converter: custom**
+  Define your own *converter* by defining them in the `DataMaps::Converter` module.
+  Your `Converter` must implement an `execute` method. The return of this method is set as new data.
+  You have to extend the `DataMaps::Converter::Base` class. Then all options are available via the `option` attribute reader.
+
+  ```ruby
+    class DataMaps::Converter::ToPersonObject < DataMaps::Converter::Base
+      def execute(data)
+        Person.new(data, option)
+      end
+    end
+  ```
+
+  ```ruby
+    to_person_object: { as: :importer } # passed value are available with option
+  ```
+
+Have fun using the `DataMaps` gem :)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  task :default => :spec
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts 'rspec isn\'t available'
+end

data/data_maps.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_maps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'data_maps'
+  spec.version       = DataMaps::VERSION
+  spec.authors       = ['Axel Wahlen']
+  spec.email         = ['axel.wahlen@mixxt.de']
+  spec.summary       = %q{ Maps data to another structure through a mapping }
+  spec.description   = %q{ Maps data to another structure through a mapping }
+  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{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 3.2.21'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.9.1'
+end

data/lib/data_maps/concerns/factory.rb

@@ -0,0 +1,31 @@
+module DataMaps
+  module Concerns
+    module Factory
+      # Factory to create an instance from a class in this module
+      #
+      # @param [String] name
+      # @param [mixed] option
+      # @return [Class]
+      def factory(name, option)
+        name = name.to_s.classify
+        klass_name = "#{self.name}::#{name}"
+        raise ArgumentError.new("No class '#{klass_name}' exists.") unless self.constants.include?(name.to_sym)
+
+        klass = klass_name.constantize
+        klass.new(option)
+      end
+
+      # Helper method to create class from a mapping_hash
+      #
+      # @param [Hash] mapping
+      # @return [Array] of factorized classes
+      def create_from_map(mapping)
+        raise ArgumentError.new("#{self.name} mapping has to be an hash") unless mapping.is_a?(Hash)
+
+        mapping.map do |name, option|
+          self.factory(name, option)
+        end
+      end
+    end
+  end
+end

data/lib/data_maps/condition.rb

@@ -0,0 +1,81 @@
+module DataMaps
+  # A condition
+  #
+  # @since 0.0.1
+  # @attr_reader [Array] whens
+  # @attr_reader [Array] thens
+  class Condition
+    attr_reader :whens, :thens
+
+    # Helper method to create conditions from a mapping
+    #
+    # @param [Array] mapping
+    #
+    # @return [Array] of Condition
+    def self.create_from_map(mapping)
+      raise ArgumentError.new('Conditions mapping has to be an array') unless mapping.is_a?(Array)
+
+      mapping.map do |condition|
+        self.new(
+          DataMaps::When.create_from_map(condition[:when]),
+          DataMaps::Then.create_from_map(condition[:then])
+        )
+      end
+    end
+
+    # Initializer for a Condition
+    #
+    # @param [Array] whens an array of when's
+    # @param [Array] thens an array of then's
+    def initialize(whens, thens)
+      raise ArgumentError.new('Whens must be an array of DataMaps::When') unless DataMaps::When::Base.valid_collection?(whens)
+      raise ArgumentError.new('Thens must be an array of DataMaps::Then') unless DataMaps::Then::Base.valid_collection?(thens)
+
+      @whens = whens
+      @thens = thens
+    end
+
+    # Helper method to indicate if this condition can break execution
+    #
+    # @return [Bool]
+    def can_break?
+      thens.any?{ |t| t.is_a?(DataMaps::Then::Filter) }
+    end
+
+    # Execute this condition with given data
+    #
+    # @param [mixed] data The given data
+    # @return [mixed] data The original or modified data for the next step
+    def execute(data)
+      if check(data)
+        if can_break?
+          DataMaps::FilteredValue.new(data)
+        else
+          result(data)
+        end
+      else
+        data
+      end
+    end
+
+    # Check all whens on data
+    #
+    # @param [mixed] data The given data
+    # @return [mixed] data The original or modified data for the next step
+    def check(data)
+      whens.all? { |w| w.execute data }
+    end
+
+    # Apply the thens on data
+    #
+    # @param [mixed] data The given data
+    # @return [mixed] data The original or modified data for the next step
+    def result(data)
+      thens.each do |t|
+        data = t.execute(data)
+      end
+
+      data
+    end
+  end
+end

data/lib/data_maps/converter/affixes.rb

@@ -0,0 +1,35 @@
+module DataMaps
+  module Converter
+    # Adds a prefix to the given data
+    #
+    # @since 0.0.1
+    class Prefix < Base
+      # The execute method to adds a prefix to the given data
+      #
+      # @param [mixed] data
+      def execute(data)
+        case data
+          when Array then data.map{ |v| "#{option}#{v}" }
+          when Hash then Hash[data.map{ |k,v| [k,"#{option}#{v}"] }]
+          else "#{option}#{data}"
+        end
+      end
+    end
+
+    # Adds a postfix to the given data
+    #
+    # @since 0.0.1
+    class Postfix < Base
+      # The execute method to adds a postfix to the given data
+      #
+      # @param [mixed] data
+      def execute(data)
+        case data
+          when Array then data.map{ |v| "#{v}#{option}" }
+          when Hash then Hash[data.map{ |k,v| [k,"#{v}#{option}"] }]
+          else "#{data}#{option}"
+        end
+      end
+    end
+  end
+end

data/lib/data_maps/converter/base.rb

@@ -0,0 +1,12 @@
+module DataMaps
+  module Converter
+    extend DataMaps::Concerns::Factory
+
+    # Base class for converter
+    #
+    # @since 0.0.1
+    # @abstract
+    class Base < DataMaps::Executable
+    end
+  end
+end

data/lib/data_maps/converter/bool.rb

@@ -0,0 +1,15 @@
+module DataMaps
+  module Converter
+    # Converts numeric values
+    #
+    # @since 0.0.1
+    class Bool < Base
+      # The execute method to convert the given data into string
+      #
+      # @param [mixed] data
+      def execute(data)
+        !!data
+      end
+    end
+  end
+end

data/lib/data_maps/converter/keys.rb

@@ -0,0 +1,23 @@
+module DataMaps
+  module Converter
+    # Converts numeric values
+    #
+    # @since 0.0.1
+    class Keys < Base
+      # The after initialize callback
+      def after_initialize
+        @option = option.with_indifferent_access
+      end
+
+      # The execute method to convert the keys of given data
+      #
+      # @param [mixed] data
+      def execute(data)
+        case data
+          when Hash then Hash[data.map{ |k,v| [option[k] || k, v] }]
+          else data
+        end
+      end
+    end
+  end
+end

data/lib/data_maps/converter/map.rb

@@ -0,0 +1,24 @@
+module DataMaps
+  module Converter
+    # Map values
+    #
+    # @since 0.0.1
+    class Map < Base
+      # The after initialize callback
+      def after_initialize
+        @option = option.with_indifferent_access
+      end
+
+      # The execute method to convert the given data
+      #
+      # @param [mixed] data
+      def execute(data)
+        case data
+          when Array then data.map{ |d| option[d] }
+          when Hash then Hash[data.map{ |k,v| [k, option[v]] }]
+          else option[data] || data
+        end
+      end
+    end
+  end
+end

data/lib/data_maps/converter/numeric.rb

@@ -0,0 +1,28 @@
+module DataMaps
+  module Converter
+    # Converts numeric values
+    #
+    # @since 0.0.1
+    class Numeric < Base
+      # The execute method to convert the given data
+      #
+      # @param [mixed] data
+      def execute(data)
+        raise DataMaps::Errors::InvalidDataError.new("The given data is not a numeric: #{data}") unless is_numeric?(data)
+
+        case option
+          when 'Integer' then data.to_i
+          when 'Float' then data.to_f
+          when Integer then data.to_f.round(option)
+          else data
+        end
+      end
+
+      private
+
+      def is_numeric?(data)
+        true if Float(data) rescue false
+      end
+    end
+  end
+end

data/lib/data_maps/converter/ruby.rb

@@ -0,0 +1,20 @@
+module DataMaps
+  module Converter
+    # Ruby method converter
+    #
+    # @since 0.0.1
+    class Ruby < Base
+      # After initialize callback
+      def after_initialize
+        @option = Array(option)
+      end
+
+      # The execute method to convert the given data
+      #
+      # @param [mixed] data
+      def execute(data)
+        data.respond_to?(option.first) ? data.send(*option) : data
+      end
+    end
+  end
+end