rom-changeset 1.0.0.beta3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e974c1c36fcff82e3b23b9f2a3cfea2e6b8de4a
-  data.tar.gz: c87a7913578f4091f9496b9b7676ebb8d797963e
+  metadata.gz: ac26fa822218a9b349d6f09543deb6a61a4590f1
+  data.tar.gz: d49f5d26caf046d2ac23c28b2fee9656cd036bc1
 SHA512:
-  metadata.gz: 63d0b84a39845c77a5ca20a2806cb736b010867549290d8a41a132f16703278d02e4d9ed75bf34c30c9dca7510e920cbfc9371ab6b2d62211a3f8d0a33ebb18f
-  data.tar.gz: dd10e1c4f3b82c80b576aa77c46b122e2355e7979df82a69e70f9b29518a6b060ed0d69f50e07f2b52f28731d1808e986a5cc372cac47889040f4acba46a728b
+  metadata.gz: 1cbe5db0a4d56fd23d08183c30f689be74d656c24d63d1d837e680e7ed07d50f5cf5fda3cf562f4969cd1b0be8a42b9f2641562a7f5e7ed6a60b812d6f87292f
+  data.tar.gz: 4e080b8c7c5e452794323e7423ca1533674c714bf0cb85baf2e3004c5644df7145fa1a7fba36bb53a4d85994e144703727840f3010c547810818c51efafd572a

data/lib/rom/changeset/associated.rb

@@ -53,6 +53,12 @@ module ROM
         command.call
       end
 
+      # Associate with other changesets
+      #
+      # @see Changeset#associate
+      #
+      # @return [Associated]
+      #
       # @api public
       def associate(other, name = Associated.infer_assoc_name(other))
         self.class.new(left, associations: associations.merge(name => other))

data/lib/rom/changeset/update.rb

@@ -4,10 +4,10 @@ module ROM
     #
     # Update changesets will only execute their commands when
     # the data is different from the original tuple. Original tuple
-    # is fetched from changeset's relation using `by_pk` relation view.
-    # This means the underlying adapter must provide this view, or you
-    # you need to implement it yourself in your relations if you want to
-    # use Update changesets.
+    # is fetched from changeset's relation using `one` method.
+    #
+    # @example
+    #   users.by_pk(1).changeset(:update, name: "Jane Doe").commit
     #
     # @see Changeset::Stateful
     #

data/lib/rom/changeset/version.rb

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

data/lib/rom/changeset.rb

@@ -76,7 +76,7 @@ module ROM
     # New options can be provided too
     #
     # @param [Relation] relation
-    # @param [Hash] options
+    # @param [Hash] new_options
     #
     # @return [Changeset]
     #

data/lib/rom/plugins/relation/changeset.rb

@@ -7,6 +7,9 @@ require 'rom/changeset/delete'
 module ROM
   module Plugins
     module Relation
+      # Relation plugin which adds `Relation#changeset` method
+      #
+      # @api public
       module Changeset
         TYPES = {
           create: ROM::Changeset::Create,
@@ -20,8 +23,10 @@ module ROM
           event[:relation].include(InstanceMethods)
         end
 
+        # Relation instance methods provided by the Changeset plugin
+        #
+        # @api public
         module InstanceMethods
-
           # Create a changeset for a relation
           #
           # @overload changeset(type, data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-changeset
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-core