acts_as_label 1.0.2 → 1.1.0

data/.specification

@@ -1,22 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_label
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Coroutine
 - John Dugan
+- Rick Branson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 -06:00
-default_executable: 
+date: 2011-05-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -26,10 +22,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 4
         version: 2.3.4
   type: :runtime
   version_requirements: *id001
@@ -41,10 +33,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 4
         version: 2.3.4
   type: :development
   version_requirements: *id002
@@ -57,7 +45,6 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - .specification
 - MIT-LICENSE
 - README.rdoc
@@ -70,13 +57,12 @@ files:
 - rails/init.rb
 - test/acts_as_label_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/coroutine/acts_as_label
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -84,25 +70,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: Gem version of acts_as_label Rails plugin.
-test_files: 
-- test/acts_as_label_test.rb
-- test/test_helper.rb
+test_files: []
+
 

data/Rakefile

@@ -28,7 +28,7 @@ end
 
 begin
   Jeweler::Tasks.new do |gemspec|
-    gemspec.authors           = ["Coroutine", "John Dugan"]
+    gemspec.authors           = ["Coroutine", "John Dugan", "Rick Branson"]
     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"

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/acts_as_label.gemspec

@@ -1,47 +1,40 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_label}
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Coroutine", "John Dugan"]
-  s.date = %q{2010-12-16}
+  s.authors = [%q{Coroutine}, %q{John Dugan}, %q{Rick Branson}]
+  s.date = %q{2011-05-12}
   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}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     ".specification",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "acts_as_label.gemspec",
-     "init.rb",
-     "lib/acts_as_label.rb",
-     "lib/acts_as_label/base.rb",
-     "rails/init.rb",
-     "test/acts_as_label_test.rb",
-     "test/test_helper.rb"
+    ".specification",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acts_as_label.gemspec",
+    "init.rb",
+    "lib/acts_as_label.rb",
+    "lib/acts_as_label/base.rb",
+    "rails/init.rb",
+    "test/acts_as_label_test.rb",
+    "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/coroutine/acts_as_label}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.2}
   s.summary = %q{Gem version of acts_as_label Rails plugin.}
-  s.test_files = [
-    "test/acts_as_label_test.rb",
-     "test/test_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/acts_as_label/base.rb

@@ -77,7 +77,7 @@ module Coroutine                      #:nodoc:
           #--------------------------------------------
           class_eval do
             
-            # Add inheritable accessors
+            # inheritable accessors
             write_inheritable_attribute :acts_as_label_system_label_column,   system_label
             class_inheritable_reader    :acts_as_label_system_label_column
             write_inheritable_attribute :acts_as_label_label_column,          label
@@ -92,7 +92,7 @@ module Coroutine                      #:nodoc:
             attr_readonly               system_label
             
             
-            # Add validations
+            # validations
             validates_presence_of       system_label
             validates_length_of         system_label,  :maximum   => 255
             validates_format_of         system_label,  :with      => /^[A-Z][_A-Z0-9]*$/
@@ -100,36 +100,66 @@ module Coroutine                      #:nodoc:
             validates_length_of         label,         :maximum => 255
             
             
-            # Add method missing, if needed
-            unless self.method_defined? :method_missing
-              def self.method_missing(method, *args, &block)
+            
+            # This method catches all undefined method calls. It first sees if any ancestor
+            # understands the request. If not, it tries to match the method call to an
+            # existing system label. If that is found, it lazily manufacturers a method on the
+            # class of the same name. Otherwise, it throws the NoMethodError.
+            #
+            def self.method_missing(method, *args, &block)
+              begin
                 super
+              rescue NoMethodError => e
+                if has_acts_as_label_method?(method)
+                  self.__send__(method)
+                elsif method.to_s == "to_ary"
+                  # do nothing
+                else
+                  throw e
+                end
               end
             end
             
-            # Add custom method missing functionality to perform find by system label lookup. If 
-            # nothing is found, it delegates the call to the original method_missing.
+                        
+            # This method determines whether or not the class has an instance with
+            # the given system label. If it does, it also lazily creates a method 
+            # that can be accessed without all this method missing nonsense.
             #
-            # The method attempts rails 3 syntax. If that fails, it reverts to rails 2 syntax.
-            def self.method_missing_with_label(method, *args, &block)
-              if self.respond_to?(:where)
-                record = self.where("#{acts_as_label_system_label_column} = ?", method.to_s.upcase).first
-              else
-                record =  self.find(:first, :conditions => ["#{acts_as_label_system_label_column} = ?", method.to_s.upcase])
-              end
-              if record
-                return record
-              else
-                method_missing_without_label(method, *args, &block)
+            def self.has_acts_as_label_method?(method_name)
+              mn = method_name.to_s.underscore
+              sl = mn.upcase
+              
+              if record = by_acts_as_label_system_label(sl)
+                eval %Q{
+                  class << self
+                    def #{mn}
+                      by_acts_as_label_system_label('#{sl}')
+                    end
+                  end
+                }
               end
+              
+              !!record
             end
             
-            # Add method missing alias
-            class << self
-              alias_method_chain :method_missing, :label       
+            
+            # This method finds an active record object for the given system label.
+            # It automatically determines the correct syntax for the current version
+            # of rails via duck typing.def typing.
+            #             
+            def self.by_acts_as_label_system_label(system_label)
+              sl = system_label.to_s.upcase
+              
+              if @by_system_label_has_arel ||= ActiveRecord::Base.respond_to?(:where)
+                where("#{acts_as_label_system_label_column} = ?", sl).first
+              else
+                find(:first, :conditions => ["#{acts_as_label_system_label_column} = ?", sl])
+              end
             end
-               
-            # Add class method to return default record, if needed
+
+
+            # This block adds a class method to return the default record.
+            #
             unless self.method_defined? :default
               if default.nil?
                 def self.default
@@ -141,7 +171,16 @@ module Coroutine                      #:nodoc:
                 end
               end
             end
-            
+
+
+            # This method overrides the system label column writer to force 
+            # upcasing of the value.
+            #
+            define_method("#{acts_as_label_system_label_column}=") do |value| 
+              value = value.to_s.strip.upcase unless value.nil?
+              write_attribute("#{acts_as_label_system_label_column}", value)
+            end
+                          
             
             # Add all the instance methods
             include Coroutine::ActsAsLabel::Base::InstanceMethods
@@ -153,14 +192,6 @@ module Coroutine                      #:nodoc:
     
       module InstanceMethods
         
-        # This method updates the system label attribute writer to ensure it is uppercase.
-        #
-        def system_label=(value)
-          value = value.to_s.strip.upcase unless value.nil?
-          write_attribute("#{acts_as_label_system_label_column}", value)
-        end
-        
-        
         # This method overrides the to_s method to return the friendly label value.
         #
         def to_s
@@ -169,15 +200,25 @@ module Coroutine                      #:nodoc:
         
         
         # This method overrides the to_sym method to return the downcased symbolized 
-        # system label value.  This method is particularly useful in conjunction with
+        # system label value. This method is particularly useful in conjunction with
         # role-based authorization systems.
         #
         def to_sym
-          self.send("#{acts_as_label_system_label_column}").downcase.to_sym
+          self.send("#{acts_as_label_system_label_column}").underscore.to_sym
+        end
+        
+        
+        # This method compares two values by running to_sym on both sides.  This allows
+        # comparisons like the following:
+        #   u.role == Role.superuser
+        #   u.role == :superuser
+        #
+        def ==(other)
+          self.to_sym == other.to_sym
         end
         
       end
     
     end
   end
-end
+end

data/lib/acts_as_label.rb

@@ -1,10 +1,10 @@
-# external gems
-require "active_record"
-
-
 # acts_as_label extension
 require File.dirname(__FILE__) + "/acts_as_label/base"
 
 
 # add extensions to active record
-::ActiveRecord::Base.send(:include, Coroutine::ActsAsLabel::Base)
+begin
+  ::ActiveRecord::Base.send(:include, Coroutine::ActsAsLabel::Base)
+rescue
+  # do nothing
+end

data/rails/init.rb

@@ -1 +1 @@
-require 'acts_as_label'
+require "acts_as_label"

data/test/acts_as_label_test.rb

@@ -6,7 +6,6 @@
 require "test_helper"
 
 
-
 #---------------------------------------------------------
 # Database config
 #---------------------------------------------------------
@@ -14,7 +13,6 @@ require "test_helper"
 # establish db connection
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 
-
 # define and seed tables
 def setup_db
   ActiveRecord::Schema.define(:version => 1) do
@@ -59,7 +57,6 @@ def teardown_db
 end
 
 
-
 #---------------------------------------------------------
 # Model definitions
 #---------------------------------------------------------
@@ -96,7 +93,6 @@ class Framework < ActiveRecord::Base
 end
 
 
-
 #---------------------------------------------------------
 # Tests
 #---------------------------------------------------------
@@ -114,8 +110,6 @@ class ActsAsLabelTest < ActiveSupport::TestCase
     teardown_db
   end
 
-
-
   #---------------------------------------------
   # test validations
   #---------------------------------------------
@@ -216,6 +210,7 @@ class ActsAsLabelTest < ActiveSupport::TestCase
     begin
       role_superuser  = Role.where("system_label = ?", "SUPERUSER").first
       role_guest      = Role.where("system_label = ?", "GUEST").first
+      role_fresh      = Role.create!(:system_label => "FRESH", :label => "Fresh")
       framework_rails = Framework.where("system_name = ?", "RUBY_ON_RAILS").first
     rescue
       role_superuser  = Role.find(:first, :conditions => ["system_label = ?", "SUPERUSER"])
@@ -223,8 +218,14 @@ class ActsAsLabelTest < ActiveSupport::TestCase
       framework_rails = Framework.find(:first, :conditions => ["system_name = ?", "RUBY_ON_RAILS"])
     end
     
+    # Won't have a method now
+    assert !Role.methods.map(&:to_s).include?("fresh")  # some rubies report strings, some symbols
+    
     # test lookup by system label
-    assert_equal role_superuser, Role.superuser
+    assert_equal role_fresh, Role.fresh
+    
+    # should have a method now
+    assert Role.methods.map(&:to_s).include?("fresh")   # some rubies report strings, some symbols
     
     # test default with implemented method
     assert_equal role_guest, Role.default
@@ -234,10 +235,8 @@ class ActsAsLabelTest < ActiveSupport::TestCase
     
     # test default with specified system label
     assert_equal framework_rails, Framework.default
-    
   end
   
-  
   def test_method_missing_finders
     
     # dynamic find on stand-alone model
@@ -289,6 +288,13 @@ class ActsAsLabelTest < ActiveSupport::TestCase
   # test instance methods
   #---------------------------------------------
   
+  def test_equality
+    r1 = Role.superuser
+    
+    assert (r1 == Role.superuser)
+    assert (r1 == :superuser)
+  end
+  
   def test_to_s
     role = Role.first
     assert_equal role.label, role.to_s
@@ -300,8 +306,15 @@ class ActsAsLabelTest < ActiveSupport::TestCase
   end
   
   def test_upcase_system_label_value
+    
+    # default system label column name
     record = Role.create!({ :system_label => "Customer",  :label => "Client" })
     assert_equal record.system_label, "CUSTOMER"
+    
+    # custom system label column name
+    record = Framework.create!( :system_name => "example", :name => "Example")
+    assert_equal record.system_name, "EXAMPLE"
+    
   end
 
 end

data/test/test_helper.rb

@@ -2,13 +2,12 @@
 require "rubygems"
 require "active_support"
 require "active_support/test_case"
+require "active_record"
 require "test/unit"
 
 # require plugin
 require "#{File.dirname(__FILE__)}/../init"
 
-
-
 #----------------------------------------------------------
 # Define global methods
 #----------------------------------------------------------

metadata

@@ -1,21 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_label
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Coroutine
 - John Dugan
+- Rick Branson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -06:00
+date: 2011-05-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,6 +28,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 2
         - 3
@@ -41,6 +44,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 2
         - 3
@@ -57,7 +61,6 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - .specification
 - MIT-LICENSE
 - README.rdoc
@@ -75,8 +78,8 @@ homepage: http://github.com/coroutine/acts_as_label
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -84,6 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -92,16 +96,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Gem version of acts_as_label Rails plugin.
-test_files: 
-- test/acts_as_label_test.rb
-- test/test_helper.rb
+test_files: []
+

data/.gitignore

@@ -1,2 +0,0 @@
-.DS_Store
-*.gem