digget 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 844819201cdd222faf30bdd0b8abf0cc2a63b24c
+  data.tar.gz: 71c0f7d24f13af6fdc051f925da254902d1a9e6f
+SHA512:
+  metadata.gz: 6f88cfb2e064c08028ef62d7e72a976e905b2dbdabe509772e66778bd9626d0bb5a58be3d7b4e7e0111a41165cab365a5cd23b686db42e3f026176470681bd1d
+  data.tar.gz: 13aeb6030bc94ca3d26d58059e86ec0c209d6e79278fa5b29506360761e8c87b29cce1a788f342f7a4039891b4f3261af09ffce6c44fce310866bcf73c232b65

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Pieterjan
+
+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,30 @@
+[![codecov](https://codecov.io/gh/pielambr/digget/branch/master/graph/badge.svg)](https://codecov.io/gh/pielambr/digget)
+[![Build Status](https://travis-ci.org/pielambr/digget.svg?branch=master)](https://travis-ci.org/pielambr/digget)
+# Digget
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digget'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install digget
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--private']
+  t.stats_options = ['--list-undoc']
+end
+
+task default: :spec

data/lib/digget.rb

@@ -0,0 +1,6 @@
+require 'digget/validator'
+require 'i18n'
+
+module Digget
+  I18n.load_path += Dir["lib/translations/digget.yml"]
+end

data/lib/digget/validator.rb

@@ -0,0 +1,115 @@
+require 'i18n'
+
+module Digget
+  # This class is the validator superclass containing the logic to cast
+  # the parameters and verify the options that are defined on them
+  class Validator
+    def initialize(params, object = nil)
+      @object = object
+      @casted_params = {}
+      @errors = []
+      @params = params
+    end
+
+    # This method returns an array with all the errors during validation
+    # @return [Array] An array containing the validation errors
+    attr_reader :errors
+
+    # This method returns a hash with the parameters casted to their requested type
+    # @return [Hash] A hash with as a key the parameter symbol and the casted value as value
+    attr_reader :casted_params
+
+    # This method verifies one of the parameters with the provided options
+    # @param name [Symbol] The name of the param in the `params` hash
+    # @param type [Class] Type that the parameter should be casted to
+    # @param options [Hash] Validation options for this parameter
+    def verify(name, type, options = {})
+      casted_param = cast(@params[name], type)
+      return unless @errors.empty?
+      @casted_params[name] = casted_param
+      verify_options(casted_param, name, options)
+      casted_param
+    end
+
+    def filter(name, type, options = {})
+      param = verify(name, type, options)
+      return object unless @errors.empty?
+      filter_options(param, name, options)
+    end
+
+    # This method is a helper method to determine whether the validation of the parameters was successful
+    # @return `true` if there were no errors during parameter checking, `false` otherwise
+    def valid?
+      @errors.empty?
+    end
+
+    private
+
+    # This method casts the parameter to the requested type if possible
+    # @param param [String] Parameter that is about to get casted
+    # @param type [Class] The type that the parameter should be after this method
+    # @return Returns a casted version of the provided parameter
+    def cast(param, type)
+      if param.nil?
+        return nil
+      elsif type == Integer
+        return Integer(param)
+      elsif type == String
+        return String(param)
+      elsif type == Float
+        return Float(param)
+      elsif type == Date
+        return Date.parse(param)
+      elsif type == Time
+        return Time.parse(param)
+      end
+    rescue ArgumentError
+      errors.append(I18n.t('digget.cast', param: param, type: type))
+    end
+
+    # This method verifies the parameters and adds errors when a parameter
+    # doesn't conform with the provided verification options
+    # @param param The parameter value that needs to be verified
+    # @param name [String] The name of the parameter, used to be displayed in error messages
+    # @param options [Hash] The verification options for the provided parameter
+    def verify_options(param, name, options = {})
+      options.each do |key, value|
+        if key == :required && value
+          next unless param.nil?
+          @errors.append(I18n.t('digget.required', name: name))
+        elsif key == :min && !param.nil?
+          next unless param < value
+          @errors.append(I18n.t('digget.min', name: name, value: value))
+        elsif key == :max && !param.nil?
+          next unless param > value
+          @errors.append(I18n.t('digget.max', name: name, value: value))
+        elsif key == :min_length && !param.nil?
+          next unless param.length < value
+          @errors.append(I18n.t('digget.min_length', name: name, value: value))
+        elsif key == :max_length && !param.nil?
+          next unless param.length > value
+          @errors.append(I18n.t('digget.max_length', name: name, value: value))
+        elsif key == :length && !param.nil?
+          next unless param.length == value
+          @errors.append(I18n.t('digget.length', name: name, value: value))
+        end
+      end
+    end
+
+    def filter_options(param, name, options = {})
+      name = options.key?(:column) ? options[:column] : name
+      return unless @object && options.key?(:filter)
+      filter = options[:filter]
+      if filter == :min
+        @object = @object.where(@object.arel_table[name].gteq(param))
+      elsif filter == :max
+        @object = @object.where(@object.arel_table[name].lteq(param))
+      elsif filter == :equal
+        @object = @object.where(@object.arel_table[name].eq(param))
+      elsif filter == :not_equal
+        @object = @object.where(@object.arel_table[name].not_eq(param))
+      end
+    end
+  end
+
+end

data/lib/digget/version.rb

@@ -0,0 +1,3 @@
+module Digget
+  VERSION = '0.1.0'
+end

data/lib/translations/digget.yml

@@ -0,0 +1,9 @@
+en:
+  digget:
+    cast: "The parameter `%{param}` cannot be converted to type `%{type}`"
+    required: "The parameter `%{name}` is required"
+    min: "The parameter `%{name}` should be at least %{value}"
+    max: "The parameter `%{name}` can be %{value} at most"
+    min_length: "The parameter `%{name}` should have a length of at least %{value}"
+    max_length: "The parameter `%{name}` should have a length of %{value} at most"
+    length: "The parameter `%{name}` should have a length of %{value}"

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: digget
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pieterjan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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-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: byebug
+  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: yard
+  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: codecov
+  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: database_cleaner
+  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: Description of Digget.
+email:
+- me@pielambr.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/digget.rb
+- lib/digget/validator.rb
+- lib/digget/version.rb
+- lib/tasks/digget_tasks.rake
+- lib/translations/digget.yml
+homepage: https://www.pielambr.be
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Summary of Digget.
+test_files: []