ordered_initializers 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d425bf8b9398491a77bca28f215e83f90ccc061152628ffa966a9bdbc1c52228
+  data.tar.gz: 21c7298c590081853528ed8324235461347f65737a4cc4038bfd1aa1183aeeed
+SHA512:
+  metadata.gz: e4e1e4142f7ebf7f2dfbec1020c2d4cc23c7d8368fbcbc064f32407d5b3bca65b8597b480b17336d41e13da71a8f17c517c8ccef10f01edb86482bd331dd569e
+  data.tar.gz: 4263dfc8339ff8938d57f40418072f907a661ff990f0ffd966a621e48aa50a15508261887715710a964c114e8477c13f908a6c10eb071a3bb7a281c8be6f4905

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brandon Keepers
+
+MIT License
+
+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,34 @@
+According to [Rails doc](https://guides.rubyonrails.org/configuring.html#using-initializer-files)
+> After loading the framework and any gems in your application, Rails turns to loading initializers. An initializer is any Ruby file stored under config/initializers in your Rails application.
+The files in config/initializers are _sorted_ and _loaded_ _one by one_ as part of the load_config_initializers initializer.
+If an initializer has code that relies on code in another initializer, you can combine them into a single initializer instead. This makes the dependencies more explicit, and can help surface new concepts within your application. Rails also supports _numbering of initializer file names_, but this can lead to file name churn.
+
+Ordered Initiliazers simply allows you to choose the order in which you want your initializers to be loaded, independently of their name.
+
+# Installation
+
+Add this line to the top of your Rails application's Gemfile:
+
+```ruby
+gem 'ordered_initializers'
+```
+
+And then install the gem:
+
+```shell
+$ bundle install
+```
+
+You can set your initializers order in the `config/initializers.yml` file. Because there is no possibility to prevent Rails from loading files in `config/initializers`, you need to store your initializers files in the `config/ordered_initializers` folder.
+
+Ordered Initiliazers provides a rake task that will automatically moves the files from `config/initializers` to`config/ordered_initializers`, generates the `config/initializers.yml` file and leaves a small reminder in `config/initializers`.
+
+```shell
+$ rake ordered_initializers:install
+```
+
+You can reorder the initializers path as you see fit.
+
+You can still add files to `config/initializers`. They will be loaded alphabetically after the ones in `config/ordered_initializers`.
+
+Running `rake ordered_initializers:install` again will simply append the new files from `config/initializers` at the end of `config/initializers.yml`.

data/lib/ordered_initializers/parser.rb

@@ -0,0 +1,21 @@
+module OrderedInitializers
+  class Parser
+    class << self
+      def path
+        "config/initializers.yml"
+      end
+    end
+
+    def initializer_files
+      YAML.safe_load(yml_file, aliases: true)
+    rescue ArgumentError
+      YAML.safe_load(yml_file)
+    end
+
+    private
+
+    def yml_file
+      File.read(Rails.root.join(self.class.path))
+    end
+  end
+end

data/lib/ordered_initializers/rails.rb

@@ -0,0 +1,30 @@
+require "rails"
+require "ordered_initializers/parser"
+require "ordered_initializers"
+
+module OrderedInitializers
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+
+    def load_initializer_file
+      OrderedInitializers.initializer_files = parsed
+    end
+
+    def parsed
+      Parser.new.initializer_files
+    end
+
+    private
+
+    config.before_initialize do
+      load_initializer_file
+
+      OrderedInitializers.go
+    rescue Errno::ENOENT
+      ::Kernel.warn("Missing file #{Parser.path}! Please run `rake ordered_initializers:install` to generate the file. Skipping ordered_initializers for the moment")
+    end
+  end
+end

data/lib/ordered_initializers/tasks/install.rake

@@ -0,0 +1,89 @@
+namespace :ordered_initializers do
+  desc "Moves files from config/initializers to config/ordered_initializers and generates config/initializers.yml"
+  task :install do
+    def from_dir
+      Rails.root.join("config/initializers")
+    end
+
+    def to_dir
+      Rails.root.join("config/ordered_initializers").tap do |path|
+        Dir.mkdir(path) unless Dir.exist?(path)
+      end
+    end
+
+    def rails_initializers_yml_path
+      Rails.root.join("config/initializers.yml")
+    end
+
+    def existing_initializer_files_path
+      YAML.load_file(Rails.root.join(rails_initializers_yml_path)) || []
+    rescue
+      []
+    end
+
+    def all_initializer_files_path
+      Dir[to_dir + "*"].map { |path| to_relative_path(path) }
+    end
+
+    def to_relative_path(path)
+      path.sub(/#{Rails.root}\//, "")
+    end
+
+    def move_initializers!
+      ::Kernel.warn("Moving all existing initializers from #{to_relative_path(from_dir)} to #{to_relative_path(to_dir)}")
+
+      Dir[from_dir + "*"].each do |old_dest|
+        next if /0_placeholder.rb/.match?(old_dest.to_s)
+        new_dest = old_dest.to_s.gsub(from_dir.to_s, to_dir.to_s)
+        FileUtils.mv(old_dest, new_dest)
+      end
+    end
+
+    # Keep the already existing initializers path and append the new ones at the end
+    def update_initializers_yml!
+      if File.exist?(rails_initializers_yml_path)
+        ::Kernel.warn("Updating #{to_relative_path(rails_initializers_yml_path)}")
+      else
+        ::Kernel.warn("Creating #{to_relative_path(rails_initializers_yml_path)}")
+      end
+
+      new_initializer_files_path = all_initializer_files_path - existing_initializer_files_path
+      initializer_files_path = existing_initializer_files_path + new_initializer_files_path
+
+      File.open(rails_initializers_yml_path, "w") do |f|
+        f.puts "# this file have been generated using `rake ordered_initializers:install`"
+        f.puts "# you can reorder the initializers path as you see fit"
+        f.write initializer_files_path.to_yaml
+      end
+
+      ::Kernel.warn("The initializers will be load in the following order:")
+      initializer_files_path.each do |path|
+        ::Kernel.warn("- #{to_relative_path(path)}")
+      end
+      ::Kernel.warn("You can reorder the initializers path as you see fit.")
+    end
+
+    def add_placeholder
+      ::Kernel.warn("Generating config/initializers/0_placeholder.rb")
+
+      File.open(from_dir.join("0_placeholder.rb"), "w") do |f|
+        f.puts "# All the files from this folder were moved to config/ordered_initializers folder using `rake ordered_initializers:install`"
+        f.puts "# You can still add files to this folder. They will be loaded alphabetically after the ones in config/ordered_initializers."
+
+        f.puts <<~EOF
+          
+          return if Gem::Specification.all_names.any? { |gem_name| gem_name.match(/ordered_initializers/) }
+          
+          abort('`ordered_initializers` gem could not be found.
+          You need to either reinstall the gem, or move to this folder all the files from config/ordered_initializer then delete config/initializers.yml as well as this file.')
+        EOF
+      end
+    end
+
+    move_initializers!
+    add_placeholder
+    update_initializers_yml!
+  end
+end
+
+task environment: %w[ordered_initializers:install]

data/lib/ordered_initializers/version.rb

@@ -0,0 +1,3 @@
+module OrderedInitializers
+  VERSION = "0.3.2".freeze
+end

data/lib/ordered_initializers.rb

@@ -0,0 +1,19 @@
+require "ordered_initializers/rails"
+
+module OrderedInitializers
+  class << self
+    attr_accessor :initializer_files
+  end
+
+  module_function
+
+  def go
+    initializer_files.each do |file|
+      load_config_initializer(file)
+    end
+  end
+
+  def load_config_initializer(initializer)
+    load initializer
+  end
+end

data/spec/fixtures/initializers.yml

@@ -0,0 +1,3 @@
+- file1.rb
+- file2.rb
+- file3.rb

data/spec/ordered_initializers/parser_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe OrderedInitializers::Parser do
+  let(:parser) { described_class.new }
+
+  before do
+    Dir.chdir(File.expand_path("../../fixtures", __FILE__))
+    allow(Rails).to receive(:root).and_return Pathname.new(File.expand_path("../../fixtures", __FILE__))
+  end
+
+  describe ".initializer_files" do
+    before do
+      allow(described_class).to receive(:path).and_return("initializers.yml")
+    end
+
+    subject(:initializer_files) { parser.initializer_files }
+
+    it "returns parsed content as an Array" do
+      expect(initializer_files).to eq(["file1.rb", "file2.rb", "file3.rb"])
+    end
+  end
+
+  describe ".yml_file" do
+    before do
+      allow(described_class).to receive(:path).and_return("initializers.yml")
+    end
+
+    subject(:yml_file) { parser.send(:yml_file) }
+
+    it "returns content of yaml file" do
+      expect(yml_file).to eq("- file1.rb\n- file2.rb\n- file3.rb\n")
+    end
+  end
+
+  describe "#path" do
+    subject(:path) { described_class.path }
+
+    it "returns the default path" do
+      expect(path).to eq("config/initializers.yml")
+    end
+  end
+end

data/spec/ordered_initializers/rails_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+require "rails"
+require "ordered_initializers/rails"
+
+# Fake watcher for Spring
+class SpecWatcher
+  attr_reader :items
+
+  def initialize
+    @items = []
+  end
+
+  def add(*items)
+    @items |= items
+  end
+end
+
+describe OrderedInitializers::Railtie do
+  before do
+    Rails.env = "test"
+    allow(Rails).to receive(:root).and_return Pathname.new(File.expand_path("../../fixtures", __FILE__))
+
+    Rails.application = double(:application)
+  end
+
+  after do
+    Rails.application = nil
+  end
+
+  describe "before_initialize" do
+    before do
+      allow(OrderedInitializers::Parser).to receive(:path).and_return(path)
+    end
+
+    context "when the initializers.yml file is present" do
+      let(:path) { "initializers.yml" }
+
+      it "calls OrderedInitializers.go" do
+        expect(described_class.instance).to receive(:load_initializer_file).and_call_original
+        expect(OrderedInitializers).to receive(:go)
+
+        ActiveSupport.run_load_hooks(:before_initialize)
+      end
+    end
+
+    fcontext "when the initializers.yml file is missing" do
+      let(:path) { "foobar.yml" }
+
+      it "does not call OrderedInitializers.go" do
+        expect(described_class.instance).to receive(:load_initializer_file).and_call_original
+        expect(OrderedInitializers).not_to receive(:go)
+
+        expect(::Kernel).to receive(:warn).with(/Skipping ordered_initializers/)
+
+        ActiveSupport.run_load_hooks(:before_initialize)
+      end
+    end
+  end
+
+  describe "#load_initializer_file" do
+    subject(:load_initializer_file) { described_class.instance.load_initializer_file }
+
+    it "sets OrderedInitializers.initializer_files" do
+      allow(described_class.instance).to receive(:parsed).and_return(["fileA.rb", "fileB.rb", "fileC.rb"])
+
+      load_initializer_file
+
+      expect(OrderedInitializers.initializer_files).to eq(["fileA.rb", "fileB.rb", "fileC.rb"])
+    end
+  end
+end

data/spec/ordered_initializers_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe OrderedInitializers do
+  describe ".go" do
+    subject(:go) { OrderedInitializers.go }
+
+    it "calls load_config_initializer as many times as there are entry in initializer_files" do
+      OrderedInitializers.initializer_files = Array.new(5)
+      expect(OrderedInitializers).to receive(:load_config_initializer).exactly(5).times
+
+      go
+    end
+
+    it "raises an error if one initializer file is missing" do
+      OrderedInitializers.initializer_files = ["foo.rb"]
+
+      expect { go }.to raise_error(LoadError, /cannot load such file -- foo.rb/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "ordered_initializers"
+
+RSpec::Mocks.configuration.allow_message_expectations_on_nil = true
+
+RSpec.configure do |config|
+  # Reinit OrderedInitializers.initializer_files value
+  config.before { OrderedInitializers.initializer_files = nil }
+  config.after { OrderedInitializers.initializer_files = nil }
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ordered_initializers
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Benjamin BOCCARA
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run your Rails application initializers file in the order you want.
+email: boccarab@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/ordered_initializers.rb
+- lib/ordered_initializers/parser.rb
+- lib/ordered_initializers/rails.rb
+- lib/ordered_initializers/tasks/install.rake
+- lib/ordered_initializers/version.rb
+- spec/fixtures/initializers.yml
+- spec/fixtures/initializers/file1.rb
+- spec/fixtures/initializers/file2.rb
+- spec/fixtures/initializers/file3.rb
+- spec/ordered_initializers/parser_spec.rb
+- spec/ordered_initializers/rails_spec.rb
+- spec/ordered_initializers_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/ordered_initializers
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+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: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Run your Rails application initializers file in the order you want.
+test_files:
+- spec/fixtures/initializers.yml
+- spec/fixtures/initializers/file1.rb
+- spec/fixtures/initializers/file2.rb
+- spec/fixtures/initializers/file3.rb
+- spec/ordered_initializers/parser_spec.rb
+- spec/ordered_initializers/rails_spec.rb
+- spec/ordered_initializers_spec.rb
+- spec/spec_helper.rb