fig_tree 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 359a81208b3825233a55fd631b7b4e9c00ba34451286679c5ceb2c93cc50787d
-  data.tar.gz: 58f8342253d10c7d37575a05761b05f89d9bff3579f85ba682cc5341a0b55b29
+  metadata.gz: 05e904a52d3b7edb7d02d48b4d063db396de7918b6b1de8f277cfcc6fcbe7cb2
+  data.tar.gz: 58334d1b630a134a2e08cefc03d1131d130ff550d9d0a89e350f57ccdb676002
 SHA512:
-  metadata.gz: 6ec628b03063fc54940a2a6503362d4c13937541865a786f1a1197719b0b4e4e08a4eb24c07acf32cd99237010ef53b7d2247c224f7900da41567a8b414d30c4
-  data.tar.gz: d29f30d43a4bc821da27b36c5c3c3af7e983780eb758f6baa5a55e638427a94844a2284341977e3a75d0792ab8a725cc9c80e9c20608d61e5ebf1c02bb015d08
+  metadata.gz: ef3fff25ee51e1bc67f5657a3574e303ca2346cf651379261ca915878d9b3d9e679b5acc6778b995bdac8dc1c412724c9540926563e020983d570ad53103493a
+  data.tar.gz: 0b80fb3feee7165b47a7ce1121cd7f374ba40fa2687adfbc94e7237692f78c36c3698e72643666e96da6d208a329b784e0789aaec7352e1461cca4e36d712d5d

data/CHANGELOG.md

@@ -7,5 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
-## [0.0.1] - 2021-02-17
+## [0.0.4] - 2022-05-16
+- Added `with_config` method for testing.
+
+## [0.0.2] - 2021-02-17
 - Initial release.

data/README.md

@@ -188,6 +188,18 @@ FileCreator.user_read = true
 # config.user_read is deprecated - use config.file_options.user_read
 ```
 
+## Testing
+
+You can use the `with_config` method to test your code with specific config values that get 
+reset after the block is done executing:
+
+```ruby
+FileCreator.with_config('file_options.group_name' => 'root') do
+  # test this code
+end
+# file_options.group_name will be set back to the original value afterwards
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/fig_tree .

data/fig_tree.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Configuration framework for Ruby.'
   spec.homepage      = ''
   spec.license       = 'Apache-2.0'
-  spec.required_ruby_version = '2.3'
+  spec.required_ruby_version = '>= 2.3'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/fig_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FigTree
-  VERSION = '0.0.1'
+  VERSION = '0.0.4'
 end

data/lib/fig_tree.rb

@@ -241,6 +241,34 @@ module FigTree
       @config ||= ConfigStruct.new('config')
     end
 
+    # Evaluate a block with the given configuration values. Reset back to the original values
+    # when done.
+    # @param values [Hash]
+    def with_config(values={}, &block) # rubocop:disable Metrics/AbcSize
+      set_value = lambda do |k, v|
+        obj = self.config
+        tokens = k.split('.')
+        tokens[0..-2].each do |token|
+          obj = obj.send(token)
+        end
+        obj.send(:"#{tokens.last}=", v)
+      end
+
+      get_value = lambda do |k|
+        obj = self.config
+        tokens = k.split('.')
+        tokens.each do |token|
+          obj = obj.send(token)
+        end
+        obj
+      end
+
+      old_values = values.keys.map { |k| [k, get_value.call(k)] }.to_h
+      values.each { |k, v| set_value.call(k, v) }
+      block.call
+      old_values.each { |k, v| set_value.call(k, v) }
+    end
+
     # Pass a block to run after configuration is done.
     def after_configure(&block)
       mod = self

data/spec/fig_tree_spec.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'fig_tree'
+
+# :nodoc:
+class MyConfig
+  include FigTree
+
+  define_settings do
+    setting :set1
+    setting :set2, 'hi mom'
+    setting :group do
+      setting :set3, default_proc: proc { false }
+      setting :set5, (proc { 5 })
+    end
+
+    setting_object :listy do
+      setting :list1, 10
+      setting :list2, 5
+    end
+  end
+end
+
+describe FigTree do
+  it 'should configure correctly with default values' do
+    expect(MyConfig.config.set1).to be_nil
+    expect(MyConfig.config.set2).to eq('hi mom')
+    expect(MyConfig.config.group.set3).to eq(false)
+    expect(MyConfig.config.listy_objects).to be_empty
+    expect { MyConfig.config.blah }.to raise_error(NameError)
+    expect { MyConfig.config.group.set4 }.to raise_error(NameError)
+  end
+
+  it 'should not call the proc until it has to' do
+    num_calls = 0
+    value_proc = proc do
+      num_calls += 1
+      num_calls
+    end
+    MyConfig.define_settings do
+      setting :set_with_proc, default_proc: value_proc
+    end
+    expect(num_calls).to eq(0)
+    expect(MyConfig.config.set_with_proc).to eq(1)
+    # calling twice should not call the proc again
+    expect(MyConfig.config.set_with_proc).to eq(1)
+    expect(num_calls).to eq(1)
+  end
+
+  it "should raise error when setting configs that don't exist" do
+    expect { MyConfig.configure { set15('some_value') } }.to raise_error(NameError)
+  end
+
+  it 'should add values' do
+    MyConfig.configure do |config|
+      config.set1 = 5 # config.x syntax
+      set2 nil # method_missing syntax
+      config.group.set3 = true
+    end
+
+    # second configure should not blow anything away
+    MyConfig.configure do
+      listy do
+        list1 0
+        list2 1
+      end
+      listy do
+        list1 100
+        list2 200
+      end
+    end
+
+    expect(MyConfig.config.set1).to eq(5)
+    expect(MyConfig.config.set2).to be_nil
+    expect(MyConfig.config.group.set3).to eq(true)
+    expect(MyConfig.config.listy_objects.map(&:to_h)).
+      to eq([
+              { list1: 0, list2: 1 },
+              { list1: 100, list2: 200 }
+            ])
+
+    # test reset!
+    MyConfig.config.reset!
+    expect(MyConfig.config.set1).to be_nil
+    expect(MyConfig.config.set2).to eq('hi mom')
+    expect(MyConfig.config.group.set3).to eq(false)
+    expect(MyConfig.config.listy_objects).to be_empty
+  end
+
+  it 'should add with block syntax' do
+    MyConfig.configure do
+      group do
+        set5(proc { 10 })
+      end
+    end
+    expect(MyConfig.config.group.set5.call).to eq(10)
+  end
+
+  it 'should add or redefine settings' do
+    MyConfig.define_settings do
+      setting :group do
+        setting :set6, 15
+        setting :set5, (proc { 15 })
+      end
+      setting_object :notey do
+        setting :note_title, 'some-title'
+      end
+    end
+
+    expect(MyConfig.config.group.set6).to eq(15)
+    expect(MyConfig.config.group.set5.call).to eq(15)
+    expect(MyConfig.config.listy_objects).to be_empty
+    expect(MyConfig.config.notey_objects).to be_empty
+
+    MyConfig.configure do
+      notey do
+        note_title 'hi mom'
+      end
+      listy do
+        list1 0
+      end
+    end
+    expect(MyConfig.config.notey_objects.size).to eq(1)
+    expect(MyConfig.config.notey_objects.first.note_title).to eq('hi mom')
+    expect(MyConfig.config.listy_objects.size).to eq(1)
+    expect(MyConfig.config.listy_objects.first.list1).to eq(0)
+
+    # This should not remove any keys
+    MyConfig.define_settings do
+      setting :group do
+        setting :set6, 20
+      end
+    end
+    expect(MyConfig.config.group.set6).to eq(20)
+    expect(MyConfig.config.group.set5.call).to eq(15)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fig_tree
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -144,6 +144,7 @@ files:
 - fig_tree.gemspec
 - lib/fig_tree.rb
 - lib/fig_tree/version.rb
+- spec/fig_tree_spec.rb
 - spec/spec_helper.rb
 - support/flipp-logo.png
 homepage: ''
@@ -156,7 +157,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -165,9 +166,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Configuration framework for Ruby.
 test_files:
+- spec/fig_tree_spec.rb
 - spec/spec_helper.rb