acts_as_publicable 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc

data/.infinity_test

@@ -0,0 +1,3 @@
+infinity_test do
+   use :rubies => %w(1.8.7 1.9.2), :test_framework => :rspec
+end

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--tty
+--format nested

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.textile

@@ -0,0 +1,58 @@
+This gem will give you only two scopes and a method for handling
+published/unpublished stuff. Nothing remarkable bur saved me a lot of typing
+when I wrote it for a project with an huge number of publishable models.
+Suggestions are more than welcome.
+
+h2. How It Works
+
+In order to use in your model, write something like the following:
+
+<pre>
+    class Articile < ActiveRecord::Base
+        acts_as_publicable
+    end
+</pre>
+
+With that you get two very simple scopes:
+
+<pre>
+ruby-1.9.2-p180 :001 > Article.unpublished
+  Article Load (0.2ms)  SELECT `articles`.* FROM `articles` WHERE (published is false)
+ => [] 
+ruby-1.9.2-p180 :002 > Article.published
+  Article Load (0.2ms)  SELECT `articles`.* FROM `articles` WHERE (published is true)
+ => []
+</pre>
+
+and a method to publish an article:
+
+<pre>
+ruby-1.9.2-p180 :011 > @article=Article.first
+Article Load (0.2ms)  SELECT `articles`.* FROM `articles` LIMIT 1
+ruby-1.9.2-p180 :012 > @article.publish!
+  SQL (0.1ms)  BEGIN
+  AREL (0.2ms)  UPDATE `articles` SET `published` = 1, `updated_at` = '2011-04-05 08:50:45' WHERE (`articles`.`id` = 1)
+  SQL (48.3ms)  COMMIT
+ => true 
+</pre>
+
+h2. Generator
+
+You can use a generator to add the published field to your target model:
+
+rails g acts_as_publicable model_name
+
+It will generate a simple migration that will add the neeeded field.
+
+h2. Roadmap
+
+* comment code
+* add a date for handling a better publishing concept
+
+h2. Copyright
+
+This program is free software. It comes without any warranty,
+to the extent permitted by applicable law. You can redistribute
+it and/or modify it under the terms of the Do What The Fuck You
+Want To Public License, Version 2, as published by Sam Hocevar.
+See http://sam.zoy.org/wtfpl/COPYING for more details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs'
+task :default => :spec  
+RSpec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+end

data/acts_as_publicable.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_publicable/version"
+
+Gem::Specification.new do |s|
+    s.name        = "acts_as_publicable"
+    s.version     = ActsAsPublicable::VERSION
+    s.platform    = Gem::Platform::RUBY
+    s.authors     = ["lucapette"]
+    s.email       = ["lucapette@gmail.com"]
+    s.homepage    = "https://github.com/lucapette/acts_as_publicable"
+    s.summary     = %q{a simple ActiveRecord extension for handling publishable stuff}
+    s.description = %q{This gem will give you only two scopes and a method for handling
+published/unpublished stuff. Nothing remarkable bur saved me a lot of typing
+when I wrote it for a project with an huge number of publishable models.
+Suggestions are more than welcome.}
+
+    s.add_development_dependency 'sqlite3'
+    s.add_dependency "rails", ">= 3.0.0"
+    s.add_development_dependency "rspec-rails", ">= 2.5.0"
+
+    s.rubyforge_project = "acts_as_publicable"
+
+    s.files         = `git ls-files`.split("\n")
+    s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+    s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    s.require_paths = ["lib"]
+end

data/lib/acts_as_publicable.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require "acts_as_publicable/acts_as_publicable"
+
+if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.send :include, ActsAsPublicable::ActiveRecordExtension
+end

data/lib/acts_as_publicable/acts_as_publicable.rb

@@ -0,0 +1,26 @@
+module ActsAsPublicable
+
+    class FieldNotPresentError < StandardError; end
+    module ActiveRecordExtension
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+            def acts_as_publicable
+                raise ActsAsPublicable::FieldNotPresentError unless column_names.include?(:published.to_s)
+                scope :published, where("published is true")
+                scope :unpublished, where("published is false")
+            end
+        end
+
+        module InstanceMethods
+
+            def publish!
+                self.published = true
+                save
+            end
+
+        end
+
+    end
+end

data/lib/acts_as_publicable/version.rb

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

data/lib/generators/USAGE

@@ -0,0 +1,9 @@
+Description:
+    This generator will give you a migration for the published field on the
+    given model
+    
+Example:
+    rails generate acts_as_publicable model_name
+
+    This will create something like:
+        db/migrate/20110404120349_add_published_to_table_name.rb

data/lib/generators/acts_as_publicable_generator.rb

@@ -0,0 +1,13 @@
+class ActsAsPublicableGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def manifest
+        migration_template 'migration.rb', "db/migrate/add_publicable_to_#{table_name}"
+    end
+
+    def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,9 @@
+class AddPublishedTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :published, :boolean
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :published
+  end
+end

data/spec/acts_as_publicable/acts_as_publicable_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe "acts_as_publicable" do
+    it "raises an error when it's not present published field" do
+        lambda { 
+            class Post
+                acts_as_publicable
+            end
+        }.should raise_error ActsAsPublicable::FieldNotPresentError
+    end
+
+    it "adds published scope" do
+        Article.should respond_to(:published)
+    end
+
+    it "adds unpublished scope" do
+        Article.should respond_to(:unpublished)
+    end
+
+    describe "#publish!" do
+        it "publish an article" do
+            @article = Article.create!(:title=>"Awesome article")
+            @article.publish!
+            @article.should be_published
+        end
+    end
+
+end

data/spec/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "articles", :force => true do |t|
+    t.string   "title"
+    t.boolean "published", :default => false
+  end
+  
+  create_table "posts", :force => true do |t|
+    t.string   "name"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+def load_models!
+    ActiveRecord::Base.descendants.each do |model|
+        model.delete_all
+        Object.class_eval { remove_const model.name if const_defined?(model.name) }
+    end
+
+    load File.dirname(__FILE__) + "/support/models.rb"
+end
+
+Bundler.setup
+require "rails/all"
+Bundler.require(:default)
+
+require "rspec/rails"
+require "acts_as_publicable"
+
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+load "schema.rb"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+    config.before do
+        load_models!
+    end
+end

data/spec/support/models.rb

@@ -0,0 +1,6 @@
+class Article < ActiveRecord::Base
+    acts_as_publicable
+end
+
+class Post < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_publicable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- lucapette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  This gem will give you only two scopes and a method for handling
+  published/unpublished stuff. Nothing remarkable bur saved me a lot of typing
+  when I wrote it for a project with an huge number of publishable models.
+  Suggestions are more than welcome.
+email: 
+- lucapette@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .infinity_test
+- .rspec
+- Gemfile
+- README.textile
+- Rakefile
+- acts_as_publicable.gemspec
+- lib/acts_as_publicable.rb
+- lib/acts_as_publicable/acts_as_publicable.rb
+- lib/acts_as_publicable/version.rb
+- lib/generators/USAGE
+- lib/generators/acts_as_publicable_generator.rb
+- lib/generators/templates/migration.rb
+- spec/acts_as_publicable/acts_as_publicable_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+has_rdoc: true
+homepage: https://github.com/lucapette/acts_as_publicable
+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: acts_as_publicable
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: a simple ActiveRecord extension for handling publishable stuff
+test_files: []
+