secretary-rails 1.0.0.beta5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a3fabc2aa72279b7c65cfb1437502c7828516aa
-  data.tar.gz: e1a90574dfafbcc326d590658fd6a7841aebfa4b
+  metadata.gz: 2d57032707a48935f4cd868ce3230c1e30628931
+  data.tar.gz: b84674f6e9d5ff487974a94657b9765ddfe37650
 SHA512:
-  metadata.gz: df71ac7242fe988ee50c01f21a83ced6c0ff2d3a3ba620ca09eee8eb3b0298aec0ef6014fd8e12fc005a9c776bfd782f3bde541e341e3851b35e66e533d46779
-  data.tar.gz: 029dfa9765095925a73db1c3d2d2d894878731725fc7cbaf9d1522e872bbf190ac2da8d294839a00b39aef16d33780de0269280b5fd8bf3554331abf712f0093
+  metadata.gz: 1cf913c07526528e2b4c8f016a8d7f2ad72d1393b471f8590e261dc69338be83df8acb6a1262345f85693904576b0dd9acba6807a3fd9cfd84375224f8ff8e5d
+  data.tar.gz: d385d6f11fcc7db4b81a6f5791158576bd5e341fe233899e6581f25f6f514d9492e6c0f1572016b0753168ac32e19382d697c83a817d96b71179f59f63cebee6

data/README.md

@@ -251,6 +251,34 @@ end
 Article.versioned_attributes # => ["headline", "images"]
 ``` 
 
+#### Changes vs. Versions
+There is one aspect that may seem a bit confusing. The behavior of
+`record.changes`, and other Dirty attribute methods from ActiveModel, is
+preserved, so any attribute you change will be added to the record's changes.
+**However**, this does *not* necessarily mean that a version will be created,
+because you may have changed an attribute that isn't versioned. For example:
+
+```ruby
+class Article < ActiveRecord::Base
+  has_secretary on: ["headline", "body"]
+end
+
+article = Article.find(1)
+article.changed? #=> false
+
+article.slug = "new-slug-for-article" # "slug" is not versioned
+article.changed? #=> true
+article.changed #=> ["slug"]
+
+article.versioned_changes #=> {}
+article.save! # A new version isn't created!
+```
+
+This also goes for associations: if you change an association on a parent
+object, but in an "insignificant" way (i.e., no versioned attributes are
+changed), then that association won't be considered "changed" when it comes
+time to build the version.
+
 
 ## Contributing
 Fork it and send a pull request!

data/app/models/secretary/version.rb

@@ -20,7 +20,7 @@ module Secretary
       # I didn't want to override the public ActiveRecord
       # API.
       def generate(object)
-        changes = object.versioned_changes
+        changes = object.send(:__versioned_changes)
 
         object.versions.create({
           :user_id          => object.logged_user_id,

data/lib/secretary/gem_version.rb

@@ -1,3 +1,3 @@
 module Secretary
-  GEM_VERSION = "1.0.0.beta5"
+  GEM_VERSION = "1.0.0"
 end

data/lib/secretary/has_secretary.rb

@@ -30,7 +30,10 @@ module Secretary
 
         attr_accessor :logged_user_id
 
-        after_save :generate_version, :if => lambda { self.changed? }
+        after_save :generate_version,
+          :if => lambda { __versioned_changes.present? }
+
+        after_save :reset_versioned_changes
 
         include InstanceMethodsOnActivation
       end

data/lib/secretary/versioned_attributes.rb

@@ -74,7 +74,16 @@ module Secretary
           end
         end
 
-        modified_changes[key] = [previous, current]
+        # This really shouldn't need to be here,
+        # but there is some confusion if we're destroying
+        # an associated object in a save callback on the
+        # parent object. We can't know that the callback
+        # is going to destroy this object on save,
+        # so we just have to add the association normally
+        # and then filter it out here.
+        if previous != current
+          modified_changes[key] = [previous, current]
+        end
       end
 
       modified_changes
@@ -93,5 +102,23 @@ module Secretary
     def versioned_attribute?(key)
       self.class.versioned_attributes.include?(key.to_s)
     end
+
+
+    private
+
+    # Memoized version changes.
+    # This is just so when we're near the end of an object's journey to
+    # persistence, we don't have to keep running the whole `versioned_changes`
+    # method, which is rather expensive. When we reach that point, we can
+    # be reasonably certain that no additional changes will occur, so it's
+    # safe to memoize the method. However, while an object is being modified,
+    # memoizing would be wrong, since that hash it constantly changing.
+    def __versioned_changes
+      @__versioned_changes ||= versioned_changes
+    end
+
+    def reset_versioned_changes
+      @__versioned_changes = nil
+    end
   end
 end

data/spec/factories.rb

@@ -36,7 +36,7 @@ FactoryGirl.define do
     name "Bryan Ricker"
   end
 
-  factory :version, class: "Secretary::Version" do
+  factory :version, :class => "Secretary::Version" do
     versioned { |v| v.association :story }
     user
   end