metahash 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+.rspec
+pkg/*
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in metahash.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/metahash/version.rb

@@ -0,0 +1,3 @@
+module Metahash
+  VERSION = "0.0.1"
+end

data/lib/metahash.rb

@@ -0,0 +1,91 @@
+require 'metahash/version'
+require 'rubygems'
+require 'bson'
+require 'json'
+module Metahash
+  class Metahash
+    BOM = (JSON '["\uFEFF"]')[0]
+    SEARCH_BYTE_OFFSET = 4
+    SEARCH_BYTE_SEQUENCE = "\003bson-\357\273\277"
+    def initialize(path,options={})
+      raise ArgumentError unless File.exists? path
+      @path     = path
+      @options  = options
+      bson      = read_for_search  File.open(@path,"rb") 
+      if bson
+        @bson_range = bson[:range]
+        @bson_size  = bson[:size]
+        @bytes      = bson[:bytes]
+      end
+      self
+    end
+    # returns current state of metahash, false if no tag attahed, true if tag attached
+    def tagged?
+      !@bson_size.nil?
+    end
+
+    # returns a hash 
+    def to_h
+      return nil if @bytes.nil?
+      packet = BSON.deserialize(BSON::ByteBuffer.new(@bytes[@bson_range])) 
+      packet["bson-#{BOM}"]["object"]
+    end
+
+    # allow transparent usage like hash
+    # TODO: This is ridiculous, truly a monkey patch to provide cool functionality, please implement hash correctly
+    def method_missing(method,*args)
+      if {}.respond_to?(method) 
+        hash = to_h||{}
+        result = hash.send(method,*args)
+        write hash
+        result
+      else
+        super
+      end
+    end
+    def write(obj)
+      byte_string = BSON.serialize(wrap_obj(obj)).to_s
+      if @bytes
+        #take 0..bson_start 
+        #serialize object
+        #with bson_end..-1
+        @bytes=@bytes[0..@bson_range.first]+byte_string+@bytes[@bson_range.last..-1]
+        #write and reinitialize 
+        File.truncate(@path,0)
+        File.open(@path,"wb+") do |file|
+          file.write(@bytes)
+        end
+      else
+        File.open(@path,"ab+") do |file|
+          file.write(byte_string)
+        end
+      end
+      initialize(@path,@options)
+    end
+    private
+
+    # wraps obj in Meta Hash header
+    def wrap_obj(obj)
+      meta_bson = {
+        "bson-#{BOM}"=>{
+          "version"=>VERSION,
+          "ns"=>["http://json-schema.org/card.properties","http://groups.google.com/group/json-schema/browse_thread/thread/dd1a8c9e55035c67?pli=1"],
+          "object"=> obj
+        }
+      }
+    end
+    def read_for_search(io)
+      bytes = io.read
+      search_position = bytes.index(SEARCH_BYTE_SEQUENCE)
+      return nil unless search_position
+      bson_start = search_position - SEARCH_BYTE_OFFSET
+      bson_size = bytes[bson_start..(search_position-1)].unpack("S")[0]
+      bson_end = bson_start + bson_size
+      return {
+          :range =>  bson_start..bson_end,
+          :size  =>  bson_size,
+          :bytes =>  bytes
+      }
+    end
+  end
+end

data/metahash.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "metahash/version"
+
+Gem::Specification.new do |s|
+  s.name        = "metahash"
+  s.version     = Metahash::VERSION
+  s.authors     = ["Thomas Devol"]
+  s.email       = ["thomas.devol@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Provides metadata management for many file types}
+  s.description = %q{Successor to exif/id3/xmp for metadata management}
+
+  s.rubyforge_project = "metahash"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "ruby-debug"
+  s.add_runtime_dependency "bson"
+  s.add_runtime_dependency "json"
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/metahash_spec.rb

@@ -0,0 +1,132 @@
+require 'metahash'
+require 'ruby-debug'
+module Metahash
+  describe Metahash do
+    before {
+      @test_path = File.dirname(__FILE__)+"/test.txt"  
+      @test_data = {"hello"=>"world"}
+    }
+
+    context "generally" do #high level expectations
+
+      it "should be able to append to a new file" do
+        
+        mh = Metahash.new @test_path
+        mh.write({"hello"=>"world"})
+
+        mh = Metahash.new @test_path
+        obj = mh.to_h
+        obj.should be_a(Hash)
+        obj["hello"].should == "world"
+
+      end
+      it "should be able to modify an already tagged file" do
+        mh = Metahash.new @test_path 
+        mh.write({"hello"=>"world"})
+
+        mh = Metahash.new @test_path
+        mh.write({"hello"=>"holmes"})
+
+        mh = Metahash.new @test_path
+        obj = mh.to_h
+        obj.should be_a(Hash)
+        obj["hello"].should == "holmes"
+      end
+    end
+    describe "specifically" do
+      let(:new_metahash_with_untagged_file) do
+        f = File.open @test_path,"w+"
+        f.write "Hello World"
+        f.close
+        Metahash.new @test_path 
+      end
+      let(:new_metahash_with_tagged_file) do
+        mh = new_metahash_with_untagged_file
+        mh.write @test_data
+        mh
+      end
+      
+      describe "#initialize" do
+        it "should throw an error on an invalid path" do
+          invalid_path = rand().to_s+@test_path
+          expect{
+            mh = Metahash.new invalid_path
+          }.to raise_error(ArgumentError)
+        end
+        it "should not throw an error on a valid path" do
+          lambda {
+           new_metahash_with_untagged_file
+          }.should_not raise_error(ArgumentError)
+        end
+      end
+      describe "#tagged?" do
+        it "should return false for untagged files" do
+          new_metahash_with_untagged_file.should_not be_tagged
+        end
+        it "should return true for tagged files" do
+          new_metahash_with_tagged_file.should be_tagged
+        end
+      end
+      describe "#write" do
+        context "with an untagged file" do
+          subject &:new_metahash_with_untagged_file 
+          it "should call wrap obj and serialize" do
+            subject.should_receive(:wrap_obj).with(@test_data)
+            BSON.should_receive :serialize
+            subject.write @test_data
+          end
+          it "should call initialize after write" do
+            subject.should_receive(:initialize).exactly(1).times 
+            subject.write @test_data
+          end
+        end
+        context "with a tagged file" do
+          subject &:new_metahash_with_tagged_file
+          it "should truncate already tagged file" do
+            File.should_receive(:truncate).with(@test_path,0)
+            subject.write({"hello"=>"holmes"})
+          end
+        end
+      end
+      describe "#to_h" do
+        context "with an untagged file" do
+          subject &:new_metahash_with_untagged_file 
+          it "should return nil" do
+            subject.to_h.should be_nil
+          end
+        end
+        context "with a tagged file" do
+          subject &:new_metahash_with_tagged_file
+          it "should return test data" do
+            subject.to_h.should == @test_data
+          end
+        end
+      end
+      describe "#method_missing" do
+        context "with a tagged file" do
+          subject &:new_metahash_with_tagged_file
+          it "should read just like a hash" do
+            subject["hello"].should == "world" 
+          end
+          it "should write and persist" do
+            #debugger
+            subject["foo"] = "bar"
+            subject["foo"].should == "bar"
+          end
+        end
+        context "with an untagged file" do
+          subject &:new_metahash_with_untagged_file
+          it "should just work" do
+            subject["artist"] = "dave matthews"
+
+            mh = Metahash.new @test_path
+            mh["artist"].should == "dave matthews"
+          end
+        end
+
+
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: metahash
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thomas Devol
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-30 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Successor to exif/id3/xmp for metadata management
+email: 
+- thomas.devol@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/metahash.rb
+- lib/metahash/version.rb
+- metahash.gemspec
+- spec/metahash_spec.rb
+- spec/test.txt
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: metahash
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides metadata management for many file types
+test_files: 
+- spec/metahash_spec.rb
+- spec/test.txt