autorequire_rails 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4c7834e6fa2af64dcafc6f3ad709a86212b73c094e6f05b3ad44b6c05d448de
+  data.tar.gz: 1c3b731ad8bad5eb2023f74049b32556c4037c343a3d4225aca66432ef902407
+SHA512:
+  metadata.gz: cf30992f767bd170fe037c0920d23c2ac4213a77942483d1914abcb81a081db8e2e1230778d1cff0fd95aeff8a7f970039e8277fb927f6c2cd316314a4317032
+  data.tar.gz: e5f3e57e6ed1fd04ac797b183c73d8692f086ecb33acd40768bd35d306046647e16bedad796178f220825e9b46485e3cfc0e2e8807ef2c812712ec5ddf68f9f1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/dummy/db/*.sqlite3
+/spec/dummy/db/*.sqlite3-journal
+/spec/dummy/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require rails_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - spec/dummy/db/schema.rb
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 130
+
+Style/StderrPuts:
+  Exclude:
+    - spec/dummy/bin/yarn
+
+Style/MixinUsage:
+  Exclude:
+    - spec/dummy/bin/setup
+    - spec/dummy/bin/update

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## 1.0.2 (Jan 08, 2018)
+
+1. Publish a new version to replace the two earlier versions that were yanked from Rubygems.
+
+## 1.0.1 (Jan 08, 2018)
+
+1. Polish the gem and add automated tests.  (Issue #3)
+1. Reduce rubocop violations to 0.  (Issue #6)
+
+## 1.0.0 (Jan 07, 2018)
+
+1. Autorequire all files in `lib/autorequire` via an initializer.  (Issue #1)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autorequire_rails.gemspec
+gemspec
+
+group :development, :test do
+  gem 'bootsnap', require: false
+  gem 'puma', '~> 3.7'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robert Soly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# autorequire_rails
+
+autorequire_rails is a Rails engine that automatically requires all ruby files in `lib/autorequire` when a Rails app boots.
+
+Why is this useful?  Rails has multiple strategies for loading code and there are some scenarios that can cause Rails to ignore files in `lib`.  One example where this frequently arises is when trying to monkey patch a core ruby class.  Many people create a file like `lib/string.rb` and expect Rails to autoload or eagerload it.  However, out of the box, Rails isn't configured to reach into `lib` so the code won't get loaded .  On top of that, even if Rails were configured to look in `lib`, it still wouldn't work.  Constants, like the `String` constant, are always defined so Rails never thinks it needs to go looking for additional files to load.
+
+To solve these kinds of problems, you typically have to explicitly require files on your own.  autorequire_rails saves you the trouble and establishes a pattern.
+
+## Versioning Scheme
+
+This gem uses [semver](http:/semver.org).
+
+## Supported Rails Versions
+
+Rails 4+.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'autorequire_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add any file with a .rb extension to the `lib/autorequire` folder (or a sub folder).  Rails will automatically load it during the boot process.
+
+## Recommendations
+
+#### Recommended Folder Stricture
+
+You can use any folder structure you like, but we recommend putting extensions to ruby core classes in `lib/autorequire/core_ext` and extensions to gems in a folder like `lib/autorequire/gem_ext/<gem name here>`.
+
+#### What to Put in lib/autorequire
+
+Ultimately, `lib/autorequire` is useful for adding code **to constants that are already defined**.  As a result, it's ideal for changes to 3rd party libraries and ruby core classes/modules.  It can also be great place to hold reusable code that can be shared between applications.
+
+If you're defining **application specific** custom classes and modules, consider using a sub folder inside `app`.  If you're defining a new constant (and the file name follow proper Rails naming rules), Rails will happily discover it when needed.  `app/lib` is a sensible place to hold these kind of classes and modules.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/corlewsolutions/format_restricter_rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec "pry -r autorequire_rails -I ./lib"
+  # exec "irb -r autorequire_rails -I ./lib"
+end

data/autorequire_rails.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autorequire_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autorequire_rails"
+  spec.version       = AutorequireRails::VERSION
+  spec.authors       = ["roberts1000"]
+  spec.email         = ["roberts@corlewsolutions.com"]
+
+  spec.summary       = "A Rails engine that requires all ruby files in lib/autorequire when a Rails app boots."
+  spec.description   = "A Rails engine that requires all ruby files in lib/autorequire when a Rails app boots."
+  spec.homepage      = "https://github.com/corlewsolutions/autorequire_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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 "pry", "~> 0.11.3"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.7.2"
+  spec.add_development_dependency "sass-rails", "~> 5.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.11"
+
+  spec.add_dependency "rails", ">= 4"
+end

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "autorequire_rails"
+
+# 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.
+
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/rails

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/autorequire_rails/engine', __FILE__)
+APP_PATH = File.expand_path('../../spec/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/initializers/gem_autorequire_rails.rb

@@ -0,0 +1,11 @@
+# Automatically require all .rb files in the lib/autorequire directory.  This directory holds any
+# files that should be loaded, but are unabled to be autoloaded by Rails (like extensions to core
+# classes/modules and other monkey patches to already loaded constants).
+#
+# Why is this necessary?  Consider the situation where you would like to add a method to the String class
+# inside a lib/core_ext/string.rb file. Rails has an autoloading feature, but it only kicks-in when a
+# constant is missing.  Since the String constant is always present, rails will never attempt to autoload it
+# and any methods defined in string.rb will never be loaded.  The general solution to this problem is to
+# manually require files that extend core classes inside an initializer.  The autorequire pattern takes this
+# a step farther by giving us a place to automatically require any .rb file.
+Dir.glob(Rails.root.join('lib', 'autorequire', '**', '*.rb')).each { |f| require f }

data/lib/autorequire_rails.rb

@@ -0,0 +1,13 @@
+require "rails"
+require "autorequire_rails/version"
+require "autorequire_rails/engine"
+
+# Setup pry for development when running "rake console". Guard against load
+# errors in production (since pry is only loaded as a DEVELOPMENT dependency
+# in the .gemspec)
+# rubocop:disable Lint/HandleExceptions
+begin
+  require "pry"
+rescue LoadError
+end
+# rubocop:enable Lint/HandleExceptions

data/lib/autorequire_rails/engine.rb

@@ -0,0 +1,4 @@
+module AutorequireRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/autorequire_rails/version.rb

@@ -0,0 +1,3 @@
+module AutorequireRails
+  VERSION = "1.0.2".freeze
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: autorequire_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- roberts1000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-08 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: A Rails engine that requires all ruby files in lib/autorequire when a
+  Rails app boots.
+email:
+- roberts@corlewsolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- autorequire_rails.gemspec
+- bin/console
+- bin/rails
+- bin/setup
+- config/initializers/gem_autorequire_rails.rb
+- lib/autorequire_rails.rb
+- lib/autorequire_rails/engine.rb
+- lib/autorequire_rails/version.rb
+homepage: https://github.com/corlewsolutions/autorequire_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: A Rails engine that requires all ruby files in lib/autorequire when a Rails
+  app boots.
+test_files: []