attribute_predicates 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,27 @@
+== master
+
+== 0.1.0 / 2008-07-03
+
+* Rename to attribute_predicates
+
+== 0.0.5 / 2008-06-19
+
+* Avoid string evaluation for dynamic methods
+
+== 0.0.4 / 2008-05-05
+
+* Support for Rails 2.1
+* Update documentation
+
+== 0.0.3 / 2007-09-18
+
+* Remove gem dependency on activerecord
+* Convert dos newlines to unix newlines
+
+== 0.0.2 / 2007-02-02
+
+* Released as a gem
+
+== 0.0.1 / 2007-01-04
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2008 Aaron Pfeifer
+
+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.rdoc

@@ -0,0 +1,135 @@
+= attribute_predicates
+
++attribute_predicates+ adds automatic generation of predicate methods (truth
+accessors) when defining attributes using +attr+, +attr_reader+, +attr_writer+, and
++attr_accessor+.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/attribute_predicates
+
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13777-attribute_predicates
+
+Development
+
+* http://github.com/pluginaweek/attribute_predicates
+
+Source
+
+* git://github.com/pluginaweek/attribute_predicates.git
+
+== Description
+
+When you define attributes within your classes and want to use the
+predicate-style methods (i.e. "def foo?; end"), then you have to define these
+yourself.  This is a repetitive task especially if you want to query attributes
+that may not necessarily contain just true/false.  For example, an attribute
+may contain 0, or the string "false".  In this case, you would need to do
+special checks to see whether or not the value is really false.
+
++attribute_predicates+ makes it easy by automatically generating predicate-style
+methods for all attributes that are created using +attr+, +attr_reader+, +attr_writer+,
+and +attr_accessor+.  In addition, there is support for ActiveRecord's
+non-standard truth accessor implementation (see below).
+
+All of these shortcuts have the same interface and meaning as you would normally
+find.
+
+== Usage
+
+=== Ruby Attributes
+
+==== attr
+
+This method takes a symbol (the name of the attribute) and an optional argument
+for whether or not the attribute is writeable.  For example,
+
+  module Mod
+    attr :is_okay, true
+  end
+
+is equivalent to:
+
+  module Mod
+    def is_okay
+      @is_okay
+    end
+    
+    def is_okay=(val)
+      @is_okay = value
+    end
+    
+    def is_okay?
+      !is_okay.blank?
+    end
+  end
+
+==== attr_reader
+
+This method is equivalent to calling <tt>battr(symbol, false)</tt> on each symbol in
+turn.  For example,
+
+  module Mod
+    attr_reader :is_good, :is_bad
+  end
+  
+  Mod.instance_methods.sort   #=> ["is_bad", "is_bad?", "is_good", "is_good?"]
+
+==== attr_writer
+
+This method creates an accessor and predicate method for each symbol in turn.
+For example,
+
+  module Mod
+    attr_writer :is_good, :is_bad
+  end
+  
+  Mod.instance_methods.sort   #=> ["is_bad=", "is_bad?", "is_good=", "is_good?"]
+
+==== attr_accessor
+
+This method is equivalent to calling <tt>attr(symbol, true)</tt> on each symbol in
+turn.  For example,
+
+  module Mod
+    attr_accessor :is_good, :is_bad
+  end
+  
+  Mod.instance_methods.sort   #=> ["is_bad", "is_bad=", "is_bad?", "is_good", "is_good=", "is_good?"]
+
+=== ActiveRecord Attributes
+
+The predicate method has a slightly more complex implementation for subclasses
+of ActiveRecord::Base.  It is built from how ActiveRecord implemented querying
+attributes.  The following lists show which values will return false/true:
+
+For String, the following values return true:
+* "true"
+* "t"
+
+For Integer, the following values return true:
+* 1
+
+For all other types, the predicate will return false.
+
+== Testing
+
+Before you can run any tests, the following gem must be installed:
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
+
+To run against a specific version of Rails:
+
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
+
+== Dependencies
+
+* Rails 2.0 or later
+
+== References
+
+* Yurii Rashkovskii - {Boolean Attributes in Ruby}[http://rashkovskii.com/articles/2007/01/04/boolean-attributes-in-ruby]
+* Evan Weaver - {truth accessors in rails}[http://blog.evanweaver.com/articles/2007/01/05/truth-accessors-in-rails]

data/Rakefile

@@ -0,0 +1,88 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+spec = Gem::Specification.new do |s|
+  s.name              = 'attribute_predicates'
+  s.version           = '0.1.0'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Adds automatic generation of predicate methods for attributes.'
+  
+  s.files             = FileList['{lib,test}/**/*'].to_a + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc)
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
+task :default => :test
+
+desc "Test the #{spec.name} plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = spec.test_files
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = spec.name
+  rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem.'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
+end
+
+desc 'Publish the API documentation.'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pgem, :pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new.configure
+  ruby_forge.login
+  
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'attribute_predicates'

data/lib/attribute_predicates.rb

@@ -0,0 +1,2 @@
+require 'attribute_predicates/extensions/module'
+require 'attribute_predicates/extensions/active_record'

data/lib/attribute_predicates/extensions/active_record.rb

@@ -0,0 +1,22 @@
+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}"))
+          end
+        end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend PluginAWeek::AttributePredicates::ActiveRecord
+end if defined?(ActiveRecord)

data/lib/attribute_predicates/extensions/module.rb

@@ -0,0 +1,37 @@
+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
+          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)}
+        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?
+          end
+        end
+    end
+  end
+end
+
+::Module.class_eval do
+  include PluginAWeek::AttributePredicates::Module
+end

data/test/active_record_test.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActiveRecordTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(ActiveRecord::Base) do
+      def initialize(value)
+        self.foo = value
+      end
+    end
+  end
+  
+  def test_should_evaluate_string_values
+    @klass.attr_accessor(:foo)
+    
+    [nil, '', 'Name'].each do |value|
+      assert_equal false, @klass.new(value).foo?, "#{value.inspect} is true"
+    end
+  end
+  
+  def test_should_evaluate_numeric_values
+    @klass.attr_accessor(:foo)
+    
+    [nil, 0, '0'].each do |value|
+      assert_equal false, @klass.new(value).foo?, "#{value.inspect} is true"
+    end
+    
+    assert_equal true, @klass.new(1).foo?, '1 is false'
+    assert_equal true, @klass.new('1').foo?, '"1" is false'
+  end
+  
+  def test_should_evaluate_boolean_values
+    @klass.attr_accessor(:foo)
+    
+    [nil, '', false, 'false', 'f', 0].each do |value|
+      assert_equal false, @klass.new(value).foo?, "#{value.inspect} is true"
+    end
+    
+    [true, 'true', '1', 1].each do |value|
+      assert_equal true, @klass.new(value).foo?, "#{value.inspect} is false"
+    end
+  end
+end

data/test/module_test.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Module
+  public  :attr,
+          :attr_reader,
+          :attr_writer,
+          :attr_accessor,
+          :attr_predicate
+end
+
+class ModuleAttrTest < Test::Unit::TestCase
+  def setup
+    @module = Module.new
+  end
+  
+  def test_should_create_predicate_for_readonly_attr
+    @module.attr(:foo)
+    ['foo', 'foo?'].each do |method|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+    
+    ['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|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+  end
+end
+
+class ModuleAttrReaderTest < Test::Unit::TestCase
+  def setup
+    @module = Module.new
+  end
+  
+  def test_should_create_predicate
+    @module.attr_reader(:foo)
+    ['foo', 'foo?'].each do |method|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+    
+    ['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|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+    
+    ['foo=', 'bar='].each do |method|
+      assert !@module.instance_methods.include?(method), "#{method} exists"
+    end
+  end
+end
+
+class ModuleAttrAccessorTest < Test::Unit::TestCase
+  def setup
+    @module = Module.new
+  end
+  
+  def test_should_create_predicate
+    @module.attr_accessor(:foo)
+    ['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|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+  end
+end
+
+class ModuleAttrWriterTest < Test::Unit::TestCase
+  def setup
+    @module = Module.new
+  end
+  
+  def test_should_create_predicate
+    @module.attr_writer(:foo)
+    ['foo=', 'foo?'].each do |method|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+    
+    ['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|
+      assert @module.instance_methods.include?(method), "#{method} does not exist"
+    end
+    
+    ['foo', 'bar'].each do |method|
+      assert !@module.instance_methods.include?(method), "#{method} exists"
+    end
+  end
+end
+
+class ModuleAttrPredicateTest < Test::Unit::TestCase
+  def setup
+    @module = Module.new
+  end
+  
+  def test_should_create_predicate
+    @module.attr_predicate(:foo)
+    assert @module.instance_methods.include?('foo?'), 'foo? does not exist'
+  end
+end
+  
+class ModuleTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new do
+      def initialize(value)
+        self.foo = value
+      end
+    end
+  end
+  
+  def test_should_evaluate_false_values_for_predicate
+    @klass.attr_accessor(:foo)
+    
+    [nil, '', ' ', {}, []].each do |value|
+      assert_equal false, @klass.new(value).foo?, "#{value.inspect} is true"
+    end
+  end
+  
+  def test_should_evaluate_true_values_for_predicate
+    @klass.attr_accessor(:foo)
+    
+    [1, 'hello world', {1 => 1}, [1]].each do |value|
+      assert_equal true, @klass.new(value).foo?, "#{value.inspect} is false"
+    end
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_predicates
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-03 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/attribute_predicates.rb
+- lib/attribute_predicates
+- lib/attribute_predicates/extensions
+- lib/attribute_predicates/extensions/active_record.rb
+- lib/attribute_predicates/extensions/module.rb
+- test/active_record_test.rb
+- test/test_helper.rb
+- test/module_test.rb
+- CHANGELOG.rdoc
+- init.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: pluginaweek
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Adds automatic generation of predicate methods for attributes.
+test_files: 
+- test/active_record_test.rb
+- test/module_test.rb