search_path 0.0.1

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+html/
+pkg/
+vendor/cache/*.gem
+/.idea
+

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format Fuubar
+

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2012-08-19
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thomas Baustert
+
+MIT License
+
+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.md

@@ -0,0 +1,71 @@
+## SearchPath
+
+Allows to define search paths to find files in.
+
+Useful for example to configure a few template directories to find a template in.
+
+## Install via Bundler
+
+Add to Gemfile:
+
+    # Gemfile
+    gem "search_path"
+
+And run bundler:
+
+    $ bundle install
+
+## Install without Bundler
+
+    $ gem install search_path
+
+## Usage
+
+### Example with find
+
+    # Define the search paths. Search paths are considered in the order given, first given first searched.
+    search_path = SearchPath.new(["/custom/path/to/files", "/standard/path/to/files"])
+
+    # Case 1: File not in "/custom/path/to/files" but in "/standard/path/to/files":
+    search_path.find("template.erb") # => "/standard/path/to/files/template.erb"
+
+    # Case 2: File in "/custom/path/to/files" and in "/standard/path/to/files":
+    search_path.find("template.erb") # => "/custom/path/to/files/template.erb"
+
+    # Case 3: File not in "/custom/path/to/files" and not in "/standard/path/to/files":
+    search_path.find("template.erb") # => nil
+
+### Example with find!
+
+Same as `find` but raises `SearchPath::FileNotFoundError` if file cannot be found:
+
+    search_path.find!("template.erb")   # => "/custom/path/to/files/template.erb"
+    search_path.find!("not_exists.erb") # => SearchPath::FileNotFoundError
+
+### Verify that search paths exists
+
+In case you wanna make sure the given search paths exists use option `verify_paths`:
+
+    # Raises SearchPath::SearchPathNotExistError if "/path1/to/files" or "/path2/to/files" not exist.
+    search_path = SearchPath.new(["/path1/to/files", "/path2/to/files"], :verify_paths => true)
+
+### Search paths must be absolute
+
+Note that each search path must be an absolute path. Using a relative path will raise an error:
+
+    # This Raises SearchPath::SearchPathNotAbsoluteError:
+    search_path = SearchPath.new("relative/path/to/files")
+
+Because you want to avoid using hardcoded absolute paths in your code you define the paths
+relative to search_path initialization code for example:
+
+    search_dir  = File.expand("../../relative/path/to/files", __FILE__)
+    search_path = SearchPath.new([search_dir])
+
+## Contact
+
+For comments and question feel free to contact me: business@thomasbaustert.de
+
+Copyright © 2012 [Thomas Baustert](http://thomasbaustert.de), released under the MIT license
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "search_path"
+end
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+Bundler::GemHelper.install_tasks

data/lib/search_path/version.rb

@@ -0,0 +1,3 @@
+class SearchPath
+  VERSION = "0.0.1"
+end

data/lib/search_path.rb

@@ -0,0 +1,122 @@
+require 'search_path/version'
+
+class SearchPath
+
+  # Raised if search path is not absolute.
+  class SearchPathNotAbsoluteError < StandardError; end
+
+  # Raised if one or more given search paths does not exist.
+  class SearchPathNotExistError < StandardError; end
+
+  # Raised if given file was not found in the given search paths.
+  class FileNotFoundError < StandardError; end
+
+
+  attr_reader :search_paths
+
+  ##
+  # Initialize a new +SearchPath+ instance with the given search paths.
+  #
+  # == Parameters
+  #
+  # * +search_paths+ - The search paths to find a filename in.
+  #
+  # == Options
+  #
+  # * +:verify_paths+ - If +true+ verify the existence of each search path and raise an +SearchPathNotExistError+ exception if path not exists.
+  #
+  # ==== Examples
+  #
+  #    search_path = SearchPath.new("/path1/to/files")
+  #    search_path = SearchPath.new(["/path1/to/files", "/path2/to/files"])
+  #
+  #    # => raises SearchPathNotAbsoluteError
+  #    search_path = SearchPath.new(["a/relative/path"])
+  #
+  #    # => raises SearchPathNotExistError for "/not/existing/path"
+  #    search_path = SearchPath.new(["/existing/path", "/not/existing/path"], :verify_paths => true)
+  #
+  def initialize(search_paths, options = {})
+    @search_paths = Array(search_paths)
+
+    verify_search_paths_are_absolute!
+    verify_search_paths_exists! if options[:verify_paths] == true
+  end
+
+  ##
+  # Finds the given +filename+ in the search paths. Returns the full path to the file
+  # or +nil+ if the file could not be found in one of the search paths.
+  #
+  # == Parameters
+  #
+  # * +filename+ - The filename to find.
+  #
+  # ==== Examples
+  #
+  #    search_path = SearchPath.new(["/path1/to/files", "/path2/to/files"])
+  #
+  #    # File "searched_file.txt" exists in "/path1/to/files"
+  #    search_path.find("searched_file.txt") # => "/path1/to/files/searched_file.txt"
+  #
+  #    # File "searched_file.txt" exists in "/path2/to/files"
+  #    search_path.find("searched_file.txt") # => "/path2/to/files/searched_file.txt"
+  #
+  #    # File "searched_file.txt" exists in none
+  #    search_path.find("searched_file.txt") # => nil
+  #
+  def find(filename)
+    search_paths.each do |path|
+      if File.exists?("#{path}/#{filename}")
+        return "#{path}/#{filename}"
+      end
+    end
+
+    nil
+  end
+
+  ##
+  # Same as #find but raises +FileNotFoundError+ exception if the file could not be found.
+  #
+  def find!(filename)
+    find(filename) || raise_file_not_found!(filename)
+  end
+
+  private
+
+  def verify_search_paths_are_absolute!
+    not_absolute_paths = search_paths.inject([]) do |list, path|
+      list << path unless Pathname.new(path).absolute?
+      list
+    end
+
+    raise raise_search_path_not_absolute!(not_absolute_paths) unless not_absolute_paths.empty?
+  end
+
+  def verify_search_paths_exists!
+    not_existing_paths = search_paths.inject([]) do |list, path|
+      list << path unless existing_directory?(path)
+      list
+    end
+
+    raise raise_search_path_not_exists!(not_existing_paths) unless not_existing_paths.empty?
+  end
+
+  def existing_directory?(path)
+    File.exists?(path) && File.directory?(path)
+  end
+
+  def raise_search_path_not_absolute!(paths)
+    raise SearchPathNotAbsoluteError.new("Search path(s) #{paths.inspect} is not absolute.")
+  end
+
+  def raise_search_path_not_exists!(paths)
+    raise SearchPathNotExistError.new("Search path(s) #{paths.inspect} does not exists.")
+  end
+
+  def raise_file_not_found!(filename)
+    raise FileNotFoundError.new("File '#{filename}' not found in search paths #{search_paths.inspect}.")
+  end
+
+end
+
+

data/search_path.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/search_path/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "search_path"
+  gem.version       = SearchPath::VERSION
+  gem.summary       = %q{Allows to define search paths to find files in.}
+  gem.description   = %q{Allows to define search paths to find files in.}
+  gem.license       = "MIT"
+  gem.authors       = ["Thomas Baustert"]
+  gem.email         = "business@thomasbaustert.de"
+  gem.homepage      = "https://github.com/thomasbaustert/search_path"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'fakefs'
+  gem.add_development_dependency 'rubygems-tasks'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'fuubar'
+end
+

data/spec/search_path/search_path_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe SearchPath do
+
+  describe "#initialize" do
+
+    context "given relative path" do
+      it "raises exception" do
+        FakeFS do
+          create_dir("/absolute/path/to/")
+          Dir.chdir("/absolute/path/to") do
+            lambda {
+              SearchPath.new(["a/not/existing/relative/path"])
+            }.should raise_error(SearchPath::SearchPathNotAbsoluteError, "Search path(s) [\"a/not/existing/relative/path\"] is not absolute.")
+          end
+        end
+      end
+    end
+
+    describe "verification existence of search paths" do
+
+      context "given not existing search path" do
+        context "as absolute path" do
+          it "raises exception if path not exists" do
+            lambda {
+              SearchPath.new(["/not/existing/path"], :verify_paths => true)
+            }.should raise_error(SearchPath::SearchPathNotExistError, "Search path(s) [\"/not/existing/path\"] does not exists.")
+          end
+        end
+
+        it "raises exception if one path not exists" do
+          FakeFS do
+            create_dir("/existing/path")
+            lambda {
+              SearchPath.new(["/existing/path", "/not/existing/path"], :verify_paths => true)
+            }.should raise_error(SearchPath::SearchPathNotExistError, "Search path(s) [\"/not/existing/path\"] does not exists.")
+          end
+        end
+
+        it "raises exception if path is not a directory" do
+          FakeFS do
+            create_filename("/existing/path/to/file.txt")
+            lambda {
+              SearchPath.new(["/existing/path/to/file.txt"], :verify_paths => true)
+            }.should raise_error(SearchPath::SearchPathNotExistError, "Search path(s) [\"/existing/path/to/file.txt\"] does not exists.")
+          end
+        end
+      end
+    end
+  end
+
+  describe "#search_paths" do
+    context "given search paths is nil" do
+      it "converts string to empty array" do
+        search_path = SearchPath.new(nil)
+        search_path.search_paths.should eq []
+      end
+    end
+
+    context "given search paths is as string" do
+      it "converts string to array with one element" do
+        search_path = SearchPath.new("/path/to/files")
+        search_path.search_paths.should eq ["/path/to/files"]
+      end
+    end
+
+    context "given search paths is an array of strings" do
+      it "returns array as given" do
+        search_path = SearchPath.new(["/path1/to/files", "/path2/to/more/files"])
+        search_path.search_paths.should eq ["/path1/to/files", "/path2/to/more/files"]
+      end
+    end
+  end
+
+  describe "#find" do
+    context "empty search path given" do
+      it "should return nil" do
+        SearchPath.new(nil).find("searched_file.txt").should be_nil
+        SearchPath.new([]).find("searched_file.txt").should be_nil
+      end
+    end
+
+    context "search path given" do
+      context "file not exists in search path" do
+        it "should return nil" do
+          FakeFS do
+            search_path = SearchPath.new(["/not/existing/path"])
+            search_path.find("searched_file.txt").should be_nil
+          end
+        end
+      end
+
+      context "file exists in search path" do
+        it "should return full path to file" do
+          FakeFS do
+            create_filename("/path/to/files/searched_file.txt")
+            search_path = SearchPath.new(["/path/to/files"])
+            search_path.find("searched_file.txt").should eq "/path/to/files/searched_file.txt"
+          end
+        end
+      end
+    end
+  end
+
+  describe "#find!" do
+    context "empty search path given" do
+      it "should raise exception" do
+        lambda { SearchPath.new(nil).find!("searched_file.txt") }.should(
+            raise_error(SearchPath::FileNotFoundError, "File 'searched_file.txt' not found in search paths []."))
+        lambda { SearchPath.new([]).find!("searched_file.txt") }.should raise_error(SearchPath::FileNotFoundError)
+      end
+    end
+
+    context "search path given" do
+      context "file not exists in search path" do
+        it "should raise exception" do
+          FakeFS do
+            search_path = SearchPath.new(["/not/existing/path"])
+            lambda { search_path.find!("searched_file.txt") }.should raise_error(SearchPath::FileNotFoundError)
+          end
+        end
+      end
+
+      context "file exists in search path" do
+        it "should return full path to file" do
+          FakeFS do
+            create_filename("/path/to/files/searched_file.txt")
+            search_path = SearchPath.new(["/path/to/files"])
+            search_path.find!("searched_file.txt").should eq "/path/to/files/searched_file.txt"
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def create_filename(filename, content = "RESULT")
+    create_dir(File.dirname(filename))
+    File.open(filename, "w") { |file| file.write(content) }
+  end
+
+  def create_dir(dirname)
+    FileUtils.mkdir_p(dirname)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'search_path'
+require 'fakefs/spec_helpers'
+

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: search_path
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Baustert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to define search paths to find files in.
+email: business@thomasbaustert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/search_path.rb
+- lib/search_path/version.rb
+- search_path.gemspec
+- spec/search_path/search_path_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thomasbaustert/search_path
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4409282025559043119
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4409282025559043119
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows to define search paths to find files in.
+test_files:
+- spec/search_path/search_path_spec.rb
+- spec/spec_helper.rb