app_config_for 0.0.1 → 0.0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16aa403545b3c7bb28165f904eb60d51138293dfbc8269c76bc2f13ec3cf44a0
-  data.tar.gz: 707c8d7280805a21df63505882cabd48ac9e7a9536b717fb9054bd50c2b83ec9
+  metadata.gz: 228991a28438bec90c4aa9f06b33850a5ee4034b01a7ec87a33c90fa77ace37d
+  data.tar.gz: eed01754e58c59c3ea8d58c23e809f8d9c3ae1b6fe5a3b24958a1a173f01a87c
 SHA512:
-  metadata.gz: a7996b0d285f25d1a874ed19593ed4773d20d6eeb55237bfdccf3f61c9045a49c73a703ffeeac014e3035c71f131f1f0b7f98f0a205fe7fb71250778e1985d58
-  data.tar.gz: 372bb10b3e6f63754a65608b7d67553c6fd49ec821b8efe101f067e9060f816ab1ab023fafef38b5b37af1a0dc1495e0cc073120805fef15657452946bfa788d
+  metadata.gz: d05a93814a9b8162890151e89f2e83e99f29c58478e371aeef49c63c29713a01d1c86ab3b4a28ee320d2eb639dd51879d107dd820c9f173c3bae958c626396b9
+  data.tar.gz: b9dc3d8224b2e0c05167da273faf7df940c1397022d22768af8cce85101de32993a56cc2e13bca5b2d8cb656e7885251a962486856388ad1871be9163784816e

data/lib/app_config_for/errors.rb

@@ -22,4 +22,17 @@ module AppConfigFor
       super "Could not load configuration file: #{@file}\n#{@original_exception.message}"
     end
   end
+
+  class InvalidEnvInheritanceStyle < Error
+
+    attr_reader :attempted, :valid
+
+    def initialize(attempted)
+      @attempted = attempted
+      @valid = EnvPrefixInheritanceStyles.dup
+      super "Invalid inheritance style #{@attempted.inspect}. Please use one of the following: #{@valid.map(&:inspect).join(', ')}"
+    end
+
+  end
+
 end

data/lib/app_config_for/gem_version.rb

@@ -0,0 +1,16 @@
+module AppConfigFor
+
+  def self.gem_version
+    Gem::Version.new(VERSION::STRING)
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 4
+    PRE = 1
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+
+end

data/lib/app_config_for/legacy_support.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/string/inflections'
+name = File.basename(__dir__).classify
+STDERR.puts "#{name}: Warning! Outdated version of ActiveSupport active! To avoid security issues, please upgrade your version of ActiveSupport to at least 6.1.4."
+if ActiveSupport.gem_version < Gem::Version.new('6.1.0')
+  puts "#{name}: Loading legacy support for ActiveSupport version #{ActiveSupport.gem_version}."
+
+  # Quick and dirty backport. This won't be here long. Just enough to support AppConfigFor during some legacy upgrades.
+  require "active_support/string_inquirer"
+  require "erb"
+  require "yaml"
+
+  module ActiveSupport
+    class EnvironmentInquirer < StringInquirer
+
+      Environments = %w(development test production)
+
+      def initialize(env)
+        super(env)
+        Environments.each { |e| instance_variable_set(:"@#{e}", env == e) }
+      end
+
+      Environments.each { |e| define_method("#{e}?") { instance_variable_get("@#{e}") }}
+    end
+
+    class ConfigurationFile
+      def initialize(file_name)
+        @file_name = file_name
+        @config = File.read(file_name)
+        warn(file_name + ' contains invisible non-breaking spaces.') if @config.match?("\u00A0")
+      end
+
+      def self.parse(file_name)
+        new(file_name).parse
+      end
+
+      def parse
+        YAML.load(ERB.new(@config).result) || {}
+      rescue Psych::SyntaxError => e
+        raise "YAML syntax error occurred while parsing #{@file_name}. Error: #{e.message}"
+      end
+    end
+
+  end
+
+end

data/lib/app_config_for/version.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
+require_relative "gem_version"
 
 module AppConfigFor
-  VERSION = "0.0.1"
+
+  def self.version
+    gem_version
+  end
+
 end

data/lib/app_config_for.rb

@@ -2,27 +2,46 @@
 
 require_relative "app_config_for/version"
 require_relative "app_config_for/errors"
-require 'active_support/environment_inquirer'
-require 'active_support/configuration_file'
+
+require 'active_support/gem_version'
+if ActiveSupport.gem_version >= Gem::Version.new('6.1.4')
+  require 'active_support/environment_inquirer'
+  require 'active_support/configuration_file'
+else
+  require_relative 'app_config_for/legacy_support'
+end
+
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
-require "active_support/core_ext/hash/indifferent_access"
+require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/ordered_options'
 require 'active_support/core_ext/object/try'
 
 module AppConfigFor
 
+  EnvPrefixInheritanceStyles = %i(none namespace class namespace_class class_namespace)
+
   def initialize(*args)
     add_env_prefix
     super
   end
 
-  def add_env_prefix(prefix = nil, at_beginning: true)
-    env_prefixes(all: false, dup: false).send(at_beginning ? :unshift : :push, AppConfigFor.prefix_from(prefix || self)).uniq!
+  def add_env_prefix(prefix = nil, at_beginning = true)
+    env_prefixes(false, false).send(at_beginning ? :unshift : :push, AppConfigFor.prefix_from(prefix || self)).uniq!
+  end
+
+  def add_config_directory(new_directory)
+    (additional_config_directories << Pathname.new(new_directory).expand_path).uniq!
+  end
+
+  def additional_config_directories
+    @additional_config_directories ||= []
   end
 
   def config_directories
-    directories = ['Rails'.safe_constantize&.application&.paths, try(:paths)].compact.map { |root| Pathname.new(root["config"].existent.first) }
+    directories = ['Rails'.safe_constantize&.application&.paths, try(:paths)].compact.map { |root| root["config"].existent.first }.compact
+    directories.map! { |directory| Pathname.new(directory).expand_path }
+    directories.concat additional_config_directories
     directories.push(Pathname.getwd + 'config')
     directories.uniq
   end
@@ -36,7 +55,7 @@ module AppConfigFor
   end
 
   def config_files(name = nil)
-    name = AppConfigFor.yml_name_from(name || self)
+    name = AppConfigFor.yml_name_from(name || config_name)
     config_directories.map { |directory| directory + name }
   end
 
@@ -44,8 +63,8 @@ module AppConfigFor
     !config_file(name).blank?
   end
 
-  def config_for(name, environment: nil)
-    config, shared = config_options(name).fetch_values((environment || env).to_sym, :shared) {nil}
+  def config_for(name, env: nil)
+    config, shared = config_options(name).fetch_values((env || self.env).to_sym, :shared) {nil}
     config ||= shared
 
     if config.is_a?(Hash)
@@ -56,53 +75,70 @@ module AppConfigFor
     config
   end
 
+  def config_name
+    @config_name ||= self
+  end
+
+  def config_name=(new_config_name)
+    @config_name = new_config_name
+  end
+
   def config_options(name = nil)
     file = name.is_a?(Pathname) ? name : config_file(name)
     ActiveSupport::ConfigurationFile.parse(file.to_s).deep_symbolize_keys
   rescue SystemCallError => exception
     raise ConfigNotFound.new(name.is_a?(Pathname) ? name : config_files(name), exception)
   rescue => exception
-    raise LoadError.new(file, exception)
+    raise file ? LoadError.new(file, exception) : exception
   end
 
-  def configured(environment: nil)
-    config_for(self, environment: environment)
+  def configured(reload = false, env: nil)
+    @configured = config_for(nil, env: env) if reload || @configured.nil?
+    @configured
   end
 
-  def env(reload: false)
+  def env(reload = false)
     @env = ActiveSupport::EnvironmentInquirer.new(AppConfigFor.env_name(env_prefixes)) if reload || @env.nil?
     @env
   end
 
-  def env_prefixes(all: true, dup: true)
+  def env_prefix_inheritance
+    @env_prefix_inheritance ||= :namespace
+  end
+
+  def env_prefix_inheritance=(style)
+    @env_prefix_inheritance = AppConfigFor.verified_style!(style)
+  end
+
+  def env_prefixes(all = true, dup = true)
     @env_prefixes ||= []
     if all
-      @env_prefixes + AppConfigFor.progenitor_of(self).env_prefixes(all: true)
+      @env_prefixes + AppConfigFor.progenitor_prefixes_of(self)
     else
       dup ? @env_prefixes.dup : @env_prefixes
     end
   end
 
-  def remove_env_prefix(prefix, all: false)
+  def remove_env_prefix(prefix, all = false)
     if all
       remove_env_prefix(prefix)
-      AppConfigFor.progenitor_of(self).remove_env_prefix(prefix, all: true)
+      AppConfigFor.progenitor_of(self)&.remove_env_prefix(prefix, all)
     else
-      env_prefixes(all: false, dup: false).delete(AppConfigFor.prefix_from(prefix))
+      env_prefixes(false, false).delete(AppConfigFor.prefix_from(prefix))
     end
   end
 
   class << self
 
-    def add_env_prefix(prefix)
-      env_prefixes(dup: false).push(prefix_from(prefix))
+    def add_env_prefix(prefix, at_beginning = true)
+      env_prefixes(false, false).send(at_beginning ? :unshift : :push, prefix_from(prefix)).uniq!
     end
 
     def env_name(prefixes = env_prefixes)
       prefixes.inject(nil) { |current_env, name| current_env || ENV["#{name.to_s.upcase}_ENV"].presence } || 'development'
     end
 
-    def env_prefixes(all: true, dup: true)
+    def env_prefixes(_all = true, dup = true)
       # all is ignored as we are at the end of the chain
       @env_prefixes ||= [:rails, :rack]
       dup ? @env_prefixes.dup : @env_prefixes
@@ -119,6 +155,27 @@ module AppConfigFor
       end.deconstantize.safe_constantize
     end
 
+    # Not used internally, this is a convenience method to study what progenitors are used during namespace dives
+    def namespaces_of(object)
+      (object = [namespace_of(object)]).each { |x| x && object << namespace_of(x) }[0..-2]
+    end
+
+    def parent_of(object)
+      case object
+      when String
+        object.safe_constantize
+      when Class
+        object.superclass
+      else
+        object.class
+      end
+    end
+
+    # Not used internally, this is a convenience method to study what progenitors are used during class dives
+    def parents_of(object)
+      (object = [parent_of(object)]).each { |x| x && object << parent_of(x) }[0..-2]
+    end
+
     def prefix_from(object)
       if object.is_a?(Symbol)
         object
@@ -134,19 +191,41 @@ module AppConfigFor
           object.class.name
         end.underscore.gsub('/','_').to_sym
      end
+    end
 
+    def progenitor_of(object, style = nil)
+      style = verified_style!(style, object)
+      command = {namespace: :namespace_of, class: :parent_of}[style] # Todo, deal with the other styles by doing nothing and not crashing or something.
+      object && command && send(command, object).yield_self { |n| n && (n.respond_to?(:env_prefixes) ? n : progenitor_of(n)) }
     end
 
-    # First namespace of the object that supports env_prefixes or AppConfig
-    def progenitor_of(object)
-      (namespace_of(object) || self).yield_self do |namespace|
-        namespace.respond_to?(:env_prefixes) ? namespace : progenitor_of(namespace)
-      end
+    def progenitor_prefixes_of(object, style = nil, all = true)
+      Array(progenitor_of(object, style)&.env_prefixes(all))
     end
 
-    def remove_env_prefix(prefix, all: false)
-      # all is ignored as we are at the end of the chain
-      env_prefixes(dup: false).delete(prefix_from(prefix))
+    def progenitors_of(object, style = nil, terminate = true)
+      style = verified_style!(style, object)
+      terminate = terminate && style != :none
+      if object && style != :none
+        styles = style.to_s.split('_')
+        if styles.size > 1
+          styles.flat_map{ |style| progenitors_of(object, style, false) }
+        else
+          Array(progenitor_of(object, style)).yield_self { |x| x + progenitors_of(x.last, nil, false) }
+        end
+      else
+        []
+      end.yield_self { |result| terminate ? result.reverse.uniq.reverse + [self] : result }
+    end
+
+    def remove_env_prefix(prefix, all = false)
+      env_prefixes(all, false).delete(prefix_from(prefix))
+    end
+
+    def verified_style!(style, object = nil)
+      style ||= object.respond_to?(:env_prefix_inheritance) ? object.send(:env_prefix_inheritance) : :namespace
+      style = style.try(:to_sym) || style.to_s.to_sym
+      EnvPrefixInheritanceStyles.include?(style) ? style : raise(InvalidEnvInheritanceStyle.new(style))
     end
 
     def yml_name_from(object)
@@ -166,17 +245,23 @@ module AppConfigFor
 
     private
 
+    def prep_base(base)
+      base.add_env_prefix
+      gem = Gem.loaded_specs[base.name.underscore]
+      base.add_config_directory(gem.gem_dir + '/config') if gem
+    end
+
     def extended(base)
       # Todo: Add the ability to check the default environments directly from base if the methods don't yet exist.
       # ie: base.development? is the same as base.env.development?
-      base.add_env_prefix
+      prep_base(base)
     end
 
-    # Todo: Determine progenitor_of with respect to combining inheritance with namespace scoping
-    # def included(base)
-    #   base.add_env_prefix
-    # end
+    def included(base)
+      prep_base(base)
+    end
 
   end
 
 end
+

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: app_config_for
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4.1
 platform: ruby
 authors:
 - Frank Hall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +78,8 @@ files:
 - Rakefile
 - lib/app_config_for.rb
 - lib/app_config_for/errors.rb
+- lib/app_config_for/gem_version.rb
+- lib/app_config_for/legacy_support.rb
 - lib/app_config_for/version.rb
 - sig/app_config_for.rbs
 homepage: https://github.com/ChapterHouse/app_config_for
@@ -79,8 +87,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ChapterHouse/app_config_for
-  source_code_uri: https://github.com/ChapterHouse/app_config_for/tree/v0.0.1
-  changelog_uri: https://github.com/ChapterHouse/app_config_for/blob/v0.0.1/CHANGELOG.md
+  source_code_uri: https://github.com/ChapterHouse/app_config_for/tree/v0.0.4.1
+  changelog_uri: https://github.com/ChapterHouse/app_config_for/blob/v0.0.4.1/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -89,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="