varify 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 763aded5cac48164416a5e0ccaa754591ebed284
-  data.tar.gz: aef8ce54a9d0f62c7efadee030a06be09696b38b
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWEzNmRkZTcyMTYwZWIwMzhkMzgyODQ4MDJiOGZiNzk2MThiM2Q5MA==
+  data.tar.gz: !binary |-
+    Zjc2ZWU0ZWNhZmQ5OGE4ZWM5MGY5ZDVmYzZkYWI5NGE4ZDMzNTViYw==
 SHA512:
-  metadata.gz: ee09b59330a05714a91c4f8a73bf40e02810814c18307afa0b29a235bf47b8aed9e206c8b222a862747479ff7be786d6ced5587c1675b8b93d6fe0b7e39f43f7
-  data.tar.gz: 4aa6db6e02da6c67f5beae29638e4e10255d11bc5faaa5f229e160874d6ec01e00238e5ba1dbf99ee9fb58f853b728fdb685b664e5bdf371ec2a59ed3a8a9c42
+  metadata.gz: !binary |-
+    MjY3NWVkNmU1NGJiMGRhZmFlYjBiOTIyYWJiYTZiZDE5MGNlM2JmZTA3YWU1
+    YzkzZmI0YmI1MGZmNDk5OTIxN2QyYTU0OTg2MWM1Nzg4ZWE3YzNkNDIwOWQx
+    MDM5YTBhNThmYzhkOGUyNmExYmM0OGE3NTQ2MDYzMTljZDE4YmE=
+  data.tar.gz: !binary |-
+    MjFmNTNhZDY5YmRmYTg5M2UwZWI0ZTM0ZTY3MWI5N2FlMmMzMjVlM2UzNDY4
+    MGIzM2EyZjVmZTEyNGEzODdlZDU0ZTYyMmNlNDc0Y2NiYzVlOTI1ODIzM2U5
+    NTk0Y2NmN2ExOWJjY2Q1MjVjZGUwZDQ4NGIwMzhjNmNlNjU1M2Q=

data/lib/varify.rb

@@ -1,3 +1,3 @@
 require 'varify/base'
 require 'varify/hash'
-require 'varify/ostruct'
+require 'varify/openstruct'

data/lib/varify/base.rb

@@ -1,8 +1,73 @@
 
+require 'varify/rules/required'
+require 'varify/rules/is_a'
+require 'varify/rules/one_of'
+
 module Varify
   module Base
-    def self.varify(key, params={}, options={},&block)
-      value = params[key]
+    RULES = {
+      required: Varify::Rules::RequiredRule,
+      is_a:     Varify::Rules::IsARule,
+      one_of:   Varify::Rules::OneOfRule
+    }
+
+
+    # Sets the callback for when a validation fails
+    # @param &block [Proc] the callback to run when validation fails
+    # @yieldparam
+    def self.callback(&block)
+      @callback = block
+    end
+
+    # Used by the varify method to send error messages to the callback
+    # @param [Hash] options the information to post for the error
+    # @option options [String] :message the user readable message
+    # @option options [Symbol] :key the key of the value to get from the Hashh
+    # @option options [Symbol] :rule the Rule ID from RULES
+    # @api private
+    def self.fail(options={})
+      message = options.is_a?(String) ? options : options[:message]
+      raise "Fail (fail) requires a string message or hash with :message" unless message
+      raise "Key (:key) is required in calling fail" unless options[:key]
+      raise "Rule (:rule) is required in calling fail" unless options[:rule]
+
+      error = {
+        message: message,
+        key:     options[:key],
+        rule:    options[:rule]
+      }
+
+      if @callback
+        @callback.call(error)
+      else
+        raise ArgumentError, message
+      end
+    end
+
+    # Processes the input parameter
+    # @param [Symbol] Varify::Base.callback the key to identify the value out of the hash
+    # @param [Hash] params the hash of keys 
+    # @param [Hash] options set of rules to test
+    # @param [Proc] &block optional block to use as a validator
+    def self.varify(param_key, params={}, options={},&block)
+      value = params[param_key] || options[:default]
+      name  = params[:name] || param_key.to_s.split('_').map{|e| e.capitalize}.join(' ')
+      rules = {}
+
+      rules_to_process = options.dup
+      rules_to_process.delete(:default)
+      rules_to_process.delete(:name)
+
+      rules_to_process.each do |rule_key,rule_value|
+        rule_class = RULES[rule_key]
+        raise "Rule ':#{rule_key}' is not defined" unless rule_class
+        rules[rule_key] = rule_class.new(param_key,name,value,rule_value)
+      end
+
+      rules.each do |rule_key,rule|
+        fail(message: rule.error_message, key: param_key, rule:rule_key) unless rule.valid?
+      end
+
       value
     end
   end

data/lib/varify/hash.rb

@@ -1,9 +1,7 @@
 require 'varify/base'
 
-module Varify
-  class Hash
-    def varify(key, options = {})
-      Varify.varify(key, self, options)
-    end
+class Hash
+  def varify(key, options = {})
+    Varify::Base.varify(key, self, options)
   end
 end

data/lib/varify/openstruct.rb

@@ -0,0 +1,8 @@
+require 'ostruct'
+require 'varify/base'
+
+class OpenStruct
+  def varify(key, options = {})
+    Varify::Base.varify(key, self.marshal_dump, options)
+  end
+end

data/lib/varify/rules/is_a.rb

@@ -0,0 +1,15 @@
+require 'varify/rules/rule'
+
+module Varify
+  module Rules
+    class IsARule < Rule
+      def valid?
+        @value.is_a?(@options)
+      end
+
+      def error_message
+        "#{@name} (:#{@key}) must be a #{@options.name}"
+      end
+    end
+  end
+end

data/lib/varify/rules/one_of.rb

@@ -0,0 +1,24 @@
+require 'varify/rules/rule'
+
+module Varify
+  module Rules
+    class OneOfRule < Rule
+      def valid?
+        @options.include?(@value)
+      end
+
+      def error_message
+        message = if @options.count >=2
+          last  = "'#{@options[-1]}'"
+          first = @options[0..-2].map{|o| "'#{o}'"}.join(', ')
+          "#{@name} (:#{@key}) must be #{first} or #{last}"
+        elsif @options.count == 1
+          "#{@name} (:#{@key}) must be '#{@options[0]}'"
+        else
+          "#{@name} (:#{@key}) can't be valid because no valid options were provided"
+        end
+        message
+      end
+    end
+  end
+end

data/lib/varify/rules/required.rb

@@ -0,0 +1,19 @@
+require 'varify/rules/rule'
+
+module Varify
+  module Rules
+    class RequiredRule < Rule
+      def valid?
+        if @options
+          !@value.nil? 
+        else
+          true
+        end
+      end
+
+      def error_message
+        "#{@name} (:#{@key}) is required"
+      end
+    end
+  end
+end

data/lib/varify/rules/rule.rb

@@ -0,0 +1,22 @@
+
+module Varify
+  module Rules
+    class Rule
+
+      def initialize(key,name,value,options={})
+        @value   = value
+        @key     = key
+        @name    = name
+        @options = options
+      end
+
+      def valid?
+        raise NotImplementedError
+      end
+
+      def error_message
+        "#{@name} (:#{@key}) failed verification"
+      end
+    end
+  end
+end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: varify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Maciej Skierkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.5
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.5.0
 description: 
 email:
 - maciej@factor.io
@@ -62,7 +90,11 @@ files:
 - lib/varify.rb
 - lib/varify/base.rb
 - lib/varify/hash.rb
-- lib/varify/ostruct.rb
+- lib/varify/openstruct.rb
+- lib/varify/rules/is_a.rb
+- lib/varify/rules/one_of.rb
+- lib/varify/rules/required.rb
+- lib/varify/rules/rule.rb
 homepage: https://factor.io
 licenses:
 - MIT
@@ -73,17 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Varify

data/lib/varify/ostruct.rb

@@ -1,10 +0,0 @@
-require 'ostruct'
-require 'varify/base'
-
-module Varify
-  class OStruct
-    def varify(key, options = {})
-      Varify.varify(key, self.to_h, options)
-    end
-  end
-end