file_finder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a648a32d4db029ca80b4890db2c5ea359a81f0d8
+  data.tar.gz: 9c3c9d85961a548c967a85864eff8630807d332a
+SHA512:
+  metadata.gz: d4944a0d654e6bab746cf1ecbbcaf6e368884c7fb406bee968a2a7af41603772b8ddcf9be982b37ce8878808762fbe1fb39a995fc468b2e0eb4b569826924059
+  data.tar.gz: 43849f3d2a740e51bde93727e295ea9f5adfdafe74c0c369453702d533a56283a9564f0d5a91e363f3a6e7fdac854fa8ae7d9fc2f4ceac5f9aebda1ba21aa6cf

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Logan Hasson
+
+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,93 @@
+# FileFinder
+
+Easily access files within your gems' directory structures. Why is this
+cool? It takes some annoying jumping through hoops to access support files from
+within a gem. If you try to `File.read('some/file.rb')`, you end up
+accessing a file relative to where the gem is *run* from.
+
+FileFinder gives you a simple helper method to get the absolute path to
+support files.
+
+## Installation
+
+Add this line to your gemspec:
+
+    spec.add_runtime_dependency "file_finder"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_finder
+
+## Usage
+
+Call `apath_to` with a relative path to a file.
+
+    `apath_to('path/to/file.rb')`
+
+For example, let's say I have this directory structure:
+
+```bash
+├── README.md
+├── Rakefile
+├── my_sweet_gem.gemspec
+├── lib
+│   ├── my_sweet_gem
+│   │   ├── some_class.rb
+│   │   ├── another_class.rb
+│   │   └── yet_another_class.rb
+│   └── outer_file.rb
+├── templates
+│   └── some_template.txt
+└── spec
+```
+
+If I want to read `templates/some_template.txt` from within
+`lib/my_sweet_gem/some_class.rb`, I can do something like this:
+
+```ruby
+File.read(apath_to('../../templates/some_template.txt'))
+```
+
+## Configuration
+
+There's one downside to the default usage of FileFinder: the `apath_to`
+method is defined on Kernel. It could have been defined on Object just
+as easily, but that's six of one and half a dozen of the other. If this
+would overwrite another method of the same name that you've written, or
+you just perfer not polluting the global namespace, you can turn this
+feature off with:
+
+```ruby
+FileFinder.config do |c|
+  c.global_method = false
+end
+```
+
+If you've done this, you can get absolute paths with `FileFinder::File('path/to/file/here)`.
+
+## Known Issues
+
+1. If you happen to already have a method, `apath_to` defined on Kernel,
+   setting the `global_method` configuration option to `true` more than
+once will forever overwrite the original method. The current solution to
+this problem is the alternate setting the `global_method`
+configuration option between `true` and `false` if you intend to change
+it on the fly. Really, you should only be setting this option once.
+
+## Todo
+
+1. Write specs
+2. Solve known issue
+
+## Contributing
+
+1. Fork it ( https://github.com/loganhasson/file_finder/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 a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/file_finder.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_finder"
+  spec.version       = FileFinder::VERSION
+  spec.authors       = ["Logan Hasson"]
+  spec.email         = ["logan.hasson@gmail.com"]
+  spec.summary       = "Utility for loading support files within gems."
+  spec.homepage      = "http://github.com/loganhasson/file_finder.git"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/file_finder.rb

@@ -0,0 +1,19 @@
+require 'file_finder/version'
+require 'file_finder/configuration'
+require 'file_finder/finder'
+require 'reset_kernel'
+
+module FileFinder
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= FileFinder::Configuration.new
+  end
+
+  def self.config
+    yield configuration
+  end
+end
+

data/lib/file_finder/configuration.rb

@@ -0,0 +1,29 @@
+require 'file_finder/finder'
+
+module FileFinder
+  class Configuration
+
+    def global_method=(value)
+      if value == false || value == 'false'
+        unset_kernel_method
+      elsif value == true || value == 'true'
+        reset_kernel_method
+      else
+        raise FileFinder::InvalidConfigOptionError, "global_method= accepts either `true` or `false`"
+      end
+    end
+
+    def unset_kernel_method
+      load "#{FileFinder::File('../unset_kernel.rb')}"
+    end
+
+    def reset_kernel_method
+      load "#{FileFinder::File('../reset_kernel.rb')}"
+    end
+
+  end
+
+  InvalidConfigOptionError = Class.new(StandardError)
+
+end
+

data/lib/file_finder/finder.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+
+module FileFinder
+
+  def self.File(path)
+    FileFinder::Finder.get_absolute_path_to(path, Kernel.caller.first.match(/(.*):.*:.*/)[1])
+  end
+
+  class Finder
+    attr_reader :path, :configuration, :calling_file
+
+    def self.get_absolute_path_to(path, calling_file = __FILE__)
+      new(path, calling_file).absolute_path
+    end
+
+    def initialize(path, calling_file)
+      @path = path
+      @calling_file = calling_file
+    end
+
+    def absolute_path
+      Pathname.new(File.join(File.dirname(File.expand_path(calling_file)), path)).expand_path.to_s
+    end
+
+  end
+
+end
+

data/lib/file_finder/version.rb

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

data/lib/reset_kernel.rb

@@ -0,0 +1,16 @@
+require 'file_finder/finder.rb'
+
+module Kernel
+  if self.respond_to?(:apath_to)
+    alias original_apath_to apath_to
+
+    class << self
+      alias original_apath_to apath_to
+    end
+  end
+
+  private
+  module_function def apath_to(path)
+  FileFinder::Finder.get_absolute_path_to(path, Kernel.caller.first.match(/(.*):.*:.*/)[1])
+  end
+end

data/lib/unset_kernel.rb

@@ -0,0 +1,18 @@
+module Kernel
+  if self.respond_to?(:apath_to)
+    remove_method :apath_to
+
+    class << self
+      remove_method :apath_to
+    end
+
+    if self.respond_to?(:original_apath_to)
+      alias apath_to original_apath_to
+
+      class << self
+        alias apath_to original_apath_to
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: file_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Logan Hasson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- logan.hasson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_finder.gemspec
+- lib/file_finder.rb
+- lib/file_finder/configuration.rb
+- lib/file_finder/finder.rb
+- lib/file_finder/version.rb
+- lib/reset_kernel.rb
+- lib/unset_kernel.rb
+- spec/.keep
+homepage: http://github.com/loganhasson/file_finder.git
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Utility for loading support files within gems.
+test_files:
+- spec/.keep