rom-repository 1.4.0 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60e1932a1540f3a5db52bbb5a4ae073b83ee0289
-  data.tar.gz: 8a430f76a00792c4d12d94d8271b0736310dc20b
+  metadata.gz: 748ea9ec748c486d611e4ac107cf338362a76b51
+  data.tar.gz: 111dd4763fbe363d22e4fe0179e52c3a0d343531
 SHA512:
-  metadata.gz: 514906df2e8c7c3b33fb3cce5083d65f4b238ca1aa7ca03df9d736f0ceb4752b610d66937e372645cc0f71dd7a0d845cbcdeca27a69a8ca13a367bf75a42b3e8
-  data.tar.gz: a75e84fd982d615e4f57802a130658d5d0482c62bf0216f6cf70c6c348c4b99d50561cdcd33de73f6b7ff3700fc15702d4023711b2fe0c0c599b184dc45a77b4
+  metadata.gz: 4027a4c8fd3cacfb40a6f0ffe99bae2d88b0e98cd3a8993ef83b6a07e2fac9510e528578b71a1abb673dea61e9dd93b832406a002d7b80e457d1abfc66174549
+  data.tar.gz: 5f45222483b70724de8837fa0e2d3cb87737f5acf6944fbccd3c26fc110dd2b5c9d52a76082902a29d3d96a17a8053c131af62214bcb56412ddb74662843871d

data/CHANGELOG.md

@@ -1,17 +1,25 @@
-# v1.4.0 2017-07-04
+# v2.0.0 to-be-released
 
-### Added
+### Changed
+
+* [BREAKING] `Relation#combine` no longer works with arbitrary `many` and `one` options. Configure associations instead and use their identifiers as arguments (solnic)
+* [BREAKING] `Relation#combine_parents` was removed (solnic)
+* [BREAKING] `Relation#combine_children` was removed (solnic)
+* [BREAKING] `Relation#wrap_parent` was removed, configure associations and use their identifiers in `wrap` instead (solnic)
+* [BREAKING] `Repository#command` was removed in favor of `Relation#command` (solnic)
 
-* `Relation#map_to` available in repository relations to ease upgrade to rom 4.0 (solnic)
-* Deprecation warnings in preparation for rom 4.0 release (solnic)
+### Internal
 
-[Compare v1.3.3...v1.3.4](https://github.com/rom-rb/rom-repository/compare/v1.3.3...v1.3.4)
+* `RelationProxy` was removed as its functionality was ported and improved in rom-core (solnic)
 
 # v1.3.3 2017-05-31
 
 ### Added
 
-* `Changeset#extend` to exclude steps from the `#diff` output, this allows to filter out timestamp changes prior to updates so that we can avoid hitting the database in case of timestamp-only changes. You still can call `.map(:touch)` if you want to have `updated_at` refreshed unconditionally (flash-gordon)
+* `Changeset#extend` to exclude steps from the `#diff` output, this allows
+  to filter out timestamp changes prior to updates so that we can avoid
+  hitting the database in case of timestamp-only changes. You still can call `.map(:touch)`
+  if you want to have `updated_at` refreshed unconditionally (flash-gordon)
 
 ## Fixed
 

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Piotr Solnica
+Copyright (c) 2014-2017 Piotr Solnica
 
 MIT License
 

data/README.md

@@ -1 +1,18 @@
-# This project was moved to [rom-rb/rom](https://github.com/rom-rb/rom/tree/master/repository)
+[gem]: https://rubygems.org/gems/rom-repository
+[gemnasium]: https://gemnasium.com/rom-rb/rom-repository
+
+# rom-repository
+
+[![Gem Version](https://badge.fury.io/rb/rom-repository.svg)][gem]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-repository.svg)][gemnasium]
+
+Repositories for [rom-rb](https://github.com/rom-rb/rom) with auto-mapping, changesets and commands.
+
+Resources:
+
+* [User documentation](http://rom-rb.org/learn/repositories)
+* [API documentation](http://rubydoc.info/gems/rom-repository)
+
+## License
+
+See `LICENSE` file.

data/lib/rom-repository.rb

@@ -1,3 +1,2 @@
-require 'rom'
-
+require 'rom/core'
 require 'rom/repository'

data/lib/rom/repository.rb

@@ -2,11 +2,6 @@ require 'dry/core/deprecations'
 
 require 'rom/initializer'
 require 'rom/repository/class_interface'
-require 'rom/repository/mapper_builder'
-require 'rom/repository/relation_proxy'
-require 'rom/repository/command_compiler'
-
-require 'rom/repository/changeset'
 require 'rom/repository/session'
 
 module ROM
@@ -55,13 +50,6 @@ module ROM
   #
   # @api public
   class Repository
-    # Mapping for supported changeset classes used in #changeset(type => relation) method
-    CHANGESET_TYPES = {
-      create: Changeset::Create,
-      update: Changeset::Update,
-      delete: Changeset::Delete
-    }.freeze
-
     extend ClassInterface
     extend Initializer
     extend Dry::Core::ClassAttributes
@@ -86,6 +74,11 @@ module ROM
     #   Get or set struct namespace
     defines :struct_namespace
 
+    # @!method self.relation_reader
+    #   Get or set relation reader module
+    #   @return [RelationReader]
+    defines :relation_reader
+
     struct_namespace ROM::Struct
 
     # @!attribute [r] container
@@ -104,175 +97,15 @@ module ROM
     #   @return [RelationRegistry] The relation proxy registry used by a repo
     attr_reader :relations
 
-    # @!attribute [r] mappers
-    #   @return [MapperBuilder] The auto-generated mappers for repo relations
-    attr_reader :mappers
-
-    # @!attribute [r] commmand_compiler
-    #   @return [Method] Function for compiling commands bound to a repo instance
-    attr_reader :command_compiler
-
     # Initializes a new repo by establishing configured relation proxies from
     # the passed container
     #
     # @param container [ROM::Container] The rom container with relations and optional commands
     #
-    # @api public
-    def initialize(container, opts = EMPTY_HASH)
+    # @api private
+    def initialize(container, options = EMPTY_HASH)
       super
-
-      @mappers = MapperBuilder.new(struct_namespace: struct_namespace)
-
-      @relations = RelationRegistry.new do |registry, relations|
-        self.class.relations.each do |name|
-          relation = container.relations[name]
-          relation = relation.with(mappers: container.mappers[name]) if container.mappers.key?(name)
-
-          proxy = RelationProxy.new(
-            relation, name: name, mappers: mappers, registry: registry, auto_struct: auto_struct
-          )
-
-          instance_variable_set("@#{name}", proxy)
-
-          relations[name] = proxy
-        end
-      end
-
-      @command_compiler = method(:command)
-    end
-
-    # Return a command for a relation
-    #
-    # @overload command(type, relation)
-    #   Returns a command for a relation
-    #
-    #   @example
-    #     repo.command(:create, repo.users)
-    #
-    #   @param type [Symbol] The command type (:create, :update or :delete)
-    #   @param relation [RelationProxy] The relation for which command should be built for
-    #
-    # @overload command(options)
-    #   Builds a command for a given relation identifier
-    #
-    #   @example
-    #     repo.command(create: :users)
-    #
-    #   @param options [Hash<Symbol=>Symbol>] A type => rel_name map
-    #
-    # @overload command(rel_name)
-    #   Returns command registry for a given relation identifier
-    #
-    #   @example
-    #     repo.command(:users)[:my_custom_command]
-    #
-    #   @param rel_name [Symbol] The relation identifier from the container
-    #
-    #   @return [CommandRegistry]
-    #
-    # @overload command(rel_name, &block)
-    #   Yields a command graph composer for a given relation identifier
-    #
-    #   @param rel_name [Symbol] The relation identifier from the container
-    #
-    # @return [ROM::Command]
-    #
-    # @api public
-    def command(*args, **opts, &block)
-      all_args = args + opts.to_a.flatten
-
-      if all_args.size > 1
-        commands.fetch_or_store(all_args.hash) do
-          compile_command(*args, **opts)
-        end
-      else
-        container.command(*args, &block)
-      end
-    end
-
-    # Return a changeset for a relation
-    #
-    # @overload changeset(name, attributes)
-    #   Return a create changeset for a given relation identifier
-    #
-    #   @example
-    #     repo.changeset(:users, name: "Jane")
-    #
-    #   @param name [Symbol] The relation container identifier
-    #   @param attributes [Hash]
-    #
-    #   @return [Changeset::Create]
-    #
-    # @overload changeset(name, primary_key, attributes)
-    #   Return an update changeset for a given relation identifier
-    #
-    #   @example
-    #     repo.changeset(:users, 1, name: "Jane Doe")
-    #
-    #   @param name [Symbol] The relation container identifier
-    #   @param restriction_arg [Object] The argument passed to restricted view
-    #
-    #   @return [Changeset::Update]
-    #
-    # @overload changeset(changeset_class)
-    #   Return a changeset object using provided class
-    #
-    #   @example
-    #     repo.changeset(NewUserChangeset).data(attributes)
-    #
-    #   @param [Class] changeset_class Custom changeset class
-    #
-    #   @return [Changeset]
-    #
-    # @overload changeset(opts)
-    #   Return a changeset object using provided changeset type and relation
-    #
-    #   @example
-    #     repo.changeset(delete: repo.users.where { id > 10 })
-    #
-    #   @param [Hash<Symbol=>Relation] opts Command type => Relation config
-    #
-    #   @return [Changeset]
-    #
-    # @api public
-    def changeset(*args)
-      opts = { command_compiler: command_compiler }
-
-      if args.size == 2
-        name, data = args
-      elsif args.size == 3
-        name, pk, data = args
-      elsif args.size == 1
-        if args[0].is_a?(Class)
-          klass = args[0]
-
-          if klass < Changeset
-            return klass.new(relations[klass.relation], opts)
-          else
-            raise ArgumentError, "+#{klass.name}+ is not a Changeset subclass"
-          end
-        else
-          type, relation = args[0].to_a[0]
-        end
-      else
-        raise ArgumentError, 'Repository#changeset accepts 1-3 arguments'
-      end
-
-      if type
-        klass = CHANGESET_TYPES.fetch(type) {
-          raise ArgumentError, "+#{type.inspect}+ is not a valid changeset type. Must be one of: #{CHANGESET_TYPES.keys.inspect}"
-        }
-
-        klass.new(relation, opts)
-      else
-        relation = relations[name]
-
-        if pk
-          Changeset::Update.new(relation.by_pk(pk), opts.update(__data__: data))
-        else
-          Changeset::Create.new(relation, opts.update(__data__: data))
-        end
-      end
+      @relations = {}
     end
 
     # Open a database transaction
@@ -305,7 +138,7 @@ module ROM
     #
     # @api public
     def inspect
-      %(#<#{self.class} relations=[#{self.class.relations.map(&:inspect).join(' ')}]>)
+      %(#<#{self.class} struct_namespace=#{struct_namespace} auto_struct=#{auto_struct}>)
     end
 
     # Start a session for multiple changesets
@@ -321,46 +154,6 @@ module ROM
       yield(session)
       transaction { session.commit! }
     end
-
-    private
-
-    # Local command cache
-    #
-    # @api private
-    def commands
-      @__commands__ ||= Concurrent::Map.new
-    end
-
-    # Build a new command or return existing one
-    #
-    # @api private
-    def compile_command(*args, mapper: nil, use: nil, **opts)
-      type, name = args + opts.to_a.flatten(1)
-
-      relation = name.is_a?(Symbol) ? relations[name] : name
-
-      ast = relation.to_ast
-      adapter = relations[relation.name].adapter
-
-      if mapper
-        mapper_instance = container.mappers[relation.name.relation][mapper]
-      elsif mapper.nil?
-        mapper_instance = mappers[ast]
-      end
-
-      command = CommandCompiler[container, type, adapter, ast, use, opts]
-
-      if mapper_instance
-        command >> mapper_instance
-      else
-        command.new(relation)
-      end
-    end
-
-    # @api private
-    def map_tuple(relation, tuple)
-      relations[relation.name].mapper.([tuple]).first
-    end
   end
 end
 

data/lib/rom/repository/class_interface.rb

@@ -1,3 +1,5 @@
+require 'rom/repository/relation_reader'
+
 module ROM
   class Repository
     # Class-level APIs for repositories
@@ -18,11 +20,20 @@ module ROM
       # @api public
       def [](name)
         klass = Class.new(self < Repository::Root ? self : Repository::Root)
-        klass.relations(name)
         klass.root(name)
         klass
       end
 
+      # @api public
+      def new(container, options = EMPTY_HASH)
+        unless relation_reader
+          relation_reader(RelationReader.new(self, container.relations.elements.keys))
+          include(relation_reader)
+        end
+
+        super
+      end
+
       # Inherits configured relations and commands
       #
       # @api private
@@ -31,34 +42,9 @@ module ROM
 
         return if self === Repository
 
-        klass.relations(*relations)
         klass.commands(*commands)
       end
 
-      # Define which relations your repository is going to use
-      #
-      # @example
-      #   class MyRepo < ROM::Repository
-      #     relations :users, :tasks
-      #   end
-      #
-      #   my_repo = MyRepo.new(rom)
-      #
-      #   my_repo.users
-      #   my_repo.tasks
-      #
-      # @return [Array<Symbol>]
-      #
-      # @api public
-      def relations(*names)
-        if names.empty?
-          @relations ||= []
-        else
-          attr_reader(*(names - relations))
-          @relations = relations | names
-        end
-      end
-
       # Defines command methods on a root repository
       #
       # @example
@@ -107,10 +93,9 @@ module ROM
       def define_command_method(type, **opts)
         define_method(type) do |*input|
           if input.size == 1 && input[0].respond_to?(:commit)
-            changeset = input[0]
-            map_tuple(changeset.relation, changeset.commit)
+            input[0].commit
           else
-            command(type => self.class.root, **opts).call(*input)
+            root.command(type, **opts).call(*input)
           end
         end
       end
@@ -126,11 +111,9 @@ module ROM
             changeset = input.first
 
             if changeset.respond_to?(:commit)
-              map_tuple(changeset.relation, changeset.commit)
+              changeset.commit
             else
-              command(type => self.class.root, **opts)
-                .public_send(view_name, *view_args)
-                .call(*input)
+              root.command(type, **opts).public_send(view_name, *view_args).call(*input)
             end
           end
         end

data/lib/rom/repository/relation_reader.rb

@@ -0,0 +1,46 @@
+module ROM
+  class Repository
+    # @api private
+    class RelationReader < Module
+      # @api private
+      attr_reader :klass
+
+      # @api private
+      attr_reader :relations
+
+      module InstanceMethods
+        # @api private
+        def set_relation(name)
+          container.
+            relations[name].
+            with(auto_struct: auto_struct).
+            struct_namespace(struct_namespace)
+        end
+      end
+
+      # @api private
+      def initialize(klass, relations)
+        @klass = klass
+        @relations = relations
+        define_readers!
+      end
+
+      # @api private
+      def included(klass)
+        super
+        klass.include(InstanceMethods)
+      end
+
+      private
+
+      # @api private
+      def define_readers!
+        relations.each do |name|
+          define_method(name) do
+            @relations[name] ||= set_relation(name)
+          end
+        end
+      end
+    end
+  end
+end