require_dir 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 059b6f8de63b2557966908e76cead3d137642590
-  data.tar.gz: a2c128d3165444e72c23458ae99c63750d1e8213
+SHA256:
+  metadata.gz: 176bbfddf11657c59b8dd1f2254b5b6355fb9c47fa2424ab912148f816c33114
+  data.tar.gz: 557bafbcfee44d9e91fb1da631fd84cc27cbb07f9f7a06054b991557a5779dc4
 SHA512:
-  metadata.gz: 94811d95ef361b928b7c6d8b5fcc40a38a578dd9fc169c7deeb1ee138e27b16b0bdcfd0e649f112193745f0791486c8c2fe4ad531960138080ea29e79c9fa2d3
-  data.tar.gz: a6a5ce85dd1f6165c7a61e458c28b765c2addda65192eacc7433e80d93aedb3d874fa4f691bf22b19690503d836536dac1596036abc03e648f61f5af025e0bcd
+  metadata.gz: 7f8d135050287dfff5a2c49dd05e325578f14d34d456672e70906d7a9ed85d8c2d43f4adee13445e53807167ae3ccf6c755096e2f56c07613203e2e91b9bd346
+  data.tar.gz: 3c0524a4f194f2cb53caadbb44f08e408068362e8278b0c1d7c3ad39192b8336eedaac31e20861310c250eb7c256d7e23d70e09a64dfd8e9c6b493a5ed231f4d

data/.gitignore

@@ -1,3 +1,5 @@
+.idea/
+**/.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -1,10 +1,20 @@
 language: ruby
 env:
-  - CODECLIMATE_REPO_TOKEN=703cb4759e977bdd9502305ae454a0acdf7bd0d51d418e88048110f4735c4a80
+  global:
+    - CODECLIMATE_REPO_TOKEN=703cb4759e977bdd9502305ae454a0acdf7bd0d51d418e88048110f4735c4a80
 rvm:
-  - 2.2.3
-  - 2.3.0
-script: "bundle exec rspec"
+  - 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
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 notifications:
   email:
     recipients:

data/README.md

@@ -3,11 +3,9 @@
 [![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)
 
-<br />
-
-[![Build Status](https://travis-ci.org/kigster/require_dir.svg?branch=master)](https://travis-ci.org/kigster/warp-dir)
-[![Code Climate](https://codeclimate.com/github/kigster/require_dir/badges/gpa.svg)](https://codeclimate.com/githb/kigster/require_dir)
-[![Test Coverage](https://codeclimate.com/github/kigster/require_dir/badges/coverage.svg)](https://codeclimate.com/github/kigster/require_dir/coverage)
+[![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)
 
 
@@ -17,7 +15,7 @@ Unlike other gems, such as `require_all`, this gem does suffer from module clobb
 
 ## Author
 
-This library is the work of [Konstantin Gredeskoul](http:/kig.re), &copy; 2016, distributed under the MIT license.
+This library is the work of [Konstantin Gredeskoul](http:/kig.re), &copy; 2016-2018, distributed under the MIT license.
 
 ## Installation
 
@@ -43,15 +41,17 @@ 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
-  extend RequireDir
-  init __FILE__
+  RequireDir.enable_require_dir!(self, __FILE__)
 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'
+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'
 
 ```
 
+You can also use shorcuts `dir` and `dir_r`, which are equivalent to `require_dir` and  `require_dir_r` respectively.
+
+
 ### Offset
 
 You can optionally load the library using `init_with_offset` method, which allows you 
@@ -66,8 +66,7 @@ be able to later use RequireDir to load files relative to `lib`. This is how you
 require 'require_dir'
 module Mylib
   module SubFolder
-    extend RequireDir
-    init_with_offset(__FILE__, 1)
+    RequireDir.enable_require_dir!(self, __FILE__, 1)
   end
 end
 
@@ -86,8 +85,7 @@ exploded. You can enable debugging output using two methods:
  * Initialize library with options hash, setting:
 
 ```ruby
-  extend RequireDir
-  init __FILE__, debug: true
+  RequireDir.enable_require_dir!(self, __FILE__, 0, debug: true)
 ```
 
 ## Development

data/Rakefile

@@ -1,6 +1,35 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :clean do 
+  shell('rm -rf pkg/ tmp/ coverage/ doc/' )
+end
+
+task :gem => [:build] do
+  shell('gem install pkg/*')
+end
+
+task :permissions => [ :clean ] do 
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+task :build => :permissions
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
+  t.options.unshift('--title','RequireDir')
+  t.after = ->() { exec('open doc/index.html') }
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+

data/lib/require_dir/initializer.rb

@@ -0,0 +1,32 @@
+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 init(source, offset = 0, options = {})
+      project_folder = project_folder_from(source: source, offset: offset)
+      self.loader    = create_loader(options, project_folder)
+    end
+
+    def 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))
+    end
+  end
+end

data/lib/require_dir/loader.rb

@@ -1,5 +1,5 @@
 require 'require_dir/version'
-
+require 'colored2'
 module RequireDir
   #
   # This class is meant to be instantiated per project/library, and then used to load
@@ -8,6 +8,12 @@ module RequireDir
 
     attr_accessor :project_root, :options
 
+    class << self
+      attr_accessor :stderr
+    end
+
+    self.stderr = STDERR
+
     def initialize(root_dir, options = {})
       raise ArgumentError.new("Folder #{root_dir} is not found") unless Dir.exist?(root_dir)
       self.project_root = root_dir
@@ -23,25 +29,36 @@ module RequireDir
       ::Dir.glob(project_root + folder + (recursive ? '/**/*.rb' : '/*.rb') ) do |file|
         puts "Loading #{file}" if debug?
         begin
-          Kernel.require(file)
+          Kernel.require file
         rescue SyntaxError, LoadError => e
-          len = file.length + 6
-          STDERR.puts '—' * len
-          STDERR.puts "⇨  #{file.bold.yellow} ⇦".bold.white
-          STDERR.puts '—' * len
-          STDERR.puts e.message.bold.red
-          STDERR.puts '—' * len
-          STDERR.puts e.backtrace.join("\n").bold.black if e.backtrace && !e.backtrace.empty?
-          exit 1
+          report_error(e, file)
+          raise(e)
         end
       end
-
-
     end
 
     def dir_r(folder)
       dir(folder, true)
     end
 
+    alias require_dir dir
+    alias require_dir_r dir_r
+
+    private
+
+    def report_error(e, file)
+      len = file.length + 6
+      outputs '—' * len
+      outputs "⇨  #{file.bold.yellow} ⇦".bold.white
+      outputs '—' * len
+      outputs e.message.bold.red
+      outputs '—' * len
+      outputs e.backtrace.join("\n").bold.black if e.backtrace && !e.backtrace.empty?
+    end
+
+    def outputs(*args)
+      self.class.stderr.puts(*args) if self.class.stderr
+    end
+
   end
 end

data/lib/require_dir/version.rb

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

data/lib/require_dir.rb

@@ -1,28 +1,34 @@
+require 'forwardable'
+
 require 'require_dir/version'
 require 'require_dir/loader'
-require 'forwardable'
-module RequireDir
-  attr_accessor :loader
+require 'require_dir/initializer'
 
-  def project_folder_from(source: , offset: 0)
-    dirs_up = ''
-    offset.times { dirs_up << '/..' } if offset > 0
-    File.dirname(File.expand_path(source +  dirs_up))
-  end
 
-  def init_with_offset(source, offset = 0, options = {})
-    project_folder = project_folder_from(source: source, offset: offset)
-    self.loader = RequireDir::Loader.new(project_folder, options)
-  end
+#
+# This module should be used to enable directory-wide
+# requiring of dependent ruby files. Recursive is also supported.
+#
+# @example of the usage:
+#
+#        module Foo
+#          class Bar
+#             RequireDir.enable(self, __FILE__)
+#          end
+#        end
+#        Foo::Bar.dir()
+module RequireDir
+  class << self
+    # @deprecated Please use {#enable_require_dir!} instead
+    def included(klass)
+      klass.extend(RequireDir::Initializer)
+      klass.include(RequireDir::Initializer)
+    end
 
-  def init(source, options = {})
-    init_with_offset(source, 0, options)
+    def enable_require_dir!(klass, source_file, offset = 0, **options)
+      klass.extend(RequireDir::Initializer)
+      klass.include(RequireDir::Initializer)
+      klass.init(source_file, offset, options)
+    end
   end
-
-  alias_method :init_from_source, :init_with_offset
-
-  extend Forwardable
-  def_delegators :@loader, :dir, :dir_r
-
-  extend self
 end

data/require_dir.gemspec

@@ -17,8 +17,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = %w(lib)
 
+  spec.add_dependency 'colored2'
+
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.5' 
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: require_dir
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
 description: 'Easily and non-intrusively require files from sub-folders. Without polluting
   global namespace, or having modules clobber each other, include RequireDir and initialize
   it to get access to #dir and #dir_r'
@@ -87,6 +101,7 @@ files:
 - bin/console
 - bin/setup
 - lib/require_dir.rb
+- lib/require_dir/initializer.rb
 - lib/require_dir/loader.rb
 - lib/require_dir/version.rb
 - require_dir.gemspec
@@ -110,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Easily and non-intrusively require files from sub-folders