optionable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 198b619f4a71038fcb8f5d2b7b0beb81d393f408
-  data.tar.gz: f5d4a0df739bc012faa4e5edd3f646f0c857af6d
+  metadata.gz: f6cb2bd9147a5c10dd8ac1a4ad6f8669c12e7fda
+  data.tar.gz: c6da7fc2c7a38e3f00c08d45b15f456cc715b8b6
 SHA512:
-  metadata.gz: e34e673ddc316c189d90b07e557b70574f6e7f80cb4c234deb002bd8df6cdd9b2ddd697c619ef1557a4effb086aa69c867e61052d7c9e75e982ceebb9cf65318
-  data.tar.gz: 9bfe6a413779ad23accb7991aef7919cf59cb43a80908f00e4a2b073d1ae0b21e06a9e0712fcfc9023cc1e5263ed4d357b44840df49ed3c5a09d650ee448f5b8
+  metadata.gz: 7a9b19e8a01ae47087bca5ab6572792d59064e1d381c40f055618d926faf2bf23c123161a3dd10122e7cc1b7b238e3c05ddb926f224553c71a5c317cae58abba
+  data.tar.gz: 0ac9199ffd60222ea6e912db0fbd732110a13b7c3200e187d22848038b29f9cc5017a50899e7096893fe388bd6ce52dedead663566e87fc20c1cff84cd665ce1

data/README.md

@@ -46,6 +46,8 @@ end
 
 If the options are invalid, an `Optionable::Invalid` error will be raised.
 
+If an unknown option is provided, an `Optionable::Unknown` error will be
+raised.
 
 API Documentation
 -----------------

data/lib/optionable.rb

@@ -2,6 +2,7 @@
 require "optionable/any"
 require "optionable/dsl"
 require "optionable/invalid"
+require "optionable/unknown"
 require "optionable/validator"
 require "optionable/version"
 
@@ -19,12 +20,17 @@ module Optionable
   # @param [ Hash ] options The options to validate.
   #
   # @raise [ Optionable::Invalid ] If the options are wack.
+  # @raise [ Optionable::Unknown ] If an unknown option is passed.
   #
   # @since 0.0.0
   def validate_strict(options)
     (options || {}).each_pair do |key, value|
       validator = optionable_validators[key]
-      validator.validate!(value) if validator
+      if validator
+        validator.validate!(value)
+      else
+        raise Unknown.new(key, optionable_validators.keys)
+      end
     end
   end
 

data/lib/optionable/unknown.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Optionable
+
+  # This exception is raised whenever unknown options are found during
+  # validation.
+  #
+  # @since 0.0.0
+  class Unknown < RuntimeError
+
+    # @!attribute key
+    #   @return [ Symbol ] The name of the option.
+    # @!attribute names
+    #   @return [ Array<Symbol> ] The list of valid option names.
+    attr_reader :key, :names
+
+    # Initialize the unknown option exception.
+    #
+    # @example Initialize the exception.
+    #   Optionable::Unknown.new(:test, [ :read, :write ])
+    #
+    # @param [ Symbol ] key The name of the option.
+    # @param [ Array<Symbol> ] names The valid option names.
+    #
+    # @since 0.0.0
+    def initialize(key, names)
+      @key = key
+      @names = names
+      super(generate_message)
+    end
+
+    private
+
+    # Generate the message that will be used in the exception.
+    #
+    # @api private
+    #
+    # @since 0.0.0
+    def generate_message
+      "#{key.inspect} is an unknown option. Valid options are: #{names.map(&:inspect).join(", ")}."
+    end
+  end
+end

data/lib/optionable/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Optionable
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/optionable/unknown_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Optionable::Unknown do
+
+  describe "#message" do
+
+    let(:invalid) do
+      described_class.new(:test, [ :first, :second ])
+    end
+
+    it "returns the valid names in the message" do
+      expect(invalid.message).to eq(
+        ":test is an unknown option. Valid options are: :first, :second."
+      )
+    end
+  end
+end

data/spec/optionable_spec.rb

@@ -43,6 +43,15 @@ describe Optionable do
       end
     end
 
+    context "when options exist that are not defined" do
+
+      it "raises an error" do
+        expect {
+          Model.new(something: :else)
+        }.to raise_error
+      end
+    end
+
     context "when the options are valid" do
 
       context "when options are allowed specific values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optionable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Durran Jordan
@@ -20,6 +20,7 @@ files:
 - lib/optionable/any.rb
 - lib/optionable/dsl.rb
 - lib/optionable/invalid.rb
+- lib/optionable/unknown.rb
 - lib/optionable/validator.rb
 - lib/optionable/version.rb
 - lib/optionable.rb
@@ -28,6 +29,7 @@ files:
 - Rakefile
 - spec/optionable/any_spec.rb
 - spec/optionable/invalid_spec.rb
+- spec/optionable/unknown_spec.rb
 - spec/optionable/validator_spec.rb
 - spec/optionable_spec.rb
 - spec/spec_helper.rb
@@ -57,6 +59,7 @@ summary: Robust options validation for methods.
 test_files:
 - spec/optionable/any_spec.rb
 - spec/optionable/invalid_spec.rb
+- spec/optionable/unknown_spec.rb
 - spec/optionable/validator_spec.rb
 - spec/optionable_spec.rb
 - spec/spec_helper.rb