rom 0.9.0.rc1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68b700901edb358688ae8f41a8f474cab6dc1254
-  data.tar.gz: 97d2569ad4ad0b653e725b0598fe6edb0d6d70b8
+  metadata.gz: e37b5bfee7aba0349fc7072c15a936d86b5d64da
+  data.tar.gz: 960446e1976fcfbe3d13d7bafb25a83ce7912626
 SHA512:
-  metadata.gz: 5627b18505dd2e30d7eca6b6514b84f6f81573cd99a44eb7fb67b15966e37fccc007df8b3d3016b8a65a4363321d10e056e5e93c255c0ef13704693592345c5c
-  data.tar.gz: 46dd954fd398b22e3a5a5af01215ff9f52ab51ee9b750de68d7a5c9510a4275f29fb9e04914d03cb52e026653cf3c0754fa88aad10fb4feebd8ae28d138ea122
+  metadata.gz: 9c251e5659fb72fc73cfca473a1667d4da46a4ca58ed68f31eb2b74f275139ca86ffdf49c93f2b87a194420baa5911655e26927e5d923239ead79ca2bc910cda
+  data.tar.gz: 6c35bbee777498703f1a386ea4ce2f91d96b0860c7a664800ffe05f58ba1ce18199279f088f9ae3dac2b3b0ce6d11fc6aa718d10afbb7db01192b08500012674

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## v0.9.0 to-be-released
+## v0.9.0 2015-08-19
 
 ### Added
 
@@ -24,8 +24,11 @@
 * Adapter-specific interface is properly included in relation descendants (solnic)
 * Combined commands (aka command graph) properly rejects keys from nested input
   prior sending the input to individual commands (solnic)
+* Composite relation materializes correctly when another composite on the right
+  side became materialized (ie piping relation through a composite relation will
+  work correctly) (solnic)
 
-[Compare v0.8.1...HEAD](https://github.com/rom-rb/rom/compare/v0.8.1...HEAD)
+[Compare v0.8.1...v0.9.0](https://github.com/rom-rb/rom/compare/v0.8.1...v0.9.0)
 
 ## v0.8.1 2015-07-12
 

data/lib/rom/command.rb

@@ -60,7 +60,7 @@ module ROM
     # @return [Command]
     #
     # @api public
-    def self.build(relation, options = {})
+    def self.build(relation, options = EMPTY_HASH)
       new(relation, self.options.merge(options))
     end
 
@@ -78,7 +78,7 @@ module ROM
     # @option options [Symbol] :adapter (:default) first adapter to check for plugin
     #
     # @api public
-    def self.use(plugin, _options = {})
+    def self.use(plugin, _options = EMPTY_HASH)
       ROM.plugin_registry.commands.fetch(plugin, adapter).apply_to(self)
     end
 

data/lib/rom/command_registry.rb

@@ -19,7 +19,7 @@ module ROM
     option :mapper, reader: true
 
     # @api private
-    def initialize(elements, options = {})
+    def initialize(elements, options = EMPTY_HASH)
       super
       @registry =
         if elements.is_a?(Registry)

data/lib/rom/commands/abstract.rb

@@ -35,7 +35,7 @@ module ROM
         'Source relation is now available as `Command#source`'
 
       # @api private
-      def initialize(relation, options = {})
+      def initialize(relation, options = EMPTY_HASH)
         super
         @relation = relation
         @source = options[:source] || relation

data/lib/rom/commands/graph.rb

@@ -26,7 +26,7 @@ module ROM
       option :mappers, reader: true, default: proc { MapperRegistry.new }
 
       # @api private
-      def initialize(root, nodes, options = {})
+      def initialize(root, nodes, options = EMPTY_HASH)
         super
         @root = root
         @nodes = nodes

data/lib/rom/environment.rb

@@ -45,11 +45,14 @@ module ROM
       ROM.plugin_registry
     end
 
-    # Apply
+    # Apply a plugin to the environment
+    #
+    # @param [Mixed] The plugin identifier, usually a Symbol
+    # @param [Hash] Plugin options
     #
     # @api public
-    def use(plugin)
-      plugin_registry.environment.fetch(plugin).apply_to(self)
+    def use(plugin, options = {})
+      plugin_registry.environment.fetch(plugin).apply_to(self, options)
     end
 
     # Starts the setup process for relations, mappers and commands.

data/lib/rom/environment_plugin.rb

@@ -10,8 +10,8 @@ module ROM
     # @param [ROM::Environment] environment
     #
     # @api private
-    def apply_to(environment)
-      mod.apply(environment)
+    def apply_to(environment, options = {})
+      mod.apply(environment, options)
     end
   end
 end

data/lib/rom/environment_plugins/auto_registration.rb

@@ -7,10 +7,20 @@ module ROM
     # @api public
     module AutoRegistration
       # @api private
-      def self.apply(environment)
-        ROM::Relation.on(:inherited) { |relation| environment.register_relation(relation) }
-        ROM::Command.on(:inherited) { |command| environment.register_command(command) }
-        ROM::Mapper.on(:inherited) { |mapper| environment.register_mapper(mapper) }
+      def self.apply(environment, options = {})
+        if_proc = options.fetch(:if, ->(*args) { true })
+
+        ROM::Relation.on(:inherited) do |relation|
+          environment.register_relation(relation) if if_proc.call(relation)
+        end
+
+        ROM::Command.on(:inherited) do |command|
+          environment.register_command(command) if if_proc.call(command)
+        end
+
+        ROM::Mapper.on(:inherited) do |mapper|
+          environment.register_mapper(mapper) if if_proc.call(mapper)
+        end
       end
     end
   end

data/lib/rom/global/plugin_dsl.rb

@@ -19,7 +19,7 @@ module ROM
       attr_reader :registry
 
       # @api private
-      def initialize(registry, defaults = {}, &block)
+      def initialize(registry, defaults = EMPTY_HASH, &block)
         @registry = registry
         @defaults = defaults
         instance_exec(&block)
@@ -32,7 +32,7 @@ module ROM
       # @param [Hash] options
       #
       # @api public
-      def register(name, mod, options = {})
+      def register(name, mod, options = EMPTY_HASH)
         registry.register(name, mod, defaults.merge(options))
       end
 

data/lib/rom/plugin_registry.rb

@@ -49,7 +49,7 @@ module ROM
     # relation or mapper)
     # @option options [Symbol] :adapter (:default) which adapter this plugin
     # applies to. Leave blank for all adapters
-    def register(name, mod, options = {})
+    def register(name, mod, options = EMPTY_HASH)
       type    = options.fetch(:type)
       adapter = options.fetch(:adapter, :default)
 

data/lib/rom/relation.rb

@@ -19,7 +19,7 @@ module ROM
   # however, is considered private and should not be used outside of the
   # relation instance.
   #
-  # ROM builds sub-classes of this class for every relation defined in the 
+  # ROM builds sub-classes of this class for every relation defined in the
   # environment for easy inspection and extensibility - every gateway can
   # provide extensions for those sub-classes but there is always a vanilla
   # relation instance stored in the schema registry.
@@ -47,7 +47,7 @@ module ROM
     attr_reader :dataset
 
     # @api private
-    def initialize(dataset, options = {})
+    def initialize(dataset, options = EMPTY_HASH)
       @dataset = dataset
       super
     end
@@ -115,7 +115,7 @@ module ROM
     private
 
     # @api private
-    def __new__(dataset, new_opts = {})
+    def __new__(dataset, new_opts = EMPTY_HASH)
       self.class.new(dataset, options.merge(new_opts))
     end
   end

data/lib/rom/relation/class_interface.rb

@@ -72,7 +72,7 @@ module ROM
           end
 
           # @api private
-          def initialize(dataset, options = {})
+          def initialize(dataset, options = EMPTY_HASH)
             @name = self.class.dataset
             super
           end
@@ -131,7 +131,7 @@ module ROM
       # @option options [Symbol] :adapter (:default) first adapter to check for plugin
       #
       # @api public
-      def use(plugin, _options = {})
+      def use(plugin, _options = EMPTY_HASH)
         ROM.plugin_registry.relations.fetch(plugin, adapter).apply_to(self)
       end
 

data/lib/rom/relation/composite.rb

@@ -21,7 +21,9 @@ module ROM
         relation = left.call(*args)
         response = right.call(relation)
 
-        if relation.is_a?(Loaded)
+        if response.is_a?(Loaded)
+          response
+        elsif relation.is_a?(Loaded)
           relation.new(response)
         else
           Loaded.new(relation, response)

data/lib/rom/relation/curried.rb

@@ -1,4 +1,6 @@
 require 'rom/support/options'
+
+require 'rom/pipeline'
 require 'rom/relation/materializable'
 
 module ROM
@@ -6,6 +8,7 @@ module ROM
     class Curried
       include Options
       include Materializable
+      include Pipeline
 
       option :name, type: Symbol, reader: true
       option :arity, type: Integer, reader: true, default: -1
@@ -14,7 +17,7 @@ module ROM
       attr_reader :relation
 
       # @api private
-      def initialize(relation, options = {})
+      def initialize(relation, options = EMPTY_HASH)
         @relation = relation
         super
       end
@@ -67,7 +70,7 @@ module ROM
       private
 
       # @api private
-      def __new__(relation, new_opts = {})
+      def __new__(relation, new_opts = EMPTY_HASH)
         Curried.new(relation, options.merge(new_opts))
       end
 

data/lib/rom/setup_dsl/command.rb

@@ -8,7 +8,7 @@ module ROM
     # This is used by Setup#commands DSL and its `define` block
     #
     # @api private
-    def self.build_class(name, relation, options = {}, &block)
+    def self.build_class(name, relation, options = EMPTY_HASH, &block)
       type = options.fetch(:type) { name }
       command_type = Inflector.classify(type)
       adapter = options.fetch(:adapter)

data/lib/rom/setup_dsl/command_dsl.rb

@@ -24,7 +24,7 @@ module ROM
       # @return [Class] generated class
       #
       # @api public
-      def define(name, options = {}, &block)
+      def define(name, options = EMPTY_HASH, &block)
         Command.build_class(
           name, relation, { adapter: adapter }.merge(options), &block
         )

data/lib/rom/setup_dsl/mapper.rb

@@ -8,7 +8,7 @@ module ROM
     # This is used by Setup#mappers DSL
     #
     # @api private
-    def self.build_class(name, options = {}, &block)
+    def self.build_class(name, options = EMPTY_HASH, &block)
       class_name = "ROM::Mapper[#{name}]"
 
       parent = options[:parent]

data/lib/rom/setup_dsl/mapper_dsl.rb

@@ -22,7 +22,7 @@ module ROM
       # @return [Class]
       #
       # @api public
-      def define(name, options = {}, &block)
+      def define(name, options = EMPTY_HASH, &block)
         Mapper.build_class(name, options, &block)
         self
       end

data/lib/rom/setup_dsl/relation.rb

@@ -8,7 +8,7 @@ module ROM
     # This is used by Setup#relation DSL
     #
     # @api private
-    def self.build_class(name, options = {})
+    def self.build_class(name, options = EMPTY_HASH)
       class_name = "ROM::Relation[#{Inflector.camelize(name)}]"
       adapter = options.fetch(:adapter)
 

data/lib/rom/setup_dsl/setup.rb

@@ -19,7 +19,7 @@ module ROM
     #   end
     #
     # @api public
-    def relation(name, options = {}, &block)
+    def relation(name, options = EMPTY_HASH, &block)
       klass_opts = { adapter: default_adapter }.merge(options)
       klass = Relation.build_class(name, klass_opts)
       klass.class_eval(&block) if block

data/lib/rom/version.rb

@@ -1,3 +1,3 @@
 module ROM
-  VERSION = '0.9.0.rc1'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/spec/integration/multi_env_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+
+describe 'Setting up ROM with multiple environments' do
+  let(:environment) do
+    {
+      one: ROM::Environment.new,
+      two: ROM::Environment.new
+    }
+  end
+  let(:setup) do
+    {
+      one: environment[:one].setup(:memory),
+      two: environment[:two].setup(:memory)
+    }
+  end
+  let(:container) do
+    {
+      one: setup[:one].finalize,
+      two: setup[:two].finalize
+    }
+  end
+
+  before { setup }
+
+  context 'without :auto_registration plugin' do
+    before do
+      module Test
+        class Users < ROM::Relation[:memory]
+          dataset :users
+        end
+
+        class CreateUser < ROM::Commands::Create[:memory]
+          register_as :create
+          relation :users
+          result :one
+        end
+
+        class UserMapper < ROM::Mapper
+          relation :users
+          register_as :entity
+        end
+      end
+    end
+
+    it 'registers items independently of other environments' do
+      environment[:one].register_relation(Test::Users)
+      environment[:one].register_command(Test::CreateUser)
+      environment[:one].register_mapper(Test::UserMapper)
+
+      expect(container[:one].relations[:users]).to be_kind_of Test::Users
+      expect(container[:one].commands[:users].create).to be_kind_of Test::CreateUser
+      expect(container[:one].mappers[:users].entity).to be_kind_of Test::UserMapper
+
+      expect { container[:two].relations[:users] }.to raise_error(
+        ROM::Registry::ElementNotFoundError
+      )
+      expect { container[:two].commands[:users].create }.to raise_error(
+        ROM::Registry::ElementNotFoundError
+      )
+      expect { container[:two].commands[:users].create }.to raise_error(
+        ROM::Registry::ElementNotFoundError
+      )
+    end
+
+    it 'allows use of the same identifiers in different environments' do
+      environment[:one].register_relation(Test::Users)
+      environment[:one].register_command(Test::CreateUser)
+      environment[:one].register_mapper(Test::UserMapper)
+
+      expect { environment[:two].register_relation(Test::Users) }.to_not raise_error
+      expect { environment[:two].register_command(Test::CreateUser) }.to_not raise_error
+      expect { environment[:two].register_mapper(Test::UserMapper) }.to_not raise_error
+    end
+  end
+
+  context 'with :auto_registration plugin' do
+    context 'without if option' do
+      before do
+        environment[:one].use :auto_registration
+
+        module Test
+          class Users < ROM::Relation[:memory]
+            dataset :users
+          end
+
+          class CreateUser < ROM::Commands::Create[:memory]
+            register_as :create
+            relation :users
+            result :one
+          end
+
+          class UserMapper < ROM::Mapper
+            relation :users
+            register_as :entity
+          end
+        end
+      end
+
+      it 'registers all classes that are defined with the given environment' do
+        expect(container[:one].relations[:users]).to be_kind_of Test::Users
+        expect(container[:one].commands[:users].create).to be_kind_of Test::CreateUser
+        expect(container[:one].mappers[:users].entity).to be_kind_of Test::UserMapper
+      end
+
+      it 'works independently of other environments' do
+        expect { container[:two].relations[:users] }.to raise_error(
+          ROM::Registry::ElementNotFoundError
+        )
+        expect { container[:two].commands[:users].create }.to raise_error(
+          ROM::Registry::ElementNotFoundError
+        )
+        expect { container[:two].commands[:users].create }.to raise_error(
+          ROM::Registry::ElementNotFoundError
+        )
+      end
+    end
+
+    context 'with if option' do
+      before do
+        environment[:one].use :auto_registration, if: ->(item) do
+          item.to_s[/(.*)(?=::)/] == 'Test'
+        end
+
+        environment[:two].use :auto_registration, if: ->(item) do
+          item.to_s[/(.*)(?=::)/] == 'Test::API'
+        end
+
+        module Test
+          class Users < ROM::Relation[:memory]
+            dataset :users
+          end
+
+          class CreateUser < ROM::Commands::Create[:memory]
+            register_as :create
+            relation :users
+            result :one
+          end
+
+          class UserMapper < ROM::Mapper
+            relation :users
+            register_as :entity
+          end
+
+          module API
+            class Users < ROM::Relation[:memory]
+              dataset :users
+            end
+
+            class CreateUser < ROM::Commands::Create[:memory]
+              register_as :create
+              relation :users
+              result :one
+            end
+
+            class UserMapper < ROM::Mapper
+              relation :users
+              register_as :entity
+            end
+          end
+        end
+      end
+
+      it 'registers all classes that are defined where proc returns true' do
+        expect(container[:one].relations[:users]).to be_kind_of Test::Users
+        expect(container[:one].commands[:users].create).to be_kind_of Test::CreateUser
+        expect(container[:one].mappers[:users].entity).to be_kind_of Test::UserMapper
+        expect(container[:two].relations[:users]).to be_kind_of Test::API::Users
+        expect(container[:two].commands[:users].create).to be_kind_of(
+          Test::API::CreateUser
+        )
+        expect(container[:two].mappers[:users].entity).to be_kind_of(
+          Test::API::UserMapper
+        )
+      end
+    end
+  end
+end

data/spec/unit/rom/plugin_spec.rb

@@ -6,18 +6,20 @@ describe "ROM::PluginRegistry" do
   let(:setup) { ROM.setup(:memory) }
 
   before do
-    Test::CommandPlugin   = Module.new
-    Test::MapperPlugin    = Module.new
-    Test::RelationPlugin  = Module.new do
+    Test::EnvironmentPlugin = Module.new
+    Test::CommandPlugin     = Module.new
+    Test::MapperPlugin      = Module.new
+    Test::RelationPlugin    = Module.new do
       def plugged_in
         "a relation"
       end
     end
 
     ROM.plugins do
-      register :publisher,  Test::CommandPlugin,  type: :command
-      register :pager,      Test::RelationPlugin, type: :relation
-      register :translater, Test::MapperPlugin,   type: :mapper
+      register :registration, Test::EnvironmentPlugin, type: :environment
+      register :publisher,    Test::CommandPlugin,     type: :command
+      register :pager,        Test::RelationPlugin,    type: :relation
+      register :translater,   Test::MapperPlugin,      type: :mapper
     end
   end
 
@@ -27,6 +29,10 @@ describe "ROM::PluginRegistry" do
     ROM.instance_variable_set('@plugin_registry', orig_plugins)
   end
 
+  it "makes environment plugins available" do
+    expect(ROM.plugin_registry.environment[:registration].mod).to eq Test::EnvironmentPlugin
+  end
+
   it "includes relation plugins" do
     setup.relation(:users) do
       use :pager

data/spec/unit/rom/relation/composite_spec.rb

@@ -4,6 +4,7 @@ describe ROM::Relation::Composite do
   include_context 'users and tasks'
 
   let(:users) { rom.relation(:users) }
+  let(:tasks) { rom.relation(:tasks) }
 
   let(:name_list) { proc { |r| r.map { |t| t[:name] } } }
   let(:upcaser) { proc { |r| r.map(&:upcase) } }
@@ -15,7 +16,13 @@ describe ROM::Relation::Composite do
       end
 
       def sorted(other)
-        other.sort_by { |t| t[:name] }
+        other.source.order(:name)
+      end
+    end
+
+    setup.relation(:tasks) do
+      def for_users(users)
+        restrict(name: users.map { |u| u[:name] })
       end
     end
   end
@@ -26,6 +33,7 @@ describe ROM::Relation::Composite do
       loaded = relation.call
 
       expect(loaded.source).to eql(users)
+
       expect(loaded).to match_array(%w(JANE JOE))
     end
 
@@ -33,12 +41,26 @@ describe ROM::Relation::Composite do
       relation = users >> users.sorted
       loaded = relation.call
 
-      expect(loaded.source).to eql(users)
+      expect(loaded.source).to eql(users.sorted(users.call))
+
       expect(loaded).to match_array([
         { name: 'Jane', email: 'jane@doe.org' },
         { name: 'Joe', email: 'joe@doe.org' }
       ])
     end
+
+    it 'sends a relation through another composite relation' do
+      task_mapper = -> tasks { tasks }
+      relation = users.by_name('Jane') >> (tasks.for_users >> task_mapper)
+
+      loaded = relation.call
+
+      expect(loaded.source).to eql(tasks.for_users(users.by_name('Jane')))
+
+      expect(loaded).to match_array([
+        { name: 'Jane', title: 'be cool', priority: 2 }
+      ])
+    end
   end
 
   describe '#each' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom
 version: !ruby/object:Gem::Version
-  version: 0.9.0.rc1
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: transproc
@@ -224,6 +224,7 @@ files:
 - spec/integration/mappers/ungroup_spec.rb
 - spec/integration/mappers/unwrap_spec.rb
 - spec/integration/mappers/wrap_spec.rb
+- spec/integration/multi_env_spec.rb
 - spec/integration/multi_repo_spec.rb
 - spec/integration/relations/inheritance_spec.rb
 - spec/integration/relations/reading_spec.rb
@@ -283,9 +284,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5