acts_as_model_with_status 0.9.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_model_with_status.gemspec
+gemspec
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run tests"
+task :default => :spec

data/acts_as_model_with_status.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_model_with_status/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_model_with_status"
+  s.version     = ActsAsModelWithStatus::VERSION
+  s.authors     = ["Santi Bel"]
+  s.email       = ["santiago.bel@gmail.com"]
+  s.homepage    = "http://github.com/landtax/acts_as_model_with_status"
+  s.summary     = %q{Simple status management for Active Record models}
+  s.description = %q{Simple status management for Active Record models}
+
+  s.rubyforge_project = "acts_as_model_with_status"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.13"
+  s.add_development_dependency "sqlite3", "1.3.7"
+
+  s.add_runtime_dependency "rails", "~> 3.2"
+end

data/lib/acts_as_model_with_status.rb

@@ -0,0 +1,10 @@
+require "acts_as_model_with_status/version"
+require 'active_support/core_ext'
+
+require File.join(File.dirname(__FILE__), "acts_as_model_with_status/railtie.rb")
+
+module ActsAsModelWithStatus
+  autoload :Hook, File.join(File.dirname(__FILE__), "acts_as_model_with_status/hook")
+  autoload :InstanceMethods, File.join(File.dirname(__FILE__), "acts_as_model_with_status/instance_methods")
+end
+

data/lib/acts_as_model_with_status/hook.rb

@@ -0,0 +1,21 @@
+module ActsAsModelWithStatus::Hook
+
+  def acts_as_model_with_status(status_list, *args)
+    options = args.extract_options!
+
+    cattr_accessor :available_statuses
+    cattr_accessor :invert_available_statuses
+    cattr_accessor :status_column
+    cattr_accessor :default_status
+
+    self.available_statuses = status_list
+    self.invert_available_statuses = self.available_statuses.invert
+    self.status_column = options[:column] || :status
+    self.default_status = options[:default]
+
+    include ActsAsModelWithStatus::InstanceMethods
+
+    after_initialize :set_default_status_if_needed
+  end
+
+end

data/lib/acts_as_model_with_status/instance_methods.rb

@@ -0,0 +1,37 @@
+module ActsAsModelWithStatus::InstanceMethods
+
+  def status
+    status_key read_attribute(self.status_column.to_sym)
+  end
+
+  def status= key
+    validate_status key
+
+    write_attribute(self.status_column.to_sym, status_value(key))
+  end
+
+  private
+
+  def set_default_status_if_needed
+    if self.status.nil? && !self.default_status.nil?
+      self.status = self.default_status 
+    end
+  end
+
+  def status_key(value)
+    invert_available_statuses[value]
+  end
+
+  def status_value(key)
+    validate_status key
+
+    available_statuses[key]
+  end
+
+  def validate_status(key)
+    if !available_statuses.keys.include? key
+      raise "Invalid status ':#{key}'" 
+    end
+  end
+
+end

data/lib/acts_as_model_with_status/railtie.rb

@@ -0,0 +1,16 @@
+require 'rails'
+require 'active_record'
+require 'acts_as_model_with_status'
+
+begin
+  module ActsAsModelWithStatus
+    class Railtie < Rails::Railtie
+      config.to_prepare do
+        ActiveRecord::Base.send(:extend, ActsAsModelWithStatus::Hook)
+      end
+    end
+  end
+rescue
+  p $!, $!.message
+  raise $!
+end

data/lib/acts_as_model_with_status/version.rb

@@ -0,0 +1,3 @@
+module ActsAsModelWithStatus
+  VERSION = "0.9.0"
+end

data/spec/acts_as_model_with_status_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+ActiveRecord::Base.send(:extend, ActsAsModelWithStatus::Hook)
+
+STATUS_LIST = {:new => 1, :running => 2, :done => 3, :closed => 4}
+
+class MyModel < ActiveRecord::Base
+end
+
+class BasicModel < MyModel
+  acts_as_model_with_status(STATUS_LIST)
+end
+
+class WithDefaultModel < MyModel
+  acts_as_model_with_status(STATUS_LIST, :default => :running)
+end
+
+class WithColumnModel < MyModel
+  acts_as_model_with_status(STATUS_LIST, :default => :running, :column => :my_status)
+end
+
+
+describe ActsAsModelWithStatus do
+
+  before :each do
+    initialize_database
+  end
+
+  describe "Status operations" do
+    subject { BasicModel.new }
+
+    its(:status_culumn) { eq :status}
+    its(:default_status) {be_nil}
+    its (:status) { be_nil }
+
+    it "must update status" do
+      STATUS_LIST.each do |k,v| 
+        subject.status = k
+        subject.save
+
+        subject.reload
+        subject.status.should == k
+      end
+    end
+
+    it "must raise an exception when status is not in list" do
+      expect{subject.status = :fake_status}.to raise_exception
+    end
+
+  end
+
+  describe "Initialize Status with default value" do
+    subject { WithDefaultModel.new }
+
+    its(:status_culumn) { eq :status}
+    its(:default_status) {eq :running}
+    its(:status) {eq  :running }
+  end
+
+  describe "Use custom column name" do
+    subject { WithColumnModel.new }
+
+    its(:status_culumn) {eq :my_status}
+    its(:default_status) {eq :running}
+
+    it "must initialize status" do
+      subject.status.should == :running
+    end
+
+    it "does not store value in default column name but in custom column name" do
+      subject.save
+      subject.reload
+      subject.read_attribute(:status).should be_nil
+      subject.read_attribute(:my_status).should == 2
+
+      subject.status = :new
+      subject.save
+      subject.reload
+      subject.read_attribute(:status).should be_nil
+      subject.read_attribute(:my_status).should == 1
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'active_record'
+require 'active_support'
+require 'acts_as_model_with_status'
+require 'rspec'
+require 'rspec/autorun'
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+end
+
+def initialize_database
+  ActiveRecord::Base.establish_connection( :adapter => "sqlite3", :database => ":memory:")
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'my_models'")
+  ActiveRecord::Base.connection.create_table(:my_models) do |t|
+    t.integer :my_status
+    t.integer :status
+    t.timestamps
+  end
+end
+
+initialize_database

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_model_with_status
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Santi Bel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &80799740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: *80799740
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &80799330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: *80799330
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &80799020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80799020
+description: Simple status management for Active Record models
+email:
+- santiago.bel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- acts_as_model_with_status.gemspec
+- lib/acts_as_model_with_status.rb
+- lib/acts_as_model_with_status/hook.rb
+- lib/acts_as_model_with_status/instance_methods.rb
+- lib/acts_as_model_with_status/railtie.rb
+- lib/acts_as_model_with_status/version.rb
+- spec/acts_as_model_with_status_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/landtax/acts_as_model_with_status
+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_model_with_status
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple status management for Active Record models
+test_files: []