load_path 0.0.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,76 @@
+# <img src="https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcRb1vaCQj_2gIgEdX5Fly1vMjfbFKYkuLW1P5c4-3dcFyQ3OqgZoTiOto_8" height="50"> Load Path
+
+This gem is written to make it easy to configure the load path in Ruby files. Simple use a *configure* block to setup your load path without ugly code to interact with the file system. 
+
+===================
+
+### Contributing
+
+For questions and to report bugs, <nayyara.samuel@opower.com>. For contributing to code, send a pull request with a detailed description of changes to this repo.
+
+### Installing
+
+To build the gem use the rake commands for gem tasks. To install:
+
+	rake install
+
+### Usage
+If you have been programming Ruby you will notice that `require_relative` is not encouraged. 
+The alternative is to setup your load path with code that looks something like the following: 
+
+```
+this_dir = File.dirname(__FILE__)
+
+#Add the folder lib 2 levels above
+lib_dir  = File.join(this_dir,  '..', '..', 'lib')
+$: << lib_dir
+
+#Add the folder utils to load path
+utils_dir  = File.join(this_dir,  '..', 'utils')
+$: << utils_dir
+
+#Add the folder others under this directory to load path
+others_dir = File.join(this_dir, 'others')
+$: << others_dir
+
+```
+
+And so forth. You can make the code look nicer but the line `$: << some_directory` looks ugly. With **LoadPath** your code looks something like this: 
+
+```
+require 'load_path`
+
+LoadPath.configure do 
+   add parent_directory('lib', up: 2)
+   add sibling_directory('utils')
+   add child_directory('others')
+end
+ ```
+ 
+You can then proceed to require the files with `require` instead of `require_relative` as normal. **NOTE**: You must first have the desired directory on the load path before requiring files from it.
+
+The configure block also lets you require your files in bulk. For example to require all files in the lib folder 2 levels above, you would write code like this:
+
+```
+ Dir.glob(File.join(this_dir, '..', '..', 'lib', '*.rb')) do |file|
+   require File.basename(file)
+ end
+``` 
+
+Which can be made cleaner with:
+
+```
+LoadPath.configure do
+  add parent_directory('lib', up: 2)
+  add sibling_directory('utils')
+
+  require_all parent_directory('lib', up: 2), '*.rb'
+  # Default is '*.rb', so missing second option works for Ruby source files
+  require_all sibling_directory('utils')
+end
+```
+### Examples
+
+See also the example under Rspec tests with directory structure:
+
+<img src="https://github.va.opower.it/nayyara-samuel/load-path/raw/master/img/test_case.png" height="250">

data/Rakefile

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

data/lib/load_path.rb

@@ -0,0 +1,72 @@
+#
+# This module makes the setting up of the load path for Ruby projects easy
+# by the use of a simple configure() block. Also your statements to setup the load path
+# look cleaner and clearer
+#
+# See the README.md file for detailed examples.
+#
+# Author: Nayyara Samuel (nayyara.samuel@opower.com)
+#
+module LoadPath
+
+  # Primary method to setup your load path
+  def self.configure(&block)
+    root = calling_class_path(caller(0))
+    # Evaluate the block on an instance of the load path setup
+    # that understand the files required
+    LoadPathSetup.new(root).instance_eval(&block)
+  end
+
+  # Construct the file location/path of the file that is using this module
+  def self.calling_class_path(call_stack)
+    me = __FILE__
+    configure_call_index = call_stack.rindex { |call| call =~ /#{me}.*\:in.*configure/ }
+    external_call = call_stack[configure_call_index + 1]
+    begin
+      external_file_name = (external_call.match /(.*):\d+:in/)[1]
+      external_file_directory = File.expand_path(File.dirname(external_file_name))
+    rescue
+      raise "Cannot infer calling file's name from #{external_call}"
+    end
+    return external_file_directory
+  end
+
+  # Helper class to setup the load path
+  class LoadPathSetup
+    attr_accessor :root_dir
+
+    # Construct with a root
+    def initialize(root_dir)
+      @root_dir = root_dir
+    end
+
+    # Require all files matching the pattern in the directory
+    def require_files(directory, file_pattern='*.rb')
+      Dir.glob(File.join(directory, file_pattern)) do |file|
+        require File.basename(file)
+      end
+    end
+
+    # Add the given directory to the load path
+    def add(directory)
+      $: << directory
+    end
+
+    # Construct a parent relative to the root by name
+    def parent_directory(directory_name, levels_up={up: 1})
+      levels_up = levels_up[:up].to_i + 1
+      File.join(root_dir, levels_up.times.map { |_| '..' }, directory_name)
+    end
+
+    # Construct a child relative to the root by name
+    def child_directory(*directory_list)
+      File.join(root_dir, directory_list)
+    end
+
+    # Construct a sibling relative to the root by name
+    def sibling_directory(directory_name)
+      parent_directory(directory_name, up: 0)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: load_path
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nayyara Samuel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: nayyara.samuel@opower.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/load_path.rb
+- Gemfile
+- Rakefile
+- README.md
+homepage: https://github.com/nayyara84/load-path
+licenses: []
+post_install_message: 
+rdoc_options:
+- --title
+- load_path
+- --main
+- README.md
+- -ri
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cleaner way to setup your load path
+test_files: []