hashformer 0.2.0

data/lib/hashformer.rb

@@ -0,0 +1,87 @@
+# Hashformer: A declarative data transformation DSL for Ruby
+# Created June 2014 by Mike Bourgeous, DeseretBook.com
+# Copyright (C)2014 Deseret Book
+# See LICENSE and README.md for details.
+
+require 'classy_hash'
+
+require 'hashformer/version'
+require 'hashformer/generate'
+
+
+# This module contains the Hashformer methods for transforming Ruby Hash objects
+# from one form to another.
+#
+# See README.md for examples.
+module Hashformer
+  # Transforms +data+ according to the specification in +xform+.  The
+  # transformation specification in +xform+ is a Hash specifying an input key
+  # name (e.g. a String or Symbol) or transforming lambda for each output key
+  # name.  If +validate+ is true, then ClassyHash::validate will be used to
+  # validate the input and output data formats against the :@__in_schema and
+  # :@__out_schema keys within +xform+, if specified.
+  #
+  # Nested transformations can be specified by calling Hashformer::transform
+  # again inside of a lambda.
+  #
+  # If a value in +xform+ is a Proc, the Proc will be called with the input
+  # Hash, and the return value of the Proc used as the output value.
+  #
+  # If a key in +xform+ is a Proc, the Proc will be called with the exact
+  # original input value from +xform+ (before calling a lambda, if applicable)
+  # and the input Hash, and the return value of the Proc used as the name of
+  # the output key.
+  #
+  # Example (see the README for more examples):
+  #   Hashformer.transform({old_name: 'Name'}, {new_name: :old_name}) # Returns {new_name: 'Name'}
+  #   Hashformer.transform({orig: 5}, {opposite: lambda{|i| -i[:orig]}}) # Returns {opposite: -5}
+  def self.transform(data, xform, validate=true)
+    raise 'Must transform a Hash' unless data.is_a?(Hash)
+    raise 'Transformation must be a Hash' unless xform.is_a?(Hash)
+
+    validate(data, xform[:__in_schema], 'input') if validate
+
+    out = {}
+    xform.each do |key, value|
+      next if key == :__in_schema || key == :__out_schema
+
+      key = key.call(value, data) if key.respond_to?(:call)
+      out[key] = self.get_value(data, value)
+    end
+
+    validate(out, xform[:__out_schema], 'output') if validate
+
+    out
+  end
+
+  # Returns a value for the given +key+, method chain, or callable on the given
+  # +input_hash+.
+  def self.get_value(input_hash, key)
+    if Hashformer::Generate::Chain::Receiver === key
+      # Had to special case chains to allow chaining .call
+      key.__chain.call(input_hash)
+    elsif key.respond_to?(:call)
+      key.call(input_hash)
+    else
+      input_hash[key]
+    end
+
+    # TODO: add support for nested output hashes
+  end
+
+  private
+  # Validates the given data against the given schema, at the given step.
+  def self.validate(data, schema, step)
+    return unless schema.is_a?(Hash)
+
+    begin
+      ClassyHash.validate(data, schema)
+    rescue => e
+      raise "#{step} data failed validation: #{e}"
+    end
+  end
+end
+
+if !Kernel.const_defined?(:HF)
+  HF = Hashformer
+end

data/spec/lib/hashformer/generate_spec.rb

@@ -0,0 +1,231 @@
+# Hashformer transformation generator tests
+# Created July 2014 by Mike Bourgeous, DeseretBook.com
+# Copyright (C)2014 Deseret Book
+# See LICENSE and README.md for details.
+
+require 'spec_helper'
+
+require 'hashformer'
+
+RSpec.describe Hashformer::Generate do
+  describe '.map' do
+    let(:data) {
+      {
+        first: 'Hash',
+        last: 'Former'
+      }
+    }
+
+    context 'map was given no arguments' do
+      context 'map was not given a block' do
+        it 'returns an empty array' do
+          expect(Hashformer.transform(data, { out: HF::G.map() })).to eq({out: []})
+        end
+      end
+
+      context 'map was given a block' do
+        it 'passes no arguments to the block' do
+          expect(Hashformer.transform(data, { out: HF::G.map(){|*a| a.count} })).to eq({out: 0})
+        end
+      end
+    end
+
+    context 'map was not given a block' do
+      let(:xform) {
+        {
+          name: HF::G.map(:first, :last),
+          first: HF::G.map(:first),
+          last: HF::G.map(:last)
+        }
+      }
+
+      it 'stores mapped values into an array' do
+        expect(Hashformer.transform(data, xform)).to eq({name: ['Hash', 'Former'], first: ['Hash'], last: ['Former']})
+      end
+
+      it 'adds nil to a returned array for missing keys' do
+        expect(Hashformer.transform({}, xform)).to eq({name: [nil, nil], first: [nil], last: [nil]})
+      end
+    end
+
+    context 'map was given a block that returns a string' do
+      let(:xform) {
+        {
+          name: HF::G.map(:first, :last) { |f, l| "#{f} #{l}".strip }
+        }
+      }
+
+      it 'generates the expected string for missing keys' do
+        expect(Hashformer.transform({}, xform)).to eq({name: ''})
+      end
+
+      it 'generates the expected string' do
+        expect(Hashformer.transform(data, xform)).to eq({name: 'Hash Former'})
+      end
+    end
+
+    context 'map was given a block that returns a reversed array' do
+      let(:xform) {
+        {
+          name: HF::G.map(:first, :last) { |*a| a.reverse }
+        }
+      }
+
+      it 'passes nil for missing keys' do
+        expect(Hashformer.transform({}, xform)).to eq({name: [nil, nil]})
+      end
+
+      it 'generates the expected array' do
+        expect(Hashformer.transform(data, xform)).to eq({name: ['Former', 'Hash']})
+      end
+    end
+
+    context 'map was given callables as keys and no block' do
+      let(:xform) {
+        {
+          name: HF::G.map(->(h){h[:first]}, ->(h){h[:last]})
+        }
+      }
+
+      it 'generates the expected output array' do
+        expect(Hashformer.transform(data, xform)).to eq({name: ['Hash', 'Former']})
+      end
+    end
+
+    context 'map was given paths as keys' do
+      let(:xform) {
+        {
+          name: HF::G.map(HF::G.path[:first], HF::G.path[:last]) { |*a| a.join(' ').downcase }
+        }
+      }
+
+      it 'generates the expected output' do
+        expect(Hashformer.transform(data, xform)).to eq({name: 'hash former'})
+      end
+    end
+
+    context 'map was given method chains as keys and no block' do
+      let(:xform) {
+        {
+          name: HF::G.map(HF::G.chain[:first].downcase, HF::G.chain[:last].upcase)
+        }
+      }
+
+      it 'generates the expected output' do
+        expect(Hashformer.transform(data, xform)).to eq({name: ['hash', 'FORMER']})
+      end
+    end
+
+    it 'works when chained' do
+      xform = {
+        name: HF::G.map(HF::G.map(:first, :last), HF::G.map(:last, :first))
+      }
+
+      expect(Hashformer.transform(data, xform)).to eq({name: [['Hash', 'Former'], ['Former', 'Hash']]})
+    end
+
+    it 'joins an array using a method reference' do
+      data = { a: [1, 2, 3, 4] }
+      xform = { a: HF::G.map(:a, &:join) }
+      expect(Hashformer.transform(data, xform)).to eq({a: '1234'})
+    end
+  end
+
+  describe '.path' do
+    let(:data) {
+      {
+        a: { b: [ 'c', 'd', 'e', 'f' ] }
+      }
+    }
+
+    let(:xform) {
+      {
+        a: HF::G.path[:a][:b][0],
+        b: HF::G.path[:a][:b][3]
+      }
+    }
+
+    it 'produces the expected output for a simple input' do
+      expect(Hashformer.transform(data, xform)).to eq({a: 'c', b: 'f'})
+    end
+
+    it 'returns nil when dereferencing a nonexistent path' do
+      expect(Hashformer.transform(data, {a: HF::G.path[:b][:c][0][1][2][3]})).to eq({a: nil})
+    end
+
+    it 'raises an error when dereferencing a non-array/non-hash object' do
+      expect{Hashformer.transform(data, {a: HF::G.path[:a][:b][0][:fail]})}.to raise_error(/dereferencing/)
+    end
+
+    context 'no path is added' do
+      it 'returns the input hash' do
+        expect(Hashformer.transform({a: 1, b: 2}, {x: HF::G.path})).to eq({x: {a: 1, b: 2}})
+      end
+    end
+  end
+
+  describe '.chain' do
+    let(:data) {
+      {
+        in1: {
+          in1: ['a', 'b', 'c', 'd'],
+          in2: [1, 2, 3, [4, 5, 6, 7]]
+        }
+      }
+    }
+
+    let(:xform) {
+       xform = {
+         out1: HF::G.chain[:in1][:in2][3].reduce(&:+),
+         out2: HF[:in1][:in1][3],
+         out3: HF[].count
+       }
+    }
+
+    it 'produces the expected output for a simple input' do
+      expect(Hashformer.transform(data, xform)).to eq({out1: 22, out2: 'd', out3: 1})
+    end
+
+    context 'using normally reserved methods' do
+      it 'calls a proc with .call' do
+        calldata = {
+          p: ->(*a){a.reduce(1, &:*)}
+        }
+        expect(Hashformer.transform(calldata, {o: HF[:p].call()})).to eq({o: 1})
+        expect(Hashformer.transform(calldata, {o: HF[:p].call(5, 0)})).to eq({o: 0})
+        expect(Hashformer.transform(calldata, {o: HF[:p].call(5, 4, 5)})).to eq({o: 100})
+      end
+
+      it 'sends messages to the correct target with .send' do
+        senddata = {
+          a: 'Hashformer'
+        }
+        sendxf = {
+          b: HF[:a].clone.send(:reverse).send(:concat, ' transforms')
+        }
+        expect(Hashformer.transform(senddata, sendxf)).to eq({b: 'remrofhsaH transforms'})
+      end
+
+      it 'chains operators' do
+        opxf = {
+          a: !((HF[:a] + 3) == 8),
+        }
+        expect(Hashformer.transform({a: 5}, opxf)).to eq({a: false})
+        expect(Hashformer.transform({a: 6}, opxf)).to eq({a: true})
+      end
+
+      it 'chains instance_exec' do
+        class HFTestFoo
+          def initialize(val)
+            @y = val
+          end
+        end
+        execxf = {
+          x: -HF[:a].instance_exec{@y}
+        }
+        expect(Hashformer.transform({a: HFTestFoo.new(-1.5)}, execxf)).to eq({x: 1.5})
+        expect(Hashformer.transform({a: HFTestFoo.new(2014)}, execxf)).to eq({x: -2014})
+      end
+    end
+  end
+end