require_dir 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 176bbfddf11657c59b8dd1f2254b5b6355fb9c47fa2424ab912148f816c33114
-  data.tar.gz: 557bafbcfee44d9e91fb1da631fd84cc27cbb07f9f7a06054b991557a5779dc4
+SHA1:
+  metadata.gz: 2faa13586135684abb096c092fef2daaa002796a
+  data.tar.gz: 1c0d386ce4b9c18e771b78ee0b85d3f64e4c7c72
 SHA512:
-  metadata.gz: 7f8d135050287dfff5a2c49dd05e325578f14d34d456672e70906d7a9ed85d8c2d43f4adee13445e53807167ae3ccf6c755096e2f56c07613203e2e91b9bd346
-  data.tar.gz: 3c0524a4f194f2cb53caadbb44f08e408068362e8278b0c1d7c3ad39192b8336eedaac31e20861310c250eb7c256d7e23d70e09a64dfd8e9c6b493a5ed231f4d
+  metadata.gz: 7f24094cb68704a8c7fe3ef97bf8d281515399c9401ab56aff1e59820ba3d84c862a0eb4aa89fd655760f8f645b6e160faa7b612356db4850a624495e504eea3
+  data.tar.gz: 020ad935bf36cfc904179f7774780f0958d43752af0b0a07b5978e1f52eb94fbe0877b0812628d4c8df193fce4307428f0704ec06dfc79706d5fd0edae0c07f1

data/.travis.yml

@@ -1,23 +1,24 @@
 language: ruby
-env:
-  global:
-    - CODECLIMATE_REPO_TOKEN=703cb4759e977bdd9502305ae454a0acdf7bd0d51d418e88048110f4735c4a80
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+- 2.2.9
+- 2.3.6
+- 2.4.3
+- 2.5.0
 before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
 script:
-  - bundle exec rspec
+- bundle exec rspec
 after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 notifications:
   email:
     recipients:
-      - kigster@gmail.com
+    - kigster@gmail.com
     on_success: change
     on_failure: always
+env:
+  global:
+    secure: KFl7jV0zv/OZ/Hi+IBI8fDaMEfWjbYOZBAmlPZp3N5A1YcHT/7oqGguUgrYWKfBM84CMZOzszKw7yVvzdn6pvate+0nP22hfwCwT6hRly56c/oMLJvm/Sud+hSsL7Aq7lZq3UeuDDUzPcoyCA6h3hqve4RX93w/A5a4yQYE6N8PJbyZwFZ+uf3MvnoyIRTFAW5Rjrk23ieSjBsG8zdIUabYahAGUkm0tZt7SXmEyFi5ghMpY8WFeUl3cwnlhVjYyZ+/qfTdzW1vFhJ11ZObrQPCaMb1te/Wh0/WoUE/ycbUPkxPWEfd7KDThb6x9QVzK28ssIgB1w7VmHpAa9h77vu9UaZvJTcS8Ud/gQaTE00VinEeK/wOA2CgLIcUnK4bjbCeZ+bgMjjKhN1JPJZvx+xsk19IHTT3DuQF+olkPJV3NU4o0ZjRBwbi4tNGuboJiDC+op/WiKDGsdTzSqA3TWNIQZzfVI+x64YcHZ5OjZHC1kNdeKd51kjITRbtp3RAepCeITQMZKLiS66k7tLtqkf8zMdkIUHFCBon5TXlclnVzCwqxtySk4RDOQ0ac0zgot/MnXXhEJkkgd9Qo+51Yd0DBCzkZgJfRWNKCv/MmAyn7K2kq3COfNDoS/C9JEQzFapj3CNdntdCZWHUTwiug0y/DBxSzyRagbwyoVObVBfY=

data/README.md

@@ -1,13 +1,12 @@
-# RequireDir 
-
+[![Build Status](https://travis-ci.org/kigster/require_dir.svg?branch=master)](https://travis-ci.org/kigster/require_dir)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ad8aceb1bb3c22f72194/maintainability)](https://codeclimate.com/github/kigster/require_dir/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ad8aceb1bb3c22f72194/test_coverage)](https://codeclimate.com/github/kigster/require_dir/test_coverage)    
 [![Gem Version](https://badge.fury.io/rb/require_dir.svg)](https://badge.fury.io/rb/require_dir)
 [![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/require_dir?type=total)](https://rubygems.org/gems/require_dir)
 
-[![Build Status](https://travis-ci.org/kigster/require_dir.svg?branch=master)](https://travis-ci.org/kigster/require_dir)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ad8aceb1bb3c22f72194/test_coverage)](https://codeclimate.com/github/kigster/require_dir/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ad8aceb1bb3c22f72194/maintainability)](https://codeclimate.com/github/kigster/require_dir/maintainability)
-[![Issue Count](https://codeclimate.com/github/kigster/require_dir/badges/issue_count.svg)](https://codeclimate.com/github/kigster/require_dir)
+----
 
+# RequireDir 
 
 This gem provides an easy way to require all file from a folder – recursively, or not.
 
@@ -41,37 +40,41 @@ Recommended usage is to include this gem's module into the top level module of y
 # file 'lib/mylib.rb' -- top level file for a gem 'mylib'
 require 'require_dir'
 module Mylib
+  # You must pass __FILE__ so that the library knows the "root" of your sources.
   RequireDir.enable_require_dir!(self, __FILE__)
-end
-
-Mylib.require_dir('mylib/subfolder')   # loads all files in the folder 'lib/mylib/subfolder/*.rb'
-Mylib.require_dir_r('mylib/subfolder') # recursive load from 'lib/mylib/subfolder/**/*.rb'
 
+  dir_r 'mylib/cli'
+  dir   'mylib/commands'
+end
 ```
 
-You can also use shorcuts `dir` and `dir_r`, which are equivalent to `require_dir` and  `require_dir_r` respectively.
+You literally have access to two methods (with aliases):
 
+ * `dir_r` (or `require_dir_r`) loads all ruby files recursively
+ * `dir` (or `require_dir`) loads files non-recursively
 
-### Offset
-
-You can optionally load the library using `init_with_offset` method, which allows you 
-to initialize the library from a file located not directly under lib, but further down below.
 
-Say you want to initialize the library from `lib/mylib/subfolder/mymodule.rb`. But you want to 
-be able to later use RequireDir to load files relative to `lib`. This is how you would do that:
+### Offset
 
+If your library's top required file is not at the very top level of the directory structure, 
+which might happen, if, say you have a gem named `app-foo`, and your primary required file is
+located in `lib/app/foo.rb`, in this case you will need to pass an offset of 1 to the `enable_require_dir!` 
+method to properly initialize recursive loading:
 
 ```ruby
-# file 'lib/mylib/subfolder/mymodule.rb' -- top level file for a gem 'mylib'
+# 'lib/app/foo.rb' 
+# i.e. this file is one level deep in the source tree of this library:
+
 require 'require_dir'
-module Mylib
-  module SubFolder
-    RequireDir.enable_require_dir!(self, __FILE__, 1)
+
+module App
+  module Foo
+    # offset is 1, because the current file is 1 level deep into the source tree.
+    RequireDir.enable_require_dir!(self, __FILE__, 1) 
+
+    dir_r 'app/foo/bar'   # loads all files in the folder 'app/foo/bar/**.rb'
   end
 end
-
-Mylib.dir('mylib/subfolder')   # loads all files in the folder 'lib/mylib/subfolder/*.rb'
-Mylib.dir_r('mylib/subfolder') # recursive load from 'lib/mylib/subfolder/**/*.rb'
 ```
 
 ### Load Errors
@@ -85,7 +88,9 @@ exploded. You can enable debugging output using two methods:
  * Initialize library with options hash, setting:
 
 ```ruby
+module Foo
   RequireDir.enable_require_dir!(self, __FILE__, 0, debug: true)
+end
 ```
 
 ## Development

data/lib/require_dir.rb

@@ -16,19 +16,21 @@ require 'require_dir/initializer'
 #             RequireDir.enable(self, __FILE__)
 #          end
 #        end
-#        Foo::Bar.dir()
+#        Foo::Bar.dir_r 'foo/bar/commands' # loads all 'foo/bar/commands/**.rb' files
+#        Foo::Bar.dir_r 'foo/bar/commands' # loads all 'foo/bar/commands/*.rb' files
+#
 module RequireDir
   class << self
     # @deprecated Please use {#enable_require_dir!} instead
     def included(klass)
-      klass.extend(RequireDir::Initializer)
-      klass.include(RequireDir::Initializer)
+      klass.send(:extend, RequireDir::Initializer)
+      klass.send(:include, RequireDir::Initializer)
     end
 
     def enable_require_dir!(klass, source_file, offset = 0, **options)
-      klass.extend(RequireDir::Initializer)
-      klass.include(RequireDir::Initializer)
-      klass.init(source_file, offset, options)
+      klass.send(:extend, RequireDir::Initializer)
+      klass.send(:include, RequireDir::Initializer)
+      klass.send(:__require_dir_init, source_file, offset, options)
     end
   end
 end

data/lib/require_dir/initializer.rb

@@ -1,32 +1,29 @@
 require 'forwardable'
 module RequireDir
   module Initializer
-    attr_accessor :loader
-    class << self
-      def included(base)
-        base.instance_eval do
-          class << self
-            attr_accessor :loader
-            extend Forwardable
-            def_delegators :@loader, :dir, :dir_r, :require_dir, :require_dir_r
-          end
-        end
-      end
-    end
+    def self.included(base)
+      base.instance_eval do
+        class << self
+          attr_accessor :__require_dir_loader
+          extend Forwardable
+          def_delegators :@__require_dir_loader, :dir, :dir_r, :require_dir, :require_dir_r
 
-    def init(source, offset = 0, options = {})
-      project_folder = project_folder_from(source: source, offset: offset)
-      self.loader    = create_loader(options, project_folder)
-    end
+          def __require_dir_init(source, offset = 0, options = {})
+            project_folder            = __require_dir_project_folder(source: source, offset: offset)
+            self.__require_dir_loader = __require_dir_create_loader(options, project_folder)
+          end
 
-    def create_loader(options, project_folder)
-      RequireDir::Loader.new(project_folder, options)
-    end
+          def __require_dir_create_loader(options, project_folder)
+            RequireDir::Loader.new(project_folder, options)
+          end
 
-    def project_folder_from(source:, offset: 0)
-      dirs_up = ''
-      offset.times { dirs_up << '/..' } if offset > 0
-      File.dirname(File.expand_path(source + dirs_up))
+          def __require_dir_project_folder(source:, offset: 0)
+            dirs_up = ''
+            offset.times { dirs_up << '/..' } if offset > 0
+            File.dirname(File.expand_path(source + dirs_up))
+          end
+        end
+      end
     end
   end
 end

data/lib/require_dir/version.rb

@@ -1,3 +1,3 @@
 module RequireDir
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: require_dir
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Easily and non-intrusively require files from sub-folders