rom-repository 1.0.0.beta3 → 1.0.0.rc1

data/lib/rom/repository/changeset.rb

@@ -2,37 +2,65 @@ require 'dry/core/class_attributes'
 require 'dry/core/cache'
 
 require 'rom/initializer'
-require 'rom/repository/changeset/pipe'
 
 module ROM
+  # Abstract Changeset class
+  #
+  # If you inherit from this class you need to configure additional settings
+  #
+  # @example define a custom changeset using :upsert command
+  #
+  #   class NewTag < ROM::Changeset[:tags]
+  #     def default_command_type
+  #       :upsert
+  #     end
+  #   end
+  #
+  # @abstract
   class Changeset
+    DEFAULT_COMMAND_OPTS = { mapper: false }.freeze
+
     extend Initializer
     extend Dry::Core::Cache
     extend Dry::Core::ClassAttributes
 
+    # @!method self.command_type
+    #   Get or set changeset command type
+    #
+    #   @overload command_type
+    #     Return configured command_type
+    #     @return [Symbol]
+    #
+    #   @overload command_type(identifier)
+    #     Set relation identifier for this changeset
+    #     @param [Symbol] identifier The command type identifier
+    #     @return [Symbol]
+    defines :command_type
+
+    # @!method self.relation
+    #   Get or set changeset relation identifier
+    #
+    #   @overload relation
+    #     Return configured relation identifier for this changeset
+    #     @return [Symbol]
+    #
+    #   @overload relation(identifier)
+    #     Set relation identifier for this changeset
+    #     @param [Symbol] identifier The relation identifier from the ROM container
+    #     @return [Symbol]
     defines :relation
 
     # @!attribute [r] relation
     #   @return [Relation] The changeset relation
     param :relation
 
-    # @!attribute [r] __data__
-    #   @return [Hash] The relation data
-    option :__data__, reader: true, optional: true, default: proc { nil }
-
-    # @!attribute [r] pipe
-    #   @return [Changeset::Pipe] data transformation pipe
-    option :pipe, reader: true, accept: [Proc, Pipe], default: -> changeset {
-      changeset.class.default_pipe(changeset)
-    }
-
     # @!attribute [r] command_compiler
     #   @return [Proc] a proc that can compile a command (typically provided by a repo)
     option :command_compiler, reader: true, optional: true
 
     # @!attribute [r] command_type
     #   @return [Symbol] a custom command identifier
-    option :command_type, reader: true, optional: true, default: -> changeset { changeset.default_command_type }
+    option :command_type, reader: true, default: -> changeset { changeset.class.command_type }
 
     # Create a changeset class preconfigured for a specific relation
     #
@@ -49,129 +77,24 @@ module ROM
       }
     end
 
-    # Define a changeset mapping
-    #
-    # Subsequent mapping definitions will be composed together
-    # and applied in the order they way defined
-    #
-    # @example Transformation DSL
-    #   class NewUser < ROM::Changeset::Create
-    #     map do
-    #       unwrap :address, prefix: true
-    #     end
-    #   end
-    #
-    # @example Using custom block
-    #   class NewUser < ROM::Changeset::Create
-    #     map do |tuple|
-    #       tuple.merge(created_at: Time.now)
-    #     end
-    #   end
-    #
-    # @example Multiple mappings (executed in the order of definition)
-    #   class NewUser < ROM::Changeset::Create
-    #     map do
-    #       unwrap :address, prefix: true
-    #     end
+    # Return a new changeset with updated options
     #
-    #     map do |tuple|
-    #       tuple.merge(created_at: Time.now)
-    #     end
+    # @example
+    #   class NewUser < ROM::Changeset::Create[:users]
+    #     option :token_generator, reader: true
     #   end
     #
-    # @return [Array<Pipe, Transproc::Function>]
-    #
-    # @api public
-    def self.map(&block)
-      if block.arity.zero?
-        pipes << Class.new(Pipe, &block).new
-      else
-        pipes << Pipe.new(block)
-      end
-    end
-
-    # Build default pipe object
-    #
-    # This can be overridden in a custom changeset subclass
-    #
-    # @return [Pipe]
-    def self.default_pipe(context)
-      pipes.size > 0 ? pipes.map { |p| p.bind(context) }.reduce(:>>) : Pipe.new
-    end
-
-    # @api private
-    def self.inherited(klass)
-      return if klass == ROM::Changeset
-      super
-      klass.instance_variable_set(:@__pipes__, pipes ? pipes.dup : [])
-    end
-
-    # @api private
-    def self.pipes
-      @__pipes__
-    end
-
-    # Pipe changeset's data using custom steps define on the pipe
-    #
-    # @param *steps [Array<Symbol>] A list of mapping steps
-    #
-    # @return [Changeset]
-    #
-    # @api public
-    def map(*steps, &block)
-      if block
-        __data__.map { |*args| yield(*args) }
-      else
-        with(pipe: steps.reduce(pipe) { |a, e| a >> pipe[e] })
-      end
-    end
-
-    # Coerce changeset to a hash
-    #
-    # This will send the data through the pipe
-    #
-    # @return [Hash]
-    #
-    # @api public
-    def to_h
-      pipe.call(__data__)
-    end
-    alias_method :to_hash, :to_h
-
-    # Coerce changeset to an array
-    #
-    # This will send the data through the pipe
-    #
-    # @return [Array]
-    #
-    # @api public
-    def to_a
-      result == :one ? [to_h] : __data__.map { |element| pipe.call(element) }
-    end
-    alias_method :to_ary, :to_a
-
-    # Return a new changeset with updated options
+    #   changeset = user_repo.changeset(NewUser).with(token_generator: my_token_gen)
     #
     # @param [Hash] new_options The new options
     #
     # @return [Changeset]
     #
-    # @api private
+    # @api public
     def with(new_options)
       self.class.new(relation, options.merge(new_options))
     end
 
-    # Return changeset with data
-    #
-    # @param [Hash] data
-    #
-    # @return [Changeset]
-    #
-    # @api public
-    def data(data)
-      with(__data__: data)
-    end
-
     # Persist changeset
     #
     # @example
@@ -186,39 +109,36 @@ module ROM
       command.call
     end
 
-    # Return command result type
+    # Return string representation of the changeset
     #
-    # @return [Symbol]
+    # @return [String]
     #
-    # @api private
-    def result
-      __data__.is_a?(Hash) ? :one : :many
+    # @api public
+    def inspect
+      %(#<#{self.class} relation=#{relation.name.inspect}>)
     end
 
-    private
-
+    # Return a command for this changeset
+    #
+    # @return [ROM::Command]
+    #
     # @api private
-    def respond_to_missing?(meth, include_private = false)
-      super || __data__.respond_to?(meth)
+    def command
+      command_compiler.(command_type, relation_identifier, DEFAULT_COMMAND_OPTS).new(relation)
     end
 
+    private
+
     # @api private
-    def method_missing(meth, *args, &block)
-      if __data__.respond_to?(meth)
-        response = __data__.__send__(meth, *args, &block)
-
-        if response.is_a?(__data__.class)
-          with(__data__: response)
-        else
-          response
-        end
-      else
-        super
-      end
+    def relation_identifier
+      relation.name.relation
     end
   end
 end
 
+require 'rom/repository/changeset/stateful'
+require 'rom/repository/changeset/associated'
+
 require 'rom/repository/changeset/create'
 require 'rom/repository/changeset/update'
 require 'rom/repository/changeset/delete'

data/lib/rom/repository/class_interface.rb

@@ -38,7 +38,7 @@ module ROM
       # Define which relations your repository is going to use
       #
       # @example
-      #   class MyRepo < ROM::Repository::Base
+      #   class MyRepo < ROM::Repository
       #     relations :users, :tasks
       #   end
       #
@@ -83,7 +83,7 @@ module ROM
       #     commands :create, mapper: :my_custom_mapper
       #   end
       #
-      # @param *names [Array<Symbol>] A list of command names
+      # @param [Array<Symbol>] names A list of command names
       # @option :mapper [Symbol] An optional mapper identifier
       # @option :use [Symbol] An optional command plugin identifier
       #
@@ -113,7 +113,7 @@ module ROM
       # @api private
       def define_command_method(type, **opts)
         define_method(type) do |input|
-          if input.is_a?(Changeset)
+          if input.respond_to?(:commit)
             map_tuple(input.relation, input.commit)
           else
             command(type => self.class.root, **opts).call(input)
@@ -131,7 +131,7 @@ module ROM
 
             changeset = input.first
 
-            if changeset.is_a?(Changeset)
+            if changeset.respond_to?(:commit)
               map_tuple(changeset.relation, changeset.commit)
             else
               command(type => self.class.root, **opts)

data/lib/rom/repository/command_compiler.rb

@@ -26,13 +26,15 @@ module ROM
       # in repositories. It might be worth looking into removing this requirement
       # from rom core Command::Graph API.
       #
-      # @param container [ROM::Container] container where relations are stored
-      # @param type [Symbol] The type of command
-      # @param adapter [Symbol] The adapter identifier
-      # @param ast [Array] The AST representation of a relation
-      # @param plugins [Array<Symbol>] A list of optional command plugins that should be used
+      # @overload [](container, type, adapter, ast, plugins, options)
       #
-      # @return [Command, CommandProxy]
+      #   @param container [ROM::Container] container where relations are stored
+      #   @param type [Symbol] The type of command
+      #   @param adapter [Symbol] The adapter identifier
+      #   @param ast [Array] The AST representation of a relation
+      #   @param plugins [Array<Symbol>] A list of optional command plugins that should be used
+      #
+      #   @return [Command, CommandProxy]
       #
       # @api private
       def self.[](*args)
@@ -112,24 +114,24 @@ module ROM
         name, meta, header = node
         other = visit(header, name)
 
-        mapping =
-          if meta[:combine_type] == :many
-            name
-          else
-            { Dry::Core::Inflector.singularize(name).to_sym => name }
-          end
-
         if type
           register_command(name, type, meta, parent_relation)
 
+          mapping =
+            if meta[:combine_type] == :many
+              name
+            else
+              { Dry::Core::Inflector.singularize(name).to_sym => name }
+            end
+
           if other.size > 0
             [mapping, [type, other]]
           else
             [mapping, type]
           end
         else
-          registry[name][id] = container.commands[name][id].with(options)
-          [mapping, id]
+          registry[name][id] = container.commands[name][id]
+          [name, id]
         end
       end
 

data/lib/rom/repository/command_proxy.rb

@@ -4,6 +4,8 @@ module ROM
   class Repository
     # TODO: look into making command graphs work without the root key in the input
     #       so that we can get rid of this wrapper
+    #
+    # @api private
     class CommandProxy
       attr_reader :command, :root
 

data/lib/rom/repository/relation_proxy/combine.rb

@@ -48,8 +48,6 @@ module ROM
         #     @option :many [Hash] Sets options for "has-many" type of association
         #     @option :one [Hash] Sets options for "has-one/belongs-to" type of association
         #
-        # @param [Hash] options
-        #
         # @return [RelationProxy]
         #
         # @api public
@@ -190,8 +188,9 @@ module ROM
         # used to get the keys. Otherwise we fall back to using default keys based
         # on naming conventions.
         #
-        # @param [RelationProxy] relation
-        # @param [Symbol] type The type can be either :parent or :children
+        # @param [Relation::Name] source The source relation name
+        # @param [Relation::Name] target The target relation name
+        # @param [Symbol] type The association type, can be either :parent or :children
         #
         # @return [Hash<Symbol=>Symbol>]
         #

data/lib/rom/repository/relation_proxy.rb

@@ -52,8 +52,21 @@ module ROM
 
       # Maps the wrapped relation with other mappers available in the registry
       #
-      # @param *names [Array<Symbol, Class>] Either a list of mapper identifiers
-      #                                      or a custom model class
+      # @overload map_with(model)
+      #   Map tuples to the provided custom model class
+      #
+      #   @example
+      #     users.as(MyUserModel)
+      #
+      #   @param [Class>] model Your custom model class
+      #
+      # @overload map_with(*mappers)
+      #   Map tuples using registered mappers
+      #
+      #   @example
+      #     users.as(MyUserModel)
+      #
+      #   @param [Array<Symbol>] mappers A list of mapper identifiers
       #
       # @return [RelationProxy] A new relation proxy with pipelined relation
       #
@@ -67,6 +80,15 @@ module ROM
       end
       alias_method :as, :map_with
 
+      # Return a string representation of this relation proxy
+      #
+      # @return [String]
+      #
+      # @api public
+      def inspect
+        %(#<#{relation.class} name=#{name} dataset=#{dataset.inspect}>)
+      end
+
       # Infers a mapper for the wrapped relation
       #
       # @return [ROM::Mapper]
@@ -136,11 +158,6 @@ module ROM
         relation.respond_to?(meth) || super
       end
 
-      # @api public
-      def inspect
-        %(#<#{relation.class} name=#{name} dataset=#{dataset.inspect}>)
-      end
-
       private
 
       # @api private

data/lib/rom/repository/root.rb

@@ -31,6 +31,19 @@ module ROM
     class Root < Repository
       extend Dry::Core::ClassAttributes
 
+      # @!method self.root
+      #   Get or set repository root relation identifier
+      #
+      #   This method is automatically used when you define a class using
+      #   MyRepo[:rel_identifier] shortcut
+      #
+      #   @overload root
+      #     Return root relation identifier
+      #     @return [Symbol]
+      #
+      #   @overload root(identifier)
+      #     Set root relation identifier
+      #     @return [Symbol]
       defines :root
 
       # @!attribute [r] root
@@ -131,7 +144,7 @@ module ROM
       #
       #   @return [Changeset]
       #
-      # @override Repository#changeset
+      # @see Repository#changeset
       #
       # @api public
       def changeset(*args)

data/lib/rom/repository/session.rb

@@ -1,6 +1,9 @@
 require 'dry/equalizer'
 
 module ROM
+  # TODO: finish this in 1.1.0
+  #
+  # @api private
   class Session
     include Dry::Equalizer(:queue, :status)
 

data/lib/rom/repository/struct_builder.rb

@@ -3,7 +3,7 @@ require 'dry/core/cache'
 require 'dry/core/class_builder'
 
 require 'rom/struct'
-require 'rom/schema/type'
+require 'rom/schema/attribute'
 
 module ROM
   class Repository

data/lib/rom/repository/version.rb

@@ -1,5 +1,5 @@
 module ROM
   class Repository
-    VERSION = '1.0.0.beta3'.freeze
+    VERSION = '1.0.0.rc1'.freeze
   end
 end