require_relative_dir 0.9.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff708f5f44cfb5ee7fcd2bb5af8b7ba8719eb6d2025e2269b3260d383cfc4461
-  data.tar.gz: 6828d1ddd8e36226ceaaff20e9f1bc5b17afd783b3afd2f1681a10be1da86ab5
+  metadata.gz: dc2c0b7e0c3e204cce27a38f26147a277dc70a9f3dc5cccf61bd095db32a6600
+  data.tar.gz: f52022c23ec705627cf213d13d837c342dc6733e5122ddbaa089b28b263d0cd9
 SHA512:
-  metadata.gz: 7947d10e90172fbda933c54d18247538504b7f29e78786f979c3764680de1b393068da3999f652cf2cc17ba053d4848b52fde8143c3147d0c438995c79483a8c
-  data.tar.gz: ea50beea10bb927a8becafcda0555d810a7c95b976e02fea0dd2edb7f9a5757fd89bc973b5948e6d4c4b6518403b3b4b219cebeec47e993e28b23e53a623918e
+  metadata.gz: 2cab7b31b54641a231ab3985883a8b095a2f125444c22ba193f3ebf79bba5e43980a5abe07c469f56aaf14fe0480a67264a27a6a232a5c528d5d020170961af3
+  data.tar.gz: 15af8406a2a364e64830f9e8e4f5ec73d17b38e50412fbbccfac6f5b5788c9c12bfc5a5196f268645033b159fec8e506e4351b2822263068d474091fa31cd3cf

data/.github/workflows/require_relative_dir.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on: [pull_request]
+
+jobs:
+  tests:
+    name: >-
+      Specs | ${{ matrix.ruby }} (${{ matrix.usage }})
+    runs-on: ${{ matrix.os }}-latest
+    env:
+      # See https://github.com/tmm1/test-queue#environment-variables
+      TEST_QUEUE_WORKERS: 2
+      USAGE: ${{ matrix.usage }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu ]
+        ruby: [ 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, head ]
+        usage: [ modern, legacy ]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: install dependencies
+        run: bundle install --jobs 3 --retry 3
+      - name: spec
+        run:  bundle exec rake
+  internal_investigation:
+    name: >-
+      Coding Style
+    runs-on: ${{ matrix.os }}-latest
+    env:
+      TEST_QUEUE_WORKERS: 2
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu ]
+        ruby: [ 2.7 ]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: install dependencies
+        run: bundle install --jobs 3 --retry 3
+      - name: internal investigation
+        run: bundle exec rubocop

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+Gemfile.lock
+
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+# For sure
+
+Layout/LineLength:
+  Max: 150
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/MultilineBlockLayout:
+  Enabled: false
+Layout/BlockEndNewline:
+  Enabled: false
+
+# Experiment
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+
+
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyleForEmptyBraces: no_space

data/Gemfile

@@ -1,6 +1,13 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop', require: false
 
 # Specify your gem's dependencies in require_relative_dir.gemspec
 gemspec

data/README.md

@@ -1,10 +1,38 @@
 # RequireRelativeDir
 
-Simple utility to `require` all Ruby files in a given directory.
+Simple utility to `require_relative` all Ruby files in a given directory.
 
 ## Usage
 
+```ruby
+# lib/your_gem_or_app.rb
+require 'require_relative_dir'
+
+using RequireRelativeDir
+
+require_relative_dir # or pass 'your_gem_or_app' to be more explicit
+
+# lib/your_gem_or_app/whatever.rb
+
+require 'some_gem'
+require 'some_other_gem'
+
+using RequireRelativeDir
+
+require_relative_dir 'concerns'  # requires all of 'your_gem_or_app/concerns/'
+require_relative_dir 'utils', except: 'big_and_unused_for_now'
+
+class Whatever
+  # ...
+end
 ```
+
+### Legacy usage
+
+While the above usage with `using` is the recommended way, the method `require_relative_dir`
+is also avaible with `extend RequireRelativeDir`. For example:
+
+```ruby
 # lib/your_gem_or_app.rb
 require 'require_relative_dir'
 
@@ -43,8 +71,9 @@ gem 'require_relative_dir'
 
 And then execute:
 
-    $ bundle
-
+```sh
+$ bundle
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "require_relative_dir"
+require 'bundler/setup'
+require 'require_relative_dir'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "require_relative_dir"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/require_relative_dir.rb

@@ -1,4 +1,6 @@
-require "require_relative_dir/version"
+# frozen_string_literal: true
+
+require 'require_relative_dir/version'
 
 module RequireRelativeDir
   SAME_AS_CALLER_NAME = Object.new
@@ -9,14 +11,20 @@ module RequireRelativeDir
     base_path = File.dirname(caller_path)
     path = File.expand_path("#{base_path}/#{dir_name}")
     raise LoadError, "Directory '#{path}' not found" unless Dir.exist?(path)
+
     paths = Dir["#{path}/*.rb"].sort
     paths = RequireRelativeDir.remove_exceptions(paths, except) if except
     paths.each { |file| require file }
   end
 
+  refine Object do
+    include RequireRelativeDir
+    private :require_relative_dir
+  end
+
   extend self
 
-  private
+  # @api private
   def self.remove_exceptions(paths, except)
     except = Array(except).map(&:to_s)
     except.map! { |exception| File.extname(exception) == '.rb' ? exception[0...-3] : exception }

data/lib/require_relative_dir/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RequireRelativeDir
-  VERSION = "0.9.9"
+  VERSION = '1.0.0'
 end

data/require_relative_dir.gemspec

@@ -1,28 +1,27 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "require_relative_dir/version"
+require 'require_relative_dir/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "require_relative_dir"
+  spec.name          = 'require_relative_dir'
   spec.version       = RequireRelativeDir::VERSION
-  spec.authors       = ["Marc-Andre Lafortune"]
-  spec.email         = ["github@marc-andre.ca"]
+  spec.authors       = ['Marc-Andre Lafortune']
+  spec.email         = ['github@marc-andre.ca']
 
-  spec.summary       = %q{Basic utility to require a directory.}
-  spec.description   = %q{Basic utility to require a directory.}
-  spec.homepage      = "https://github.com/marcandre/require_relative_dir"
-  spec.license       = "MIT"
+  spec.summary       = 'Basic utility to require a directory.'
+  spec.description   = 'Basic utility to require a directory.'
+  spec.homepage      = 'https://github.com/marcandre/require_relative_dir'
+  spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '> 2.1.0'
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: require_relative_dir
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Marc-Andre Lafortune
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2020-11-09 00:00:00.000000000 Z
+dependencies: []
 description: Basic utility to require a directory.
 email:
 - github@marc-andre.ca
@@ -59,11 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/require_relative_dir.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -76,24 +34,23 @@ homepage: https://github.com/marcandre/require_relative_dir
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Basic utility to require a directory.
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-  - 2.4.1
-  - 2.3.4
-  - 2.2.7
-  - 2.1.10
-  - ruby-head
-before_install: gem install bundler -v 1.16.2

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    require_relative_dir (0.9.9)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  require_relative_dir!
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.4