load_path 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTg3NWQ4MDBjNzYwY2ZiNjU0ZTE3YWJmMmUwODE2MDQzNDBhOGMxOA==
+  data.tar.gz: !binary |-
+    MjJhOGZkMDJiNWE4MmExZjY5NDlmZWRkNGFmMTdhMzFlNDNiNTRlOA==
+SHA512:
+  metadata.gz: !binary |-
+    MmUyNjYxNGQxYzI5MGY5YzRjZDA5N2RiYjk5Njc2MzI5ZjQ5NTNlNDBjZjVk
+    NzgyYzZhMjIxYjUzODlmZTUxODk1MjgxMGI5MWFiYjE1YzRjZjFhZjRmNmIw
+    ODMwZThiOWRhMTAxZDc3Yzc1MDRiMjcxNjk2MGU1NGQ5MDAxYmY=
+  data.tar.gz: !binary |-
+    ZTA5OGNiYmVjYWZkYzFhYzQwOGFhMWE1ZTgyZTUzZWQwNDk3M2QyZTJkMTJk
+    YTM4N2QyMjRmNGQ3NWZjNWJlM2MyMTNjZDVkNTA0OWViODE2YjI3MjU5MzJj
+    YmUzZWMzNjYxYWU0OGU2ZmM4Njg1NDQyN2ZhODc2ZWRhNjE1MDY=

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+#### 0.0.1
+  * Ability to configure load path and require files
+
+#### 0.1.0
+  * Adds a `PathHelper` and `PathBuilder` class for constructing paths.
+
+#### 0.2.0
+  * Adds default option of blank to file_path. The way the calling class is inferred is changed and alot of bug fixes gone into the configure block.
+

data/README.md

@@ -1,6 +1,6 @@
 # <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. 
+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.
 
 ===================
 
@@ -8,45 +8,50 @@ This gem is written to make it easy to configure the load path in Ruby files. Si
 
 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
+### Building
 
 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: 
+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
+#Add the folder `lib` 2 levels above
 lib_dir  = File.join(this_dir,  '..', '..', 'lib')
 $: << lib_dir
 
-#Add the folder utils to load path
+#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
+#Add the folder `others` under this directory to load path
 others_dir = File.join(this_dir, 'others')
 $: << others_dir
 
+#Add the folder `bin` on the same level as `lib` folder
+bin_dir = File.join(this_dir, '..', '..', 'bin')
+
 ```
 
-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: 
+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`
+require 'load_path'
 
-LoadPath.configure do 
+LoadPath.configure do
    add parent_directory('lib', up: 2)
    add sibling_directory('utils')
    add child_directory('others')
+   add path_buider { parent_directory('lib', up: 2).sibling_directory('bin') }
 end
  ```
- 
+Notice the use of the `path_builder` block. This is required if you wish you chain paths together.
+
 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:
@@ -55,11 +60,13 @@ The configure block also lets you require your files in bulk. For example to req
  Dir.glob(File.join(this_dir, '..', '..', 'lib', '*.rb')) do |file|
    require File.basename(file)
  end
-``` 
+```
 
 Which can be made cleaner with:
 
 ```
+require 'load_path'
+
 LoadPath.configure do
   add parent_directory('lib', up: 2)
   add sibling_directory('utils')
@@ -69,8 +76,19 @@ LoadPath.configure do
   require_all sibling_directory('utils')
 end
 ```
+
+There is also a `PathBuilder` class to help you construct paths in your code. Here is how the class can be used:
+
+```
+require 'path_builder'
+
+path_builder = LoadPath::PathBuilder.new('.')
+config_file = path_builder.child_directory('config').file_path('config.yml')
+
+```
+
 ### Examples
 
-See also the example under Rspec tests with directory structure:
+See also the example under tests directory. The following file system structure is used by the test:
 
-<img src="https://github.va.opower.it/nayyara-samuel/load-path/raw/master/img/test_case.png" height="250">
+<img src="https://github.com/nayyara84/load-path/blob/master/img/test_case.png?raw=true" height="250">

data/lib/load_path.rb

@@ -1,3 +1,4 @@
+require 'path_builder'
 #
 # 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
@@ -20,7 +21,7 @@ module LoadPath
   # 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/ }
+    configure_call_index = call_stack.index { |call| call =~ /#{me}.*\:in.*configure/ }
     external_call = call_stack[configure_call_index + 1]
     begin
       external_file_name = (external_call.match /(.*):\d+:in/)[1]
@@ -32,18 +33,12 @@ module LoadPath
   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
+  class LoadPathSetup < PathHelper
 
     # 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)
+        require File.basename(file.to_s)
       end
     end
 
@@ -52,21 +47,12 @@ module LoadPath
       $: << 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)
+    def path_builder(&block)
+      builder = LoadPath::PathBuilder.new(self.file_path)
+      builder.instance_eval(&block)
+      builder.file_path
     end
   end
 
-end
+end
+

data/lib/path_builder.rb

@@ -0,0 +1,75 @@
+#
+# A helper for building path on the file system
+# Author: Nayyara Samuel (nayyara.samuel@opower.com)
+#
+module LoadPath
+  class PathHelper
+    attr_accessor :root_dir
+
+    # Construct with a root
+    def initialize(root_dir, expand_path=false)
+      if (expand_path)
+        @root_dir = File.expand_path(root_dir)
+      else
+        @root_dir = root_dir
+      end
+    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
+
+    def file_path(file_name=nil)
+      if (file_name)
+        File.join(root_dir, file_name)
+      else
+        root_dir
+      end
+    end
+  end
+
+# Builder for path helper
+  class PathBuilder
+    attr_accessor :path_helper
+
+    def initialize(root_dir, expand_path=false)
+      @path_helper = PathHelper.new(root_dir, expand_path)
+    end
+
+    def parent_directory(*args)
+      @path_helper = PathHelper.new(@path_helper.parent_directory(*args))
+      self
+    end
+
+    def child_directory(*args)
+      @path_helper = PathHelper.new(@path_helper.child_directory(*args))
+      self
+    end
+
+    def sibling_directory(*args)
+      @path_helper = PathHelper.new(@path_helper.sibling_directory(*args))
+      self
+    end
+
+    def file_path(file_name=nil)
+      @path_helper.file_path(file_name)
+    end
+
+    def to_s
+      file_path
+    end
+  end
+
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: load_path
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Nayyara Samuel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: nayyara.samuel@opower.com
@@ -19,11 +18,14 @@ extra_rdoc_files:
 - README.md
 files:
 - lib/load_path.rb
+- lib/path_builder.rb
+- CHANGELOG.md
 - Gemfile
 - Rakefile
 - README.md
 homepage: https://github.com/nayyara84/load-path
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --title
@@ -35,21 +37,19 @@ 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
+rubygems_version: 2.1.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cleaner way to setup your load path
 test_files: []