assent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b52124be104c1cc804575ecf7ccd64d10a19344
+  data.tar.gz: 35d85119557e5d1bd50d6e4e856104909dbb04d5
+SHA512:
+  metadata.gz: 22e0145cca7875097063146a46fcc3a816230c2ad2693bcb7ab1d040a403cd383e9457b50ad1411e9ae500fafcc69d8d0b56519785c54c239e77ce88ca1ccff4
+  data.tar.gz: 175aa27110bcfaf38311a65ec3eaa6cf94d079ee3a267438fbe139388cb7de1139185d0283a0c7a070ec2955f8a82a91a3218732c81ecc5020e4b987aa0eccaf

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+assent-*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    assent (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  assent!
+  bundler (~> 1.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Frank
+
+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,55 @@
+[![Build Status](https://travis-ci.org/frankieleef/assent.svg?branch=develop)](https://travis-ci.org/frankieleef/assent)
+
+# Assent
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/assent`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'assent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install assent
+
+## Usage
+
+**NOTE:** This gem is still under heavy development.
+
+#### Basic Usage
+
+```ruby
+  require 'assent'
+
+  class LoginValidator < Assent::Validator
+
+    field :email, presence: true
+    field :password, presence: true
+  end
+```
+
+## Development
+
+**TODO**
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/frankieleef/assent.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "assent"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lang.yml

@@ -0,0 +1 @@
+presence: The :field is required because I say so.

data/lib/assent/config/config.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'assent/exceptions/config_exception'
+
+module Assent
+  module Config
+
+    def initialize
+      if Config.config.empty?
+        lang = YAML.load_file(File.dirname(__FILE__) + '/lang.yml')
+
+        lang.each do |key, value|
+          Config.add(key, value)
+        end
+      end
+    end
+
+    def self.config_file(path)
+      begin
+        lang = YAML.load_file(path)
+        lang.each do |key, value|
+          add(key, value)
+        end
+      rescue Errno::ENOENT
+        raise ConfigException.new "Config file could not be found."
+      end
+    end
+
+    def self.add(option, value)
+      config[option] = value
+    end
+
+    def self.config
+      @@config ||= Hash.new
+    end
+
+    private
+
+    def set_empty_config
+      @@config = Hash.new
+    end
+
+  end
+end

data/lib/assent/config/lang.yml

@@ -0,0 +1,4 @@
+presence: The :field is required.
+accepted: The :field is not accepted.
+date: The :field is not a valid date.
+ip: The :field is not a valid ip.

data/lib/assent/exceptions/config_exception.rb

@@ -0,0 +1,4 @@
+module Assent
+  class ConfigException < Exception
+  end
+end

data/lib/assent/validations/errors.rb

@@ -0,0 +1,28 @@
+require 'assent/config/config'
+
+module Assent
+  class Errors
+    include Config
+
+    def initialize
+      @errors = Hash.new
+      super
+    end
+
+    def add(field, rule)
+      text = String.new(Config.config[rule.to_s])
+      replace(text, field)
+      @errors[field] ||= []
+      @errors[field].push(text)
+    end
+
+    def errors
+      @errors
+    end
+
+    def replace(text, field)
+      message = text.sub! ':field', field.to_s
+      return message
+    end
+  end
+end

data/lib/assent/validations/field.rb

@@ -0,0 +1,24 @@
+require 'assent/validations/validations_set'
+
+module Assent
+  module Field
+    include ValidationsSet
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def add_field(name, options)
+      add(name, options)
+    end
+
+    module ClassMethods
+      include Field
+
+      def field(name, options = {}, &block)
+        add_field name, options
+      end
+    end
+
+  end
+end

data/lib/assent/validations/options.rb

@@ -0,0 +1,21 @@
+module Assent
+  module Options
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def self.options
+      @options ||= Hash.new
+    end
+
+    module ClassMethods
+      include Options
+
+      def set(option, value)
+        Options.options[option] = value
+      end
+
+    end
+  end
+end

data/lib/assent/validations/validation_error.rb

@@ -0,0 +1,12 @@
+module Assent
+  class ValidationError
+
+    attr_reader :field
+    attr_reader :validation
+
+    def initialize(field, validation)
+      @field = field
+      @validation = validation
+    end
+  end
+end

data/lib/assent/validations/validations_set.rb

@@ -0,0 +1,14 @@
+module Assent
+  module ValidationsSet
+
+    @@validations = Hash.new
+
+    def add(name, options)
+      @@validations[name] = options
+    end
+
+    def validations
+      @@validations
+    end
+  end
+end

data/lib/assent/validations/validator.rb

@@ -0,0 +1,101 @@
+require 'assent/validations/options'
+require 'date'
+
+module Assent
+  class Validate
+    include Options
+
+    def initialize(field, value, rules, errors)
+      @field = field
+      @value = value
+      @rules = rules
+      @errors = errors
+    end
+    # Validate method that checks all the validations for a single field
+    def validate
+      required
+      accepted
+
+      return if blank?
+
+      date
+      ip
+
+      @errors
+    end
+
+    private
+
+    # Validates the presence of a field
+    #
+    # Example:
+    #
+    # class LoginValidator < Assent::Validator
+    #   field :email, presence: true
+    # end
+    #
+    # credentials = Hash.new
+    # credentials[:email] = nil
+    # LoginValidator.new.errors will contain errors because of a nil value
+    #
+    #
+    # credentials[:email] = "test@example.com"
+    # This will pass
+    def required
+      validation(:presence) { !blank? }
+    end
+
+    # Validates if a field has the value true, 1 or yes
+    #
+    # Example:
+    # class TermsValidator < Assent::Validator
+    #   field :terms, accepted: true
+    # end
+    def accepted
+      validation(:accepted) { @value == true || @value == 1}
+    end
+
+    # Validates if a field is a valid date
+    #
+    # Example:
+    # class RegistrationValidator < Assent::validator
+    # field :date, date: true
+    # end
+    def date
+      validation(:date) do |validator|
+        date = Date.parse(@value) rescue nil
+
+        !date.nil?
+      end
+    end
+
+    # Validates if a field is a valid ip-address
+    #
+    # Example:
+    # class IpValidator < Assent::Validator
+    #   field :ip, ip: true
+    # end
+    def ip
+      validation(:ip) do |validator|
+        result = /^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$/.match(@value.to_s)
+
+        !result.nil?
+      end
+    end
+
+    # Checks if the given value is nil or empty
+    def blank?
+      @value.nil? || @value.empty?
+    end
+
+    def validation(rule)
+      validator = @rules[rule]
+
+      if(validator) && (!yield validator)
+        @errors.add(@field, rule)
+      end
+
+      yield validator
+    end
+  end
+end

data/lib/assent/validator.rb

@@ -0,0 +1,27 @@
+require 'assent/validations/field'
+require 'assent/validations/options'
+require 'assent/config/config'
+require 'assent/validations/validator'
+require 'assent/validations/errors'
+
+module Assent
+  class Validator
+    include Field
+    include Options
+    include Config
+
+    def errors
+      @errors ||= Errors.new
+    end
+
+    def validate(input)
+      @@validations.each do |field, validations|
+        value = input[field]
+        value = input[field].to_s if value.nil?
+        validate = Validate.new(field, value, validations, errors)
+        validate.validate
+      end
+    end
+
+  end
+end

data/lib/assent/version.rb

@@ -0,0 +1,3 @@
+module Assent
+  VERSION = "0.1.0"
+end

data/lib/assent.rb

@@ -0,0 +1,2 @@
+require 'assent/validator'
+require 'assent/config/config'

data/spec/config_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Assent::Config do
+
+  let(:config) { Class.new {
+      include Assent::Config
+
+      def initialize
+        super
+      end
+
+      def add(option, value)
+        Assent::Config.add(option, value)
+      end
+
+      def config_file(path)
+        puts path
+        Assent::Config.config_file(path)
+      end
+
+      def config
+        Assent::Config.config
+      end
+    }
+  }
+
+
+  describe '.config_file' do
+    it 'loads the default config when no config file is set' do
+      config_class = config.new
+      expect(config_class.config["presence"]).to eq("The :field is required.")
+    end
+
+    it 'adds custom config to the config hash' do
+      config_class = config.new
+      config_class.config_file(File.dirname(__FILE__) + '/helpers/config.yml')
+      expect(config_class.config["presence"]).to eq("This is custom config for :field")
+    end
+
+    after(:all) do
+      config_class = Class.new{
+        include Assent::Config
+
+        def initialize
+          super
+        end
+      }
+
+      config_class.new.send(:set_empty_config)
+    end
+  end
+end

data/spec/field_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Assent::Field do
+  describe '.field' do
+    let(:field) { Class.new{ include Assent::Field }}
+
+    it 'adds a field to a hash' do
+      rules = Hash.new
+      rules[:name] = {:presence=>true}
+      field.field :name, presence: true
+      expect(field.validations).to eq(rules)
+    end
+    
+  end
+end

data/spec/helpers/config.yml

@@ -0,0 +1 @@
+presence: This is custom config for :field

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'assent'

data/spec/validator_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Assent::Validate do
+  let(:error) { Assent::Errors.new { include Assent::Config }}
+  let(:validator) { Assent::Validate }
+
+  describe '.required' do
+
+    it 'checks if a field is not blank' do
+      validation = validator.new(:name, "Frank", {:presence=>true}, error)
+      expect(validation.send(:required)).to eq(true)
+    end
+
+    it "adds an error when a field is required and empty" do
+      validation = validator.new(:name, nil, {:presence=>true}, error)
+      validation.send(:required)
+      expect(error.errors).to eq({:name => ["The name is required."]})
+    end
+  end
+
+  describe '.accepted' do
+    it 'checks if a field is accepted' do
+      validation = validator.new(:terms, true, {:accepted=>true}, error)
+      expect(validation.send(:accepted)).to eq(true)
+    end
+
+    it 'returns false when a field is not accepted' do
+      validation = validator.new(:terms, false, {:accepted=>true}, error)
+      expect(validation.send(:accepted)).to eq(false)
+    end
+
+    it 'adds an error when a field is not accepted' do
+      validation = validator.new(:terms, false, {:accepted=>true}, error)
+      validation.send(:accepted)
+      expect(error.errors).to eq({:terms => ["The terms is not accepted."]})
+    end
+  end
+
+  describe '.date' do
+    it 'checks if a field is a valid date' do
+      validation = validator.new(:date, '20-11-1992', {:date=>true}, error)
+      expect(validation.send(:date)).to eq(true)
+    end
+
+    it 'returns false when a field is not a valid date' do
+      validation = validator.new(:date, '200-11-1992', {:date=>true}, error)
+      expect(validation.send(:date)).to eq(false)
+      validation2 = validator.new(:date, nil, {:date=>true}, error)
+      expect(validation2.send(:date)).to eq(false)
+      validation3 = validator.new(:date, "", {:date=>true}, error)
+      expect(validation3.send(:date)).to eq(false)
+    end
+
+    it 'adds an error when a field is not a date' do
+      validation = validator.new(:date, '200-11-1992', {:date=>true}, error)
+      validation.send(:date)
+      expect(error.errors).to eq({:date=> ["The date is not a valid date."]})
+    end
+  end
+
+  describe '.ip' do
+    it 'checks if a field is a valid ip' do
+      validation = validator.new(:ip, '192.168.1.1', {:ip=>true}, error)
+      expect(validation.send(:ip)).to eq(true)
+    end
+
+    it 'returns false when a field is not a valid ip' do
+      validation = validator.new(:ip, '912.456.123.123', {:ip=>true}, error)
+      expect(validation.send(:ip)).to eq(false)
+    end
+
+    it 'adds an error when a field is not a valid ip' do
+      validation = validator.new(:ip, '912.456.123.123', {:ip=>true}, error)
+      validation.send(:ip)
+      expect(error.errors).to eq({:ip => ["The ip is not a valid ip."]})
+    end
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'assent/version'
+
+describe Assent do
+  it 'has a version number' do
+    expect(Assent::VERSION).not_to be nil
+  end
+end

data/test.rb

@@ -0,0 +1,19 @@
+require 'assent'
+
+class Valid < Assent::Validator
+  field :email, presence: true
+  field :testfield, presence: true
+  field :datetime, date: true
+end
+
+# Assent::Config.config_file 'lang.yml'
+
+input = Hash.new
+# input[:email] = "fr.levering@gmail.com"
+# input[:name] = "test"
+date = "20-11-1992"
+Date.parse(date)
+input[:datetime] = "20-11-1992"
+valid = Valid.new
+valid.validate(input)
+puts valid.errors.errors

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: assent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem that handles your form and query validation in an elegant way.
+email:
+- fr.levering@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lang.yml
+- lib/assent.rb
+- lib/assent/config/config.rb
+- lib/assent/config/lang.yml
+- lib/assent/exceptions/config_exception.rb
+- lib/assent/validations/errors.rb
+- lib/assent/validations/field.rb
+- lib/assent/validations/options.rb
+- lib/assent/validations/validation_error.rb
+- lib/assent/validations/validations_set.rb
+- lib/assent/validations/validator.rb
+- lib/assent/validator.rb
+- lib/assent/version.rb
+- spec/config_spec.rb
+- spec/field_spec.rb
+- spec/helpers/config.yml
+- spec/spec_helper.rb
+- spec/validator_spec.rb
+- spec/version_spec.rb
+- test.rb
+homepage: https://rubygems.org
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Assent is a simple validation library
+test_files: []