pwnbus-configdb 0.1.0

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.project

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>pwnbus-configdb</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>org.radrails.rails.core.railsnature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.0.0.beta.20"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre3"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.0.pre3)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.0.pre3)
+  rcov
+  rspec (>= 2.0.0.beta.20)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Victor Costan
+
+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,17 @@
+= pwnbus-configdb
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Victor Costan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pwnbus-configdb"
+  gem.summary = %Q{Pure-ruby database for configuration variables.}
+  gem.description = %Q{Dead-simple key-value store with atomic updates.}
+  gem.email = "victor@costan.us"
+  gem.homepage = "http://github.com/pwnall/pwnbus_configdb"
+  gem.authors = ["Victor Costan"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  spec.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  spec.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency "rspec", ">= 2.0.0.beta.20"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.0.pre3"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "new #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pwnbus/configdb.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../configdb/db.rb', __FILE__)
+require File.expand_path('../configdb/files.rb', __FILE__)
+
+# :nodoc: namespace
+module Pwnbus
+
+# Pure-ruby database for configuration variables.
+module Configdb
+  # Opens a configuration database. The database is created if it doesn't exist.
+  #
+  # Args:
+  #   name:: the database name; if the name starts with a ., the database is
+  #          only readable to the current user, otherwise it is public (readable
+  #          to everyone, but only writable by the current user)
+  #   options:: the following keys are recognized
+  #     :read:: opens the database only for reading
+  #
+  # Yields a proxy object that can be used to access the database.  
+  #
+  # Returns the value produced by the block.
+  #
+  # Example:
+  #    Pwnbus::Configdb.open('system') do |system|
+  #      system.os.name = 'Ubuntu'
+  #      system.os.version = '10.04.1'
+  #    end
+  def self.open(name, options = {})
+    db_path = Files.find_db(name) || Files.create_db(name, options)
+    
+    db_file = Files.open_db(db_path, options)
+    db = Db.new db_file
+    begin
+      return_value = yield db.proxy
+      if db.dirty?
+        Files.write_db db_path, options do |wf|
+          db.write wf
+        end
+      end
+      return_value
+    ensure
+      db.close
+      db_file.close
+    end
+  end  
+end  # namespace Pwnbus::Configdb
+
+end  # namespace Pwnbus

data/lib/pwnbus/configdb/db.rb

@@ -0,0 +1,160 @@
+require 'yaml'
+
+# :nodoc: namespace
+module Pwnbus
+  
+# :nodoc: file-related functionality
+module Configdb
+  
+# Database instance.
+class Db
+  attr_reader :data
+  attr_reader :proxy
+  
+  # Database initialized with the contents of a file.
+  #
+  # Args:
+  #   file:: File instance
+  def initialize(file)
+    @data = YAML.load file
+    @dirty = false
+    @proxy = Proxy.new self, ''
+  end
+  
+  # Writes the database contents to a file.
+  #
+  # Args:
+  #   file:: File instance
+  #
+  # Returns true.
+  def write(file)
+    file.truncate 0
+    YAML.dump @data, file
+    true
+  end
+  
+  # Any future reads / writes will result in a crash.
+  def close
+    @data = nil
+  end
+  
+  # Reads a key from the database.
+  #
+  # Args:
+  #   key:: string or symbol
+  #
+  # Returns the value associated with the key, or nil if the key does not exist.
+  def [](key)
+    @data[key.to_s]
+  end
+    
+  # Inserts or updates a key in the database.
+  #
+  # Args:
+  #   key:: string or symbol
+  #   value:: the value to be associated with the key
+  #
+  # Returns value.
+  def []=(key, value)
+    @dirty = true
+    if value.nil?
+      @data.delete key.to_s
+    else
+      @data[key.to_s] = (value.kind_of?(Numeric) || value.kind_of?(Symbol) ||
+                         value == true || value == false) ? value : value.dup
+    end
+    value
+  end
+  
+  # True if the database contents has changed since the database has been open.
+  def dirty?
+    @dirty
+  end
+  
+  # Reads a key from the database, creating a proxy for inexistent keys.
+  #
+  # Args:
+  #   key:: string or symbol
+  #
+  # Returns the value associated with the key, or a database access proxy if the
+  # key doesn't exist. This makes it possible to have .-separated keys, like
+  # db.user.name = 'abc'.
+  def proxy_get(key)
+    value = self[key]
+    value.nil? ? Proxy.new(self, key + '.') : value
+  end
+  
+  # Inserts or updates
+  #
+  # Args:
+  #   key:: string or symbol
+  #   value:: the value to be associated with the key
+  #
+  # Returns value.
+  def proxy_set(key, value)
+    self[key] = value
+  end
+
+  if defined? BasicObject
+    # :nodoc: superclass for 1.9+ 
+    class Proxy < BasicObject; end
+  else
+    # :nodoc: superclass for 1.8
+    class Proxy < Object; end
+  end
+
+# Easy access to a configuration database.
+class Proxy
+  def initialize(database, prefix)
+    @db = database
+    @prefix = prefix
+    @eigenclass = (class <<self; self; end)
+  end
+  
+  # Proxy objects aren't database values, so they behave like nil.
+  def nil?
+    true
+  end
+  
+  # Proxy objects aren't database values, so they behave like nil.
+  def empty?
+    true
+  end
+  
+  # Pretty access
+  def method_missing(name, *args)
+    db_key = @prefix + name.to_s
+    do_write = false
+    
+    case db_key[-1]
+    when ??
+      db_key = db_key[0...-1]
+    when ?=
+      db_key = db_key[0...-1]
+      do_write = true
+    end
+    
+    if do_write
+      @eigenclass.class_eval <<END_DEF
+        def #{name}(value)
+          @db.proxy_set #{db_key.inspect}, value
+        end
+END_DEF
+    else
+      @eigenclass.class_eval <<END_DEF
+        def #{name}
+          @db.proxy_get #{db_key.inspect}
+        end
+END_DEF
+    end
+    
+    # The method was defined, now fire it off.
+    send name, *args
+  end
+end  # class Pwnbus::ConfigDb::Db::Proxy
+
+end  # class Pwnbus::Configdb::Db
+
+end  # namespace Pwnbus::Configdb
+
+end  # namespace Pwnbus

data/lib/pwnbus/configdb/files.rb

@@ -0,0 +1,159 @@
+require 'fileutils'
+
+# :nodoc: namespace
+module Pwnbus
+  
+# :nodoc: file-related functionality
+module Configdb
+  
+# Handling procedures for database files.
+module Files
+  # Opens the file for a configuration database. The file must exist.
+  #
+  # Returns a File instance.
+  def self.open_db(db_path, options)
+    db_path = crash_recovery_db_path db_path, options
+    f = File.open db_path, 'r'
+    f.flock options[:read] ? File::LOCK_SH : File::LOCK_EX
+    f
+  end
+  
+  # Peforms crash recovery on a database.
+  #
+  # Args:
+  #   db_path:: path to a file containing a configuration database
+  #   options:: same as for Configdb#new
+  #
+  # Returns the path to the recovered database. Most of the time, this will be 
+  def self.crash_recovery_db_path(db_path, options)
+    new_db_path = db_path + '.new'
+    if !File.exist?(db_path)
+      # Crashed during rename.
+      if options[:read]        
+        # Writing to the .new copy completed. The copy will be locked.
+        return new_db_path
+      else
+        # Do the rename.
+        File.rename new_db_path, db_path
+        return db_path
+      end
+    end
+          
+    if File.exist?(new_db_path) && !options[:read]
+      # Crashed during new version write. The new version is probably corrupted.
+      File.unlink new_db_path
+    end
+    db_path
+  end
+  
+  # Writes a new database version atomically.
+  #
+  # Args:
+  #   db_path:: path to a file containing a configuration database
+  #   options:: same as for Configdb#new
+  #
+  # Returns db_path.
+  def self.write_db(db_path, options)
+    new_db_path = db_path + '.new'
+    File.open(new_db_path, 'w') do |f|
+      f.flock File::LOCK_EX
+      permissions = public_db_name?(File.basename(db_path)) ? 0644 : 0600
+      File.chmod permissions, new_db_path      
+      yield f
+    end
+    File.unlink db_path
+    File.rename new_db_path, db_path
+    db_path
+  end
+
+  # True if the file is accessible with the desired Configdb#open options.
+  #
+  # Args:
+  #   db_path:: path to a database file
+  #   options:: same as for Configdb#new
+  def self.can_access_path?(db_path, options)
+    db_stat = File.stat(db_path)
+    options[:read] ? db_stat.readable? : db_stat.writable?
+  end
+  
+  # The path to a database, or nil if the database doesn't exist.
+  # 
+  # Args:
+  #   name:: the database name
+  def self.find_db(name)
+    db_dir_paths.each do |dir_path|
+      db_path = File.join dir_path, name + '.yml'
+      return db_path if File.exist?(db_path) || File.exist?(db_path + '.new')
+    end
+    nil
+  end
+  
+  # Creates a new database. The database must not exist.
+  #
+  # Args:
+  #   name:: the database name
+  #   options:: same as for Configdb#open
+  #
+  # Returns the path to the database file.
+  def self.create_db(name, options)
+    db_path = File.join ensure_db_dir_exists, name + '.yml'
+    File.open(db_path, 'w') do |f|
+      f.flock File::LOCK_EX
+      YAML.dump empty_db_data(name), f
+    end
+    permissions = public_db_name?(name) ? 0644 : 0600
+    File.chmod permissions, db_path
+    db_path
+  end
+  
+  # The contents of a empty (newly created) database.
+  #
+  # Args:
+  #    name:: the database's name
+  def self.empty_db_data(name)
+    {}
+  end
+  
+  # Databases whose names start with . are public (global-read, author-write).
+  def self.public_db_name?(name)
+    name[0] != ?.
+  end
+  
+  # Returns the the database directory. Creates it if it doesn't exist.
+  def self.ensure_db_dir_exists
+    dir_path = db_dir_paths.first
+    unless File.exist? dir_path    
+      FileUtils.mkdir_p dir_path
+      File.chmod 0755, dir_path
+    end
+    dir_path
+  end
+  
+  # Paths to the directory containing database files for the current user.
+  def self.db_dir_paths
+    if superuser?
+      [db_dir_global_path]
+    else
+      [db_dir_user_path, db_dir_global_path]
+    end
+  end
+  
+  # Path to the directory holding per-user databases.
+  def self.db_dir_user_path
+    File.expand_path('~/.pwnbus')
+  end
+  
+  # Path to the computer-global databases.
+  def self.db_dir_global_path
+    '/etc/pwnbus'
+  end
+  
+  # True if running as the root user.
+  def self.superuser?
+    Process.euid == 0
+  end
+end  # namespace Pwnbus::Configdb::Files
+
+end  # namespace Pwnbus::Configdb
+  
+end  # namespace Pwnbus

data/pwnbus-configdb.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pwnbus-configdb}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Victor Costan"]
+  s.date = %q{2010-09-19}
+  s.description = %q{Dead-simple key-value store with atomic updates.}
+  s.email = %q{victor@costan.us}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".gitignore",
+    ".project",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/pwnbus/configdb.rb",
+    "lib/pwnbus/configdb/db.rb",
+    "lib/pwnbus/configdb/files.rb",
+    "pwnbus-configdb.gemspec",
+    "spec/.rspec",
+    "spec/db_object_spec.rb",
+    "spec/db_spec.rb",
+    "spec/fixtures/db.yml",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/pwnall/pwnbus_configdb}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Pure-ruby database for configuration variables.}
+  s.test_files = [
+    "spec/db_object_spec.rb",
+    "spec/db_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.20"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.20"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.20"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.20"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.20"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.20"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/db_object_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Db object" do
+  before do
+    File.open File.expand_path('../fixtures/db.yml', __FILE__) do |f|
+      @db = Pwnbus::Configdb::Db.new f
+    end
+    @proxy = @db.proxy
+  end
+   
+  it "reads simple key" do
+    @proxy.variable.should == 'value'
+  end
+  
+  it "reads nested key" do
+    @proxy.deeper.variable.should == 'deeper value'
+  end
+  
+  it "changes simple key" do
+    @proxy.variable = 'new value'
+    @proxy.variable.should == 'new value'
+  end
+  
+  it "changes nested key" do
+    @proxy.deeper.variable = 'new deeper value'
+    @proxy.deeper.variable.should == 'new deeper value'
+  end
+  
+  it "returns nil? object for non-existing keys" do
+    @proxy.none.should be_nil
+  end
+
+  it "returns nil? object for non-existing nested keys" do
+    @proxy.none.none.should be_nil
+  end
+  
+  it "inserts simple key" do
+    @proxy.new_key.should be_nil
+    @proxy.new_key = 'new value'
+    @proxy.new_key.should == 'new value'
+  end
+  
+  it "inserts nested key" do
+    @proxy.newer.new_key.should be_nil
+    @proxy.newer.new_key = 'new deep value'
+    @proxy.newer.new_key.should == 'new deep value'    
+  end
+  
+  it "inserts nested key off existing prefix" do
+    @proxy.deeper.new_key.should be_nil
+    @proxy.deeper.new_key = 'new mixed value'
+    @proxy.deeper.new_key.should == 'new mixed value'
+  end
+end

data/spec/db_spec.rb

@@ -0,0 +1,166 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'fileutils'
+
+describe "Db" do
+  Files = Pwnbus::Configdb::Files
+  Configdb = Pwnbus::Configdb
+  
+  shared_examples_for "paths" do
+    it "should have a global path pointing to /etc" do
+      Files.db_dir_paths.last[0, 5].should == '/etc/'
+    end    
+  end
+
+  describe "for non-root user" do
+    it_should_behave_like "paths"
+
+    before do
+      Files.should_receive(:superuser?).and_return(false)
+    end
+    
+    it "should use a local and a global path" do
+      Files.db_dir_paths.should have(2).items
+    end
+  end
+  
+  describe "for root user" do
+    before do
+      Files.should_receive(:superuser?).and_return(true)
+    end
+    
+    it "should only use the global path" do
+      Files.db_dir_paths.should have(1).item
+    end    
+  end
+end
+
+describe "Db with stubbed dir" do  
+  before do
+    @tempdir = "/tmp/pwnbus-#{(Time.now.to_f * 1000).to_i}"
+    
+    @global_dir = File.join @tempdir, 'etc/pwnbus'
+    @user_dir = File.join @tempdir, 'home', 'user', '.pwnbus'
+    Dir.mkdir(@tempdir)
+    Files.stub!(:db_dir_global_path).and_return(@global_dir)
+    Files.stub!(:db_dir_user_path).and_return(@user_dir)
+  end
+  
+  after do
+    FileUtils.rm_r(@tempdir)
+  end
+  
+  describe "for non-root user" do
+    before do
+      Files.should_receive(:superuser?).at_least(:once).and_return(false)
+    end
+
+    it "saves new databases in the local dir" do
+      Configdb.open('pathtest') { }
+      File.exist?(@global_dir + '/pathtest.yml').should be_false
+      File.exist?(@user_dir + '/pathtest.yml').should be_true
+    end
+  end
+  
+  describe "for root user" do
+    before do
+      Files.should_receive(:superuser?).at_least(:once).and_return(true)
+    end
+    
+    it "saves databases in /etc'" do
+      Configdb.open('pathtest') { }
+      File.exist?(@user_dir + '/pathtest.yml').should be_false
+      File.exist?(@global_dir + '/pathtest.yml').should be_true
+    end
+  end
+  
+  describe "with saved db" do
+    before do
+      Configdb.open('persistence') do |c|
+        c.really.long.flag = true
+        c.really.long.number = 41
+        c.really.long.string = 'something'
+      end
+    end
+    
+    it "should report variables correctly" do
+      Configdb.open('persistence') do |c|
+        c.really.long.flag.should == true
+        c.really.long.number.should == 41
+        c.really.long.string.should == 'something'
+      end
+    end
+    
+    it "should make the dbfile world-readable" do
+      (File.stat(@user_dir + '/persistence.yml').mode & 0777).should == 0644
+    end
+    
+    describe "after overwriting some vars" do
+      before do
+        Configdb.open('persistence') do |c|
+          c.really.long.number = 42
+          c.really.long.flag = false
+        end
+      end
+      
+      it "should report changes correctly" do
+        Configdb.open('persistence') do |c|
+          c.really.long.flag.should == false
+          c.really.long.number.should == 42
+          c.really.long.string.should == 'something'        
+        end
+      end
+    end
+  end
+  
+  describe "with private db" do
+    before do
+      Configdb.open('.private') do |c|
+        c.secret.pin = '1234'
+      end
+    end
+    
+    it "should not make the dbfile world-readable" do
+      (File.stat(@user_dir + '/.private.yml').mode & 0777).should == 0600
+    end
+    
+    it "should be able to read back data" do
+      Configdb.open('.private') { |c| c.secret.pin.should == '1234' }
+    end
+  end
+  
+  describe "after crash" do
+    before do
+      @crash_path = @user_dir + '/crash.yml'
+      @crash_new_path = @crash_path + '.new'
+      FileUtils.mkdir_p @user_dir
+      File.open(@crash_path, 'w') { |f| YAML.dump({'old' => 'yes'}, f) }
+      File.open(@crash_new_path, 'w') { |f| YAML.dump({'old' => 'no'}, f) }
+    end
+    
+    describe "during writing" do
+      before do
+        @db_old = Configdb.open('crash') { |crash| crash.old }
+      end
+      
+      it "should read the old copy" do
+        @db_old.should == 'yes'
+      end
+    end
+    
+    describe "during rename" do
+      before do
+        File.unlink @crash_path
+        @db_old = Configdb.open('crash') { |crash| crash.old }        
+      end
+      
+      it "should read the new copy" do
+        @db_old.should == 'no'
+      end
+      
+      it "should finish the rename" do
+        File.exist?(@crash_path).should be_true
+        File.exist?(@crash_new_path).should be_false
+      end
+    end
+  end
+end

data/spec/fixtures/db.yml

@@ -0,0 +1,3 @@
+---
+variable: value
+deeper.variable: deeper value

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'pwnbus/configdb'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification 
+name: pwnbus-configdb
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Victor Costan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -1876988218
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre3
+        version: 1.5.0.pre3
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  requirement: *id005
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id006
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -1876988218
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre3
+        version: 1.5.0.pre3
+  requirement: *id007
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+  type: :development
+description: Dead-simple key-value store with atomic updates.
+email: victor@costan.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .project
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pwnbus/configdb.rb
+- lib/pwnbus/configdb/db.rb
+- lib/pwnbus/configdb/files.rb
+- pwnbus-configdb.gemspec
+- spec/.rspec
+- spec/db_object_spec.rb
+- spec/db_spec.rb
+- spec/fixtures/db.yml
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/pwnall/pwnbus_configdb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Pure-ruby database for configuration variables.
+test_files: 
+- spec/db_object_spec.rb
+- spec/db_spec.rb
+- spec/spec_helper.rb