workflow_status 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2df972219e574cb89cf577ba655fd1260c314d24
+  data.tar.gz: 8ce1351b6256830e613438bf88e4bf53b4660680
+SHA512:
+  metadata.gz: 565a25f461d728033869d4123ca72e4586e1747287cc607535b4717df1f02881e4e24149b4e7b0e0dd60d82e19d4d2006b596ce0750d684292fbe98ae93184aa
+  data.tar.gz: a77d58db868410a1328a695a85cc1e688a3d453355396a80cf04f17cf92c191bfad66ef3bb5b495d1722664734edaa6b26f41d6c46af93b330cd0c21ba1145c6

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Friel
+
+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,72 @@
+# WorkflowStatus
+
+When building a content management system, it's often useful to model the stages a user goes through when working on a bit of content. Much like how a new feature is not immediately ready to be committed to a git repo, a user will often want to start working on a new page or product as a 'draft' before she is ready to publish it to a live site. And it is also often useful to give users a way to 'trash' certain items without actually deleting the records from the database.
+
+WorkflowStatus provides some convenient methods for modeling such a workflow with an ActiveRecord attribute called, unsurprisingly, 'workflow_status.' Imagine you have a Page model in your app. With workflow_status, you can call:
+
+```
+Page.published
+Page.first.published?
+Page.last.trashed?
+Page.unpublished
+etc.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'workflow_status'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflow_status
+
+## Usage
+
+Create a migration to add 'workflow_status' to your model.
+
+```
+class AddWorkflowStatusToPage < ActiveRecord::Migration
+  def change
+    add_column :pages, :workflow_status, :integer, limit: 2, null: false, default: 0  
+  end
+end
+```
+
+
+Then add WorkflowStatus to your model:
+
+```
+class Page < ActiveRecord::Base
+
+  extend WorkflowStatus
+
+  # ...
+
+end
+```
+
+And that's it! You can now call all of the following:
+
+```
+Page.published
+Page.unpublished
+Page.trashed
+Page.first.published?
+Page.last.trashed?
+Page.find(3).unpublished?
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/johnfriel/workflow_status/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/workflow_status/instance_methods.rb

@@ -0,0 +1,30 @@
+module WorkflowStatus::InstanceMethods
+  
+  def workflow_status
+    code = read_attribute :workflow_status
+    workflow_status_map.invert.fetch(code)
+  end
+  
+  def workflow_status=(status_symbol)
+    value = workflow_status_map.fetch(status_symbol.to_sym)
+    write_attribute :workflow_status, value
+  end
+
+  def published?
+    workflow_status == :published
+  end
+  
+  def unpublished?
+    workflow_status == :unpublished
+  end
+  
+  def trashed?
+    workflow_status == :trashed
+  end
+
+  private
+
+  def workflow_status_map
+    WorkflowStatus::WORKFLOW_STATUS_MAP
+  end
+end

data/lib/workflow_status/version.rb

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

data/lib/workflow_status.rb

@@ -0,0 +1,48 @@
+require "workflow_status/version"
+require "workflow_status/instance_methods"
+
+module WorkflowStatus
+  WORKFLOW_STATUS_MAP = {
+    unpublished:  0,
+    published:    1,
+    trashed:      2
+  }
+  
+  class << self
+    def extended(extender)
+      extender.send :include, InstanceMethods
+    end
+  end
+  
+  def workflow_statuses
+    workflow_status_map.keys
+  end
+
+  def unpublished
+    where(workflow_status: workflow_status_code(:unpublished))
+  end
+  
+  def published
+    where(workflow_status: workflow_status_code(:published))
+  end
+  
+  def trashed
+    where(workflow_status: workflow_status_code(:trashed))
+  end
+
+
+  # for Rails form select helper
+  def status_options_for_select
+    workflow_status_map.to_a
+  end
+
+  private
+
+  def workflow_status_code(text_value)
+    workflow_status_map.fetch text_value.to_sym
+  end
+
+  def workflow_status_map
+    WORKFLOW_STATUS_MAP
+  end
+end

data/spec/lib/instance_methods_spec.rb

@@ -0,0 +1,118 @@
+require 'workflow_status'
+
+describe WorkflowStatus::InstanceMethods do
+
+  before :each do
+    class DummyClass
+      extend WorkflowStatus
+    end
+
+    @class = DummyClass
+    @obj = DummyClass.new
+  end
+
+  it 'adds a method for retreiving workflow_status' do
+    @obj.should respond_to(:workflow_status)
+  end
+  
+  it 'adds a method for setting workflow_status' do
+    @obj.should respond_to(:'workflow_status=')
+  end
+
+
+  ##########
+  # Getter #
+  ##########
+  describe '#workflow_status' do
+    it "returns :published for an actual attr of 1" do
+      obj = @class.new
+      obj.stub(:read_attribute).with(:workflow_status) { 1 }
+   
+      obj.workflow_status.should be(:published)
+    end
+    
+    it "returns :unpublished for an actual attr of 0" do
+      obj = @class.new
+      obj.stub(:read_attribute).with(:workflow_status) { 0 }
+   
+      obj.workflow_status.should be(:unpublished)
+    end
+    
+    it "returns :trashed for an actual attr of 2" do
+      obj = @class.new
+      obj.stub(:read_attribute).with(:workflow_status) { 2 }
+   
+      obj.workflow_status.should be(:trashed)
+    end
+  end
+
+
+  ##########
+  # Setter #
+  ##########
+  describe '#workflow_status=' do
+    it 'writes 0 to workflow_status for :unpublished' do
+      obj = @class.new
+  
+      obj.should_receive(:write_attribute).with(:workflow_status, 0)
+      obj.workflow_status = :unpublished
+    end
+    
+    it 'writes 1 to workflow_status for :published' do
+      obj = @class.new
+  
+      obj.should_receive(:write_attribute).with(:workflow_status, 1)
+      obj.workflow_status = :published
+    end
+    
+    it 'writes 2 to workflow_status for :trashed' do
+      obj = @class.new
+  
+      obj.should_receive(:write_attribute).with(:workflow_status, 2)
+      obj.workflow_status = :trashed
+    end
+  end
+
+
+
+
+
+  describe '#published?' do
+    it "checks if workflow_status is :published" do
+      obj1 = @class.new
+      obj2 = @class.new
+
+      obj1.stub(:workflow_status) { :published }
+      obj2.stub(:workflow_status) { 'foo' }
+
+      obj1.published?.should be true
+      obj2.published?.should be false
+    end
+  end
+  
+  describe '#unpublished?' do
+    it "checks if workflow_status is :unpublished" do
+      obj1 = @class.new
+      obj2 = @class.new
+
+      obj1.stub(:workflow_status) { :unpublished }
+      obj2.stub(:workflow_status) { 'bar' }
+
+      obj1.unpublished?.should be true
+      obj2.unpublished?.should be false
+    end
+  end
+  
+  describe '#trashed?' do
+    it "checks if workflow_status is :trashed" do
+      obj1 = @class.new
+      obj2 = @class.new
+
+      obj1.stub(:workflow_status) { :trashed }
+      obj2.stub(:workflow_status) { 'quux' }
+
+      obj1.trashed?.should be true
+      obj2.trashed?.should be false
+    end
+  end
+end

data/spec/workflow_status_spec.rb

@@ -0,0 +1,48 @@
+require 'workflow_status'
+
+describe WorkflowStatus do
+
+  before :each do
+    @klass = Class.new do
+      extend WorkflowStatus
+    end
+  end
+
+  it 'adds a class method for returning status names as symbols' do
+    @klass.workflow_statuses.should include(:unpublished) 
+    @klass.workflow_statuses.should include(:published) 
+    @klass.workflow_statuses.should include(:trashed) 
+  end
+
+  # workflow_status 0
+  describe '#unpublished' do
+    it 'sends an ActiveRecord query for the correct workflow_status' do
+      @klass.should_receive(:where).with(workflow_status: 0) 
+      @klass.unpublished
+    end
+  end
+  
+  # workflow_status 1
+  describe '#published' do
+    it 'sends an ActiveRecord query for the correct workflow_status' do
+      @klass.should_receive(:where).with(workflow_status: 1) 
+      @klass.published
+    end
+  end
+  
+  # workflow_status 2
+  describe '#trashed' do
+    it 'sends an ActiveRecord query for the correct workflow_status' do
+      @klass.should_receive(:where).with(workflow_status: 2) 
+      @klass.trashed
+    end
+  end
+
+  describe '#status_options_for_select' do
+    it 'returns an array of options suitable for Rails form select helper' do
+      @klass.status_options_for_select.should include([:unpublished, 0])
+      @klass.status_options_for_select.should include([:published,   1])
+      @klass.status_options_for_select.should include([:trashed,     2])
+    end
+  end
+end

data/workflow_status.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflow_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workflow_status"
+  spec.version       = WorkflowStatus::VERSION
+  spec.authors       = ["John Friel"]
+  spec.email         = ["friel.john@gmail.com"]
+  spec.summary       = "For CMS workflows that allow drafts, publishing and trashing, provides convenient, human-readable methods for an integer based ActiveRecord attribute"
+  spec.description   = <<DESC
+For CMS workflows that allow drafts, publishing and trashing, provides convenient, human-readable methods for an integer based ActiveRecord attribute
+DESC
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.11"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: workflow_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Friel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: |
+  For CMS workflows that allow drafts, publishing and trashing, provides convenient, human-readable methods for an integer based ActiveRecord attribute
+email:
+- friel.john@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/workflow_status.rb
+- lib/workflow_status/instance_methods.rb
+- lib/workflow_status/version.rb
+- spec/lib/instance_methods_spec.rb
+- spec/workflow_status_spec.rb
+- workflow_status.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: For CMS workflows that allow drafts, publishing and trashing, provides convenient,
+  human-readable methods for an integer based ActiveRecord attribute
+test_files:
+- spec/lib/instance_methods_spec.rb
+- spec/workflow_status_spec.rb