rom-mapper 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1305458b68360474e3be88eb5418ce057e7a5dc3
+  data.tar.gz: 69e816fabf9130eaf6daf3300f56b9efce63161f
+SHA512:
+  metadata.gz: 1184db0c8ce2fd3bea1d7bb7cdec72a8f1a7f298f0be35482a2357081c9841896aeea87e0a648f5deab1af1cad8a5160ac888ebc9840cadf960952421143e4f5
+  data.tar.gz: fa2c178cdcf7ce602c4390a633fd255c2a04f15b5fe3425d90445ca6a6fa30bcb5ed1ed320adedee55e581e7f0c30530cbe7deb8fd618ff426f1947c866bfa4b

data/.gitignore

@@ -2,6 +2,7 @@ log
 *.rbx
 *.rbc
 Gemfile.lock
+vendor/
 tmp/
 doc/
 coverage/
@@ -15,3 +16,4 @@ Vagrantfile
 
 # spiking area
 scratchpad.rb
+.ruby-version

data/.rspec

@@ -1,3 +1,3 @@
 --color
---profile
 --order random
+--warnings

data/.travis.yml

@@ -1,21 +1,27 @@
 language: ruby
-bundler_args: --without yard guard benchmarks
+sudo: false
+cache: bundler
+bundler_args: --without sql benchmarks console tools
 script: "bundle exec rake ci"
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
   - ruby-head
-  - rbx-19mode
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
     - rvm: ruby-head
+    - rvm: jruby-head
 notifications:
-  irc:
-    channels:
-      - "irc.freenode.org#rom-rb"
-    on_success: never
-    on_failure: change
-  email:
-    on_success: never
-    on_failure: change
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/{Changelog.md → CHANGELOG.md}

@@ -1,3 +1,9 @@
+# v0.2.0 2015-08-10
+
+Import code from rom 0.8.1
+
+[Compare v0.1.1..v0.2.0](https://github.com/rom-rb/rom-mapper/compare/v0.1.0...v0.2.0)
+
 # v0.1.1 2013-09-02
 
 * [internal] Moved version file to rom/mapper/version (solnic)

data/Gemfile

@@ -1,19 +1,32 @@
-# encoding: utf-8
-
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'rom-mapper', path: '.'
-
 group :test do
-  gem 'bogus', '~> 0.1'
-  gem 'axiom', '~> 0.1'
+  gem 'anima'
+  gem 'virtus'
+  gem 'inflecto', '~> 0.0', '>= 0.0.2'
+
+  platforms :rbx do
+    gem 'codeclimate-test-reporter', require: false
+  end
 end
 
-group :development do
-  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+group :benchmarks do
+  gem 'benchmark-ips', '~> 2.2.0'
 end
 
-# Added by devtools
-eval_gemfile 'Gemfile.devtools'
+group :tools do
+  gem 'rubocop', '~> 0.31'
+
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+
+  gem 'byebug'
+
+  platform :mri do
+    gem 'mutant', '>= 0.8.0', github: 'mbj/mutant', branch: 'master'
+    gem 'mutant-rspec'
+  end
+end

data/README.md

@@ -1,21 +1,26 @@
-# rom-mapper
-
-[![Gem Version](https://badge.fury.io/rb/rom-mapper.png)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom-mapper.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-mapper.png)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/rom-rb/rom-mapper.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/rom-rb/rom-mapper/badge.png?branch=master)][coveralls]
-
 [gem]: https://rubygems.org/gems/rom-mapper
 [travis]: https://travis-ci.org/rom-rb/rom-mapper
 [gemnasium]: https://gemnasium.com/rom-rb/rom-mapper
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom-mapper
-[coveralls]: https://coveralls.io/r/rom-rb/rom-mapper
+[inchpages]: http://inch-ci.org/github/rom-rb/rom-mapper
+
+# ROM::Mapper
+
+[![Gem Version](https://badge.fury.io/rb/rom-mapper.svg)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-mapper.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-mapper.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-mapper/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-mapper/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-mapper.svg?branch=master)][inchpages]
+
+ROM mapper component is a DSL for defining object mappers with pluggable mapping
+backends. It is the default mapper in ROM.
 
-Mappers for [Ruby Object Mapper](http://rom-rb.org).
+Resources:
 
-See ROM's [README](https://github.com/rom-rb/rom) for more information.
+- [Guides](http://rom-rb.org/guides/basics/mappers/)
+- [Importing Data with ROM and Transproc](http://solnic.eu/2015/07/15/importing-data-with-rom-and-transproc.html)
 
 ## License
 
-See LICENSE file.
+See `LICENSE` file.

data/Rakefile

@@ -1,7 +1,15 @@
-# encoding: utf-8
+require "rspec/core/rake_task"
+require "rake/testtask"
 
-require 'devtools'
+RSpec::Core::RakeTask.new(:spec)
+task default: [:ci]
 
-Devtools.init_rake_tasks
+desc 'Run specs in isolation'
+task :"spec:isolation" do
+  FileList["spec/**/*_spec.rb"].each do |spec|
+    sh "rspec", spec
+  end
+end
 
-require 'rspec/core/rake_task'
+desc "Run CI tasks"
+task ci: [:spec]

data/lib/rom-mapper.rb

@@ -1,17 +1,8 @@
-# encoding: utf-8
+require 'rom-support'
 
-require 'concord'
-require 'adamantium'
-require 'equalizer'
-require 'abstract_type'
-
-require 'rom/mapper/attribute'
-require 'rom/mapper/header'
-
-require 'rom/mapper/loader'
-require 'rom/mapper/loader/allocator'
-require 'rom/mapper/loader/attribute_writer'
-require 'rom/mapper/loader/object_builder'
-
-require 'rom/mapper/dumper'
 require 'rom/mapper'
+require 'rom/processor/transproc'
+
+module ROM
+  MapperMisconfiguredError = Class.new(StandardError)
+end

data/lib/rom/header.rb

@@ -0,0 +1,195 @@
+require 'equalizer'
+
+require 'rom/header/attribute'
+
+module ROM
+  # Header provides information about data mapping of a specific relation
+  #
+  # Processors use headers to build objects that process raw relations that go
+  # through mappers.
+  #
+  # @private
+  class Header
+    include Enumerable
+    include Equalizer.new(:attributes, :model)
+
+    # @return [Class] optional model associated with a header
+    #
+    # @api private
+    attr_reader :model
+
+    # @api private
+    attr_reader :reject_keys
+
+    # @api private
+    attr_reader :attributes
+
+    # @return [Hash] attribute key/name mapping for all primitive attributes
+    #
+    # @api private
+    attr_reader :mapping
+
+    # @return [Array] all attribute keys that are in a tuple
+    #
+    # @api private
+    attr_reader :tuple_keys
+
+    # @return [Array] all attribute names that are popping from a tuple
+    #
+    # @api private
+    attr_reader :pop_keys
+
+    # Coerce array with attribute definitions into a header object
+    #
+    # @param [Array<Array>] input attribute name/option pairs
+    #
+    # @param [Class] model optional
+    #
+    # @return [Header]
+    #
+    # @api private
+    def self.coerce(input, options = {})
+      if input.instance_of?(self)
+        input
+      else
+        attributes = input.each_with_object({}) { |pair, h|
+          h[pair.first] = Attribute.coerce(pair)
+        }
+
+        new(attributes, options)
+      end
+    end
+
+    # @api private
+    def initialize(attributes, options = {})
+      @options = options
+      @model = options[:model]
+      @reject_keys = options.fetch(:reject_keys, false)
+
+      @attributes = attributes
+      initialize_mapping
+      initialize_tuple_keys
+      initialize_pop_keys
+    end
+
+    # Iterate over attributes
+    #
+    # @yield [Attribute]
+    #
+    # @api private
+    def each
+      attributes.each_value { |attribute| yield(attribute) }
+    end
+
+    # Return if there are any aliased attributes
+    #
+    # @api private
+    def aliased?
+      any?(&:aliased?)
+    end
+
+    # Return attribute keys
+    #
+    # An attribute key corresponds to tuple attribute names
+    #
+    # @api private
+    def keys
+      attributes.keys
+    end
+
+    # Return attribute identified by its name
+    #
+    # @return [Attribute]
+    #
+    # @api private
+    def [](name)
+      attributes.fetch(name)
+    end
+
+    # Return all Combined attributes
+    #
+    # @return [Array<Combined>]
+    #
+    # @api private
+    def combined
+      by_type(Combined)
+    end
+
+    # Returns all attributes that require preprocessing
+    #
+    # @return [Array<Group,Fold>]
+    #
+    # @api private
+    def preprocessed
+      by_type(Group, Fold)
+    end
+
+    # Returns all attributes that require postprocessing
+    #
+    # @return [Array<Ungroup,Unfold>]
+    #
+    # @api private
+    def postprocessed
+      by_type(Ungroup, Unfold)
+    end
+
+    # Return all Wrap attributes
+    #
+    # @return [Array<Wrap>]
+    #
+    # @api private
+    def wraps
+      by_type(Wrap)
+    end
+
+    # Return all non-primitive attributes that don't require mapping
+    #
+    # @return [Array<Group,Fold,Ungroup,Unfold,Wrap,Unwrap>]
+    #
+    # @api private
+    def non_primitives
+      preprocessed + wraps
+    end
+
+    # Return all primitive attributes that require mapping
+    #
+    # @return [Array<Attribute>]
+    #
+    # @api private
+    def primitives
+      to_a - non_primitives
+    end
+
+    private
+
+    # Find all attribute matching specific attribute class (not kind)
+    #
+    # @return [Array<Attribute>]
+    #
+    # @api private
+    def by_type(*types)
+      select { |attribute| types.include?(attribute.class) }
+    end
+
+    # Set mapping hash from primitive attributes
+    #
+    # @api private
+    def initialize_mapping
+      @mapping = primitives.map(&:mapping).reduce(:merge) || {}
+    end
+
+    # Set all tuple keys from all attributes going deep into Wrap and Group too
+    #
+    # @api private
+    def initialize_tuple_keys
+      @tuple_keys = mapping.keys + non_primitives.flat_map(&:tuple_keys)
+    end
+
+    # Set all tuple keys from all attributes popping from Unwrap and Ungroup
+    #
+    # @api private
+    def initialize_pop_keys
+      @pop_keys = mapping.values + non_primitives.flat_map(&:tuple_keys)
+    end
+  end
+end

data/lib/rom/header/attribute.rb

@@ -0,0 +1,184 @@
+module ROM
+  class Header
+    # An attribute provides information about a specific attribute in a tuple
+    #
+    # This may include information about how an attribute should be renamed,
+    # or how its value should coerced.
+    #
+    # More complex attributes describe how an attribute should be transformed.
+    #
+    # @private
+    class Attribute
+      include Equalizer.new(:name, :key, :type)
+
+      # @return [Symbol] name of an attribute
+      #
+      # @api private
+      attr_reader :name
+
+      # @return [Symbol] key of an attribute that corresponds to tuple attribute
+      #
+      # @api private
+      attr_reader :key
+
+      # @return [Symbol] type identifier (defaults to :object)
+      #
+      # @api private
+      attr_reader :type
+
+      # @return [Hash] additional meta information
+      #
+      # @api private
+      attr_reader :meta
+
+      # Return attribute class for a given meta hash
+      #
+      # @param [Hash] meta hash with type information and optional transformation info
+      #
+      # @return [Class]
+      #
+      # @api private
+      def self.[](meta)
+        key = (meta.keys & TYPE_MAP.keys).first
+        TYPE_MAP.fetch(key || meta[:type], self)
+      end
+
+      # Coerce an array with attribute meta-data into an attribute object
+      #
+      # @param [Array<Symbol,Hash>] input attribute name/options pair
+      #
+      # @return [Attribute]
+      #
+      # @api private
+      def self.coerce(input)
+        name = input[0]
+        meta = (input[1] || {}).dup
+
+        meta[:type] ||= :object
+
+        if meta.key?(:header)
+          meta[:header] = Header.coerce(meta[:header], model: meta[:model])
+        end
+
+        self[meta].new(name, meta)
+      end
+
+      # @api private
+      def initialize(name, meta)
+        @name = name
+        @meta = meta
+        @key = meta.fetch(:from) { name }
+        @type = meta.fetch(:type)
+      end
+
+      # Return if an attribute has a specific type identifier
+      #
+      # @api private
+      def typed?
+        type != :object
+      end
+
+      # Return if an attribute should be aliased
+      #
+      # @api private
+      def aliased?
+        key != name
+      end
+
+      # Return :key-to-:name mapping hash
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def mapping
+        { key => name }
+      end
+    end
+
+    # Embedded attribute is a special attribute type that has a header
+    #
+    # This is the base of complex attributes like Hash or Group
+    #
+    # @private
+    class Embedded < Attribute
+      include Equalizer.new(:name, :key, :type, :header)
+
+      # return [Header] header of an attribute
+      #
+      # @api private
+      attr_reader :header
+
+      # @api private
+      def initialize(*)
+        super
+        @header = meta.fetch(:header)
+      end
+
+      # Return tuple keys from the header
+      #
+      # @return [Array<Symbol>]
+      #
+      # @api private
+      def tuple_keys
+        header.tuple_keys
+      end
+
+      def pop_keys
+        header.pop_keys
+      end
+    end
+
+    # Array is an embedded attribute type
+    Array = Class.new(Embedded)
+
+    # Hash is an embedded attribute type
+    Hash = Class.new(Embedded)
+
+    # Combined is an embedded attribute type describing combination of multiple
+    # relations
+    Combined = Class.new(Embedded)
+
+    # Wrap is a special type of Hash attribute that requires wrapping
+    # transformation
+    Wrap = Class.new(Hash)
+
+    # Unwrap is a special type of Hash attribute that requires unwrapping
+    # transformation
+    Unwrap = Class.new(Hash)
+
+    # Group is a special type of Array attribute that requires grouping
+    # transformation
+    Group = Class.new(Array)
+
+    # Ungroup is a special type of Array attribute that requires ungrouping
+    # transformation
+    Ungroup = Class.new(Array)
+
+    # Fold is a special type of Array attribute that requires folding
+    # transformation
+    Fold = Class.new(Array)
+
+    # Unfold is a special type of Array attribute that requires unfolding
+    # transformation
+    Unfold = Class.new(Array)
+
+    # Exclude is a special type of Attribute to be removed
+    Exclude = Class.new(Attribute)
+
+    # TYPE_MAP is a (hash) map of ROM::Header identifiers to ROM::Header types
+    #
+    # @private
+    TYPE_MAP = {
+      combine: Combined,
+      wrap: Wrap,
+      unwrap: Unwrap,
+      group: Group,
+      ungroup: Ungroup,
+      fold: Fold,
+      unfold: Unfold,
+      hash: Hash,
+      array: Array,
+      exclude: Exclude
+    }
+  end
+end