storable 0.7.4 → 0.8.0

data/CHANGES.txt

@@ -3,6 +3,16 @@ STORABLE, CHANGES
 * TODO: Handle nested hashes and arrays.                                 
 * TODO: to_xml, see: http://codeforpeople.com/lib/ruby/xx/xx-2.0.0/README
 
+#### 0.8.0 (2010-07-28) #############################
+
+* FIXED: from_delimited now gracefully handles String input by splitting it by $/
+* CHANGE: Removed field name magic from from_delimited 
+* CHANGE: Converted to Tryouts 2 
+* ADDED: Support for sensitive fields
+* ADDED: Supports inheritance
+* ADDED: Storable#to_array
+
+
 #### 0.7.4 (2010-05-01) #############################
 
 * FIXED: Check separately if getter and setter methods are already defined

data/README.rdoc

@@ -26,6 +26,23 @@ Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)
     puts mac2.position.class        # => Fixnum
 
 
+== Sensitive Fields
+
+    require 'storable'
+    
+    class Calc < Storable
+      field :three
+      field :two
+      field :one
+      sensitive_fields :three
+    end
+    
+    calc = Calc.new 3, 2, 1
+    calc.to_a                       # => [3, 2, 1]
+    calc.sensitive!
+    calc.to_a                       # => [2, 1]
+    
+    
 == Storing Procs
 
 Storable can also marshal Proc objects to and from their actual source code. 
@@ -38,18 +55,18 @@ Storable can also marshal Proc objects to and from their actual source code.
       field :calculate => Proc
     end
     
-    mat1 = Maths.new 2.0, 3.0
-    mat1.calculate = Proc.new { @x * @y }
-    
-    mat1.calculate.source            # => "{ @x * @y }"
-    mat1.call :calculate             # => 6.0
+    m1 = Maths.new 2.0, 3.0
+    m1.calculate = Proc.new { @x * @y }
     
-    dump = mat1.to_json
+    m1.calculate.source            # => "{ @x * @y }"
+    m1.call :calculate             # => 6.0
     
-    mat2 = Maths.from_json dump
-    mat2.call :calculate             # => 6.0
+    dump = m1.to_json
     
+    m2 = Maths.from_json dump
+    m2.call :calculate             # => 6.0
     
+   
 Anything is possible when you keep your mind open and you use Ruby. 
 
 

data/lib/storable.rb

@@ -1,6 +1,7 @@
 #--
 # TODO: Handle nested hashes and arrays.
 # TODO: to_xml, see: http://codeforpeople.com/lib/ruby/xx/xx-2.0.0/README
+# TODO: from_args([HASH or ordered params])
 #++
 
 
@@ -39,32 +40,25 @@ class Storable
   require 'proc_source'  
   require 'storable/orderedhash' if USE_ORDERED_HASH
   unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
-    VERSION = "0.7.4"
+    VERSION = "0.8.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, :debug
+    attr_accessor :sensitive_fields, :field_names, :field_types, :debug
   end
   
-  # This value will be used as a default unless provided on-the-fly.
-  # See SUPPORTED_FORMATS for available values.
-  attr_reader :format
-  
-  # See SUPPORTED_FORMATS for available values
-  def format=(v)
-    v &&= v.to_sym
-    raise "Unsupported format: #{v}" unless SUPPORTED_FORMATS.member?(v)
-    @format = v
-  end
-  
-  def postprocess
-  end
-  
-  # TODO: from_args([HASH or ordered params])
-  
+  # Passes along fields to inherited classes
+  def self.inherited(obj)                           
+    unless Storable == self                         
+      obj.sensitive_fields = self.sensitive_fields.clone if !self.sensitive_fields.nil?
+      obj.field_names = self.field_names.clone if !self.field_names.nil?
+      obj.field_types = self.field_types.clone if !self.field_types.nil?
+    end                                             
+  end                                               
+    
   # Accepts field definitions in the one of the follow formats:
   #
   #     field :product
@@ -80,10 +74,10 @@ 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)
-    
+
+    self.field_names ||= []
+    self.field_types ||= {}
     args.each_pair do |m,t|
-      self.field_names ||= []
-      self.field_types ||= {}
       self.field_names << m
       self.field_types[m] = t unless t.nil?
       
@@ -113,6 +107,17 @@ class Storable
     end
   end
   
+  def self.sensitive_fields(*args)
+    @sensitive_fields ||= []
+    @sensitive_fields.push *args unless args.empty?
+    @sensitive_fields
+  end
+  
+  def self.sensitive_field?(name)
+    @sensitive_fields ||= []
+    @sensitive_fields.member?(name)
+  end
+  
   def self.has_field?(n)
     field_names.member? n.to_sym
   end
@@ -120,6 +125,11 @@ class Storable
     self.class.field_names.member? n.to_sym
   end
   
+  
+  # This value will be used as a default unless provided on-the-fly.
+  # See SUPPORTED_FORMATS for available values.
+  attr_reader :format
+  
   # +args+ is a list of values to set amongst the fields. 
   # It's assumed that the order values matches the order
   def initialize(*args)
@@ -129,7 +139,25 @@ class Storable
     end
     preprocess if respond_to?(:preprocess)
   end
-
+  
+  # See SUPPORTED_FORMATS for available values
+  def format=(v)
+    v &&= v.to_sym
+    raise "Unsupported format: #{v}" unless SUPPORTED_FORMATS.member?(v)
+    @format = v
+  end
+  
+  def postprocess
+  end
+  
+  def sensitive?
+    @storable_sensitive == true
+  end
+  
+  def sensitive!
+    @storable_sensitive = true
+  end
+  
   # Returns an array of field names defined by self.field
   def field_names
     self.class.field_names
@@ -139,7 +167,10 @@ class Storable
   def field_types
     self.class.field_types
   end
-
+  def sensitive_fields
+    self.class.sensitive_fields
+  end
+  
   # Dump the object data to the given format. 
   def dump(format=nil, with_titles=false)
     format &&= format.to_sym
@@ -149,6 +180,7 @@ class Storable
   end
   
   def to_string(*args)
+    # TODO: sensitive?
     to_s(*args)
   end
   
@@ -251,11 +283,13 @@ class Storable
     self.postprocess
     self
   end
+  
   # Return the object data as a hash
   # +with_titles+ is ignored. 
   def to_hash
     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
@@ -265,10 +299,23 @@ class Storable
     end
     tmp
   end
+
+  def to_array
+    fields = sensitive? ? (field_names-sensitive_fields) : field_names
+    fields.collect 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_a : v2 } 
+      end
+      v
+    end
+  end
   
   def to_json(*from, &blk)
     hash = to_hash
-    if YAJL_LOADED
+    if YAJL_LOADED # set by Storable
       ret = Yajl::Encoder.encode(hash)
       #raise "DELANO"
       #ret.force_encoding("ISO-8859-1")
@@ -361,17 +408,11 @@ class Storable
   # +delim+ is the field delimiter.
   def self.from_delimited(from=[],delim=',')
     return if from.empty?
-    # We grab an instance of the class so we can 
+    from = from.split($/) if String === from
     hash = {}
     
-    fnames = values = []
-    if (from.size > 1 && !from[1].empty?)
-      fnames = from[0].chomp.split(delim)
-      values = from[1].chomp.split(delim)
-    else
-      fnames = self.field_names
-      values = from[0].chomp.split(delim)
-    end
+    fnames = self.field_names
+    values = from[0].chomp.split(delim)
     
     fnames.each_with_index do |key,index|
       next unless values[index]

data/storable.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "storable"
   s.rubyforge_project = "storable"
-  s.version = "0.7.4"
+  s.version = "0.8.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,13 @@
 --- !ruby/object:Gem::Specification 
 name: storable
 version: !ruby/object:Gem::Version 
-  version: 0.7.4
+  hash: 63
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-01 00:00:00 -04:00
+date: 2010-07-28 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -45,21 +51,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: storable
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"