storable 0.5.8 → 0.6.0

data/CHANGES.txt

@@ -1,5 +1,11 @@
 STORABLE, CHANGES
 
+#### 0.6.0 (2009-11-27) #############################
+
+* FIXED: Undefined @@field_names error when no fields specified
+* ADDED: Support for field output processors
+* ADDED: Storable::DefaultProcessors
+
 
 #### 0.5.8 (2009-10-06) #############################
 

data/lib/storable.rb

@@ -4,7 +4,7 @@
 #++
 
 
-USE_ORDERED_HASH = (RUBY_VERSION =~ /1.9/).nil?
+USE_ORDERED_HASH = (RUBY_VERSION =~ /^1.9/).nil?
 
 begin
   require 'json'
@@ -15,19 +15,40 @@ end
 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
+end
+
 # Storable makes data available in multiple formats and can
 # re-create objects from files. Fields are defined using the 
 # Storable.field method which tells Storable the order and 
 # name.
 class Storable
+  extend Storable::DefaultProcessors
+  
   require 'storable/orderedhash' if USE_ORDERED_HASH
   unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
-    VERSION = "0.5.8"
+    VERSION = "0.6.0"
     NICE_TIME_FORMAT  = "%Y-%m-%d@%H:%M:%S".freeze 
     SUPPORTED_FORMATS = [:tsv, :csv, :yaml, :json, :s, :string].freeze 
   end
   
+  class << self
+    attr_accessor :field_names, :field_types
+  end
+  
   # This value will be used as a default unless provided on-the-fly.
   # See SUPPORTED_FORMATS for available values.
   attr_reader :format
@@ -48,23 +69,29 @@ class Storable
   #
   #     field :product
   #     field :product => Integer
+  #     field :product do |val|
+  #       # modify val before it's stored. 
+  #     end
   #
   # The order they're defined determines the order the will be output. The fields
   # 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={})
+  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_names << m
+      self.field_types << t unless t.nil?
       
-      [[:@@field_names, m], [:@@field_types, t]].each do |tuple|
-        class_variable_set(tuple[0], []) unless class_variable_defined?(tuple[0])
-        class_variable_set(tuple[0], class_variable_get(tuple[0]) << tuple[1])
+      unless processor.nil?
+        define_method("_storable_processor_#{m}", &processor)
       end
       
-      next if method_defined?(m)
+      next if method_defined?(m) # don't refine the accessor methods
       
       define_method(m) do instance_variable_get("@#{m}") end
       define_method("#{m}=") do |val| 
@@ -80,23 +107,15 @@ class Storable
     self.class.field_names.member? n.to_sym
   end
   
-  # Returns an array of field names defined by self.field
-  def self.field_names
-    class_variable_get(:@@field_names)
-  end
+
   # Returns an array of field names defined by self.field
   def field_names
-    self.class.send(:class_variable_get, :@@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 self.field_types
-    class_variable_get(:@@field_types)
+    self.class.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.send(:class_variable_get, :@@field_types)
+    self.class.field_types
   end
 
   # Dump the object data to the given format. 
@@ -185,22 +204,40 @@ class Storable
   def to_hash
     tmp = USE_ORDERED_HASH ? Storable::OrderedHash.new : {}
     field_names.each do |fname|
-      tmp[fname] = self.send(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
   end
   
+  def to_json(*from, &blk)
+    to_hash.to_json(*from, &blk)
+  end
+  
+  def to_yaml(*from, &blk)
+    to_hash.to_yaml(*from, &blk)
+  end
+
+  def process(fname, val)
+    self.send :"_storable_processor_#{fname}", val
+  end
+  
+  def has_processor?(fname)
+    self.respond_to? :"_storable_processor_#{fname}"
+  end
+  
   # Create a new instance of the object from YAML. 
   # +from+ a YAML String or Array (split into by line). 
   def self.from_yaml(*from)
     from_str = [from].flatten.compact.join('')
     hash = YAML::load(from_str)
-    hash = from_hash(hash) if hash.kind_of?(Hash)
+    hash = from_hash(hash) if Hash === hash
     hash
   end
-  def to_yaml
-    to_hash.to_yaml
-  end
   
   # Create a new instance of the object from a JSON string. 
   # +from+ a YAML String or Array (split into by line). 
@@ -214,9 +251,6 @@ class Storable
     hash_sym = from_hash(hash_sym) if hash_sym.kind_of?(Hash)  
     hash_sym
   end
-  def to_json(with_titles=true)
-    to_hash.to_json
-  end
   
   # Return the object data as a delimited string. 
   # +with_titles+ specifiy whether to include field names (default: false)
@@ -307,3 +341,4 @@ class Storable
   end
 end
 
+

data/storable.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "storable"
   s.rubyforge_project = "storable"
-	s.version = "0.5.8"
+	s.version = "0.6.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.5.8
+  version: 0.6.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-08 00:00:00 -04:00
+date: 2009-11-27 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: storable
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"