surveillance_authority 0.2.0 → 0.3.0

data/README.md

@@ -105,7 +105,7 @@ Withing your plugin, you will be able to access your options simply by calling `
 
 
      class VarnishSweeper < SurveillanceAuthority::Sanctions
-       default_config  {:method => :purge}
+       default_config(:method => :purge)
 
        def sweep(url, options = {})
          options.reverse_merge(
@@ -142,10 +142,29 @@ If you want to access the config of other plugins, use:
 
 Note that you can easily provide default options for your plugin by calling `default_config` in your plugin file:
 
-     default_config {:method => :purge}
+     default_config(:method => :purge)
 
 which comes in handy if some config options of your plugin do not need to be set by the users.
 
+### Configuration Validator
+
+If your want to make sure that all configuration values of your plugin are valid, you can define a method called `validate_configuration` that does the necessary checks. It gets called after calling `default_config` and `config=` and should get called by methods that take in options that can overwrite the configuration. It should take care of the situation. If `validate_configuration` validates it should return the `@config` variable as its result gets returned when calling `config=`.
+
+     class VarnishSweeper < SurveillanceAuthority::Sanctions
+       default_config(:method => :purge)
+        
+       def validate_configuration
+         # make sure the method option is either set to :purge or :header_invalidation
+         raise "invalid config" unless [:purge, :header_invalidation].include?( @config[:method] )
+         @config
+       end
+
+       def sweep(url, options = {})
+         options = validate_configuration( self.config.merge(options) )
+         ...
+       end
+     end
+
 
 Copyright
 ---------

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/surveillance_authority.rb

@@ -8,17 +8,23 @@ class SurveillanceAuthority
 
     def self.default_config(options = {})
       self.instance.config = options
+      self.instance.validate_configuration
     end
 
     def config=(options = {})
       @config ||= {}
       @config = @config.merge(options)
+      validate_configuration
     end
 
     def config
       @config ||= {}
     end
 
+    def validate_configuration
+      @config
+    end
+
     VALID_HOOKS = [:validation, :validation_on_create, :save, :create]
     @@plugins = []
 

data/spec/plugin_configuration_spec.rb

@@ -3,6 +3,11 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 class Notify < SurveillanceAuthority::Sanction
   default_config(:default_config => "I am a default option")
 
+  def validate_configuration
+    raise unless ["I am a default option", "I am not a default option"].include?( @config[:default_config] )
+    @config
+  end
+
   def my_config
     config
   end
@@ -41,6 +46,19 @@ describe "plugin configuration" do
     SurveillanceAuthority.config(Notify, :what => "ever")
     Notify.instance.config[:default_config].should == "I am a default option"
   end
+   
+  it "should throw an exception if we pass in an invalid option through SurveillanceAuthority.config" do
+    lambda {
+      SurveillanceAuthority.config(Notify, :default_config => "ha ha -- I am full invalid dude")
+    }.should raise_error
+  end
+
+  it "should throw an exception if we pass in an invalid option through Plugin.config = " do
+    lambda {
+      Notify.config = {:default_config => "ho ho ho -- valid I am not"}
+    }.should raise_error
+  end
+
 
   # ALWAYS LAST:
   it "should be possible for plugins to overwrite default options" do

data/surveillance_authority.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveillance_authority}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Bornkessel"]

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Bornkessel
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2654120252079229652
+      hash: -4373169688177034088
       segments: 
       - 0
       version: "0"