search_up 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b03089ff2d4f071eaf8a3a71a397b901aaa20fb9
+  data.tar.gz: c25008a660af357c3bf1a7152b7b28457f2173ae
+SHA512:
+  metadata.gz: 7a3cb7e0ee0701886b03e17bd7a3765f8537e8f01233a67075332607410ad022b3ea84aece22e2d6ca1016668ae81aabe303e02673ce2181254f05fe4fdfcf92
+  data.tar.gz: 981e104c9cdf92e5ebd3c6168e99509034afd52718be38bc6132b2115cf17f36119e7884345c1c687022afd03e41f33fbb9124bd72527a7415d732f6604ad2a6

data/.editorconfig

@@ -0,0 +1,13 @@
+[*]
+insert_final_newline = true
+charset = utf-8
+
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.{js,json,rb}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "*.gemspec"
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Max: 1500
+  
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ModuleLength:
+  Max: 1500
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false # avoids dangling object pointers

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ed@edropple.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ed Ropple
+
+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,51 @@
+# SearchUp
+
+`SearchUp` encapsulates an annoyingly common bit of code I keep writing for various projects (like [Boss](https://github.com/eropple/cfer-boss)) -- recursively searching upward for a file or directory. We see this all the time in Ruby command-line tools, searching for a `Gemfile` or a `Rakefile`, and everybody implements it themselves. Nobody implements it the same way twice, either. So I decided to take my preferred implementation and gem it up.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'search_up'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search_up
+
+## Usage
+
+You can get a good feel for this library through its [test cases](https://github.com/eropple/search_up/blob/master/spec/search_up_spec.rb). The method signature, though, is as follows:
+
+```ruby
+SearchUp.search(start_at, pattern, stop_at: nil, find_one: false, &predicate)
+```
+
+`search` returns either an `Array` of `String` (which may be empty) or a single `String` if `find_one: true`.
+
+- `start_at`: The directory in which to start searching.
+- `pattern`: Either a String (glob) or a Regexp against which to test directory entries.
+- `stop_at:`: Optional parameter. If set, the search will stop after reaching this directory. Any entries found in this directory _will_ be returned.
+- `find_one:`: If true, returns only the first successful hit. Returns as a `String` rather than an array.
+- `&predicate`: If a block (1-arity) is passed to this method, every file found by the pattern will be tested against it. Files for which this block returns false will be skipped.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eropple/search_up. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/search_up.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require "search_up/version"
+
+module SearchUp
+  def self.search(start_at, pattern, stop_at: nil, find_one: false, &predicate)
+    raise "start_at must be a String" unless start_at.is_a?(String)
+    raise "pattern must be a String or a Regexp" \
+      unless pattern.is_a?(String) || pattern.is_a?(Regexp)
+
+    raise "stop_at must be nil or a String" \
+      unless stop_at.nil? || stop_at.is_a?(String)
+
+    find_one = !!find_one
+
+    ret = []
+
+    start_directory = File.expand_path(start_at)
+    stop_directory = stop_at.nil? ? nil : File.expand_path(stop_at)
+
+    previous = nil
+    current = start_directory
+    until current.nil? || current == previous
+      candidates =
+        if pattern.is_a?(String)
+          Dir[File.join(current, pattern)]
+        else
+          Dir[File.join(current, "*")].grep(pattern)
+        end
+
+      candidates.select!(&predicate) unless predicate.nil?
+
+      return candidates.first if find_one && !candidates.first.nil?
+
+      ret << candidates
+
+      previous = current
+      current = File.expand_path("..", previous)
+
+      break if current == stop_directory
+    end
+
+    # implicit; we can't get here in the find_one path unless we haven't found one
+    find_one ? nil : ret.flatten
+  end
+end

data/lib/search_up/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SearchUp
+  VERSION = "1.0.2"
+end

data/search_up.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "search_up/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "search_up"
+  spec.version       = SearchUp::VERSION
+  spec.authors       = ["Ed Ropple"]
+  spec.email         = ["ed+searchup@edropple.com"]
+
+  spec.summary       = "A simple utility for recursively searching upward for a file or directory."
+  spec.homepage      = "https://github.com/eropple/search_up"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: search_up
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Ed Ropple
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ed+searchup@edropple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/search_up.rb
+- lib/search_up/version.rb
+- search_up.gemspec
+homepage: https://github.com/eropple/search_up
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple utility for recursively searching upward for a file or directory.
+test_files: []