daily_affirmation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a8c603a904381accd3632ef5a72f8b0fdb88d7f
+  data.tar.gz: 92b4e916aefb6589644c63cde10a38e820768631
+SHA512:
+  metadata.gz: fc3b958edda00cdde56f72e407d93a039e2b37ba304d47200643c5a99246912b2f8babb2664f492004c9f017f7dff32c55ca77e73d0920a3c0fbcfeb9c284c6c
+  data.tar.gz: 10be4946fe5db48e8794ca8dd3c0efaadee1f26de108121a7101d10f2befd2faa7c01216d6b6099644d59e99bf883a8c94c798491a130308771285e4ffa2bee0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "coveralls", :require => false
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TeamSnap
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# DailyAffirmation
+
+[![Semaphore](https://semaphoreapp.com/api/v1/projects/7268def52c792e50bfc60e1b1a6e905ed4e2a80d/118940/shields_badge.png)](https://semaphoreapp.com/minter/daily_affirmation)
+[![Code Climate](https://codeclimate.com/github/teamsnap/daily_affirmation.png)](https://codeclimate.com/github/teamsnap/daily_affirmation)
+[![Coverage Status](https://coveralls.io/repos/teamsnap/daily_affirmation/badge.png?branch=master)](https://coveralls.io/r/teamsnap/daily_affirmation?branch=master)
+[![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)
+
+A simple library for external validations of POROs
+
+![Daily Affirmation](http://i.imgur.com/rdvgFAK.jpg)
+
+There are currently two ways to validate objects in Rails, ActiveRecord based validates and ActiveModel based validations. Both require them to be placed directly into your models, making for more heavy weight, less flexible code. DailyAffirmation allows you to validate your models (or any PORO) externally.
+
+By validating objects externally, you can have different validations depending on your code path. Perhaps you require a password for a User object when it's being created, but do not need it again when it's being updated. Simply create a UserCreationAffirmation and a UserChangeAffirmation with the correct validations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'daily_affirmation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install daily_affirmation
+
+## Usage
+
+    require "daily_affirmations"
+
+    class Team
+      attr_accessor :name, :status_cd
+    end
+
+    class TeamAffirmation
+      include DailyAffirmation.affirmations
+
+      affirms_presence_of :name
+      affirms_inclusion_of :status_cd, :list => 0..2
+    end
+
+    team1 = OpenStruct.new(:name => "", :status_cd => 3)
+    TeamAffirmation.new(team1).valid? #=> false
+    
+## Roadmap
+
+- Provide all the validations ActiveModel does
+- Add a way to build custom validations (example validating a password)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/daily_affirmation.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'daily_affirmation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "daily_affirmation"
+  spec.version       = DailyAffirmation::VERSION
+  spec.authors       = ["Shane Emmons"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.beta1"
+end

data/lib/daily_affirmation/affirmations.rb

@@ -0,0 +1,88 @@
+module DailyAffirmation
+  module Affirmations
+    def self.included(descendant)
+      descendant.extend(ClassMethods)
+    end
+
+    def initialize(object)
+      self.object = object
+    end
+
+    def valid?
+      validate[0]
+    end
+
+    def validate
+      @validate ||= [
+        affirmations.map(&:first).all?,
+        affirmations.map(&:last).compact
+      ]
+    end
+
+    def error_messages
+      validate[1]
+    end
+
+    private
+
+    attr_accessor :object
+
+    def affirmations
+      @affirmations ||= self.class.affirmations
+        .map { |affirmation| affirm(affirmation) }
+    end
+
+    def affirm(affirmation)
+      method = "affirm_#{affirmation[:type]}_of"
+      attribute = affirmation[:attribute]
+      args = affirmation.reject { |k, _| [:type, :attribute].include?(k) }
+      send(method, attribute, args)
+    end
+
+    def affirm_presence_of(attribute, _ = {})
+      if present?(attribute)
+        [true, nil]
+      else
+        [false, "#{attribute} is not present"]
+      end
+    end
+
+    def affirm_inclusion_of(attribute, list: [])
+      if list.include?(object.send(attribute))
+        [true, nil]
+      else
+        [false, "#{attribute} is not included in #{list}"]
+      end
+    end
+
+    def blank?(attribute)
+      value = object.send(attribute)
+      case value
+      when String
+        value !~ /[^[:space:]]/
+      else
+        value.respond_to?(:empty?) ? value.empty? : !value
+      end
+    end
+
+    def present?(attribute)
+      !blank?(attribute)
+    end
+
+    module ClassMethods
+      def affirms_presence_of(attribute)
+        affirmations << {:attribute => attribute, :type => :presence}
+      end
+
+      def affirms_inclusion_of(attribute, list: [])
+        affirmations << {
+          :attribute => attribute, :type => :inclusion, :list => list
+        }
+      end
+
+      def affirmations
+        @affirmations ||= []
+      end
+    end
+  end
+end

data/lib/daily_affirmation/version.rb

@@ -0,0 +1,3 @@
+module DailyAffirmation
+  VERSION = "0.0.1"
+end

data/lib/daily_affirmation.rb

@@ -0,0 +1,12 @@
+require_relative "daily_affirmation/affirmations"
+require_relative "daily_affirmation/version"
+
+module DailyAffirmation
+  def self.affirmations
+    Module.new do
+      def self.included(descendant)
+        descendant.send(:include, ::DailyAffirmation::Affirmations)
+      end
+    end
+  end
+end

data/spec/daily_affirmation_spec.rb

@@ -0,0 +1,140 @@
+require_relative "spec_helper"
+require_relative "../lib/daily_affirmation"
+
+describe DailyAffirmation do
+  describe ".affirms_presence_of" do
+    let(:cls) do
+      Class.new do
+        include DailyAffirmation.affirmations
+
+        affirms_presence_of :name
+      end
+    end
+
+    it "fails validation if attribute is nil" do
+      obj = double(:name => nil)
+
+      affirmation = cls.new(obj)
+      expect(affirmation).to_not be_valid
+    end
+
+    it "fails validation if attribute is empty" do
+      obj = double(:name => " ")
+
+      affirmation = cls.new(obj)
+      expect(affirmation).to_not be_valid
+    end
+
+    it "passes validation if attribute is present" do
+      obj = double(:name => :foo)
+
+      affirmation = cls.new(obj)
+      expect(affirmation).to be_valid
+    end
+  end
+
+  describe ".affirms_inclusion_of" do
+    let(:cls) do
+      Class.new do
+        include DailyAffirmation.affirmations
+
+        affirms_inclusion_of :age, :list => 13..18
+      end
+    end
+
+    it "fails validation if attribute is not in the list" do
+      obj = double(:age => 12)
+
+      affirmation = cls.new(obj)
+      expect(affirmation).to_not be_valid
+    end
+
+    it "passes validation if attribute is in the list" do
+      obj = double(:age => 13)
+
+      affirmation = cls.new(obj)
+      expect(affirmation).to be_valid
+    end
+  end
+
+  describe "#validate" do
+    let(:cls) do
+      Class.new do
+        include DailyAffirmation.affirmations
+
+        affirms_presence_of :name
+        affirms_inclusion_of :age, :list => 13..18
+      end
+    end
+
+    it "returns if object is valid as the first result" do
+      obj = double(:name => :foo, :age => 13)
+      affirmation = cls.new(obj)
+
+      is_valid = affirmation.validate[0]
+      expect(is_valid).to eq(true)
+    end
+
+    it "returns validation error messages as the second result" do
+      obj = double(:name => "", :age => 12)
+      affirmation = cls.new(obj)
+
+      messages = affirmation.validate[1]
+      expect(messages).to include("name is not present")
+      expect(messages).to include("age is not included in 13..18")
+    end
+  end
+
+  describe "#valid" do
+    let(:cls) do
+      Class.new do
+        include DailyAffirmation.affirmations
+
+        affirms_presence_of :name
+        affirms_inclusion_of :age, :list => 13..18
+      end
+    end
+
+    it "returns true if the object is valid" do
+      obj = double(:name => :foo, :age => 13)
+      affirmation = cls.new(obj)
+
+      expect(affirmation).to be_valid
+    end
+
+    it "returns false if the object is not valid" do
+      obj = double(:name => "", :age => 12)
+      affirmation = cls.new(obj)
+
+      expect(affirmation).to_not be_valid
+    end
+  end
+
+  describe "error_messages" do
+    let(:cls) do
+      Class.new do
+        include DailyAffirmation.affirmations
+
+        affirms_presence_of :name
+        affirms_inclusion_of :age, :list => 13..18
+      end
+    end
+
+    it "returns an array of error message if the object is not valid" do
+      obj = double(:name => "", :age => 12)
+      affirmation = cls.new(obj)
+      messages = affirmation.error_messages
+
+      expect(messages).to include("name is not present")
+      expect(messages).to include("age is not included in 13..18")
+    end
+
+    it "returns an empty array if the object is valid" do
+      obj = double(:name => :foo, :age => 13)
+      affirmation = cls.new(obj)
+      messages = affirmation.error_messages
+
+      expect(messages).to eq([])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "coveralls"
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: daily_affirmation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shane Emmons
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: A simple library for external validations of POROs
+email:
+- oss@teamsnap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- daily_affirmation.gemspec
+- lib/daily_affirmation.rb
+- lib/daily_affirmation/affirmations.rb
+- lib/daily_affirmation/version.rb
+- spec/daily_affirmation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/teamsnap/daily_affirmation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A simple library for external validations of POROs
+test_files:
+- spec/daily_affirmation_spec.rb
+- spec/spec_helper.rb