storable 0.8.7 → 0.8.8

data/CHANGES.txt

@@ -2,7 +2,15 @@ STORABLE, CHANGES
 
 * TODO: https://github.com/delano/storable/pull/2
 * TODO: Handle nested hashes and arrays.                                 
-* TODO: to_xml, see: http://codeforpeople.com/lib/ruby/xx/xx-2.0.0/README
+
+
+#### 0.8.8 (2011-05-20) #############################
+
+* ADDED: Storable.field can now take and store Hash options (:default, :meth)
+
+#### 0.8.7 (2011-??-??) #############################
+
+* ?
 
 #### 0.8.6 (2010-12-31) #############################
 

data/lib/proc_source.rb

@@ -41,7 +41,7 @@ end
 class RubyToken::Token
   
     # These EXPR_BEG tokens don't have associated end tags
-  FAKIES = [RubyToken::TkWHEN, RubyToken::TkELSIF, RubyToken::TkTHEN]
+  FAKIES = [RubyToken::TkWHEN, RubyToken::TkELSIF, RubyToken::TkELSE, RubyToken::TkTHEN]
   
   def name
     @name ||= nil

data/lib/storable.rb

@@ -35,14 +35,14 @@ class Storable
   require 'proc_source'  
   require 'storable/orderedhash' if USE_ORDERED_HASH
   unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
-    VERSION = "0.8.7"
+    VERSION = "0.8.8"
     NICE_TIME_FORMAT  = "%Y-%m-%d@%H:%M:%S".freeze 
     SUPPORTED_FORMATS = [:tsv, :csv, :yaml, :json, :s, :string].freeze 
   end
   
   @debug = false
   class << self
-    attr_accessor :sensitive_fields, :field_names, :field_types, :debug
+    attr_accessor :sensitive_fields, :field_names, :field_types, :field_opts, :debug
   end
   
   # Passes along fields to inherited classes
@@ -66,37 +66,61 @@ class Storable
   # data is available by the standard accessors, class.product and class.product= etc...
   # The value of the field will be cast to the type (if provided) when read from a file. 
   # The value is not touched when the type is not provided. 
-  def self.field(args={}, &processor)
+  def self.field(*args, &processor)
     # TODO: Examine casting from: http://codeforpeople.com/lib/ruby/fattr/fattr-1.0.3/
-    args = {args => nil} unless args.kind_of?(Hash)
-
+    field_definitions = {}
+    if args.first.kind_of?(Hash)
+      args.first.each_pair do |fname,klass|
+        field_definitions[fname] = { :class => klass }
+      end
+    else
+      fname, opts = *args
+      if opts.nil?
+        field_definitions[fname] = {}
+      elsif Hash === opts
+        field_definitions[fname] = opts
+      else
+        raise ArgumentError, "Second argument must be a hash" 
+      end
+    end
+    
     self.field_names ||= []
     self.field_types ||= {}
-    args.each_pair do |m,t|
-      self.field_names << m
-      self.field_types[m] = t unless t.nil?
+    self.field_opts ||= {}
+    field_definitions.each_pair do |fname,opts|
+      self.field_names << fname
+      self.field_opts[fname] = opts
+      self.field_types[fname] = opts[:class] unless opts[:class].nil?
       
       # This processor automatically converts a Proc object
       # to a String of its source. 
-      processor = proc_processor if t == Proc && processor.nil?
+      processor = proc_processor if opts[:class] == Proc && processor.nil?
       
       unless processor.nil?
-        define_method("_storable_processor_#{m}", &processor)
+        define_method("_storable_processor_#{fname}", &processor)
       end
       
-      if method_defined?(m) # don't redefine the getter method
-        STDERR.puts "method exists: #{self}##{m}" if Storable.debug
+      if method_defined?(fname) # don't redefine the getter method
+        STDERR.puts "method exists: #{self}##{fname}" if Storable.debug
       else
-        define_method(m) do 
-          instance_variable_get("@#{m}") 
+        define_method(fname) do 
+          ret = instance_variable_get("@#{fname}") || opts[:default]
+          if ret.nil? 
+            if opts[:default]
+              ret = opts[:default]
+            elsif opts[:meth]
+              ret = self.send(opts[:meth])
+            end
+          end
+          ret
         end
       end
       
-      if method_defined?("#{m}=") # don't redefine the setter methods
-        STDERR.puts "method exists: #{self}##{m}=" if Storable.debug
+      if method_defined?("#{fname}=") # don't redefine the setter methods
+        STDERR.puts "method exists: #{self}##{fname}=" if Storable.debug
       else
-        define_method("#{m}=") do |val| 
-          instance_variable_set("@#{m}",val)
+        define_method("#{fname}=") do |val| 
+          instance_variable_set("@#{fname}",val)
         end
       end
     end
@@ -145,15 +169,15 @@ class Storable
   
   # Returns an array of field names defined by self.field
   def field_names
-    self.class.field_names
+    self.class.field_names #|| self.class.ancestors.first.field_names
   end
   # Returns an array of field types defined by self.field. Fields that did 
   # not receive a type are set to nil.
   def field_types
-    self.class.field_types
+    self.class.field_types #|| self.class.ancestors.first.field_types
   end
   def sensitive_fields
-    self.class.sensitive_fields
+    self.class.sensitive_fields #|| self.class.ancestors.first.sensitive_fields
   end
   
   # Dump the object data to the given format. 
@@ -298,14 +322,16 @@ class Storable
   def to_hash
     preprocess if respond_to? :preprocess
     tmp = USE_ORDERED_HASH ? Storable::OrderedHash.new : {}
-    field_names.each do |fname|
-      next if sensitive? && self.class.sensitive_field?(fname)
-      v = self.send(fname)
-      v = process(fname, v) if has_processor?(fname)
-      if Array === v
-        v = v.collect { |v2| v2.kind_of?(Storable) ? v2.to_hash : v2 } 
+    if field_names
+      field_names.each do |fname|
+        next if sensitive? && self.class.sensitive_field?(fname)
+        v = self.send(fname)
+        v = process(fname, v) if has_processor?(fname)
+        if Array === v
+          v = v.collect { |v2| v2.kind_of?(Storable) ? v2.to_hash : v2 } 
+        end
+        tmp[fname] = v.kind_of?(Storable) ? v.to_hash : v
       end
-      tmp[fname] = v.kind_of?(Storable) ? v.to_hash : v
     end
     tmp
   end
@@ -329,9 +355,6 @@ class Storable
     hash = to_hash
     if YAJL_LOADED # set by Storable
       ret = Yajl::Encoder.encode(hash)
-      #raise "DELANO"
-      #ret.force_encoding("ISO-8859-1")
-      #p [:to, ret.encoding.name] if ret.respond_to?(:encoding)
       ret
     elsif JSON_LOADED
       JSON.generate(hash, *from, &blk)
@@ -508,7 +531,8 @@ class Storable
     end
     def proc_processor
       Proc.new do |val|
-        (Proc === val) ? val.source : val 
+        ret = (Proc === val) ? val.source : val 
+        ret
       end
     end
     # If the object already has a value for +@id+

data/storable.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "storable"
   s.rubyforge_project = "storable"
-  s.version = "0.8.7"
+  s.version = "0.8.8"
   s.summary = "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"
   s.description = s.summary
   s.author = "Delano Mandelbaum"

metadata

@@ -2,7 +2,7 @@
 name: storable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.7
+  version: 0.8.8
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-03 00:00:00 -05:00
+date: 2011-05-20 00:00:00 -04:00
 default_executable: 
 dependencies: []