acts_as_label 0.1.2 → 0.1.3

data/.specification

@@ -5,10 +5,11 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
+- Coroutine
 - John Dugan
 autorequire: 
 bindir: bin
@@ -39,10 +40,12 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .gitignore
+- .specification
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- acts_as_label-0.1.2.gem
 - acts_as_label.gemspec
 - init.rb
 - lib/acts_as_label.rb

data/README.rdoc

@@ -6,6 +6,13 @@
 This acts_as extension implements a system label and a friendly label on a class and centralizes
 the logic for performing validations and accessing items by system label.
 
+The extension is particularly useful for tabled, enumerated lists.  
+
+The system label is declared as a read-only attribute, allowing models and controllers to code 
+to the value safely, secure in the knowledge that the value will never change.  
+
+The friendly value can be changed to any value required by the end-user without affecting the 
+model/controller code in any way.
 
 
 == Usage
@@ -42,6 +49,28 @@ record is by implementing a class method on the subclass.
   end
 
 
+The extension also allows records to be access by system label as though the system label were 
+a class method.  The default option can be accessed in a similar manner using the class 
+method +default+.  This yields more expressive code.
+
+  class Role < ActiveRecord::Base
+    has_many :users  
+
+    acts_as_label :default => :guest
+  end
+
+  class User < ActiveRecord::Base
+    belongs_to :role
+  end
+
+  Role.create!({ :system_label => "SUPERUSER", :label => "Superuser"} )
+  Role.create!({ :system_label => "GUEST",      :label => "Guest"} )
+
+  User.create!({ :name => "John Dugan",     :role => Role.superuser })
+  User.create!({ :name => "Anonymous Dude", :role => Role.default })
+	
+
+
 
 == License
 

data/Rakefile

@@ -33,7 +33,7 @@ begin
     gemspec.description       = "This acts_as extension implements a system label and a friendly label on a class and centralizes the logic for performing validations and accessing items by system label."
     gemspec.email             = "jdugan@coroutine.com"
     gemspec.homepage          = "http://github.com/coroutine/acts_as_label"
-    gemspec.authors           = ["John Dugan"]
+    gemspec.authors           = ["Coroutine", "John Dugan"]
     gemspec.add_dependency "activesupport"
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/acts_as_label.gemspec

@@ -5,10 +5,10 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_label}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Dugan"]
+  s.authors = ["Coroutine", "John Dugan"]
   s.date = %q{2010-03-10}
   s.description = %q{This acts_as extension implements a system label and a friendly label on a class and centralizes the logic for performing validations and accessing items by system label.}
   s.email = %q{jdugan@coroutine.com}

data/lib/acts_as_label.rb

@@ -88,6 +88,10 @@ module Coroutine                      #:nodoc:
             class_inheritable_reader    :acts_as_label_default_system_label
           
             
+            # protect attributes
+            attr_readonly               system_label
+            
+            
             # Add validations
             validates_presence_of       system_label
             validates_length_of         system_label,  :maximum   => 255

data/test/acts_as_label_test.rb

@@ -241,6 +241,39 @@ class ActsAsLabelTest < ActiveSupport::TestCase
   
   
   
+  #---------------------------------------------
+  # test validations
+  #---------------------------------------------
+  
+  def test_system_label_is_readonly
+    
+    # build valid record
+    record = Role.new({ :system_label => "CUSTOMER",  :label => "Client" })
+    assert record.valid?
+    
+    # save it and remember id and system label
+    record.save
+    id           = record.id
+    system_label = record.system_label
+    
+    # system label unchanged on safe update
+    record.label  = "Customer"
+    record.save
+    record = Role.find(id)                            # we have to get the record again to verify what's in the db
+    assert_equal system_label, record.system_label
+    
+    # system_label unchanged on unsafe update
+    record.system_label = "CLIENT"
+    record.label        = "Client"
+    record.save
+    record = Role.find(id)                            # we have to get the record again to verify what's in the db
+    assert_equal "Client", record.label
+    assert_equal system_label, record.system_label
+    
+  end
+  
+  
+  
   #---------------------------------------------
   # test instance methods
   #---------------------------------------------

metadata

@@ -5,10 +5,11 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
+- Coroutine
 - John Dugan
 autorequire: 
 bindir: bin