typed_accessors 0.1 → 0.2

data/lib/typed_accessors.rb

@@ -1,19 +1,46 @@
+# Typed accessors works as a Mixin on Class.  It creates a set of
+# functions that are used in the class definition which eval and
+# create new accessor methods at class eval time (so little
+# performance penalty).  For now, this is limitted to built in types,
+# float, int, boolean, and date, though this approach could clearly be
+# expanded.
+#
+# Example of a class definition
+#
+#   class MyClass
+#     float_accessor :distance
+#     int_accessor :count
+#     bool_yn_accessor :onfire
+#     date_accessor :day
+#   end
+
 class Class
+    
+    # Creates a boolean accessor.  It will convert and incoming string
+    # to a true / false value.  If the string is "y" or "yes" it will be
+    # true, otherwise false.
     def bool_yn_accessor( *symbols )
         attr_reader( *symbols )
         bool_yn_writer( *symbols )
     end
 
+    
+    # Creates a float accessor, using built in .to_f functions on
+    # objects.  Any object that has a .to_f is supported.
     def float_accessor( *symbols )
-        float_reader( *symbols )
+        attr_reader( *symbols )
         float_writer( *symbols )
     end
     
+    # Creates an int accessor, using built in .to_i functions on
+    # objects.  Any object that has a .to_i is supported.
     def int_accessor( *symbols )
-        int_reader( *symbols )
+        attr_reader( *symbols )
         int_writer( *symbols )
     end
     
+    # Creates a data accessor using the Date parse function on
+    # strings.  Not defined for other input types.
     def date_accessor( *symbols )
         attr_reader( *symbols )
         date_writer( *symbols )
@@ -25,7 +52,7 @@ class Class
         symbols.each do |symbol|
             class_eval(<<-EOS, __FILE__, __LINE__)
                 def #{symbol}=(val)
-                    if val.class.to_s == 'String'
+                    if val.is_a? String
                         instance_variable_set("@#{symbol}", Date.parse(val))
                     else
                         instance_variable_set("@#{symbol}", val)
@@ -39,7 +66,7 @@ class Class
         symbols.each do |symbol|
             class_eval(<<-EOS, __FILE__, __LINE__)
                 def #{symbol}=(val)
-                    if val.upcase == 'Y' || val == true then
+                    if (val.is_a? String and val =~ /^(y(es)?|t(rue)?)$/i) or val == true then
                         instance_variable_set("@#{symbol}", true)
                     else
                         instance_variable_set("@#{symbol}", false)
@@ -49,42 +76,22 @@ class Class
         end
     end
         
-    def float_reader( *symbols )
-        symbols.each do |symbol|
-            class_eval(<<-EOS, __FILE__, __LINE__)
-                def #{symbol}
-                    instance_variable_get("@#{symbol}")
-                end
-            EOS
-        end
-    end
-
     def float_writer( *symbols )
         symbols.each do |symbol|
             class_eval(<<-EOS, __FILE__, __LINE__)
                 def #{symbol}=(val)
-                    if !val.respond_to?('to_f') then raise ArgumentError, "#{symbol} must be float" end
+                    if !val.respond_to?('to_f') then raise ArgumentError, "#{symbol} must be Float" end
                     instance_variable_set("@#{symbol}", val.to_f)
                 end
             EOS
         end
     end
 
-    def int_reader( *symbols )
-        symbols.each do |symbol|
-            class_eval(<<-EOS, __FILE__, __LINE__)
-                def #{symbol}
-                    instance_variable_get("@#{symbol}")
-                end
-            EOS
-        end
-    end
-
     def int_writer( *symbols )
         symbols.each do |symbol|
             class_eval(<<-EOS, __FILE__, __LINE__)
                 def #{symbol}=(val)
-                    if !val.respond_to?('to_i') then raise ArgumentError, "#{symbol} must be int" end
+                    if !val.respond_to?('to_i') then raise ArgumentError, "#{symbol} must be Integer" end
                     instance_variable_set("@#{symbol}", val.to_i)
                 end
             EOS

data/test/basic_test.rb

@@ -0,0 +1,118 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'date'
+require 'typed_accessors'
+
+class TypedExample
+    float_accessor :dollars
+    int_accessor :count
+    bool_yn_accessor :onfire
+    date_accessor :day
+end
+
+class TestTypedAccessors < Test::Unit::TestCase
+    
+    def test_date
+        t = TypedExample.new
+        t.day = Date.today
+        assert_instance_of Date, t.day
+        assert_equal Date.today, t.day
+
+        t.day = Date.today.strftime("%Y-%m-%d")
+        assert_instance_of Date, t.day
+        assert_equal Date.today, t.day
+
+        # this might fail depending on locale, need to figure out a
+        # better way to handle that
+        t.day = Date.today.strftime("%m/%d/%Y")
+        assert_instance_of Date, t.day
+        assert_equal Date.today, t.day
+        
+        assert_raise ArgumentError do
+            t.day = Date.today.strftime("foo")
+        end
+    end
+    
+    def test_float
+        t = TypedExample.new
+
+        t.dollars = "54"
+        assert_instance_of Float, t.dollars
+        assert_equal 54.0, t.dollars
+
+        t.dollars = "54.200000"
+        assert_instance_of Float, t.dollars
+        assert_equal 54.2, t.dollars
+        
+        t.dollars = 54
+        assert_instance_of Float, t.dollars
+        assert_equal 54.0, t.dollars
+
+        t.dollars = "foo"
+        assert_instance_of Float, t.dollars
+        assert_equal 0.0, t.dollars
+
+    end
+
+    def test_int
+        t = TypedExample.new
+
+        t.count = "54"
+        assert_instance_of Fixnum, t.count
+        assert_equal 54, t.count
+
+        t.count = "54.200000"
+        assert_instance_of Fixnum, t.count
+        assert_equal 54, t.count
+        
+        t.count = 54.0
+        assert_instance_of Fixnum, t.count
+        assert_equal 54, t.count
+    end
+
+    def test_bool
+        t = TypedExample.new
+
+        t.onfire = "Y"
+        assert_instance_of TrueClass, t.onfire
+        assert_equal true, t.onfire
+
+        t.onfire = "54.200000"
+        assert_instance_of FalseClass, t.onfire
+        assert_equal false, t.onfire
+        
+        t.onfire = "y"
+        assert_instance_of TrueClass, t.onfire
+        assert_equal true, t.onfire
+        
+        t.onfire = "yes"
+        assert_instance_of TrueClass, t.onfire
+        assert_equal true, t.onfire
+
+        t.onfire = "yessir"
+        assert_instance_of FalseClass, t.onfire
+        assert_equal false, t.onfire
+
+        t.onfire = "t"
+        assert_instance_of TrueClass, t.onfire
+        assert_equal true, t.onfire
+        
+        t.onfire = "TRUE"
+        assert_instance_of TrueClass, t.onfire
+        assert_equal true, t.onfire
+
+        t.onfire = "truth"
+        assert_instance_of FalseClass, t.onfire
+        assert_equal false, t.onfire
+
+        t.onfire = false
+        assert_instance_of FalseClass, t.onfire
+        assert_equal false, t.onfire
+
+        t.onfire = true
+        assert_instance_of TrueClass, t.onfire
+        assert_equal true, t.onfire
+    end
+end
+

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: typed_accessors
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
-- Pat Ladd
+- Sean Dague
 autorequire: typed_accessors
 bindir: bin
 cert_chain: []
 
-date: 2009-03-26 00:00:00 -04:00
+date: 2009-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: Defines easy to use additional functions to creating typed accessors, which auto convert the attributes to non string types
-email: 
+email: sean@dague.net
 executables: []
 
 extensions: []
@@ -23,7 +23,22 @@ extra_rdoc_files:
 - README
 - COPYING
 files: 
+- test/basic_test.rb
 - lib/typed_accessors.rb
+- docs/typed_accessors
+- docs/typed_accessors/created.rid
+- docs/typed_accessors/rdoc-style.css
+- docs/typed_accessors/classes
+- docs/typed_accessors/classes/Class.html
+- docs/typed_accessors/fr_method_index.html
+- docs/typed_accessors/fr_class_index.html
+- docs/typed_accessors/fr_file_index.html
+- docs/typed_accessors/index.html
+- docs/typed_accessors/files
+- docs/typed_accessors/files/COPYING.html
+- docs/typed_accessors/files/README.html
+- docs/typed_accessors/files/lib
+- docs/typed_accessors/files/lib/typed_accessors_rb.html
 - Rakefile
 - README
 - COPYING
@@ -33,6 +48,7 @@ post_install_message:
 rdoc_options: 
 - --main
 - README
+- --accessor int_accessor="RW int" --accessor int_reader="R int" --accessor int_writer="W int" --accessor float_accessor="RW float" --accessor float_reader="R float" --accessor float_writer="W float" --accessor bool_yn_accessor="RW bool" --accessor bool_yn_reader="R bool" --accessor bool_yn_writer="W bool"
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -49,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: http://rubyforge.org/projects/sdaguegems
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2