acts_as_status_for 1.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem 'rails'
+gem 'sqlite3'
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.28)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.1)
+  rails
+  rcov
+  rspec (~> 2.3.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Curtis Schofield
+
+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

@@ -0,0 +1,42 @@
+ActiveRecord::Migration.create_table :things do |t|
+  t.datetime :on_hold_at
+  t.datetime :archived_at
+  t.datetime :featured_at
+end
+
+class Thing < ActiveRecord::Base
+  include ActsAsStatusFor
+  acts_as_status_for :on_hold, :archived, :featured do
+    scope :depends_on, not_on_hold.not_archived
+  end
+end
+
+----
+ Given this code you will be granted the following abilities:
+
+ status
+  => returns a string '' with marks according to what status is set
+ status=('')
+  => enforces the status set to match the status string passed in
+ archived?, on_hold?, featured?
+  => check on status of flag 
+ archived!, on_hold!, featured!
+  => turn on status & save
+ not_archived!, not_on_hold!, not_featured!
+  => turn off status & save
+ 
+ scopes :
+
+ not_archived, not_on_hold, not_featured,
+ archived    , on_hold    ' featured
+--
+
+
+ please note : you can protect your code from failing to exectue when your migrations
+ have not run yet (like on staging) but the code referencies fields about to be added
+ via a migration - by the use of a block
+
+ In the above example the block contains a reference to 'not_on_hold' - this is a scope
+ which is created by the argument to acts_as_status. :on_hold must exist in the database
+ for this block to run - and actually - if anyone of the status marks _at database attribute
+ doens't exist - the code will not install itself properly 

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acts_as_status_for"
+  gem.homepage = "http://github.com/robotarmy/acts_as_status_for"
+  gem.license = "MIT"
+  gem.summary = %Q{Acts as Status For a list of events - did something occur? or not? with scoped finder?}
+  gem.description = %Q{Given a list of datetime _at attributes }
+  gem.email = "github.com@robotarmyma.de"
+  gem.authors = ["Curtis Schofield"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_status_for #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require './config/environment.rb'
+ActsAsStatus::Application.load_tasks

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/acts_as_status_for.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_status_for}
+  s.version = "1.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Curtis Schofield"]
+  s.date = %q{2011-06-14}
+  s.description = %q{Given a list of datetime _at attributes }
+  s.email = %q{github.com@robotarmyma.de}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "acts_as_status_for.gemspec",
+    "config/environment.rb",
+    "lib/acts_as_status_for.rb",
+    "spec/acts_as_status_for_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/robotarmy/acts_as_status_for}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Acts as Status For a list of events - did something occur? or not? with scoped finder?}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/config/environment.rb

@@ -0,0 +1,12 @@
+require 'rails/all'
+
+module ActsAsStatus
+  class Application < Rails::Application
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+

data/lib/acts_as_status_for.rb

@@ -0,0 +1,98 @@
+module ActsAsStatusFor
+  def self.included(base)
+    base.instance_eval do
+      include InstanceMethods
+    end
+    base.extend(ClassMethods)
+  end
+  module ClassMethods
+
+    def acts_as_status_for(*status_marks,&after_migrations)
+      @all_status_marks_exist = true
+      @on_at_events  = status_marks
+      @off_at_events = on_at_events.collect do | event |
+        "not_#{event.to_s}".to_sym
+      end
+      install_scopes
+      install_methods
+      after_migrations.call(self) if @all_status_marks_exist && block_given?
+    end
+    def log_error(state)
+      STDERR.puts "Arel could not find #{state}_at in the database - skipping installation of acts_as_status"
+    end
+    def install_scopes
+      on_at_events.each do |state|
+        if self.arel_table["#{state}_at".to_sym] then
+          scope "#{state}".to_sym, where(self.arel_table["#{state}_at".to_sym].not_eq(nil))
+          scope "not_#{state}".to_sym, where(self.arel_table["#{state}_at".to_sym].eq(nil))
+        else
+          log_error(state)
+          @all_status_marks_exist = @all_status_marks_exist && false
+        end
+      end
+    end
+
+    def install_methods
+      on_at_events.each do |state|
+        if self.arel_table["#{state}_at".to_sym] then
+          define_method "#{state}?" do
+            !read_attribute("#{state}_at".to_sym).nil?
+          end
+
+          define_method "not_#{state}!" do
+            if self.__send__("#{state}?")
+              self.send("#{state}_at=".to_sym,nil)
+              self.save!
+            end
+          end
+
+          define_method "#{state}!" do
+            unless self.__send__("#{state}?")
+              self.send("#{state}_at=".to_sym,Time.now)
+              self.save!
+            end
+          end
+        else
+          log_error(state)
+          @all_status_marks_exist = @all_status_marks_exist && false
+        end
+      end
+    end
+
+    def off_at_events
+      @off_at_events
+    end
+    def all_at_events
+      @all_at_events ||= ( off_at_events | on_at_events )
+    end
+    def on_at_events
+      @on_at_events
+    end
+  end
+
+  module InstanceMethods
+
+    def status=(event_string)
+      case event_string
+      when ''
+        self.class.off_at_events.each do | event |
+          self.send("#{event}!") if self.respond_to?("#{event}!")
+        end
+      else
+        event_string.split(' ').each do | event | 
+          if self.class.all_at_events.include?(event.to_sym)
+            self.send("#{event}!") if self.respond_to?("#{event}!")
+          end
+        end
+      end
+    end
+
+    def status
+      status = []
+      self.class.on_at_events.each do | event |
+        status << event.to_s if self.send("#{event}?")
+      end
+      status.join(' ')
+    end
+  end
+end

data/spec/acts_as_status_for_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+ActiveRecord::Migration.create_table :things do |t|
+  t.datetime :on_hold_at
+  t.datetime :archived_at
+  t.datetime :featured_at
+end
+
+class Thing < ActiveRecord::Base
+  include ActsAsStatusFor
+end
+
+describe ActsAsStatusFor do
+  subject {
+    Thing.new
+  }
+  context "for non-existing fields" do
+    before do
+      @ran = false
+      Thing.instance_eval do
+        acts_as_status_for :happing do
+          @ran = true
+        end
+      end
+    end
+    it "does not execute block" do
+      @ran.should be_false
+    end
+  end
+  context "install dependent helpers" do
+    before do
+      Thing.instance_eval do
+        acts_as_status_for :on_hold, :archived, :featured do
+          scope :depends_on, not_on_hold.not_archived
+        end
+      end
+    end
+    it "#depends_on" do
+      subject.class.respond_to?(:depends_on).should be_true
+    end
+  end
+
+  context "#status" do
+    before do
+      Thing.instance_eval do
+        acts_as_status_for :on_hold, :archived, :featured
+      end
+    end
+    it "defaults to ''" do
+      subject.status.should == ''
+    end
+
+    it "setting it to blank clears all states" do
+      subject.on_hold!
+      subject.archived!
+      subject.featured!
+      subject.status = ''
+      subject.status.should == ''
+    end
+    {
+      # class finder method 
+      #          => [ list of event states that belong to finder]
+      #
+      :featured  => [:featured],
+      :on_hold   => [:on_hold],
+      :archived  => [:archived]
+    }.each do |scope,states|
+      states.each do |state|
+        it "can be used to set events" do
+          subject.status = state.to_s
+          subject.send(%%#{state}?%).should be_true
+          subject.status.should include(state.to_s)
+        end
+
+        it "can be reversed" do
+          subject.status = state.to_s
+          subject.send("#{state}?").should be_true
+          subject.status = "not_" + state.to_s
+          subject.send("#{state}?").should be_false
+        end
+
+        it "#{state} sets state string" do
+          subject.send("#{state}!")
+          subject.send("#{state}?").should be_true
+          subject.status.should include(state.to_s)
+        end
+
+        it "#{state} is in the scope #{scope}" do
+          subject.send("#{state}!")
+          subject.send("#{state}?").should be_true
+          subject.class.send(scope).should include(subject)
+        end
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'acts_as_status_for'
+require './config/environment.rb'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_status_for
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Curtis Schofield
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: "Given a list of datetime _at attributes "
+email: github.com@robotarmyma.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README
+- Rakefile
+- VERSION
+- acts_as_status_for.gemspec
+- config/environment.rb
+- lib/acts_as_status_for.rb
+- spec/acts_as_status_for_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/robotarmy/acts_as_status_for
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -345335642477759870
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Acts as Status For a list of events - did something occur? or not? with scoped finder?
+test_files: []
+