fedux_org-stdlib 0.8.11 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e31a82df3298845b3873de282960a7db936423b
-  data.tar.gz: 65e33b51505ae347bc8c5078d376c6d723145d35
+  metadata.gz: a8ea2539aca02e286fba494301df890c97c51997
+  data.tar.gz: 50ce0223035ded9a8df1874530ecd5efe02f7dff
 SHA512:
-  metadata.gz: cf8da3ab201f5f3f5853a038d91008d22a1a18fdbefd67cfeb7c1079cd168e220fa80c0e846ca6450a10d669563d9629745a652c60c3870629e0c63005cb52f8
-  data.tar.gz: 00b2e8d9a1867c94714452447a11289f317b785790e9a99d4f2a9f556e398c18d8b8451a0af38be09672dac3d13834023895b2794995b123429cf26531c38b62
+  metadata.gz: 673fab131735338339eca8e7aa2378b9e2db1fd8151ea2ebcc7dcebdadc6ba79649e6a8f1d29fe4cfb57a71ed10fae34db032b5de5dc0f640512707c0d854872
+  data.tar.gz: d7a0e36de2ec5c42ab178a7be419d8bea7494a339a7985ac4f4c5c40113ad6178f4c6d5d3317a1d5c5b9981956e538abec45a2c8ee56ddbe85e9534ebe0d4050

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fedux_org-stdlib (0.8.10)
+    fedux_org-stdlib (0.8.11)
       activesupport
 
 PATH
@@ -60,7 +60,7 @@ GEM
     erubis (2.7.0)
     facter (2.2.0)
       CFPropertyList (~> 2.2.6)
-    ffi (1.9.5)
+    ffi (1.9.6)
     filegen (0.4.3)
       activesupport
     fuubar (2.0.0)
@@ -78,12 +78,12 @@ GEM
     mail (2.6.1)
       mime-types (>= 1.16, < 3)
     method_source (0.8.2)
-    mime-types (2.4.1)
+    mime-types (2.4.3)
     minitest (5.4.2)
     multi_json (1.10.1)
     multi_test (0.1.1)
-    netrc (0.7.7)
-    parser (2.2.0.pre.5)
+    netrc (0.8.0)
+    parser (2.2.0.pre.6)
       ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
     posix-spawn (0.3.9)
@@ -100,7 +100,7 @@ GEM
       yard (~> 0.8)
     rainbow (2.0.0)
     rake (10.3.2)
-    redcarpet (3.1.2)
+    redcarpet (3.2.0)
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
@@ -108,7 +108,7 @@ GEM
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
       rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.6)
+    rspec-core (3.1.7)
       rspec-support (~> 3.1.0)
     rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -150,7 +150,7 @@ GEM
     versionomy (0.4.4)
       blockenspiel (>= 0.4.5)
     xml-simple (1.1.4)
-    yard (0.8.7.4)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby

data/lib/fedux_org_stdlib/recursive_file_finder.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require 'fedux_org_stdlib/logging/logger'
+
+require_library %w(pathname)
+
+module FeduxOrgStdlib
+  class RecursiveFileFinder
+    # Create a new instance of finder
+    #
+    # It tries to find a file.
+    #
+    # @param [String] file_name
+    #   The name of the file to be looked for
+    #
+    # @param [String] working_directory
+    #   The directory where to start search
+    #
+    # @return [RecursiveFileFinder]
+    #   The config instance. If the resulting data structure created by the
+    #   config_engine does not respond to `:[]` an empty config object will be
+    #   created.
+
+    attr_reader :working_directory, :logger, :file_name, :raise_error
+
+    def initialize(
+      file_name:,
+      working_directory: Dir.getwd,
+      logger: FeduxOrgStdlib::Logging::Logger.new,
+      raise_error: true
+    )
+      @logger            = logger
+      @working_directory = Pathname.new(working_directory).expand_path
+      @file_name         = Pathname.new(file_name)
+      @raise_error       = raise_error
+    end
+
+    # Return path to file
+    #
+    # @raise [Errno::ENOENT]
+    #   If file cannot be found
+    #
+    # @return [Pathname]
+    #   The path
+    def file
+      return @found_path if @found_path
+
+      @found_path = nil
+
+      working_directory.ascend do |p|
+        path = p + file_name
+        @found_path = path if path.exist?
+      end
+
+      return @found_path if @found_path
+      fail Errno::ENOENT, file_name.to_s  if raise_error
+
+      nil
+    end
+
+    # The directory where file was found
+    #
+    # @raise [Errno::ENOENT]
+    #   If file cannot be found
+    #
+    # @return [Pathname]
+    #   The path to directory
+    def directory
+      file.dirname
+    end
+  end
+end

data/lib/fedux_org_stdlib/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # FeduxOrgStdlib
 module FeduxOrgStdlib
-  VERSION = '0.8.11'
+  VERSION = '0.9.0'
 end

data/spec/recursive_file_finder_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/recursive_file_finder'
+
+RSpec.describe RecursiveFileFinder do
+  context '#file' do
+    it 'returns path to found file' do
+      touch_file 'test.txt'
+      finder = RecursiveFileFinder.new(file_name: 'test.txt', working_directory: absolute_path('.'))
+      expect(finder.file).to eq Pathname.new(absolute_path('test.txt'))
+    end
+
+    it 'runs up file hierarchy' do
+      touch_file 'test.txt'
+      finder = RecursiveFileFinder.new(file_name: 'test.txt', working_directory: absolute_path('dir1/dir2/'))
+      expect(finder.file).to eq Pathname.new(absolute_path('test.txt'))
+    end
+
+    it 'runs up file hierarchy and finds it in between' do
+      touch_file 'dir1/test.txt'
+      finder = RecursiveFileFinder.new(file_name: 'test.txt', working_directory: absolute_path('dir1/dir2/'))
+      expect(finder.file).to eq Pathname.new(absolute_path('dir1/test.txt'))
+    end
+
+    it 'fails if file was not found' do
+      finder = RecursiveFileFinder.new(file_name: 'test.txt', working_directory: absolute_path('dir1/dir2/'))
+      expect { finder.file }.to raise_error Errno::ENOENT
+    end
+
+    it 'returns nil if told to to so' do
+      finder = RecursiveFileFinder.new(file_name: 'test.txt', working_directory: absolute_path('dir1/dir2/'), raise_error: false)
+      expect(finder.file).to be nil
+    end
+  end
+
+  context '#directory' do
+    it 'returns the directory where the file was found' do
+      touch_file 'test.txt'
+      finder = RecursiveFileFinder.new(file_name: 'test.txt', working_directory: absolute_path('dir1/dir2/'))
+      expect(finder.directory).to eq Pathname.new(absolute_path('.'))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.8.11
+  version: 0.9.0
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,6 +146,7 @@ files:
 - lib/fedux_org_stdlib/rake_tasks/tests/cucumber.rb
 - lib/fedux_org_stdlib/rake_tasks/tests/rspec.rb
 - lib/fedux_org_stdlib/rake_tasks/tests/travis.rb
+- lib/fedux_org_stdlib/recursive_file_finder.rb
 - lib/fedux_org_stdlib/require_files.rb
 - lib/fedux_org_stdlib/roles/comparable_by_name.rb
 - lib/fedux_org_stdlib/roles/typable.rb
@@ -206,6 +207,7 @@ files:
 - spec/project/plan_spec.rb
 - spec/project/report_spec.rb
 - spec/project/taskjuggler_spec.rb
+- spec/recursive_file_finder_spec.rb
 - spec/roles/typable_spec.rb
 - spec/shell_language_detector_spec.rb
 - spec/spec_helper.rb
@@ -287,6 +289,7 @@ test_files:
 - spec/project/plan_spec.rb
 - spec/project/report_spec.rb
 - spec/project/taskjuggler_spec.rb
+- spec/recursive_file_finder_spec.rb
 - spec/roles/typable_spec.rb
 - spec/shell_language_detector_spec.rb
 - spec/spec_helper.rb