has_publishing 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/has_publishing_test.db

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_publishing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 3months
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# HasPublishing
+
+Mark models as `has_publishing` to publish, draft and embargo models. Easy peasy!
+
+## 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.
+* In use in production on multiple sites
+* Covered by automated tests
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_publishing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_publishing
+
+## Usage
+
+Simply add `has_publishing` to the model of your choice, and then generate the publishing attributes for your model:
+
+``` bash
+bundle exec rails generate migration [YOUR MODEL NAME] embargoed_until:datetime published_at:datetime published_id:integer kind:string
+```
+
+…and then of course run `rake db:migrate`
+
+(If anyone would like to add a generator to automate this process, it would be very much appreciated)
+
+## A note on publishing
+
+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 --|
+```
+
+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 draft records otherwise
+
+This prevents 'duplicate' records from appearing for the user (since each 'record' has two representations - 'draft' and 'published/withdrawn')
+
+### So:
+
+1. If you would prefer that this default scope **NOT** be applied, then simply set `HasPublishing.config.scope_records` to `false`. 
+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`.
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/has_publishing.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_publishing/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "has_publishing"
+  gem.version       = HasPublishing::VERSION
+  gem.authors       = ["Josh McArthur @ 3months"]
+  gem.email         = ["joshua.mcarthur@gmail.com"]
+  gem.description   = %q{Add ability to draft/publish/withdraw/embargo models}
+  gem.summary       = %q{Add publishing to your ActiveRecord models}
+  gem.homepage      = "https://github.com/3months/has_publishing"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activerecord"
+  gem.add_dependency "activesupport"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/has_publishing/class_methods.rb

@@ -0,0 +1,18 @@
+module HasPublishing
+  module ClassMethods
+    # This default scope allows published and draft viewing modes to share the
+    # same code. This is good. However if you need to access the other, draft
+    # from published or published from draft e.g from admin for editing, then
+    # you must explicitly use .unscoped to remove the default scope.
+
+    def default_scope
+      return scoped if HasPublishing.config.scope_records == false
+
+      if Rails.env == (HasPublishing.config.published_rails_environment)
+        published
+      else
+        draft
+      end
+    end
+  end
+end

data/lib/has_publishing/configuration.rb

@@ -0,0 +1,7 @@
+module HasPublishing
+  include ActiveSupport::Configurable
+
+  # Set some default config
+  self.config.scope_records = true
+  self.config.published_rails_environment = "production"
+end

data/lib/has_publishing/generators/publishing_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class HasPublishing::Generators::PublishingGenerator < ::Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  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)
+    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 set_local_assigns!
+    @table_name = file_name.pluralize
+  end
+end

data/lib/has_publishing/generators/templates/migration.rb.erb

@@ -0,0 +1,13 @@
+class PublishingFieldsFor<%= @table_name %> < ActiveRecord::Migration
+  def self.change
+    change_table <%= @table_name %> do |t|
+      t.datetime :published_at 
+      t.datetime :embargoed_until
+      t.string   :kind, :null => false, :index => true
+      t.boolean  :dirty
+
+      # These should already be present
+      t.timestamps
+    end
+  end
+end

data/lib/has_publishing/instance_methods.rb

@@ -0,0 +1,72 @@
+module HasPublishing
+  module InstanceMethods
+
+
+    # Publishing "states"
+    #   Draft         = draft only (no published version, i.e new)
+    #   Dirty         = published + draft dirty (this is a kind of Draft state,
+    #                                            has been published but draft has been edited since)
+    #   Published     = published + draft NOT dirty
+    #   Under imbargo = published but future dated (embargo_until field)
+
+
+    def publish!(extra_attrs = {})
+      self.save! if self.new_record?
+      self.class.unscoped {
+        return false unless draft?
+        if published.nil? # first time publishing
+          published_obj = self.class.create!(attributes.merge(:kind => 'published', :published_at => Time.zone.now, :dirty => nil).merge(extra_attrs))
+          self.published_id = published_obj.id
+        else
+          published.update_attributes!(attributes.merge(:kind => 'published', :published_id => nil, :published_at => Time.zone.now, :dirty => nil).merge(extra_attrs))
+        end
+        self.class.record_timestamps = false # want same updated_at
+        self.save! # make sure this model is in sync
+        update_attributes!(:published_at => published.published_at, :dirty => false, :updated_at => published.updated_at)
+        self.class.record_timestamps = true
+        return published
+      }
+    end
+
+    def withdraw!
+      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}))
+        self.class.record_timestamps = true
+        return published
+      }
+    end
+
+    def draft?
+      kind == 'draft'
+    end
+
+    def published?
+      self.class.unscoped { (draft? && published && published.kind == 'published') || kind == 'published' }
+    end
+
+    def withdrawn?
+      self.class.unscoped { (draft? && published && published.kind == 'withdrawn') || kind == 'withdrawn' }
+    end
+
+    def ever_published?
+      published? || withdrawn?
+    end
+
+    def under_embargo?
+      published? && embargoed_until && embargoed_until > Time.zone.now
+    end
+
+    private
+
+    def set_dirty
+      self.class.unscoped { update_attributes(:dirty => true) if draft? && published && published.updated_at != updated_at && !dirty? && !withdrawn? }
+    end
+
+    def set_draft
+      self.kind = 'draft' if kind.nil?
+    end
+
+  end
+end

data/lib/has_publishing/version.rb

@@ -0,0 +1,3 @@
+module HasPublishing
+  VERSION = "0.0.1"
+end

data/lib/has_publishing.rb

@@ -0,0 +1,30 @@
+require 'has_publishing/version'
+require 'has_publishing/class_methods'
+require 'has_publishing/instance_methods'
+require 'has_publishing/configuration'
+
+
+class << ActiveRecord::Base
+  def has_publishing
+
+    # Include instance methods
+    include HasPublishing::InstanceMethods
+
+    # Include dynamic class methods
+    extend HasPublishing::ClassMethods
+
+
+    scope :published, lambda { where(:kind => "published").not_embargoed }
+    scope :draft, where(:kind => 'draft')
+
+    scope :embargoed, lambda { where("embargoed_until IS NOT NULL AND ? > embargoed_until", Time.zone.now.round) }
+    scope :not_embargoed, lambda { where("embargoed_until IS NULL OR embargoed_until < ?", Time.zone.now.round) }
+
+    before_create :set_draft
+    after_save :set_dirty
+
+    belongs_to :published, :class_name => self.name, :foreign_key => :published_id, :dependent => :destroy
+    has_one :draft, :class_name => self.name, :foreign_key => :published_id
+
+  end
+end

data/spec/has_publishing_spec.rb

@@ -0,0 +1,328 @@
+require 'active_record'
+require 'ostruct'
+require 'has_publishing'
+
+
+# This should be all of the rails we need
+class Rails
+  @@env = "draft"
+  def self.env
+    @@env
+  end
+
+  def self.env=(env)
+    @@env = env
+  end
+end
+
+class Time
+  def self.zone
+    OpenStruct.new(:now => Time.now)
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'has_publishing_test.db')
+)
+
+
+class CreateTestModels < ActiveRecord::Migration
+  def self.up
+    if ActiveRecord::Base.connection.table_exists? "test_models"
+      drop_table :test_models
+    end
+
+    create_table :test_models do |t|
+      t.datetime :published_at
+      t.datetime :embargoed_until
+      t.string :kind
+      t.boolean :dirty
+      t.references :published
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :test_models
+  end
+end
+
+CreateTestModels.migrate(:up)
+
+class TestModel < ActiveRecord::Base
+  has_publishing
+end
+
+describe "has_publishing" do
+
+  before do
+    TestModel.delete_all
+  end
+
+  subject do
+    TestModel.new
+  end
+
+  describe "default configuration" do
+    it { HasPublishing.config.scope_records.should be_true }
+    it { HasPublishing.config.published_rails_environment.should eq "production" }
+  end
+
+
+  describe "scopes" do
+
+    describe "default scope" do
+      context "scope_records is false" do
+        before do
+          HasPublishing.config.scope_records = false
+        end
+
+        it "should not append any conditions" do
+          TestModel.should_not_receive(:where)
+          TestModel.first
+        end
+      end
+
+      context "rails production is published" do
+        before do
+          HasPublishing.config.scope_records = true
+          HasPublishing.config.published_rails_environment = "production"
+          Rails.env = "production"
+        end
+
+        after do
+          HasPublishing.config.scope_records = false
+        end
+
+        it "should only return published records" do
+          TestModel.should_receive(:published).at_least(:once)
+          TestModel.first
+        end
+
+        it "should not return embargoed records" do
+          TestModel.should_receive(:not_embargoed)
+          TestModel.first
+        end
+      end
+    end
+
+    describe "draft" do
+      it "should include a draft record" do
+        subject.kind = 'draft'
+        subject.save
+
+        subject.class.draft.should include subject
+      end
+
+      it "should not include a published record" do
+        subject.kind = 'published'
+        subject.save
+
+        subject.class.draft.should_not include subject
+      end
+    end
+
+    describe "published" do
+      it "should include a published record" do
+        subject.kind = 'published'
+        subject.save! 
+        subject.class.unscoped.published.should include subject
+      end
+
+      it "should not include a draft record" do
+        subject.kind = 'draft'
+        subject.save
+        subject.class.published.should_not include subject
+      end
+    end
+
+    describe "embargoed" do
+      it "should include an embargoed record" do
+        subject.embargoed_until = Time.now - 3600
+        subject.save
+
+        subject.class.embargoed.should include subject
+      end
+
+      it "should not include an embargoed record whose time has not passed" do
+        subject.embargoed_until = Time.now + 5.minutes
+        subject.save
+        subject.class.embargoed.should_not include subject
+      end
+    end
+
+    describe "non_embargoed" do
+      it "should include a non embargoed record" do
+        subject.save
+        subject.class.not_embargoed.should include subject
+      end
+
+      it "should include a non-expired embargoed record" do
+        subject.embargoed_until = Time.now - 3600
+        subject.save
+        subject.class.not_embargoed.should include subject
+      end
+
+      it "should not include an embargoed record" do
+        subject.embargoed_until = Time.now + 3600
+        subject.save
+        subject.class.not_embargoed.should_not include subject
+      end
+    end
+  end
+
+  describe "associations" do
+    it { subject.methods.should include :draft }
+    it { subject.methods.should include :published_id }
+  end
+
+  describe "callbacks" do
+    it "should set the default status to draft" do
+      subject.save
+      subject.kind.should eq "draft"
+    end
+
+    it "should not change the status if it is already set" do
+      subject.kind = "published"
+      subject.save
+      subject.kind.should_not eq "draft"
+    end
+
+    it "should set the record to dirty once it has been created and is already published" do
+      subject.kind = "draft"
+      subject.published = TestModel.new(:updated_at => Time.now)  
+      subject.save
+      subject.dirty.should be_true
+    end
+  end
+
+  describe "instance methods" do
+    describe "publish!" do
+      before do
+        subject.kind = "draft"
+        subject.save
+      end
+
+      context "first time publishing" do
+        it "should create a published record" do
+          subject.class.should_receive(:create!).and_call_original
+          subject.publish!
+        end
+
+        it "should set the inverse record on the original" do
+          expect {
+            subject.publish!
+          }.to change(subject, :published).to(an_instance_of(TestModel))
+        end
+
+        it "should record the published date" do
+          expect {
+            subject.publish!
+          }.to change(subject, :published_at).to(an_instance_of(Time))
+        end
+      end
+    end
+
+    describe "withdraw!" do
+      before do
+        subject.kind = 'draft'
+        subject.save
+      end
+
+      it "should not withdraw if the record is not published" do
+        subject.withdraw!.should be_false
+      end
+
+      it "should withdraw the published record" do
+        subject.publish!
+        subject.withdraw!
+        subject.withdrawn?.should be_true
+      end
+    end
+
+    describe "draft?" do
+      it { subject.kind = "draft"; subject.draft?.should be_true }
+      it { subject.kind = "published"; subject.draft?.should be_false }
+    end
+
+    describe "published?" do
+      context "record is draft, inverse is published" do
+        before do
+          subject.kind = 'draft'
+          subject.published = TestModel.new(:kind => "published")
+        end
+
+        it { subject.published?.should be_true }
+      end
+
+      context "record is published" do
+        it { subject.kind = "published"; subject.published?.should be_true }
+        it { subject.kind = "draft"; subject.published?.should be_false }
+      end
+    end
+
+    describe "ever_published?" do
+      before do
+        subject.save
+      end
+      
+      context "record is published" do
+        before do
+          subject.publish!
+        end
+
+        it { subject.ever_published?.should be_true }
+      end
+
+      context "record is withdrawn" do
+        before do
+          subject.publish!
+          subject.withdraw!
+        end
+
+        it { subject.ever_published?.should be_true }
+      end
+
+      it { subject.ever_published?.should be_false }
+    end
+
+    describe "under_embargo?" do
+      before do
+        subject.publish!
+      end
+
+      context "record is published and embargo has finished" do
+        before do
+          subject.embargoed_until = Time.now + 5.minutes
+          subject.save
+        end
+
+        it { subject.under_embargo?.should be_true }
+      end
+
+      context "embargo is not present" do
+        it { subject.under_embargo?.should be_false }
+      end
+
+      it { subject.under_embargo?.should be_false }
+    end
+
+    describe "withdrawn?" do
+      context "record is draft, inverse is withdrawn" do
+        before do
+          subject.kind = 'draft'
+          subject.published = TestModel.new(:kind => "withdrawn")
+        end
+
+        it { subject.withdrawn?.should be_true }
+      end
+
+      context "record is withdrawn" do
+        it { subject.kind = "withdrawn"; subject.withdrawn?.should be_true }
+        it { subject.kind = "draft"; subject.withdrawn?.should be_false }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: has_publishing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh McArthur @ 3months
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add ability to draft/publish/withdraw/embargo models
+email:
+- joshua.mcarthur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- has_publishing.gemspec
+- lib/has_publishing.rb
+- lib/has_publishing/class_methods.rb
+- lib/has_publishing/configuration.rb
+- lib/has_publishing/generators/publishing_generator.rb
+- lib/has_publishing/generators/templates/migration.rb.erb
+- lib/has_publishing/instance_methods.rb
+- lib/has_publishing/version.rb
+- spec/has_publishing_spec.rb
+homepage: https://github.com/3months/has_publishing
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2118166424192642894
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2118166424192642894
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add publishing to your ActiveRecord models
+test_files:
+- spec/has_publishing_spec.rb