spine-transform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4ab6da369c4fb24c26a099255860a7704bd1348
+  data.tar.gz: 79ba8def7647c80be07de5a2ff669a1484d162c8
+SHA512:
+  metadata.gz: ffcc2c6f9ab1730526b8e00990f3318216bc88c15c6bbb0b854c823d0fa26c3ab603987887b1d1a368f760a02f16164de0cff2db32de678885db146601960c52
+  data.tar.gz: b18cd1a765d423585dfb9ac179607b48fc5259dca827452b6b2f731b2b8a13837c51a78b5ff8230d2cbb4c7d5a0d492d00e0a472817da58ae84b3c2879448cce

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require config/default

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+0.1.0
+-----
+-   First public release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spine-transform.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    spine-transform (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.2)
+    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.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter (~> 0.4)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  spine-transform!

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the TOGGL LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,43 @@
+# Spine::Transform
+
+[![Gem Version](https://badge.fury.io/rb/spine-transform.svg)](http://badge.fury.io/rb/spine-transform)
+[![Dependency Status](https://gemnasium.com/rspine/transform.svg)](https://gemnasium.com/rspine/transform)
+[![Test Coverage](https://codeclimate.com/github/rspine/transform/badges/coverage.svg)](https://codeclimate.com/github/rspine/transform/coverage)
+[![Code Climate](https://codeclimate.com/github/rspine/transform/badges/gpa.svg)](https://codeclimate.com/github/rspine/transform)
+[![Codeship Status for rspine/transform](https://codeship.com/projects/3bca5340-e429-0132-2690-16773c71d38d/status?branch=master)](https://codeship.com/projects/81799)
+
+Transforms hash by defined commands. Here we focus on how to transform given
+object, `Spine::Mappings` focuses on result and how to retrieve values for it.
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-transform'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-transform`.
+
+## Usage
+
+```ruby
+transformations = Spine::Transform.define do
+  integer :id
+  copy :name
+  decimal :price
+  boolean :is_available
+  transform :available, flatten: true do
+    date :from, to: :available_from
+    date :until, to: :available_until
+  end
+end
+
+transformations.transform(
+  id: '1',
+  name: 'Product',
+  price: 1.0,
+  is_available: true,
+  available: { from: '2014-01-01', until: '2015-01-01' }
+)
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spine/transform/commands/copy.rb

@@ -0,0 +1,15 @@
+module Spine
+  module Transform
+    module Commands
+      class Copy
+        def initialize(key, options = {})
+          @key = options.fetch(:to, key)
+        end
+
+        def execute(destination, value)
+          destination[@key] = value
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/commands/intercept.rb

@@ -0,0 +1,18 @@
+module Spine
+  module Transform
+    module Commands
+      class Intercept
+        def initialize(key, action, options = {})
+          @key = options.fetch(:to, key)
+          @action = action
+        end
+
+        def execute(destination, value)
+          destination[@key] = @action.call(value)
+        #rescue
+        #  raise 'Uhuu'
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/commands/null.rb

@@ -0,0 +1,12 @@
+module Spine
+  module Transform
+    module Commands
+      module Null
+        extend self
+
+        def execute(destination, value)
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/commands/transform.rb

@@ -0,0 +1,21 @@
+module Spine
+  module Transform
+    module Commands
+      class Transform
+        def initialize(key, options = {}, &block)
+          @options = options
+          @key = options.fetch(:to, key)
+          @dsl = block
+        end
+
+        def execute(destination, value)
+          if @options[:flatten]
+            Transformer.new(@dsl).transform(value, destination)
+          else
+            destination[@key] = Transformer.new(@dsl).transform(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/definition.rb

@@ -0,0 +1,9 @@
+module Spine
+  module Transform
+    module Definition
+      def define(&block)
+        Transformer.new(block)
+      end
+    end
+  end
+end

data/lib/spine/transform/mapping.rb

@@ -0,0 +1,42 @@
+module Spine
+  module Transform
+    class Mapping
+      include Syntax::Copy
+      include Syntax::Transform
+      include Syntax::Integer
+      include Syntax::Decimal
+      include Syntax::Boolean
+      include Syntax::Date
+      include Syntax::Timestamp
+
+      attr_reader :commands
+
+      def initialize(dsl)
+        @dsl = dsl
+      end
+
+      def commands
+        @commands ||= {}
+      end
+
+      def for(key)
+        commands[key] || Commands::Null
+      end
+
+      def parse
+        instance_eval &@dsl
+      end
+
+      private
+
+      def register(key, command)
+        commands[key] = command
+        command
+      end
+
+      def intercept(key, options = {}, &block)
+        Commands::Intercept.new(key, block, options)
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/boolean.rb

@@ -0,0 +1,16 @@
+module Spine
+  module Transform
+    module Syntax
+      module Boolean
+        FALSES = [nil, 0, false, 'f', 'false', '0'].freeze
+
+        def boolean(key, options = {})
+          register(
+            key,
+            intercept(key, options) { |value| !FALSES.include?(value) }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/copy.rb

@@ -0,0 +1,11 @@
+module Spine
+  module Transform
+    module Syntax
+      module Copy
+        def copy(key, options = {})
+          register(key, Commands::Copy.new(key, options))
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/date.rb

@@ -0,0 +1,17 @@
+module Spine
+  module Transform
+    module Syntax
+      module Date
+        def date(key, options = {})
+          register(
+            key,
+            intercept(key, options) { |value|
+              return value if value.is_a?(Date)
+              DateTime.iso8601(value.to_s).to_date
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/decimal.rb

@@ -0,0 +1,17 @@
+module Spine
+  module Transform
+    module Syntax
+      module Decimal
+        def decimal(key, options = {})
+          register(
+            key,
+            intercept(key, options) { |value|
+              return value if value.is_a?(Float)
+              Float(value.to_s)
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/integer.rb

@@ -0,0 +1,17 @@
+module Spine
+  module Transform
+    module Syntax
+      module Integer
+        def integer(key, options = {})
+          register(
+            key,
+            intercept(key, options) { |value|
+              return value if value.is_a?(Integer)
+              Integer(value.to_s, 10)
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/timestamp.rb

@@ -0,0 +1,17 @@
+module Spine
+  module Transform
+    module Syntax
+      module Timestamp
+        def timestamp(key, options = {})
+          register(
+            key,
+            intercept(key, options) { |value|
+              return value if value.is_a?(DateTime)
+              DateTime.iso8601(value.to_s)
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/syntax/transform.rb

@@ -0,0 +1,11 @@
+module Spine
+  module Transform
+    module Syntax
+      module Transform
+        def transform(key, options = {}, &block)
+          register(key, Commands::Transform.new(key, options, &block))
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/transformer.rb

@@ -0,0 +1,21 @@
+module Spine
+  module Transform
+    class Transformer
+      extend Definition
+
+      attr_reader :mapping
+
+      def initialize(dsl)
+        @mapping = Mapping.new(dsl)
+        @mapping.parse
+      end
+
+      def transform(source, destination = {})
+        source.reduce(destination) do |result, (key, value)|
+          mapping.for(key).execute(result, value)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/spine/transform/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Transform
+    VERSION = '0.1.0'
+  end
+end

data/lib/spine/transform.rb

@@ -0,0 +1,26 @@
+module Spine
+  module Transform
+    autoload :Definition, 'spine/transform/definition'
+    autoload :Transformer, 'spine/transform/transformer'
+    autoload :Mapping, 'spine/transform/mapping'
+
+    module Syntax
+      autoload :Copy, 'spine/transform/syntax/copy'
+      autoload :Transform, 'spine/transform/syntax/transform'
+      autoload :Integer, 'spine/transform/syntax/integer'
+      autoload :Decimal, 'spine/transform/syntax/decimal'
+      autoload :Boolean, 'spine/transform/syntax/boolean'
+      autoload :Date, 'spine/transform/syntax/date'
+      autoload :Timestamp, 'spine/transform/syntax/timestamp'
+    end
+
+    module Commands
+      autoload :Null, 'spine/transform/commands/null'
+      autoload :Copy, 'spine/transform/commands/copy'
+      autoload :Transform, 'spine/transform/commands/transform'
+      autoload :Intercept, 'spine/transform/commands/intercept'
+    end
+
+    extend Definition
+  end
+end

data/spec/config/coverage.rb

@@ -0,0 +1,4 @@
+require './spec/config/default'
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start

data/spec/config/default.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end

data/spec/spine/transform/transformer_spec.rb

@@ -0,0 +1,173 @@
+require 'spine/transform'
+
+module Spine
+  module Transform
+    describe Transformer do
+      context 'when transforming flat hash' do
+        let(:target) {
+          { customer_name: 'Elmo', vat_code: 'EEE12345' }
+        }
+
+        it 'copies defined attributes to destination' do
+          subject = Transformer.define do
+            copy :customer_name
+          end
+
+          result = subject.transform(target)
+          expect(result[:customer_name]).to eq(target[:customer_name])
+        end
+
+        it 'copies defined attributes to target destination' do
+          subject = Transformer.define do
+            copy :customer_name, to: :name
+          end
+
+          result = subject.transform(target)
+          expect(result[:name]).to eq(target[:customer_name])
+        end
+
+        it 'rejects undefined attributes' do
+          subject = Transformer.define do
+            copy :customer_name
+          end
+
+          result = subject.transform(target)
+          expect(result[:customer_name]).to be
+          expect(result[:vat_code]).not_to be
+        end
+      end
+
+      context 'when transforming nested hash' do
+        let(:target) {
+          {
+            customer_name: 'Elmo',
+            vat_code: 'EEE12345',
+            postal_address: address
+          }
+        }
+        let(:address) {
+          { address: 'Seesame Street', country: 'United States' }
+        }
+
+        it 'flattens to destination' do
+          subject = Transformer.define do
+            transform :postal_address, flatten: true do
+              copy :country
+            end
+          end
+
+          result = subject.transform(target)
+          expect(result[:country]).to eq(target[:postal_address][:country])
+        end
+
+        it 'copies defined attributes to destination' do
+          subject = Transformer.define do
+            transform :postal_address do
+              copy :country
+            end
+          end
+
+          result = subject.transform(target)
+          expect(result[:postal_address][:country])
+            .to eq(target[:postal_address][:country])
+        end
+
+        it 'copies defined attributes to target destination' do
+          subject = Transformer.define do
+            transform :postal_address, to: :address do
+              copy :address, to: :street
+            end
+          end
+
+          result = subject.transform(target)
+          expect(result[:address][:street]).to eq(target[:postal_address][:address])
+        end
+
+        it 'rejects undefined attributes' do
+          subject = Transformer.define do
+            transform :postal_address do
+              copy :address
+            end
+          end
+
+          result = subject.transform(target)
+          expect(result[:postal_address][:address]).to be
+          expect(result[:postal_address][:country]).not_to be
+        end
+      end
+
+      context 'when parsing values when transforming' do
+        it 'transforms value to integer' do
+          subject = Transformer.define do
+            integer :identity
+          end
+
+          result = subject.transform(identity: '1')
+          expect(result[:identity]).to eql(1)
+        end
+
+        it 'transforms value to decimal' do
+          subject = Transformer.define do
+            decimal :price
+          end
+
+          result = subject.transform(price: '1.25')
+          expect(result[:price]).to eql(1.25)
+        end
+
+        it 'transforms value to boolean' do
+          subject = Transformer.define do
+            boolean :active
+          end
+
+          result = subject.transform(active: nil)
+          expect(result[:active]).to eql(false)
+        end
+
+        it 'transforms value to boolean from integer' do
+          subject = Transformer.define do
+            boolean :active
+          end
+
+          expect(subject.transform(active: 0)[:active]).to eql(false)
+          expect(subject.transform(active: 1)[:active]).to eql(true)
+        end
+
+        it 'transforms value to boolean from string' do
+          subject = Transformer.define do
+            boolean :active
+          end
+
+          expect(subject.transform(active: 'f')[:active]).to eql(false)
+          expect(subject.transform(active: 't')[:active]).to eql(true)
+
+          expect(subject.transform(active: 'false')[:active]).to eql(false)
+          expect(subject.transform(active: 'true')[:active]).to eql(true)
+
+          expect(subject.transform(active: '0')[:active]).to eql(false)
+          expect(subject.transform(active: '1')[:active]).to eql(true)
+        end
+
+        it 'transforms value to date' do
+          subject = Transformer.define do
+            date :starts_at
+          end
+
+          date = Date.new(2014, 1, 1)
+          result = subject.transform(starts_at: date.iso8601)
+          expect(result[:starts_at]).to eql(date)
+        end
+
+        it 'transforms value to timestamp' do
+          subject = Transformer.define do
+            timestamp :starts_at
+          end
+
+          date = DateTime.new(2014, 1, 1, 12, 0, 0)
+          result = subject.transform(starts_at: date.iso8601)
+          expect(result[:starts_at]).to eql(date)
+        end
+      end
+    end
+  end
+end

data/spine-transform.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/transform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-transform"
+  spec.version       = Spine::Transform::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/transform'
+  spec.license       = 'BSD-3-Clause'
+
+  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_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+  spec.add_development_dependency 'codeclimate-test-reporter', "~> 0.4"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: spine-transform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine/transform.rb
+- lib/spine/transform/commands/copy.rb
+- lib/spine/transform/commands/intercept.rb
+- lib/spine/transform/commands/null.rb
+- lib/spine/transform/commands/transform.rb
+- lib/spine/transform/definition.rb
+- lib/spine/transform/mapping.rb
+- lib/spine/transform/syntax/boolean.rb
+- lib/spine/transform/syntax/copy.rb
+- lib/spine/transform/syntax/date.rb
+- lib/spine/transform/syntax/decimal.rb
+- lib/spine/transform/syntax/integer.rb
+- lib/spine/transform/syntax/timestamp.rb
+- lib/spine/transform/syntax/transform.rb
+- lib/spine/transform/transformer.rb
+- lib/spine/transform/version.rb
+- spec/config/coverage.rb
+- spec/config/default.rb
+- spec/spine/transform/transformer_spec.rb
+- spine-transform.gemspec
+homepage: https://github.com/rspine/transform
+licenses:
+- BSD-3-Clause
+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.4.5
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/config/coverage.rb
+- spec/config/default.rb
+- spec/spine/transform/transformer_spec.rb