rom 0.9.1 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5eaa5117425dbec0243b42bfc8e5cd2a246ee67
-  data.tar.gz: b4d0c29e7025e62a7e8cf8660913a1a5c5c9a65a
+  metadata.gz: 5528fe9b5a765d4b890b736e7f1fd41756f98bb9
+  data.tar.gz: 98e7df71ea10901734ff91af05a42d17b345e385
 SHA512:
-  metadata.gz: fd50b8d43492c960dffcb3782cf0068138bacfaa05791266a8d407fe8938b5cf758360372b88be8a26f98c391fa2c857502a9547574d2e635c76ccad581f8f30
-  data.tar.gz: 45c454986d7b9aa01b06bc1210b75733b9daedb25a13208e7726bbe11e2000039ce0d057c94f11bd3f31adea46bfb08a8a92115abf998b58ffd79af98d1d5b09
+  metadata.gz: 3c11e54690552a3b38ec4cd59cea7c2153c40e93be50fb69de3b3b63c0c5b4645127b65ac33f61cbe785043992824e56b2cd82e0622bd7fbabda0075f300827d
+  data.tar.gz: 8a87fbd020626ae052732c524af292666338bff3bce12e174af9b82a40504216f29385c0026b0991bae747af9f9835ab37d0fee41d626831e24f3e8eda0f705b

data/.rubocop_todo.yml

@@ -1,28 +1,46 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-02-26 16:54:42 +0100 using RuboCop version 0.29.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-26 16:17:55 +0200 using RuboCop version 0.34.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
+# Offense count: 3
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/rom/relation/class_interface.rb'
+    - 'spec/unit/rom/commands_spec.rb'
+
+# Offense count: 13
 Metrics/AbcSize:
-  Max: 22
+  Max: 38
 
-# Offense count: 1
+# Offense count: 3
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 9
 
-# Offense count: 40
+# Offense count: 65
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 88
+  Max: 113
 
-# Offense count: 15
+# Offense count: 20
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 21
+  Max: 42
 
-# Offense count: 1
+# Offense count: 3
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodName:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Methods.
+Style/SingleLineBlockParams:
+  Exclude:
+    - 'lib/rom/commands/graph/class_interface.rb'

data/.travis.yml

@@ -10,7 +10,7 @@ rvm:
   - 2.1
   - 2.2
   - rbx-2
-  - jruby
+  - jruby-9000
   - ruby-head
   - jruby-head
 env:

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## v1.0.0 to-be-released
+
+### Added
+
+- Command graph DSL (endash + solnic)
+- Command graph now supports update and delete commands (cflipse + solnic)
+- `Gateway.adapter` setting and a corresponding `Gateway#adapter` reader. Both are
+  necessary to access a migrator (nepalez)
+- `ROM::Commands::Result#{success?,failure?}` interface (Snuff)
+- Imported relation plugins from `rom-repository`:
+  - `view` for explicit relation view definitions
+  - `key_inference` for inferring `foreign_key` of a relation
+
+### Changed
+
+- **REMOVED** all deprecated APIs (solnic)
+- [fixed #306] Inheriting from a misconfigured adapter relation will raise a
+  meaningful error (solnic)
+- Command graph will raise `ROM::KeyMissing` command error when a key is missing
+  in the input (solnic)
+- Command graph no longer rescues from any exception (solnic)
+
+[Compare v0.9.1...HEAD](https://github.com/rom-rb/rom/compare/v0.9.1...HEAD)
+
 ## v0.9.1 2015-08-21
 
 This is a small bug-fix release which addresses a couple of issues for inline

data/Gemfile

@@ -2,6 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rom-support', github: 'rom-rb/rom-support', branch: 'master'
+gem 'rom-mapper', github: 'rom-rb/rom-mapper', branch: 'master'
+gem 'transproc', github: 'solnic/transproc', branch: 'master'
+
 group :console do
   gem 'pry'
   gem 'pg', platforms: [:mri]
@@ -9,7 +13,7 @@ end
 
 group :test do
   gem 'virtus'
-  gem 'anima'
+  gem 'anima', '~> 0.2.0'
   gem 'minitest'
   gem 'thread_safe'
   gem 'activesupport'
@@ -22,7 +26,7 @@ group :test do
 end
 
 group :sql do
-  gem 'rom-sql', git: 'https://github.com/rom-rb/rom-sql.git', branch: 'master'
+  gem 'rom-sql', github: 'rom-rb/rom-sql', branch: 'master'
   gem 'sequel'
   gem 'jdbc-sqlite3', platforms: :jruby
   gem 'sqlite3', platforms: [:mri, :rbx]
@@ -43,7 +47,7 @@ group :tools do
   gem 'byebug', platform: :mri
 
   platform :mri do
-    gem 'mutant', '>= 0.8.0', github: 'mbj/mutant', branch: 'master'
+    gem 'mutant'
     gem 'mutant-rspec'
   end
 end

data/README.md

@@ -28,18 +28,30 @@ Learn more:
 
 You can support ROM's development via our [campaign on Bountysource](https://salt.bountysource.com/teams/rom-rb). Cheers!
 
+## Ecosystem
+
+There are other gems within the rom ecosystem that you will find useful:
+
+* [rom-repository](https://github.com/rom-rb/rom-repository) a higher-level, convenient abstraction with auto-mapping
+* [rom-model](https://github.com/rom-rb/rom-model) extensions for coercion and validation
+
 ## Adapters
 
-  * [rom-sql](https://github.com/rom-rb/rom-sql)
-  * [rom-yesql](https://github.com/rom-rb/rom-yesql)
-  * [rom-couchdb](https://github.com/rom-rb/rom-couchdb)
-  * [rom-mongo](https://github.com/rom-rb/rom-mongo)
-  * [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)
-  * [rom-yaml](https://github.com/rom-rb/rom-yaml)
-  * [rom-csv](https://github.com/rom-rb/rom-csv)
+* [rom-couchdb](https://github.com/rom-rb/rom-couchdb)
+* [rom-csv](https://github.com/rom-rb/rom-csv)
+* [rom-cassandra](https://github.com/rom-rb/rom-cassandra)
+* [rom-event_store](https://github.com/rom-rb/rom-event_store)
+* [rom-git](https://github.com/rom-rb/rom-git)
+* [rom-http](https://github.com/rom-rb/rom-http)
+* [rom-influxdb](https://github.com/rom-rb/rom-influxdb)
+* [rom-json](https://github.com/rom-rb/rom-json)
+* [rom-kafka](https://github.com/rom-rb/rom-kafka)
+* [rom-mongo](https://github.com/rom-rb/rom-mongo)
+* [rom-neo4j](https://github.com/rom-rb/rom-neo4j)
+* [rom-rethinkdb](https://github.com/rom-rb/rom-rethinkdb)
+* [rom-sql](https://github.com/rom-rb/rom-sql)
+* [rom-yaml](https://github.com/rom-rb/rom-yaml)
+* [rom-yesql](https://github.com/rom-rb/rom-yesql)
 
 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.
@@ -57,7 +69,8 @@ ROM is on its way towards 1.0.0. You can see an overview of tasks scheduled for
 ## Community
 
 * [Official Blog](http://rom-rb.org/blog/)
-* [Ruby Object Mapper](https://groups.google.com/forum/#!forum/rom-rb) mailing list
+* [Discussion Forum](http://discourse.rom-rb.org)
+* [Gitter Channel](https://gitter.im/rom-rb/chat)
 
 ## Credits
 

data/lib/rom.rb

@@ -1,4 +1,4 @@
-require 'equalizer'
+require 'dry-equalizer'
 
 require 'rom-support'
 require 'rom/version'
@@ -10,11 +10,10 @@ require 'rom/support/registry'
 require 'rom/support/options'
 require 'rom/support/class_macros'
 require 'rom/support/class_builder'
-require 'rom/support/guarded_inheritance_hook'
 require 'rom/support/inheritance_hook'
 
 # core parts
-require 'rom/environment_plugin'
+require 'rom/configuration_plugin'
 require 'rom/plugin'
 require 'rom/relation'
 require 'rom-mapper'
@@ -23,40 +22,24 @@ require 'rom/commands'
 # rom Global
 require 'rom/global'
 
-# rom environments
-require 'rom/environment'
-
-# TODO: consider to make this part optional and don't require it here
-require 'rom/setup_dsl/setup'
+# rom configurations
+require 'rom/configuration'
 
 # container with registries
 require 'rom/container'
 
+# container factory
+require 'rom/create_container'
+
 # register core plugins
-require 'rom/environment_plugins/auto_registration'
+require 'rom/plugins/configuration/configuration_dsl'
 require 'rom/plugins/relation/registry_reader'
 
 module ROM
   extend Global
 
-  @environment = ROM::Environment.new
-
-  class << self
-    def method_missing(method, *args, &block)
-      if @environment.respond_to?(method)
-        @environment.__send__(method, *args, &block)
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method, _include_private = false)
-      @environment.respond_to?(method) || super
-    end
-  end
-
   plugins do
-    register :auto_registration, ROM::EnvironmentPlugins::AutoRegistration, type: :environment
+    register :macros, ROM::ConfigurationPlugins::ConfigurationDSL, type: :configuration
     register :registry_reader, ROM::Plugins::Relation::RegistryReader, type: :relation
   end
 end

data/lib/rom/command.rb

@@ -1,130 +1,168 @@
-require 'rom/commands/abstract'
+require 'rom/support/options'
+
+require 'rom/commands/class_interface'
+require 'rom/commands/composite'
+require 'rom/commands/graph'
+require 'rom/commands/lazy'
 
 module ROM
-  # Base command class with factory class-level interface and setup-related logic
+  # Abstract command class
+  #
+  # Provides a constructor accepting relation with options and basic behavior
+  # for calling, currying and composing commands.
+  #
+  # Typically command subclasses should inherit from specialized
+  # Create/Update/Delete, not this one.
+  #
+  # @abstract
   #
   # @private
-  class Command < Commands::Abstract
+  class Command
+    include Commands
+
     extend ClassMacros
-    extend ROM::Support::GuardedInheritanceHook
+    extend ClassInterface
 
-    include Equalizer.new(:relation, :options)
+    include Options
+    include Dry::Equalizer(:relation, :options)
 
     defines :adapter, :relation, :result, :input, :validator, :register_as
 
+    option :type, allow: [:create, :update, :delete]
+    option :source, reader: true
+    option :result, reader: true, allow: [:one, :many]
+    option :validator, reader: true
+    option :input, reader: true
+    option :curry_args, type: Array, reader: true, default: EMPTY_ARRAY
+
     input Hash
     validator proc {}
     result :many
 
-    # Return adapter specific sub-class based on the adapter identifier
-    #
-    # This is a syntax sugar to make things consistent
-    #
-    # @example
-    #   ROM::Commands::Create[:memory]
-    #   # => ROM::Memory::Commands::Create
-    #
-    # @param [Symbol] adapter identifier
-    #
-    # @return [Class]
-    #
-    # @api public
-    def self.[](adapter)
-      adapter_namespace(adapter).const_get(Inflector.demodulize(name))
+    # @attr_reader [Relation] relation The command's relation
+    attr_reader :relation
+
+    # @api private
+    def initialize(relation, options = EMPTY_HASH)
+      super
+      @relation = relation
+      @source = options[:source] || relation
     end
 
-    # Return namespaces that contains command subclasses of a specific adapter
+    # Execute the command
     #
-    # @param [Symbol] adapter identifier
+    # @abstract
     #
-    # @return [Module]
+    # @return [Array] an array with inserted tuples
     #
     # @api private
-    def self.adapter_namespace(adapter)
-      ROM.adapters.fetch(adapter).const_get(:Commands)
-    rescue KeyError
-      raise AdapterNotPresentError.new(adapter, :relation)
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
     end
 
-    # Build a command class for a specific relation with options
-    #
-    # @example
-    #   class CreateUser < ROM::Commands::Create[:memory]
-    #   end
+    # Call the command and return one or many tuples
     #
-    #   command = CreateUser.build(rom.relations[:users])
+    # @api public
+    def call(*args)
+      tuples = execute(*(curry_args + args))
+
+      if one?
+        tuples.first
+      else
+        tuples
+      end
+    end
+    alias_method :[], :call
+
+    # Curry this command with provided args
     #
-    # @param [Relation] relation
-    # @param [Hash] options
+    # Curried command can be called without args
     #
     # @return [Command]
     #
     # @api public
-    def self.build(relation, options = EMPTY_HASH)
-      new(relation, self.options.merge(options))
+    def curry(*args)
+      if curry_args.empty? && args.first.is_a?(Graph::InputEvaluator)
+        Lazy[self].new(self, *args)
+      else
+        self.class.build(relation, options.merge(curry_args: args))
+      end
     end
+    alias_method :with, :curry
 
-    # Use a configured plugin in this relation
+    # Compose a command with another one
+    #
+    # The other one will be called with the result from the first one
     #
     # @example
-    #   class CreateUser < ROM::Commands::Create[:memory]
-    #     use :pagintion
     #
-    #     per_page 30
-    #   end
+    #   command = users.create.curry(name: 'Jane')
+    #   command >>= tasks.create.curry(title: 'Task One')
+    #
+    #   command.call # creates user, passes it to tasks and creates task
     #
-    # @param [Symbol] plugin
-    # @param [Hash] options
-    # @option options [Symbol] :adapter (:default) first adapter to check for plugin
+    # @return [Composite]
     #
     # @api public
-    def self.use(plugin, _options = EMPTY_HASH)
-      ROM.plugin_registry.commands.fetch(plugin, adapter).apply_to(self)
+    def >>(other)
+      Composite.new(self, other)
+    end
+
+    # @api public
+    def combine(*others)
+      Graph.new(self, others)
     end
 
-    # Build command registry hash for provided relations
-    #
-    # @param [RelationRegistry] relations registry
-    # @param [Hash] gateways
-    # @param [Array] descendants a list of command subclasses
-    #
-    # @return [Hash]
-    #
     # @api private
-    def self.registry(relations, gateways, descendants)
-      descendants.each_with_object({}) do |klass, h|
-        rel_name = klass.relation
+    def lazy?
+      false
+    end
 
-        next unless rel_name
+    # @api private
+    def graph?
+      false
+    end
 
-        relation = relations[rel_name]
-        name = klass.register_as || klass.default_name
+    # @api private
+    def one?
+      result.equal?(:one)
+    end
 
-        gateway = gateways[relation.class.gateway]
-        gateway.extend_command_class(klass, relation.dataset)
+    # @api private
+    def many?
+      result.equal?(:many)
+    end
 
-        (h[rel_name] ||= {})[name] = klass.build(relation)
+    # Assert that tuple count in the relation corresponds to :result
+    # setting
+    #
+    # @raise TupleCountMismatchError
+    #
+    # @api private
+    def assert_tuple_count
+      if one? && tuple_count > 1
+        raise TupleCountMismatchError, "#{inspect} expects one tuple"
       end
     end
 
-    # Return default name of the command class based on its name
+    # Return number of tuples in the relation relation
     #
-    # During setup phase this is used by defalut as `register_as` option
+    # This should be overridden by gateways when `#count` is not available
+    # in the relation objects
     #
-    # @return [Symbol]
+    # @return [Fixnum]
     #
     # @api private
-    def self.default_name
-      Inflector.underscore(Inflector.demodulize(name)).to_sym
+    def tuple_count
+      relation.count
     end
 
-    # Return default options based on class macros
-    #
-    # @return [Hash]
-    #
     # @api private
-    def self.options
-      { input: input, validator: validator, result: result }
+    def new(new_relation)
+      self.class.build(new_relation, options.merge(source: relation))
     end
   end
 end