validate_options 0.0.2

data/README.rdoc

@@ -0,0 +1,60 @@
+= ValidateOptions
+
+This is a tiny Ruby snippet that provides a smarter way to validate 
+'options'-like hashes (a.k.a. named arguments).
+
+For example:
+
+  require 'validate_options'
+
+  def foo(text, options = {})
+    # Only :align and :color are allowed.
+    validate_options options, :align, :color
+
+    text
+  end
+
+  # Disabled by default.
+  ValidateOptions.enable!
+
+  foo("Hello")
+  # => "Hello"
+
+  foo("Hello", :align => :left)
+  # => "Hello"
+
+  foo("Hello", :colour => :red)
+  # ArgumentError: Invalid options provided: :colour.
+
+Using a block for more fine-grained control over arguments: 
+
+  def bar(text, options = {})
+    validate_options options, :align do |op|
+      raise ":align should be either :left or :right" if op[:align] && ![:left, :right].include?(op[:align])
+    end
+  end
+
+  bar("Hello", :align => :left)
+  # => "Hello"
+
+  bar("Hello", :align => :center)
+  # ArgumentError: :align should be either :left or :right
+
+Valid options can also be specified outside the method:
+
+  class Formatter
+    def print(text, options = {})
+      puts text
+    end
+
+    validate_options_for :print, :align, :color
+  end
+
+  Formatter.new.print("Hello")
+  # => "Hello"
+
+  Formatter.new.print("Hello", :align => :left)
+  # => "Hello"
+
+  Formatter.new.print("Hello", :colour => :red)
+  # ArgumentError: Invalid options provided: :colour.

data/lib/validate_options.rb

@@ -0,0 +1,49 @@
+module ValidateOptions
+  def self.disable!
+    Kernel.module_eval do
+      def validate_options(hash, *keys)
+        # no-op
+      end
+    end
+  end
+
+  def self.enable!
+    Kernel.module_eval do
+      def validate_options(hash, *keys)
+        return unless hash
+        extra = hash.keys - keys
+        raise ArgumentError, "Invalid options provided: #{extra.map {|k| k.inspect }.join(', ')}." unless extra.empty?
+
+        if block_given?
+          begin
+            yield(hash)
+          rescue ArgumentError
+            raise
+          rescue Exception => e
+            raise ArgumentError, e
+          end
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.class_eval <<-EOS
+    def validate_options_for(method, *args)
+      alias_method "\#{method}_without_options_validation".to_sym, method
+
+      module_eval <<-EOIS
+        def \#{method}(*args)
+          validate_options(args.last, *\#{args.inspect})
+          \#{method}_without_options_validation(*args)
+        end
+      EOIS
+    end
+    EOS
+  end
+
+  # Disable by default.
+  disable!
+end
+
+Class.send(:include, ValidateOptions)

data/lib/validate_options/spec.rb

@@ -0,0 +1,45 @@
+module ValidateOptions
+  module Spec
+    module Matchers
+      class ValidateOptionsMatcher #:nodoc:
+        def initialize(accepted_options)
+          @accepted_options = accepted_options
+        end
+
+        def matches?(target)
+          accepted = @accepted_options.all? do |opt|
+            begin
+              target.call(opt => nil)
+              true
+            rescue ArgumentError
+              false
+            end
+          end
+          
+          rejected = begin
+                       target.call("___very_odd_probably_invalid_key" => nil)
+                       false
+                     rescue ArgumentError
+                       true
+                     end
+          
+          accepted && rejected
+        end
+
+        def failure_message
+          "expected block to validate options."
+        end
+      end
+      
+      # :call-seq:
+      #   should validate_options(:color)
+      #
+      # == Examples
+      #
+      #   lambda {|options| Formatter.text('Hello', options) }.should validate_options(:color)
+      def validate_options(*accepted_options)
+        ValidateOptionsMatcher.new(accepted_options)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: validate_options
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-19 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: damian.janowski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/validate_options/spec.rb
+- lib/validate_options.rb
+- README.rdoc
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- tti
+- --main
+- README.rdoc
+require_paths: 
+- lib
+- lib/validate_options
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Hash validation for 'options'-like methods.
+test_files: []
+