status_accessor 0.1.0 → 1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/README.md

@@ -0,0 +1,70 @@
+status_accessor
+===============
+
+A simple bit of code we keep reusing.
+
+It provides a quick way of setting up accessors for a status-like field,
+which by default is called :status, but can be anything
+
+Examples
+--------
+
+```ruby
+status_accessor :open, :closed
+```
+
+is equivalent to
+
+```ruby
+@@status_strings = ['OPEN', 'CLOSED']
+
+def open?
+  status == 'OPEN'
+end
+
+def open!
+  status = 'OPEN'
+end
+
+def closed?
+  status == 'CLOSED'
+end
+
+def closed!
+  status = 'CLOSED'
+end
+
+# also adds appropriate named_scope accessors if the class responds to
+# named_scope (ie it is an ActiveRecord subclass)
+
+named_scope :open, :conditions => {:status => 'OPEN'}
+named_scope :closed, :conditions => {:status => 'CLOSED'}
+```
+
+An alternative field name can also be specified to override the default fieldname of 'status' like this:
+
+```ruby
+status_accessor :foo, [:open, :closed]
+```
+
+which works as expected so
+
+```ruby
+obj.open!
+obj.foo
+# => 'OPEN'
+
+Obj.foo_strings
+# => ['OPEN', 'CLOSED']
+```
+
+By default statuses are stored upcase.  This behaviour can be modified by passing a :transform option eg
+
+```ruby
+status_accessor :open, :closed, :transform => :downcase
+
+# then
+obj.open!
+obj.status
+# => 'open'
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/status_accessor.rb

@@ -38,7 +38,7 @@ module StatusAccessor
     class_variable_set "@@#{field_name}_strings", statuses.collect {|s| s.to_s.upcase}
 
     (class << self; self; end).send(:define_method, "#{field_name}_strings") do
-      class_variable_get "@@#{field_name}_strings"
+      class_variable_get("@@#{field_name}_strings").clone
     end
 
   end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module StatusAccessor
+  VERSION = '1.0'
+end

data/status_accessor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'status_accessor'
+  s.version     = StatusAccessor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.date        = '2012-03-26'
+  s.summary     = "utility for handling status-like fields"
+  s.description = "utility for handling status-like fields"
+  s.authors     = "Rob Anderson"
+  s.email       = 'rob.anderson@paymentcardsolutions.co.uk'
+  s.files       = ["lib/status_accessor.rb"]
+  s.homepage    = 'https://github.com/rob-anderson/status_accessor.git'
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/test/status_accessor_test.rb

@@ -0,0 +1,87 @@
+require 'lib/status_accessor'
+require 'test/unit'
+
+class StatusAccessorTest < Test::Unit::TestCase
+
+  class Test1
+    extend StatusAccessor
+    status_accessor :cheese, :ham
+  end
+  class Test2
+    extend StatusAccessor
+    status_accessor :chalk
+  end
+
+  def test_statuses_are_unique_to_classes
+    assert_equal ['CHEESE', 'HAM'], Test1.status_strings
+    assert_equal ['CHALK'], Test2.status_strings
+    assert_equal ['CHEESE', 'HAM'], Test1.status_strings # reading the Test2 definition hasn't overwritten class variable
+  end
+
+  def test_status_strings_provdes_cloned_instance
+    assert_equal ['Any', 'CHEESE', 'HAM'], Test1.status_strings.unshift('Any')
+    assert_equal ['CHEESE', 'HAM'], Test1.status_strings
+  end
+
+  class Valve
+    extend StatusAccessor
+    attr_accessor :status
+    status_accessor :open, :closed
+  end
+
+  def test_setters_and_getters_work_as_expected
+    v = Valve.new
+    v.open!
+    assert_equal 'OPEN', v.status
+    v.closed!
+    assert_equal 'CLOSED', v.status
+    assert v.closed?
+    assert !v.open?
+  end
+
+  class Chameleon
+    attr_accessor :colour
+    extend StatusAccessor
+    status_accessor :colour, [:red, :blue, :green]
+  end
+
+  def test_default_status_field_name_can_be_overwritten
+    assert_equal %w{RED BLUE GREEN}, Chameleon.colour_strings
+    c = Chameleon.new
+    c.blue!
+    assert_equal 'BLUE', c.colour
+    assert c.blue?
+  end
+
+  class Camel
+    attr_accessor :hump
+    extend StatusAccessor
+    status_accessor :hump, [:single_hump, :double_hump], :transform => :capitalize
+  end
+
+  def status_formatting_can_be_set_via_a_transform_option
+    c = Camel.new
+    c.single_hump!
+    assert_equal "Single_hump", c.hump
+  end
+
+  class MockedActiveRecord
+    class << self
+      @@nops = []
+      def named_scope name, options
+        @@nops << [name, options]
+      end
+      def named_scopes
+        @@nops
+      end
+    end
+    extend StatusAccessor
+    status_accessor :ham, :spam
+  end
+
+  def test_named_scopes
+    assert_equal [:ham, {:conditions => {:status => 'HAM'}}], MockedActiveRecord.named_scopes.first
+  end
+
+end
+

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: status_accessor
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: 
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  version: "1.0"
 platform: ruby
 authors: 
 - Rob Anderson
@@ -16,8 +15,23 @@ bindir: bin
 cert_chain: []
 
 date: 2012-03-26 00:00:00 Z
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
 description: utility for handling status-like fields
 email: rob.anderson@paymentcardsolutions.co.uk
 executables: []
@@ -27,8 +41,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- README.md
+- Rakefile
 - lib/status_accessor.rb
-homepage: http://rubygems.org/gems/status_accessor
+- lib/version.rb
+- status_accessor.gemspec
+- test/status_accessor_test.rb
+homepage: https://github.com/rob-anderson/status_accessor.git
 licenses: []
 
 post_install_message: 
@@ -50,14 +70,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: utility for handling status-like fields