pubdraft 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joe Sak
+
+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,50 @@
+# Pubdraft
+
+Quickly add published/drafted states to your ActiveRecord models, with helpful scopes and instance methods for querying and changing the states
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pubdraft'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pubdraft
+
+## Usage
+
+```ruby
+# requires string column `state` to exist
+# $ rails g migration AddStateToMyModels state
+
+class MyModel < ActiveRecord::Base
+  pubdraft
+end
+
+record = MyModel.create!
+record.published? #=> true
+
+record.draft!
+record.drafted?   #=> true
+
+record.publish!
+record.published? #=> true
+
+MyModel.published #=> [published records]
+MyModel.drafted   #=> [drafted records]
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: db/test.sqlite

data/lib/pubdraft/version.rb

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

data/lib/pubdraft.rb

@@ -0,0 +1,63 @@
+require "pubdraft/version"
+
+module Pubdraft
+  module InstanceMethods
+    def self.included(base)
+      base.send :before_create, :set_pubdraft_state
+      base.attr_accessible :state
+
+      base.scope :published, base.where(:state => 'published')
+      base.scope :drafted,   base.where(:state => 'drafted')
+    end
+
+    def published?
+      state == 'published'
+    end
+
+    def drafted?
+      state == 'drafted'
+    end
+
+    def publish!
+      publish && save
+    end
+
+    def publish
+      self.state = 'published'
+    end
+
+    def draft!
+      draft && save
+    end
+
+    def draft
+      self.state = 'drafted'
+    end
+
+    private
+    def set_pubdraft_state
+      return unless state.blank?
+      publish
+    end
+  end
+
+  module ClassMethods
+    def pubdraft
+      send(:include, InstanceMethods)
+    end
+  end
+
+  module HelperMethods
+    def pubdraft_states_for_select
+      [['Published', 'published'], ['Drafted', 'drafted']]
+    end
+  end
+
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.extend Pubdraft::ClassMethods
+  end
+
+  if defined?(ApplicationHelper)
+    ApplicationHelper.extend Pubdraft::HelperMethods
+  end
+end

data/pubdraft.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pubdraft/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pubdraft"
+  gem.version       = Pubdraft::VERSION
+  gem.authors       = ["Joe Sak"]
+  gem.email         = ["joe@neotericdesign.com"]
+  gem.description   = %q{Quickly add publish/draft state to your ActiveRecord models}
+  gem.summary       = %q{Quick publish/draft state on ActiveRecord models}
+
+  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_development_dependency 'sqlite3'
+  gem.add_development_dependency 'activerecord', '3.2.9'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'database_cleaner'
+end

data/spec/pubdraft_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_no_rails_helper'
+require 'pubdraft'
+
+class CreateTestData < ActiveRecord::Migration
+  unless table_exists?('fake_things')
+    create_table :fake_things do |t|
+      t.string :state
+    end
+  end
+end
+
+class FakeThing < ActiveRecord::Base
+  pubdraft
+end
+
+describe Pubdraft do
+  before { @class = FakeThing }
+
+  it "defaults to published state" do
+    obj = @class.create!
+
+    obj.should be_published
+  end
+
+  it "changes states" do
+    obj = @class.create!
+
+    obj.draft!
+    obj.should be_drafted
+
+    obj.publish!
+    obj.should be_published
+  end
+
+  it "has scopes" do
+    published = @class.create!
+    drafted   = @class.create!(:state => 'drafted')
+
+    @class.published.should == [published]
+    @class.drafted.should   == [drafted]
+  end
+end

data/spec/spec_no_rails_helper.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+require 'database_cleaner'
+
+db = YAML.load(File.open('config/database.yml'))['test']
+ActiveRecord::Base.establish_connection(db)
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end unless defined?(Rails)

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: pubdraft
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Sak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2165585040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165585040
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2165584200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :development
+  prerelease: false
+  version_requirements: *2165584200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165583700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165583700
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &2165582980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165582980
+description: Quickly add publish/draft state to your ActiveRecord models
+email:
+- joe@neotericdesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/database.yml
+- db/.gitkeep
+- lib/pubdraft.rb
+- lib/pubdraft/version.rb
+- pubdraft.gemspec
+- spec/.gitkeep
+- spec/pubdraft_spec.rb
+- spec/spec_no_rails_helper.rb
+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.6
+signing_key: 
+specification_version: 3
+summary: Quick publish/draft state on ActiveRecord models
+test_files:
+- spec/.gitkeep
+- spec/pubdraft_spec.rb
+- spec/spec_no_rails_helper.rb