mappy 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97a895fb24535f400ea8d29194014cc1839a70c4
-  data.tar.gz: 89f0e15d65ab2e4bf6185b050bdb50bccfa8af22
+  metadata.gz: 4bbb59217a36e78e7771bc6cfb785ee4e98927df
+  data.tar.gz: 95c90b75b8e56c6db422fc253fbc0f176813666c
 SHA512:
-  metadata.gz: 5853e1dd86267941c97ddbb948bb302f1a72c64c4d4b296465c1da318dd6796289eda87a563e8b811ffca8a5bd6fa05a49ae7f53370933052402bf78fef400f6
-  data.tar.gz: f4911345c74c394b58ff32359da4a378917fa0c01579a77a4d41059e489f68b2bd8c8c8876794e7aefeee370a1fe02be057e54f8fd10e3453c1a514725398c67
+  metadata.gz: f0c28bc091328590967f0e28d3828877822fd3ee53fe28ef6f986764337c7bad65d1a4d886c71ba272eb51e29260f8b81b109026eb0f6a1c3b2deafb507586c6
+  data.tar.gz: c240762fa3bee3d3caa09078c0ea6fab1f56612fbc995906fa0937a78bd7c0adb85244f1fa91f1afee560dffa5a378d470b6cd22d197df1127fef39c682c7025

data/README.md

@@ -3,21 +3,6 @@
 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:
@@ -31,3 +16,53 @@ And then execute:
 Or install it yourself as:
 
     $ gem install mappy
+
+## Usage
+
+You can certainly read the documentation. In particular the [Mappy module](lib/mappy.rb).
+But if you are like me, you won't trust the documentation.
+Instead I would recommend reading the specs, especially [mappy_spec](spec/mappy_spec.rb)
+
+### TL;DR
+
+```ruby
+  class Book
+    attr_accessor :name
+    def initialize(attributes = {})
+      attributes.each {|key, value| send("#{key}=", value) if respond_to?("#{key}=") }
+    end
+  end
+
+  class Orcid::Work
+    attr_accessor :title
+    def initialize(attributes = {})
+      attributes.each {|key, value| send("#{key}=", value) if respond_to?("#{key}=") }
+    end
+  end
+
+  Mappy.configure do |config|
+    config.register(source: 'book', target: 'orcid/work', legend: [:name, :title])
+  end
+
+  book = Book.new(title: 'Hello World')
+  orcid_work = Mappy.map(book, target: 'orcid/work')
+
+  assert_equal orcid_work.title, book.name
+```
+
+
+
+## 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.

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'lib/mappy.rb', '-', 'README.md', 'LICENSE']
+  t.options = ['--no-private']
+end

data/lib/mappy.rb

@@ -3,43 +3,66 @@ require "mappy/configuration"
 
 module Mappy
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    private :configuration
+
   end
 
   module_function
-
+  # Determines the object's Mappy type
+  #
+  # @param object [Object] the source object
+  # @return [String] the Mappy type which should be used in configuring Mappy
+  # @see Mappy.configure
   def to_type(object)
     return object.to_mappy_type if object.respond_to?(:to_mappy_type)
     object.class.to_s.underscore
   end
 
-  # Used for configuring available RemoteService and any additional
-  # initialization requirements for those RemoteServices (i.e. credentials)
+  # Registers a collection of maps.
   #
   # @example
+  #   Mappy.configure do |config|
+  #     config.register(source: 'book', target: 'orcid/work', legend: [:name, :title])
+  #   end
   #
   # @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
-    finalize! unless defined?(Rails)
+    yield(configuration)
   end
 
+  # Converts the source object to an instance of the options[:target].
+  #
+  # @example
+  #   Mappy.configure do |config|
+  #     config.register(source: 'book', target: 'orcid/work', legend: [:name, :title])
+  #   end
+  #   book = Book.new(title: 'Hello World')
+  #   orcid_work = Mappy.map(book, target: 'orcid/work')
+  #
+  #   assert_equal orcid_work.title, book.name
+  #
+  # @param source [Object] :source - the instance of a class that you are mapping from
+  # @param options [Hash]
+  # @options options [String] :target - the class name of the target that you are mapping to.
+  # @return [Object] an instance of the :target that has been instantiated by mapping the :source object
+  #
+  # @see Mappy.configure
   def map(source, options = {})
     configuration.map(source, options)
   end
 
+  # @deprecated
   def finalize!
-    if @configuration_block.respond_to?(:call)
-      self.configuration ||= Configuration.new
-      @configuration_block.call(configuration)
-    end
   end
 
+  # Because sometimes, when you are testing things, you might want a new
+  # configuration.
+  # :nodoc:
   def reset!
     self.configuration = Configuration.new
   end

data/lib/mappy/configuration.rb

@@ -7,16 +7,16 @@ module Mappy
   class Configuration
     attr_reader :map_store
     def initialize(config = {})
-      @map_store = config.fetch(:map_store) { Mappy::MapStore.new }
+      @map_store = config.fetch(:map_store) { MapStore.new }
     end
 
-    def legend(options = {})
+    def register(options = {})
       map_store.write(options)
     end
 
     def map(source_instance, options = {})
       target = options.fetch(:target)
-      target_builder_finder = options.fetch(:target_builder_finder) { Mappy::TargetBuilderFactory }
+      target_builder_finder = options.fetch(:target_builder_finder) { TargetBuilderFactory }
       target_builder = target_builder_finder.call(target)
 
       return source_instance if source_instance.is_a?(target_builder)
@@ -43,4 +43,5 @@ module Mappy
     end
   end
 
+  private_constant :Configuration
 end

data/lib/mappy/exceptions.rb

@@ -1,5 +1,8 @@
 module Mappy
 
+  class InvalidTargetBuilder < RuntimeError
+  end
+
   class MapNotFound < RuntimeError
     def initialize(map_store, keys)
       super("#{keys.inspect} not found in #{map_store.inspect}")

data/lib/mappy/map_store.rb

@@ -26,4 +26,6 @@ module Mappy
     end
 
   end
+
+  private_constant :MapStore
 end

data/lib/mappy/resolver.rb

@@ -35,4 +35,6 @@ module Mappy
       end
     end
   end
+
+  private_constant :Resolver
 end

data/lib/mappy/target_builder_factory.rb

@@ -1,8 +1,7 @@
 require 'active_support/inflector'
+require File.expand_path('../exceptions', __FILE__)
 
 module Mappy
-  class InvalidTargetBuilder < RuntimeError
-  end
 
   # Responsible for taking a symbol, finding the appropriate class then
   # verifying that the class is "well formed."
@@ -34,4 +33,6 @@ module Mappy
 
     end
   end
+
+  private_constant :TargetBuilderFactory
 end

data/lib/mappy/version.rb

@@ -1,3 +1,3 @@
 module Mappy
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/mappy.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'yard'
 end

data/spec/lib/mappy/configuration_spec.rb

@@ -2,14 +2,16 @@ require File.expand_path('../../../../lib/mappy/configuration', __FILE__)
 
 module Mappy
   describe Configuration do
-    let(:map_store) { Mappy::MapStore.new }
+    let(:map_store) { MapStore.new }
     let(:legend) { [[:title, :title]] }
 
     subject { described_class.new(map_store: map_store) }
 
-    context '#legend' do
+    context '#register' do
+      before(:each) do
+      end
       it 'should yield a map storage' do
-        subject.legend(source: :article, target: :document, legend: legend)
+        subject.register(source: :article, target: :document, legend: legend)
         expect(map_store.read(source: :article, target: :document)).to eq(legend)
       end
     end
@@ -22,7 +24,7 @@ module Mappy
       let(:target_builder_finder) { double("Finder") }
 
       before(:each) do
-        subject.legend(source: source_type, target: target_type, legend: legend)
+        subject.register(source: source_type, target: target_type, legend: legend)
       end
       it 'should yield a map storage' do
         target_builder_finder.should_receive(:call).with(target_type).and_return(target_builder)

data/spec/lib/mappy_spec.rb

@@ -19,7 +19,7 @@ describe Mappy do
   context '.map' do
     before(:each) do
       Mappy.configure do |config|
-        config.legend(
+        config.register(
           source: :journal,
           target: 'mappy/mock_valid_model',
           legend: [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mappy
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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
@@ -138,3 +152,4 @@ test_files:
 - spec/lib/mappy/target_builder_factory_spec.rb
 - spec/lib/mappy_spec.rb
 - spec/lib/model_support.rb
+has_rdoc: