printing_press 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Edmond Leung
+
+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.rdoc

@@ -0,0 +1,19 @@
+= printing_press
+
+Description goes here.
+
+== Contributing to printing_press
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Edmond Leung. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "printing_press"
+  gem.homepage = "http://github.com/eleung/printing_press"
+  gem.license = "MIT"
+  gem.summary = "Adds the ability to mark models as publishable"
+  gem.description = "Used in projects where you need to be able to save drafts of models and allow users to publish them at a later date."
+  gem.email = "eleung@thewonderfactory.com"
+  gem.authors = ["Edmond Leung"]
+  gem.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*", 'lib/printing_press/templates/.gitignore']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "printing_press #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/generators/printing_press/publishable/publishable_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module PrintingPress
+	class PublishableGenerator < Rails::Generators::NamedBase
+		include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+		
+		source_root File.expand_path('../templates', __FILE__)
+		
+    desc 'Generates (but does not run) a migration that is a clone of the specified resource.'
+		
+		def create_migration_file
+			migration_template "create_published_table.rb", "db/migrate/create_published_#{file_path.gsub('/', '_').pluralize}.rb"
+		end
+	end
+end

data/lib/generators/printing_press/publishable/templates/create_published_table.rb

@@ -0,0 +1,16 @@
+class CreatePublished<%= class_name.pluralize %> < ActiveRecord::Migration
+  def self.up
+    create_table :published_<%= class_name.pluralize.underscore %> do |t|
+			<% class_name.singularize.constantize.columns.each do |column| next if column.name == "id" %>t.<%= column.type.to_sym %> :<%= column.name %><% column.scale.nil? ? '' : ", :scale => #{column.scale}" %><% column.precision.nil? ? '' : ", :scale => #{column.precision}" %>
+			<% end %>
+		end
+		
+		# You'll need to copy the indexes manually
+  end
+
+  def self.down
+		# Don't forget to drop any indexes created above here
+		
+    drop_table :published_<%= class_name.pluralize.underscore %>
+  end
+end

data/lib/printing_press/controller.rb

@@ -0,0 +1,39 @@
+module PrintingPress
+  module Controller
+
+    def self.included(base)
+      base.before_filter :set_printing_press_enabled_for_controller
+      base.before_filter :setup_printing_press	
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+			def acts_as_publication(models = [], options = {})
+				models = [ models] unless models.is_a?(Array) 
+				
+				class_attribute :printing_press_models
+				self.printing_press_models = models
+			end
+		end
+		
+		protected
+		
+		def should_acts_as_publication?
+      true
+    end
+		
+		private
+		
+		def set_printing_press_enabled_for_controller
+			::PrintingPress.enabled_for_controller = should_acts_as_publication?
+		end
+		
+		def setup_printing_press
+			if ::PrintingPress.enabled_for_controller?
+				(self.class.try(:printing_press_models) || []).each do |model_name|
+					model_name.to_s.classify.constantize.try(:printing_press_on)
+				end
+			end
+		end
+  end
+end

data/lib/printing_press/publishable.rb

@@ -0,0 +1,75 @@
+module PrintingPress
+  module Model
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+		
+    module ClassMethods
+      def publishable(options = {})
+        send :include, InstanceMethods
+
+				class_attribute :published_table_name
+				self.published_table_name = options[:table_name] || "published_#{table_name}"
+				
+				class_attribute :dependencies
+				self.dependencies = options[:dependent_on] || []
+
+				class_attribute :printing_press_enabled_for_model				
+      end
+
+      def printing_press_off
+        self.printing_press_enabled_for_model = false
+				set_table_name reset_table_name
+      end
+
+      def printing_press_on
+        self.printing_press_enabled_for_model = true
+				set_table_name self.published_table_name
+      end
+
+			def drafts
+				self.find_by_sql("SELECT o.* FROM #{self.reset_table_name} o, #{self.published_table_name} p WHERE (o.id = p.id AND o.updated_at != p.updated_at)") +
+				self.find_by_sql("SELECT * FROM #{self.reset_table_name} WHERE id NOT IN (SELECT id FROM #{self.published_table_name}) GROUP BY id")
+			end
+    end
+
+    module InstanceMethods		
+			def published_version
+				@published_version ||= self.class.find_by_sql("SELECT * FROM #{self.class.published_table_name} WHERE id = #{self.id}").first
+			end
+			
+			def publish
+				return if published?
+				
+				remove_published_version if not published_version.nil?
+				connection.insert("INSERT INTO #{self.class.published_table_name} SELECT * FROM #{self.class.reset_table_name} WHERE id = #{self.id}")
+				
+				# We need to handle belongs_to dependencies as well
+				self.class.dependencies.each do |dependency|
+					self.try(dependency).try(:publish)
+				end
+			end
+			
+			def published?
+				not published_version.nil? and published_version.updated_at == self.updated_at
+			end
+			
+			def destroy
+				remove_published_version
+				super
+			end
+			
+			def published_at
+				published_version.nil? ? nil : published_version.updated_at
+			end
+			
+			private
+			
+			def remove_published_version
+				connection.delete("DELETE FROM #{self.class.published_table_name} WHERE id = #{self.id}")
+			end
+    end
+
+  end
+end

data/lib/printing_press/version_number.rb

@@ -0,0 +1,3 @@
+module PrintingPress
+  VERSION = '0.1.0'
+end

data/lib/printing_press.rb

@@ -0,0 +1,29 @@
+require 'printing_press/controller'
+require 'printing_press/publishable'
+require 'printing_press/version_number'
+
+module PrintingPress
+  def self.enabled_for_controller?
+    !!printing_press_store[:request_enabled_for_controller]
+  end
+
+  def self.enabled_for_controller=(value)
+    printing_press_store[:request_enabled_for_controller] = value
+  end
+
+	private
+
+  def self.printing_press_store
+    Thread.current[:printing_press] ||= {
+      :request_enabled_for_controller => true
+    }
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include PrintingPress::Model
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include PrintingPress::Controller
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'printing_press'
+
+class Test::Unit::TestCase
+end

data/test/test_printing_press.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPrintingPress < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: printing_press
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Edmond Leung
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id004
+description: Used in projects where you need to be able to save drafts of models and allow users to publish them at a later date.
+email: eleung@thewonderfactory.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/generators/printing_press/publishable/publishable_generator.rb
+- lib/generators/printing_press/publishable/templates/create_published_table.rb
+- lib/printing_press.rb
+- lib/printing_press/controller.rb
+- lib/printing_press/publishable.rb
+- lib/printing_press/version_number.rb
+- test/helper.rb
+- test/test_printing_press.rb
+has_rdoc: true
+homepage: http://github.com/eleung/printing_press
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds the ability to mark models as publishable
+test_files: []
+