mappy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf1c7c828053b75ccd40b4727fc0ab95b85536a1
-  data.tar.gz: 1de27fffeb496e08ffd418d8e79843196f9c613e
+  metadata.gz: f61f54bcd4b19eae357e8b121765aae2437f0db6
+  data.tar.gz: 690d5a86cae5781ff21024436a42037093918776
 SHA512:
-  metadata.gz: d0ecee7474691679b643c5102089575adef6be95aaca636f8b7f42ca66b8248f77f6fe3a41360e48ead89ec3bf38c8c03f9166860dd7ed1ede77db506c27354c
-  data.tar.gz: ef4708b9d7922b4211b7322af5f7bf8e936b78f0a92c80025a69cc05ea07cfd203608bf81e7b7eec832290cb89a7d309d0d4d684d2e86e45a9db205866106829
+  metadata.gz: 6a366fa8161a24d3eec2da41bf226ad55bd83b47b1e32fc2295a18aef024121b110f4c38156711ee9ea4c5c0e42c8ff61b9652280e0c6c7e055b8aa7c071c9f2
+  data.tar.gz: dd9e93aa43fcc49d43d9be06c831783b912537bf63d0c3a1fc321028ef9f6f55c337c4f795f92a4641dbbc74f97654a72ccfcc2bf09b539955d9fc993d2e3f43

data/README.md

@@ -3,6 +3,21 @@
 Map one object to another. Apsiring to be a DSL for mapping one object's "data
 structure" onto another object's "data structure".
 
+## Why?
+
+Because I have discovered that I am regularly working with a heterogenious set of
+objects that need to be handled via some other service. And that service has its
+expected data structure. And there are quite a few services.
+
+That is to say, I'm attempting to submit a work to my Orcid Profile. I need some
+method for defining how to map my home grown "Article" object to the attributes
+that are needed for an Orcide work. And I don't want to infect my Article class
+with a #to_orcid_profile_attributes method.
+
+Or I want to create a DOI for my Article.
+
+In essence, Mappy provides a configurable seam in an application.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/mappy/configuration.rb

@@ -1,3 +1,6 @@
+require "mappy/resolver"
+require "mappy/target_builder_factory"
+
 module Mappy
 
   class Configuration
@@ -18,12 +21,15 @@ module Mappy
     def map(source_instance, options = {})
       source = source_instance.to_mappy_type
       target = options.fetch(:target)
+      target_builder_finder = options.fetch(:target_builder_finder) { Mappy::TargetBuilderFactory }
       legend = map_store.fetch(target).fetch(source)
 
+      target_builder = target_builder_finder.call(target)
+
       # @Todo: The returned value should not be an OpenStruct, but should
       # be an instance of the target (as per some Mappy resolver).
       Resolver.new(
-        target_builder: OpenStruct.method(:new),
+        target_builder: target_builder,
         legend: legend
       ).call(source_instance)
     end

data/lib/mappy/resolver.rb

@@ -14,7 +14,7 @@ module Mappy
         m[target_attribute] = extract_attribute_for(source, source_method)
         m
       end
-      target_builder.call(attributes)
+      target_builder.new(attributes)
     end
 
     protected

data/lib/mappy/target_builder_factory.rb

@@ -0,0 +1,37 @@
+require 'active_support/inflector'
+
+module Mappy
+  class InvalidTargetBuilder < RuntimeError
+  end
+
+  # Responsible for taking a symbol, finding the appropriate class then
+  # verifying that the class is "well formed."
+  class TargetBuilderFactory
+
+    def self.call(*args)
+      new.call(*args)
+    end
+
+    def call(target_symbol)
+      target_builder = extract_target_builder(target_symbol)
+      validate!(target_builder)
+      target_builder
+    end
+
+    private
+    def extract_target_builder(target_symbol)
+      target_symbol.to_s.classify.constantize
+    end
+
+    def validate!(target_builder)
+      target_instance = target_builder.allocate
+
+      begin
+        target_instance.send(:initialize, {})
+      rescue ArgumentError => e
+        raise InvalidTargetBuilder.new("Expected #{target_builder} to initialize with an attributes hash.\n#{e}")
+      end
+
+    end
+  end
+end

data/lib/mappy/version.rb

@@ -1,3 +1,3 @@
 module Mappy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mappy.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'activesupport'
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/lib/mappy/configuration_spec.rb

@@ -17,11 +17,17 @@ module Mappy
     context '#map' do
       let(:source_type) {:article}
       let(:article) { double('Article', title: 'Hello', to_mappy_type: source_type) }
+      let(:target_builder) { OpenStruct }
+      let(:target_type) { :document }
+      let(:target_builder_finder) { double("Finder") }
+
       before(:each) do
-        subject.legend(source: source_type, target: :document, legend: legend)
+        subject.legend(source: source_type, target: target_type, legend: legend)
       end
       it 'should yield a map storage' do
-        document = subject.map(article, target: :document)
+        target_builder_finder.should_receive(:call).with(target_type).and_return(target_builder)
+
+        document = subject.map(article, target: target_type, target_builder_finder: target_builder_finder)
         expect(document.title).to eq(article.title)
       end
     end

data/spec/lib/mappy/resolver_spec.rb

@@ -5,7 +5,7 @@ module Mappy
   describe Resolver do
     let(:source_publisher) { lambda {|source| source.publishers.join("; ")}}
     let(:source) { double('Source', title: 'A Title', publishers: ["John", "Ringo"]) }
-    let(:target_builder) { lambda {|attrs| OpenStruct.new(attrs) } }
+    let(:target_builder) { OpenStruct }
     let(:legend) {
       [
         [:title, :title],

data/spec/lib/mappy/target_builder_factory_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../../../lib/mappy/target_builder_factory', __FILE__)
+require File.expand_path('../../model_support', __FILE__)
+
+module Mappy
+  describe TargetBuilderFactory do
+    subject { described_class.new }
+
+    context '.call' do
+      it 'returns a builder lambda based on the input' do
+        expect(described_class.call('mappy/mock_valid_model')).to respond_to(:new)
+      end
+    end
+
+    context '#call' do
+      it 'returns a builder lambda based on the input' do
+        expect(subject.call('mappy/mock_valid_model')).to respond_to(:new)
+      end
+
+      it 'raises an exception when the builder does not have attributes' do
+        expect {
+          subject.call('mappy/mock_invalid_model')
+        }.to raise_error
+      end
+
+    end
+  end
+end

data/spec/lib/mappy_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../../../lib/mappy', __FILE__)
+require File.expand_path('../model_support', __FILE__)
 
 describe Mappy do
   context '.to_type' do
@@ -14,7 +15,7 @@ describe Mappy do
       Mappy.configure do |config|
         config.legend(
           source: :journal,
-          target: 'orcid/work',
+          target: 'mappy/mock_valid_model',
           legend: [
             [:title, :title],
             [lambda{|*|'long-journal'}, :work_type],
@@ -27,11 +28,8 @@ describe Mappy do
     end
 
     let(:title) { 'A Rocking Title' }
-    let(:journal) {
-      double('Journal', to_mappy_type: :journal, title: title)
-    }
-
-    subject { Mappy.map(journal, target: 'orcid/work') }
+    let(:journal) { double('Journal', to_mappy_type: :journal, title: title) }
+    subject { Mappy.map(journal, target: 'mappy/mock_valid_model') }
 
     its(:work_type) { should eq('long-journal')}
     its(:title) { should eq(title) }

data/spec/lib/model_support.rb

@@ -0,0 +1,14 @@
+module Mappy
+  class MockValidModel
+    attr_accessor :title, :work_type
+    def initialize(attributes)
+      attributes.each_pair do |key, value|
+        send("#{key}=", value) if respond_to?("#{key}=")
+      end
+    end
+  end
+
+  class MockInvalidModel
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mappy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,11 +96,14 @@ files:
 - lib/mappy.rb
 - lib/mappy/configuration.rb
 - lib/mappy/resolver.rb
+- lib/mappy/target_builder_factory.rb
 - lib/mappy/version.rb
 - mappy.gemspec
 - spec/lib/mappy/configuration_spec.rb
 - spec/lib/mappy/resolver_spec.rb
+- spec/lib/mappy/target_builder_factory_spec.rb
 - spec/lib/mappy_spec.rb
+- spec/lib/model_support.rb
 homepage: https://github.com/jeremyf/mappy
 licenses:
 - APACHE2
@@ -114,4 +131,6 @@ summary: Map one object to another
 test_files:
 - spec/lib/mappy/configuration_spec.rb
 - spec/lib/mappy/resolver_spec.rb
+- spec/lib/mappy/target_builder_factory_spec.rb
 - spec/lib/mappy_spec.rb
+- spec/lib/model_support.rb