anyway_config 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efb55eb76ff8fe050d265f9f73af34e1ca813134
-  data.tar.gz: ea56b66f8d7eb4b6d63a4fb068c1631feb6d49e9
+  metadata.gz: f61c3efab21364fb9d6f502183bcf2a15edd5207
+  data.tar.gz: '08ca86bbc7687a451f035051d9584a7d8b76c955'
 SHA512:
-  metadata.gz: a282acf7111e9dab9fbcc995f97604ded970617b0fdf8c5db7b5db612911253bf6aea75cbc7f1e21c383237aab6e45798a9c159d69c4bccf21a54a05af5d2763
-  data.tar.gz: 66aa6cefebd02087c6926927d805803a7885399b10b31e729e9d33cf7a8f8722e3dcb0cf1c453f580aaf8394b21d4325503a73afb4282b8f6ed2e6d1156aa378
+  metadata.gz: e665ffd00ff4b055cfc4eaece0f9aec66e69638fd7a18b4151d740c6e434678764c8bbbbaf2852238ad2c2f6551826e9d619cf8d592ec7f2d974763c44507b1a
+  data.tar.gz: f259801f4db6626cc0356c07439dda350718c08073db6e4a40c891e8c45820dde4eb3f87812478936902eee2cca7def1859e0d13a10740912fb9ca7af2f65c21

data/.rubocop.yml

@@ -13,7 +13,7 @@ AllCops:
     - 'vendor/**/*'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.2
 
 Style/Documentation:
   Exclude:
@@ -36,3 +36,9 @@ Metrics/BlockLength:
 
 Metrics/LineLength:
   Max: 100
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## 1.1.0 (2017-10-06)
+
+- Add `#to_h` method. ([@palkan][])
+
+See [#4](https://github.com/palkan/anyway_config/issues/4).
+
+- Make it possible to extend configuration parameters. ([@palkan][])
+
 ## 1.0.0 (2017-06-20)
 
 - Lazy load and parse ENV configurtaion. ([@palkan][])

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in anyway_config.gemspec
 gem 'sqlite3'
+gem 'pry-byebug'
 gemspec
 
 local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"

data/anyway_config.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)

data/lib/anyway/config.rb

@@ -2,11 +2,13 @@
 
 require 'anyway/ext/class'
 require 'anyway/ext/deep_dup'
+require 'anyway/ext/deep_freeze'
 require 'anyway/ext/hash'
 
 module Anyway # :nodoc:
   using Anyway::Ext::Class
   using Anyway::Ext::DeepDup
+  using Anyway::Ext::DeepFreeze
   using Anyway::Ext::Hash
 
   # Base config class
@@ -17,10 +19,16 @@ module Anyway # :nodoc:
       attr_reader :defaults, :config_attributes
 
       def attr_config(*args, **hargs)
-        @defaults = hargs.deep_dup
-        defaults.stringify_keys!
-        @config_attributes = args + defaults.keys
-        attr_accessor(*@config_attributes)
+        @defaults ||= {}
+        @config_attributes ||= []
+
+        new_defaults = hargs.deep_dup
+        new_defaults.stringify_keys!
+        defaults.merge! new_defaults
+
+        new_keys = (args + new_defaults.keys) - config_attributes
+        @config_attributes += new_keys
+        attr_accessor(*new_keys)
       end
 
       def config_name(val = nil)
@@ -44,6 +52,7 @@ module Anyway # :nodoc:
 
     def initialize(config_name = nil, do_load = true)
       @config_name = config_name || self.class.config_name
+      raise ArgumentError, "Config name is missing" unless @config_name
       load if do_load
     end
 
@@ -88,6 +97,12 @@ module Anyway # :nodoc:
       config
     end
 
+    def to_h
+      self.class.config_attributes.each_with_object({}) do |key, obj|
+        obj[key.to_sym] = send(key)
+      end.deep_dup.deep_freeze
+    end
+
     private
 
     def set_value(key, val)

data/lib/anyway/ext/deep_freeze.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Anyway
+  module Ext
+    # Add #deep_freeze to hashes and arrays
+    module DeepFreeze
+      refine ::Hash do
+        def deep_freeze
+          freeze
+          each_value do |value|
+            value.deep_freeze if value.is_a?(::Hash) || value.is_a?(::Array)
+          end
+        end
+      end
+
+      refine ::Array do
+        def deep_freeze
+          freeze
+          each do |value|
+            value.deep_freeze if value.is_a?(::Hash) || value.is_a?(::Array)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anyway/ext/hash.rb

@@ -22,7 +22,7 @@ module Anyway
         end
 
         def stringify_keys!
-          keys.each do |key|
+          keys.each do |key| # rubocop: disable Performance/HashEachMethods
             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.0.0"
+  VERSION = "1.1.0"
 end

data/spec/config_spec.rb

@@ -6,7 +6,7 @@ describe Anyway::Config do
   let(:conf) { CoolConfig.new }
   let(:test_conf) { Anyway::TestConfig.new }
 
-  describe "config with name" do
+  context "config with name" do
     before(:each) do
       ENV.delete_if { |var| var =~ /^(cool|anyway)_/i }
     end
@@ -26,6 +26,25 @@ describe Anyway::Config do
       expect(conf).to respond_to(:user)
     end
 
+    describe "#to_h" do
+      subject(:config) { CoolConfig.new }
+
+      it "returns deeply frozen hash" do
+        hashed = config.to_h
+
+        expect(hashed).to be_a(Hash)
+        expect(hashed).to be_frozen
+        expect(hashed[:user]).to be_frozen
+      end
+
+      it "returns new hash every time" do
+        hashed = config.to_h
+        hashed2 = config.to_h
+
+        expect(hashed).to be_eql(hashed2)
+      end
+    end
+
     describe "load from files" do
       it "set defaults" do
         expect(conf.port).to eq 8080
@@ -87,7 +106,7 @@ describe Anyway::Config do
     end
   end
 
-  describe "config for name" do
+  context "config for name" do
     before(:each) do
       ENV.delete_if { |var| var =~ /^myapp_/i }
     end
@@ -104,4 +123,46 @@ describe Anyway::Config do
       end
     end
   end
+
+  context "config without defaults" do
+    let(:conf) { SmallConfig.new }
+
+    it "works" do
+      expect(conf.meta).to be_nil
+      expect(conf.data).to be_nil
+    end
+  end
+
+  context "when name is missing" do
+    let(:config) do
+      Class.new(described_class)
+    end
+
+    it "raises ArgumentError" do
+      expect { config.new }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "extending config" do
+    let(:config) do
+      Class.new(described_class) do
+        config_name 'testo'
+        attr_config :test, debug: false
+      end
+    end
+
+    it "adds new params" do
+      old_config = config.new
+
+      expect(old_config.debug).to eq false
+      expect(old_config.test).to be_nil
+
+      config.attr_config new_param: 'a'
+
+      new_config = config.new
+      expect(new_config.debug).to eq false
+      expect(new_config.test).to be_nil
+      expect(new_config.new_param).to eq 'a'
+    end
+  end
 end

data/spec/config_spec_norails.rb

@@ -61,7 +61,7 @@ describe Anyway::Config do
 
       let(:conf) { empty_config_class.new }
 
-      specify { expect(conf.config_name).to be_nil }
+      specify { expect { conf.config_name }.to raise_error(ArgumentError) }
     end
 
     context "loading from default path" do

data/spec/ext/deep_freeze_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'anyway/ext/deep_freeze'
+
+describe Anyway::Ext::DeepFreeze do
+  using Anyway::Ext::DeepFreeze
+
+  it "freezes nested arrays and hashes", :aggregate_failures do
+    source = {
+      a: 1,
+      b: 'hello',
+      c: {
+        id: 1,
+        list: [1, 2, { name: 'John' }]
+      },
+      d: [{ id: 1 }, { id: 2 }]
+    }
+
+    dup = source.deep_freeze
+
+    expect(dup).to be_frozen
+    expect(dup[:c]).to be_frozen
+    expect(dup[:d]).to be_frozen
+
+    expect(dup[:c][:list]).to be_frozen
+    expect(dup[:c][:list].last).to be_frozen
+
+    expect(dup[:d].first).to be_frozen
+    expect(dup[:d].last).to be_frozen
+  end
+end

data/spec/support/small_config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class SmallConfig < Anyway::Config # :nodoc:
+  config_name :small
+  attr_config :meta,
+              :data
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-20 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -79,6 +79,7 @@ files:
 - lib/anyway/env.rb
 - lib/anyway/ext/class.rb
 - lib/anyway/ext/deep_dup.rb
+- lib/anyway/ext/deep_freeze.rb
 - lib/anyway/ext/hash.rb
 - lib/anyway/rails/config.rb
 - lib/anyway/version.rb
@@ -97,9 +98,11 @@ files:
 - spec/dummy/config/secrets.yml
 - spec/env_spec.rb
 - spec/ext/deep_dup_spec.rb
+- spec/ext/deep_freeze_spec.rb
 - spec/spec_helper.rb
 - spec/spec_norails_helper.rb
 - spec/support/cool_config.rb
+- spec/support/small_config.rb
 - spec/support/test_config.rb
 homepage: http://github.com/palkan/anyway_config
 licenses:
@@ -121,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Configuration DSL for Ruby libraries and applications