storable 0.5.1

data/CHANGES.txt

@@ -0,0 +1,14 @@
+STORABLE, CHANGES
+
+
+#### 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, 
+and delano-delanotes for complete history of SysInfo (was SystemInfo).
+

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Delano Mandelbaum, Solutious Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,52 @@
+= Storable - v0.5
+
+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:
+
+    $ sudo gem install storable
+    $ sudo gem install delano-storable --source http://gems.github.com/
+
+or via download:
+* storable-latest.tar.gz[http://github.com/delano/storable/tarball/latest]
+* 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)
+
+== License
+
+See: LICENSE.txt

data/Rakefile

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'hanna/rdoctask'
+require 'fileutils'
+include FileUtils
+ 
+task :default => :package
+ 
+# CONFIG =============================================================
+
+# Change the following according to your needs
+README = "README.rdoc"
+CHANGES = "CHANGES.txt"
+LICENSE = "LICENSE.txt"
+
+# Files and directories to be deleted when you run "rake clean"
+CLEAN.include [ 'pkg', '*.gem', '.config']
+
+# Virginia assumes your project and gemspec have the same name
+name = (Dir.glob('*.gemspec') || ['virginia']).first.split('.').first
+load "#{name}.gemspec"
+version = @spec.version
+
+# That's it! The following defaults should allow you to get started
+# on other things. 
+
+
+# TESTS/SPECS =========================================================
+
+
+
+# INSTALL =============================================================
+
+Rake::GemPackageTask.new(@spec) do |p|
+  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :release => [ :rdoc, :package ]
+task :install => [ :rdoc, :package ] do
+	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+task :uninstall => [ :clean ] do
+	sh %{sudo gem uninstall #{name}}
+end
+
+
+# RUBYFORGE RELEASE / PUBLISH TASKS ==================================
+
+if @spec.rubyforge_project
+  desc 'Publish website to rubyforge'
+  task 'publish:rdoc' => 'doc/index.html' do
+    sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
+  end
+
+  desc 'Public release to rubyforge'
+  task 'publish:gem' => [:package] do |t|
+    sh <<-end
+      rubyforge add_release -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+      rubyforge add_file -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
+    end
+  end
+end
+
+
+
+# RUBY DOCS TASK ==================================
+
+Rake::RDocTask.new do |t|
+	t.rdoc_dir = 'doc'
+	t.title    = @spec.summary
+	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+	t.options << '--charset' << 'utf-8'
+	t.rdoc_files.include(LICENSE)
+	t.rdoc_files.include(README)
+	t.rdoc_files.include(CHANGES)
+	#t.rdoc_files.include('bin/*')
+	t.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+#Hoe.new('rspec', Spec::VERSION::STRING) do |p|
+#  p.summary = Spec::VERSION::SUMMARY
+#  p.description = "Behaviour Driven Development for Ruby."
+#  p.rubyforge_name = 'rspec'
+#  p.developer('RSpec Development Team', 'rspec-devel@rubyforge.org')
+#  p.extra_dev_deps = [["cucumber",">= 0.1.13"]]
+#  p.remote_rdoc_dir = "rspec/#{Spec::VERSION::STRING}"
+#  p.rspec_options = ['--options', 'spec/spec.opts']
+#  p.history_file = 'History.rdoc'
+#  p.readme_file  = 'README.rdoc'
+#  p.post_install_message = <<-POST_INSTALL_MESSAGE
+##{'*'*50}
+#
+#  Thank you for installing rspec-#{Spec::VERSION::STRING}
+#
+#  Please be sure to read History.rdoc and Upgrade.rdoc
+#  for useful information about this release.
+#
+#{'*'*50}
+#POST_INSTALL_MESSAGE
+#end

data/lib/storable.rb

@@ -0,0 +1,294 @@
+#--
+# TODO: Handle nested hashes and arrays. 
+# TODO: to_xml, see: http://codeforpeople.com/lib/ruby/xx/xx-2.0.0/README
+#++
+
+
+USE_ORDERED_HASH = (RUBY_VERSION =~ /1.9/).nil?
+require 'orderedhash' if USE_ORDERED_HASH
+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
+  unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
+    VERSION = 0.5
+    NICE_TIME_FORMAT  = "%Y-%m-%d@%H:%M:%S".freeze 
+    SUPPORTED_FORMATS = [:tsv, :csv, :yaml, :json, :s, :string].freeze 
+  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])
+  
+  # Accepts field definitions in the one of the follow formats:
+  #
+  #     field :product
+  #     field :product => Integer
+  #
+  # 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={})
+    # 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|
+      
+      [[:@@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])
+      end
+      
+      next if method_defined?(m)
+      
+      define_method(m) do instance_variable_get("@#{m}") end
+      define_method("#{m}=") do |val| 
+        instance_variable_set("@#{m}",val)
+      end
+    end
+  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)
+  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)
+  end
+
+  # 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
+    raise "Format not defined (#{format})" unless SUPPORTED_FORMATS.member?(format)
+    send("to_#{format}", with_titles) 
+  end
+  
+  def to_string(*args)
+    to_s(*args)
+  end
+  
+  # Create a new instance of the object using data from file. 
+  def self.from_file(file_path, format='yaml')
+    raise "Cannot read file (#{file_path})" unless File.exists?(file_path)
+    raise "#{self} doesn't support from_#{format}" unless self.respond_to?("from_#{format}")
+    format = format || File.extname(file_path).tr('.', '')
+    me = send("from_#{format}", read_file_to_array(file_path))
+    me.format = format
+    me
+  end
+  # Write the object data to the given file. 
+  def to_file(file_path=nil, with_titles=true)
+    raise "Cannot store to nil path" if file_path.nil?
+    format = File.extname(file_path).tr('.', '')
+    format &&= format.to_sym
+    format ||= @format
+    Storable.write_file(file_path, dump(format, with_titles))
+  end
+
+  # Create a new instance of the object from a hash.
+  def self.from_hash(from={})
+    return nil if !from || from.empty?
+    me = self.new
+        
+    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
+      
+      # TODO: Correct this horrible implementation (sorry, me. It's just one of those days.)
+      
+      if field_types[index] == Array
+        ((value ||= []) << stored_value).flatten 
+      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.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
+          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!"
+        end
+      end
+      
+      me.send("#{key}=", value) if self.method_defined?("#{key}=")  
+    end
+    
+    me.postprocess
+    
+    me
+  end
+  # Return the object data as a hash
+  # +with_titles+ is ignored. 
+  def to_hash(with_titles=true)
+    tmp = USE_ORDERED_HASH ? OrderedHash.new : {}
+    field_names.each do |fname|
+      tmp[fname] = self.send(fname)
+    end
+    tmp
+  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
+  end
+  def to_yaml(with_titles=true)
+    to_hash.to_yaml
+  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=[])
+    # from is an array of strings
+    from_str = from.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.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)
+  # +delim+ is the field delimiter.
+  def to_delimited(with_titles=false, delim=',')
+    values = []
+    field_names.each do |fname|
+      values << self.send(fname.to_s)   # TODO: escape values
+    end
+    output = values.join(delim)
+    output = field_names.join(delim) << $/ << output if with_titles
+    output
+  end
+  # Return the object data as a tab delimited string. 
+  # +with_titles+ specifiy whether to include field names (default: false)
+  def to_tsv(with_titles=false)
+    to_delimited(with_titles, "\t")
+  end
+  # Return the object data as a comma delimited string. 
+  # +with_titles+ specifiy whether to include field names (default: false)
+  def to_csv(with_titles=false)
+    to_delimited(with_titles, ',')
+  end
+  # Create a new instance from tab-delimited data.  
+  # +from+ a JSON string split into an array by line.
+  def self.from_tsv(from=[])
+    self.from_delimited(from, "\t")
+  end
+  # Create a new instance of the object from comma-delimited data.
+  # +from+ a JSON string split into an array by line.
+  def self.from_csv(from=[])
+    self.from_delimited(from, ',')
+  end
+  
+  # Create a new instance of the object from a delimited string.
+  # +from+ a JSON string split into an array by line.
+  # +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 
+    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.each_with_index do |key,index|
+      next unless values[index]
+      hash[key.to_sym] = values[index]
+    end
+    hash = from_hash(hash) if hash.kind_of?(Hash) 
+    hash
+  end
+
+  def self.read_file_to_array(path)
+    contents = []
+    return contents unless File.exists?(path)
+    
+    open(path, 'r') do |l|
+      contents = l.readlines
+    end
+
+    contents
+  end
+  
+  def self.write_file(path, content, flush=true)
+    write_or_append_file('w', path, content, flush)
+  end
+  
+  def self.append_file(path, content, flush=true)
+    write_or_append_file('a', path, content, flush)
+  end
+  
+  def self.write_or_append_file(write_or_append, path, content = '', flush = true)
+    #STDERR.puts "Writing to #{ path }..." 
+    create_dir(File.dirname(path))
+    
+    open(path, write_or_append) do |f| 
+      f.puts content
+      f.flush if flush;
+    end
+    File.chmod(0600, path)
+  end
+end
+

data/storable.gemspec

@@ -0,0 +1,55 @@
+@spec = Gem::Specification.new do |s|
+	s.name = "storable"
+  s.rubyforge_project = "storable"
+	s.version = "0.5.1"
+	s.summary = "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"
+	s.description = s.summary
+  s.author = "Delano Mandelbaum"
+  s.email = "delano@solutious.com"
+  s.homepage = "http://solutious.com/"
+  
+  
+  # = EXECUTABLES =
+  # The list of executables in your project (if any). Don't include the path, 
+  # just the base filename.
+  s.executables = %w[]
+  
+  # = 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
+  # error. You can ask your VCS for the list of versioned files:
+  # git ls-files
+  # svn list -R
+  s.files = %w(
+  CHANGES.txt
+  LICENSE.txt
+  README.rdoc
+  Rakefile
+  lib/storable.rb
+  storable.gemspec
+  )
+  
+  s.extra_rdoc_files = %w[README.rdoc LICENSE.txt]
+  s.has_rdoc = true
+  s.rdoc_options = ["--line-numbers", "--title", s.summary, "--main", "README.rdoc"]
+  s.require_paths = %w[lib]
+  s.rubygems_version = '1.3.0'
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+ 
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<RedCloth>, [">= 4.0.4"])
+    else
+      s.add_dependency(%q<RedCloth>, [">= 4.0.4"])
+    end
+  else
+    s.add_dependency(%q<RedCloth>, [">= 4.0.4"])
+  end
+  
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: storable
+version: !ruby/object:Gem::Version 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Delano Mandelbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 -04: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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.0.4
+    version: 
+description: "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"
+email: delano@solutious.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- CHANGES.txt
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/storable.rb
+- storable.gemspec
+has_rdoc: true
+homepage: http://solutious.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --title
+- "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: storable
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 2
+summary: "Storable: Marshal Ruby classes into and out of multiple formats (yaml, json, csv, tsv)"
+test_files: []
+