confg 1.0.3 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a22248aee15636933d13104780068971f2663a3
-  data.tar.gz: e8b1bbf96b54edf9cf796ed5c49724df47b93f87
+SHA256:
+  metadata.gz: 50b51215735b3ac4f8caedb04e36ae28176bb1bd6e7c14c2e3cdced3e7480a1e
+  data.tar.gz: 95b45d10ab8cb6751afd546d28f4fa76d48e56c4e2746489c5a91cb8dcfcba07
 SHA512:
-  metadata.gz: 2e7cf98c81efeb762c04acc64c82e7c15a5792d9b54c8a1de90433562e4fcd27f797fc09869abaa297b9881270d40b9d3dd06017984f43337cc82527129092b8
-  data.tar.gz: 12dfb2ab1b2d4c6c1a1e5cff7adf12a0e3ffc8919686e09a72f54cffc9b251f4fcaeb37e27faa7b20e7f81b1d2a5957cc4caf348eb7e876498b3eadf89eddc58
+  metadata.gz: c94266338ff570a78f1db7e736be6264f89658d3c96711c78871a34a4a01746ad4b54eb117d909c07857a52549a3d8bd8f9898648611fb809560e656dfa360b8
+  data.tar.gz: a2c2042c39354842a10b72d5616dc725ba538b6f7e0ccd01ebd88f98fd84f74635949158aa4e30928c2d4738bc9b02b8faf0a6976563231fce48ce409296ca9b

data/Rakefile

@@ -1 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/confg.gemspec

@@ -1,21 +1,25 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'confg/version'
+require "confg/version"
 
-Gem::Specification.new do |gem|
-  gem.name          = "confg"
-  gem.version       = Confg::VERSION
-  gem.authors       = ["Mike Nelson"]
-  gem.email         = ["mike@mnelson.io"]
-  gem.description   = %q{Config the pipes}
-  gem.summary       = %q{Sets shared variables for applications}
-  gem.homepage      = ""
+Gem::Specification.new do |spec|
+  spec.name          = "confg"
+  spec.version       = Confg::VERSION
+  spec.authors       = ["Mike Nelson"]
+  spec.email         = ["mike@mnelson.io"]
+  spec.description   = "Config the pipes"
+  spec.summary       = "Sets shared variables for applications"
+  spec.homepage      = ""
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.add_dependency 'activesupport', '>= 3.0.0'
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/confg.rb

@@ -1,13 +1,23 @@
-require 'confg/version'
-require 'confg/configuration'
-require 'confg/erb_context'
+# frozen_string_literal: true
+
+require "confg/version"
+require "confg/configuration"
+require "confg/erb_context"
 
 module Confg
 
   class << self
 
     def root
-      @root ||= Pathname.new(calc_root_string).expand_path
+      return @root if defined?(@root)
+
+      @root = calc_root_path
+    end
+
+    def env
+      return @env if defined?(@env)
+
+      @env = calc_env_string
     end
 
     def erb_function(function_name, &block)
@@ -17,29 +27,21 @@ module Confg
       self
     end
 
-    def configure(raise_on_missed_key = false)
-      @configuration ||= ::Confg::Configuration.new(raise_on_missed_key)
+    def configure
+      @configuration ||= ::Confg::Configuration.new(env: env, root: root)
       yield @configuration if block_given?
       @configuration
     end
-    alias_method :config, :configure
+    alias config configure
 
     def method_missing(method_name, *args, &block)
       config.send(method_name, *args, &block)
     end
 
-    def respond_to_missing?(*args)
+    def respond_to_missing?(*_args)
       true
     end
 
-    def get(path)
-      thing = self
-      path.split('.').each do |piece|
-        thing = thing.try(piece)
-      end
-      thing
-    end
-
     protected
 
     def calc_root_string
@@ -47,13 +49,27 @@ module Confg
       return RAILS_ROOT      if defined?(RAILS_ROOT)
       return RACK_ROOT       if defined?(RACK_ROOT)
 
-      ENV['RAILS_ROOT'] || ENV['RACK_ROOT'] || Dir.pwd
+      ENV["RAILS_ROOT"] || ENV["RACK_ROOT"] || Dir.pwd
+    end
+
+    def calc_root_path
+      ::Pathname.new(calc_root_string).expand_path
+    end
+
+    def calc_env_string
+      return ::Rails.env.to_s if defined?(::Rails)
+      return RAILS_ENV if defined?(RAILS_ENV)
+      return RACK_ENV if defined?(RACK_ENV)
+
+      ENV["RAILS_ENV"] || ENV["RACK_ENV"] || nil
     end
 
     def reset!
-      remove_instance_variable("@configuration")  if defined?(@configuration)
-      remove_instance_variable("@root")  if defined?(@root)
+      remove_instance_variable("@configuration") if defined?(@configuration)
+      remove_instance_variable("@env") if defined?(@env)
+      remove_instance_variable("@root") if defined?(@root)
     end
+
   end
 
 end

data/lib/confg/configuration.rb

@@ -1,47 +1,62 @@
-require 'active_support/core_ext/module/delegation'
+# frozen_string_literal: true
+
+require "yaml"
 
 module Confg
-  class Configuration
+  class Configuration < ::SimpleDelegator
+
+    attr_reader :confg_env, :confg_root
+
+    def initialize(env: Confg.env, root: Confg.root)
+      @confg_env = env.to_s
+      @confg_root = Pathname.new(root)
 
-    delegate :each, :inspect, :to => :@attributes
+      super({})
+    end
 
-    def initialize(raise_error_on_miss = false, parent = nil)
-      @attributes           = {}
-      @raise_error_on_miss  = raise_error_on_miss
-      @parent               = parent
+    def tmp(key, value)
+      initial = get(key)
+      set(key, value)
+      yield
+    ensure
+      set(key, initial)
     end
 
-    def merge(hash)
-      hash.each do |k,v|
-        self.set(k,v)
+    def merge(other)
+      other.each_pair do |k, v|
+        set(k, v)
       end
     end
-    alias_method :merge!, :merge
+    alias merge! merge
 
-    def to_hash
-      out = @attributes.to_h.dup
-      out.each_pair do |k,v|
-        out[k] = v.to_hash if v.is_a?(self.class)
+    def to_h
+      __getobj__.transform_values do |v|
+        v.is_a?(self.class) ? v.to_h : v
       end
-      out
     end
-    alias_method :to_h, :to_hash
 
-    def [](key)
-      self.get(key)
+    def get(key)
+      __getobj__[key.to_s]
     end
+    alias [] get
 
-    def []=(key, value)
-      self.set(key, value)
+    def get!(key)
+      __getobj__.fetch(key.to_s)
     end
 
-    def tmp(key, value)
-      initial = self[key]
-      self[key] = value
-      yield
-    ensure
-      self[key] = initial
+    def set(key, value = nil)
+      __getobj__[key.to_s] = case value
+      when ::Hash
+        set_block(key) do |child|
+          value.each_pair do |k, v|
+            child.set(k, v)
+          end
+        end
+      else
+        value
+      end
     end
+    alias []= set
 
     def load_key(key)
       # loads yaml file with given key
@@ -49,121 +64,84 @@ module Confg
     end
 
     def load_yaml(path, key: nil, ignore_env: false)
-      path = find_config_yaml(path)
-      raw_content = File.open(path, 'r'){|io| io.read } rescue nil
+      found_path = find_config_yaml(path)
 
-      return unless raw_content
+      raise ArgumentError, "#{path} could not be found" if found_path.nil?
 
       ctxt = ::Confg::ErbContext.new
-      content = ctxt.evaluate(raw_content)
+      raw_content = ::File.read(found_path)
+      erb_content = ctxt.evaluate(raw_content)
+      yaml_content = ::YAML.send :load, erb_content
 
       unless ignore_env
-        env = defined?(Rails) ? Rails.env.to_s : ENV["RAILS_ENV"] || ENV["RACK_ENV"]
-        content = content[Rails.env] if env && content.is_a?(::Hash) && content.has_key?(Rails.env)
+        yaml_content = yaml_content[confg_env] if confg_env && yaml_content.is_a?(::Hash) && yaml_content.key?(confg_env)
       end
 
       if key
-        self.set(key, content)
+        set(key, yaml_content)
       else
-        if content.is_a?(Array)
-          raise "A key must be provided to load the file at: #{path}"
+        if yaml_content.is_a?(Array)
+          raise "A key must be provided to load the file at: #{found_path}"
         else
-          content.each do |k,v|
-            self.set(k, v)
+          yaml_content.each do |k, v|
+            set(k, v)
           end
         end
       end
     end
-    alias_method :load_yml, :load_yaml
+    alias load_yml load_yaml
 
     def method_missing(method_name, *args, &block)
-      if method_name.to_s =~ /^(.+)=$/ && !args.empty?
-        self.set($1, args.first)
-      elsif method_name.to_s =~ /^([^=]+)$/
-        if block_given?
-          self.set_block($1, &block)
-        elsif @attributes.respond_to?($1)
-          @attributes.send($1, *args)
-        else
-          self.get($1)
-        end
-      else
+      key = method_name.to_s
+
+      if __getobj__.respond_to?(key)
         super
+      elsif key.end_with?("=") && !args.empty?
+        set(key[0...-1], args[0])
+      elsif block_given?
+        set_block(key, &block)
+      else
+        get!(key)
       end
     end
 
-    def respond_to?(method_name, include_private = false)
+    def respond_to_missing?(*_args)
       true
     end
 
     protected
 
-    def set(key, value = nil)
-      case value
-      when ::Hash
-        set_block key do |inner|
-          value.each do |k,v|
-            inner.set(k, v)
-          end
-        end
-      else
-        @attributes[key.to_s] = value
-      end
-    end
-
-    def get(key)
-      if @attributes.has_key?(key.to_s)
-        @attributes[key.to_s]
-      else
-        get_missing_key(key.to_s)
-      end
-    end
-
-    def get_missing_key(key)
-      if @raise_error_on_miss
-        raise "Missing key: #{key} in #{@attributes.inspect}"
-      else
-        nil
-      end
-    end
-
-    def set_block(key, &block)
-      inner = @attributes[key.to_s] || child_new
-      block.call(inner)
+    def set_block(key)
+      inner = get(key) || spawn_child
+      yield(inner)
       set(key, inner)
     end
 
     def find_config_yaml(path)
       path = path.to_s
       # give it back if it starts with a slash
-      return path if path =~ /^\//
+      if path.start_with?("/")
+        return nil unless ::File.file?(path)
+
+        return path
+      end
 
       to_try = []
-      unless path =~ /.yml$/
-        to_try << Confg.root.join("config/#{path}.yml")
+      unless path.end_with?(".yml")
+        to_try << confg_root.join("config/#{path}.yml")
       end
-      to_try << Confg.root.join("config/#{path}")
-      to_try << Confg.root.join(path)
+      to_try << confg_root.join("config/#{path}")
+      to_try << confg_root.join(path)
 
       to_try.each do |file|
-        return file if File.file?(file)
+        return file.to_s if File.file?(file)
       end
 
-      to_try.first
-    end
-
-    def child_class
-      # same as ours
-      self.class
-    end
-
-    def child_raise_error_on_miss
-      # same as ours
-      @raise_error_on_miss
+      nil
     end
 
-    def child_new
-      child_class.new(child_raise_error_on_miss, self)
+    def spawn_child
+      self.class.new(env: confg_env, root: confg_root)
     end
 
   end

data/lib/confg/erb_context.rb

@@ -1,12 +1,12 @@
-require 'yaml'
-require 'erb'
+# frozen_string_literal: true
+
+require "erb"
 
 module Confg
   class ErbContext
 
     def evaluate(raw_content)
-      raw_content = ERB.new(raw_content).result(binding)
-      YAML.load(raw_content)
+      ::ERB.new(raw_content).result(binding)
     end
 
   end

data/lib/confg/version.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
 module Confg
-  VERSION = "1.0.3"
+
+  VERSION = "2.0.0.rc1"
+
 end

data/test/confg_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ConfgTest < Minitest::Test
+
+  def config
+    @config ||= ::Confg::Configuration.new(root: __dir__, env: "test")
+  end
+
+  def test_simple_keys_can_be_assigned
+    config.foo = "bar"
+    assert_equal "bar", config.foo
+    assert_equal({ "foo" => "bar" }, config.to_h)
+  end
+
+  def test_a_child_block_can_be_opened
+    config.foo do |child|
+      child.bar = "baz"
+    end
+
+    assert_equal "baz", config.foo.bar
+    assert_equal({ "foo" => { "bar" => "baz" } }, config.to_h)
+  end
+
+  def test_a_child_block_can_be_merged_by_assigning_a_hash
+    config.foo = { "bar" => "baz" }
+    assert_equal "baz", config.foo.bar
+    assert_equal({ "foo" => { "bar" => "baz" } }, config.to_h)
+  end
+
+  def test_an_error_is_raised_for_a_missing_key
+    assert_raises KeyError do
+      config.foo
+    end
+  end
+
+  def test_hash_methods_are_accessible
+    config.foo = "foo_value"
+    config.bar = "bar_value"
+
+    assert_equal(%w[foo bar], config.keys)
+    assert_equal(%w[foo_value bar_value], config.values)
+
+    ikeys = []
+    config.each_key { |k| ikeys << k }
+    assert_equal(%w[foo bar], ikeys)
+
+    ivalues = []
+    config.each_value { |v| ivalues << v }
+    assert_equal(%w[foo_value bar_value], ivalues)
+  end
+
+  def test_a_yml_file_can_be_loaded_by_env
+    config.load_yaml("example.yml")
+    assert_equal({ "foo" => "foo", "env_setting" => "setting_test" }, config.to_h)
+  end
+
+  def test_a_yml_file_can_be_loaded_by_raw
+    config.load_yaml("example.yml", ignore_env: true)
+    assert_equal({
+      "shared" => { "foo" => "foo" },
+      "production" => { "env_setting" => "setting_prod", "foo" => "foo" },
+      "test" => { "env_setting" => "setting_test", "foo" => "foo" },
+    }, config.to_h)
+  end
+
+end

data/test/example.yml

@@ -0,0 +1,10 @@
+shared: &shared
+  foo: "foo"
+
+production:
+  <<: *shared
+  env_setting: "setting_prod"
+
+test:
+  <<: *shared
+  env_setting: "setting_test"

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "confg"
+
+require "minitest/autorun"

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: confg
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-14 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Config the pipes
 email:
 - mike@mnelson.io
@@ -40,6 +82,9 @@ files:
 - lib/confg/configuration.rb
 - lib/confg/erb_context.rb
 - lib/confg/version.rb
+- test/confg_test.rb
+- test/example.yml
+- test/test_helper.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -54,13 +99,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Sets shared variables for applications
-test_files: []
+test_files:
+- test/confg_test.rb
+- test/example.yml
+- test/test_helper.rb