rails_legit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 855b56aca820aa680b2a95ec3572d28a617d06bf
+  data.tar.gz: 41482d5be38796fff7d213e38dd5c1d7e04958a7
+SHA512:
+  metadata.gz: e33a786477a8919de7133ed63008aa73e06050b143aeb285148c737a064ecb25fd86ce3de0d4afbd1aff8320ef4db3dc9173cd45b731bac618e5f88e02618ec3
+  data.tar.gz: 1a5dd6eb87d1847579fa906da2b1c22ef45ca74d01789391d68ac5c35364e8897079c6096c3926d608560675f505e6b0a20727fa0cd042074b4094475f8ca13a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-legit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kashyap
+
+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,122 @@
+# Rails::Legit
+
+It is quite common to perform checks like:
+
+* Check if an array is a subset of another array
+* A date supplied by the user does not be in the past
+* An event start date will always fall after the event end date
+
+and so on...
+
+This gem abstracts out this common logic and lets you do things like:
+
+    validates :start_date, verify_date: { before: Date.current }
+
+or
+
+    validates :end_date, verify_date: { before: :current}
+
+As of now, only `Date` and `DateTime` validators are implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_legit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_legit
+
+## Usage
+
+The gem uses Rails' `ActiveModel::Validator` to perform these checks.
+
+
+### Date Validator
+
+Say we are building an event management application where the management
+can create events where they can specify the start times and the end times
+of the event. `EventForm` is such a class that is a non-persistent model of
+the event record.
+
+    class Event < ActiveRecord::Base
+      # has the following attributes:
+      # name
+      # description
+      # to
+      # from
+    end
+
+The `to` and `from` are DateTime objects that get stored in the DB. And the
+corresponding ActiveModel form: (assuming Rails 4)
+
+    class EventForm
+      include ActiveModel::Model
+      attr_accessor :name, :description, :to, :from
+      attr_accessor :to_date, :to_time
+      attr_accessor :from_date, :from_time
+    end
+
+The `:to_date`, `:to_time`, `:from_date`, `:from_time` are the attributes
+for the data that is returned from the UI where there are separate inputs
+for start date, end date, start time and end time.
+
+To use the `DateValidator`, include the `RailsLegit` module in the
+`EventForm` class:
+
+    class EventForm
+      # unchanged from above
+      include RailsLegit
+    end
+
+Adding validations is as simple as:
+
+    class EventForm
+      # unchanged from above
+      validates :from_date, :to_date, verify_date: true
+    end
+
+Currently supported validation syntax elements are:
+
+    verify_date: true
+
+This will check if the date returned from the input fields in the UI is
+valid or not.
+
+    verify_date: { before: Date.current }
+    # same as:
+    verify_date: { before: :current }
+
+The valid options are `:before`, `:after`, `:on_or_before`, `:on_or_after`, `:on`.
+
+You can pass in a method as a symbol, string or a `Date` object. By default, all symbols except
+`:current`, `:today`, `:now` are sent to the object under validation.
+
+    validates :from_date, verify_date: { before: :current } # Date.current is used
+    validates :from_date, verify_date: { before: :today   } # Date.current is used
+    validates :from_date, verify_date: { before: :now     } # Date.current is used
+
+    validates :from_date, verify_date: { before: :end_date } # <EventForm Object>.end_date is used
+
+Finally,
+
+    class EventForm
+      attr_accessor :to_date, :from_date
+      include ActiveModel::Model
+      include RailsLegit
+      validates :from_date, verify_date: { before: :today }
+      validates :to_date, verify_date: { before: :from_date }
+    end
+
+## 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/lib/rails_legit/verify_date_validator.rb

@@ -0,0 +1,91 @@
+module RailsLegit
+  class VerifyDateValidator < ActiveModel::EachValidator
+
+    VALID_COMPARISIONS = {
+      :before => :<,
+      :after => :>,
+      :on => :==,
+      :on_or_before => :<=,
+      :on_or_after => :>=,
+    }.freeze
+
+    attr_accessor :comparisions
+
+    def initialize(options)
+      super
+      @comparisions = {}
+      process_options!
+    end
+
+    def validate_each(record, attribute, value)
+
+      date_to_check = try_to_convert_to_date(value)
+
+      if value.nil?
+        record.errors.add(attribute, "Can't be nil")
+        return
+      end
+
+      unless date_to_check
+        record.errors.add(attribute, "Invalid Date Format")
+        return
+      end
+
+      comparisions.each do |key, value|
+        date_to_be_checked_with_before_type_cast = value.is_a?(Symbol) ? record.send(value) : value
+        date_to_be_checked_with = try_to_convert_to_date(date_to_be_checked_with_before_type_cast)
+
+        # TODO: should check for :current instead
+        message = if date_to_check < Date.today
+                    "Occurs in the past"
+                  else
+                    "Occurs before #{value.to_s.humanize}"
+                  end
+
+        unless date_to_check.send(VALID_COMPARISIONS[key], date_to_be_checked_with)
+          record.errors.add(attribute, message)
+        end
+      end
+    end
+
+    def check_validity!
+      options.keys.each do |key|
+        unless VALID_COMPARISIONS.member?(key)
+          raise ArgumentError, "Valid keys for options are #{VALID_COMPARISIONS.keys.join(", ")}"
+        end
+      end
+    end
+
+    def process_options!
+      options.each do |k, v|
+        if v.respond_to?(:to_date)
+          comparisions[k] = v.send(:to_date)
+        elsif v.is_a? Proc
+          comparisions[k] = v.call
+        elsif v.is_a? Symbol
+          if Date.respond_to? v
+            comparisions[k] = Date.send v
+          else
+            comparisions[k] = v
+          end
+        elsif date = try_to_convert_to_date(v)
+          comparisions[k] = date
+        else
+          raise ArgumentError, "Unable to understand the value for #{k}"
+        end
+      end
+    end
+
+    def try_to_convert_to_date(arg)
+      if arg.respond_to? :to_date
+        arg.to_date
+      else
+        begin
+          Date.parse(arg.to_s)
+        rescue ArgumentError => e
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/rails_legit/version.rb

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

data/lib/rails_legit.rb

@@ -0,0 +1,8 @@
+require "rails_legit/version"
+require "active_support"
+
+module RailsLegit
+  extend ActiveSupport::Autoload
+
+  autoload :VerifyDateValidator
+end

data/rails_legit.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_legit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_legit"
+  spec.version       = RailsLegit::VERSION
+  spec.authors       = ["Kashyap"]
+  spec.email         = ["kashyap.kmbc@gmail.com"]
+  spec.description   = %q{Provides a DSL for common validation formats like Date, Array, DateTime etc.}
+  spec.summary       = %q{Provides a DSL for common validation formats like Date, Array, DateTime etc.}
+  spec.homepage      = ""
+  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 "rails"
+  spec.add_development_dependency "rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require File.expand_path("../../lib/rails_legit.rb", __FILE__)
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/date.rb

@@ -0,0 +1,27 @@
+shared_examples "basic date validations" do
+
+  context "Invalid Date" do
+    let(:date) { "Invalid Date" }
+    it { should be_invalid }
+  end
+
+  context "Valid Date as a String" do
+    let(:date) { "21 December 2013" }
+    it { should be_valid }
+  end
+
+  context "Valid Date as a Date object" do
+    let(:date) { Date.today }
+    it { should be_valid }
+  end
+
+  context "Valid Date as a DateTime object" do
+    let(:date) { DateTime.now }
+    it { should be_valid }
+  end
+
+  context "Valid Date as a Time object" do
+    let(:date) { Time.now }
+    it { should be_valid }
+  end
+end

data/spec/verify_date_validator_spec.rb

@@ -0,0 +1,159 @@
+require "spec_helper"
+require "active_model"
+
+class TestRecordWithNoExtraOptions
+  include ActiveModel::Validations
+  include RailsLegit
+
+  validates :date, verify_date: true
+
+  attr_accessor :date
+  def initialize(date)
+    @date = date
+  end
+end
+
+class TestRecordWithNoExtraOptionsMultipleAttributes
+  include ActiveModel::Validations
+  include RailsLegit
+
+  validates :date, :anotherdate, verify_date: true
+
+  attr_accessor :date, :anotherdate
+  def initialize(date, anotherdate)
+    @date = date
+    @anotherdate = anotherdate
+  end
+end
+
+class TestRecordWithMultipleAttributesBeforeOption
+  include ActiveModel::Validations
+  include RailsLegit
+
+  validates :date, :anotherdate, verify_date: { before: :before_date }
+
+  attr_accessor :date, :anotherdate, :before_date
+  def initialize(date, anotherdate, before_date)
+    @date = date
+    @anotherdate = anotherdate
+    @before_date = before_date
+  end
+end
+
+class TestRecordWithMultipleAttributesBeforeOptionCurrentSymbol
+  include ActiveModel::Validations
+  include RailsLegit
+
+  validates :date, :anotherdate, verify_date: { before: :today }
+
+  attr_accessor :date, :anotherdate, :before_date
+  def initialize(date, anotherdate, before_date)
+    @date = date
+    @anotherdate = anotherdate
+    @before_date = before_date
+  end
+end
+
+class TestRecordWithMultipleAttributesBeforeOptionProc
+  include ActiveModel::Validations
+  include RailsLegit
+
+  validates :date, :anotherdate, verify_date: { before: ->{ Date.today + 1 } }
+
+  attr_accessor :date, :anotherdate
+  def initialize(date, anotherdate)
+    @date = date
+    @anotherdate = anotherdate
+  end
+end
+
+describe RailsLegit::VerifyDateValidator do
+  describe "No Extra Options provided" do
+    let(:record) { TestRecordWithNoExtraOptions.new(date) }
+    subject { record }
+
+    include_examples "basic date validations"
+
+    context "Invalid Date" do
+      let(:date) { "Invalid Date" }
+
+      it "should attach error on appropriate method" do
+        record.valid?
+        expect(record.errors[:date]).to include("Invalid Date Format")
+      end
+    end
+  end
+
+  describe "No Extra Options provided and multiple attributes" do
+    let(:record) { TestRecordWithNoExtraOptionsMultipleAttributes.new(date, anotherdate) }
+    let(:anotherdate) { Date.today }
+    subject { record }
+
+    include_examples "basic date validations"
+
+    context "Invalid Date on comparision method" do
+      let(:anotherdate) { "Invalid Date" }
+      let(:date) { Date.today }
+
+      it "should attach error on appropirate method" do
+        record.valid?
+        expect(record.errors[:anotherdate]).to include("Invalid Date Format")
+      end
+    end
+  end
+
+  describe "Before option, multiple attributes" do
+    let(:date) { "12 december 1900" }
+    subject { record }
+
+    context "Dates in the past" do
+      let(:anotherdate) { Date.today - 1 }
+
+      context "comparision object is a Proc" do
+        let(:record) { TestRecordWithMultipleAttributesBeforeOptionProc.new(date, anotherdate) }
+        it { should be_valid }
+      end
+
+      context "comparision object is a Symbol" do
+        let(:before_date) { Date.today + 1 }
+        let(:record) { TestRecordWithMultipleAttributesBeforeOption.new(date, anotherdate, before_date) }
+
+        it { should be_valid }
+      end
+
+      context "comparision object is :current" do
+        let(:before_date) { :current }
+        let(:record) { TestRecordWithMultipleAttributesBeforeOptionCurrentSymbol.new(date, anotherdate, before_date) }
+
+        it { should be_valid }
+      end
+    end
+
+    context "Dates in the future" do
+      let(:anotherdate) { Date.today + 100 }
+
+      context "comparision object is a Proc" do
+        let(:record) { TestRecordWithMultipleAttributesBeforeOptionProc.new(date, anotherdate) }
+        it { should be_invalid }
+
+        it "should attach error to the correct attribute" do
+          record.valid?
+          message = "Occurs before #{Date.today + 1}"
+          expect(record.errors[:anotherdate]).to include(message)
+        end
+      end
+
+      context "comparision object is a Symbol" do
+        let(:before_date) { Date.today + 1 }
+        let(:record) { TestRecordWithMultipleAttributesBeforeOption.new(date, anotherdate, before_date) }
+
+        it { should be_invalid }
+
+        it "should attach error to the correct attribute" do
+          record.valid?
+          expect(record.errors[:anotherdate]).to include("Occurs before Before date")
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rails_legit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kashyap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-07 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: rails
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a DSL for common validation formats like Date, Array, DateTime
+  etc.
+email:
+- kashyap.kmbc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_legit.rb
+- lib/rails_legit/verify_date_validator.rb
+- lib/rails_legit/version.rb
+- rails_legit.gemspec
+- spec/spec_helper.rb
+- spec/support/date.rb
+- spec/verify_date_validator_spec.rb
+homepage: ''
+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: Provides a DSL for common validation formats like Date, Array, DateTime etc.
+test_files:
+- spec/spec_helper.rb
+- spec/support/date.rb
+- spec/verify_date_validator_spec.rb