hexx-settings 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eea12d82992465509602ac4fa8286d33979127fa
-  data.tar.gz: 15b2a30e2c8444d6aadd45b7a0731e439dc0529c
+  metadata.gz: ccaf5248db078fad3c483a32553e641e96787f76
+  data.tar.gz: c8731c6418062d828cf63e0a08a039482a8a4447
 SHA512:
-  metadata.gz: c58582296a1408686e04a2649b6e1d99ff5067fd46ef6dab5bc556b2e3270053ecbf45413e9f644a871d46890a27a20d38c10ebec530a530a3dd41849bee98d9
-  data.tar.gz: a78956b1beaca51250139f65598f4cecb898dd00f2cdbac4872093bce8161247d1f5d442aba01912c8cb066dfab14979fc73fc143c572bea6ba624bb247ab1dd
+  metadata.gz: ceb08c39c2f162e7dd41386c787430d0bead4fd30881b20a942e40978b7f4a266e03f3443f5479818f49c5f82e8e1873b759a67c6c01457d735ce68d7083847c
+  data.tar.gz: 5f9ba43c2564f68e5b102a1c2f0ea6a94ec4bfdc9a4db0922128b73615a1512c7c04b3fd62c5f63425394d914799b8a41e744305575d243ea4561ecf9a4bd6de

data/Guardfile

@@ -5,7 +5,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   watch(%r{^spec/.+_spec.rb$})
 
   watch(%r{^lib/hexx(.+)\.rb$}) do |m|
-    "spec/tests#{ m[1] }_spec.rb"
+    "spec/unit#{ m[1] }_spec.rb"
   end
 
   watch("lib/hexx-settings.rb") { "spec" }

data/README.md

@@ -35,29 +35,44 @@ end # module MyGem
 
 The class provides a [singleton instance] to store settings in.
 
-Class `Settings` predefines `configure` and `[]` class methods.
-The first one yields the block with the instance of its own, the second
-is a shortcut to the instance methods.
+### configure
+
+The class method `.configure` yields the block with access to its configurable
+singleton instance:
 
 ```ruby
 MyGem::Settings.configure do |config|
   config.foo = :bar
 end
+```
+
+### []
 
-MyGem::Settings.instance.foo # => :bar
-# this is the same as above:
-MyGem::Settings[:foo]        # => :bar
+The class method `[]` is a shortcut to the instance variable:
+
+```ruby
+MyGem::Settings[:foo] # => :bar
 ```
 
-It also provides the class method `.initialize_from` to try loading
-settings from given initializer:
+### initialize_from
+
+The class method `.initialize_from` to load settings from given initializer:
 
 ```ruby
 MyGem::Settings.initialize_from "my_module", at: ENV["PATH_TO_INITIALIZERS"]
 ```
 
-The method doesn't fail when the initializer hasn't been found, but instead
-warns the user.
+The method doesn't fail when the initializer hasn't been found,
+but only warns the user.
+
+### reset
+
+The class method `.reset` clears all settings
+
+```ruby
+MyGem::Settings.reset
+MyGem::Settings[:foo] # => nil
+```
 
 [singleton instance]: http://ruby-doc.org/stdlib-1.9.3/libdoc/singleton/rdoc/Singleton.html
 

data/lib/hexx/settings.rb

@@ -70,6 +70,16 @@ module Hexx
       warn "You should provide the '#{ filename }' initializer"
     end
 
+    # Resets all settings
+    #
+    # @return [undefined]
+    #
+    def self.reset
+      instance.instance_variables.each do |variable|
+        instance.instance_variable_set variable, nil
+      end
+    end
+
   end # class Settings
 
 end # module Hexx

data/lib/hexx/settings/version.rb

@@ -6,7 +6,7 @@ module Hexx
 
     # The semantic version of the module.
     # @see http://semver.org/ Semantic versioning 2.0
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
 
   end # class Settings
 

data/spec/{tests → unit}/settings_spec.rb

@@ -133,4 +133,15 @@ describe Hexx::Settings do
 
   end # describe .initialize_from
 
+  describe ".reset" do
+
+    before  { instance.foo = "foo" }
+    subject { klass.reset         }
+
+    it "resets settings" do
+      expect { subject }.to change { klass[:foo] }.from("foo").to nil
+    end
+
+  end # describe .reset
+
 end # describe Hexx::Settings

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx-settings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
@@ -60,7 +60,7 @@ files:
 - lib/hexx/settings.rb
 - lib/hexx/settings/version.rb
 - spec/spec_helper.rb
-- spec/tests/settings_spec.rb
+- spec/unit/settings_spec.rb
 homepage: https://github.com/nepalez/hexx-settings
 licenses:
 - MIT
@@ -87,5 +87,5 @@ specification_version: 4
 summary: The interface for a gem's settings storage
 test_files:
 - spec/spec_helper.rb
-- spec/tests/settings_spec.rb
+- spec/unit/settings_spec.rb
 has_rdoc: