mongoid-app_settings 0.1.0 → 1.0.0

data/README.markdown

@@ -1,6 +1,14 @@
-# mongoid-app_settings
+# mongoid-app\_settings
 
-[![Build Status](https://secure.travis-ci.org/marten/mongoid-app_settings.png)](http://travis-ci.org/marten/mongoid-app_settings)
+[![Build Status](https://secure.travis-ci.org/marten/mongoid-app_settings.png)](http://travis-ci.org/marten/mongoid-app\_settings)
+
+This is a fairly simple gem to let you work with application configuration
+that's stored in Mongoid. It's inspired by a similar project called
+[rails-settings](https://github.com/ledermann/rails-settings), except this
+stores it in MongoDB using Mongoid.
+
+It's a little more explicit in that it requires you to define a list of 
+settings beforehand.
 
 ## Usage
 
@@ -26,7 +34,23 @@ Then you can do things like:
     MySettings.something_else
     => "FooBar"
 
-# Contributing to mongoid-app_settings
+You can unset a value (reverting it to the default if given):
+
+    MySettings.reset(:enable_my_feature)
+    MySettings.enable_my_feature
+    => true
+
+You can get a list of all values:
+
+    MySettings.all
+    => {:enable_my_feature => true, :something_else => "FooBar"}
+
+You can get a list of defaults:
+
+    MySettings.defaults
+    => {:enable_my_feature => true, :something_else => nil}
+
+# Contributing to mongoid-app\_settings
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/lib/mongoid-app_settings.rb

@@ -48,6 +48,27 @@ module Mongoid
         @record = nil
       end
 
+      # Unsets a set value, resetting it to its default
+      def delete(setting)
+        @record.unset(setting)
+      end
+
+      def all
+        {}.tap do |result|
+          settings.each do |setting, options|
+            result[setting.to_sym] = self.send(setting)
+          end
+        end
+      end
+
+      def defaults
+        {}.tap do |result|
+          settings.each do |setting, options|
+            result[setting.to_sym] = options[:default]
+          end
+        end
+      end
+
       protected
 
       def settings # :nodoc:

data/mongoid-app_settings.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid-app_settings"
-  s.version = "0.1.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marten Veldthuis"]
-  s.date = "2011-12-22"
+  s.date = "2012-01-02"
   s.description = "Mongoid::AppSettings allows you to store settings in MongoDB, and access them easily"
   s.email = "marten@veldthuis.com"
   s.extra_rdoc_files = [

data/spec/mongoid-app_settings_spec.rb

@@ -13,81 +13,130 @@ describe "Mongoid::AppSettings" do
     other_settings
   end
 
-  it "should be possible to save a setting" do 
-    settings.instance_eval { setting :something }
-    settings.something = "some nice value"
-    settings.something.should == "some nice value"
+  describe "defining settings" do
+    it "should be possible to define a setting" do
+      settings.instance_eval { setting :something }
+      settings.something.should be_nil
+    end
+
+    it "should be possible to specify default values" do
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo.should == "bar"
+    end
+
+    it "should be possible to use defaults of other settings in defaults" do
+      settings.instance_eval { setting :foo, :default => "bar"
+                              setting :baz, :default => "#{foo} quux" }
+      settings.baz.should == "bar quux"
+    end
+
+    it "should be possible to use values of other settings in defaults" do
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo = "baz"
+      settings.instance_eval { setting :qux, :default => "#{foo} quux" }
+      settings.qux.should === "baz quux"
+    end
+
+    it "should define fields on the record" do
+      settings.instance_eval { setting :something }
+      expect { 
+        settings.send(:record).something 
+      }.not_to raise_error(NoMethodError)
+    end
   end
 
-  it "should define fields on the record" do
-    settings.instance_eval { setting :something }
-    expect { 
-      settings.send(:record).something 
-    }.not_to raise_error(NoMethodError)
+  describe "setting values" do
+    it "should be possible to save a setting" do 
+      settings.instance_eval { setting :something }
+      settings.something = "some nice value"
+      settings.something.should == "some nice value"
+    end
+
+    it "should save settings to mongodb" do
+      settings.instance_eval { setting :something }
+      other_settings.instance_eval { setting :something }
+
+      settings.something = "some nice value"
+      other_settings.something.should == "some nice value"
+    end
+
+    it "should be possible to overwrite a default value" do
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo = "baz"
+      settings.foo.should == "baz"
+    end
+
+    it "should be possible to overwrite a value with something else" do
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo = "baz"
+      settings.foo = "quux"
+      settings.foo.should == "quux"
+    end
+
+    it "should be possible to unset a value, reverting to default" do
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo = "baz"
+      settings.delete(:foo)
+      settings.foo.should == "bar"
+    end
+
+    it "should be possible to get a hash of all settings and their values" do
+      settings.instance_eval { setting :one, :default => "One" }
+      settings.instance_eval { setting :two, :default => "Two" }
+      settings.instance_eval { setting :three, :default => "Three" }
+
+      settings.two = "My value"
+      settings.three = nil
+      settings.all.should == {:one => "One", :two => "My value", :three => nil}
+    end
+
+    it "should be possible to get a hash of all settings and their defaults" do
+      settings.instance_eval { setting :one, :default => "One" }
+      settings.instance_eval { setting :two, :default => "Two" }
+      settings.instance_eval { setting :three}
+
+      settings.two = "My value"
+      settings.three = nil
+      settings.defaults.should == {:one => "One", :two => "Two", :three => nil}
+    end
+
+    it "should be possible to overwrite a value with false" do
+      # At one point, Mongoid didn't support Record#set with nil/false
+      # This spec is here to prevent regression
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo = "baz"
+      settings.foo = false
+      settings.foo.should == false
+    end
+
+    it "should be possible to overwrite a value with false" do
+      # At one point, Mongoid didn't support Record#set with nil/false
+      # This spec is here to prevent regression
+      settings.instance_eval { setting :foo, :default => "bar" }
+      settings.foo = "baz"
+      settings.foo = nil
+      settings.foo.should == nil
+    end
   end
 
-  it "should save settings outside of itself" do
-    settings.instance_eval { setting :something }
-    other_settings.instance_eval { setting :something }
-
-    settings.something = "some nice value"
-    other_settings.something.should == "some nice value"
-  end
-
-  it "should be possible to specify default values" do
-    settings.instance_eval { setting :foo, :default => "bar" }
-    settings.foo.should == "bar"
-  end
-
-  it "should be possible to use defaults of other settings in defaults" do
-    settings.instance_eval { setting :foo, :default => "bar"
-                             setting :baz, :default => "#{foo} quux" }
-    settings.baz.should == "bar quux"
-  end
-
-  it "should be possible to use values of other settings in defaults" do
-    settings.instance_eval { setting :foo, :default => "bar" }
-    settings.foo = "baz"
-    settings.instance_eval { setting :qux, :default => "#{foo} quux" }
-    settings.qux.should === "baz quux"
-  end
-
-  it "should be possible to overwrite a default value" do
-    settings.instance_eval { setting :foo, :default => "bar" }
-    settings.foo = "baz"
-    settings.foo.should == "baz"
-  end
-
-  it "should be possible to overwrite a value with something else" do
-    settings.instance_eval { setting :foo, :default => "bar" }
-    settings.foo = "baz"
-    settings.foo = "quux"
-    settings.foo.should == "quux"
-  end
-
-  it "should be possible to overwrite a value with something falsey" do
-    settings.instance_eval { setting :foo, :default => "bar" }
-    settings.foo = "baz"
-    settings.foo = false
-    settings.foo.should == false
-  end
-
-  it "should not constantly reload" do
-    settings.instance_eval { setting :foo }
-    other_settings.instance_eval { setting :foo }
-    other_settings.foo # force other_settings to load the record
-
-    settings.foo = "bar"
-    other_settings.foo.should be_nil
-  end
-
-  it "should be possible to reload" do
-    settings.instance_eval { setting :foo }
-    other_settings.instance_eval { setting :foo }
-    other_settings.foo # force other_settings to load the record
-
-    settings.foo = "bar"
-    other_settings.reload
-    other_settings.foo.should == "bar"
+  describe "reload behaviour" do
+    it "should not reload for every call" do
+      settings.instance_eval { setting :foo }
+      other_settings.instance_eval { setting :foo }
+      other_settings.foo # force other_settings to load the record
+
+      settings.foo = "bar"
+      other_settings.foo.should be_nil
+    end
+
+    it "should be possible to reload" do
+      settings.instance_eval { setting :foo }
+      other_settings.instance_eval { setting :foo }
+      other_settings.foo # force other_settings to load the record
+
+      settings.foo = "bar"
+      other_settings.reload
+      other_settings.foo.should == "bar"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-app_settings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000 Z
+date: 2012-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &19040800 !ruby/object:Gem::Requirement
+  requirement: &11653860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19040800
+  version_requirements: *11653860
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &19039820 !ruby/object:Gem::Requirement
+  requirement: &11652580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19039820
+  version_requirements: *11652580
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &19038280 !ruby/object:Gem::Requirement
+  requirement: &11651400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19038280
+  version_requirements: *11651400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19037040 !ruby/object:Gem::Requirement
+  requirement: &11650500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19037040
+  version_requirements: *11650500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &19035620 !ruby/object:Gem::Requirement
+  requirement: &11649380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *19035620
+  version_requirements: *11649380
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &19034560 !ruby/object:Gem::Requirement
+  requirement: &11648700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19034560
+  version_requirements: *11648700
 description: Mongoid::AppSettings allows you to store settings in MongoDB, and access
   them easily
 email: marten@veldthuis.com
@@ -113,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3872212591673506427
+      hash: 4007270136377991358
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: