rom-repository 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdb0dfc90b48097d286f0d5b79790560d79c8fdd
-  data.tar.gz: ed15356517cc1dff17729d851e53b77f75727075
+  metadata.gz: 8deef9fc5ae64394c2845f34d1575ff4f55d503d
+  data.tar.gz: 746ac682b439a3ffd603cd79e64b2bf52ead6d8b
 SHA512:
-  metadata.gz: cc5b70717bbfb200cad2dc539f89c438398ae3dd3c6fb3f10f8d1c58c48e2be2b5d7bc01a729f738400e9b5021dbb070aa14fbdaec98c5ec8f30b57511e6448c
-  data.tar.gz: 88d6e30ab3107d583119ab1ed2a48bb83e138b2bc5026235acbb1a6932302a34037bb5315de976479d0c58895cb841026fe3239f8c3326e2093d882faf84942e
+  metadata.gz: c970db02832c84c5287a4c537bcc851abd07013947fdaeccccf6db117bf5b7817b4b10dbbfa0efc6683be30830e826eeaf5aba504b3e47663348a94291c05b06
+  data.tar.gz: 410546d65acdec9fedb221809ed1e2b098621da1b034eb8580b34c333931fdee16ba5ece929f9ccdfbc9be52150eb7fe89c5531ebea852c2cbd3c090f8a3bc44

data/.travis.yml

@@ -21,6 +21,7 @@ env:
 matrix:
   allow_failures:
     - rvm: rbx-3
+    - rvm: jruby-9.1.6.0
 notifications:
   webhooks:
     urls:

data/.yardopts

@@ -0,0 +1,2 @@
+--query '@api.text != "private"'
+--embed-mixins

data/CHANGELOG.md

@@ -2,15 +2,17 @@
 
 ### Added
 
-* New `Repository#session` API for building transactions using changesets (solnic)
-* Support for inferring typed structs based on relation schemas (solnic)
+* New `Repository#transaction` API for executing operations inside a database transaction (flash-gordon+solnic)
 * `aggregate` and `combine` support nested association specs, ie `combine(users: [tasks: :tags])` (beauby)
 * Changesets support data as arrays too (solnic)
 * Changesets support custom command types via `Changeset#with(command_type: :my_command)` (solnic)
 * `Changeset::Delete` was added and is accessible via `repo.changeset(delete: some_relation.by_pk(1))` (solnic)
-* Ability to define custom changeset classes that can be instantiated via `repo.changeset(MyChangesetClass[:rel_name]).data(some_data)` where `MyChangesetClass` inherits from a core changeset class (solnic)
+* Ability to define custom changeset classes that can be instantiated via `repo.changeset(MyChangesetClass[:rel_name]).data(some_data)` or `root_repo.changeset(MyChangesetClass)` where `MyChangesetClass` inherits from a core changeset class (solnic)
 * `Changeset.map` which accepts a block and exposes a DSL for data transformations (all [transproc hash methods](https://github.com/solnic/transproc)) are available (solnic)
+* `Changeset.map` which accepts a custom block that can transform data (executed in the context of a changeset object) (solnic)
+* Support for composing multiple mappings via `Changeset.map` (solnic)
 * `Changeset#associate` method that accepts another changeset or parent data and an association identifier, ie `post_changeset.associate(user, :author)` (solnic)
+* Support for inferring typed structs based on relation schemas (solnic)
 * You can now use `wrap_parent` in combined relations too (which is gazillion times faster than `combine_parents`) (solnic)
 
 ### Changed
@@ -20,7 +22,7 @@
 
 ### Fixed
 
-* Auto-mapping to structs ignores FK attributes consistently (solnic)
+* FKs are always included in auto-generated structs used in aggregates (solnic)
 
 [Compare v0.3.1...v1.0.0](https://github.com/rom-rb/rom-repository/compare/v0.3.1...v1.0.0)
 

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

@@ -27,6 +27,14 @@ module ROM
         self.class[name]
       end
 
+      def bind(context)
+        if processor.is_a?(Proc)
+          self.class.new(Pipe[-> *args { context.instance_exec(*args, &processor) }])
+        else
+          self
+        end
+      end
+
       def >>(other)
         if processor
           Pipe.new(processor >> other)

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

@@ -8,6 +8,19 @@ module ROM
       #   @return [Symbol] The name of the relation's primary key attribute
       option :primary_key, reader: true
 
+      # Commit update changeset if there's a diff
+      #
+      # This returns original tuple if there's no diff
+      #
+      # @return [Hash]
+      #
+      # @see Changeset#commit
+      #
+      # @api public
+      def commit
+        diff? ? super : original
+      end
+
       # Return true
       #
       # @return [TrueClass]

data/lib/rom/repository/changeset.rb

@@ -23,7 +23,7 @@ module ROM
     # @!attribute [r] pipe
     #   @return [Changeset::Pipe] data transformation pipe
     option :pipe, reader: true, accept: [Proc, Pipe], default: -> changeset {
-      changeset.class.default_pipe
+      changeset.class.default_pipe(changeset)
     }
 
     # @!attribute [r] command_compiler
@@ -44,14 +44,50 @@ module ROM
     #
     # @api public
     def self.[](relation_name)
-      fetch_or_store(relation_name) {
+      fetch_or_store([relation_name, self]) {
         Class.new(self) { relation(relation_name) }
       }
     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
+    #
+    #     map do |tuple|
+    #       tuple.merge(created_at: Time.now)
+    #     end
+    #   end
+    #
+    # @return [Array<Pipe, Transproc::Function>]
+    #
     # @api public
     def self.map(&block)
-      @pipe = Class.new(Pipe, &block).new
+      if block.arity.zero?
+        pipes << Class.new(Pipe, &block).new
+      else
+        pipes << Pipe.new(block)
+      end
     end
 
     # Build default pipe object
@@ -59,8 +95,20 @@ module ROM
     # This can be overridden in a custom changeset subclass
     #
     # @return [Pipe]
-    def self.default_pipe
-      @pipe || Pipe.new
+    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
@@ -124,6 +172,20 @@ module ROM
       with(__data__: data)
     end
 
+    # Persist changeset
+    #
+    # @example
+    #   changeset = user_repo.changeset(name: 'Jane')
+    #   changeset.commit
+    #   # => { id: 1, name: 'Jane' }
+    #
+    # @return [Hash, Array]
+    #
+    # @api public
+    def commit
+      command.call
+    end
+
     # Return command result type
     #
     # @return [Symbol]

data/lib/rom/repository/class_interface.rb

@@ -112,8 +112,12 @@ module ROM
 
       # @api private
       def define_command_method(type, **opts)
-        define_method(type) do |*args|
-          command(type => self.class.root, **opts).call(*args)
+        define_method(type) do |input|
+          if input.is_a?(Changeset)
+            map_tuple(input.relation, input.commit)
+          else
+            command(type => self.class.root, **opts).call(input)
+          end
         end
       end
 
@@ -127,8 +131,8 @@ module ROM
 
             changeset = input.first
 
-            if changeset.is_a?(Changeset) && changeset.clean?
-              map_tuple(changeset.relation, changeset.original)
+            if changeset.is_a?(Changeset)
+              map_tuple(changeset.relation, changeset.commit)
             else
               command(type => self.class.root, **opts)
                 .public_send(view_name, *view_args)

data/lib/rom/repository/root.rb

@@ -61,9 +61,23 @@ module ROM
       #
       #   @param *associations [Array<Symbol>] A list of association names
       #
+      # @overload aggregate(*associations, *assoc_opts)
+      #   Composes an aggregate from configured associations and assoc opts
+      #   on the root relation
+      #
+      #   @example
+      #     user_repo.aggregate(:tasks, posts: :tags)
+      #
+      #   @param *associations [Array<Symbol>] A list of association names
+      #   @param [Hash] Association options for nested aggregates
+      #
       # @overload aggregate(options)
       #   Composes an aggregate by delegating to combine_children method.
       #
+      #   @example
+      #     user_repo.aggregate(tasks: :labels)
+      #     user_repo.aggregate(posts: [:tags, :comments])
+      #
       #   @param options [Hash] An option hash
       #
       #   @see RelationProxy::Combine#combine_children
@@ -72,33 +86,60 @@ module ROM
       #
       # @api public
       def aggregate(*args)
-        root.combine(*args)
+        if args.all? { |arg| arg.is_a?(Symbol) }
+          root.combine(*args)
+        else
+          args.reduce(root) { |a, e| a.combine(e) }
+        end
       end
 
       # @overload changeset(name, *args)
       #   Delegate to Repository#changeset
+      #
       #   @see Repository#changeset
       #
       # @overload changeset(data)
       #   Builds a create changeset for the root relation
+      #
       #   @example
       #     user_repo.changeset(name: "Jane")
+      #
       #   @param data [Hash] New data
+      #
       #   @return [Changeset::Create]
       #
-      # @overload changeset(restriction_arg, data)
+      # @overload changeset(primary_key, data)
       #   Builds an update changeset for the root relation
+      #
       #   @example
       #     user_repo.changeset(1, name: "Jane Doe")
-      #   @param restriction_arg [Object] An argument for the restriction view
+      #
+      #   @param primary_key [Object] Primary key for restricting relation
+      #
       #   @return [Changeset::Update]
       #
+      # @overload changeset(changeset_class)
+      #   Return a changeset prepared for repo's root relation
+      #
+      #   @example
+      #     changeset = user_repo.changeset(MyChangeset)
+      #
+      #     changeset.relation == user_repo.root
+      #     # true
+      #
+      #   @param [Class] changeset_class Your custom changeset class
+      #
+      #   @return [Changeset]
+      #
       # @override Repository#changeset
       #
       # @api public
       def changeset(*args)
         if args.first.is_a?(Symbol) && relations.key?(args.first)
           super
+        elsif args.first.is_a?(Class)
+          klass, *rest = args
+          super(klass[self.class.root], *rest)
         else
           super(root.name, *args)
         end

data/lib/rom/repository/session.rb

@@ -22,7 +22,7 @@ module ROM
     end
 
     def commit!
-      queue.map(&:command).compact.each(&:call)
+      queue.each(&:commit)
 
       @status = :success
 

data/lib/rom/repository/version.rb

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

data/lib/rom/repository.rb

@@ -139,7 +139,7 @@ module ROM
     end
 
     # @overload changeset(name, attributes)
-    #   Returns a create changeset for a given relation identifier
+    #   Return a create changeset for a given relation identifier
     #
     #   @example
     #     repo.changeset(:users, name: "Jane")
@@ -149,8 +149,8 @@ module ROM
     #
     #   @return [Changeset::Create]
     #
-    # @overload changeset(name, restriction_arg, attributes)
-    #   Returns an update changeset for a given relation identifier
+    # @overload changeset(name, primary_key, attributes)
+    #   Return an update changeset for a given relation identifier
     #
     #   @example
     #     repo.changeset(:users, 1, name: "Jane Doe")
@@ -160,6 +160,16 @@ module ROM
     #
     #   @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]
+    #
     # @api public
     def changeset(*args)
       opts = { command_compiler: command_compiler }

data/spec/integration/repository_spec.rb

@@ -84,6 +84,46 @@ RSpec.describe 'ROM repository' do
     expect(jane.posts.first.title).to eql('Hello From Jane')
   end
 
+  it 'loads an aggregate via assoc options' do
+    jane = repo.aggregate(posts: :labels).where(name: 'Jane').one
+
+    expect(jane.name).to eql('Jane')
+    expect(jane.posts.size).to be(1)
+    expect(jane.posts.first.title).to eql('Hello From Jane')
+    expect(jane.posts[0].labels.size).to be(2)
+    expect(jane.posts[0].labels[0].name).to eql('red')
+    expect(jane.posts[0].labels[1].name).to eql('blue')
+  end
+
+  it 'loads an aggregate with multiple assoc options' do
+    jane = repo.aggregate(:labels, posts: :labels).where(name: 'Jane').one
+
+    expect(jane.name).to eql('Jane')
+
+    expect(jane.labels.size).to be(2)
+    expect(jane.labels[0].name).to eql('red')
+    expect(jane.labels[1].name).to eql('blue')
+
+    expect(jane.posts.size).to be(1)
+    expect(jane.posts[0].title).to eql('Hello From Jane')
+
+    expect(jane.posts[0].labels.size).to be(2)
+    expect(jane.posts[0].labels[0].name).to eql('red')
+    expect(jane.posts[0].labels[1].name).to eql('blue')
+  end
+
+  it 'loads an aggregate with deeply nested assoc options' do
+    jane = repo.aggregate(posts: [{ author: :labels }]).where(name: 'Jane').one
+
+    expect(jane.posts.size).to be(1)
+    expect(jane.posts[0].title).to eql('Hello From Jane')
+
+    expect(jane.posts[0].author.id).to eql(jane.id)
+    expect(jane.posts[0].author.labels.size).to be(2)
+    expect(jane.posts[0].author.labels[0].name).to eql('red')
+    expect(jane.posts[0].author.labels[1].name).to eql('blue')
+  end
+
   it 'loads an aggregate with multiple associations' do
     jane = repo.aggregate(:posts, :labels).where(name: 'Jane').one
 

data/spec/integration/root_repository_spec.rb

@@ -45,6 +45,17 @@ RSpec.describe ROM::Repository::Root do
     end
   end
 
+  describe '#changeset' do
+    it 'returns a changeset automatically set for root relation' do
+      klass = Class.new(ROM::Changeset::Create)
+
+      changeset = repo.changeset(klass)
+
+      expect(changeset.relation).to be(repo.users)
+      expect(changeset).to be_kind_of(klass)
+    end
+  end
+
   describe '#aggregate' do
     include_context 'seeds'
 

data/spec/unit/changeset/map_spec.rb

@@ -1,42 +1,84 @@
 RSpec.describe ROM::Changeset, '.map' do
-  subject(:changeset) do
-    Class.new(ROM::Changeset) do
-      map do
-        unwrap :address
-        rename_keys street: :address_street, city: :address_city, country: :address_country
+  context 'single mapping with transaction DSL' do
+    subject(:changeset) do
+      Class.new(ROM::Changeset::Create[:users]) do
+        map do
+          unwrap :address
+          rename_keys street: :address_street, city: :address_city, country: :address_country
+        end
+
+        def default_command_type
+          :test
+        end
+      end.new(relation, __data__: user_data)
+    end
+
+    let(:relation) { double(:relation) }
+
+    context 'with a hash' do
+      let(:user_data) do
+        { name: 'Jane', address: { street: 'Street 1', city: 'NYC', country: 'US' } }
       end
 
-      def default_command_type
-        :test
+      it 'sets up custom data pipe' do
+        expect(changeset.to_h)
+          .to eql(name: 'Jane', address_street: 'Street 1', address_city: 'NYC', address_country: 'US' )
       end
-    end.new(relation, __data__: user_data)
-  end
+    end
 
-  let(:relation) { double(:relation) }
+    context 'with an array' do
+      let(:user_data) do
+        [{ name: 'Jane', address: { street: 'Street 1', city: 'NYC', country: 'US' } },
+         { name: 'Joe', address: { street: 'Street 2', city: 'KRK', country: 'PL' } }]
+      end
 
-  context 'with a hash' do
-    let(:user_data) do
-      { name: 'Jane', address: { street: 'Street 1', city: 'NYC', country: 'US' } }
+      it 'sets up custom data pipe' do
+        expect(changeset.to_a)
+          .to eql([
+                    { name: 'Jane', address_street: 'Street 1', address_city: 'NYC', address_country: 'US' },
+                    { name: 'Joe', address_street: 'Street 2', address_city: 'KRK', address_country: 'PL' }
+                  ])
+      end
     end
+  end
+
+  context 'multi mapping with custom blocks' do
+    subject(:changeset) do
+      Class.new(ROM::Changeset::Create[:users]) do
+        map do |tuple|
+          tuple.merge(one: next_value)
+        end
+
+        map do |tuple|
+          tuple.merge(two: next_value)
+        end
+
+        def initialize(*args)
+          super
+          @counter = 0
+        end
 
-    it 'sets up custom data pipe' do
-      expect(changeset.to_h)
-        .to eql(name: 'Jane', address_street: 'Street 1', address_city: 'NYC', address_country: 'US' )
+        def default_command_type
+          :test
+        end
+
+        def next_value
+          @counter += 1
+        end
+      end.new(relation).data(user_data)
     end
-  end
 
-  context 'with an array' do
-    let(:user_data) do
-      [{ name: 'Jane', address: { street: 'Street 1', city: 'NYC', country: 'US' } },
-       { name: 'Joe', address: { street: 'Street 2', city: 'KRK', country: 'PL' } }]
+    let(:relation) { double(:relation) }
+    let(:user_data) { { name: 'Jane' } }
+
+    it 'applies mappings in order of definition' do
+      expect(changeset.to_h).to eql(name: 'Jane', one: 1, two: 2)
     end
 
-    it 'sets up custom data pipe' do
-      expect(changeset.to_a)
-        .to eql([
-                  { name: 'Jane', address_street: 'Street 1', address_city: 'NYC', address_country: 'US' },
-                  { name: 'Joe', address_street: 'Street 2', address_city: 'KRK', address_country: 'PL' }
-                ])
+    it 'inherits pipes' do
+      klass = Class.new(changeset.class)
+
+      expect(klass.pipes).to eql(changeset.class.pipes)
     end
   end
 end

data/spec/unit/changeset_spec.rb

@@ -2,6 +2,26 @@ RSpec.describe ROM::Changeset do
   let(:jane) { { id: 2, name: "Jane" } }
   let(:relation) { double(ROM::Relation, primary_key: :id) }
 
+  describe '.[]' do
+    it 'returns a changeset preconfigured for a specific relation' do
+      klass = ROM::Changeset::Create[:users]
+
+      expect(klass.relation).to be(:users)
+      expect(klass < ROM::Changeset::Create).to be(true)
+    end
+
+    it 'caches results' do
+      create = ROM::Changeset::Create[:users]
+      update = ROM::Changeset::Update[:users]
+
+      expect(create).to be(ROM::Changeset::Create[:users])
+      expect(create < ROM::Changeset::Create).to be(true)
+
+      expect(update).to be(ROM::Changeset::Update[:users])
+      expect(update < ROM::Changeset::Update).to be(true)
+    end
+  end
+
   describe '#diff' do
     it 'returns a hash with changes' do
       expect(relation).to receive(:fetch).with(2).and_return(jane)

data/spec/unit/repository/transaction_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe ROM::Repository, '#transaction' do
+  let(:user_repo) do
+    Class.new(ROM::Repository[:users]) { commands :create }.new(rom)
+  end
+
+  let(:task_repo) do
+    Class.new(ROM::Repository[:tasks]) { commands :create }.new(rom)
+  end
+
+  include_context 'database'
+  include_context 'relations'
+
+  it 'creating user with tasks' do
+    user, task = user_repo.transaction do
+      user_changeset = user_repo.changeset(name: 'Jane')
+      task_changeset = task_repo.changeset(title: 'Task One')
+
+      user = user_repo.create(user_changeset)
+      task = task_repo.create(task_changeset.associate(user, :user))
+
+      [user, task]
+    end
+
+    expect(user.name).to eql('Jane')
+    expect(task.user_id).to be(user.id)
+    expect(task.title).to eql('Task One')
+  end
+end

data/spec/unit/session_spec.rb

@@ -7,8 +7,6 @@ RSpec.describe ROM::Session do
   let(:create_changeset) { instance_double(ROM::Changeset::Create, relation: relation) }
   let(:delete_changeset) { instance_double(ROM::Changeset::Delete, relation: relation) }
   let(:relation) { double.as_null_object }
-  let(:create_command) { spy(:create_command) }
-  let(:delete_command) { spy(:delete_command) }
 
   describe '#pending?' do
     it 'returns true before commit' do
@@ -22,21 +20,17 @@ RSpec.describe ROM::Session do
 
   describe '#commit!' do
     it 'executes ops and restores pristine state' do
-      expect(create_changeset).to receive(:command).and_return(create_command)
+      expect(create_changeset).to receive(:commit).and_return(true)
 
       session.add(create_changeset).commit!
       session.commit!
 
       expect(session).to be_success
-
-      expect(create_command).to have_received(:call)
     end
 
     it 'executes ops and restores pristine state when exception was raised' do
-      expect(create_changeset).to receive(:command).and_return(create_command)
-      expect(delete_changeset).to receive(:command).and_return(delete_command)
-
-      expect(delete_command).to receive(:call).and_raise(StandardError, 'oops')
+      expect(create_changeset).to_not receive(:commit)
+      expect(delete_changeset).to receive(:commit).and_raise(StandardError, 'oops')
 
       expect {
         session.add(delete_changeset)
@@ -47,8 +41,6 @@ RSpec.describe ROM::Session do
       expect(session).to be_failure
 
       session.commit!
-
-      expect(create_command).not_to have_received(:call)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-repository
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-19 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -110,6 +110,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -161,6 +162,7 @@ files:
 - spec/unit/repository/changeset_spec.rb
 - spec/unit/repository/inspect_spec.rb
 - spec/unit/repository/session_spec.rb
+- spec/unit/repository/transaction_spec.rb
 - spec/unit/session_spec.rb
 - spec/unit/struct_builder_spec.rb
 homepage: http://rom-rb.org