flat_hash 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Ryall
+ 
+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,25 @@
+= Flat Hash
+
+Serialisation for hash instances.
+
+== Rationale
+
+It's a bit of a struggle to justify creating this gem.  It just encapsulates some functionality that i'd built twice in other gems (shh and cardigan).  In both cases, I wanted to be able to manage a collection of serialised hash instances on all platforms in a version control system.  I'd used yaml initially but found that serialising the same hash on windows vs linux would produced slight differences.
+
+At this stage, only the serialisation/deserialisation has been completed.
+
+It will also need to accomodate rewriting hashes that had been serialised as yaml.
+
+== Usage
+
+=== FlatHash::Serialiser
+
+This class is just used to read and write hashes from disk
+
+Reading:
+
+  hash = FlatHash::Serialiser.new(File.open('hash)).read
+
+Writing:
+
+  FlatHash::Serialiser.new(File.open('hash', 'w')).write(hash)

data/lib/flat_hash/changeset.rb

@@ -0,0 +1,3 @@
+module FlatHash
+  Changeset = Struct.new :id, :time, :author, :modifications, :additions, :deletions, :description
+end

data/lib/flat_hash/delta.hg

@@ -0,0 +1,4 @@
+changeset = "{node}\n{date|date}\n{author}{files}\nadditions:{file_adds}\ndeletions:{file_dels}\ndescription:\n{desc|escape}\n"
+file = "\n{file|escape}"
+file_add = "\n{file_add|escape}"
+file_del = "\n{file_del|escape}"

data/lib/flat_hash/directory.rb

@@ -0,0 +1,57 @@
+require 'fileutils'
+
+module FlatHash; end
+
+class Object
+  def metaclass
+    (class << self; self; end)
+  end
+  
+  def meta_eval &block
+    metaclass.instance_eval &block
+  end
+end
+
+class FlatHash::Directory
+  include Enumerable
+
+  def initialize serialiser, path
+    @serialiser, @path = serialiser, path
+  end
+
+  def each
+    return unless File.exist?(@path)
+    Dir.foreach(@path) do |path|
+      basename = File.basename(path)
+      yield basename unless ['.','..'].include?(basename)
+    end
+  end
+
+  def destroy key
+    FileUtils.rm(File.join(@path,key))
+  end
+
+  def << entry
+    write entry.name, entry.content
+  end
+
+  def read key
+    File.open(File.join(@path,key)) {|io| add_key(@serialiser.read(io), key) }
+  end
+
+  alias :[] :read
+
+  def write key, hash
+    FileUtils.mkdir_p @path
+    File.open(File.join(@path,key),'w') {|io| @serialiser.write io, hash }
+  end
+
+  alias :[]= :write
+private
+  def add_key hash, key
+    hash.meta_eval {
+      define_method(:id) { key }
+    }
+    hash
+  end
+end

data/lib/flat_hash/entry.rb

@@ -0,0 +1,3 @@
+module FlatHash
+  Entry = Struct.new(:name, :content)
+end

data/lib/flat_hash/git.rb

@@ -0,0 +1,67 @@
+require 'flat_hash/vcs'
+require 'flat_hash/changeset'
+require 'grit'
+
+class FlatHash::Git < FlatHash::Vcs
+  def git
+    @git ||= Grit::Repo.new('.')
+  end
+
+  def name
+    :git
+  end
+
+  def addremovecommit comment
+    execute "add -A"
+    execute "ls-files --deleted -z | xargs -0 git rm"
+    commit comment
+  end
+
+  def changesets path='.'
+    sh("git log --format=%H -- #{path}") do |status, lines|
+      raise "failed with status #{status}:\n#{lines.join("\n")}" unless status.exitstatus == 128
+      []
+    end
+  end
+
+  def changeset id
+    change = FlatHash::Changeset.new
+    commit = git.commit(id)
+    change.id = commit.sha
+    change.time = commit.date
+    change.author = commit.author.to_s
+    all_changes = execute("show --pretty=\"format:\" --name-only #{commit}")
+    all_changes.shift
+    change.additions = commit.diffs.select {|diff| diff.new_file}.map {|diff| diff.a_path }.uniq
+    change.deletions = []
+    change.modifications = []
+    all_changes.each do |path|
+      if commit_contains(commit,path)
+        change.modifications << path
+      else
+        change.deletions << path
+      end
+    end
+    change.modifications = change.modifications - change.additions
+    change.description = commit.message
+    change
+  end
+
+  def content_at path, commit
+    execute("show #{commit}:#{path}").join("\n")
+  end
+
+  def files_at commit, path=nil
+    tree = git.commit(commit).tree
+    tree = tree/path if path
+    tree ? tree.blobs.map {|blob| path ? "#{path}/#{blob.name}" : blob.name } : []
+  end
+
+  def contains? id, path
+    commit_contains git.commit(id), path
+  end
+private
+  def commit_contains commit, path
+    commit.tree/path
+  end
+end

data/lib/flat_hash/hg.rb

@@ -0,0 +1,54 @@
+require 'flat_hash/vcs'
+require 'flat_hash/changeset'
+
+class FlatHash::Hg < FlatHash::Vcs
+  def name
+    :hg
+  end
+
+  def addremovecommit comment
+    execute "addremove"
+    commit comment
+  end
+
+  def changesets path='.'
+    execute "log --removed --template \"{node}\\n\" #{path}"
+  end
+
+  def changeset id
+    change = FlatHash::Changeset.new
+    style = File.join(File.dirname(__FILE__), 'delta.hg')
+    lines = sh("hg log --style \"#{style}\" -r #{id} --removed")
+    change.id = lines.shift
+    change.time = lines.shift
+    change.author = lines.shift
+    change.modifications = read_until(lines, 'additions:')
+    change.additions = read_until(lines, 'deletions:')
+    change.deletions = read_until(lines, 'description:')
+    change.modifications = change.modifications - change.additions
+    change.modifications = change.modifications - change.deletions
+    change.description = lines.join("\n")
+    change
+  end
+
+  def content_at path, commit
+    execute("cat -r #{commit} #{path}").join("\n")
+  end
+
+  def files_at commit, path='.'
+    sh "hg locate -r #{commit} '#{path}/*'" do |status, lines|
+      raise "failed with status #{status.exitstatus}:\n#{lines.join("\n")}" unless status.exitstatus == 1
+      []
+    end
+  end
+private
+  def read_until lines, end_line
+    entries = []
+    loop do
+      line = lines.shift
+      break if line == end_line
+      entries << line
+    end
+    entries
+  end
+end

data/lib/flat_hash/repository.rb

@@ -0,0 +1,18 @@
+require 'forwardable'
+require 'flat_hash/directory'
+require 'flat_hash/git'
+require 'flat_hash/hg'
+
+module FlatHash
+  class Repository < Directory
+    extend Forwardable
+    def_delegators :@vcs, :changesets
+
+    def initialize serialiser, path
+      super
+      @vcs = Git.new if File.exist?('.git')
+      @vcs = Hg.new if File.exist?('.hg')
+      raise "could not determine repository type" unless @vcs
+    end
+  end
+end

data/lib/flat_hash/serialiser.rb

@@ -0,0 +1,50 @@
+module FlatHash; end
+
+class FlatHash::Serialiser
+  def read io
+    hash = {}
+    first = true
+    key, value = nil, ''
+    io.each do |line|
+      line.chomp!
+      return read_as_yaml(io, line) if first and line =~ /^--- /
+      first = false
+      if key
+        if line == '<----->'
+          hash[key] = value
+          key, value = nil, ''          
+        else
+          value << "\n" if value.length > 0
+          value << line
+        end
+      else
+        key = line
+      end
+    end
+    hash[key] = value if key
+    hash
+  end
+
+  def write io, hash
+    first = true
+    hash.keys.sort.each do |key|
+      io.puts '<----->' unless first
+      io.puts key
+      io.puts hash[key]
+      first = false
+    end
+  end
+private
+  def read_as_yaml io, line
+    sio = StringIO.new(line)
+    io.each { |line| sio.puts line.chomp }
+    hash = YAML::load(sio.string)
+    hash['table'].instance_of?(Hash) ? convert_keys(hash['table']) : hash
+  end
+
+  def convert_keys hash
+    converted = {}
+    hash.keys.each {|k| converted[k.to_s] = hash[k]}
+    converted
+  end
+end

data/lib/flat_hash/vcs.rb

@@ -0,0 +1,23 @@
+class FlatHash::Vcs
+  def init
+    execute "init"
+  end
+
+  def commit comment
+    execute "commit -m \"#{comment}\""
+  end
+  
+  def execute command
+    sh "#{name} #{command}"
+  end
+
+  def sh command
+    lines = []
+    IO.popen("#{command} 2>&1") {|io| io.each {|l| lines << l.chomp } }
+    unless $?.success?
+      raise "\"#{command}\" failed with status #{$?}:\n#{lines.join("\n")}" unless block_given?
+      return yield($?, lines)
+    end
+    lines
+  end
+end

data/lib/flat_hash.rb

@@ -0,0 +1,4 @@
+require 'flat_hash/entry'
+require 'flat_hash/directory'
+require 'flat_hash/serialiser'
+require 'flat_hash/repository'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: flat_hash
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Ryall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-15 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: gemesis
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :development
+  version_requirements: *id004
+description: |
+  Hash serialisation that writes key/value pairs in a predicatable order
+
+email: mark@ryall.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/flat_hash/changeset.rb
+- lib/flat_hash/delta.hg
+- lib/flat_hash/directory.rb
+- lib/flat_hash/entry.rb
+- lib/flat_hash/git.rb
+- lib/flat_hash/hg.rb
+- lib/flat_hash/repository.rb
+- lib/flat_hash/serialiser.rb
+- lib/flat_hash/vcs.rb
+- lib/flat_hash.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/markryall/flat_hash
+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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: trivial but predictable serialisation for hashes
+test_files: []
+