affairs_of_state 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kevin McPhillips
+
+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,74 @@
+# AffairsOfState
+
+You have an Active Record model. It nees to have multiple states, but not complex rules. This gem gives you validation, easy check and change methods, and a single configuration line.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'affairs_of_state'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install affairs_of_state
+
+## Usage
+
+The gem assumes you have a string column named "status" on your model:
+
+    add_column :model_name, :status, :default => "active"
+
+Then you just list your states in the model:
+
+    affairs_of_state :active, :inactive
+
+If you'd like to use another column, lets say "state", pass it in as a configuration option:
+
+    affairs_of_state :active, :inactive, :column => :state
+
+You can also turn off validation:
+
+    affairs_of_state :active, :inactive, :allow_blank => true
+
+Or give it a long list of statuses:
+
+    affairs_of_state :ordered, :cancelled, :shipped, :lost, :in_transit
+
+
+## Methods
+
+The gem provides methods for checking and setting your status. The question mark method returns a boolean, and the bang method changes to that status. Lets assume you have "active" and "cancelled" as defined status:
+
+    widget = Widget.first
+
+    widget.cancelled! if widget.active?
+
+You can also access all your statuses on the model like so:
+
+    Widget::STATUES  # -> ["active", "cancelled"]
+
+
+## "But I want callbacks and validations and other things."
+
+Then this gem isn't for you. Consider:
+
+https://github.com/rubyist/aasm
+
+https://github.com/pluginaweek/state_machine
+
+
+## Tests
+
+Just run rspec:
+
+    rspec
+
+
+## The usual
+
+Author: Kevin McPhillips - github@kevinmcphillips.ca
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/affairs_of_state.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/affairs_of_state/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kevin McPhillips"]
+  gem.email         = ["github@kevinmcphillips.ca"]
+  gem.description   = %q{Add a simple state to a gem, without all the hassle of a complex state machine.}
+  gem.summary       = %q{You have an Active Record model. It nees to have multiple states, but not complex rules. This gem gives you validation, easy check and change methods, and a single configuration line.}
+  gem.homepage      = "http://github.com/kimos/affairs_of_state"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "affairs_of_state"
+  gem.require_paths = ["lib"]
+  gem.version       = AffairsOfState::VERSION
+
+  gem.add_dependency "activerecord", "~> 3.0"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "pry"
+
+end

data/lib/affairs_of_state/version.rb

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

data/lib/affairs_of_state.rb

@@ -0,0 +1,53 @@
+require "affairs_of_state/version"
+
+module AffairsOfState
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def affairs_of_state(*args)
+      @_status_options = ({:column => :status, :allow_blank => false}).merge(args.extract_options!)
+      @_statuses = args.map(&:to_s)
+
+      const_set("STATUSES", @_statuses)
+
+      validates(@_status_options[:column], :presence => true) unless @_status_options[:allow_blank]
+
+      include InstanceMethods
+      extend SingletonMethods
+      true
+    end
+  end
+
+  module InstanceMethods
+    def method_missing(method, *args)
+      if self.class::STATUSES.map{|s| "#{s}?".to_sym }.include?(method)
+        self.class.send(:define_method, method) do
+          self.status == method.to_s.gsub(/\?$/, "")
+        end
+
+        send method
+
+      elsif self.class::STATUSES.map{|s| "#{s}!".to_sym }.include?(method)
+        self.class.send(:define_method, method) do
+          self.update_attribute(self.class.instance_variable_get('@_status_options')[:column], method.to_s.gsub(/\!$/, ""))
+        end
+
+        send method
+      else
+        super
+      end
+    end
+  end
+
+  module SingletonMethods
+    def statuses_for_select
+      @_statuses.map{|s| [s.humanize, s]}
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, AffairsOfState

data/spec/affairs_of_state_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe AffairsOfState do
+
+  describe "with a simple configuration" do
+    class Pie < ActiveRecord::Base
+      affairs_of_state :active, :inactive, :cancelled
+    end
+
+    it "should set the constant" do
+      Pie::STATUSES.should == ["active", "inactive", "cancelled"]
+    end
+
+    it "should validate the column is set" do
+      p = Pie.new :status => nil
+      p.should_not be_valid
+    end
+
+    describe "boolean methods" do
+      it "should find the set status" do
+        p = Pie.new :status => "active"
+        p.active?.should be_true
+      end
+
+      it "should not find if a different status is set" do
+        p = Pie.new :status => "inactive"
+        p.cancelled?.should be_false
+      end
+    end
+
+    describe "update methods" do
+      it "should set the value" do
+        p = Pie.create! :status => "active"
+        p.inactive!.should be_true
+        p.status.should == "inactive"
+      end
+    end
+
+    it "should provide a method to pass to dropdowns" do
+      Pie.statuses_for_select.should == [["Active", "active"], ["Inactive", "inactive"], ["Cancelled", "cancelled"]]
+    end
+  end
+
+  describe "with a non-standard column name" do
+    class Pie2 < ActiveRecord::Base
+      self.table_name = "pies"
+
+      affairs_of_state :active, :inactive, :column => :super_status
+    end
+
+    it "should validate the column is set" do
+      p = Pie2.new :status => nil, :super_status => "active"
+      p.should be_valid
+    end
+  end
+
+  describe "without validations" do
+    class Pie3 < ActiveRecord::Base
+      self.table_name = "pies"
+
+      affairs_of_state :active, :inactive, :allow_blank => true
+    end
+
+    it "should validate the column is set" do
+      p = Pie3.new :status => nil
+      p.should be_valid
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+require 'affairs_of_state'
+require 'pry'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end
+
+
+## Create an AR model to test with
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "#{File.expand_path(File.join(File.dirname(__FILE__), '..'))}/spec/db/test.sqlite3"
+)
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'pies'")
+ActiveRecord::Base.connection.create_table(:pies) do |t|
+  t.string :status
+  t.string :super_status
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: affairs_of_state
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin McPhillips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-31 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &75399850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75399850
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &75399640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *75399640
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &75399410 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *75399410
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &75399200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *75399200
+description: Add a simple state to a gem, without all the hassle of a complex state
+  machine.
+email:
+- github@kevinmcphillips.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- affairs_of_state.gemspec
+- lib/affairs_of_state.rb
+- lib/affairs_of_state/version.rb
+- spec/affairs_of_state_spec.rb
+- spec/db/.gitkeep
+- spec/db/test.sqlite3
+- spec/spec_helper.rb
+homepage: http://github.com/kimos/affairs_of_state
+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.17
+signing_key: 
+specification_version: 3
+summary: You have an Active Record model. It nees to have multiple states, but not
+  complex rules. This gem gives you validation, easy check and change methods, and
+  a single configuration line.
+test_files: []
+has_rdoc: