rom-repository 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d1abbcf0ab779840aaf19b899c6e5b725c8621e
-  data.tar.gz: b4cfd46194e94c7509c920c21f54e4d317ace881
+  metadata.gz: 362832c67aba16f8f9a1dd37eac6d361b39e2344
+  data.tar.gz: bedb0cd2de862f654a709becc55095240a50dcb2
 SHA512:
-  metadata.gz: d96d070cf7eaf2729c8ebd1b78ed8cc9aebfc128d01c81211eca941fd53ad3f84d6be86ab2ba62e6ef9d1cbf97d4c1eaf299906bb7f0aac26842c070ac9f8c69
-  data.tar.gz: b82756a5892e7d62c5ce822372f51bd2b8af2e76d28b0e8dde4b01a9e798460bafac9b23ce511fbe761350c598b240024a0f6203e4946f784cb595d0df917c0d
+  metadata.gz: 2dfc1e26fd3ee71949cae67a87657b35e876588f930e00023c5fbf69a216882f35058b7f3c9038975ef619d972bc25b91f39bf8a7a69c3670923d649daf989fa
+  data.tar.gz: '02393346642d169103689807063b580ff765de616ffac3b15babdb757fef60bef91fe0bd27127bdb9720a07d296e0afdbf78a07b54b17fe75f62db9055ba8865'

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v1.3.0 2017-03-07
+
+### Added
+
+* Support for chaining `Changeset#associate` (solnic)
+* Inferring association name for `Changeset#associate` (solnic)
+* Support for restricting `Update` and `Delete` changesets explicitly via `Changeset#by_pk` (solnic)
+
+[Compare v1.2.0...v1.3.0](https://github.com/rom-rb/rom-repository/compare/v1.2.0...v1.3.0)
+
 # v1.2.0 2017-03-01
 
 ### Fixed
@@ -7,7 +17,7 @@
 
 ### Changed
 
-* Depends on rom >= 3.0.4 now as it provides `Relation::Graph#with_nodes` which is needed here (solnic)
+* Depends on rom >= 3.1.0 now as it provides `Relation::Graph#with_nodes` which is needed here (solnic)
 
 [Compare v1.1.0...v1.2.0](https://github.com/rom-rb/rom-repository/compare/v1.1.0...v1.2.0)
 

data/lib/rom/repository/changeset/associated.rb

@@ -12,13 +12,30 @@ module ROM
       #   @return [Changeset::Create] Child changeset
       param :left
 
-      # @!attribute [r] right
-      #   @return [Changeset::Create, Hash, #to_hash] Parent changeset or data
-      param :right
-
       # @!attribute [r] association
       #   @return [Symbol] Association identifier from relation schema
-      option :association, reader: true
+      option :associations, reader: true
+
+      # Infer association name from an object with a schema
+      #
+      # This expects other to be an object with a schema that includes a primary key
+      # attribute with :source meta information. This makes it work with both structs
+      # and relations
+      #
+      # @see Stateful#associate
+      #
+      # @api private
+      def self.infer_assoc_name(other)
+        schema = other.class.schema
+        attrs = schema.is_a?(Hash) ? schema.values : schema
+        pk = attrs.detect { |attr| attr.meta[:primary_key] }
+
+        if pk
+          pk.meta[:source].relation
+        else
+          raise ArgumentError, "can't infer association name for #{other}"
+        end
+      end
 
       # Commit changeset's composite command
       #
@@ -36,6 +53,11 @@ module ROM
         command.call
       end
 
+      # @api public
+      def associate(other, name = Associated.infer_assoc_name(other))
+        self.class.new(left, associations: associations.merge(name => other))
+      end
+
       # Create a composed command
       #
       # @example using existing parent data
@@ -57,13 +79,15 @@ module ROM
       #
       # @api public
       def command
-        case right
-        when Changeset
-          left.command.curry(left) >> right.command.with_association(association).curry(right)
-        when Associated
-          left.command.curry(left) >> right.command.with_association(association)
-        else
-          left.command.with_association(association).curry(left, right)
+        associations.reduce(left.command.curry(left)) do |a, (assoc, other)|
+          case other
+          when Changeset
+            a >> other.command.with_association(assoc).curry(other)
+          when Associated
+            a >> other.command.with_association(assoc)
+          else
+            a.with_association(assoc, parent: other)
+          end
         end
       end
 

data/lib/rom/repository/changeset/restricted.rb

@@ -9,6 +9,20 @@ module ROM
       def command
         super.new(relation)
       end
+
+      # Restrict changeset's relation by its PK
+      #
+      # @example
+      #   repo.changeset(UpdateUser).by_pk(1).data(name: "Jane")
+      #
+      # @param [Object] pk
+      #
+      # @return [Changeset]
+      #
+      # @api public
+      def by_pk(pk, data = EMPTY_HASH)
+        new(relation.by_pk(pk), __data__: data)
+      end
     end
   end
 end

data/lib/rom/repository/changeset/stateful.rb

@@ -187,8 +187,8 @@ module ROM
       # @param [Symbol] assoc The association identifier from schema
       #
       # @api public
-      def associate(other, name)
-        Associated.new(self, other, association: name)
+      def associate(other, name = Associated.infer_assoc_name(other))
+        Associated.new(self, associations: { name => other })
       end
 
       # Return command result type

data/lib/rom/repository/changeset.rb

@@ -92,6 +92,20 @@ module ROM
       self.class.new(relation, options.merge(new_options))
     end
 
+    # Return a new changeset with provided relation
+    #
+    # New options can be provided too
+    #
+    # @param [Relation] relation
+    # @param [Hash] options
+    #
+    # @return [Changeset]
+    #
+    # @api public
+    def new(relation, new_options = EMPTY_HASH)
+      self.class.new(relation, new_options.empty? ? options : options.merge(new_options))
+    end
+
     # Persist changeset
     #
     # @example

data/lib/rom/repository/version.rb

@@ -1,5 +1,5 @@
 module ROM
   class Repository
-    VERSION = '1.2.0'.freeze
+    VERSION = '1.3.0'.freeze
   end
 end

data/spec/shared/database.rb

@@ -1,7 +1,10 @@
-RSpec.shared_context 'database' do
+RSpec.shared_context 'database setup' do
   let(:configuration) { ROM::Configuration.new(:sql, uri) }
+
   let(:conn) { configuration.gateways[:default].connection }
+
   let(:rom) { ROM.container(configuration) }
+
   let(:uri) do
     if defined? JRUBY_VERSION
       'jdbc:postgresql://localhost/rom_repository'
@@ -12,7 +15,13 @@ RSpec.shared_context 'database' do
 
   before do
     conn.loggers << LOGGER
+  end
+end
+
+RSpec.shared_context 'database' do
+  include_context 'database setup'
 
+  before do
     [:tags, :tasks, :posts, :users, :posts_labels, :labels, :books,
      :reactions, :messages].each { |table| conn.drop_table?(table) }
 

data/spec/unit/changeset/associate_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+RSpec.describe ROM::Changeset, '#associate' do
+  include_context 'database setup'
+
+  before do
+    [:todos, :projects, :people].each { |table| conn.drop_table?(table) }
+
+    conn.create_table :people do
+      primary_key :id
+      column :name, String
+    end
+
+    conn.create_table :projects do
+      primary_key :id
+      column :name, String
+    end
+
+    conn.create_table :todos do
+      primary_key :id
+      foreign_key :user_id, :people, null: false, on_delete: :cascade
+      foreign_key :project_id, :projects, null: true, on_delete: :cascade
+      column :title, String
+    end
+
+    configuration.relation(:people) do
+      schema(infer: true) do
+        associations do
+          has_many :todos
+        end
+      end
+    end
+
+    configuration.relation(:projects) do
+      schema(infer: true) do
+        associations do
+          has_many :todos
+        end
+      end
+    end
+
+    configuration.relation(:todos) do
+      schema(infer: true) do
+        associations do
+          belongs_to :people, as: :user
+          belongs_to :projects, as: :project
+        end
+      end
+    end
+  end
+
+  let(:user_repo) do
+    Class.new(ROM::Repository[:people]) { commands :create }.new(rom)
+  end
+
+  let(:project_repo) do
+    Class.new(ROM::Repository[:projects]) { commands :create }.new(rom)
+  end
+
+  let(:task_repo) do
+    Class.new(ROM::Repository[:todos]) { commands :create }.new(rom)
+  end
+
+  context 'with Create' do
+    let(:jane) do
+      user_repo.create(name: 'Jane')
+    end
+
+    let(:project) do
+      project_repo.create(name: 'rom-rb')
+    end
+
+    it 'associates child with parent' do
+      changeset = task_repo.changeset(title: 'Test 1').associate(jane, :user)
+
+      expect(changeset.commit).to include(user_id: jane.id, title: 'Test 1')
+    end
+
+    it 'associates child with multiple parents' do
+      changeset = task_repo.changeset(title: 'Test 1').
+                    associate(jane, :user).
+                    associate(project)
+
+      expect(changeset.commit).
+        to include(user_id: jane.id, project_id: project.id, title: 'Test 1')
+    end
+
+    it 'raises when assoc name cannot be inferred' do
+      other = Class.new do
+        def self.schema
+          []
+        end
+      end.new
+
+      expect { task_repo.changeset(title: 'Test 1').associate(other) }.
+        to raise_error(ArgumentError, /can't infer association name for/)
+    end
+  end
+
+  context 'with Update' do
+    let!(:john) do
+      user_repo.create(name: 'John')
+    end
+
+    let!(:jane) do
+      user_repo.create(name: 'Jane')
+    end
+
+    let!(:task) do
+      task_repo.create(title: 'Test 1', user_id: john.id)
+    end
+
+    it 'associates child with parent' do
+      changeset = task_repo.changeset(task.id, title: 'Test 2')
+
+      expect(changeset.associate(jane, :user).commit).
+        to include(user_id: jane.id, title: 'Test 2')
+    end
+  end
+end

data/spec/unit/repository/changeset_spec.rb

@@ -121,28 +121,58 @@ RSpec.describe ROM::Repository, '#changeset' do
   end
 
   describe 'custom changeset class' do
-    let(:changeset) do
-      repo.changeset(changeset_class[:users]).data({})
-    end
+    context 'with a Create' do
+      let(:changeset) do
+        repo.changeset(changeset_class[:users]).data({})
+      end
 
-    let(:changeset_class) do
-      Class.new(ROM::Changeset::Create) do
-        def to_h
-          __data__.merge(name: 'Jane')
+      let(:changeset_class) do
+        Class.new(ROM::Changeset::Create) do
+          def to_h
+            __data__.merge(name: 'Jane')
+          end
         end
       end
-    end
 
-    it 'has data' do
-      expect(changeset.to_h).to eql(name: 'Jane')
-    end
+      it 'has data' do
+        expect(changeset.to_h).to eql(name: 'Jane')
+      end
 
-    it 'has relation' do
-      expect(changeset.relation).to be(repo.users)
+      it 'has relation' do
+        expect(changeset.relation).to be(repo.users)
+      end
+
+      it 'can be commited' do
+        expect(changeset.commit).to eql(id: 1, name: 'Jane')
+      end
     end
 
-    it 'can be commited' do
-      expect(changeset.commit).to eql(id: 1, name: 'Jane')
+    context 'with an Update' do
+      let(:changeset) do
+        repo.changeset(changeset_class).by_pk(user.id, name: 'Jade')
+      end
+
+      let(:changeset_class) do
+        Class.new(ROM::Changeset::Update[:users]) do
+          map { |t| t.merge(name: "#{t[:name]} Doe") }
+        end
+      end
+
+      let(:user) do
+        repo.command(:create, repo.users).call(name: 'Jane')
+      end
+
+      it 'has data' do
+        expect(changeset.to_h).to eql(name: 'Jade Doe')
+      end
+
+      it 'has relation restricted by pk' do
+        expect(changeset.relation.dataset).to eql(repo.users.by_pk(user.id).dataset)
+      end
+
+      it 'can be commited' do
+        expect(changeset.commit).to eql(id: 1, name: 'Jade Doe')
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-repository
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -161,6 +161,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/mapper_registry.rb
 - spec/support/mutant.rb
+- spec/unit/changeset/associate_spec.rb
 - spec/unit/changeset/map_spec.rb
 - spec/unit/changeset_spec.rb
 - spec/unit/relation_proxy_spec.rb