delano-storable 0.5.1 → 0.5.2

data/CHANGES.txt

@@ -1,6 +1,18 @@
 STORABLE, CHANGES
 
 
+#### 0.5.2 (2009-05-12) #############################
+
+* CHANGE: Put OrderedHash into Storable namespace and imported merge fix from Caesars
+* FIXED: Circular dependency with Sysinfo
+
+
+#### 0.5.1 (2009-05-07) #############################
+
+* FIXED: Bug in from_hash which was incorrectly parsing some data types (incl. Integer)
+* ADDED: bin/example
+* ADDED: OrderedHash for Ruby 1.8.x (still unordered in JRuby. Need to investigate.)
+
 #### 0.5 (2009-05-07) ###############################
 
 * First public release. See commit history for solutious-stella, solutious-rudy, 

data/README.rdoc

@@ -2,6 +2,30 @@
 
 Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)
 
+== Example
+    
+    require 'storable'
+    
+    class Machine < Storable
+      field :environment            # Define field names for Machine. The
+      field :role                   # default type is String, but you can
+      field :position => Integer    # specify a type using a hash syntax.
+    end
+    
+    mac1 = Machine.new              # Instances of Machine have accessors
+    mac1.environment = "stage"      # just like regular attributes. 
+    mac1.role = "app"
+    mac1.position = 1
+    
+    puts "# YAML", mac1.to_yaml     # Note: the field order is maintained     
+    puts "# CSV", mac1.to_csv       # => stage,app,1
+    puts "# JSON", mac1.to_json     # Note: field order not maintained.
+    
+    mac2 = Machine.from_yaml(mac1.to_yaml)
+    puts mac2.environment           # => "stage"
+    puts mac2.position.class        # => Fixnum
+
+
 == Installation
 
 Via Rubygems, one of:
@@ -14,9 +38,15 @@ or via download:
 * storable-latest.zip[http://github.com/delano/storable/zipball/latest]
  
 
+== Prerequisites
+
+* Ruby 1.8, Ruby 1.9, or JRuby 1.2
+
+
 == Credits
 
 * Delano Mandelbaum (delano@solutious.com)
+* OrderedHash implementation by Jan Molic
 
 == License
 

data/lib/storable/orderedhash.rb

@@ -0,0 +1,199 @@
+# AUTHOR
+#    jan molic /mig/at/1984/dot/cz/
+#
+# DESCRIPTION
+#    Hash with preserved order and some array-like extensions
+#    Public domain. 
+#
+# THANKS
+#    Andrew Johnson for his suggestions and fixes of Hash[],
+#    merge, to_a, inspect and shift
+class Storable::OrderedHash < ::Hash
+    attr_accessor :order
+
+    class << self
+        def [] *args
+          hsh = Storable::OrderedHash.new
+          if Hash === args[0]
+            hsh.replace args[0]
+          elsif (args.size % 2) != 0
+            raise ArgumentError, "odd number of elements for Hash"
+          else
+            0.step(args.size - 1, 2) do |a|
+              b = a + 1
+              hsh[args[a]] = args[b]
+            end
+          end
+          hsh
+        end
+    end
+    def initialize(*a, &b)
+      super
+      @order = []
+    end
+    def store_only a,b
+        store a,b
+    end
+    alias orig_store store    
+    def store a,b
+        @order.push a unless has_key? a
+        super a,b
+    end
+    alias []= store
+    def == hsh2
+        return false if @order != hsh2.order
+        super hsh2
+    end
+    def clear
+        @order = []
+        super
+    end
+    def delete key
+        @order.delete key
+        super
+    end
+    def each_key
+        @order.each { |k| yield k }
+        self
+    end
+    def each_value
+        @order.each { |k| yield self[k] }
+        self
+    end
+    def each
+        @order.each { |k| yield k,self[k] }
+        self
+    end
+    alias each_pair each    
+    def delete_if
+        @order.clone.each { |k| 
+            delete k if yield(k)
+        }
+        self
+    end
+    def values
+        ary = []
+        @order.each { |k| ary.push self[k] }
+        ary
+    end
+    def keys
+        @order
+    end
+    def first
+      {@order.first => self[@order.first]}
+    end
+    def last
+      {@order.last => self[@order.last]}
+    end
+    def invert
+        hsh2 = Hash.new    
+        @order.each { |k| hsh2[self[k]] = k }
+        hsh2
+    end
+    def reject &block
+        self.dup.delete_if &block
+    end
+    def reject! &block
+        hsh2 = reject &block
+        self == hsh2 ? nil : hsh2
+    end
+    def replace hsh2
+        @order = hsh2.keys 
+        super hsh2
+    end
+    def shift
+        key = @order.first
+        key ? [key,delete(key)] : super
+    end
+    def unshift k,v
+        unless self.include? k
+            @order.unshift k
+            orig_store(k,v)
+            true
+        else
+            false
+        end
+    end
+    def push k,v
+        unless self.include? k
+            @order.push k
+            orig_store(k,v)
+            true
+        else
+            false
+        end
+    end
+    def pop
+        key = @order.last
+        key ? [key,delete(key)] : nil
+    end
+    def to_a
+        ary = []
+        each { |k,v| ary << [k,v] }
+        ary
+    end
+    def to_s
+        self.to_a.to_s
+    end
+    def inspect
+        ary = []
+        each {|k,v| ary << k.inspect + "=>" + v.inspect}
+        '{' + ary.join(", ") + '}'
+    end
+    def update hsh2
+        hsh2.each { |k,v| self[k] = v }
+        self
+    end
+    alias :merge! update
+    def merge hsh2
+        ##self.dup update(hsh2)   ## 2009-05-12 -- delano
+        update hsh2               ## dup doesn't take an argument
+                                  ## and there's no need for it here
+    end
+    def select
+        ary = []
+        each { |k,v| ary << [k,v] if yield k,v }
+        ary
+    end
+    def class
+      Hash
+    end
+    def __class__
+      Storable::OrderedHash
+    end
+
+    attr_accessor "to_yaml_style"
+    def yaml_inline= bool
+      if respond_to?("to_yaml_style")
+        self.to_yaml_style = :inline
+      else
+        unless defined? @__yaml_inline_meth
+          @__yaml_inline_meth =
+            lambda {|opts|
+              YAML::quick_emit(object_id, opts) {|emitter|
+                emitter << '{ ' << map{|kv| kv.join ': '}.join(', ') << ' }'
+              }
+            }
+          class << self
+            def to_yaml opts = {}
+              begin
+                @__yaml_inline ? @__yaml_inline_meth[ opts ] : super
+              rescue
+                @to_yaml_style = :inline
+                super
+              end
+            end
+          end
+        end
+      end
+      @__yaml_inline = bool
+    end
+    def yaml_inline!() self.yaml_inline = true end
+
+    def each_with_index
+      @order.each_with_index { |k, index| yield k, self[k], index }
+      self
+    end
+end # class Storable::OrderedHash
+
+

data/lib/storable.rb

@@ -1,20 +1,24 @@
 #--
 # TODO: Handle nested hashes and arrays. 
 # TODO: to_xml, see: http://codeforpeople.com/lib/ruby/xx/xx-2.0.0/README
-# TODO: Rename to Stuffany
 #++
 
-require 'yaml'
-require 'fileutils'
 
+USE_ORDERED_HASH = (RUBY_VERSION =~ /1.9/).nil?
+
+require 'json' rescue nil
 
+require 'yaml'
+require 'fileutils'
+  
 # 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
+  require 'storable/orderedhash' if USE_ORDERED_HASH
   unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
-    VERSION = 5
+    VERSION = 0.5
     NICE_TIME_FORMAT  = "%Y-%m-%d@%H:%M:%S".freeze 
     SUPPORTED_FORMATS = [:tsv, :csv, :yaml, :json, :s, :string].freeze 
   end
@@ -46,7 +50,7 @@ class Storable
   # The value is not touched when the type is not provided. 
   def self.field(args={})
     # TODO: Examine casting from: http://codeforpeople.com/lib/ruby/fattr/fattr-1.0.3/
-    args = {args => nil} unless args.is_a? Hash
+    args = {args => nil} unless args.kind_of?(Hash)
 
     args.each_pair do |m,t|
       
@@ -127,14 +131,15 @@ class Storable
       
       if field_types[index] == Array
         ((value ||= []) << stored_value).flatten 
-      elsif field_types[index] == Hash
+      elsif field_types[index].kind_of?(Hash)
         
         value = stored_value
       else
         
         # SimpleDB stores attribute shit as lists of values
-        value = stored_value.first if stored_value.is_a?(Array) && stored_value.size == 1
-
+        ##value = stored_value.first if stored_value.is_a?(Array) && stored_value.size == 1
+        value = (stored_value.is_a?(Array) && stored_value.size == 1) ? stored_value.first : stored_value
+        
         if field_types[index] == Time
           value = Time.parse(value)
         elsif field_types[index] == DateTime
@@ -145,10 +150,11 @@ class Storable
           value = value.to_f
         elsif field_types[index] == Integer
           value = value.to_i
-        elsif field_types[index].kind_of?(Storable) && stored_value.is_a?(Hash)
-          value = field_types[index].from_hash(stored_value)
-        else
-          value = (stored_value.is_a?(Array) && stored_value.size == 1) ? stored_value.first : stored_value
+        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!"
         end
       end
       
@@ -162,7 +168,7 @@ class Storable
   # Return the object data as a hash
   # +with_titles+ is ignored. 
   def to_hash(with_titles=true)
-    tmp = {}
+    tmp = USE_ORDERED_HASH ? Storable::OrderedHash.new : {}
     field_names.each do |fname|
       tmp[fname] = self.send(fname)
     end
@@ -170,12 +176,11 @@ class Storable
   end
   
   # Create a new instance of the object from YAML. 
-  # +from+ a YAML string split into an array by line. 
-  def self.from_yaml(from=[])
-    # from is an array of strings
-    from_str = from.join('')
+  # +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.is_a? Hash 
+    hash = from_hash(hash) if hash.kind_of?(Hash)
     hash
   end
   def to_yaml(with_titles=true)
@@ -183,21 +188,18 @@ class Storable
   end
   
   # Create a new instance of the object from a JSON string. 
-  # +from+ a JSON string split into an array by line.
-  def self.from_json(from=[])
-    require 'json'
-    # from is an array of strings
-    from_str = from.join('')
+  # +from+ a YAML String or Array (split into by line). 
+  def self.from_json(*from)
+    from_str = [from].flatten.compact.join('')
     tmp = JSON::load(from_str)
     hash_sym = tmp.keys.inject({}) do |hash, key|
        hash[key.to_sym] = tmp[key]
        hash
     end
-    hash_sym = from_hash(hash_sym) if hash_sym.is_a? Hash  
+    hash_sym = from_hash(hash_sym) if hash_sym.kind_of?(Hash)  
     hash_sym
   end
   def to_json(with_titles=true)
-    require 'json'
     to_hash.to_json
   end
   
@@ -255,7 +257,7 @@ class Storable
       next unless values[index]
       hash[key.to_sym] = values[index]
     end
-    hash = from_hash(hash) if hash.is_a? Hash 
+    hash = from_hash(hash) if hash.kind_of?(Hash) 
     hash
   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.1"
+	s.version = "0.5.2"
 	s.summary = "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"
 	s.description = s.summary
   s.author = "Delano Mandelbaum"
@@ -16,8 +16,7 @@
   
   # = DEPENDENCIES =
   # Add all gem dependencies
-  s.add_dependency 'sysinfo', '>= 0.5.0'
-    
+  
   # = MANIFEST =
   # The complete list of files to be included in the release. When GitHub packages your gem, 
   # it doesn't allow you to run any command that accesses the filesystem. You will get an
@@ -30,6 +29,7 @@
   README.rdoc
   Rakefile
   lib/storable.rb
+  lib/storable/orderedhash.rb
   storable.gemspec
   )
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: delano-storable
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -12,16 +12,6 @@ cert_chain: []
 date: 2009-04-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: sysinfo
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.5.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: RedCloth
   type: :runtime
@@ -47,6 +37,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/storable.rb
+- lib/storable/orderedhash.rb
 - storable.gemspec
 has_rdoc: true
 homepage: http://solutious.com/