iron-settings 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30675b76476bbdbc880ba503df09e58edaabce5a
-  data.tar.gz: e4f5b24d064e9ce607a645fe786834d779487e06
+  metadata.gz: 3ff3ceb048486b314e176cb0a6c7733f2bf50c3c
+  data.tar.gz: 706357ea7822e59582d9e049d9c3cd4ab8e28ac4
 SHA512:
-  metadata.gz: 85fbd26e319de40c6d1e11e14bdb1d99ec028bef8ddaf039c3f9525809a6507f2b398a940a30c06f9ec08fa8af75589f4e66b7d74e890052b1cde976f06d3b3e
-  data.tar.gz: ba83a460b831a995f11bf53d3550d0ddbbe40e9bea4f3f2207144d59c793e74ba7584059c44955272d1e47ce9fd4eb5a254f133f386f0a35d5a7909877eb8c15
+  metadata.gz: f28ef71c9d33a6fa6b3c3dcfa212b049585dd584c9e4861de91f0f590e173df8745ba64a08d2d8c2a63784c94b91f6fc2a472e0ca6e7231b73d0aec953692d8f
+  data.tar.gz: fdb528d297029f1684812e8dc76dd5daa99b859d5d5e65cb827cb979ca86888a4e5302fa0cab6591d1366d2c823e7185a48a691079c375d8dea75d8a50e6ead0

data/History.txt

@@ -1,3 +1,9 @@
+== 1.0.4 / 2018-01-03
+
+* Update docs to show group setting for static values
+* Add Cursor#entry_values to allow getting a hash of all values for a given group
+* Update Cursor#method_missing to return false if querying for a missing entry
+
 == 1.0.3 / 2015-01-27
 
 * Update to use new 1.2 version of iron-extensions and add dependency on iron-dsl gem

data/README.rdoc

@@ -72,6 +72,10 @@ configuration info.
       class_settings(:file => '~/.mytool') do
         string('api_key')
         string('base_path', '~')
+        group('options') do
+          bool('debug', false)
+          bool('verbose', false)
+        end
       end
       
       def initialize
@@ -85,10 +89,15 @@ configuration info.
   
     end
     
-Now, your users could create a .mytool file like so:
+Now, your users could create a .mytool file like so.  Notice how there are no equals signs,
+and the group settings can be accessed in a block:
 
     api_key   '1234ASDF'
     base_path '~/code'
+    options do
+      debug   true
+      verbose true
+    end
     
 On calling MyTool.settings, this file would be loaded and override the settings defaults.
     
@@ -127,7 +136,7 @@ RVM users can skip the sudo:
 
 Then use
 
-    require 'iron/settings'
+    require 'iron-settings'
     
 to require the library code.
 

data/Version.txt

@@ -1 +1 @@
-1.0.3
+1.0.4

data/lib/iron-settings.rb

@@ -0,0 +1 @@
+require 'iron/settings'

data/lib/iron/settings.rb

@@ -122,6 +122,7 @@ class Settings
 
   def self.classes
     @classes ||= []
+    @classes
   end
 
   def self.default_timestamp_file(class_name)

data/lib/iron/settings/class_level.rb

@@ -37,6 +37,7 @@ class Settings #:nodoc:
       # of need to reload automatically.  Useful for testing, but not generally needed in production use
       def reload_settings
         @settings_values.load
+        true
       end
 
     end

data/lib/iron/settings/cursor.rb

@@ -29,6 +29,14 @@ class Settings
       keys
     end
     
+    # Returns a hash of all entry keys to their values at the cursor's current 
+    # position, and optionally including all child keys.  If the cursor is at 
+    # a sub-group node, keys will be relative to that node.
+    def entry_values(include_all = true)
+      keys = entry_keys(include_all)
+      keys.convert_to_hash {|k| item_value(find_item(k)) }
+    end
+    
     # Returns all group keys
     def group_keys(include_all = false)
       keys = @group.entries(include_all).collect {|e| e.key }
@@ -93,7 +101,13 @@ class Settings
       item = @group.find_item(method)
       if item.nil?
         # Unknown item name, whoops.
-        raise RuntimeError.new("Unknown settings group or entry '#{method}' for settings path #{@group.key}")
+        if query
+          # Querying for existence of key is fine if it's missing
+          return false
+        else
+          # Setting or getting, GTFO
+          raise RuntimeError.new("Unknown settings group or entry '#{method}' for settings path #{@group.key}")
+        end
         
       elsif item.group?
         if query

data/spec/settings/cursor_spec.rb

@@ -91,5 +91,20 @@ describe Settings::Cursor do
   it 'should eval lambda defaults in the context of the root cursor' do
     CursorTest.settings.top.middle.bottom.lamby.should == 6
   end
+
+  it 'should return a hash of keys to vals' do
+    CursorTest.settings.invalid_default = 'hi'
+    CursorTest.settings.entry_values.should == {
+      'val1' => 5,
+      'val2' => nil,
+      'top.middle.bottom.lamby' => 6,
+      'top.middle.bottom.leaf' => nil,
+      'invalid_default' => 'hi'
+    }
+  end
+  
+  it 'should return false on interrogating a missing key' do
+    CursorTest.settings.bob?.should be_false
+  end
   
 end

data/spec/spec_helper.rb

@@ -38,6 +38,11 @@ RSpec.configure do |config|
   config.color = true
   config.add_formatter 'documentation'
   config.backtrace_exclusion_patterns = [/rspec/]
+  # Allow us to use: it '...', :focus do ... end 
+  # rather than needing: it '...', :focus => true do ... end
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # If everything is filtered, run everything - used if no :focus element is present
+  config.run_all_when_everything_filtered = true
 end
 
 module SpecHelper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iron-settings
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Rob Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iron-extensions
@@ -66,6 +66,7 @@ files:
 - README.rdoc
 - Version.txt
 - db/settings_migration.rb
+- lib/iron-settings.rb
 - lib/iron/rake_loader.rb
 - lib/iron/settings.rb
 - lib/iron/settings/builder.rb