surveillance_authority 0.1.0 → 0.2.0

data/README.md

@@ -103,9 +103,10 @@ Withing your plugin, you will be able to access your options simply by calling `
 
 #### Example: `VarnishSweep` needs to be configured with a base url to varnish
 
-<code>
 
      class VarnishSweeper < SurveillanceAuthority::Sanctions
+       default_config  {:method => :purge}
+
        def sweep(url, options = {})
          options.reverse_merge(
            :method => :invalidate
@@ -128,21 +129,22 @@ Withing your plugin, you will be able to access your options simply by calling `
        end
      end
 
-</code>
 
 In the project using this plugin:
 
-<code>
 
       SurveillanceAuthority.config(VarnishSweeper, :base_url => "http://varnish.example.com")
- 
       ...
-</code>
 
 If you want to access the config of other plugins, use:
 
       `SurveillanceAuthority.config_for(<plugin>)`
 
+Note that you can easily provide default options for your plugin by calling `default_config` in your plugin file:
+
+     default_config {:method => :purge}
+
+which comes in handy if some config options of your plugin do not need to be set by the users.
 
 
 Copyright

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/surveillance_authority.rb

@@ -4,9 +4,21 @@ require 'singleton'
 class SurveillanceAuthority
 
   class Sanction
-    attr_accessor :config
     include Singleton
 
+    def self.default_config(options = {})
+      self.instance.config = options
+    end
+
+    def config=(options = {})
+      @config ||= {}
+      @config = @config.merge(options)
+    end
+
+    def config
+      @config ||= {}
+    end
+
     VALID_HOOKS = [:validation, :validation_on_create, :save, :create]
     @@plugins = []
 

data/spec/plugin_configuration_spec.rb

@@ -1,6 +1,8 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 class Notify < SurveillanceAuthority::Sanction
+  default_config(:default_config => "I am a default option")
+
   def my_config
     config
   end
@@ -16,18 +18,34 @@ describe "plugin configuration" do
   it "should be possible to configure plugins with the SurveillanceAuthority.config method" do
     SurveillanceAuthority.config(Notify, :option1 => true)
 
-    Notify.instance.config.should == {:option1 => true}
+    Notify.instance.config[:option1].should == true
   end
 
   it "configuration should be accessible within the plugin" do
     SurveillanceAuthority.config(Notify, :option2 => true)
 
-    Notify.instance.my_config.should == {:option2 => true}
+    Notify.instance.my_config[:option2].should == true
   end
 
   it "should be possible to configure plugins with the SurveillanceAuthority.config method and retrieve this config with SurveillanceAuthority::config_for" do
     SurveillanceAuthority.config(Notify, :option3 => true)
 
-    SurveillanceAuthority.config_for(Notify).should == {:option3 => true}
+    SurveillanceAuthority.config_for(Notify)[:option3].should == true
+  end
+
+  it "should be possible for plugins to have default options" do
+    Notify.instance.config[:default_config].should == "I am a default option"
+  end
+
+  it "should not delete default config if user sets some config options" do
+    SurveillanceAuthority.config(Notify, :what => "ever")
+    Notify.instance.config[:default_config].should == "I am a default option"
+  end
+
+  # ALWAYS LAST:
+  it "should be possible for plugins to overwrite default options" do
+    SurveillanceAuthority.config(Notify, :default_config => "I am not a default option")
+    Notify.instance.config[:default_config].should == "I am not a default option"
   end
+
 end

data/surveillance_authority.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveillance_authority}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Bornkessel"]
-  s.date = %q{2010-10-20}
+  s.date = %q{2010-10-25}
   s.description = %q{Write centralized model observers in a simple DSL}
   s.email = %q{github@bornkessel.com}
   s.extra_rdoc_files = [

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Bornkessel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 +02:00
+date: 2010-10-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1608769546526049591
+      hash: -2654120252079229652
       segments: 
       - 0
       version: "0"