croesus 0.1.3

data/lib/croesus/validations.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+module Croesus
+  class Base
+    attr_accessor :hash, :validations, :errors
+
+    def initialize(hash, validations)
+      self.errors      = {}
+      self.hash        = hash
+      self.validations = validations.inject({
+        }){ |memo,(k,v)| memo[k] = v.to_s.downcase; memo }
+      validate
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def self.validate(hash, validations)
+      new(hash, validations)
+    end
+
+    private #   P R O P R I E T À   P R I V A T A   Vietato L'accesso
+
+    def validate
+      Croesus.validator_for(hash).validate(
+        :base, self.hash, self.validations, self.errors
+      )
+      self.errors = errors[:base]
+    end
+  end
+
+  @@validators = []
+
+  def self.append_validator(validator)
+    unless validator.is_a?(Croesus::Validator::Base)
+      raise ValidationError.new(
+        'Validators inherit from Croesus::Validator::Base'
+      )
+    end
+
+    if @@validators.detect { |v| v.name == validator.name }
+      raise ValidationError.new('Validators must have unique names.')
+    end
+
+    @@validators << validator
+  end
+
+  def self.validator_for(item)
+    @@validators.detect { |v| v.should_validate?(item) } ||
+      raise(ValidationError.new("Could not find valid validator for: #{item}"))
+  end
+
+  module Validator
+  end
+
+  module Validations
+  end
+end
+
+# Load validators
+require 'croesus/validations/optional'
+require 'croesus/validations/many'
+require 'croesus/validators/base'
+require 'croesus/validators/simple_validator'
+require 'croesus/validators/hash_validator'
+require 'croesus/validators/presence_validator'
+require 'croesus/validators/simple_type_validators'
+require 'croesus/validators/boolean_validator'
+require 'croesus/validators/email_validator'
+require 'croesus/validators/enumerable_validator'
+require 'croesus/validators/lambda_validator'
+require 'croesus/validators/optional_validator'
+require 'croesus/validators/many_validator'

data/lib/croesus/validators/base.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::Base
+  attr_accessor :name
+
+  def initialize(name)
+    unless name.is_a?(String) && name.size > 0
+      raise StandardError.new(
+        'Validator must be initialized with a valid name '\
+        '(string with length greater than zero).'
+      )
+    end
+
+    self.name = name
+  end
+
+  def should_validate?(name)
+    self.name == name
+  end
+
+  def presence_error_message
+    "#{self.name} required"
+  end
+
+  def validate(key, value, validations, errors)
+    raise ValidationError.new(
+      'Validate should not be called directly on Croesus::Validator::Base'
+    )
+  end
+end

data/lib/croesus/validators/boolean_validator.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::BooleanValidator < Croesus::Validator::Base
+  def initialize
+    super('boolean')  # The name of the validator
+  end
+
+  def validate(key, value, validations, errors)
+    unless [TrueClass, FalseClass].include?(value.class)
+      errors[key] = presence_error_message
+    end
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::BooleanValidator.new)

data/lib/croesus/validators/email_validator.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::EmailValidator < Croesus::Validator::Base
+  def initialize
+    super('email')  # The name of the validator
+  end
+
+  def presence_error_message
+    'is not a valid email'
+  end
+
+  def validate(key, value, validations, errors)
+    unless value.is_a?(String) && value.include?("@")
+      errors[key] = presence_error_message
+    end
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::EmailValidator.new)

data/lib/croesus/validators/enumerable_validator.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::EnumerableValidator < Croesus::Validator::Base
+  def initialize
+    super('_enumerable')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+  end
+
+  def should_validate?(item)
+    item.is_a?(Enumerable)
+  end
+
+  def presence_error_message
+    'value from list required'
+  end
+
+  def validate(key, value, validations, errors)
+    unless validations.include?(value)
+      errors[key] = presence_error_message
+    end
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::EnumerableValidator.new)

data/lib/croesus/validators/hash_validator.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::HashValidator < Croesus::Validator::Base
+  def initialize
+    super('hash')
+  end
+
+  def should_validate?(item)
+    item.is_a?(Hash)
+  end
+
+  def validate(key, value, validations, errors)
+    # Validate hash
+    unless value.is_a?(Hash)
+      errors[key] = presence_error_message
+      return
+    end
+
+    # Hashes can contain sub-elements, attempt to validator those
+    errors = (errors[key] = {})
+
+    validations.each do |v_key, v_value|
+      Croesus.validator_for(v_value).validate(
+        v_key, value[v_key], v_value, errors
+      )
+    end
+
+    # Cleanup errors (remove any empty nested errors)
+    errors.delete_if { |k,v| v.empty? }
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::HashValidator.new)

data/lib/croesus/validators/lambda_validator.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::LambdaValidator < Croesus::Validator::Base
+  def initialize
+    super('_lambda')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+  end
+
+  def should_validate?(item)
+    if item.is_a?(Proc)
+      if item.arity == 1
+        true
+      else
+        raise InvalidArgumentCount.new(
+          "Lambda validator should only accept one argument; " \
+          "supplied lambda accepts #{item.arity}."
+        )
+      end
+    else
+      false
+    end
+  end
+
+  def presence_error_message
+    'is not valid'
+  end
+
+  def validate(key, value, lambda, errors)
+    unless lambda.call(value)
+      errors[key] = presence_error_message
+    end
+
+  rescue
+    errors[key] = presence_error_message
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::LambdaValidator.new)

data/lib/croesus/validators/many_validator.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+module Croesus::Validator
+  class ManyValidator < Base
+    def initialize
+      super('_many')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+    end
+
+    def should_validate?(validation)
+      validation.is_a?(Croesus::Validations::Many)
+    end
+
+    def presence_error_message
+      "enumerable required"
+    end
+
+    def validate(key, value, validations, errors)
+      unless value.is_a?(Enumerable)
+        errors[key] = presence_error_message
+        return
+      end
+
+      element_errors = Array.new
+
+      value.each_with_index do |element, i|
+        ::Croesus.validator_for(validations.validation).validate(i, element, validations.validation, element_errors)
+      end
+
+      element_errors.each_with_index do |e, i|
+        if e.respond_to?(:empty?) && e.empty?
+          element_errors[i] = nil
+        end
+      end
+
+      errors[key] = element_errors unless element_errors.all?(&:nil?)
+    end
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::ManyValidator.new)

data/lib/croesus/validators/optional_validator.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+module Croesus::Validator
+  class OptionalValidator < Base
+    def initialize
+      # The name of the validator, underscored as it won't usually be directly
+      # invoked (invoked through use of validator).
+      super('_optional')
+    end
+
+    def should_validate?(validation)
+      validation.is_a?(Croesus::Validations::Optional)
+    end
+
+    def validate(key, value, validations, errors)
+      if value
+        ::Croesus.validator_for(validations.validation).validate(key, value, validations.validation, errors)
+        errors.delete(key) if errors[key].respond_to?(:empty?) && errors[key].empty?
+      end
+    end
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::OptionalValidator.new)

data/lib/croesus/validators/presence_validator.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::PresenceValidator < Croesus::Validator::Base
+  def initialize
+    super('required')
+  end
+
+  def presence_error_message
+    'is required'
+  end
+
+  def validate(key, value, validations, errors)
+    unless value
+      errors[key] = presence_error_message
+    end
+  end
+end
+
+Croesus.append_validator(Croesus::Validator::PresenceValidator.new)

data/lib/croesus/validators/simple_type_validators.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+[
+  Array,
+  Complex,
+  Enumerable,
+  Float,
+  Integer,
+  Numeric,
+  Range,
+  Rational,
+  Regexp,
+  String,
+  Symbol,
+  Time
+].each do |type|
+  name = type.to_s.gsub(/(.)([A-Z])/,'\1_\2').downcase
+  Croesus.append_validator(Croesus::Validator::SimpleValidator.new(
+    name, lambda { |v| v.is_a?(type) })
+  )
+end

data/lib/croesus/validators/simple_validator.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+class Croesus::Validator::SimpleValidator < Croesus::Validator::Base
+  attr_accessor :lambda
+
+  def initialize(name, lambda)
+    # lambda must accept one argument (the value)
+    if lambda.arity != 1
+      raise ValidationError.new(
+        "Lambda should take only one argument; passed #{lambda.arity}"
+      )
+    end
+
+    super(name)
+    self.lambda = lambda
+  end
+
+  def validate(key, value, validations, errors)
+    unless lambda.call(value)
+      errors[key] = presence_error_message
+    end
+  end
+end

data/lib/croesus/version.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+#
+# Author: Stefano Harding <riddopic@gmail.com>
+#
+# Copyright (C) 2014 Stefano Harding
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+
+# The version number of the Croesus Gem
+#
+# @return [String]
+#
+# @api public
+module Croesus
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 3
+
+    # Returns a version string by joining MAJOR, MINOR, and PATCH with '.'
+    #
+    # Example
+    #
+    #   Version.string # '1.0.3'
+    def self.string
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+
+  VERSION = Croesus::Version.string
+end