anyway_config 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47484989863db8a88b4f66998387c86ca202ecd8e352fce005500ed11ada2aee
-  data.tar.gz: 2353a987747f87c15adf6efe2d888215bdac5d3aa1631b988135f535d6fa6e93
+  metadata.gz: cdd74aa415435157e394ef1433722c7a579ff015e72923b095f9f7b25d02990e
+  data.tar.gz: d10f5c7bfc2a8f7908ae1b9a43efcc16da7682974aef1519772af482d75c6cd8
 SHA512:
-  metadata.gz: ba01bdb3ddc7053e72b2e7644af1da4aa94382f8a8d544aa7d76d0f432826356e38d8dae47bd47a46559dd2ca6aa056e47ac21281bc827fe24aca15040ccace6
-  data.tar.gz: 18a500de792a4ab8b3e0255a2f6dfd3b36c2bc415a3590df4d57065ad84e6e2ba23c9877499fd9641317ec80741ed671225a437ea1bf18d07e0a15efca89237f
+  metadata.gz: a6ac9bd78a2dbd84ae21124a3ad21556204fd6ebfe05dbb55276ac8ef8a94f5ae09ad070e51cf8e97fc3aca8e8f8126171b53e58ff4c81b012abdbbcc28a2779
+  data.tar.gz: 7da007e994e49579dba02fedf82814367c469be4872bba8aafec1b19f57eb3bd6b46bee03e5e98e60e14bbb28e26b3ba76bf16aa40006ae36438ed0dcae409eb

data/.rubocop.yml

@@ -13,7 +13,7 @@ AllCops:
     - 'vendor/**/*'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
 
 Style/Documentation:
   Exclude:
@@ -42,3 +42,6 @@ Bundler/OrderedGems:
 
 Style/MutableConstant:
   Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/.travis.yml

@@ -21,7 +21,7 @@ matrix:
       gemfile: gemfiles/rails5.gemfile
     - rvm: 2.4.3
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.2.3
+    - rvm: 2.3.2
       gemfile: gemfiles/rails42.gemfile
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## master
+
+## 1.3.0 (2018-06-15)
+
+- Ruby 2.2 is no longer supported.
+
+- `Anyway::Config.env_prefix` method is introduced. ([@charlie-wasp][])
+
+## 1.2.0 (2018-02-19)
+
+Now works on JRuby 9.1+.
+
 ## 1.1.3 (2017-12-20)
 
 - Allow to pass raw hash with explicit values to `Config.new`. ([@dsalahutdinov][])
@@ -54,3 +66,4 @@ Initial version.
 [@palkan]: https://github.com/palkan
 [@onemanstartup]: https://github.com/onemanstartup
 [@dsalahutdinov]: https://github.com/dsalahutdinov
+[@charlie-wasp]: https://github.com/charlie-wasp

data/README.md

@@ -89,6 +89,26 @@ module MyCoolGem
 end
 ```
 
+#### Customize env variable names prefix
+
+By default, Anyway Config will use config name with stripped underscores as a prefix for env variable names (e.g.
+`config_name :my_app` will result to parsing `MYAPP_HOST` variable, not `MY_APP_HOST`). You can set env prefix
+explicitly, and it will be used as is:
+
+```ruby
+module MyCoolGem
+  class Config < Anyway::Config
+    config_name :cool_gem
+    env_prefix :really_cool # now variables, starting wih `REALLY_COOL_`, will be parsed
+    attr_config user: 'root', password: 'root', host: 'localhost', options: {}
+  end
+end
+```
+
+**DEPRECATION WARNING** In the 1.4 version no stripping will be applied on config_names by default, so if you use explicit config names with
+underscores and use env variables, your app will be broken. In this case it is recommended to start using `env_prefix`
+now.
+
 #### Provide explicit values
 
 Sometimes it's useful to set some parameters explicitly during config initialization.
@@ -176,7 +196,7 @@ Examples:
 - `"123"` to 123 and `"3.14"` to 3.14.
 
 *Anyway Config* supports nested (_hashed_) env variables. Just separate keys with double-underscore.
-For example, "MYCOOLGEM_OPTIONS__VERBOSE" is parsed as `config.options.verbose`.
+For example, "MYCOOLGEM_OPTIONS__VERBOSE" is parsed as `config.options["verbose"]`.
 
 Array values are also supported:
 

data/Rakefile

@@ -20,4 +20,4 @@ RSpec::Core::RakeTask.new("spec:norails") do |task|
 end
 
 desc "Run the all specs and linters"
-task default: %w[spec:norails spec rubocop]
+task default: %w[rubocop spec:norails spec]

data/anyway_config.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 2.2'
+  s.required_ruby_version = '>= 2.3'
 
   s.add_development_dependency "rspec", "~> 3.5"
-  s.add_development_dependency "rubocop", "~> 0.52"
+  s.add_development_dependency "rubocop", "~> 0.57.2"
   s.add_development_dependency "simplecov", ">= 0.3.8"
 end

data/lib/anyway/config.rb

@@ -35,6 +35,11 @@ module Anyway # :nodoc:
         @config_name
       end
 
+      def env_prefix(val = nil)
+        return (@env_prefix = val.to_s) unless val.nil?
+        @env_prefix
+      end
+
       # Load config as Hash by any name
       #
       # Example:
@@ -56,7 +61,7 @@ module Anyway # :nodoc:
       end
     end
 
-    attr_reader :config_name
+    attr_reader :config_name, :env_prefix
 
     # Instantiate config with specified name, loads the data and applies overrides
     #
@@ -64,19 +69,26 @@ module Anyway # :nodoc:
     #
     #   my_config = Anyway::Config.new(name: :my_app, load: true, overrides: { some: :value })
     #
-    # rubocop:disable Metrics/LineLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-    def initialize(config_name = nil, do_load = nil, name: nil, load: true, overrides: {})
-      unless config_name.nil? && do_load.nil?
-        warn "[Deprecated] Positional arguments for Anyway::Config#initialize will be removed in 1.2.0. Use keyword arguments instead: initialize(name:, load:, overrides:)"
-      end
-      name = config_name unless config_name.nil?
-      load = do_load unless do_load.nil?
-
+    # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/LineLength,Metrics/CyclomaticComplexity
+    def initialize(name: nil, load: true, overrides: {})
       @config_name = name || self.class.config_name
+
       raise ArgumentError, "Config name is missing" unless @config_name
+
+      if @config_name.to_s.include?('_') && @env_prefix.nil?
+        warn "[Deprecated] As your config_name is #{@config_name}, " \
+             "the prefix `#{@config_name.to_s.delete('_').upcase}` " \
+             "will be used to parse env variables. " \
+             "This behavior is about to change in 1.4.0 (no more deleting underscores). " \
+             "Env prefix can be set explicitly with `env_prefix` method now already " \
+             "(check out the docs), and it will be used as is."
+      end
+
+      @env_prefix = self.class.env_prefix || @config_name.to_s&.delete('_')
+
       self.load(overrides) if load
     end
-    # rubocop:enable Metrics/LineLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength,Metrics/AbcSize,Metrics/LineLength,Metrics/CyclomaticComplexity
 
     def reload(overrides = {})
       clear
@@ -108,14 +120,14 @@ module Anyway # :nodoc:
     end
 
     def load_from_file(config)
-      config_path = Anyway.env.fetch(config_name).delete('conf') ||
+      config_path = Anyway.env.fetch(env_prefix).delete('conf') ||
                     "./config/#{config_name}.yml"
       config.deep_merge!(parse_yml(config_path) || {}) if config_path && File.file?(config_path)
       config
     end
 
     def load_from_env(config)
-      config.deep_merge!(Anyway.env.fetch(config_name))
+      config.deep_merge!(Anyway.env.fetch(env_prefix))
       config
     end
 

data/lib/anyway/env.rb

@@ -21,34 +21,20 @@ module Anyway
       @data.clear
     end
 
-    def fetch(config_name)
-      @data[config_name] ||= parse_env(config_name)
-      @data[config_name].deep_dup
+    def fetch(prefix)
+      @data[prefix] ||= parse_env(prefix.to_s.upcase)
+      @data[prefix].deep_dup
     end
 
     private
 
-    def parse_env(config_name)
-      config_env_name = config_name.to_s.delete("_")
-      config_env_name.upcase!
-      data = {}
-      ENV.each_pair do |key, val|
-        if key.start_with?(config_env_name)
-          _mod, path = extract_module_path(key)
-          set_by_path(data, path, serialize_val(val))
-        end
-      end
-      data
-    end
+    def parse_env(prefix)
+      ENV.each_pair.with_object({}) do |(key, val), data|
+        next unless key.start_with?(prefix)
 
-    def config_key?(key)
-      key =~ /^[A-Z\d]+\_[A-Z\d\_]+/
-    end
-
-    def extract_module_path(key)
-      _, mod, path = key.split(/^([^\_]+)/)
-      path.sub!(/^[\_]+/, '')
-      [mod.downcase, path.downcase]
+        path = key.sub(/^#{prefix}_/, '').downcase
+        set_by_path(data, path, serialize_val(val))
+      end
     end
 
     def set_by_path(to, path, val)

data/lib/anyway/ext/hash.rb

@@ -22,7 +22,7 @@ module Anyway
         end
 
         def stringify_keys!
-          keys.each do |key| # rubocop: disable Performance/HashEachMethods
+          keys.each do |key|
             value = delete(key)
             value.stringify_keys! if value.is_a?(::Hash)
             self[key.to_s] = value

data/lib/anyway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anyway # :nodoc:
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/config_spec.rb

@@ -72,12 +72,32 @@ describe Anyway::Config do
     end
 
     describe "load from env" do
-      it "work" do
-        ENV['COOL_PORT'] = '80'
-        ENV['COOL_USER__NAME'] = 'john'
-        Anyway.env.clear
-        expect(conf.port).to eq 80
-        expect(conf.user[:name]).to eq 'john'
+      context "when env_prefix is not specified" do
+        it "uses config_name as a prefix to load variables" do
+          ENV['COOL_PORT'] = '80'
+          ENV['COOL_USER__NAME'] = 'john'
+          Anyway.env.clear
+          expect(conf.port).to eq 80
+          expect(conf.user[:name]).to eq 'john'
+        end
+      end
+
+      context "when env_prefix is specified" do
+        let(:conf) do
+          klass = CoolConfig.dup
+          klass.class_eval { env_prefix(:cool_env) }
+          klass.new
+        end
+
+        it "uses env_prefix value as a prefix to load variables" do
+          ENV['COOL_PORT'] = '80'
+          ENV['COOL_ENV_PORT'] = '8888'
+          ENV['COOL_USER__NAME'] = 'john'
+          ENV['COOL_ENV_USER__NAME'] = 'bill'
+          Anyway.env.clear
+          expect(conf.port).to eq 8888
+          expect(conf.user[:name]).to eq 'bill'
+        end
       end
 
       it "handle ENV in YML thru ERB" do

data/spec/env_spec.rb

@@ -7,7 +7,7 @@ describe Anyway::Env do
 
   it "loads simple key/values by module", :aggregate_failures do
     ENV['TESTO_KEY'] = 'a'
-    ENV['MYTEST_KEY'] = 'b'
+    ENV['MY_TEST_KEY'] = 'b'
     expect(env.fetch('testo')['key']).to eq 'a'
     expect(env.fetch('my_test')['key']).to eq 'b'
   end

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ end
 
 ENV["RAILS_ENV"] = 'test'
 
-require File.expand_path("../dummy/config/environment", __FILE__)
+require File.expand_path('dummy/config/environment', __dir__)
 require 'anyway_config'
 
 Rails.application.eager_load!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.57.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Configuration DSL for Ruby libraries and applications