homecoming 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 984f5b31cb94ef8c040a44eab2e393bbecfe1917
+  data.tar.gz: fe029bcac9fd794eae77280f6e7fc2267bf97099
+SHA512:
+  metadata.gz: 042a0d9c8334afc1310697e7e4612fe2c8659f777159dc1edc41232a7bd74606de206748c3767a58b5e3efdd46407a97585fe8463b31f26c7136f632d0dc90af
+  data.tar.gz: 80365a5a23eca9fe34f472e67cc488430c36fb1d2b0f8a69d2785176b2ac99f37a529aaefda5b6343eb76205f8012c639f96674a020cb24a4cfb72b23251c489

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in homecoming.gemspec
+gemspec
+
+gem 'simplecov', :require => false, :group => :test

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 René Föhring
+
+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,89 @@
+# Homecoming
+
+Homecoming let's you easily traverse all parent directories of a given or
+the current directory.
+
+This comes in handy when searching for a config file
+with settings that can be overridden by the same config file in a lower level
+directory (a popular example being `.gitignore`).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'homecoming'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install homecoming
+
+
+## Usage
+
+### Finding files
+
+`Homecoming.find` searches for a given filename in the current and all parent
+directories.
+
+  # Given the following directory structure:
+
+  /
+    home/
+      rrrene/
+        projects/
+          your_project/
+            .yourconfig
+        .yourconfig
+
+  Homecoming.find(".yourconfig", "/home/rrrene/projects/your_project")
+  # => ["/home/rrrene/.yourconfig",
+        "/home/rrrene/projects/your_project/.yourconfig"]
+
+If no path is given as second parameter, the current directory is the
+starting point of the traversal.
+
+### Traversing parents
+
+`Homecoming.each` traverses and yields the given and all parent
+directories.
+
+  Homecoming.each("/home/rrrene/projects/your_project") do |dir|
+    # ...
+  end
+
+If no path is given, the current directory is the starting point of the
+traversal.
+
+In our example, this would yield the following directories beginning with the
+given/current one:
+
+  "/home/rrrene/projects/your_project"
+  "/home/rrrene/projects"
+  "/home/rrrene"
+  "/home"
+  "/"
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/homecoming/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Author
+
+René Föhring (@rrrene)
+
+
+## License
+
+Homecoming is released under the MIT License. See the LICENSE.txt file for further
+details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/homecoming.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'homecoming/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "homecoming"
+  spec.version       = Homecoming::VERSION
+  spec.authors       = ["René Föhring"]
+  spec.email         = ["rf@bamaru.de"]
+  spec.summary       = %q{Easy upwards directory traversal}
+  spec.description   = %q{Easy upwards directory traversal}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/homecoming/find.rb

@@ -0,0 +1,34 @@
+module Homecoming
+  class Find
+    def initialize(filename, start_dir = Dir.pwd)
+      @start_dir = start_dir
+      @filename = filename
+    end
+
+    # Returns all found files with the given filename in the current and all
+    # parent directories.
+    #
+    #   # Given the following directory structure:
+    #
+    #   /
+    #     home/
+    #       rrrene/
+    #         projects/
+    #           your_project/
+    #             .yourconfig
+    #         .yourconfig
+    #
+    #   Homecoming.find(".yourconfig", "/home/rrrene/projects/your_project")
+    #   # => ["/home/rrrene/.yourconfig",
+    #         "/home/rrrene/projects/your_project/.yourconfig"]
+    #
+    def files
+      found_files = []
+      Traversal.new(@start_dir) do |dir|
+        filename = File.join(dir, @filename)
+        found_files.unshift filename if File.exist?(filename)
+      end
+      found_files
+    end
+  end
+end

data/lib/homecoming/traversal.rb

@@ -0,0 +1,12 @@
+module Homecoming
+  class Traversal
+    def initialize(dir = Dir.pwd, &block)
+      old_length = nil
+      while dir != '.' && dir.length != old_length
+        yield dir
+        old_length = dir.length
+        dir = File.dirname(dir)
+      end
+    end
+  end
+end

data/lib/homecoming/version.rb

@@ -0,0 +1,3 @@
+module Homecoming
+  VERSION = "0.1.0"
+end

data/lib/homecoming.rb

@@ -0,0 +1,33 @@
+require "homecoming/find"
+require "homecoming/traversal"
+require "homecoming/version"
+
+# Homecoming searches for a given filename in the current and all parent
+# directories.
+#
+#   # Given the following directory structure:
+#
+#   /
+#     home/
+#       rrrene/
+#         projects/
+#           your_project/
+#             .yourconfig
+#         .yourconfig
+#
+#   Homecoming.find(".yourconfig", "/home/rrrene/projects/your_project")
+#   # => ["/home/rrrene/.yourconfig",
+#         "/home/rrrene/projects/your_project/.yourconfig"]
+#
+# If no path is given as second parameter, the current directory is the
+# starting point of the traversal.
+#
+module Homecoming
+  def self.find(filename, path = Dir.pwd)
+    Homecoming::Find.new(filename, path).files
+  end
+
+  def self.each(path = Dir.pwd, &block)
+    Homecoming::Traversal.new(path, &block)
+  end
+end

data/test/fixtures/simple/.yourconfig

@@ -0,0 +1 @@
+# Nothing here

data/test/fixtures/simple/config/settings.yml

@@ -0,0 +1 @@
+# settings.yml

data/test/fixtures/simple/projects/your_project/.yourconfig

@@ -0,0 +1 @@
+# Nothing here

data/test/fixtures/simple/projects/your_project/config/settings.yml

@@ -0,0 +1 @@
+# settings.yml

data/test/homecoming_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+describe ::Homecoming do
+  it "should find both .yourconfig files" do
+    Dir.chdir File.join(fixture_path(:simple), "projects", "your_project")
+    list = Homecoming.find(".yourconfig")
+    here = File.dirname(__FILE__)
+    assert_equal ["#{here}/fixtures/simple/.yourconfig", "#{here}/fixtures/simple/projects/your_project/.yourconfig"], list
+  end
+
+  it "should find both config/settings.yml files" do
+    Dir.chdir File.join(fixture_path(:simple), "projects", "your_project")
+    list = Homecoming.find("config/settings.yml")
+    here = File.dirname(__FILE__)
+    assert_equal ["#{here}/fixtures/simple/config/settings.yml", "#{here}/fixtures/simple/projects/your_project/config/settings.yml"], list
+  end
+
+  it "should find both .yourconfig files" do
+    Dir.chdir File.join(fixture_path(:simple), "projects", "your_project")
+    list = []
+    Homecoming.each do |dir|
+      list << dir
+    end
+    assert_equal Dir.pwd, list.first
+    assert_equal "/", list.last
+    assert_equal Dir.pwd.split('/').size, list.size
+    # directories in the list are getting shorter (getting closer to home)
+    assert_equal list.sort_by(&:size), list.reverse
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'bundler'
+Bundler.require
+
+def fixture_path(name)
+  File.join(File.dirname(__FILE__), "fixtures", name.to_s)
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: homecoming
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- René Föhring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy upwards directory traversal
+email:
+- rf@bamaru.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- homecoming.gemspec
+- lib/homecoming.rb
+- lib/homecoming/find.rb
+- lib/homecoming/traversal.rb
+- lib/homecoming/version.rb
+- test/fixtures/simple/.yourconfig
+- test/fixtures/simple/config/settings.yml
+- test/fixtures/simple/projects/your_project/.yourconfig
+- test/fixtures/simple/projects/your_project/config/settings.yml
+- test/homecoming_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Easy upwards directory traversal
+test_files:
+- test/fixtures/simple/.yourconfig
+- test/fixtures/simple/config/settings.yml
+- test/fixtures/simple/projects/your_project/.yourconfig
+- test/fixtures/simple/projects/your_project/config/settings.yml
+- test/homecoming_test.rb
+- test/test_helper.rb