anyway_config 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5deaa09c29ffb32bb0b6454e3c6efc5a3870b01caf4f7794034e7d329d65c43
-  data.tar.gz: 86b948b10fbfac5a56e2cd980a00144f9b6e538dab109923277c00f4466e1220
+  metadata.gz: b57f348945f2dbb59224655d3967880fd8c02adba6b54748b14436266c4c0c5d
+  data.tar.gz: 36101f8dcb28679c746846d861a220ec28d836eb62cbbdaa5cb3f1254b56446b
 SHA512:
-  metadata.gz: 7bd2c01d521402aa0e1dc6ffae192c5a969383e8e7420a24d39af01b5af3d8e7cd62e084c52e093e8496a67b2007358bce586c0d2501745f1092b2fd7ef82903
-  data.tar.gz: 2a3e279019bca94cba9ec99084e4991ead85e36df3b9e7b9436774b04b520f0c3e4c2a33711a9d23cc2d2db404a534ca87e59f7e81182e540cc8502bc68b3d91
+  metadata.gz: d623918a56e50ab8c2f7eba539d2a4c1ea487a3192277525b559443d49328ee2cb70e9739bdd8524298ef3bff69fde6819b26262e245dafd7712a8a2c5a50d27
+  data.tar.gz: 60a2be222bc918750f6896bb4fcb1c2f1a2570ca32780a3f55e8d3610f8f3fdc78033971c9104968f5970c9b3943272f54fe911995dc43819f774a669010c80a

data/.gitignore

@@ -34,6 +34,7 @@ spec/dummy/tmp/
 Gemfile.lock
 Gemfile.local
 .rspec
+.ruby-version
 *.gem
 
 tmp/

data/.rubocop.yml

@@ -19,7 +19,7 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*.rb'
 
-Style/StringLiterals: 
+Style/StringLiterals:
   Enabled: false
 
 Style/BlockDelimiters:
@@ -34,6 +34,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Metrics/ClassLength:
+  Max: 140
+
 Metrics/LineLength:
   Max: 100
 

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## master
 
+## 1.4.0 (2018-10-29)
+
+- Add OptionParse integration ([@jastkand][])
+
+  See more https://github.com/palkan/anyway_config/pull/18
+
+- Use underscored config name as an env prefix. ([@palkan][])
+
+  For a config class:
+
+  ```ruby
+  class MyApp < Anyway::Config
+  end
+  ```
+
+  Before this change we use `MYAPP_` prefix, now it's `MY_APP_`.
+
+  You can specify the prefix explictly:
+
+  ```ruby
+  class MyApp < Anyway::Config
+    env_prefix "MYAPP_"
+  end
+  ```
+
 ## 1.3.0 (2018-06-15)
 
 - Ruby 2.2 is no longer supported.
@@ -67,3 +92,4 @@ Initial version.
 [@onemanstartup]: https://github.com/onemanstartup
 [@dsalahutdinov]: https://github.com/dsalahutdinov
 [@charlie-wasp]: https://github.com/charlie-wasp
+[@jastkand]: https://github.com/jastkand

data/README.md

@@ -91,8 +91,8 @@ 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
+By default, Anyway Config uses underscored config name as a prefix for env variable names (e.g.
+`config_name :my_app` will result to parsing `MY_APP_HOST` variable). You can set env prefix
 explicitly, and it will be used as is:
 
 ```ruby
@@ -105,10 +105,6 @@ module MyCoolGem
 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.
@@ -150,7 +146,7 @@ Your config will be filled up with values from the following sources (ordered by
 By default, Anyway Config is looking for a config YAML at `./config/<config-name>.yml`. You can override this setting
 through special environment variable – 'MYGEM_CONF' – containing the path to the YAML file.
 
-Environmental variables work the same way as with Rails. 
+Environmental variables work the same way as with Rails.
 
 
 ### Config clear and reload
@@ -159,9 +155,49 @@ There are `#clear` and `#reload` functions on your config (which do exactly what
 
 Note: `#reload` also accepts `overrides` key to provide explicit values (see above).
 
+### OptionParser integration
+
+It's possible to use config as option parser (e.g. for CLI apps/libraries). It uses
+[`optparse`](https://ruby-doc.org/stdlib-2.5.1/libdoc/optparse/rdoc/OptionParser.html) under the hood.
+
+Example usage:
+
+```ruby
+class MyConfig < Anyway::Config
+  attr_config :host, :log_level, :concurrency, server_args: {}
+
+  # specify which options shouldn't be handled by option parser
+  ignore_options :server_args
+
+  # provide description for options
+  describe_options(
+    concurrency: "number of threads to use"
+  )
+
+  # extend an option parser object (i.e. add banner or version/help handlers)
+  extend_options do |parser|
+    parser.banner = "mycli [options]"
+    parser.on_tail "-h", "--help" do
+      puts parser
+    end
+  end
+end
+
+config = MyConfig.new
+
+config.parse_options!(%w(--host localhost --port 3333 --log-level debug))
+
+config.host # => "localhost"
+config.port # => 3333
+config.log_level # => "debug"
+
+# Get the instance of OptionParser
+config.option_parser
+```
+
 ## `Rails.application.config_for` vs `Anyway::Config.for`
 
-Rails 4.2 introduced new feature: `Rails.application.config_for`. It looks very similar to 
+Rails 4.2 introduced new feature: `Rails.application.config_for`. It looks very similar to
 `Anyway::Config.for`, but there are some differences:
 
 | Feature       | Rails         | Anyway Config |
@@ -169,7 +205,7 @@ Rails 4.2 introduced new feature: `Rails.application.config_for`. It looks very
 | load data from `config/app.yml`     | yes | yes |
 | load data from `secrets`      | no      |   yes |
 | load data from environment | no   |   yes |
-| return Hash with indifferent access | no | yes | 
+| return Hash with indifferent access | no | yes |
 | support ERB within `config/app.yml` | yes | yes* |
 | raise errors if file doesn't exist | yes | no |
 

data/anyway_config.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.3'
 
   s.add_development_dependency "rspec", "~> 3.5"
-  s.add_development_dependency "rubocop", "~> 0.59.0"
+  s.add_development_dependency "rubocop", "~> 0.60.0"
   s.add_development_dependency "simplecov", ">= 0.3.8"
 end

data/lib/anyway/config.rb

@@ -3,6 +3,7 @@
 require 'anyway/ext/deep_dup'
 require 'anyway/ext/deep_freeze'
 require 'anyway/ext/hash'
+require 'anyway/option_parser_builder'
 
 module Anyway # :nodoc:
   using Anyway::Ext::DeepDup
@@ -14,7 +15,7 @@ module Anyway # :nodoc:
   # configuration parameters and set defaults
   class Config
     class << self
-      attr_reader :defaults, :config_attributes
+      attr_reader :defaults, :config_attributes, :option_parser_extension
 
       def attr_config(*args, **hargs)
         @defaults ||= {}
@@ -36,6 +37,30 @@ module Anyway # :nodoc:
         @config_name
       end
 
+      def ignore_options(*args)
+        @ignore_options ||= []
+        @ignore_options |= args
+      end
+
+      def describe_options(**hargs)
+        @option_parser_descriptions ||= {}
+        @option_parser_descriptions.merge!(hargs.stringify_keys!)
+      end
+
+      def extend_options(&block)
+        @option_parser_extension = block
+      end
+
+      def option_parser_options
+        ignored_options = @ignore_options || []
+        descriptions = @option_parser_descriptions || {}
+        config_attributes.each_with_object({}) do |key, result|
+          next if ignored_options.include?(key.to_sym)
+
+          result[key] ||= descriptions[key.to_s]
+        end
+      end
+
       def env_prefix(val = nil)
         return (@env_prefix = val.to_s) unless val.nil?
 
@@ -72,26 +97,15 @@ module Anyway # :nodoc:
     #
     #   my_config = Anyway::Config.new(name: :my_app, load: true, overrides: { some: :value })
     #
-    # 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?('_') && self.class.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('_')
+      @env_prefix = self.class.env_prefix || @config_name
 
       self.load(overrides) if load
     end
-    # rubocop:enable Metrics/MethodLength,Metrics/AbcSize,Metrics/LineLength,Metrics/CyclomaticComplexity
 
     def reload(overrides = {})
       clear
@@ -135,6 +149,19 @@ module Anyway # :nodoc:
       config
     end
 
+    def option_parser
+      @option_parser ||= begin
+        parser = OptionParserBuilder.call(self.class.option_parser_options) do |key, arg|
+          set_value(key, arg)
+        end
+        self.class.option_parser_extension&.call(parser) || parser
+      end
+    end
+
+    def parse_options!(options)
+      option_parser.parse!(options)
+    end
+
     def to_h
       self.class.config_attributes.each_with_object({}) do |key, obj|
         obj[key.to_sym] = send(key)

data/lib/anyway/env.rb

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
 require 'anyway/ext/deep_dup'
+require 'anyway/ext/string'
 
 module Anyway
   # Parses environment variables and provides
   # method-like access
   class Env
     using Anyway::Ext::DeepDup
-
-    # Regexp to detect array values
-    # Array value is a values that contains at least one comma
-    # and doesn't start/end with quote
-    ARRAY_RXP = /\A[^'"].*\s*,\s*.*[^'"]\z/
+    using Anyway::Ext::String
 
     def initialize
       @data = {}
@@ -33,7 +30,7 @@ module Anyway
         next unless key.start_with?(prefix)
 
         path = key.sub(/^#{prefix}_/, '').downcase
-        set_by_path(data, path, serialize_val(val))
+        set_by_path(data, path, val.serialize)
       end
     end
 
@@ -48,30 +45,5 @@ module Anyway
     def get_hash(from, name)
       (from[name] ||= {})
     end
-
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def serialize_val(value)
-      case value
-      when ARRAY_RXP
-        value.split(/\s*,\s*/).map(&method(:serialize_val))
-      when /\A(true|t|yes|y)\z/i
-        true
-      when /\A(false|f|no|n)\z/i
-        false
-      when /\A(nil|null)\z/i
-        nil
-      when /\A\d+\z/
-        value.to_i
-      when /\A\d*\.\d+\z/
-        value.to_f
-      when /\A['"].*['"]\z/
-        value.gsub(/(\A['"]|['"]\z)/, '')
-      else
-        value
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
   end
 end

data/lib/anyway/ext/hash.rb

@@ -27,6 +27,8 @@ module Anyway
             value.stringify_keys! if value.is_a?(::Hash)
             self[key.to_s] = value
           end
+
+          self
         end
       end
 

data/lib/anyway/ext/string.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Anyway
+  module Ext
+    # Extend String through refinements
+    module String
+      refine ::String do
+        # Regexp to detect array values
+        # Array value is a values that contains at least one comma
+        # and doesn't start/end with quote
+        ARRAY_RXP = /\A[^'"].*\s*,\s*.*[^'"]\z/
+
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def serialize
+          case self
+          when ARRAY_RXP
+            # rubocop:disable Style/SymbolProc
+            split(/\s*,\s*/).map { |word| word.serialize }
+            # rubocop:enable Style/SymbolProc
+          when /\A(true|t|yes|y)\z/i
+            true
+          when /\A(false|f|no|n)\z/i
+            false
+          when /\A(nil|null)\z/i
+            nil
+          when /\A\d+\z/
+            to_i
+          when /\A\d*\.\d+\z/
+            to_f
+          when /\A['"].*['"]\z/
+            gsub(/(\A['"]|['"]\z)/, '')
+          else
+            self
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/CyclomaticComplexity
+      end
+
+      using self
+    end
+  end
+end

data/lib/anyway/option_parser_builder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'anyway/ext/string'
+
+module Anyway # :nodoc:
+  using Anyway::Ext::String
+
+  # Initializes the OptionParser instance using the given configuration
+  class OptionParserBuilder
+    class << self
+      def call(options)
+        OptionParser.new do |opts|
+          options.each do |key, description|
+            opts.on(*option_parser_on_args(key, description)) do |arg|
+              yield [key, arg.serialize]
+            end
+          end
+        end
+      end
+
+      private
+
+      def option_parser_on_args(key, description)
+        on_args = ["--#{key.to_s.tr('_', '-')} VALUE"]
+        on_args << description unless description.nil?
+        on_args
+      end
+    end
+  end
+end

data/lib/anyway/version.rb

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

data/spec/config_spec.rb

@@ -109,10 +109,6 @@ describe Anyway::Config do
           klass.new
         end
 
-        it "warns user about deprecated behaviour" do
-          expect { conf }.to print_warning
-        end
-
         context "when env_name is set" do
           let(:conf) do
             klass = CoolConfig.dup
@@ -177,8 +173,8 @@ describe Anyway::Config do
     end
 
     it "load data by config name", :aggregate_failures do
-      ENV['MYAPP_TEST'] = '1'
-      ENV['MYAPP_NAME'] = 'my_app'
+      ENV['MY_APP_TEST'] = '1'
+      ENV['MY_APP_NAME'] = 'my_app'
       Anyway.env.clear
       data = Anyway::Config.for(:my_app)
       expect(data[:test]).to eq 1
@@ -236,4 +232,87 @@ describe Anyway::Config do
       expect(new_config.new_param).to eq 'a'
     end
   end
+
+  describe "#parse_options!" do
+    let(:config_instance) { config.new }
+
+    context "when `ignore_options` is not provided" do
+      let(:config) do
+        Class.new(described_class) do
+          config_name 'optparse'
+          attr_config :host, :port, :log_level, :debug
+        end
+      end
+
+      it "parses ARGC string" do
+        config_instance.parse_options!(%w[--host localhost --port 3333 --log-level debug --debug T])
+        expect(config_instance.host).to eq("localhost")
+        expect(config_instance.port).to eq(3333)
+        expect(config_instance.log_level).to eq("debug")
+        expect(config_instance.debug).to eq(true)
+      end
+    end
+
+    context 'when `ignore_options` is provided' do
+      let(:config) do
+        Class.new(described_class) do
+          config_name 'optparse'
+          attr_config :host, :log_level, :concurrency, server_args: {}
+
+          ignore_options :server_args
+        end
+      end
+
+      it "parses ARGC string" do
+        expect do
+          config_instance.parse_options!(
+            %w[--host localhost --concurrency 10 --log-level debug --server-args SOME_ARGS]
+          )
+        end.to raise_error(OptionParser::InvalidOption, /--server-args/)
+
+        expect(config_instance.host).to eq("localhost")
+        expect(config_instance.concurrency).to eq(10)
+        expect(config_instance.log_level).to eq("debug")
+        expect(config_instance.server_args).to eq({})
+      end
+    end
+
+    context 'when `describe_options` is provided' do
+      let(:config) do
+        Class.new(described_class) do
+          config_name 'optparse'
+          attr_config :host, :log_level, :concurrency, server_args: {}
+
+          describe_options(
+            concurrency: "number of threads to use"
+          )
+        end
+      end
+
+      it "contains options description" do
+        expect(config_instance.option_parser.help).to include("number of threads to use")
+      end
+    end
+
+    context "customization of option parser" do
+      let(:config) do
+        Class.new(described_class) do
+          config_name 'optparse'
+          attr_config :host, :log_level, :concurrency, server_args: {}
+
+          extend_options do |parser|
+            parser.banner = "mycli [options]"
+
+            parser.on_tail "-h", "--help" do
+              puts parser
+            end
+          end
+        end
+      end
+
+      it "allows to customize the parser" do
+        expect(config_instance.option_parser.help).to include("mycli [options]")
+      end
+    end
+  end
 end

data/spec/ext/hash_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Anyway::Ext::Hash do
+  using Anyway::Ext::Hash
+
+  describe "#stringify_keys!" do
+    let(:source) do
+      {
+        a: 1,
+        b: 'hello',
+        c: {
+          id: 1
+        }
+      }
+    end
+
+    let(:expected_result) do
+      {
+        'a' => 1,
+        'b' => 'hello',
+        'c' => {
+          'id' => 1
+        }
+      }
+    end
+
+    it "transforms keys of hash to strings" do
+      source.stringify_keys!
+
+      expect(source).to eq(expected_result)
+    end
+
+    it "returns a hash with transformed keys to strings" do
+      expect(source.stringify_keys!).to eq(expected_result)
+    end
+  end
+end

data/spec/ext/string_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Anyway::Ext::String do
+  using Anyway::Ext::String
+
+  it "serializes a string", :aggregate_failures do
+    expect("1,2, 3".serialize).to eq [1, 2, 3]
+
+    expect("t".serialize).to eq true
+    expect("true".serialize).to eq true
+    expect("y".serialize).to eq true
+    expect("yes".serialize).to eq true
+
+    expect("f".serialize).to eq false
+    expect("false".serialize).to eq false
+    expect("n".serialize).to eq false
+    expect("no".serialize).to eq false
+
+    expect("null".serialize).to eq nil
+    expect("nil".serialize).to eq nil
+
+    expect("1".serialize).to eq 1
+
+    expect("1.5".serialize).to eq 1.5
+
+    expect("'localhost'".serialize).to eq "localhost"
+
+    expect("localhost".serialize).to eq "localhost"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.0
+        version: 0.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.0
+        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +82,8 @@ files:
 - lib/anyway/ext/deep_dup.rb
 - lib/anyway/ext/deep_freeze.rb
 - lib/anyway/ext/hash.rb
+- lib/anyway/ext/string.rb
+- lib/anyway/option_parser_builder.rb
 - lib/anyway/rails/config.rb
 - lib/anyway/version.rb
 - lib/anyway_config.rb
@@ -100,6 +102,8 @@ files:
 - spec/env_spec.rb
 - spec/ext/deep_dup_spec.rb
 - spec/ext/deep_freeze_spec.rb
+- spec/ext/hash_spec.rb
+- spec/ext/string_spec.rb
 - spec/spec_helper.rb
 - spec/spec_norails_helper.rb
 - spec/support/cool_config.rb
@@ -126,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Configuration DSL for Ruby libraries and applications