rom 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25732b8177fd64f45b5e98ee76444dfd87fcbd87
-  data.tar.gz: 1bb6afd01547c8c4455c0ba1f56ea3b939b45ea4
+  metadata.gz: a49d8efc969391ec0d48db3e9f41d29299537e44
+  data.tar.gz: 5c4ba339c27f15887468a364bd89de0c7c722572
 SHA512:
-  metadata.gz: 51358af05cf918b0b8271758e7a56a01830bfd5c1252819f949cc4e8eeabde918568f5980faba63038cf2239b0fa0df83ac40ac69a902402fd4325a45144a36b
-  data.tar.gz: bccc3cea146a146045b76d8c949d8fb8983302379bcff680c00e357b24793d2ae897361a3f6570a9a129b776a49d6a6c75046e45001a81d92f914246d4076ddf
+  metadata.gz: b720586dcc0542d8ab45d22209d91898c695a8f509af73f3bb1f967f3952f39f83ed3c9bcb7aa7b4ec87087518e7f9f2f592c4d5a4ad5763a5a3c8f9829389de
+  data.tar.gz: 1b5f6a9ae2038ea0b539d4e6931a1be194aa13d2cc2b7fbc3a1af03455bc028956f96a4ba39ab4cf94fd551931b86ab425e2c61bef8b13e2c823cd3a0f4ff967

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --order random
---warnings
+--require ./spec/spec_helper.rb

data/.travis.yml

@@ -9,11 +9,10 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3.1
   - rbx-2
-  - jruby-9000
+  - jruby-9.0.5.0
   - ruby-head
-  - jruby-head
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
@@ -21,6 +20,9 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+  include:
+    - rvm: jruby-head
+      before_install: gem install bundler --no-ri --no-rdoc
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+## v2.0.0 2016-07-27
+
+### Added
+
+- Extendible `schema` DSL for relations with attribute and type definitions (solnic)
+- New command plugin `:schema` which will set up an input handler from schema definition (solnic)
+- New command option `restrictible` for commands that can use a restricted relation (solnic)
+- More meaningful exception is raised when trying to access a non-existant command (thiagoa)
+- `Relation::Name` class that contains both relation and dataset names (flash-gordon)
+- `Relation::Loaded#pluck` returning values under specified key (solnic)
+- `Relation::Loaded#primary_keys` returning a list of primary keys from a materialized relation (solnic)
+
+#### New low-level APIs
+
+- `Command.create_class` for building a command class dynamically (solnic)
+- `Command.extend_for_relation` for extending a command with relation view interface (solnic)
+
+### Fixed
+
+- [BREAKING] command graphs return materialized results (a hash or an array) (solnic)
+- `Container#disconnect` properly delegates to gateways (endash)
+- `Relation#with` properly carries original options (solnic)
+- Command pipeline will stop processing if result was `nil` or an empty array (solnic)
+
+### Changed
+
+- [BREAKING] `ROM.env` **is gone** (solnic)
+- [BREAKING] `Update` and `Delete` no longer calls `assert_tuple_count` [more info](https://github.com/rom-rb/rom/commit/bec2c4c1dce370670c90f529feb1b4db0e6e4bd9) (solnic)
+- [BREAKING] `Relation#name` and `Command#name` now returns `Relation::Name` instance (flash-gordon)
+- `Command.validator` is now deprecated [more info](https://github.com/rom-rb/rom/commit/80bb8411bd411f05d9c51106ae026ad412a2f25f) (solnic)
+- `Relation.dataset` yields a relation class when block was passed (solnic)
+- `Relation#attributes` can return attributes explicitly passed via options (solnic)
+- Relation `:key_inference` plugin supports schema information from other relations (solnic)
+- `auto_registration` coerces its directory to a pathname now (adz)
+- `macros` are now enabled by default in in-line setup block (endash)
+
+[Compare v1.0.0...v2.0.0](https://github.com/rom-rb/rom/compare/v1.0.0...v2.0.0)
+
 ## v1.0.0 2016-01-06
 
 ### Added

data/Gemfile

@@ -11,8 +11,6 @@ group :test do
   gem 'virtus'
   gem 'anima', '~> 0.2.0'
   gem 'minitest'
-  gem 'thread_safe'
-  gem 'activesupport'
   gem 'inflecto', '~> 0.0', '>= 0.0.2'
 
   platforms :rbx do
@@ -29,21 +27,11 @@ group :sql do
 end
 
 group :benchmarks do
-  gem 'activerecord', '4.2.0'
+  gem 'activerecord', '5.0.0.beta4'
   gem 'benchmark-ips', '~> 2.2.0'
+  gem 'rom-repository', github: 'rom-rb/rom-repository', branch: 'master'
 end
 
 group :tools do
-  gem 'rubocop', '~> 0.31'
-
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
-
   gem 'byebug', platform: :mri
-
-  platform :mri do
-    gem 'mutant'
-    gem 'mutant-rspec'
-  end
 end

data/README.md

@@ -5,7 +5,7 @@
 [coveralls]: https://coveralls.io/r/rom-rb/rom
 [inchpages]: http://inch-ci.org/github/rom-rb/rom/
 
-# 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)
+# rom [![Gitter chat](https://badges.gitter.im/rom-rb/chat.svg)](https://gitter.im/rom-rb/chat)
 
 [![Gem Version](https://badge.fury.io/rb/rom.svg)][gem]
 [![Build Status](https://travis-ci.org/rom-rb/rom.svg?branch=master)][travis]
@@ -15,14 +15,13 @@
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom.svg?branch=master&style=flat)][inchpages]
 
 Ruby Object Mapper (ROM) is a data mapping and persistence toolkit for Ruby
-with the goal to provide powerful object mapping capabilities without limiting the
-full power of your datastore.
+with the goal to provide powerful object mapping capabilities without limiting
+the full power of your datastore.
 
 Learn more:
 
-* [Introduction](http://rom-rb.org/introduction/)
-* [Guides](http://rom-rb.org/guides/)
-* [Tutorials](http://rom-rb.org/tutorials/)
+* [Introduction](http://rom-rb.org/learn/introduction)
+* [Quick Start](http://rom-rb.org/learn/repositories/quick-start)
 
 ## Support Campaign
 
@@ -33,43 +32,38 @@ You can support ROM's development via our [campaign on Bountysource](https://sal
 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
+* (WIP) [rom-migrator](https://github.com/rom-rb/rom-migrator) common APIs for database migrations
 
 ## Adapters
 
+* [rom-sql](https://github.com/rom-rb/rom-sql) (supported URI schemes: ado amalgalite cubrid db2 dbi do fdbsql firebird ibmdb informix jdbc mysql mysql2 odbc openbase oracle postgres sqlanywhere sqlite swift tinytds)
+* [rom-yesql](https://github.com/rom-rb/rom-yesql)
+* [rom-http](https://github.com/rom-rb/rom-http)
 * [rom-couchdb](https://github.com/rom-rb/rom-couchdb)
 * [rom-csv](https://github.com/rom-rb/rom-csv)
+* [rom-yaml](https://github.com/rom-rb/rom-yaml)
 * [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.
 
 ## 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)
 
-## ROADMAP
-
-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/)
-* [Discussion Forum](http://discourse.rom-rb.org)
+* [Discussion Forum](http://discuss.rom-rb.org)
 * [Gitter Channel](https://gitter.im/rom-rb/chat)
 
 ## Credits

data/lib/rom.rb

@@ -34,6 +34,7 @@ require 'rom/create_container'
 # register core plugins
 require 'rom/plugins/configuration/configuration_dsl'
 require 'rom/plugins/relation/registry_reader'
+require 'rom/plugins/command/schema'
 
 module ROM
   extend Global
@@ -41,5 +42,6 @@ module ROM
   plugins do
     register :macros, ROM::ConfigurationPlugins::ConfigurationDSL, type: :configuration
     register :registry_reader, ROM::Plugins::Relation::RegistryReader, type: :relation
+    register :schema, ROM::Plugins::Command::Schema, type: :command
   end
 end

data/lib/rom/association_set.rb

@@ -0,0 +1,26 @@
+require 'rom/support/registry'
+require 'rom/support/inflector'
+
+module ROM
+  class AssociationSet < ROM::Registry
+    # @api private
+    def try(name, &block)
+      if key?(name)
+        yield(self[name])
+      else
+        false
+      end
+    end
+
+    # @api private
+    def [](name)
+      key = name.to_sym
+
+      if key?(key)
+        super
+      else
+        super(Inflector.singularize(key))
+      end
+    end
+  end
+end

data/lib/rom/command.rb

@@ -1,4 +1,6 @@
+require 'rom/support/deprecations'
 require 'rom/support/options'
+require 'rom/pipeline'
 
 require 'rom/commands/class_interface'
 require 'rom/commands/composite'
@@ -18,15 +20,18 @@ module ROM
   #
   # @private
   class Command
+    DEFAULT_VALIDATOR = proc {}
+
+    include Dry::Equalizer(:relation, :options)
     include Commands
+    include Pipeline::Operator
 
     extend ClassMacros
     extend ClassInterface
 
     include Options
-    include Dry::Equalizer(:relation, :options)
 
-    defines :adapter, :relation, :result, :input, :validator, :register_as
+    defines :adapter, :relation, :result, :input, :validator, :register_as, :restrictable
 
     option :type, allow: [:create, :update, :delete]
     option :source, reader: true
@@ -36,9 +41,26 @@ module ROM
     option :curry_args, type: Array, reader: true, default: EMPTY_ARRAY
 
     input Hash
-    validator proc {}
+    validator DEFAULT_VALIDATOR
     result :many
 
+    # @deprecated
+    #
+    # @api public
+    def self.validator(vp = nil)
+      if defined?(@validator) && vp.nil?
+        @validator
+      else
+        unless vp.equal?(DEFAULT_VALIDATOR)
+          Deprecations.announce(
+            "#{name}.validator",
+            'Please handle validation before calling commands'
+          )
+        end
+        super
+      end
+    end
+
     # @attr_reader [Relation] relation The command's relation
     attr_reader :relation
 
@@ -49,6 +71,24 @@ module ROM
       @source = options[:source] || relation
     end
 
+    # Return name of this command's relation
+    #
+    # @return [ROM::Relation::Name]
+    #
+    # @api public
+    def name
+      relation.name
+    end
+
+    # Return gateway of this command's relation
+    #
+    # @return [Symbol]
+    #
+    # @api public
+    def gateway
+      relation.gateway
+    end
+
     # Execute the command
     #
     # @abstract
@@ -66,8 +106,8 @@ module ROM
     # Call the command and return one or many tuples
     #
     # @api public
-    def call(*args)
-      tuples = execute(*(curry_args + args))
+    def call(*args, &block)
+      tuples = execute(*(curry_args + args), &block)
 
       if one?
         tuples.first
@@ -93,24 +133,6 @@ module ROM
     end
     alias_method :with, :curry
 
-    # Compose a command with another one
-    #
-    # The other one will be called with the result from the first one
-    #
-    # @example
-    #
-    #   command = users.create.curry(name: 'Jane')
-    #   command >>= tasks.create.curry(title: 'Task One')
-    #
-    #   command.call # creates user, passes it to tasks and creates task
-    #
-    # @return [Composite]
-    #
-    # @api public
-    def >>(other)
-      Composite.new(self, other)
-    end
-
     # @api public
     def combine(*others)
       Graph.new(self, others)
@@ -136,33 +158,16 @@ module ROM
       result.equal?(:many)
     end
 
-    # 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
+    def new(new_relation)
+      self.class.build(new_relation, options.merge(source: relation))
     end
 
-    # Return number of tuples in the relation relation
-    #
-    # This should be overridden by gateways when `#count` is not available
-    # in the relation objects
-    #
-    # @return [Fixnum]
-    #
-    # @api private
-    def tuple_count
-      relation.count
-    end
+    private
 
     # @api private
-    def new(new_relation)
-      self.class.build(new_relation, options.merge(source: relation))
+    def composite_class
+      Command::Composite
     end
   end
 end

data/lib/rom/command_registry.rb

@@ -8,6 +8,15 @@ module ROM
     include Commands
     include Options
 
+    CommandNotFoundError = Class.new(KeyError)
+
+    # Name of the relation from which commands are under
+    #
+    # @return [String]
+    #
+    # @api private
+    attr_reader :relation_name
+
     # Internal command registry
     #
     # @return [Registry]
@@ -19,8 +28,10 @@ module ROM
     option :mapper, reader: true
 
     # @api private
-    def initialize(elements, options = EMPTY_HASH)
+    def initialize(relation_name, elements, options = EMPTY_HASH)
       super
+
+      @relation_name = relation_name
       @registry =
         if elements.is_a?(Registry)
           elements
@@ -73,7 +84,7 @@ module ROM
     #
     # @api public
     def [](name)
-      command = registry[name]
+      command = fetch_command(name)
       mapper = options[:mapper]
 
       if mapper
@@ -104,11 +115,23 @@ module ROM
     #
     # @api private
     def with(new_options)
-      self.class.new(registry, options.merge(new_options))
+      self.class.new(relation_name, registry, options.merge(new_options))
     end
 
     private
 
+    # Fetch a command from the registry and raise a specialized error
+    # in case the command is not found
+    #
+    # @api private
+    def fetch_command(name)
+      registry.fetch(name) do
+        raise CommandNotFoundError.new(
+          "There is no :#{name} command for :#{relation_name} relation"
+        )
+      end
+    end
+
     # Allow checking if a certain command is available using dot-notation
     #
     # @api private