daily_affirmation 0.8.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d6a05019e18b5074eb228e2cd9e42ae8302cb00
-  data.tar.gz: f33966b9dc5669032db433ed3034aeacce539fd8
+  metadata.gz: 1cc1e1ce0b58bfda7c7d73f8d28f03e1e5e74756
+  data.tar.gz: bbb527d49af075c5512336fbde9a1139f85c840f
 SHA512:
-  metadata.gz: 2af4d1fd5b8bd6334e837aa1aa2842ed9c4dcbc8adb6200171313e26ebd7a54778548bc6ff37dd51a448fe1b52ce23cb34d235a52f642b9428bcd5de3c6a20bd
-  data.tar.gz: 1158c66ad417f70e3117573b8b51b9ed2d744f8b2e246a676548abe6be32b478ae3eaaab7f59d0d1bc583696b3e1e7797b57cad5e29ca31235ce0c67fd202696
+  metadata.gz: 08ce5f23b0c2911bd124818fd1a71ab052db502027d8d72f146c5980b0c07ad2d9ceb42e0761488dc93674bd6df083d97a1a58dc4f16826d30a4736e2bfbb172
+  data.tar.gz: 02eff11856d22c91fc861630c34210f5b02e4b40d7adcf520853ff657f82971d3e8cb8ae303628e59d1a785ea13c957d9692898ad93c89554a1a276200a73e56

data/README.md

@@ -1,6 +1,6 @@
 # DailyAffirmation
 
-[ ![Codeship Status for teamsnap/daily_affirmation](https://www.codeship.io/projects/70727b30-de01-0131-af05-5236ebb52643/status)](https://www.codeship.io/projects/24759)
+[![Codeship Status for teamsnap/daily_affirmation](https://www.codeship.io/projects/70727b30-de01-0131-af05-5236ebb52643/status)](https://www.codeship.io/projects/24759)
 
 [![Gem Version](https://badge.fury.io/rb/daily_affirmation.png)](http://badge.fury.io/rb/daily_affirmation)
 [![Code Climate](https://codeclimate.com/github/teamsnap/daily_affirmation.png)](https://codeclimate.com/github/teamsnap/daily_affirmation)
@@ -8,6 +8,8 @@
 [![Dependency Status](https://gemnasium.com/teamsnap/daily_affirmation.png)](https://gemnasium.com/teamsnap/daily_affirmation)
 [![License](http://img.shields.io/license/MIT.png?color=green)](http://opensource.org/licenses/MIT)
 
+[Documentation](http://www.rubydoc.info/github/teamsnap/daily_affirmation)
+
 A simple library for external validations of POROs
 
 ![Daily Affirmation](http://i.imgur.com/rdvgFAK.jpg)
@@ -49,11 +51,6 @@ end
 team1 = OpenStruct.new(:name => "", :status_cd => 3)
 TeamAffirmation.new(team1).valid? #=> false
 ```
-    
-## Roadmap
-
-- Allow error messages to use i18n.
-- Add a way to build custom validations (example validating a password).
 
 ## Contributing
 

data/daily_affirmation.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["oss@teamsnap.com"]
   spec.description   = "A simple library for external validations of POROs"
   spec.summary       = "A simple library for external validations of POROs"
-  spec.homepage      = "https://github.com/teamsnap/daily_affirmation"
+  spec.homepage      = "http://teamsnap.github.io/daily_affirmation"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/daily_affirmation.rb

@@ -17,6 +17,7 @@ require_relative "daily_affirmation/version"
 module DailyAffirmation
   OptionError = Class.new(StandardError)
 
+  # Include DailyAffirmation.affirmations to make your object a validator.
   def self.affirmations
     Module.new do
       def self.included(descendant)

data/lib/daily_affirmation/affirmations.rb

@@ -4,14 +4,26 @@ module DailyAffirmation
       descendant.extend(ClassMethods)
     end
 
+    # Creates a new instance of the validator.
+    #
+    # @param object [Object] the object to validate.
+    # @return [self]
     def initialize(object)
       self.object = object
     end
 
+    # Tells you if the object is valid based on the affirmations.
+    #
+    # @return [true, false]
     def valid?
       validate[0]
     end
 
+    # Returns an array of length 2 telling you if the object is valid, along
+    # with any error messages.
+    #
+    # @return [Array(Boolean, Array<String>)] Array of length 2 containing
+    #   validation results.
     def validate
       @validate ||= [
         affirmations.map(&:first).all?,
@@ -19,6 +31,9 @@ module DailyAffirmation
       ]
     end
 
+    # Returns an array of error message if any, otherwise an empty array.
+    #
+    # @return [Array<String>]
     def error_messages
       validate[1]
     end

data/lib/daily_affirmation/validator.rb

@@ -1,5 +1,18 @@
 module DailyAffirmation
   class Validator
+    # Initializes a new validator to validate the given object/attribute
+    # combination.
+    #
+    # @param object [Object] the object to validate.
+    # @param attribute [Symbol] the attribute to validate. The object must
+    #   `respond_to?` a method with the name `attribute` with no arguments.
+    # @param opts [Hash] any special options related to the affirmation.
+    # @option opts [Proc] :if evaluated before affirmation to ensure we should
+    #   run validation.
+    # @option opts [true, false] :allow_nil determines if we skip validation of
+    #   `nil` valued attributes.
+    #
+    # @return [self]
     def initialize(object, attribute, opts = {})
       self.object = object
       self.attribute = attribute
@@ -7,14 +20,31 @@ module DailyAffirmation
       self.opts = opts
     end
 
+    # Returns an array of length 2 telling you if the object passes this
+    # affirmation along with an error message if it doesn't.
+    #
+    # @return [Array(Boolean, [nil, String])] Array of length 2 containing
+    #   validation results.
     def affirm
       @affirm ||= [valid?, valid? ? nil : error_message]
     end
 
+    # Tells you if the object is valid based on this affirmation.
+    #
+    # @note Subclasses of DailyAffirmation::Validator must implement this
+    # method.
+    #
+    # @return [true, false]
     def valid?
       raise StandardError, "must implement #valid?"
     end
 
+    # Returns the error message related to this validation.
+    #
+    # @note This method will always return the associated error message, even
+    # if the object passes validation.
+    #
+    # @return [String]
     def error_message
       i18n_error_message(:none)
     end

data/lib/daily_affirmation/validators/absence_validator.rb

@@ -3,6 +3,7 @@ require_relative "presence_validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is not present.
     class AbsenceValidator < Validator
       def valid?
         @valid ||= !PresenceValidator.new(object, attribute).valid?

data/lib/daily_affirmation/validators/acceptance_validator.rb

@@ -2,6 +2,7 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affrimation ensures an attribute is true.
     class AcceptanceValidator < Validator
       def valid?
         @valid ||= !!value

data/lib/daily_affirmation/validators/confirmation_validator.rb

@@ -2,6 +2,8 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures a related attribute *_confirmation has the same
+    # value.
     class ConfirmationValidator < Validator
       def valid?
         @valid ||= value == object.send("#{attribute}_confirmation")

data/lib/daily_affirmation/validators/custom_validator.rb

@@ -2,6 +2,10 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation accepts a :proc option and evaluates it's results.
+    #
+    # @option opts [Proc] :proc evaluated to determine if attribute should be
+    #   validated.
     class CustomValidator < Validator
       def valid?
         @valid ||= opts[:proc].call(object)

data/lib/daily_affirmation/validators/date_validator.rb

@@ -2,6 +2,14 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is a date and if a :before or
+    # :after option is given, that the attribute is before or after the
+    # selected date.
+    #
+    # @option opts [Date] :before if present checked to ensure value is before
+    #   provided date.
+    # @option opts [Date] :after if present checked to ensure value is after
+    #   provided date.
     class DateValidator < Validator
       class NullDateLike
         def <(val); true; end

data/lib/daily_affirmation/validators/equality_validator.rb

@@ -2,6 +2,10 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is equal to the :value option
+    # given.
+    #
+    # @option opts [Object] :value used to determine if attribute is equal
     class EqualityValidator < Validator
       def valid?
         @valid ||= (opts[:value] == value)

data/lib/daily_affirmation/validators/exclusion_validator.rb

@@ -3,6 +3,11 @@ require_relative "inclusion_validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is not in the provided :list
+    # option.
+    #
+    # @option opts [#include?] :list list of values the attribute must not
+    #   match.
     class ExclusionValidator < Validator
       def valid?
         @valid ||= !InclusionValidator.new(object, attribute, opts).valid?

data/lib/daily_affirmation/validators/format_validator.rb

@@ -2,6 +2,9 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute matches the provided :regex option.
+    #
+    # @option opts [Regex] :regex the patten the attributes value must match.
     class FormatValidator < Validator
       def valid?
         @valid ||= !!opts[:regex].match(value)

data/lib/daily_affirmation/validators/inclusion_validator.rb

@@ -2,6 +2,9 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is in the provided :list option.
+    #
+    # @option opts [#include?] :list list of values the attribute must match.
     class InclusionValidator < Validator
       def valid?
         @valid ||= opts[:list].include?(value)

data/lib/daily_affirmation/validators/length_validator.rb

@@ -2,6 +2,11 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute's size is within the provided
+    # :range option.
+    #
+    # @option opts [Range] :range the range the size of the attribute's value
+    #   must fit in.
     class LengthValidator < Validator
       def valid?
         @valid ||= opts[:range].include?(value.size)

data/lib/daily_affirmation/validators/numericality_validator.rb

@@ -2,6 +2,14 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is a Number and if the
+    # :greater_than or :less_then option is given, that the attribute is
+    # greater than or less than the value provided.
+    #
+    # @option opts [Numeric] :greater_than the value the attribute's value must
+    #   be greater than.
+    # @option opts [Numeric] :less_than the value the attribute's value must be
+    #   less than.
     class NumericalityValidator < Validator
       def valid?
         @valid ||= value ? numeric? && greater_than? && less_than? : true

data/lib/daily_affirmation/validators/presence_validator.rb

@@ -2,6 +2,7 @@ require_relative "../validator"
 
 module DailyAffirmation
   module Validators
+    # This affirmation ensures an attribute is present.
     class PresenceValidator < Validator
       def valid?
         @valid ||= present?

data/lib/daily_affirmation/version.rb

@@ -1,3 +1,3 @@
 module DailyAffirmation
-  VERSION = "0.8.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: daily_affirmation
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Shane Emmons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,7 @@ files:
 - spec/validators/length_validator_spec.rb
 - spec/validators/numericality_validator_spec.rb
 - spec/validators/presence_validator_spec.rb
-homepage: https://github.com/teamsnap/daily_affirmation
+homepage: http://teamsnap.github.io/daily_affirmation
 licenses:
 - MIT
 metadata: {}