storable 0.6.5 → 0.7.0

data/CHANGES.txt

@@ -1,13 +1,27 @@
 STORABLE, CHANGES
 
-* TODO: field_types and field_names go out of order when defining some fields with types and others not. The quick fix is to define fields with no type at the end
+* TODO: Handle nested hashes and arrays.                                 
+* TODO: to_xml, see: http://codeforpeople.com/lib/ruby/xx/xx-2.0.0/README
+
+#### 0.7.0 (2010-04-03) #############################
+
+* FIXED: Default initialize method missed the last argument
+* FIXED: Possible error in from_hash when a value is nil
+* CHANGE: Remove unused "require 'fileutils'"
+* CHANGE: field_types is now a Hash
+* CHANGE: Set the instance variable if a setter method doesn't exist. 
+* CHANGE: Will grab the first element of an Array if there is only one
+  and a field type is defined that is not an Array. 
+* ADDED: Storable.debug
+* ADDED: Boolean class (candy for TrueClass fields)
+* ADDED: Automatically convert a Proc to a string of its source in to_hash
+* ADDED: Support for Symbol field type
 
 
 #### 0.6.5 (2010-03-23) #############################
 
 * ADDED: Use Yajl if it's available.
 
-
 #### 0.6.4 (2010-03-10) #############################
 
 * FIXED: Don't pull the first value out of an array if there is only one element.

data/lib/storable.rb

@@ -4,8 +4,6 @@
 #++
 
 
-USE_ORDERED_HASH = (RUBY_VERSION =~ /^1.9/).nil?
-
 YAJL_LOADED = begin   
   require 'yajl'
   true
@@ -24,19 +22,12 @@ require 'yaml'
 require 'fileutils'
 require 'time'
 
-
-class Storable
-  module DefaultProcessors
-    def hash_proc_processor 
-      Proc.new do |procs|
-        a = {}
-        procs.each_pair { |n,v| 
-          a[n] = (Proc === v) ? v.source : v 
-        }
-        a
-      end
-    end
-  end
+unless defined?(Boolean)
+  # Used in field definitions. 
+  #
+  #     field :name => Boolean
+  #
+  class Boolean; end
 end
 
 # Storable makes data available in multiple formats and can
@@ -44,17 +35,18 @@ end
 # Storable.field method which tells Storable the order and 
 # name.
 class Storable
-  extend Storable::DefaultProcessors
-  
+  USE_ORDERED_HASH = (RUBY_VERSION =~ /^1.9/).nil?
+  require 'proc_source'  
   require 'storable/orderedhash' if USE_ORDERED_HASH
   unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
-    VERSION = "0.6.5"
+    VERSION = "0.7.0"
     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 :field_names, :field_types
+    attr_accessor :field_names, :field_types, :debug
   end
   
   # This value will be used as a default unless provided on-the-fly.
@@ -88,18 +80,25 @@ class Storable
   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)
-
+    
     args.each_pair do |m,t|
       self.field_names ||= []
-      self.field_types ||= []
+      self.field_types ||= {}
       self.field_names << m
-      self.field_types << t unless t.nil?
+      self.field_types[m] = t unless t.nil?
+      
+      # This processor automatically converts a Proc object
+      # to a String of its source. 
+      processor = proc_processor if t == Proc && processor.nil?
       
       unless processor.nil?
         define_method("_storable_processor_#{m}", &processor)
       end
       
-      next if method_defined?(m) # don't refine the accessor methods
+      if method_defined?(m) # don't redefine the accessor methods
+        STDERR.puts "method exists: #{self}##{m}" if Storable.debug
+        next
+      end
       
       define_method(m) do instance_variable_get("@#{m}") end
       define_method("#{m}=") do |val| 
@@ -119,7 +118,7 @@ class Storable
   # It's assumed that the order values matches the order
   def initialize(*args)
     (self.class.field_names || []).each_with_index do |n,index|
-      break if (index+1) >= args.size
+      break if (index+1) > args.size
       self.send("#{n}=", args[index])
     end
   end
@@ -137,7 +136,7 @@ class Storable
   # Dump the object data to the given format. 
   def dump(format=nil, with_titles=false)
     format &&= format.to_sym
-    format ||= 's' # as in, to_s
+    format ||= :s # as in, to_s
     raise "Format not defined (#{format})" unless SUPPORTED_FORMATS.member?(format)
     send("to_#{format}") 
   end
@@ -173,39 +172,44 @@ class Storable
   
   def from_hash(from={})
     fnames = field_names
-    fnames.each_with_index do |key,index|
-      stored_value = from[key] || from[key.to_s] # support for symbol keys and string keys
+    fnames.each_with_index do |fname,index|
+      ftype = field_types[fname]
+      value_orig = from[fname] || from[fname.to_s]
       
-      # TODO: Correct this horrible implementation 
-      # (sorry, me. It's just one of those days.) -- circa 2008-09-15
+      next if value_orig.nil?
       
-      if field_types[index] == Array
-        value = Array === stored_value ? stored_value : [stored_value]
-      elsif field_types[index].kind_of?(Hash)
-        value = stored_value
-      else
-        
-        value = stored_value
+      if ftype == String && value_orig.to_s.empty?
+        value = ''
+      elsif ftype == Array
+        value = Array === value_orig ? value_orig : [value_orig]
+      elsif ftype == Hash
+        value = value_orig
+      elsif !ftype.nil?
+        value_orig = value_orig.first if Array === value_orig && value_orig.size == 1
         
-        if field_types[index] == Time
-          value = Time.parse(value)
-        elsif field_types[index] == DateTime
-          value = DateTime.parse(value)
-        elsif field_types[index] == TrueClass
-          value = (value.to_s == "true")
-        elsif field_types[index] == Float
-          value = value.to_f
-        elsif field_types[index] == Integer
-          value = value.to_i
-        elsif field_types[index].kind_of?(Storable) && stored_value.kind_of?(Hash)
-          # I don't know why this is here so I'm going to raise an exception
-          # and wait a while for an error in one of my other projects. 
-          #value = field_types[index].from_hash(stored_value)
-          raise "Delano, delano, delano. Clean up Storable!"
+        if    [Time, DateTime].member?(ftype)
+          value = ftype.parse(value_orig)
+        elsif [TrueClass, FalseClass, Boolean].member?(ftype)
+          value = (value_orig.to_s.upcase == "TRUE")
+        elsif ftype == Float
+          value = value_orig.to_f
+        elsif ftype == Integer
+          value = value_orig.to_i
+        elsif ftype == Symbol
+          value = value_orig.to_s.to_sym
+        elsif ftype == Proc && String === value_orig
+          value = Proc.from_string value_orig           
         end
       end
+
+      value ||= value_orig
+      
+      if self.respond_to?("#{fname}=")
+        self.send("#{fname}=", value) 
+      else
+        self.instance_variable_set("@#{fname}", value) 
+      end
       
-      self.send("#{key}=", value) if self.respond_to?("#{key}=")  
     end
 
     self.postprocess
@@ -229,7 +233,11 @@ class Storable
   def to_json(*from, &blk)
     hash = to_hash
     if YAJL_LOADED
-      Yajl::Encoder.encode(hash)
+      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
       hash.to_json(*from, &blk)
     else 
@@ -262,8 +270,10 @@ class Storable
   # +from+ a YAML String or Array (split into by line). 
   def self.from_json(*from)
     from_str = [from].flatten.compact.join('')
+    #from_str.force_encoding("ISO-8859-1")
+    #p [:from, from_str.encoding.name] if from_str.respond_to?(:encoding)
     if YAJL_LOADED
-      tmp = Yajl::Parser.parse(from_str)
+      tmp = Yajl::Parser.parse(from_str, :check_utf8 => false)
     elsif JSON_LOADED
       tmp = JSON::load(from_str)
     else
@@ -367,3 +377,44 @@ class Storable
 end
 
 
+class Storable
+  # These methods can be used by Storable objects as
+  # custom field processors.
+  #
+  # e.g.
+  #
+  #     class A < Storable
+  #       field :name => String, &hash_proc_processor
+  #     end
+  #
+  module DefaultProcessors
+    # Replace a hash of Proc objects with a hash
+    # of 
+    def hash_proc_processor 
+      Proc.new do |procs|
+        a = {}
+        procs.each_pair { |n,v| 
+          a[n] = (Proc === v) ? v.source : v 
+        }
+        a
+      end
+    end
+    def proc_processor
+      Proc.new do |val|
+        (Proc === val) ? val.source : val 
+      end
+    end
+    # If the object already has a value for +@id+
+    # use it, otherwise return the current digest.
+    #
+    # This allows an object to have a preset ID. 
+    #
+    def gibbler_id_processor
+      Proc.new do |val|
+        @id || self.gibbler
+      end
+    end
+  end
+  extend Storable::DefaultProcessors
+end
+

data/storable.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "storable"
   s.rubyforge_project = "storable"
-  s.version = "0.6.5"
+  s.version = "0.7.0"
   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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: storable
 version: !ruby/object:Gem::Version 
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 -04:00
+date: 2010-04-03 00:00:00 -04:00
 default_executable: 
 dependencies: []