draftsman 0.5.1 → 0.6.0

data/lib/draftsman.rb

@@ -78,24 +78,45 @@ module Draftsman
     Draftsman.config.serializer = value
   end
 
+  # Sets whether or not `#save_draft` should stash drafted changes into the
+  # associated draft record or persist them to the main item.
+  def self.stash_drafted_changes=(value)
+    Draftsman.config.stash_drafted_changes = value
+  end
+
+  # Returns setting for whether or not `#save_draft` should stash drafted
+  # changes into the associated draft record.
+  def self.stash_drafted_changes?
+    Draftsman.config.stash_drafted_changes?
+  end
+
   # Returns who is reponsible for any changes that occur.
   def self.whodunnit
     draftsman_store[:whodunnit]
   end
 
-  # Sets who is responsible for any changes that occur.
-  # You would normally use this in a migration or on the console,
-  # when working with models directly.  In a controller, it is set
-  # automatically to the `current_user`.
+  # Sets who is responsible for any changes that occur. You would normally use
+  # this in a migration or on the console when working with models directly. In
+  # a controller, it is set automatically to the `current_user`.
   def self.whodunnit=(value)
     draftsman_store[:whodunnit] = value
   end
 
+  # Returns the field which records whodunnit data.
+  def self.whodunnit_field
+    Draftsman.config.whodunnit_field
+  end
+
+  # Sets global attribute name for `whodunnit` data.
+  def self.whodunnit_field=(field_name)
+    Draftsman.config.whodunnit_field = field_name
+  end
+
 private
 
   # Thread-safe hash to hold Draftman's data. Initializing with needed default values.
   def self.draftsman_store
-    Thread.current[:draft] ||= { :draft_class_name => 'Draftsman::Draft' }
+    Thread.current[:draft] ||= { draft_class_name: 'Draftsman::Draft' }
   end
 
   # Returns Draftman's configuration object.

data/lib/generators/draftsman/templates/config/initializers/draftsman.rb

@@ -1,15 +1,24 @@
-# Override global `draft` class. For example, perhaps you want your own class at `app/models/draft.rb` that adds
-# extra attributes, validations, associations, methods, etc. Be sure that this new model class extends
-# `Draftsman::Draft`.
+# Override global `draft` class. For example, perhaps you want your own class at
+# `app/models/draft.rb` that adds extra attributes, validations, associations,
+# methods, etc. Be sure that this new model class extends `Draftsman::Draft`.
 # Draftsman.draft_class_name = 'Draftsman::Draft'
 
-# Serializer for `object`, `object_changes`, and `previous_draft` columns. To use the JSON serializer, change to
-# `Draftsman::Serializers::Json`. You could implement your own serializer if you really wanted to. See files in
+# Serializer for `object`, `object_changes`, and `previous_draft` columns. To
+# use the JSON serializer, change to `Draftsman::Serializers::Json`. You could
+# implement your own serializer if you really wanted to. See files in
 # `lib/draftsman/serializers`.
 #
-# Note: this option is not needed if you're using the PostgreSQL JSON data type for the `object`,
-# `object_changes`, and `previous_draft` columns.
+# Note: this option is not needed if you're using the PostgreSQL JSON data type
+# for the `object`, `object_changes`, and `previous_draft` columns.
 # Draftsman.serializer = Draftsman::Serializers::Json
 
 # Field which records when a draft was created.
 # Draftsman.timestamp_field = :created_at
+
+# Field which records who last recorded the draft.
+# Draftsman.whodunnit_field = :whodunnit
+
+# Whether or not to stash draft data in the `Draftsman::Draft` record. If set to
+# `false`, all changes will be persisted to the main record and will not be
+# persisted to the draft record's `object` column.
+# Draftsman.stash_drafted_changes = true

data/spec/draftsman_spec.rb

@@ -1,25 +1,23 @@
 require 'spec_helper.rb'
 
 describe ::Draftsman do
-  subject { ::Draftsman }
-
   it 'passes our sanity test' do
-    expect(subject).to be_a Module
+    expect(::Draftsman).to be_a Module
   end
 
-  describe :whodunnit do
-    before(:all) { ::Draftsman.whodunnit = 'foobar' }
+  describe '.whodunnit' do
+    before(:all) { ::Draftsman.whodunnit = :foobar }
 
     it 'clears out `whodunnit` before each test' do
-      expect(subject.whodunnit).to be_nil
+      expect(::Draftsman.whodunnit).to be_nil
     end
   end
 
-  describe :controller_info do
-    before(:all) { ::Draftsman.controller_info = { foo: 'bar' } }
+  describe '.controller_info' do
+    before(:all) { ::Draftsman.controller_info = { foo: :bar } }
 
     it 'clears out `controller_info` before each test' do
-      expect(subject.controller_info).to eql Hash.new
+      expect(::Draftsman.controller_info).to eql Hash.new
     end
   end
 end

data/spec/dummy/app/controllers/application_controller.rb

@@ -3,14 +3,14 @@ class ApplicationController < ActionController::Base
   before_action :set_draftsman_whodunnit
 
   def create
-    Trashable.new(name: 'Bob').draft_creation
+    Trashable.new(name: 'Bob').save_draft
     head :no_content
   end
 
   def update
     trashable = Trashable.last
     trashable.name = 'Sam'
-    trashable.draft_update
+    trashable.save_draft
     head :no_content
   end
 

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

@@ -0,0 +1,7 @@
+require 'draftsman/draft'
+
+class OverriddenDraft < Draftsman::Draft
+  def im_overridden
+    true
+  end
+end

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

@@ -2,65 +2,43 @@ class Talkative < ActiveRecord::Base
   has_drafts
 
   # draft_creation callbacks
-  before_draft_creation :do_this_before_draft_creation
-  around_draft_creation :do_this_around_draft_creation
-  after_draft_creation :do_this_after_draft_creation
+  before_save_draft :do_this_before_save
+  around_save_draft :do_this_around_save
+  after_save_draft :do_this_after_save
 
-  # draft_update callbacks
-  before_draft_update :do_this_before_draft_update
-  around_draft_update :do_this_around_draft_update
-  after_draft_update :do_this_after_draft_update
-
-  # # draft_destruction callbacks
-  before_draft_destruction :do_this_before_draft_destruction
-  around_draft_destruction :do_this_around_draft_destruction
-  after_draft_destruction :do_this_after_draft_destruction
+  # draft_destruction callbacks
+  before_draft_destruction :do_this_before_destruction
+  around_draft_destruction :do_this_around_destruction
+  after_draft_destruction :do_this_after_destruction
 
 private
 
-  def do_this_before_draft_creation
-    self.before_comment = "I changed before creation"
+  def do_this_before_save
+    self.before_comment = 'I changed before save'
   end
 
-  def do_this_around_draft_creation
-    self.around_early_comment = "I changed around creation (before yield)"
+  def do_this_around_save
+    self.around_early_comment = 'I changed around save (before yield)'
     yield
-    self.around_late_comment = "I changed around creation (after yield)"
-  end
-
-  def do_this_after_draft_creation
-    self.after_comment = "I changed after creation"
+    self.around_late_comment = 'I changed around save (after yield)'
   end
 
-
-
-  def do_this_before_draft_update
-    self.before_comment = "I changed before update"
+  def do_this_after_save
+    self.after_comment = 'I changed after save'
   end
 
-  def do_this_around_draft_update
-    self.around_early_comment = "I changed around update (before yield)"
-    yield
-    self.around_late_comment = "I changed around update (after yield)"
-  end
-
-  def do_this_after_draft_update
-    self.after_comment = "I changed after update"
-  end
-
-
 
-  def do_this_before_draft_destruction
-    self.before_comment = "I changed before destroy"
+  def do_this_before_destruction
+    self.before_comment = 'I changed before destroy'
   end
 
-  def do_this_around_draft_destruction
-    self.around_early_comment = "I changed around destroy (before yield)"
+  def do_this_around_destruction
+    self.around_early_comment = 'I changed around destroy (before yield)'
     yield
-    self.around_late_comment = "I changed around destroy (after yield)"
+    self.around_late_comment = 'I changed around destroy (after yield)'
   end
 
-  def do_this_after_draft_destruction
-    self.after_comment = "I changed after destroy"
+  def do_this_after_destruction
+    self.after_comment = 'I changed after destroy'
   end
 end

data/spec/dummy/db/schema.rb

@@ -43,6 +43,7 @@ ActiveRecord::Schema.define(version: 20160328184419) do
     t.integer  "item_id"
     t.string   "event",          null: false
     t.string   "whodunnit"
+    t.integer  "user_id"
     t.text     "object"
     t.text     "object_changes"
     t.text     "previous_draft"

data/spec/models/child_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe Child, :type => :model do
-  let(:parent) { Parent.new(:name => 'Marge') }
-  let(:child)  { Child.new(:name => 'Lisa', :parent => parent) }
+RSpec.describe Child, type: :model do
+  let(:parent) { Parent.new(name: 'Marge') }
+  let(:child)  { Child.new(name: 'Lisa', parent: parent) }
 
   describe 'publish!' do
     context 'parent `create` draft with child `create` draft' do
       before do
-        parent.draft_creation
-        child.draft_creation
+        parent.save_draft
+        child.save_draft
       end
 
       subject { child.draft.publish! }
@@ -77,8 +77,8 @@ describe Child, :type => :model do
   describe 'revert!' do
     context 'parent `create` draft with child `create` draft' do
       before do
-        parent.draft_creation
-        child.draft_creation
+        parent.save_draft
+        child.save_draft
       end
 
       subject { child.draft.revert! }
@@ -111,7 +111,7 @@ describe Child, :type => :model do
       subject do
         child.draft.revert!
         parent.reload
-        child.reload 
+        child.reload
       end
 
       it 'does not persist the child' do
@@ -153,8 +153,8 @@ describe Child, :type => :model do
   describe 'draft_publication_dependencies' do
     context 'parent `create` draft with child `create` draft' do
       before do
-        parent.draft_creation
-        child.draft_creation
+        parent.save_draft
+        child.save_draft
       end
 
       subject { child.draft }
@@ -170,10 +170,10 @@ describe Child, :type => :model do
 
     context 'parent `create` draft with child `update` draft' do
       before do
-        parent.draft_creation
+        parent.save_draft
         child.save!
         child.name = 'Heather'
-        child.draft_update
+        child.save_draft
       end
 
       subject { child.draft }
@@ -191,11 +191,11 @@ describe Child, :type => :model do
       let(:new_parent) { Parent.new(:name => 'Patty') }
 
       before do
-        parent.draft_creation
+        parent.save_draft
         child.save!
-        new_parent.draft_creation
+        new_parent.save_draft
         child.parent = new_parent
-        child.draft_update
+        child.save_draft
       end
 
       subject { child.draft }
@@ -231,8 +231,8 @@ describe Child, :type => :model do
   describe 'draft_reversion_dependencies' do
     context 'parent `create` draft with child `create` draft' do
       before do
-        parent.draft_creation
-        child.draft_creation
+        parent.save_draft
+        child.save_draft
       end
 
       subject { child.draft }