rom 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c8c7b27e645de962baf5ff8f13ec9d7bc49f99b
-  data.tar.gz: 122627edb665db07dd980bab718b6d5478f74938
+  metadata.gz: 9513b27090115add08f6f4f4d8e446b7e805d0d8
+  data.tar.gz: 4a33b39b54ee48c1d551138688e864a3b6052970
 SHA512:
-  metadata.gz: d2f9fa00b8f6d7d577a3cc30b415bba53f02b3820a29795f940bcd81025ef858524518580d603956fbf753b7de3c66b7b541e3b0f786383eff0e9f06eec29fb5
-  data.tar.gz: d73cecf26ac256e6112e8a736f53a9e1621ec4faf7272214da4b229251d83b1636902b1d9ea92085bf971b449791e04e3c1c654270bd7b1d1495c4fb764d7987
+  metadata.gz: 17c5de3ec96c11fcf6d95fd06c89ef1f76af66f6468bdbb139a421f5a7125ae1aae228021303b778e8150abf4a3650753ec164eb4aa393997e3a44cd42bbfcaf
+  data.tar.gz: 5ded7613f606353f66371b9bc537c6a24c30f72e58d8a741f24133e976fa2d898609ca56bd4bf41a993827b3bda3f937b69dbc1f9c7ce9b432439ddfad0a1786

data/.rspec

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

data/.rubocop.yml

@@ -10,6 +10,15 @@ AllCops:
 Lint/AssignmentInCondition:
   Enabled: false
 
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  FunctionalMethods:
+    - let
+    - let!
+    - subject
+    - watch
+    - before
+
 # No need to handle LoadError in Rakefile
 Lint/HandleExceptions:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## v0.7.0 2015-05-17
+
+### Added
+
+* `combine` interface in Relation and Mapper which allows simple and explicit
+  eager-loading that works with all adapters (solnic)
+* `reject_keys` option in mapper which will filter out unspecified keys from
+  input tuples (solnic)
+* `unwrap` mapping operation (aflatter)
+* Arbitrary objects can be registered as mappers via `register` in mapping DSL (solnic)
+* Ability to reuse existing mappers in `group`, `wrap` and `embedded` mappings (solnic)
+* Plugin interface for Relation, Mapper and Command (cflipse)
+* `Memory::Dataset` accepts options hash now which makes it more flexible for
+  any adapter that wants to subclass it (solnic)
+* `ROM::Memory::Relation#take` (solnic)
+
+### Changed
+
+* [BREAKING] `Command#call` applies curried args first (solnic)
+* `Commands::Update#set` was deprecated in favor of `call` (solnic)
+* `group` mapping reject empty tuples (solnic)
+
+### Fixed
+
+* `Command` respond to missing properly now (solnic)
+* `Mapper::DSL` respond to missing properly now (solnic)
+
+### Internal
+
+* Fixed all the warnings \o/ (splattael)
+* Introduced `Deprecations` helper module (solnic)
+
+[Compare v0.6.2...v0.7.0](https://github.com/rom-rb/rom/compare/v0.6.2...v0.7.0)
+
 ## v0.6.2 2015-04-14
 
 ### Changed

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+For information about contributing please refer to [Contribute](http://rom-rb.org/contribute) section on ROM website.

data/Gemfile

@@ -30,7 +30,7 @@ end
 
 group :benchmarks do
   gem 'activerecord', '4.2.0'
-  gem 'benchmark-ips', git: 'https://github.com/evanphx/benchmark-ips.git', branch: 'master'
+  gem 'benchmark-ips', '~> 2.2.0'
 end
 
 group :tools do

data/README.md

@@ -5,11 +5,11 @@
 [coveralls]: https://coveralls.io/r/rom-rb/rom
 [inchpages]: http://inch-ci.org/github/rom-rb/rom/
 
-# Ruby Object Mapper
+# Ruby Object Mapper [![Gitter chat](https://badges.gitter.im/rom-rb/chat.svg)](https://gitter.im/rom-rb/chat) [![Stories in Ready](https://badge.waffle.io/rom-rb/rom.png?label=ready&title=Ready)](https://waffle.io/rom-rb/rom)
 
 [![Gem Version](https://badge.fury.io/rb/rom.svg)][gem]
 [![Build Status](https://travis-ci.org/rom-rb/rom.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom.png)][gemnasium]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom.svg)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/rom-rb/rom/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/rom-rb/rom/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom.svg?branch=master&style=flat)][inchpages]
@@ -30,12 +30,19 @@ Learn more:
   * [rom-mongo](https://github.com/rom-rb/rom-mongo)
   * [rom-yaml](https://github.com/rom-rb/rom-yaml)
   * [rom-csv](https://github.com/rom-rb/rom-csv)
+  * [rom-neo4j](https://github.com/rom-rb/rom-neo4j)
+  * [rom-event_store](https://github.com/rom-rb/rom-event_store)
+  * [rom-influxdb](https://github.com/rom-rb/rom-influxdb)
+  * [rom-rethinkdb](https://github.com/rom-rb/rom-rethinkdb)
 
 See [issues](https://github.com/rom-rb/rom/issues?q=is%3Aopen+is%3Aissue+label%3Aadapter+label%3Afeature)
 for a list of adapters that are planned to be added soon.
 
-ROM can be used with Rails next to ActiveRecord via [rom-rails](https://github.com/rom-rb/rom-rails) railtie.
-Integration with other frameworks is planned.
+## Framework integrations
+
+* [rom-lotus](https://github.com/rom-rb/rom-lotus)
+* [rom-rails](https://github.com/rom-rb/rom-rails)
+* [rom-roda](https://github.com/rom-rb/rom-roda)
 
 ## Synopsis
 
@@ -97,13 +104,11 @@ puts rom.relation(:users) { |r| r.by_name("Jane").adults }.as(:entity).to_a.insp
 
 ## ROADMAP
 
-ROM is on its way towards 1.0.0. Please refer to [issues](https://github.com/rom-rb/rom/issues)
-for details.
+ROM is on its way towards 1.0.0. You can see an overview of tasks scheduled for 1.0.0 on our [waffle board](https://waffle.io/rom-rb/rom?label=1.0.0). Please notice that most of the 1.0.0 features/changes will become part of minor (0.x) upgrades before 1.0.0 final gets released.
 
 ## Community
 
 * [Official Blog](http://rom-rb.org/blog/)
-* [![Gitter chat](https://badges.gitter.im/rom-rb/chat.png)](https://gitter.im/rom-rb/chat)
 * [Ruby Object Mapper](https://groups.google.com/forum/#!forum/rom-rb) mailing list
 
 ## Credits

data/lib/rom.rb

@@ -11,6 +11,7 @@ require 'rom/support/class_macros'
 require 'rom/support/class_builder'
 
 # core parts
+require 'rom/plugin'
 require 'rom/relation'
 require 'rom/mapper'
 require 'rom/command'
@@ -33,3 +34,10 @@ module ROM
 
   RelationRegistry = Class.new(Registry)
 end
+
+# register core plugins
+require 'rom/plugins/relation/registry_reader'
+
+ROM.plugins do
+  register :registry_reader, ROM::Plugins::Relation::RegistryReader, type: :relation
+end

data/lib/rom/command.rb

@@ -70,6 +70,25 @@ module ROM
       new(relation, self.options.merge(options))
     end
 
+    # Use a configured plugin in this relation
+    #
+    # @example
+    #   class CreateUser < ROM::Commands::Create[:memory]
+    #     use :pagintion
+    #
+    #     per_page 30
+    #   end
+    #
+    # @param [Symbol] plugin
+    # @param [Hash] options
+    # @option options [Symbol] :adapter (:default) first adapter to check for plugin
+    #
+    # @api public
+    def self.use(plugin, options = {})
+      adapter = options.fetch(:adapter, :default)
+      ROM.plugin_registry.commands.fetch(plugin, adapter).apply_to(self)
+    end
+
     # Build command registry hash for provided relations
     #
     # @param [RelationRegistry] relations registry

data/lib/rom/commands/abstract.rb

@@ -49,7 +49,7 @@ module ROM
       #
       # @api public
       def call(*args)
-        tuples = execute(*(args + curry_args))
+        tuples = execute(*(curry_args + args))
 
         if result == :one
           tuples.first
@@ -133,6 +133,11 @@ module ROM
         target.count
       end
 
+      # @api private
+      def respond_to_missing?(name, _include_private = false)
+        relation.respond_to?(name) || super
+      end
+
       private
 
       # @api private

data/lib/rom/commands/composite.rb

@@ -3,24 +3,7 @@ module ROM
     # Composite command that consists of left and right commands
     #
     # @api public
-    class Composite
-      include Equalizer.new(:left, :right)
-
-      # @return [Proc,Command] left command
-      #
-      # @api private
-      attr_reader :left
-
-      # @return [Proc,Command] right command
-      #
-      # @api private
-      attr_reader :right
-
-      # @api private
-      def initialize(left, right)
-        @left, @right = left, right
-      end
-
+    class Composite < Pipeline::Composite
       # Calls the composite command
       #
       # Right command is called with a result from the left one
@@ -43,44 +26,10 @@ module ROM
       end
       alias_method :[], :call
 
-      # Compose another composite command from self and other
-      #
-      # @param [Proc, Command] other command
-      #
-      # @return [Composite]
-      #
-      # @api public
-      def >>(other)
-        self.class.new(self, other)
-      end
-
       # @api private
       def result
         left.result
       end
-
-      # @api private
-      def respond_to_missing?(name, include_private = false)
-        left.respond_to?(name) || super
-      end
-
-      private
-
-      # Allow calling methods on the left side object
-      #
-      # @api private
-      def method_missing(name, *args, &block)
-        if left.respond_to?(name)
-          response = left.__send__(name, *args, &block)
-          if response.is_a?(left.class)
-            self.class.new(response, right)
-          else
-            response
-          end
-        else
-          super
-        end
-      end
     end
   end
 end

data/lib/rom/commands/update.rb

@@ -1,4 +1,5 @@
 require 'rom/command'
+require 'rom/support/deprecations'
 
 module ROM
   module Commands
@@ -8,12 +9,14 @@ module ROM
     #
     # @abstract
     class Update < Command
+      extend Deprecations
+
       # @see AbstractCommand#call
       def call(*args)
         assert_tuple_count
         super
       end
-      alias_method :set, :call
+      deprecate :set, :call
     end
   end
 end

data/lib/rom/constants.rb

@@ -10,6 +10,7 @@ module ROM
   CommandError = Class.new(StandardError)
   TupleCountMismatchError = Class.new(CommandError)
   MapperMissingError = Class.new(StandardError)
+  UnknownPluginError = Class.new(StandardError)
 
   InvalidOptionValueError = Class.new(StandardError)
   InvalidOptionKeyError = Class.new(StandardError)

data/lib/rom/env.rb

@@ -1,10 +1,12 @@
 require 'rom/relation/loaded'
+require 'rom/support/deprecations'
 
 module ROM
   # Exposes defined repositories, relations and mappers
   #
   # @api public
   class Env
+    extend Deprecations
     include Equalizer.new(:repositories, :relations, :mappers, :commands)
 
     # @return [Hash] configured repositories
@@ -69,31 +71,7 @@ module ROM
         relation.to_lazy
       end
     end
-
-    # Returns a reader with access to defined mappers
-    #
-    # @example
-    #
-    #   # with a mapper derived from relation access path "users.adults"
-    #   rom.read(:users).adults.to_a
-    #
-    #   # or with explicit mapper name
-    #   rom.read(:users).with(:some_mapper).to_a
-    #
-    # @param [Symbol] name of the registered reader
-    #
-    # @deprecated
-    #
-    # @api public
-    def read(name, &block)
-      warn <<-MSG.gsub(/^\s+/, '')
-        #{self.class}#read is deprecated.
-        Please use `#{self.class}#relation(#{name.inspect})` instead.
-        For mapping append `.map_with(:your_mapper_name)`
-        [#{caller[0]}]
-      MSG
-      relation(name, &block)
-    end
+    deprecate :read, :relation, "For mapping append `.map_with(:your_mapper_name)`"
 
     # Returns commands registry for the given relation
     #

data/lib/rom/global.rb

@@ -1,5 +1,8 @@
 require 'rom/setup'
 require 'rom/repository'
+require 'rom/plugin_registry'
+
+require 'rom/global/plugin_dsl'
 
 module ROM
   # Globally accessible public interface exposed via ROM module
@@ -14,6 +17,7 @@ module ROM
 
       rom.instance_variable_set('@adapters', {})
       rom.instance_variable_set('@repositories', {})
+      rom.instance_variable_set('@plugin_registry', PluginRegistry.new)
     end
 
     # An internal adapter identifier => adapter module map used by setup
@@ -30,6 +34,13 @@ module ROM
     # @api private
     attr_reader :repositories
 
+    # An internal identifier => plugin map used by the setup
+    #
+    # @return [Hash]
+    #
+    # @api private
+    attr_reader :plugin_registry
+
     # Setup object created during env setup phase
     #
     # This gets set to nil after setup is finalized
@@ -161,6 +172,18 @@ module ROM
       boot.mappers(*args, &block)
     end
 
+    # Global plugin setup DSL
+    #
+    # @example
+    #   ROM.plugins do
+    #     register :publisher, Plugin::Publisher, type: :command
+    #   end
+    #
+    # @example
+    def plugins(*args, &block)
+      PluginDSL.new(plugin_registry, *args, &block)
+    end
+
     # Finalize the setup and store default global env under ROM.env
     #
     # @example

data/lib/rom/global/plugin_dsl.rb

@@ -0,0 +1,47 @@
+module ROM
+  module Global
+    # plugin registration DSL
+    #
+    # @private
+    class PluginDSL
+      # Default options passed to plugin registration
+      #
+      # @return [Hash]
+      #
+      # @api private
+      attr_reader :defaults
+
+      # Plugin registry
+      #
+      # @return [PluginRegistry]
+      #
+      # @api private
+      attr_reader :registry
+
+      # @api private
+      def initialize(registry, defaults = {}, &block)
+        @registry = registry
+        @defaults = defaults
+        instance_exec(&block)
+      end
+
+      # Register a plugin
+      #
+      # @param [Symbol] name of the plugin
+      # @param [Module] mod to include
+      # @param [Hash] options
+      #
+      # @api public
+      def register(name, mod, options = {})
+        registry.register(name, mod, defaults.merge(options))
+      end
+
+      # Register plugins for a specific adapter
+      #
+      # @param [Symbol] adapter type
+      def adapter(type, &block)
+        self.class.new(registry, adapter: type, &block)
+      end
+    end
+  end
+end