servi 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6811acf7e53f4885c8132c0d83eded742bf588a7
-  data.tar.gz: 9821e8dca4ce04e82cc3c491c5cdc7a2802416b0
+  metadata.gz: d709873b6eb803abba6738c857dc91ab3f5db58b
+  data.tar.gz: 65fc977b2f68056312576f5354e4990d16862c18
 SHA512:
-  metadata.gz: 8ec854851433cf72b0d9036f93fbbef5b88616f25baefdfa4e709ae28a43bc1ef88a5e5587e047634d0e253bf8277bd0308597ceb34d82967290c25031bbf035
-  data.tar.gz: 35432e25d98b66cf15dcfa21a24d1332083723a85660fc76774e680a48f662590580b08345ba25ef9cc148065f2d97a73358efcffe4c018e30359d4607154ca0
+  metadata.gz: bc3671d343c2fc906ad0e72f43348eca4298b6f128ff6dcf588b00f060fe170ec1ccbcee6fc1042cb9501edc5efb84b8d3c590e7d5c175d1481706c5288ef517
+  data.tar.gz: 1018746b84bfa01ecba75849adbbaf71c3709394d5c6ac764758e32fa8dcbd0dc499f0578893d9e2826b58cd06a4e2e732094ca93cd2ae4d6da9fce73d46775c

data/lib/servi/validations.rb

@@ -0,0 +1,206 @@
+class Servi
+
+  # Provides a base implementation for extensible validation routines.
+  # {Scrivener::Validations} currently only provides the following assertions:
+  #
+  # * assert
+  # * assert_present
+  # * assert_format
+  # * assert_numeric
+  # * assert_url
+  # * assert_email
+  # * assert_member
+  # * assert_length
+  # * assert_decimal
+  # * assert_equal
+  #
+  # The core tenets that Scrivener::Validations advocates can be summed up in a
+  # few bullet points:
+  #
+  # 1. Validations are much simpler and better done using composition rather
+  #    than macros.
+  # 2. Error messages should be kept separate and possibly in the view or
+  #    presenter layer.
+  # 3. It should be easy to write your own validation routine.
+  #
+  # Other validations are simply added on a per-model or per-project basis.
+  #
+  # @example
+  #
+  #   class Quote
+  #     attr_accessor :title
+  #     attr_accessor :price
+  #     attr_accessor :date
+  #
+  #     def validate
+  #       assert_present :title
+  #       assert_numeric :price
+  #       assert_format  :date, /\A[\d]{4}-[\d]{1,2}-[\d]{1,2}\z
+  #     end
+  #   end
+  #
+  #   s = Quote.new
+  #   s.valid?
+  #   # => false
+  #
+  #   s.errors
+  #   # => { :title => [:not_present],
+  #          :price => [:not_numeric],
+  #          :date  => [:format] }
+  #
+  module Validations
+
+    # Check if the current model state is valid. Each call to {#valid?} will
+    # reset the {#errors} array.
+    #
+    # All validations should be declared in a `validate` method.
+    #
+    # @example
+    #
+    #   class Login
+    #     attr_accessor :username
+    #     attr_accessor :password
+    #
+    #     def validate
+    #       assert_present :user
+    #       assert_present :password
+    #     end
+    #   end
+    #
+    def valid?
+      errors.clear
+      validate
+      errors.empty?
+    end
+
+    # Base validate implementation. Override this method in subclasses.
+    def validate
+    end
+
+    # Hash of errors for each attribute in this model.
+    def errors
+      @errors ||= Hash.new { |hash, key| hash[key] = [] }
+    end
+
+  protected
+
+    # Allows you to do a validation check against a regular expression.
+    # It's important to note that this internally calls {#assert_present},
+    # therefore you need not structure your regular expression to check
+    # for a non-empty value.
+    #
+    # @param [Symbol] att The attribute you want to verify the format of.
+    # @param [Regexp] format The regular expression with which to compare
+    #                 the value of att with.
+    # @param [Array<Symbol, Symbol>] error The error that should be returned
+    #                                when the validation fails.
+    def assert_format(att, format, error = [att, :format])
+      if assert_present(att, error)
+        assert(get(att).to_s.match(format), error)
+      end
+    end
+
+    # The most basic and highly useful assertion. Simply checks if the
+    # value of the attribute is empty.
+    #
+    # @param [Symbol] att The attribute you wish to verify the presence of.
+    # @param [Array<Symbol, Symbol>] error The error that should be returned
+    #                                when the validation fails.
+    def assert_present(att, error = [att, :not_present])
+      assert(!get(att).to_s.empty?, error)
+    end
+
+    # Checks if all the characters of an attribute is a digit.
+    #
+    # @param [Symbol] att The attribute you wish to verify the numeric format.
+    # @param [Array<Symbol, Symbol>] error The error that should be returned
+    #                                when the validation fails.
+    def assert_numeric(att, error = [att, :not_numeric])
+      if assert_present(att, error)
+        assert_format(att, /\A\-?\d+\z/, error)
+      end
+    end
+
+    URL = /\A(http|https):\/\/([a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,12}|(2
+          5[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}
+          |localhost)(:[0-9]{1,5})?(\/.*)?\z/ix
+
+    def assert_url(att, error = [att, :not_url])
+      if assert_present(att, error)
+        assert_format(att, URL, error)
+      end
+    end
+
+    EMAIL = /\A([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*
+            [\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@
+            ((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+
+            [a-z]{2,12})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)\z/ix
+
+    def assert_email(att, error = [att, :not_email])
+      if assert_present(att, error)
+        assert_format(att, EMAIL, error)
+      end
+    end
+
+    def assert_member(att, set, err = [att, :not_valid])
+      assert(set.include?(get(att)), err)
+    end
+
+    def assert_length(att, range, error = [att, :not_in_range])
+      if assert_present(att, error)
+        val = get(att).to_s
+        assert range.include?(val.length), error
+      end
+    end
+
+    DECIMAL = /\A\-?(\d+)?(\.\d+)?\z/
+
+    def assert_decimal(att, error = [att, :not_decimal])
+      assert_format att, DECIMAL, error
+    end
+
+    # Check that the attribute has the expected value. It uses === for
+    # comparison, so type checks are possible too. Note that in order
+    # to make the case equality work, the check inverts the order of
+    # the arguments: `assert_equal :foo, Bar` is translated to the
+    # expression `Bar === get(:foo)`.
+    #
+    # @example
+    #
+    #   def validate
+    #     assert_equal :status, "pending"
+    #     assert_equal :quantity, Fixnum
+    #   end
+    #
+    # @param [Symbol] att The attribute you wish to verify for equality.
+    # @param [Object] value The value you want to test against.
+    # @param [Array<Symbol, Symbol>] error The error that should be returned
+    #                                when the validation fails.
+    def assert_equal(att, value, error = [att, :not_equal])
+      assert value === get(att), error
+    end
+
+    # The grand daddy of all assertions. If you want to build custom
+    # assertions, or even quick and dirty ones, you can simply use this method.
+    #
+    # @example
+    #
+    #   class CreatePost
+    #     attr_accessor :slug
+    #     attr_accessor :votes
+    #
+    #     def validate
+    #       assert_slug :slug
+    #       assert votes.to_i > 0, [:votes, :not_valid]
+    #     end
+    #
+    #   protected
+    #     def assert_slug(att, error = [att, :not_slug])
+    #       assert get(att).to_s =~ /\A[a-z\-0-9]+\z/, error
+    #     end
+    #   end
+    def assert(value, error)
+      value or errors[error.first].push(error.last) && false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Hanna
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/servi.rb
+- lib/servi/validations.rb
 homepage: http://github.com/kevinjhanna/servi
 licenses:
 - MIT