is_publishable 0.0.1

data/README.md

@@ -0,0 +1,66 @@
+# is_publishable
+
+Adds publishing capabilities to a model.  Supports marking a model as published/unpublished as well as publishing models in the future.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'is_publishable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install is_publishable
+
+## Usage
+
+To add publishing to a model, first run the generator. Let's assume the model's name is Article
+
+    $ rails generate publishable Article
+
+This will create the following migration:
+
+    class AddPublishingToArticles < ActiveRecord::Migration
+      def up
+        add_column :articles, :published, :boolean, default: false
+        add_column :articles, :published_at, :datetime
+      end
+      def down
+        remove_column :articles, :published
+        remove_column :articles, :published_at
+      end 
+    end
+
+After this, simply add `publishable` to your model (be sure to add published and published_at to your attr_accessible)
+
+    class Article < ActiveRecord::Base
+      attr_accessible ...
+      publishable
+    end
+
+The following scopes are now available:
+
+* published -- returns all Article that published=true and published_at is a date in the past
+* unpublished -- returns all Articles that are published=false or published=true and published_at is a date in the future
+
+
+The follow instance methods are now available:
+* published? -- returns true if published=true and published_at is a date in the past
+* unpublished? -- returns true if published=false or published=true and published_at is a date in the future
+
+
+## TODO
+
+* Write tests for generator
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/generators/publishable_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/active_record'
+
+class PublishableGenerator < ActiveRecord::Generators::Base
+  desc  "Create a migration to add publishing to your model. " +
+        "Usage: rails g publishable Model"
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "publishable_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+
+  def migration_name
+    "add_publishing_to_#{name.underscore.pluralize}"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+end

data/lib/generators/templates/publishable_migration.rb.erb

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def up
+    add_column :<%= table_name %>, :published, :boolean, default: false
+    add_column :<%= table_name %>, :published_at, :datetime
+  end
+
+  def down
+    remove_column :<%= table_name %>, :published
+    remove_column :<%= table_name %>, :published_at
+  end
+end

data/lib/is_publishable/version.rb

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

data/lib/is_publishable.rb

@@ -0,0 +1,51 @@
+require "is_publishable/version"
+
+module IsPublishable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def publishable args = {}
+
+      class_eval do
+        include IsPublishable::InstanceMethods
+      end
+
+      instance_eval do
+
+        # create before_save hook
+        before_save do
+          if published and published_at.nil?
+            self.published_at = Time.zone.now
+          elsif published.nil?
+            self.published = false
+          end
+        end
+
+        # create scopes
+        scope :published, lambda { where(:published => true).where("published_at < ?", Time.zone.now) }
+        scope :unpublished, lambda { where("published = ? OR published_at > ?", false, Time.zone.now) }
+
+      end
+    end
+
+  end
+
+  module InstanceMethods
+
+    def published?(time = Time.zone.now)
+      published and published_at.present? and published_at < time
+    end
+
+    def unpublished?
+      !published or (published_at and published_at > Time.zone.now)
+    end
+
+  end
+end
+
+class ActiveRecord::Base
+  include IsPublishable
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: is_publishable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendan Stennett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Gives a resouce the ability to be published against a certain date
+email:
+- brendan@unknowncollective.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/publishable_generator.rb
+- lib/generators/templates/publishable_migration.rb.erb
+- lib/is_publishable/version.rb
+- lib/is_publishable.rb
+- README.md
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Created published and published_at attrbutes for a model and allows them
+  to be queried against.
+test_files: []