rom-core 4.0.0.beta1 → 4.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef15d608c1f83a62e5fda73922905f3ea6b4ac64
-  data.tar.gz: 0756e26ace05072f5717d47f7738e21a43e322c7
+  metadata.gz: 9ea3d114fd7800efddd98a8efe19a01586625c9f
+  data.tar.gz: 59a3cc776cfd019cd54583caf4ef8ee759d90f09
 SHA512:
-  metadata.gz: 46aecaac6f9e294a7acbadd9dcd5b5c56a2b08a4bd62e15b6d408089b1ab130149a7f9d02000d78b83ed41947d0e04648be6ae30c6591428db59e3b84615d2c1
-  data.tar.gz: 8f6c5783b58df407395d2c25e1b3389c4b011d49922a9c73cd2f8e613c7464ce5122a03ddccc4311844e28adeac37e5893fcbc893277cb93805cdecd47a71aa3
+  metadata.gz: 4349071ed68f65de26faf701b930653f56be802e14f63b82510d04c091ad0a7d0687eb23bb0e6a22b6330d6f83ec32184811701d29cd41934140d10c00ec54e6
+  data.tar.gz: 31885902cc6c78cf78c2f1357ee76edcf082eea550deaa293588029534a68e09d01c6a31ef14bd7e09523ad7678344184b2e3eec8f384a767ff11c94f5948f1f

data/CHANGELOG.md

@@ -28,6 +28,8 @@ Previous `rom` gem was renamed to `rom-core`
 * [BREAKING] `Relation#as` now returns a new relation with aliased name, use `Relation#map_with(*list-of-mapper-ids)` or `Relation#map_to(model)` if you just want to map to custom models (solnic)
 * [BREAKING] `Relation.register_as(:bar)` is removed in favor of `schema(:foo, as: :bar)` (solnic)
 * [BREAKING] `Relation.dataset(:foo)` is removed in favor of `schema(:foo)`. Passing a block still works like before (solnic)
+* [BREAKING] `CommandRegistry#try` is removed (solnic)
+* [BREAKING] `Command#with` changed behavior, use `Command#curry` instead (solnic)
 * Separation between relations that are standalone or registrable in a registry is gone. All relations have names and schemas now.
   They are automatically set to defaults. In practice this means you can instantiate a relation object manually and it'll Just Work (solnic)
 * Mapper and command objects are cached locally within a given rom container (solnic)

data/lib/rom/command.rb

@@ -23,13 +23,14 @@ module ROM
   #
   # @api public
   class Command
+    extend Dry::Core::ClassAttributes
     extend Initializer
+    extend ClassInterface
+
     include Dry::Equalizer(:relation, :options)
     include Commands
     include Pipeline::Operator
 
-    extend Dry::Core::ClassAttributes
-    extend ClassInterface
 
     # @!method self.adapter
     #   Get or set adapter identifier
@@ -316,7 +317,6 @@ module ROM
         self.class.build(relation, **options, curry_args: args)
       end
     end
-    alias_method :with, :curry
 
     # Compose this command with other commands
     #
@@ -338,17 +338,6 @@ module ROM
       curry_args.size > 0
     end
 
-    # Return a new command with new options
-    #
-    # @param [Hash] new_opts A hash with new options
-    #
-    # @return [Command]
-    #
-    # @api public
-    def with_opts(new_opts)
-      self.class.new(relation, options.merge(new_opts))
-    end
-
     # Return a new command with appended before hooks
     #
     # @param [Array<Hash>] hooks A list of before hooks configurations

data/lib/rom/command_registry.rb

@@ -2,15 +2,12 @@ require 'concurrent/map'
 
 require 'rom/constants'
 require 'rom/registry'
-require 'rom/commands/result'
 
 module ROM
   # Specialized registry class for commands
   #
   # @api public
   class CommandRegistry < Registry
-    include Commands
-
     # Internal command registry
     #
     # @return [Registry]
@@ -35,31 +32,6 @@ module ROM
       CommandNotFoundError
     end
 
-    # Try to execute a command in a block
-    #
-    # @yield [command] Passes command to the block
-    #
-    # @example
-    #
-    #   rom.commands[:users].try { create(name: 'Jane') }
-    #   rom.commands[:users].try { update(:by_id, 1).call(name: 'Jane Doe') }
-    #   rom.commands[:users].try { delete(:by_id, 1) }
-    #
-    # @return [Commands::Result]
-    #
-    # @api public
-    def try(&block)
-      response = block.call
-
-      if response.is_a?(Command) || response.is_a?(Composite)
-        try { response.call }
-      else
-        Result::Success.new(response)
-      end
-    rescue CommandError => e
-      Result::Failure.new(e)
-    end
-
     # Return a command from the registry
     #
     # If mapper is set command will be turned into a composite command with

data/lib/rom/commands/graph.rb

@@ -39,8 +39,8 @@ module ROM
       #   create_task = rom.commands[:tasks].create
       #
       #   command = create_user
-      #     .with(name: 'Jane')
-      #     .combine(create_task.with(title: 'Task'))
+      #     .curry(name: 'Jane')
+      #     .combine(create_task.curry(title: 'Task'))
       #
       #   command.call
       #

data/lib/rom/commands/graph/class_interface.rb

@@ -44,7 +44,7 @@ module ROM
           tuple_path = Array[*path] << key
           input_proc = InputEvaluator.build(tuple_path, nodes)
 
-          command = command.with(input_proc, opts)
+          command = command.curry(input_proc, opts)
 
           if nodes
             if nodes.all? { |node| node.is_a?(Array) }

data/lib/rom/relation.rb

@@ -15,7 +15,7 @@ require 'rom/command_registry'
 require 'rom/relation/loaded'
 require 'rom/relation/curried'
 require 'rom/relation/composite'
-require 'rom/relation/graph'
+require 'rom/relation/combined'
 require 'rom/relation/wrap'
 require 'rom/relation/materializable'
 require 'rom/relation/commands'
@@ -172,17 +172,6 @@ module ROM
       end
     end
 
-    # Composes with other relations
-    #
-    # @param [Array<Relation>] others The other relation(s) to compose with
-    #
-    # @return [Relation::Graph]
-    #
-    # @api public
-    def graph(*others)
-      Graph.build(self, others)
-    end
-
     # Combine with other relations
     #
     # @overload combine(*associations)
@@ -196,21 +185,34 @@ module ROM
     #
     # @api public
     def combine(*args)
-      graph(*nodes(*args))
+      combine_with(*nodes(*args))
+    end
+
+    # Composes with other relations
+    #
+    # @param [Array<Relation>] others The other relation(s) to compose with
+    #
+    # @return [Relation::Graph]
+    #
+    # @api public
+    def combine_with(*others)
+      Combined.new(self, others)
     end
 
     # @api private
     def nodes(*args)
-      args.map do |arg|
+      args.reduce([]) do |acc, arg|
         case arg
         when Symbol
-          node(arg)
+          acc << node(arg)
         when Hash
-          arg.reduce(self) { |r, (k, v)| r.node(k).combine(*v) }
+          acc << arg.reduce(self) do |root, (name, *opts)|
+            root.node(name).combine(*opts)
+          end
         when Array
-          arg.map { |opts| nodes(opts) }
+          acc.concat(arg.map { |opts| nodes(opts) }.reduce(:concat))
         end
-      end.flatten(0)
+      end
     end
 
     # @api public
@@ -236,18 +238,27 @@ module ROM
       assoc.preload(self, other)
     end
 
-    # Wrap other relations
+    # Wrap other relations using association names
     #
     # @example
     #   tasks.wrap(:owner)
     #
     # @param [Hash] options
     #
-    # @return [RelationProxy]
+    # @return [Relation]
     #
     # @api public
     def wrap(*names)
-      wrap_class.new(self, names.map { |n| associations[n].wrap })
+      wrap_around(*names.map { |n| associations[n].wrap })
+    end
+
+    # Wrap around other relations
+    #
+    # @return [Relation::Wrap]
+    #
+    # @api public
+    def wrap_around(*others)
+      wrap_class.new(self, others)
     end
 
     # Loads relation
@@ -431,7 +442,7 @@ module ROM
     #
     #   @param [Array<Symbol>] mappers A list of mapper identifiers
     #
-    # @return [RelationProxy] A new relation proxy with pipelined relation
+    # @return [Relation] A new relation proxy with pipelined relation
     #
     # @api public
     def map_with(*names, **opts)

data/lib/rom/relation/class_interface.rb

@@ -95,15 +95,15 @@ module ROM
 
           @relation_name = Name[relation, ds_name]
 
-          dsl = schema_dsl.new(
-            relation_name,
-            schema_class: schema_class,
-            attr_class: schema_attr_class,
-            inferrer: schema_inferrer.with(enabled: infer),
-            &block
-          )
-
-          @schema_proc = dsl.method(:call).to_proc
+          @schema_proc = proc do |*args, &inner_block|
+            schema_dsl.new(
+              relation_name,
+              schema_class: schema_class,
+              attr_class: schema_attr_class,
+              inferrer: schema_inferrer.with(enabled: infer),
+              &block
+            ).call(*args, &inner_block)
+          end
         end
       end
 

data/lib/rom/relation/combined.rb

@@ -0,0 +1,116 @@
+require 'rom/relation/graph'
+require 'rom/relation/commands'
+
+module ROM
+  class Relation
+    # Represents a relation graphs which combines root relation
+    # with other relation nodes
+    #
+    # @api public
+    class Combined < Graph
+      include Commands
+
+      # Create a new relation combined with others
+      #
+      # @param [Relation] root
+      # @param [Array<Relation>] nodes
+      #
+      # @return [Combined]
+      #
+      # @api public
+      def self.new(root, nodes)
+        root_ns = root.options[:struct_namespace]
+        super(root, nodes.map { |node| node.struct_namespace(root_ns) })
+      end
+
+      # Combine this graph with more nodes
+      #
+      # @param [Array<Relation::Lazy>]
+      #
+      # @return [Graph]
+      #
+      # @api public
+      def combine_with(*others)
+        self.class.new(root, nodes + others)
+      end
+
+      # @api public
+      # @see Relation#combine
+      def combine(*args)
+        self.class.new(root, nodes + root.combine(*args).nodes)
+      end
+
+      # Materialize combined relation
+      #
+      # @return [Loaded]
+      #
+      # @api public
+      def call(*args)
+        left = root.with(auto_struct: false).call(*args)
+
+        right =
+          if left.empty?
+            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }
+          else
+            nodes.map { |node| node.call(left) }
+          end
+
+        if auto_map?
+          Loaded.new(self, mapper.([left, right]))
+        else
+          Loaded.new(self, [left, right])
+        end
+      end
+
+      # Return a new combined relation with adjusted node returned from a block
+      #
+      # @example with a node identifier
+      #   aggregate(:tasks).node(:tasks) { |tasks| tasks.prioritized }
+      #
+      # @example with a nested path
+      #   aggregate(tasks: :tags).node(tasks: :tags) { |tags| tags.where(name: 'red') }
+      #
+      # @param [Symbol] name The node relation name
+      #
+      # @yieldparam [Relation] The relation node
+      # @yieldreturn [Relation] The new relation node
+      #
+      # @return [Relation]
+      #
+      # @api public
+      def node(name, &block)
+        if name.is_a?(Symbol) && !nodes.map { |n| n.name.key }.include?(name)
+          raise ArgumentError, "#{name.inspect} is not a valid aggregate node name"
+        end
+
+        new_nodes = nodes.map { |node|
+          case name
+          when Symbol
+            name == node.name.key ? yield(node) : node
+          when Hash
+            other, *rest = name.flatten(1)
+            if other == node.name.key
+              nodes.detect { |n| n.name.key == other }.node(*rest, &block)
+            else
+              node
+            end
+          else
+            node
+          end
+        }
+
+        with_nodes(new_nodes)
+      end
+
+      # @api public
+      def to_ast
+        [:relation, [name.to_sym, attr_ast + node_ast, meta_ast]]
+      end
+
+      # @api private
+      def node_ast
+        nodes.map(&:to_ast)
+      end
+    end
+  end
+end

data/lib/rom/relation/curried.rb

@@ -1,3 +1,5 @@
+require 'dry/equalizer'
+
 require 'rom/types'
 require 'rom/initializer'
 require 'rom/pipeline'
@@ -9,6 +11,7 @@ module ROM
     class Curried
       extend Initializer
 
+      include Dry::Equalizer(:relation, :options)
       include Materializable
       include Pipeline
 

data/lib/rom/relation/graph.rb

@@ -1,45 +1,39 @@
+require 'dry/equalizer'
+
+require 'rom/initializer'
+
 require 'rom/relation/loaded'
 require 'rom/relation/composite'
 require 'rom/relation/materializable'
-require 'rom/relation/commands'
 require 'rom/pipeline'
 
 module ROM
   class Relation
-    # Compose relations using join-keys
-    #
-    # @example
-    #   class Users < ROM::Relation[:memory]
-    #   end
-    #
-    #   class Tasks < ROM::Relation[:memory]
-    #     def for_users(users)
-    #       restrict(user: users.map { |user| user[:name] })
-    #     end
-    #   end
-    #
-    #   rom.relations[:users] << { name: 'Jane' }
-    #   rom.relations[:tasks] << { user: 'Jane', title: 'Do something' }
-    #
-    #   rom.relations[:users].combine(rom.relations[:tasks].for_users)
+    # Abstract relation graph class
     #
     # @api public
     class Graph
+      extend Initializer
+
+      param :root
+
+      param :nodes
+
+      include Dry::Equalizer(:root, :nodes)
       include Materializable
-      include Commands
       include Pipeline
       include Pipeline::Proxy
 
       # Root aka parent relation
       #
-      # @return [Relation::Lazy]
+      # @return [Relation]
       #
       # @api private
       attr_reader :root
 
       # Child relation nodes
       #
-      # @return [Array<Relation::Lazy>]
+      # @return [Array<Relation>]
       #
       # @api private
       attr_reader :nodes
@@ -47,23 +41,6 @@ module ROM
       alias_method :left, :root
       alias_method :right, :nodes
 
-      # @api private
-      def self.build(root, nodes)
-        if nodes.any? { |node| node.instance_of?(Composite) }
-          raise UnsupportedRelationError,
-            "Combining with composite relations is not supported"
-        else
-          new(root, nodes)
-        end
-      end
-
-      # @api private
-      def initialize(root, nodes)
-        root_ns = root.options[:struct_namespace]
-        @root = root
-        @nodes = nodes.map { |node| node.struct_namespace(root_ns) }
-      end
-
       # @api public
       def with_nodes(nodes)
         self.class.new(root, nodes)
@@ -78,44 +55,6 @@ module ROM
         true
       end
 
-      # Combine this graph with more nodes
-      #
-      # @param [Array<Relation::Lazy>]
-      #
-      # @return [Graph]
-      #
-      # @api public
-      def graph(*others)
-        self.class.new(root, nodes + others)
-      end
-
-      # @api public
-      def combine(*args)
-        self.class.new(root, nodes + root.combine(*args).nodes)
-      end
-
-      # Materialize this relation graph
-      #
-      # @return [Loaded]
-      #
-      # @api public
-      def call(*args)
-        left = root.with(auto_struct: false).call(*args)
-
-        right =
-          if left.empty?
-            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }
-          else
-            nodes.map { |node| node.call(left) }
-          end
-
-        if auto_map?
-          Loaded.new(self, mapper.([left, right]))
-        else
-          Loaded.new(self, [left, right])
-        end
-      end
-
       # @api public
       def map_with(*args)
         self.class.new(root.map_with(*args), nodes)
@@ -126,56 +65,6 @@ module ROM
         self.class.new(root.map_to(klass), nodes)
       end
 
-      # Return a new graph with adjusted node returned from a block
-      #
-      # @example with a node identifier
-      #   aggregate(:tasks).node(:tasks) { |tasks| tasks.prioritized }
-      #
-      # @example with a nested path
-      #   aggregate(tasks: :tags).node(tasks: :tags) { |tags| tags.where(name: 'red') }
-      #
-      # @param [Symbol] name The node relation name
-      #
-      # @yieldparam [RelationProxy] The relation node
-      # @yieldreturn [RelationProxy] The new relation node
-      #
-      # @return [RelationProxy]
-      #
-      # @api public
-      def node(name, &block)
-        if name.is_a?(Symbol) && !nodes.map { |n| n.name.key }.include?(name)
-          raise ArgumentError, "#{name.inspect} is not a valid aggregate node name"
-        end
-
-        new_nodes = nodes.map { |node|
-          case name
-          when Symbol
-            name == node.name.key ? yield(node) : node
-          when Hash
-            other, *rest = name.flatten(1)
-            if other == node.name.key
-              nodes.detect { |n| n.name.key == other }.node(*rest, &block)
-            else
-              node
-            end
-          else
-            node
-          end
-        }
-
-        with_nodes(new_nodes)
-      end
-
-      # @api public
-      def to_ast
-        [:relation, [name.to_sym, attr_ast + node_ast, meta_ast]]
-      end
-
-      # @api private
-      def node_ast
-        nodes.map(&:to_ast)
-      end
-
       # @api private
       def mapper
         mappers[to_ast]

data/lib/rom/relation/loaded.rb

@@ -1,3 +1,5 @@
+require 'dry/equalizer'
+
 module ROM
   class Relation
     # Materializes a relation and exposes interface to access the data
@@ -5,6 +7,7 @@ module ROM
     # @api public
     class Loaded
       include Enumerable
+      include Dry::Equalizer(:source, :collection)
 
       # Coerce loaded relation to an array
       #

data/lib/rom/relation/wrap.rb

@@ -1,15 +1,11 @@
-require 'rom/initializer'
-require 'rom/relation/loaded'
-require 'rom/relation/composite'
-require 'rom/relation/materializable'
-require 'rom/pipeline'
+require 'rom/relation/graph'
 
 module ROM
   class Relation
     # Relation wrapping other relations
     #
     # @api public
-    class Wrap
+    class Wrap < Graph
       extend Initializer
 
       include Materializable
@@ -58,11 +54,6 @@ module ROM
         nodes.map(&:to_ast)
       end
 
-      # @api private
-      def mapper
-        mappers[to_ast]
-      end
-
       # Return if this is a wrap relation
       #
       # @return [true]
@@ -71,13 +62,6 @@ module ROM
       def wrap?
         true
       end
-
-      private
-
-      # @api private
-      def decorate?(other)
-        super || other.is_a?(Composite) || other.is_a?(Curried)
-      end
     end
   end
 end

data/lib/rom/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Core
-    VERSION = '4.0.0.beta1'.freeze
+    VERSION = '4.0.0.beta2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-core
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta1
+  version: 4.0.0.beta2
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -180,7 +180,6 @@ files:
 - lib/rom/commands/lazy/create.rb
 - lib/rom/commands/lazy/delete.rb
 - lib/rom/commands/lazy/update.rb
-- lib/rom/commands/result.rb
 - lib/rom/commands/update.rb
 - lib/rom/configuration.rb
 - lib/rom/configuration_dsl.rb
@@ -230,6 +229,7 @@ files:
 - lib/rom/registry.rb
 - lib/rom/relation.rb
 - lib/rom/relation/class_interface.rb
+- lib/rom/relation/combined.rb
 - lib/rom/relation/commands.rb
 - lib/rom/relation/composite.rb
 - lib/rom/relation/curried.rb

data/lib/rom/commands/result.rb

@@ -1,96 +0,0 @@
-module ROM
-  module Commands
-    # Abstract result class for success and error results
-    #
-    # @api public
-    class Result
-      # Return command execution result
-      #
-      # @api public
-      attr_reader :value
-
-      # Return potential command execution result error
-      #
-      # @api public
-      attr_reader :error
-
-      # Coerce result to an array
-      #
-      # @abstract
-      #
-      # @api public
-      def to_ary
-        raise NotImplementedError
-      end
-      alias_method :to_a, :to_ary
-
-      # Return true if command successful
-      #
-      # @api public
-      def success?
-        is_a?(Success)
-      end
-
-      # Return true if command failed
-      #
-      # @api public
-      def failure?
-        is_a?(Failure)
-      end
-
-      # Success result has a value and no error
-      #
-      # @api public
-      class Success < Result
-        # @api private
-        def initialize(value)
-          @value = value.is_a?(self.class) ? value.value : value
-        end
-
-        # Call next command on continuation
-        #
-        # @api public
-        def >(other)
-          other.call(value)
-        end
-
-        # Return the value
-        #
-        # @return [Array]
-        #
-        # @api public
-        def to_ary
-          value.to_ary
-        end
-      end
-
-      # Failure result has an error and no value
-      #
-      # @api public
-      class Failure < Result
-        # @api private
-        def initialize(error)
-          @error = error
-        end
-
-        # Do not call next command on continuation
-        #
-        # @return [self]
-        #
-        # @api public
-        def >(_other)
-          self
-        end
-
-        # Return the error
-        #
-        # @return [Array<CommandError>]
-        #
-        # @api public
-        def to_ary
-          error
-        end
-      end
-    end
-  end
-end