requires 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f35e16c778fa287257e4ea4b2bbaab9b38f02e56c54b21fe9e85045ead97e2
-  data.tar.gz: 3a744da142ac5de0a32f44504a3459c1111cf4e6b11a0cf3f6de9745b33872d7
+  metadata.gz: 1b0b0f2f8e0b604e3f3061b95a695fe537a0c7286c2d4cfea8a27578ec828019
+  data.tar.gz: 60ecc91cb37fb1a90baaed74fcc911f7644cb6195fab02279a39e1608b6dada7
 SHA512:
-  metadata.gz: e7f8e780f10352145323af0e402935d12ddb31b7a335fcb8ecc4e63d76f40118a53a6d1cd0127edb5aa9d9bdfef39bc20e3589b5e6bf9905b5d4d7d095e5321b
-  data.tar.gz: 7d4aa0fb6adcf3bf6725d2b78d2798326e3ba0de6ca83ce155a376348bb56c23efd2d163ed948a068f9b44e0dfe39ba2a5db9090c4958449aa14c7e26446a254
+  metadata.gz: 4d58d1cb6fe90169fe7fae10fac2a7c5c7af8394544b21d3b488d6277012f00dc85e8dee880a1d49c3ac826e144be237bb5cf2d46bbb11953f6e4eb54d11a6af
+  data.tar.gz: 5af9b748b2bff2349b798e9cc60f2ad43eee55c546dc93b9bc0089b5ce1073fc832c87bb1e15e040d24d1de0392ddf794c02bb89da0936d9e728a2734e2138dc

data/README.md

@@ -1,35 +1,57 @@
-Requires
-==================================================
+# Requires
 
 [![Gem Version](https://badge.fury.io/rb/requires.svg)](https://badge.fury.io/rb/requires)
-[![Build Status](https://travis-ci.com/DannyBen/requires.svg?branch=master)](https://travis-ci.com/DannyBen/requires)
+[![Build Status](https://github.com/DannyBen/requires/workflows/Test/badge.svg)](https://github.com/DannyBen/requires/actions?query=workflow%3ATest)
 
-**Requires** is ruby's missing `require` function.
+A tiny convenience function to require or autoload all ruby files in a directory.
 
-It lets you...
+## Install
 
-```ruby
-# ...require multiple files
-requires 'any_file', 'with/or/without/extension.rb'
+```bash
+$ gem install requires
+```
+
+## Usage
 
-# ...require directories
-requires 'first/directory', 'second-directory'
+### `requires`
 
-# ...require with a glob
-requires 'base_*', 'directory/*_base'
+```ruby
+# Require a directory (recursively)
+require 'requires'
+requires 'lib'
+
+# Individual files can also be loaded (with or without extension)
+requires 'lib/base'
+requires 'lib/base.rb'
 
-# ...require any other library
-requires 'yaml', 'lib/important', 'lib'
+# ...as well as external gems or built in libraries
+requires 'yaml'
 ```
 
-Everything is relative to where `requires` is called from.
+All paths are relative to the location of the file that calls `requires`.
 
----
+### `autoloads`
 
+Autoload en masse, with paths relative to the one calling `autuoloads`.
 
-Installation
---------------------------------------------------
+```ruby
+require 'requires'
+autoloads 'lib', %i[Asset SomeAPI HTTPClient]
+```
 
-    $ gem install requires
+which is equivalent to these native autoload statements:
 
+```ruby
+autoload :Asset, './lib/asset'
+autoload :SomeAPI, './lib/some_api'
+autoload :HTTPClient, './lib/HTTPClient'
+```
 
+In case you wish to autoload from the same directory, you can omit the first
+argument:
+
+```ruby
+autoloads %i[Asset SomeAPI HTTPClient]
+# which is the same as
+# autoloads '.', %i[Asset SomeAPI HTTPClient]
+```

data/lib/requires/version.rb

@@ -0,0 +1 @@
+VERSION = '1.1.0'

data/lib/requires.rb

@@ -1,21 +1,38 @@
-def requires(*items)
-  items = ['.'] if items.empty?
-
-  calling_script = caller.first.sub(/:\d+.*/, '')
-  base_dir = File.dirname calling_script
-
-  Dir.chdir base_dir do
-    items.each do |item|
-      if item.include? '*'
-        item += ".rb" unless item.end_with? '.rb'
-        Dir["#{item}"].sort.each { |file| require "./#{file}" }
-      elsif File.directory? item
-        Dir["#{item}/**/*.rb"].sort.each { |file| require "./#{file}" }
-      elsif File.file? "#{item}.rb" or File.file? item
-        require "./#{item}"
-      else
-        require item
-      end
+def requires(item)
+  base_path = caller_locations(1..1).first.path
+  base_dir = File.dirname base_path
+  path = File.expand_path item, base_dir
+
+  if File.directory? path
+    Dir["#{path}/**/*.rb"].each do |file|
+      require file
     end
+
+  elsif File.file?("#{path}.rb") || File.file?(path.to_s)
+    require path
+
+  else
+    require item
+
+  end
+end
+
+def autoloads(base, symbols = nil)
+  unless symbols
+    symbols = base
+    base = '.'
+  end
+
+  base_path = caller_locations(1..1).first.path
+  base_dir = File.dirname base_path
+  path = File.expand_path base, base_dir
+
+  symbols.each do |symbol|
+    file = symbol.to_s
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2') # Break consecutive uppercase letters before the last capital
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')     # Break lowercase or digits before an uppercase letter
+      .downcase
+
+    autoload symbol, "#{path}/#{file}"
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: requires
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2024-07-26 00:00:00.000000000 Z
 dependencies: []
-description: A simple gem to require them all!
+description: Adds functions that allow requiring a direcotry
 email: db@dannyben.com
 executables: []
 extensions: []
@@ -18,11 +18,17 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/requires.rb
+- lib/requires/version.rb
 homepage: https://github.com/dannyben/requires
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/requires/issues
+  changelog_uri: https://github.com/DannyBen/requires/blob/master/CHANGELOG.md
+  homepage_uri: https://requires.dannyb.co/
+  source_code_uri: https://github.com/DannyBen/requires
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -30,15 +36,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
-summary: Ruby's missing require function
+summary: Require all files in a directory
 test_files: []