has_publishing 0.0.3 → 0.0.5

data/README.md

@@ -2,10 +2,12 @@
 
 Mark models as `has_publishing` to publish, draft and embargo models. Easy peasy!
 
+[![Build Status](https://travis-ci.org/3months/has_publishing.png?branch=master)](https://travis-ci.org/3months/has_publishing)
+
 ## Features
 
 * `published`, `draft`, `embargoed` scopes for easy filtering/finding
-* Rails environment-based default scoping: if your site is using `production`, draft/embargoed records will still be found - if you use `RAILS_ENV=production_published`, though, only published records will be found.
+* Rails environment-based default scoping: if your site is using `draft`, draft/embargoed records will still be found - if you use `RAILS_ENV=published`, though, only published records will be found.
 * In use in production on multiple sites
 * Covered by automated tests
 
@@ -39,14 +41,13 @@ bundle exec rails generate migration [YOUR MODEL NAME] embargoed_until:datetime
 
 Publishing is typically used in an environment where there may be two installations of the Rails application sharing a common database. This at least is the set up that `has_publishing` is designed to operate in - something like the following:
 
-
 ```
-|-- Admin RAILS_ENV=production --| >>>>> SharedDatabase <<<<<< |-- Published Site RAILS_ENV=production_published --|
+|-- Admin RAILS_ENV=draft --| >>>>> SharedDatabase <<<<<< |-- Published Site RAILS_ENV=published --|
 ```
 
 Because of this, the gem applies a default_scope to all instances of this model to either:
 
-* Only return published records if `Rails.env` matches `HasPublishing.config.published_rails_environment`
+* Only return published records if `Rails.env` matches `HasPublishing.config.published_rails_environment` (which by default is `'published'`)
 * Only return draft records otherwise
 
 This prevents 'duplicate' records from appearing for the user (since each 'record' has two representations - 'draft' and 'published/withdrawn')
@@ -57,6 +58,16 @@ This prevents 'duplicate' records from appearing for the user (since each 'recor
 2. If you want the default scope to apply properly, ensure that you set the Rails environment of your **published** application in `HasPublishing.config.published_rails_environment`.
 
 
+## Injecting your own attributes to be saved
+
+When you call `publish!` and `withdraw!` you can pass a hash of attributes with it to be updated with your `ActiveRecord::Model` object. 
+
+This is usefull if you are using a gem like [ancestry](https://github.com/stefankroes/ancestry "ancestry"), for example:
+
+``` ruby
+  @page = Page.find_by_slug('foo-bar-page')
+  @page.publish!(:parent => (@page.parent.published unless @page.is_root?))
+```
 
 ## Contributing
 

data/lib/generators/has_publishing/publishing_generator.rb

@@ -1,28 +1,29 @@
 require 'rails/generators'
 require 'rails/generators/migration'
 
-class HasPublishing::PublishingGenerator < ::Rails::Generators::Base
-  include Rails::Generators::Migration
+module HasPublishing
+  class PublishingGenerator < ::Rails::Generators::NamedBase
+    include Rails::Generators::Migration
 
-  def self.source_root
-    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
-  end
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
 
-  def self.next_migration_number(dirname)
-    if ActiveRecord::Base.timestamped_migrations
-      Time.new.utc.strftime("%Y%m%d%H%M%S")
-    else
-      "%.3d" % (current_migration_number(dirname) + 1)
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.new.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
     end
-  end
 
-  def create_migration_file
-    set_local_assigns!
-    validate_file_name!
-    migration_template 'migration.rb', "db/migrate/publishing_fields_for_#{@table_name}.rb"
-  end
+    def create_migration_file
+      set_local_assigns!
+      migration_template 'migration.erb', "db/migrate/publishing_fields_for_#{@table_name}.rb"
+    end
 
-  def set_local_assigns!
-    @table_name = file_name.pluralize
+    def set_local_assigns!
+      @table_name = file_name.pluralize
+    end
   end
 end

data/lib/generators/has_publishing/templates/{migration.rb.erb → migration.erb}

@@ -1,6 +1,6 @@
 class PublishingFieldsFor<%= @table_name %> < ActiveRecord::Migration
   def self.change
-    change_table <%= @table_name %> do |t|
+    change_table :<%= @table_name %> do |t|
       t.datetime :published_at 
       t.datetime :embargoed_until
       t.string   :kind, :null => false, :index => true

data/lib/has_publishing/configuration.rb

@@ -3,5 +3,5 @@ module HasPublishing
 
   # Set some default config
   self.config.scope_records = true
-  self.config.published_rails_environment = "production"
+  self.config.published_rails_environment = "published"
 end

data/lib/has_publishing/instance_methods.rb

@@ -28,11 +28,11 @@ module HasPublishing
       }
     end
 
-    def withdraw!
+    def withdraw!(extra_attrs = {})
       self.class.unscoped {
         return false unless draft? && ever_published?
         self.class.record_timestamps = false # want same updated_at
-        published.update_attributes!(:kind => 'withdrawn') and update_attributes!(published.attributes.merge({:kind => 'draft', :published_id => published_id, :published_at => nil, :dirty => false}))
+        published.update_attributes!(:kind => 'withdrawn') and update_attributes!(published.attributes.merge({:kind => 'draft', :published_id => published_id, :published_at => nil, :dirty => false}).merge(extra_attrs))
         self.class.record_timestamps = true
         return published
       }

data/lib/has_publishing/version.rb

@@ -1,3 +1,3 @@
 module HasPublishing
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/spec/has_publishing_spec.rb

@@ -67,7 +67,7 @@ describe "has_publishing" do
 
   describe "default configuration" do
     it { HasPublishing.config.scope_records.should be_true }
-    it { HasPublishing.config.published_rails_environment.should eq "production" }
+    it { HasPublishing.config.published_rails_environment.should eq "published" }
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_publishing
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -90,7 +90,7 @@ files:
 - Rakefile
 - has_publishing.gemspec
 - lib/generators/has_publishing/publishing_generator.rb
-- lib/generators/has_publishing/templates/migration.rb.erb
+- lib/generators/has_publishing/templates/migration.erb
 - lib/has_publishing.rb
 - lib/has_publishing/class_methods.rb
 - lib/has_publishing/configuration.rb
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1806748744446144412
+      hash: 3211080172926096539
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,10 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1806748744446144412
+      hash: 3211080172926096539
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Add publishing to your ActiveRecord models