initialize 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6712de1db3bb91c900565cde1abb7526d07592b5
-  data.tar.gz: f389a3c4d4d84405de180fd29ec5e4a537965f7e
+  metadata.gz: 76d6a733de9590fbac166f9075124a940d360a3b
+  data.tar.gz: 56f1dac5bf848004a360a77397d32a439419dc0e
 SHA512:
-  metadata.gz: 7bafee335baec4d480e04a3d670c978149145df5cc5575c19fbe96229f1cede0d295f5f752f15d4b6f9617dcc71e4ab0520ee4c88a9d50b044663792a5ebfaaa
-  data.tar.gz: b342b6c542f1d56c858f6953f5936efddd435da727f0c8e13fae86639275cc1f9496f0f15d853ec8a357f537b41bd74380520d1150de071e570fdbd513bb3a41
+  metadata.gz: 10bb0fefc26a6f733dca5f0a4c6e56d074c36d0599539ed0ac416c62f48c456909e8ee7f4917f34358b972ff5d120bf11c5ca263cc12bd5194f4bf6864732a1b
+  data.tar.gz: 5b38cda7cd43d0e347b1a0bd9f89137e09840104eaeb0b81d8d81612ae01079ad0ca25b8ed2ef1840846a7c05ee60e9686bf2456c0046a6a416e32cfb5c863aa

data/README.md

@@ -1,10 +1,10 @@
 # initialize [![Gem version](http://img.shields.io/gem/v/initialize.svg?style=flat-square)](http://rubygems.org/gems/initialize)
 
-Ruby gem.
+Ruby gem to completely customize the execution order of Rails config initializers.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'initialize'
@@ -15,3 +15,73 @@ And then execute:
 ```bash
 $ bundle install
 ```
+
+## Usage
+
+For example, say you have the following Ruby on Rails application:
+
+```
+├── app
+├── bin
+├── config
+│   ├── environments
+│   ├── initializers
+│   │   ├── assets.rb
+│   │   ├── backtrace_silencers.rb
+│   │   ├── configure_rollbar.rb
+│   │   ├── filter_parameter_logging.rb
+│   │   ├── inflections.rb
+│   │   ├── init_hub_settings.rb
+│   │   ├── load_extensions.rb
+│   │   ├── mime_types.rb
+│   │   ├── schedule_app_launches.rb
+│   │   ├── schedule_app_upgrades.rb
+│   │   ├── schedule_hub_upgrades.rb
+│   │   ├── schedule_ngrok.rb
+│   │   ├── schedule_task_executions.rb
+│   │   ├── session_store.rb
+│   │   └── wrap_parameters.rb
+│   ├── application.rb
+│   ├── boot.rb
+│   ├── database.yml
+│   ├── environment.rb
+│   ├── routes.rb
+│   └── secrets.yml
+├── db
+├── lib
+├── public
+├── Gemfile
+├── Gemfile.lock
+├── Rakefile
+└── README.md
+```
+
+By default, Rails will run the files in `config/initializers` in alphabetical (filename) order, which isn't always what you want. To get around this, [the Rails team suggests prefixing initializer filenames with a numeric value](http://guides.rubyonrails.org/configuring.html#using-initializer-files), but such a solution is not the most elegant in my opinion.
+
+With this gem, elegant control is back in your hands; you can define an `initializers` array in `config/application.rb` like so:
+
+```ruby
+class Application < Rails::Application
+  config.initializers = [
+    "assets",
+    "backtrace_silencers",
+    "filter_parameter_logging",
+    "inflections",
+    "mime_types",
+    "session_store",
+    "wrap_parameters",
+    "load_extensions",
+    "init_hub_settings",
+    "configure_rollbar",
+    "schedule_ngrok",
+    "schedule_hub_upgrades",
+    "schedule_app_upgrades",
+    "schedule_app_launches",
+    "schedule_task_executions"
+  ]
+end
+```
+
+Notice how the ordering of initializers is not alphabetical? When the application starts, initializers will run in the order that they appear in the array!
+
+Additionally, this opens up interesting possibilities for your Rails application, like (for example) enabling/disabling specific initializers based on some condition determined at runtime.

data/initialize.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Initialize::VERSION
   spec.authors       = ["Luke Horvat"]
   spec.email         = ["lukehorvat@gmail.com"]
-  spec.summary       = %q{Ruby gem.}
-  spec.description   = %q{Ruby gem.}
+  spec.summary       = %q{Ruby gem to customize the run order of Rails initializers.}
+  spec.description   = %q{Ruby gem to completely customize the execution order of Rails config initializers.}
   spec.homepage      = "https://github.com/lukehorvat/initialize"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/initialize/patch.rb

@@ -1,3 +1,13 @@
+=begin
+  Monkey-patch the "run" method of Rails::Initializable::Initializer so that it executes
+  initializers in a custom order defined by the user, not alphabetical order.
+
+  Relevant reference files from Rails core:
+  - https://github.com/rails/rails/blob/v4.2.5.2/railties/lib/rails/initializable.rb
+  - https://github.com/rails/rails/blob/v4.2.5.2/railties/lib/rails/engine.rb
+  - https://github.com/rails/rails/blob/v4.2.5.2/railties/lib/rails/application.rb
+=end
+
 module Initialize
   module Patch
     def run(*args)

data/lib/initialize/version.rb

@@ -1,3 +1,3 @@
 module Initialize
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: initialize
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Luke Horvat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Ruby gem.
+description: Ruby gem to completely customize the execution order of Rails config
+  initializers.
 email:
 - lukehorvat@gmail.com
 executables: []
@@ -74,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Ruby gem.
+summary: Ruby gem to customize the run order of Rails initializers.
 test_files: []