conscript 0.1.0 → 0.2.1

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## v0.2.1
+
+* Fixed bug where associated `has_many` records with CarrierWave uploads were not duplicated correctly - uploaded files are now copied
+* Fixed bug where destroying a draft would remove an uploaded file from its draft parent if they shared the same file.
+* Fixed bug where drafts were destroyed before publish_Draft was successful
+* Added an ActiveRecord error where `save` fails if drafts exist for an instance
+
+## v0.2.0
+
+* Now defines a `published` scope rather than a `default_scope`. This avoids a number of complexities especially around validations and polymorphic relationships.
+
+## v0.1.1
+
+* CarrierWave uplaods on associated records are now cloned correctly.
+
+## v0.1.0
+
+* Additional callbacks added to allow bespoke behaviour around the save as draft and publish draft lifecycles.
+* Additional options added to remove previously documented limitations.
+
+## v0.0.1
+
+* First release.

data/README.md

@@ -1,6 +1,6 @@
 # Conscript
 
-Provides ActiveRecord models with a `drafts` scope, and the functionality to create draft instances and publish them.
+Provides ActiveRecord models with `drafts` and `published` scopes, and the functionality to create draft instances and publish them.
 
 Existing instances may have one or more draft versions which are initially created by duplication, including any required associations. A draft may then be published, overwriting the original instance.
 
@@ -46,13 +46,16 @@ To use the drafts functionality, call `register_for_draft` in your ActiveRecord
       register_for_draft
     end
 
-A `default_scope` is then set to exclude all draft instances from finders. You may use the `drafts` scope to access them:
+This registers `published` and `drafts` scopes on the model. You may use these scopes as with any other scope:
+
+    Article.published
+
+Or:
 
     Article.drafts
 
-If you need to access drafts and original instances together, use `unscoped` as you would any other `default_scope`:
+You'll therefore need to modify any existing code to use the `published` scope where you don't want to show drafts.
 
-    Article.unscoped.all
 
 ### Instance methods
 
@@ -127,19 +130,6 @@ This will result in uploads for drafts being stored in the same location as the
 
 Conscript also overrides CarrierWave's `#destroy` callbacks to ensure that no other instance is using the same file before deleting it from the filesystem. Otherwise this can happen when you delete a draft with the same file as the original instance.
 
-
-### Gotchas
-
-If saving drafts of models with `has_many` associations, the associated model should define a reciprocal `belongs_to` relationship (as normal). However, if it also has a presence validation e.g. `validates parent_model_name, presence: true` then you will encounter a limitation of ActiveRecord's default scopes. To avoid this when saving drafts with associations, wrap your save code with a `Model.unscoped` block, e.g:
-
-    Article.unscoped { draft = article.save_as_draft! }
-
-Or if updating an existing draft:
-
-    Article.unscoped { draft.save! }
-
-Otherwise you'll encounter a validation error.
-
 ## Contributing
 
 1. Fork it

data/lib/conscript/orm/activerecord.rb

@@ -21,15 +21,13 @@ module Conscript
       self.conscript_options[:ignore_attributes].map!(&:to_s)
       self.conscript_options.update options.slice(:allow_update_with_drafts, :destroy_drafts_on_publish)
 
-      default_scope { where(is_draft: false) }
-
       belongs_to :draft_parent, class_name: self
       has_many :drafts, conditions: {is_draft: true}, class_name: self, foreign_key: :draft_parent_id, dependent: :destroy, inverse_of: :draft_parent
 
       define_callbacks :publish_draft, :save_as_draft
 
       before_save :check_no_drafts_exist if (self.conscript_options[:allow_update_with_drafts] == false)
-      set_callback :publish_draft, :before, :destroy_all_drafts if (self.conscript_options[:destroy_drafts_on_publish] == true)
+      set_callback :publish_draft, :after, :destroy_all_drafts if (self.conscript_options[:destroy_drafts_on_publish] == true)
 
       # Prevent deleting CarrierWave uploads which may be used by other instances. Uploaders must be mounted beforehand.
       if self.respond_to? :uploaders
@@ -38,6 +36,10 @@ module Conscript
       end
 
       class_eval <<-RUBY
+        def self.published
+          where(is_draft: false)
+        end
+
         def self.drafts
           where(is_draft: true)
         end
@@ -45,10 +47,15 @@ module Conscript
         def save_as_draft!
           run_callbacks :save_as_draft do
             raise Conscript::Exception::AlreadyDraft if is_draft?
-            draft = new_record? ? self : dup(include: self.class.conscript_options[:associations])
+            draft = new_record? ? self : dup(include: self.class.conscript_options[:associations]) do |original, dup|
+              # Workaround for CarrierWave uploaders on associated records. Copy the uploaded files.
+              if dup.class.respond_to? :uploaders
+                dup.class.uploaders.keys.each {|uploader| dup.send(uploader.to_s + "=", original.send(uploader)) }
+              end
+            end
             draft.is_draft = true
             draft.draft_parent = self unless new_record?
-            self.class.base_class.unscoped { draft.save! }
+            draft.save!
             draft
           end
         end
@@ -63,10 +70,16 @@ module Conscript
               self.class.conscript_options[:associations].each do |association|
                 case reflections[association].macro
                   when :has_many
-                    draft_parent.send(association.to_s + "=", self.send(association).collect {|child| child.dup })
+                    draft_parent.send(association.to_s + "=", self.send(association).collect {|child| child.dup do |original, dup|
+                      # Workaround for CarrierWave uploaders on associated records. Copy the uploaded files.
+                      if dup.class.respond_to? :uploaders
+                        dup.class.uploaders.keys.each {|uploader| dup.send(uploader.to_s + "=", original.send(uploader)) }
+                      end
+                    end })
                 end
               end
 
+              self.destroy
               draft_parent.save!
             end
             draft_parent
@@ -79,6 +92,7 @@ module Conscript
 
         private
           def check_no_drafts_exist
+            errors[:base] << "Cannot save record while drafts exist"
             drafts.count == 0
           end
 
@@ -91,7 +105,8 @@ module Conscript
           def clean_uploaded_files_for_draft!
             self.class.uploaders.keys.each do |attribute|
               filename = attributes[attribute.to_s]
-              self.send("remove_" + attribute.to_s + "!") if !draft_parent_id or draft_parent.drafts.where(attribute => filename).count == 0
+              cols = self.class.arel_table
+              self.send("remove_" + attribute.to_s + "!") if !draft_parent_id or self.class.where(cols[:id].eq(draft_parent_id).or(cols[:draft_parent_id].eq(draft_parent_id))).where(attribute => filename).count == 0
             end
           end
 

data/lib/conscript/version.rb

@@ -1,3 +1,3 @@
 module Conscript
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/spec/conscript/orm/activerecord_spec.rb

@@ -11,11 +11,6 @@ describe Conscript::ActiveRecord do
       Widget.respond_to?(:register_for_draft).should == true
     end
 
-    it "creates the default scope" do
-      Widget.should_receive(:default_scope).once
-      Widget.register_for_draft
-    end
-
     it "creates a belongs_to association" do
       Widget.should_receive(:belongs_to).once.with(:draft_parent, kind_of(Hash))
       Widget.register_for_draft
@@ -60,7 +55,7 @@ describe Conscript::ActiveRecord do
             Widget.register_for_draft(destroy_drafts_on_publish: true)
             callback = Widget._publish_draft_callbacks.first
             callback.filter.should == :destroy_all_drafts
-            callback.kind.should == :before
+            callback.kind.should == :after
           end
         end
 
@@ -100,6 +95,14 @@ describe Conscript::ActiveRecord do
     end
   end
 
+  describe "#published" do
+    it "limits results to published" do
+      Widget.register_for_draft
+      Widget.should_receive(:where).once.with(is_draft: false)
+      Widget.published
+    end
+  end
+
   describe "#drafts" do
     it "limits results to drafts" do
       Widget.register_for_draft
@@ -123,6 +126,7 @@ describe Conscript::ActiveRecord do
         @subject.send(:check_no_drafts_exist).should == true
       end
     end
+
     context "when drafts exist" do
       before do
         @subject.stub_chain(:drafts, :count).and_return(1)
@@ -131,6 +135,12 @@ describe Conscript::ActiveRecord do
       it "returns false" do
         @subject.send(:check_no_drafts_exist).should == false
       end
+
+      it "adds an error" do
+        @subject.errors[:base].should be_empty
+        @subject.send(:check_no_drafts_exist)
+        @subject.errors[:base].should_not be_empty
+      end
     end
   end
 
@@ -235,7 +245,7 @@ describe Conscript::ActiveRecord do
       context "and has associations" do
         before do
           @subject.save!
-          @subject.thingies.create(name: 'Thingy')
+          @subject.thingies.create(name: 'Thingy', file: 'test.jpg')
         end
 
         context "and the association is not specified in register_for_draft" do
@@ -250,17 +260,26 @@ describe Conscript::ActiveRecord do
         end
 
         context "and the association is specified in register_for_draft" do
-          before do
+          it "duplicates the associated records" do
             Widget.register_for_draft associations: :thingies
             @duplicate = @subject.save_as_draft!
-          end
 
-          it "duplicates the associated records" do
             @subject.thingies.count.should == 1
             @duplicate.thingies.count.should == 1
             @duplicate.thingies.first.name.should == @subject.thingies.first.name
             @duplicate.thingies.first.id.should_not == @subject.thingies.first.id
           end
+
+          it "copies the uploader attributes using the setter" do
+            Thingy.cattr_accessor :uploaders do
+              {file: nil}
+            end
+
+            Widget.register_for_draft associations: :thingies
+
+            Thingy.any_instance.should_receive(:file=)
+            @duplicate = @subject.save_as_draft!
+          end
         end
       end
     end

data/spec/support/widget_migration.rb

@@ -11,6 +11,7 @@ class WidgetMigration < ActiveRecord::Migration
     create_table :thingies, :force => true do |t|
       t.references :widget
       t.string :name
+      t.string :file
       t.timestamps
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conscript
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000Z
+date: 2013-07-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70155455728440 !ruby/object:Gem::Requirement
+  requirement: &70350313257540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.3.5
   type: :development
   prerelease: false
-  version_requirements: *70155455728440
+  version_requirements: *70350313257540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70155455727800 !ruby/object:Gem::Requirement
+  requirement: &70350313257120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70155455727800
+  version_requirements: *70350313257120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70155455727040 !ruby/object:Gem::Requirement
+  requirement: &70350313256600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70155455727040
+  version_requirements: *70350313256600
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70155455726620 !ruby/object:Gem::Requirement
+  requirement: &70350313256180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70155455726620
+  version_requirements: *70350313256180
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70155455726120 !ruby/object:Gem::Requirement
+  requirement: &70350313255560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 3.2.13
   type: :runtime
   prerelease: false
-  version_requirements: *70155455726120
+  version_requirements: *70350313255560
 - !ruby/object:Gem::Dependency
   name: deep_cloneable
-  requirement: &70155455725600 !ruby/object:Gem::Requirement
+  requirement: &70350313254920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70155455725600
+  version_requirements: *70350313254920
 description: Provides ActiveRecord models with draft instances, including associations
 email:
 - steve@stevelorek.com
@@ -86,6 +86,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md