morfo 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 435026b5435920e085878e500852cef28210364a
-  data.tar.gz: 358f66a812811a70b7e7d6f9791d5462a578c4a7
+  metadata.gz: 7bb20ae90a7b011588d8e096694b69fab5664684
+  data.tar.gz: 00b3eb367ac96a797105118974ca2562a35d4163
 SHA512:
-  metadata.gz: 382af73b1c1953b0660c7c255b6f1276bc295448654df87e47f9dca16a2d98743d09544e172917c22ed1034877faffc947e07324da114c6b64960dcf080cc4dc
-  data.tar.gz: 7fce9a8d94b8b1e4d67d27157a9a01a5211b05203f7d072bc28eb0d3c052e52730f30d08d5a600807a86efe1756a6b5b3e8b54676677203b6c34418648976f3c
+  metadata.gz: c84f9323b71740ee3056033a25974a7daefedd3e29e92b40138bf5591e1b3a186349527d4cf13865c8a91bcbd260f01587857917dae74eca157351250de3f321
+  data.tar.gz: d052cce267ede1514bb6bb70c2db3eabbc3c4f01273d337c95b399986a683f0516ea2175fc43b0ad6fbf9003a1789fc62054ac498d6cc5747a886c564985db9e

data/README.md

@@ -2,9 +2,7 @@
 
 [![Build Status](https://travis-ci.org/leifg/morfo.png?branch=master)](https://travis-ci.org/leifg/morfo) [![Coverage Status](https://coveralls.io/repos/leifg/morfo/badge.png?branch=master)](https://coveralls.io/r/leifg/morfo) [![Code Climate](https://codeclimate.com/github/leifg/morfo.png)](https://codeclimate.com/github/leifg/morfo) [![Dependency Status](https://gemnasium.com/leifg/morfo.png)](https://gemnasium.com/leifg/morfo) [![Gem Version](https://badge.fury.io/rb/morfo.png)](http://badge.fury.io/rb/morfo)
 
-This Gem is inspired by the [active_importer](https://github.com/continuum/active_importer) Gem.
-
-But instead of importing spreadsheets into models, you can morf (typo intended) arrays of Hashes into other arrays of hashes.
+This gem acts like a universal converter from hashes into other hashes. You just define where your hash should get its data from and morfo will do the rest for you.
 
 ## Compatibility
 
@@ -28,10 +26,14 @@ Or install it yourself as:
 
 In order to morf the hashes you have to provide a class that extends `Morf::Base`
 
-Use the `map` method to specify what field you map to another field:
+Use the `field` method to specify what fields exist and where they will get their data from:
+
+### Simple Mapping
+
+The most basic form is, just define another field from the input hash. The value will just be copied.
 
     class Title < Morfo::Base
-      map :title, :tv_show_title
+      field :tv_show_title, from: :title
     end
 
 Afterwards use the `morf` method to morf all hashes in one array to the end result:
@@ -46,50 +48,12 @@ Afterwards use the `morf` method to morf all hashes in one array to the end resu
     #   {tv_show_title: 'Breaking Bad'},
     # ]
 
-It is also possible to map fields to multiple other fields
-
-    class MultiTitle < Morfo::Base
-      map :title, :tv_show_title
-      map :title, :show_title
-    end
-
-    MultiTitle.morf([
-              {title: 'The Walking Dead'} ,
-              {title: 'Breaking Bad'},
-            ])
-
-    # [
-    #   {tv_show_title: 'The Walking Dead', show_title: 'The Walking Dead'},
-    #   {tv_show_title: 'Breaking Bad', show_title: 'Breaking Bad'},
-    # ]
-
-## Transformations
-
-For each mapping you can define a block, that will be called on every input:
-
-    class AndZombies < Morfo::Base
-      map :title, :title do |title|
-        "#{title} and Zombies"
-      end
-    end
-
-    AndZombies.morf([
-          {title: 'Pride and Prejudice'},
-          {title: 'Fifty Shades of Grey'},
-        ])
-
-    # [
-    #     {title: 'Pride and Prejudice and Zombies'},
-    #     {title: 'Fifty Shades of Grey and Zombies'},
-    # ]
-
-## Nested Values
+If you want to have access to nested values, you'll have to provide an array as the key:
 
-You can directly access nested values in the hashes:
 
     class Name < Morfo::Base
-      map [:name, :first], :first_name
-      map [:name, :last], :last_name
+      field :first_name, from: [:name, :first]
+      field :last_name, from: [:name, :last]
     end
 
     Name.morf([
@@ -112,22 +76,39 @@ You can directly access nested values in the hashes:
     #     {first_name: 'Bruce',last_name: 'Wayne'},
     # ]
 
+## Transformations
 
-It is also possible to store values in a nested hash:
+Every field can also take a transformation block, so that the original input can be transformed.
 
-    class Wrapper < Morfo::Base
-      map :first_name, [:superhero, :name, :first]
-      map :last_name, [:superhero, :name, :last]
+    class AndZombies < Morfo::Base
+      field(:title, from: :title) {|title| "#{title} and Zombies"}
     end
 
-    Name.morf([
-      {first_name: 'Clark',last_name: 'Kent'},
-      {first_name: 'Bruce',last_name: 'Wayne'},,
-    ])
+    AndZombies.morf([
+          {title: 'Pride and Prejudice'},
+          {title: 'Fifty Shades of Grey'},
+        ])
+
+    # [
+    #     {title: 'Pride and Prejudice and Zombies'},
+    #     {title: 'Fifty Shades of Grey and Zombies'},
+    # ]
+
+As the second argument, the whole row is passed into the block. So you can even do transformation based on the whole row. Or you can leave out all the arguments and return a static value.
+
+    class NameConcatenator < Morfo::Base
+      field(:name) {|_, row| "#{row[:first_name]} #{row[:last_name]}"}
+      field(:status) { 'Best Friend' }
+    end
+
+    NameConcatenator.morf([
+          {first_name: 'Robin', last_name: 'Hood'},
+          {first_name: 'Sherlock', last_name: 'Holmes'},
+        ])
 
     # [
-    #   { superhero: {name: { first: 'Clark', last: 'Kent'}}},
-    #   { superhero: {name: { first: 'Bruce', last: 'Wayne'}}},
+    #   {:name=>"Robin Hood", :status=>"Best Friend"},
+    #   {:name=>"Sherlock Holmes", :status=>'Best Friend'}
     # ]
 
 

data/benchmarks/data.rb

@@ -0,0 +1,74 @@
+module BenchmarkData
+  extend self
+
+  def nested_wrapper
+    :person
+  end
+
+  def row
+    {
+      first_name: 'Jazmyn',
+      last_name: 'Willms',
+      gender: 'female',
+      phone_number: '485-675-9228',
+      cell_phone: '1-172-435-9402 x4907',
+      street_name: 'Becker Inlet',
+      street_number: '15a',
+      city: 'Carolynchester',
+      zip: '38189',
+      country: 'USA',
+    }
+  end
+
+  def row_string_keys
+    stringify_keys(row)
+  end
+
+  def row_nested
+    {
+      nested_wrapper => row
+    }
+  end
+
+  def row_nested_string_keys
+    {
+      nested_wrapper.to_s => row_string_keys
+    }
+  end
+
+  private
+  def stringify_keys hash
+    hash.keys.each do |key|
+      hash[key.to_s] = hash.delete(key)
+    end
+    hash
+  end
+
+  class SimpleMorferSymbol < Morfo::Base
+    BenchmarkData.row.keys.each do |field|
+      field(:"#{field}_mapped", from: field)
+    end
+  end
+
+  class SimpleMorferString < Morfo::Base
+    BenchmarkData.row_string_keys.keys.each do |field|
+      field("#{field}_mapped", from: field)
+    end
+  end
+
+  class NestedMorferSymbol < Morfo::Base
+    BenchmarkData.row_nested.each do |key, value|
+      value.keys.each do |field|
+        field(:"#{field}_mapped", from: [key, field])
+      end
+    end
+  end
+
+  class NestedMorferString < Morfo::Base
+    BenchmarkData.row_nested_string_keys.each do |key, value|
+      value.keys.each do |field|
+        field("#{field}_mapped", from: [key, field])
+      end
+    end
+  end
+end

data/benchmarks/run.rb

@@ -0,0 +1,46 @@
+require 'morfo'
+require 'benchmark'
+require './benchmarks/data'
+
+iterations = 100
+batch_size = 10000
+
+definitions = [
+  {
+    label: 'Simple (strings)',
+    row: BenchmarkData.row_string_keys,
+    morf_class: BenchmarkData::SimpleMorferString
+  },
+  {
+    label: 'Simple (symbols)',
+    row: BenchmarkData.row,
+    morf_class: BenchmarkData::SimpleMorferSymbol
+  },
+  {
+    label: 'Nested (strings)',
+    row: BenchmarkData.row_nested_string_keys,
+    morf_class: BenchmarkData::NestedMorferString
+  },
+  {
+    label: 'Nested (symbols)',
+    row: BenchmarkData.row_nested,
+    morf_class: BenchmarkData::NestedMorferSymbol
+  },
+]
+
+definitions.each do |defintition|
+  defintition.merge!(
+    data: Array.new(batch_size){ defintition[:row] }
+    )
+end
+
+Benchmark.bm(20) do |x|
+  definitions.each do |defintition|
+    x.report(defintition[:label]) do
+      iterations.times do
+        defintition[:morf_class].morf(defintition[:data])
+      end
+    end
+  end
+end
+

data/lib/morfo/actions.rb

@@ -0,0 +1,56 @@
+module Morfo
+  module Actions
+    module ValueMethods
+      def extract_value from, row
+        Array(from).inject(row) do |resulting_value, key|
+          resulting_value ? resulting_value[key] : nil
+        end
+      end
+
+      def store_value to, value
+        return {} if value.nil?
+
+        Array(to).reverse.inject({}) do |hash, key|
+          if hash.keys.first.nil?
+            hash.merge!(key => value)
+          else
+            { key => hash }
+          end
+        end
+      end
+    end
+
+    class MapAction
+      include ValueMethods
+      attr_reader :from
+      attr_reader :to
+
+      def initialize from, to
+        @from = from
+        @to = to
+      end
+
+      def execute row
+        store_value(to, extract_value(from, row))
+      end
+    end
+
+    class TransformationAction
+      include ValueMethods
+      attr_reader :to
+      attr_reader :from
+      attr_reader :transformation
+
+      def initialize from, to, transformation
+        @from = from
+        @to = to
+        @transformation = transformation
+      end
+
+      def execute row
+        resulting_value = from ? extract_value(from, row) : nil
+        store_value(to, transformation.call(resulting_value,row))
+      end
+    end
+  end
+end

data/lib/morfo/version.rb

@@ -1,3 +1,3 @@
 module Morfo
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/lib/morfo.rb

@@ -1,9 +1,18 @@
 require 'morfo/version'
+require 'morfo/actions'
 
 module Morfo
   class Base
-    def self.map from, to, &transformation
-      mapping_actions << MapAction.new(from, to, transformation)
+    def self.field field_name, definition={}, &blk
+      if blk
+        mapping_actions << Morfo::Actions::TransformationAction.new(definition[:from], field_name, blk)
+      else
+        raise(
+          ArgumentError,
+          "No field to get value from is specified for #{field_name.inspect}"
+        ) unless definition[:from]
+        mapping_actions << Morfo::Actions::MapAction.new(definition[:from], field_name)
+      end
     end
 
     def self.morf input
@@ -31,43 +40,4 @@ module Morfo
       hash
     end
   end
-
-  class MapAction
-    attr_reader :from
-    attr_reader :to
-    attr_reader :transformation
-
-    def initialize from, to, transformation
-      @from = from
-      @to = to
-      @transformation = transformation
-    end
-
-    def execute row
-      resulting_value = apply_transformation(extract_value(row))
-      resulting_value ? store_value(to, resulting_value) : {}
-    end
-
-    private
-    def extract_value row
-      Array(from).inject(row) do |resulting_value, key|
-        resulting_value ? resulting_value[key] : nil
-      end
-    end
-
-    def apply_transformation row
-      transformation ? transformation.call(row) : row
-    end
-
-    def store_value to, value
-      Array(to).reverse.inject({}) do |hash, key|
-        if hash.keys.first.nil?
-          hash.merge!(key => value)
-        else
-          { key => hash }
-        end
-      end
-      #{ to => value }
-    end
-  end
 end

data/spec/lib/morfo_spec.rb

@@ -31,12 +31,24 @@ describe Morfo::Base do
   end
 
   describe '#morf' do
+    context 'errors' do
+      subject(:no_from) do
+        class NilMorfer < Morfo::Base
+          field :my_field, {}
+        end
+        NilMorfer
+      end
+      it 'raises error for nil field' do
+        expect{no_from.morf([])}.to raise_error(ArgumentError)
+      end
+    end
+
     context '1 to 1 conversion' do
       subject do
-        class TitleMapper < Morfo::Base
-          map :title, :tv_show_title
+        class TitleMorfer < Morfo::Base
+          field :tv_show_title, from: :title
         end
-        TitleMapper
+        TitleMorfer
       end
 
       it 'maps title correctly' do
@@ -53,12 +65,10 @@ describe Morfo::Base do
 
     context '1 to 1 conversion with transformation' do
       subject do
-        class NumCastMapper < Morfo::Base
-          map :cast, :cast_num do |cast|
-            cast.size
-          end
+        class NumCastMorfer < Morfo::Base
+          field(:cast_num, from: :cast){|v,r| v.size}
         end
-        NumCastMapper
+        NumCastMorfer
       end
 
       it 'calls transformation correctly' do
@@ -69,11 +79,11 @@ describe Morfo::Base do
 
     context '1 to many conversion' do
       subject do
-        class MutliTitleMapper < Morfo::Base
-          map :title, :title
-          map :title, :also_title
+        class MutliTitleMorfer < Morfo::Base
+          field :title, from: :title
+          field :also_title, from: :title
         end
-        MutliTitleMapper
+        MutliTitleMorfer
       end
 
       it 'maps title to multiple fields' do
@@ -85,17 +95,24 @@ describe Morfo::Base do
     context 'nested conversion' do
       context 'nested source' do
         subject(:valid_path) do
-          class ImdbRatingMapper < Morfo::Base
-            map [:ratings, :imdb], :rating
+          class ImdbRatingMorfer < Morfo::Base
+            field :rating, from: [:ratings, :imdb]
+          end
+          ImdbRatingMorfer
+        end
+
+        subject(:valid_path_with_transformation) do
+          class ImdbRatingMorfer < Morfo::Base
+            field(:rating, from: [:ratings, :imdb]){|v| "Rating: #{v}"}
           end
-          ImdbRatingMapper
+          ImdbRatingMorfer
         end
 
         subject(:invalid_path) do
-          class InvalidImdbRatingMapper < Morfo::Base
-            map [:very, :long, :path, :that, :might, :not, :exist], :rating
+          class InvalidImdbRatingMorfer < Morfo::Base
+            field :rating, from: [:very, :long, :path, :that, :might, :not, :exist]
           end
-          InvalidImdbRatingMapper
+          InvalidImdbRatingMorfer
         end
 
         it 'maps nested attributes' do
@@ -103,6 +120,11 @@ describe Morfo::Base do
           expect(valid_path.morf(input)).to eq(expected_output)
         end
 
+        it 'maps nested attributes with transformation' do
+          expected_output = input.map{|v| {rating: "Rating: #{v[:ratings][:imdb]}"} }
+          expect(valid_path_with_transformation.morf(input)).to eq(expected_output)
+        end
+
         it 'doesn\'t raise error for invalid path' do
           expected_output = [{},{}]
           expect(invalid_path.morf(input)).to eq(expected_output)
@@ -111,11 +133,11 @@ describe Morfo::Base do
 
       context 'nested destination' do
         subject do
-          class WrapperMapper < Morfo::Base
-            map :title, [:tv_show, :title]
-            map :channel, [:tv_show, :channel]
+          class WrapperMorfer < Morfo::Base
+            field([:tv_show, :title], from: :title)
+            field([:tv_show, :channel], from: :channel){|v| "Channel: #{v}"}
           end
-          WrapperMapper
+          WrapperMorfer
         end
 
         it 'maps to nested destination' do
@@ -123,7 +145,7 @@ describe Morfo::Base do
             {
               tv_show: {
                 title: v[:title],
-                channel: v[:channel],
+                channel: "Channel: #{v[:channel]}",
               }
             }
           }
@@ -131,5 +153,37 @@ describe Morfo::Base do
         end
       end
     end
+
+    context 'calculations' do
+      subject do
+        class TitlePrefixMorfer < Morfo::Base
+          field(:title_with_channel){|v,r| "#{r[:title]}, (#{r[:channel]})"}
+        end
+        TitlePrefixMorfer
+      end
+
+      it 'maps calculation correctly' do
+        expected_output = input.map{|r|
+          {
+            title_with_channel: "#{r[:title]}, (#{r[:channel]})"
+          }
+        }
+        expect(subject.morf(input)).to eq(expected_output)
+      end
+    end
+
+    context 'static values' do
+      subject do
+        class StaticTitleMorfer < Morfo::Base
+          field(:new_title){ 'Static Title' }
+        end
+        StaticTitleMorfer
+      end
+
+      it 'maps static value correctly' do
+        expected_output = input.map{|r| {new_title: 'Static Title'} }
+        expect(subject.morf(input)).to eq(expected_output)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: morfo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Leif Gensert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,7 +73,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/data.rb
+- benchmarks/run.rb
 - lib/morfo.rb
+- lib/morfo/actions.rb
+- lib/morfo/actions/base.rb
 - lib/morfo/version.rb
 - morfo.gemspec
 - spec/lib/morfo_spec.rb