object-stash 1.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.1 / 2008-03-15
+
+* First release
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/object-stash
+lib/object-stash.rb
+test/test_object-stash.rb

data/README.txt

@@ -0,0 +1,61 @@
+= object-stash
+
+* http://www.marcuswestin.com
+
+== DESCRIPTION:
+
+"Permanently stash your Ruby objects" 
+
+Serializes your ruby objects and writes them to disk (gziped). 
+
+Easily load stashed object.
+
+== FEATURES/PROBLEMS:
+
+* Serializes a Ruby object
+* Writes the serialization to disk
+* Gzips written files automatically (optional)
+* Reloads Ruby objects from files
+
+== SYNOPSIS:
+
+# Store 
+my_hash = { :data => 'My big hash' }
+ObjectStash.store a_hash, './my_hash.stash'
+
+# Reload and test
+my_stashed_hash = ObjectStash.load './hash.stash
+throw :Error unless my_hash == my_stashed_hash
+
+== REQUIREMENTS:
+
+* requires 'zlib', which is part of the standard library
+
+== INSTALL:
+
+* sudo gem install object-stash
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Marcus Westin, Marcus@MarcusWestin.com
+
+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/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/object-stash.rb'
+
+Hoe.new('object-stash', ObjectStash::VERSION) do |p|
+  #p.rubyforge_name = 'object-stash' # if different than lowercase project name
+  p.developer('Marcus Westin', 'Marcus@MarcusWestin.com')
+  #p.remote_rdoc_dir = '' # Release to root
+end
+
+# vim: syntax=Ruby

data/lib/object-stash.rb

@@ -0,0 +1,79 @@
+require 'zlib'
+
+# Save any ruby object to disk!
+# Objects are stored as gzipped marshal dumps.
+#
+# Example
+#
+# # First ruby process
+# hash = {1 => "Entry1", 2 => "Entry2"}
+# ObjectStash.sotre hash, 'hash.stash'
+#
+# ...
+#
+# # Another ruby process - same_hash will be identical to the original hash
+# same_hash = ObjectStash.load 'hash.stash'
+class ObjectStash
+  VERSION = '1.0.1'
+
+  # Store an object as a gzipped file to disk
+  # 
+  # Example
+  #
+  # hash = {1 => "Entry1", 2 => "Entry2"}
+  # ObjectStore.store hash, 'hash.stash.gz'
+  # ObjectStore.store hash, 'hash.stash', :gzip => false
+  def self.store obj, file_name, options={}
+    marshal_dump = Marshal.dump(obj)
+    file = File.new(file_name,'w')
+    file = Zlib::GzipWriter.new(file) unless options[:gzip] == false
+    file.write marshal_dump
+    file.close
+    return obj
+  end
+  
+  # Read a marshal dump from file and load it as an object
+  #
+  # Example
+  #
+  # hash = ObjectStore.get 'hash.dump.gz'
+  # hash_no_gzip = ObjectStore.get 'hash.dump.gz'
+  def self.load file_name
+    begin
+      file = Zlib::GzipReader.open(file_name)
+    rescue Zlib::GzipFile::Error
+      file = File.open(file_name, 'r')
+    ensure
+      obj = Marshal.load file.read
+      file.close
+      return obj
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'test/unit'
+  class TestObjectStash < Test::Unit::TestCase
+    @@tmp = '/tmp/TestObjectStash.stash'
+    def test_hash_store_load
+      hash1 = {:test=>'test'}
+      ObjectStash.store hash1, @@tmp
+      hash2 = ObjectStash.load @@tmp
+      assert hash1 == hash2
+    end
+    def test_hash_store_load_no_gzip
+      hash1 = {:test=>'test'}
+      ObjectStash.store hash1, @@tmp, :gzip => false
+      hash2 = ObjectStash.load @@tmp
+      assert hash1 == hash2
+    end
+    def test_self_stash
+      ObjectStash.store ObjectStash, @@tmp
+      assert ObjectStash == ObjectStash.load(@@tmp)
+    end
+    def test_self_stash_no_gzip
+      ObjectStash.store ObjectStash, @@tmp, :gzip => false
+      assert ObjectStash == ObjectStash.load(@@tmp)
+    end
+  end
+end

data/test/test_object-stash.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'object-stash'
+class TestObjectStash < Test::Unit::TestCase
+  @@tmp = '/tmp/TestObjectStash.stash'
+  def test_hash_store_load
+    hash1 = {:test=>'test'}
+    ObjectStash.store hash1, @@tmp
+    hash2 = ObjectStash.load @@tmp
+    assert hash1 == hash2
+  end
+  def test_hash_store_load_no_gzip
+    hash1 = {:test=>'test'}
+    ObjectStash.store hash1, @@tmp, :gzip => false
+    hash2 = ObjectStash.load @@tmp
+    assert hash1 == hash2
+  end
+  def test_self_stash
+    ObjectStash.store ObjectStash, @@tmp
+    assert ObjectStash == ObjectStash.load(@@tmp)
+  end
+  def test_self_stash_no_gzip
+    ObjectStash.store ObjectStash, @@tmp, :gzip => false
+    assert ObjectStash == ObjectStash.load(@@tmp)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: object-stash
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Marcus Westin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: "\"Permanently stash your Ruby objects\"   Serializes your ruby objects and writes them to disk (gziped).   Easily load stashed object."
+email: 
+- Marcus@MarcusWestin.com
+executables: 
+- object-stash
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/object-stash
+- lib/object-stash.rb
+- test/test_object-stash.rb
+has_rdoc: true
+homepage: http://www.marcuswestin.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: object-stash
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: "\"Permanently stash your Ruby objects\"   Serializes your ruby objects and writes them to disk (gziped)"
+test_files: 
+- test/test_object-stash.rb