drafteable 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Diego Fernandez Fernandez
+
+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 @@
+# Drafteable [![Build Status](https://travis-ci.org/littlemove/drafteable.png)](https://travis-ci.org/littlemove/drafteable)
+
+Drafteable is a super simple and opinionated ActiveRecord model draft
+behavior encapsulation:
+
+A drafteable model should:
+
+- Provide a boolean field as a flag for its draft status.
+- Provide methods to check draft or published status.
+- Provide methods to change draft or published status.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drafteable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drafteable
+
+## Usage
+
+On your ActiveRecord model add
+
+    acts_as_drafteable
+
+Then you get `published?`, `draft?` (for checking the state) and `publish!`,
+`draft!` (for changing the status).
+
+Note that calling draft! will save the model skipping validations.
+
+## 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
+
+You've got test under spec/ and `bundle install` should take care of
+all gem dependencies for development.
+
+## TODO
+
+1. Write generator to create migration with draft field on model.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/drafteable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drafteable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "drafteable"
+  gem.version       = Drafteable::VERSION
+  gem.authors       = ["Diego Fernandez Fernandez"]
+  gem.email         = ["diego.fernandez.fernandez@gmail.com"]
+  gem.description   = %q{Drafteable is a super simple and opinionated ActiveRecord model draft
+behavior encapsulation}
+  gem.summary       = %q{Drafteable is a super simple and opinionated ActiveRecord model draft
+behavior encapsulation}
+  gem.homepage      = "http://github.com/littlemove/drafteable/"
+
+  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', '~> 3.2.8'
+  gem.add_development_dependency 'rspec', '~> 2.11.0'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/drafteable.rb

@@ -0,0 +1,31 @@
+require "drafteable/version"
+
+module Drafteable
+  def acts_as_drafteable
+    include InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def published?
+      begin
+        !self.draft
+      rescue NoMethodError
+        raise Exception.new('There is no draft field. Did you forget to run migrations?')
+      end
+    end
+
+    def draft!
+      self.draft = true
+      self.save(validate: false)
+    end
+
+    def publish!
+      self.draft = false
+      self.save
+    end
+
+  end
+
+  ActiveRecord::Base.extend Drafteable
+end

data/lib/drafteable/version.rb

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

data/spec/drafteable_spec.rb

@@ -0,0 +1,100 @@
+require 'active_record'
+require 'drafteable'
+
+require 'fileutils'
+
+describe Drafteable do
+
+  before :all do
+    setup_db
+    @no_draft_field_model = DummyModel.new
+    @drafteable_ready_model = DummyReadyModel.new
+  end
+
+  describe 'without draft field' do
+
+    it { @no_draft_field_model.should respond_to(:published?) }
+
+    it 'should raise Exception' do
+      lambda {
+        @no_draft_field_model.published?.should raise_exception(Exception, 'There is no draft field. Did you forget to run migrations?')
+      }
+    end
+
+  end
+
+
+  describe 'with draft field' do
+
+    it 'should not raise Exception' do
+      lambda { @drafteable_ready_model.published?.should_not raise_exception() }
+    end
+
+    it { @drafteable_ready_model.published?.should be(true) }
+
+    it { @drafteable_ready_model.draft?.should be(false) }
+
+    context 'set to draft' do
+      it 'should change to draft' do
+        @drafteable_ready_model.draft!
+        @drafteable_ready_model.draft?.should be(true)
+      end
+    end
+
+    context 'set to published' do
+      it 'should change to published' do
+        @drafteable_ready_model.publish!
+        @drafteable_ready_model.published?.should be(true)
+      end
+    end
+  end
+
+  after :all do
+    teardown_db
+  end
+
+end
+
+private
+
+def setup_db
+  db_dir = 'spec/db'
+  FileUtils.mkdir(db_dir) unless File.exists?(db_dir)
+  ActiveRecord::Base.establish_connection(
+                                          adapter: 'sqlite3',
+                                          database: 'spec/db/development.sqlite3'
+                                          )
+
+  ActiveRecord::Migration.verbose = false
+
+  CreateDummyModels.migrate(:up)
+end
+
+def teardown_db
+  FileUtils.rm('spec/db/development.sqlite3')
+end
+
+class CreateDummyModels < ActiveRecord::Migration
+  def change
+    create_table :dummy_models do |t|
+      t.string :name
+
+      t.timestamps
+    end
+
+    create_table :dummy_ready_models do |t|
+      t.string :name
+      t.boolean :draft, default: false
+
+      t.timestamps
+    end
+  end
+end
+
+class DummyModel < ActiveRecord::Base
+  acts_as_drafteable
+end
+
+class DummyReadyModel < ActiveRecord::Base
+  acts_as_drafteable
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: drafteable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Diego Fernandez Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 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: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.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: ! 'Drafteable is a super simple and opinionated ActiveRecord model draft
+
+  behavior encapsulation'
+email:
+- diego.fernandez.fernandez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- drafteable.gemspec
+- lib/drafteable.rb
+- lib/drafteable/version.rb
+- spec/drafteable_spec.rb
+homepage: http://github.com/littlemove/drafteable/
+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.23
+signing_key: 
+specification_version: 3
+summary: Drafteable is a super simple and opinionated ActiveRecord model draft behavior
+  encapsulation
+test_files:
+- spec/drafteable_spec.rb
+has_rdoc: