tcravit_ruby_lib 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v 0.0.1, 2011-12-02
+
+* Initial release

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new('spec')

data/lib/tcravit_ruby_lib/config_searcher.rb

@@ -0,0 +1,57 @@
+require 'pathname'
+
+module TcravitRubyLib #:nodoc:
+
+  # Utilities for locating a configuration directory within a tree.
+  # 
+  # Unix utilities such as +git+ will look for the .git directory in a 
+  # project by starting with the current directory and traversing upward
+  # until a .git folder is found. This allows local configuration in a 
+  # subdirectory to override a global configuration file upstream.
+  #
+  # This module, inspired by a post on Practicing Ruby, implements that 
+  # kind of traversal for Ruby applications.
+  module ConfigSearcher
+
+    # Locate a configuration folder by starting in the specified directory
+    # and traversing upward through the directory tree.
+    #
+    # === Options
+    #
+    # * +:start_in+ or +:start_dir+ - The directory in which to begin the
+    # search. Defaults to the current directory if unspecified or if the
+    # specified directory doesn't exist.
+    # * +:look_for+ or +:config_dir+ - The name of the configuration directory
+    # to look for. Defaults to +.config+ if unspecified.
+    # * +:only_container_dir: - If this option is true, the +:look_for+ 
+    # directory will not be returned as part of the path.
+    #
+    # === Returns
+    #
+    # If the configuration directory is found, its path will be returned as a
+    # string. Otherwise, an empty string will be returned. If the +start_in+
+    # directory doesn't exist, an exception will be raised.
+    def self.locate_config_dir(opts={})
+      start_dir           = opts[:start_in] || opts[:start_dir] || "."
+      config_dir_name     = opts[:look_for] || opts[:config_dir] || ".config"
+      only_container_dir  = opts[:only_container_dir] || false
+      
+      dir = Pathname.new(start_dir)
+      app_config_dir = dir + config_dir_name
+      
+       if dir.children.include?(app_config_dir)
+         if only_container_dir
+           app_config_dir.to_s.split('/')[0..-2].join('/')
+         else
+           app_config_dir.expand_path.to_s
+         end
+       else  
+         return nil if dir.expand_path.root?  
+         # In the event the opts come from a hash that's used elsewhere, I don't
+         # want to modify it, so I make a copy and replace the :start_in value.
+         # I'm sure there's a better way to do this.
+         locate_config_dir(opts.reject{|k,v| k == :start_in}.merge({start_in: dir.parent.to_s}))  
+       end      
+    end
+  end
+end

data/lib/tcravit_ruby_lib/version.rb

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

data/lib/tcravit_ruby_lib.rb

@@ -0,0 +1,5 @@
+require "tcravit_ruby_lib/version"
+require 'tcravit_ruby_lib/config_searcher'
+
+module TcravitRubyLib # :nodoc:
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'tcravit_ruby_lib'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/tcravit_ruby_lib/config_searcher_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe "TcravitRubyLib" do
+  describe "ConfigSearcher" do
+  
+    BASE_DIR   = '/tmp/config_searcher_test'
+    DEEP_DIR   = "#{BASE_DIR}/foo/bar/baz"
+    CONFIG_DIR = "#{BASE_DIR}/.config"
+  
+    before(:all) do
+      FileUtils.mkdir_p DEEP_DIR
+      FileUtils.mkdir_p CONFIG_DIR
+    end
+  
+    after(:all) do
+      FileUtils.remove_dir BASE_DIR, true
+    end
+  
+    it "should successfully find a directory which exists" do
+      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".config")
+      dir_path.to_s.should_not be_nil
+      dir_path.to_s.should == CONFIG_DIR
+    end
+  
+    it "should not find a directory when one doesn't exist" do
+      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".snausages")
+      dir_path.to_s.should == ""    
+    end
+  
+    it "should return the container dir when the only_container_dir option is provided" do
+      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: DEEP_DIR, look_for: ".config", only_container_dir: true)
+      dir_path.to_s.should == BASE_DIR
+    end
+    
+    it "should raise an exception when the start_in directory doesn't exist" do
+      an_exception = nil
+    
+      begin
+        dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_in: "#{DEEP_DIR}xxxxxxx", look_for: ".snausages")
+      rescue => e
+        an_exception = e
+      end
+    
+      an_exception.should_not be_nil
+      an_exception.message.should == "No such file or directory - #{DEEP_DIR}xxxxxxx"
+    end
+  
+    it "should behave the same for the alternative option names" do
+      dir_path = TcravitRubyLib::ConfigSearcher.locate_config_dir(start_dir: DEEP_DIR, config_dir: ".config")
+      dir_path.to_s.should_not be_nil
+      dir_path.to_s.should == CONFIG_DIR
+    end
+  end
+  
+end

data/tcravit_ruby_lib.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tcravit_ruby_lib/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tcravit_ruby_lib"
+  s.version     = TcravitRubyLib::VERSION
+  s.authors     = ["Tammy Cravit"]
+  s.email       = ["tcravit@taylored-software.com"]
+  s.homepage    = ""
+  s.summary     = %q{Random reusable ruby stuff}
+
+  s.rubyforge_project = "tcravit_ruby_lib"
+
+  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_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: tcravit_ruby_lib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tammy Cravit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70131351967320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70131351967320
+description: 
+email:
+- tcravit@taylored-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- Rakefile
+- lib/tcravit_ruby_lib.rb
+- lib/tcravit_ruby_lib/config_searcher.rb
+- lib/tcravit_ruby_lib/version.rb
+- spec/spec_helper.rb
+- spec/tcravit_ruby_lib/config_searcher_spec.rb
+- tcravit_ruby_lib.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tcravit_ruby_lib
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Random reusable ruby stuff
+test_files:
+- spec/spec_helper.rb
+- spec/tcravit_ruby_lib/config_searcher_spec.rb
+has_rdoc: