draftsman 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4594a89239d63ca33dfc4b008728952b04ff3d77
-  data.tar.gz: a41330672fbc6204b0a9b459db106b05cddb3675
+  metadata.gz: c75a20681563bfa82fba2f109838a5fb2688d043
+  data.tar.gz: 7f43cc039a9d07048fbdfc04cfd9f8c5ff764ce1
 SHA512:
-  metadata.gz: 4a5197c59c7c471a2abeaf558274b19fa5938eba14b319ba09fe571bca17b7df2363122c87ff00dd9f4bbe34e83177056e904a535add241b7c702e2b1ce45c00
-  data.tar.gz: 31ad8696e86643c2c230fd40df6c66510360db0c8c98728fb89c27902738cde76dc5575ee7b8baf09c5c1f2b8574c923a1279c25fa8d6fac12c85408c453ad54
+  metadata.gz: 032096c7295407be9a2ba40e8ccd51e5e595279fef880d0011145867c32ccf3df60e5a47282afeacc7a5b5022745cf0531d96b03cb34a43931577cdcbeabad85
+  data.tar.gz: 6eb88502e4c4f176cb85660614597eea419425d14a35ff2390ae0f6b9a71718fd7d84adce866f82ab904f605c9c82cd967881d2a037ac932a43376bef539544f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.3.1 - August 14, 2014
+
+-  Commit [aae737fcdf](https://github.com/live-editor/draftsman/commit/aae737fcdf48604bc480b1c9c141bf642c0f581c) - `skip` option not persisting skipped values correctly
+
 ## 0.3.0 - July 29, 2014
 
 -  Commit [1e2a59f678](https://github.com/live-editor/draftsman/commit/1e2a59f678cc4d88222dfc1976d564b5649cd329) - Add support for PostgreSQL JSON data type for `object`, `object_changes`, and `previous_draft` columns.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    draftsman (0.3.0)
+    draftsman (0.3.1)
       activerecord (>= 3.0, < 5.0)
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-# Draftsman v0.3.0 (alpha)
+# Draftsman v0.3.1 (alpha)
 
 Draftsman is a Ruby gem that lets you create draft versions of your database records. If you're developing a system in
 need of simple drafts or a publishing approval queue, then Draftsman just might be what you need.
@@ -50,7 +50,7 @@ Works well with Rails, Sinatra, or any other application that depends on ActiveR
 Add Draftsman to your `Gemfile`.
 
 ```ruby
-gem 'draftsman', '0.3.0'
+gem 'draftsman', '0.3.1'
 ```
 
 Or if you want to grab the latest from `master`:
@@ -474,6 +474,16 @@ However, there are some differences:
    as it was _before_ it was destroyed (in case you want the option of reverting the destroy later and restoring the
    drafted item back to its original state).
 
+## Semantic Versioning
+
+Like many Ruby gems, Draftsman honors the concepts behind [semantic versioning][10]:
+
+> Given a version number MAJOR.MINOR.PATCH, increment the:
+>
+> 1.  MAJOR version when you make incompatible API changes,
+> 2.  MINOR version when you add functionality in a backwards-compatible manner, and
+> 3.  PATCH version when you make backwards-compatible bug fixes.
+
 ## Contributing
 
 If you feel like you can add something useful to Draftsman, then don't hesitate to contribute! To make sure your
@@ -521,3 +531,4 @@ Draftsman is released under the [MIT License][9].
 [7]: https://raw.github.com/live-editor/draftsman/master/lib/generators/draftsman/templates/create_drafts.rb
 [8]: http://www.sinatrarb.com/intro.html#Modular%20vs.%20Classic%20Style
 [9]: http://www.opensource.org/licenses/MIT
+[10]: http://semver.org/

data/lib/draftsman/model.rb

@@ -191,11 +191,6 @@ module Draftsman
         send(self.class.draft_association_name).present?
       end
 
-      def draft_at(timestamp, reify_options = {})
-        v = send(self.class.versions_association_name).following(timestamp).first
-        v ? v.reify(reify_options) : self
-      end
-
       # Creates object and records a draft for the object's creation. Returns `true` or `false` depending on whether or not
       # the objects passed validation and the save was successful.
       def draft_creation
@@ -292,14 +287,12 @@ module Draftsman
 
             data = merge_metadata_for_draft(data)
             send(self.class.draft_association_name).update_attributes data
-
             self.save
           # Destroy the draft if this record has changed back to the original record
           elsif changed_to_original_for_draft?
             send(self.class.draft_association_name).destroy
             send "#{self.class.draft_association_name}_id=", nil
-            self.update_column "#{self.class.draft_association_name}_id", nil
-            true
+            self.save
           # Save a draft if record is changed notably
           elsif changed_notably_for_draft?
             data = {
@@ -309,24 +302,24 @@ module Draftsman
             }
             data = merge_metadata_for_draft(data)
 
-            # If there's already a draft, update it
+            # If there's already a draft, update it.
             if send(self.class.draft_association_name).present?
               data[:object_changes] = changes_for_draftsman if track_object_changes_for_draft?
               send(self.class.draft_association_name).update_attributes data
-            # If there's not draft, create an update draft
+            # If there's not draft, create an update draft.
             else
               data[:event]          = 'update'
               data[:object_changes] = changes_for_draftsman if track_object_changes_for_draft?
               send "build_#{self.class.draft_association_name}", data
               
               if send(self.class.draft_association_name).save
-                write_attribute "#{self.class.draft_association_name}_id", send(self.class.draft_association_name).id
-                self.update_column "#{self.class.draft_association_name}_id", send(self.class.draft_association_name).id
+                update_column "#{self.class.draft_association_name}_id", send(self.class.draft_association_name).id
+                update_skipped_attributes
               else
                 raise ActiveRecord::Rollback and return false
               end
             end
-          # If record is a draft and not changed notably, then update the draft
+          # If record is a draft and not changed notably, then update the draft.
           elsif self.draft?
             data = {
               :item      => self,
@@ -335,8 +328,8 @@ module Draftsman
             }
             data[:object_changes] = changes_for_draftsman(changed_from: @object.draft.changeset) if track_object_changes_for_draft?
             data = merge_metadata_for_draft(data)
-
             send(self.class.draft_association_name).update_attributes data
+            update_skipped_attributes
           # Otherwise, just save the record
           else
             self.save
@@ -469,6 +462,21 @@ module Draftsman
         write_attribute self.class.trashed_at_attribute_name, Time.now
         self.update_column self.class.trashed_at_attribute_name, send(self.class.trashed_at_attribute_name)
       end
+
+      # Updates skipped attributes' values on this model.
+      def update_skipped_attributes
+        if draftsman_options[:skip].present?
+          changed_and_skipped_keys = self.changed.select { |key| draftsman_options[:skip].include?(key) }
+          changed_and_skipped_attrs = {}
+          changed_and_skipped_keys.each { |key| changed_and_skipped_attrs[key] = self.changes[key].last }
+
+          self.reload
+          self.attributes = changed_and_skipped_attrs
+          self.save
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/draftsman/version.rb

@@ -1,3 +1,3 @@
 module Draftsman
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/dummy/app/models/skipper.rb

@@ -0,0 +1,3 @@
+class Skipper < ActiveRecord::Base
+  has_drafts :skip => :skip_me
+end

data/spec/dummy/app/models/whitelister.rb

@@ -1,3 +1,3 @@
 class Whitelister < ActiveRecord::Base
-  has_drafts only: [:name]
+  has_drafts :only => [:name]
 end

data/spec/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -71,6 +71,15 @@ class SetUpTestTables < ActiveRecord::Migration
       t.references :parent
       t.timestamps
     end
+
+    create_table :skippers, :force => true do |t|
+      t.string     :name
+      t.string     :skip_me
+      t.references :draft
+      t.datetime   :trashed_at
+      t.datetime   :published_at
+      t.timestamps
+    end
   end
 
   def self.down

data/spec/dummy/db/schema.rb

@@ -34,6 +34,15 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.datetime "updated_at"
   end
 
+  create_table "clingy_parents", force: true do |t|
+    t.string   "name"
+    t.integer  "draft_id"
+    t.datetime "trashed_at"
+    t.datetime "published_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
   create_table "draft_as_sketches", force: true do |t|
     t.string   "name"
     t.integer  "sketch_id"
@@ -67,6 +76,26 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.string   "user_agent"
   end
 
+  create_table "hopeless_children", force: true do |t|
+    t.string   "name"
+    t.integer  "clingy_parent_id"
+    t.integer  "draft_id"
+    t.datetime "trashed_at"
+    t.datetime "published_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "mortgages", force: true do |t|
+    t.float    "amount"
+    t.integer  "parent_id"
+    t.integer  "draft_id"
+    t.datetime "trashed_at"
+    t.datetime "published_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
   create_table "parents", force: true do |t|
     t.string   "name"
     t.integer  "draft_id"
@@ -76,6 +105,16 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.datetime "updated_at"
   end
 
+  create_table "skippers", force: true do |t|
+    t.string   "name"
+    t.string   "skip_me"
+    t.integer  "draft_id"
+    t.datetime "trashed_at"
+    t.datetime "published_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
   create_table "trashables", force: true do |t|
     t.string   "name"
     t.string   "title"

data/spec/models/skipper_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe Skipper do
+  let(:skipper) { Skipper.new :name => 'Bob', :skip_me => 'Skipped 1' }
+  it { should be_draftable }
+
+  describe :draft_creation do
+    subject do
+      skipper.draft_creation
+      skipper.reload
+    end
+
+    it { should be_persisted }
+    it { should be_draft }
+    its(:draft_id) { should be_present }
+    its(:draft) { should be_present }
+    its(:draft) { should be_create }
+    its(:name) { should eql 'Bob' }
+    its(:skip_me) { should eql 'Skipped 1' }
+  end
+
+  describe :draft_update do
+    subject do
+      skipper.draft_update
+      skipper.reload
+    end
+
+    context 'without existing draft' do
+      before do
+        skipper.save!
+        skipper.name = 'Sam'
+        skipper.skip_me = 'Skipped 2'
+      end
+
+      it { should be_persisted }
+      it { should be_draft }
+      its(:draft_id) { should be_present }
+      its(:draft) { should be_present }
+      its(:draft) { should be_update }
+      its(:name) { should eql 'Bob' }
+      its(:skip_me) { should eql 'Skipped 2' }
+
+      it 'creates a new draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(1)
+      end
+    end
+
+    describe 'changing back to initial state' do
+      before do
+        skipper.published_at = Time.now
+        skipper.save!
+        skipper.name = 'Sam'
+        skipper.draft_update
+        skipper.reload
+        skipper.name = 'Bob'
+        skipper.skip_me = 'Skipped 2'
+      end
+
+      it { should_not be_draft }
+      its(:draft_id) { should be_nil }
+      its(:draft) { should be_nil }
+      its(:name) { should eql 'Bob' }
+      its(:skip_me) { should eql 'Skipped 2' }
+
+      it 'destroys the draft' do
+        expect { subject }.to change(Draftsman::Draft.where(:id => skipper.draft_id), :count).by(-1)
+      end
+    end
+
+    context 'with existing `create` draft' do
+      before { skipper.draft_creation }
+
+      context 'with changes' do
+        before do
+          skipper.name = 'Sam'
+          skipper.skip_me = 'Skipped 2'
+        end
+
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_create }
+        its(:name) { should eql 'Sam' }
+        its(:skip_me) { should eql 'Skipped 2' }
+
+        it 'updates the existing draft' do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => skipper.draft_id), :count)
+        end
+
+        its "draft's `name` is updated" do
+          subject.draft.reify.name.should eql 'Sam'
+        end
+      end
+
+      context 'with no changes' do
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_create }
+        its(:name) { should eql 'Bob' }
+        its(:skip_me) { should eql 'Skipped 1' }
+
+        it "doesn't change the number of drafts" do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => skipper.draft_id), :count)
+        end
+      end
+    end
+
+    context 'with existing `update` draft' do
+      before do
+        skipper.save!
+        skipper.name = 'Sam'
+        skipper.skip_me = 'Skipped 2'
+        skipper.draft_update
+        skipper.reload
+        skipper.attributes = skipper.draft.reify.attributes
+      end
+
+      context 'with changes' do
+        before { skipper.name = 'Steve' }
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_update }
+        its(:name) { should eql 'Bob' }
+        its(:skip_me) { should eql 'Skipped 2' }
+
+        it 'updates the existing draft' do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => skipper.draft_id), :count)
+        end
+
+        its "draft's `name` is updated" do
+          subject.draft.reify.name.should eql 'Steve'
+        end
+      end
+
+      context 'with no changes' do
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_update }
+        its(:name) { should eql 'Bob' }
+        its(:skip_me) { should eql 'Skipped 2' }
+
+        it "doesn't change the number of drafts" do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => skipper.draft_id), :count)
+        end
+
+        its "draft's `name` is not updated" do
+          subject.draft.reify.name.should eql 'Sam'
+        end
+      end
+    end
+  end
+
+  # Not applicable to this customization
+  describe :draft_destroy do
+  end
+
+  # Not applicable to this customization
+  describe 'scopes' do
+  end
+end

data/spec/models/vanilla_spec.rb

@@ -106,6 +106,8 @@ describe Vanilla do
         vanilla.save!
         vanilla.name = 'Sam'
         vanilla.draft_update
+        vanilla.reload
+        vanilla.attributes = vanilla.draft.reify.attributes
       end
 
       context 'with changes' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draftsman
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Chris Peters
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -187,6 +187,7 @@ files:
 - spec/dummy/app/models/bastard.rb
 - spec/dummy/app/models/child.rb
 - spec/dummy/app/models/parent.rb
+- spec/dummy/app/models/skipper.rb
 - spec/dummy/app/models/trashable.rb
 - spec/dummy/app/models/vanilla.rb
 - spec/dummy/app/models/whitelister.rb
@@ -221,6 +222,7 @@ files:
 - spec/models/child_spec.rb
 - spec/models/draft_spec.rb
 - spec/models/parent_spec.rb
+- spec/models/skipper_spec.rb
 - spec/models/trashable_spec.rb
 - spec/models/vanilla_spec.rb
 - spec/models/whitelister_spec.rb
@@ -269,6 +271,7 @@ test_files:
 - spec/dummy/app/models/bastard.rb
 - spec/dummy/app/models/child.rb
 - spec/dummy/app/models/parent.rb
+- spec/dummy/app/models/skipper.rb
 - spec/dummy/app/models/trashable.rb
 - spec/dummy/app/models/vanilla.rb
 - spec/dummy/app/models/whitelister.rb
@@ -303,6 +306,7 @@ test_files:
 - spec/models/child_spec.rb
 - spec/models/draft_spec.rb
 - spec/models/parent_spec.rb
+- spec/models/skipper_spec.rb
 - spec/models/trashable_spec.rb
 - spec/models/vanilla_spec.rb
 - spec/models/whitelister_spec.rb