mappy 0.0.1.pre → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54cfbec2034481cd6b49b1a4bdca79ff9fb0065f
-  data.tar.gz: 4ad743913b0c4a7ef45d19981c2ce1e22c2962d8
+  metadata.gz: cf1c7c828053b75ccd40b4727fc0ab95b85536a1
+  data.tar.gz: 1de27fffeb496e08ffd418d8e79843196f9c613e
 SHA512:
-  metadata.gz: 3697cebf5719f58a9737253ce05415fdba70900f981ae4f94825f2066652a99e1a446d4bbcd3d04044415b77c414c4ea94b7ad872770f2489eb23cecc4a043ea
-  data.tar.gz: fd050299a0116b33f61b21687162dfd9d3a294f695e6fc4678f98035b962b553394d0422fc9b6e226bad3325328d1724aadaf812397135fbe8c233d9fff1c107
+  metadata.gz: d0ecee7474691679b643c5102089575adef6be95aaca636f8b7f42ca66b8248f77f6fe3a41360e48ead89ec3bf38c8c03f9166860dd7ed1ede77db506c27354c
+  data.tar.gz: ef4708b9d7922b4211b7322af5f7bf8e936b78f0a92c80025a69cc05ea07cfd203608bf81e7b7eec832290cb89a7d309d0d4d684d2e86e45a9db205866106829

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "2.0.0"
+
+script: "rspec"
+
+before_install:
+  - gem install bundler

data/README.md

@@ -1,6 +1,7 @@
-# Mappy
+# Mappy [![Build Status](https://travis-ci.org/jeremyf/mappy.png?branch=master)](https://travis-ci.org/jeremyf/mappy)
 
-Map one object to another
+Map one object to another. Apsiring to be a DSL for mapping one object's "data
+structure" onto another object's "data structure".
 
 ## Installation
 

data/lib/mappy.rb

@@ -1,5 +1,46 @@
 require "mappy/version"
+require "mappy/configuration"
 
 module Mappy
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+  end
+
+  module_function
+
+  def to_type(object)
+    return object.to_mappy_type if object.respond_to?(:to_mappy_type)
+  end
+
+  # Used for configuring available RemoteService and any additional
+  # initialization requirements for those RemoteServices (i.e. credentials)
+  #
+  # @example
+  #
+  # @yieldparam config [Configuration]
+  # @see Mappy::Railtie
+  def configure(&block)
+    @configuration_block = block
+
+    # The Rails load sequence means that some of the configured Targets may
+    # not be loaded; As such I am not calling configure! instead relying on
+    # Mappy::Railtie to handle the configure! call
+    configure! unless defined?(Rails)
+  end
+
+  def map(source, options = {})
+    configuration.map(source, options)
+  end
+
+  def configure!
+    if @configuration_block.respond_to?(:call)
+      self.configuration ||= Configuration.new
+      @configuration_block.call(configuration)
+    end
+  end
+
+  def reset!
+    self.configuration = Configuration.new
+  end
+
 end

data/lib/mappy/configuration.rb

@@ -0,0 +1,32 @@
+module Mappy
+
+  class Configuration
+    attr_reader :map_store
+    def initialize(config = {})
+      @map_store = config.fetch(:map_store) { {} }
+    end
+
+    def legend(options = {})
+      source = options.fetch(:source)
+      target = options.fetch(:target)
+      legend = options.fetch(:legend)
+
+      map_store[target] ||= {}
+      map_store[target][source] = legend
+    end
+
+    def map(source_instance, options = {})
+      source = source_instance.to_mappy_type
+      target = options.fetch(:target)
+      legend = map_store.fetch(target).fetch(source)
+
+      # @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),
+        legend: legend
+      ).call(source_instance)
+    end
+  end
+
+end

data/lib/mappy/resolver.rb

@@ -0,0 +1,30 @@
+module Mappy
+  # Responsible for mapping, via a legend, a source object to an instance of the
+  # target.
+  class Resolver
+    attr_reader :target_builder, :legend
+    def initialize(options = {})
+      @target_builder = options.fetch(:target_builder)
+      @legend = options.fetch(:legend)
+    end
+
+    def call(source)
+      attributes = {}
+      legend.each_with_object(attributes) do |(source_method, target_attribute), m|
+        m[target_attribute] = extract_attribute_for(source, source_method)
+        m
+      end
+      target_builder.call(attributes)
+    end
+
+    protected
+
+    def extract_attribute_for(source, method_name_or_proc)
+      if method_name_or_proc.respond_to?(:call)
+        method_name_or_proc.call(source)
+      elsif method_name_or_proc.is_a?(::Symbol) || method_name_or_proc.is_a?(::String)
+        source.send(method_name_or_proc)
+      end
+    end
+  end
+end

data/lib/mappy/version.rb

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

data/mappy.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
 end

data/spec/lib/mappy/configuration_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../../../../lib/mappy/configuration', __FILE__)
+
+module Mappy
+  describe Configuration do
+    let(:map_store) { {} }
+    let(:legend) { [[:title, :title]] }
+
+    subject { described_class.new(map_store: map_store) }
+
+    context '#legend' do
+      it 'should yield a map storage' do
+        subject.legend(source: :article, target: :document, legend: legend)
+        expect(map_store.fetch(:document).fetch(:article)).to eq(legend)
+      end
+    end
+
+    context '#map' do
+      let(:source_type) {:article}
+      let(:article) { double('Article', title: 'Hello', to_mappy_type: source_type) }
+      before(:each) do
+        subject.legend(source: source_type, target: :document, legend: legend)
+      end
+      it 'should yield a map storage' do
+        document = subject.map(article, target: :document)
+        expect(document.title).to eq(article.title)
+      end
+    end
+  end
+end

data/spec/lib/mappy/resolver_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../../../lib/mappy/resolver', __FILE__)
+require 'ostruct'
+
+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(:legend) {
+      [
+        [:title, :title],
+        [source_publisher, :publisher]
+      ]
+    }
+
+    context '#call' do
+      let(:resolved_publisher) { source_publisher.call(source) }
+      subject { described_class.new(target_builder: target_builder, legend: legend).call(source) }
+
+      its(:publisher) { should eq resolved_publisher }
+      its(:title) { should eq source.title }
+    end
+  end
+end

data/spec/lib/mappy_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../../../lib/mappy', __FILE__)
+
+describe Mappy do
+  context '.to_type' do
+    let(:mappy_type) { 'hello-world' }
+    let(:object) { double(to_mappy_type: mappy_type)}
+    it 'with explicit to mappy type' do
+      expect(Mappy.to_type(object)).to eq(mappy_type)
+    end
+  end
+
+  context '.map' do
+    before(:each) do
+      Mappy.configure do |config|
+        config.legend(
+          source: :journal,
+          target: 'orcid/work',
+          legend: [
+            [:title, :title],
+            [lambda{|*|'long-journal'}, :work_type],
+          ]
+        )
+      end
+    end
+    after(:each) do
+      Mappy.reset!
+    end
+
+    let(:title) { 'A Rocking Title' }
+    let(:journal) {
+      double('Journal', to_mappy_type: :journal, title: title)
+    }
+
+    subject { Mappy.map(journal, target: 'orcid/work') }
+
+    its(:work_type) { should eq('long-journal')}
+    its(:title) { should eq(title) }
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mappy
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Map one object to another
 email:
 - jeremy.n.friesen@gmail.com
@@ -46,13 +74,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/mappy.rb
+- lib/mappy/configuration.rb
+- lib/mappy/resolver.rb
 - lib/mappy/version.rb
 - mappy.gemspec
+- spec/lib/mappy/configuration_spec.rb
+- spec/lib/mappy/resolver_spec.rb
+- spec/lib/mappy_spec.rb
 homepage: https://github.com/jeremyf/mappy
 licenses:
 - APACHE2
@@ -68,13 +102,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Map one object to another
-test_files: []
+test_files:
+- spec/lib/mappy/configuration_spec.rb
+- spec/lib/mappy/resolver_spec.rb
+- spec/lib/mappy_spec.rb