attribute_predicates 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 == master
 
+== 0.1.1 / 2008-07-06
+
+* Remove dependency on active_support for non-ActiveRecord predicates
+
 == 0.1.0 / 2008-07-03
 
 * Rename to attribute_predicates

data/README.rdoc

@@ -70,7 +70,7 @@ is equivalent to:
 
 ==== attr_reader
 
-This method is equivalent to calling <tt>battr(symbol, false)</tt> on each symbol in
+This method is equivalent to calling <tt>attr(symbol, false)</tt> on each symbol in
 turn.  For example,
 
   module Mod

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'attribute_predicates'
-  s.version           = '0.1.0'
+  s.version           = '0.1.1'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Adds automatic generation of predicate methods for attributes.'
   

data/lib/attribute_predicates/extensions/active_record.rb

@@ -1,22 +1,53 @@
 module PluginAWeek #:nodoc:
   module AttributePredicates
-    module ActiveRecord
-      private
-        # For Strings, returns true when value is:
-        # * "true"
-        # * "t"
-        # 
-        # For Integers, returns true when value is:
-        # * 1
-        def attr_predicate(symbol)
-          define_method("#{symbol}?") do
-            ::ActiveRecord::ConnectionAdapters::Column.value_to_boolean(instance_variable_get("@#{symbol}"))
+    module Extensions
+      # Adds support for automatically defining predicate methods using +attr_predicate+
+      # when defining attributes using +attr+, +attr_reader+, +attr_reader+, and
+      # +attr_accessor+.  In comparison to normal Ruby attributes, ActiveRecord
+      # predicates use a different system for defining true/false.
+      # 
+      # == Examples
+      # 
+      # The predicate methods for attributes use ActiveRecord's type conversion
+      # for booleans for determing whether to return true or false.  For example,
+      # 
+      #   class Person < ActiveRecord::Base
+      #     attr_accessor :value
+      #   end
+      #   
+      #   p = Person.new
+      #   p.value = false
+      #   p.value?    # => false
+      #   
+      #   p.value = 'false'
+      #   p.value?    # => false
+      #   
+      #   p.value = 'true'
+      #   p.value?    # => true
+      #   
+      #   p.value = 't'
+      #   p.value?    # => true
+      #   
+      #   p.value = 1
+      #   p.value?    # => true
+      module ActiveRecord
+        private
+          # For Strings, returns true when value is:
+          # * "true"
+          # * "t"
+          # 
+          # For Integers, returns true when value is:
+          # * 1
+          def attr_predicate(symbol)
+            define_method("#{symbol}?") do
+              ::ActiveRecord::ConnectionAdapters::Column.value_to_boolean(instance_variable_get("@#{symbol}"))
+            end
           end
-        end
+      end
     end
   end
 end
 
 ActiveRecord::Base.class_eval do
-  extend PluginAWeek::AttributePredicates::ActiveRecord
+  extend PluginAWeek::AttributePredicates::Extensions::ActiveRecord
 end if defined?(ActiveRecord)

data/lib/attribute_predicates/extensions/module.rb

@@ -1,37 +1,81 @@
 module PluginAWeek #:nodoc:
   module AttributePredicates
-    module Module
-      def self.included(base) #:nodoc:
-        base.class_eval do
-          [:attr, :attr_reader, :attr_writer, :attr_accessor].each do |method|
-            alias_method_chain method, :predicates
+    module Extensions
+      # Adds support for automatically defining predicate methods using +attr_predicate+
+      # when defining attributes using +attr+, +attr_reader+, +attr_reader+, and
+      # +attr_accessor+.
+      # 
+      # == Examples
+      # 
+      # The predicate methods for attributes checks whether the value is blank?
+      # for determining whether true or false should be returned.  For example,
+      # 
+      #   class Person
+      #     attr_accessor :value
+      #   end
+      #   
+      #   p = Person.new
+      #   p.value = false
+      #   p.value?    # => false
+      #   
+      #   p.value = true
+      #   p.value?    # => true
+      #   
+      #   p.value = []
+      #   p.value?    # => false
+      #   
+      #   p.value = [false]
+      #   p.value?    # => true
+      module Module
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            %w(attr attr_reader attr_writer attr_accessor).each do |method|
+              alias_method "#{method}_without_predicates", method
+              alias_method method, "#{method}_with_predicates"
+            end
           end
         end
-      end
-      
-      def attr_with_predicates(*args) #:nodoc:
-        attr_without_predicates(*args)
-        attr_predicate(args.first)
-      end
-      
-      [:attr_reader, :attr_writer, :attr_accessor].each do |method|
-        define_method("#{method}_with_predicates") do |*symbols|
-          send("#{method}_without_predicates", *symbols)
-          symbols.each {|symbol| attr_predicate(symbol)}
+        
+        # Defines a predicate method, using +attr_predicate+, in addition to the
+        # attribute accessors.  For example,
+        # 
+        #   module Mod
+        #     attr :is_okay
+        #   end
+        #   
+        #   Mod.instance-methods.sort # => ["is_okay", "is_okay?"]
+        def attr_with_predicates(*args)
+          attr_without_predicates(*args)
+          attr_predicate(args.first)
         end
-      end
-      
-      private
-        # Returns true if the specified variable is not blank, otherwise false
-        def attr_predicate(symbol)
-          define_method("#{symbol}?") do
-            !instance_variable_get("@#{symbol}").blank?
+        
+        [:attr_reader, :attr_writer, :attr_accessor].each do |method|
+          define_method("#{method}_with_predicates") do |*symbols|
+            send("#{method}_without_predicates", *symbols)
+            symbols.each {|symbol| attr_predicate(symbol)}
           end
         end
+        
+        private
+          # Returns true if the specified variable is not blank, otherwise false
+          def attr_predicate(symbol)
+            define_method("#{symbol}?") do
+              value = instance_variable_get("@#{symbol}")
+              if value.respond_to?(:blank?)
+                # Use ActiveSupport's implementation
+                !value.blank?
+              elsif value.respond_to?(:empty?)
+                !value.empty?
+              else
+                !!value
+              end
+            end
+          end
+      end
     end
   end
 end
 
 ::Module.class_eval do
-  include PluginAWeek::AttributePredicates::Module
+  include PluginAWeek::AttributePredicates::Extensions::Module
 end

data/test/module_test.rb

@@ -15,18 +15,18 @@ class ModuleAttrTest < Test::Unit::TestCase
   
   def test_should_create_predicate_for_readonly_attr
     @module.attr(:foo)
-    ['foo', 'foo?'].each do |method|
+    %w(foo foo?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
     
-    ['foo='].each do |method|
+    %w(foo=).each do |method|
       assert !@module.instance_methods.include?(method), "#{method} exists"
     end
   end
   
   def test_should_create_predicate_for_readwrite_attr
     @module.attr(:foo, true)
-    ['foo', 'foo=', 'foo?'].each do |method|
+    %w(foo foo= foo?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
   end
@@ -39,22 +39,22 @@ class ModuleAttrReaderTest < Test::Unit::TestCase
   
   def test_should_create_predicate
     @module.attr_reader(:foo)
-    ['foo', 'foo?'].each do |method|
+    %w(foo foo?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
     
-    ['foo='].each do |method|
+    %w(foo=).each do |method|
       assert !@module.instance_methods.include?(method), "#{method} exists"
     end
   end
   
   def test_should_create_predicate_for_multiple_attributes
     @module.attr_reader(:foo, :bar)
-    ['foo', 'foo?', 'bar', 'bar?'].each do |method|
+    %w(foo foo? bar bar?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
     
-    ['foo=', 'bar='].each do |method|
+    %w(foo= bar=).each do |method|
       assert !@module.instance_methods.include?(method), "#{method} exists"
     end
   end
@@ -67,14 +67,14 @@ class ModuleAttrAccessorTest < Test::Unit::TestCase
   
   def test_should_create_predicate
     @module.attr_accessor(:foo)
-    ['foo', 'foo=', 'foo?'].each do |method|
+    %w(foo foo= foo?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
   end
   
   def test_should_create_predicate_for_multiple_attributes
     @module.attr_accessor(:foo, :bar)
-    ['foo', 'foo=', 'foo?', 'bar', 'bar=', 'bar?'].each do |method|
+    %w(foo foo= foo? bar bar= bar?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
   end
@@ -87,22 +87,22 @@ class ModuleAttrWriterTest < Test::Unit::TestCase
   
   def test_should_create_predicate
     @module.attr_writer(:foo)
-    ['foo=', 'foo?'].each do |method|
+    %w(foo= foo?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
     
-    ['foo'].each do |method|
+    %w(foo).each do |method|
       assert !@module.instance_methods.include?(method), "#{method} exists"
     end
   end
   
   def test_should_create_predicate_for_multiple_attributes
     @module.attr_writer(:foo, :bar)
-    ['foo=', 'foo?', 'bar=', 'bar?'].each do |method|
+    %w(foo= foo? bar= bar?).each do |method|
       assert @module.instance_methods.include?(method), "#{method} does not exist"
     end
     
-    ['foo', 'bar'].each do |method|
+    %w(foo bar).each do |method|
       assert !@module.instance_methods.include?(method), "#{method} exists"
     end
   end
@@ -131,6 +131,7 @@ class ModuleTest < Test::Unit::TestCase
   def test_should_evaluate_false_values_for_predicate
     @klass.attr_accessor(:foo)
     
+    # *Note* ' ' is only false when ActiveSupport is being used
     [nil, '', ' ', {}, []].each do |value|
       assert_equal false, @klass.new(value).foo?, "#{value.inspect} is true"
     end

data/test/test_helper.rb

@@ -1,4 +1,6 @@
 # Load the plugin testing framework
 $:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+
+# Use the test helper for testing ActiveRecord
 require 'rubygems'
 require 'plugin_test_helper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_predicates
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-03 00:00:00 -04:00
+date: 2008-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: []