preform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dc370e793ab96fc75b18581696c8b174cf9fb7a
+  data.tar.gz: 0662d9ce4610cba517b489f53b5b6003479d2be1
+SHA512:
+  metadata.gz: e2c644425393b44b72c9ab87e3a4c41c658867353ba22192cfb0556dbff1d9818cbf00c641a4e7c3c54efa9863a341091154ed303c8a56439e54a0c201f12cdf
+  data.tar.gz: '08c297085a3b1ee7a5055ddcdee4bf7037ca0f865b6ff8329e07f62a358845b77f0630286315600913949e89b562dd58b9735ae31c9f048ed536328e3ebf8e90'

data/.gitignore

@@ -0,0 +1,2 @@
+.gs/
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    preform (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    clap (1.0.0)
+    cutest (1.2.3)
+      clap
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cutest
+  preform!
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Steven Weiss
+
+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,34 @@
+# Preform
+
+A small library for validating user input. It includes mixin,
+Validatable, and two opinionated classes that include it: Form, and Field.
+
+## Usage
+
+### Installation
+
+`gem install preform`
+
+### API
+
+#### Validatable
+
+`validate`: Template command method that needs to be implemented. Runs to determine errors.
+
+`valid?`: Query to see if any errors exist.
+
+`errors`: Returns the errors hash.
+
+`assert`: Tests a value to see if an error should be added or not. Always returns a boolean so asserts can be nested.
+
+#### Form
+
+`params`: Raw params given to the form.
+
+`attributes`: Hook that allows you to transform params for use in your application. By default returns raw params.
+
+#### Field
+
+`key`: Reader for the form key, used when merging errors into a form.
+
+`value`: Raw value to validate.

data/Rakefile

@@ -0,0 +1,9 @@
+task :install do
+  sh 'mkdir -p .gs & gs bundle install --system'
+end
+
+task :test, :file_name do |t, args|
+  file_name = args[:file_name] || '*'
+
+  sh "gs cutest -r ./test/#{file_name}_test.rb"
+end

data/lib/preform.rb

@@ -0,0 +1,59 @@
+module Preform
+  VERSION = '0.1.0'
+
+  module Validatable
+    def validate
+      raise NotImplementedError, "validate must be implemented on #{self.class}"
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      unless defined?(@errors)
+        @errors = default_errors
+
+        validate
+      end
+
+      @errors
+    end
+
+    def default_errors
+      Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    def assert(predicate, key, msg)
+      return if predicate
+
+      errors[key.to_sym] << msg
+
+      false # Allows assertations to be nested.
+    end
+  end
+
+  class Field
+    include Validatable
+
+    attr_reader :key, :value
+
+    def initialize(key, value)
+      @key, @value = key, value
+    end
+  end
+
+  class Form
+    include Validatable
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def attributes
+      params
+    end
+  end
+end

data/preform.gemspec

@@ -0,0 +1,14 @@
+require_relative "./lib/preform"
+
+Gem::Specification.new do |s|
+  s.name     = "preform"
+  s.summary  = "Preform"
+  s.version  = Preform::VERSION
+  s.authors  = ["Steve Weiss"]
+  s.email    = ["weissst@mail.gvsu.edu"]
+  s.homepage = "https://github.com/sirscriptalot/preform"
+  s.license  = "MIT"
+  s.files    = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest"
+end

data/test/perform_test.rb

@@ -0,0 +1,72 @@
+require 'digest'
+
+require_relative '../lib/preform'
+
+class EmailField < Preform::Field
+  def validate
+    assert value.include?('@'), key, 'invalid format'
+  end
+end
+
+class PasswordField < Preform::Field
+  def validate
+    assert value.length > 6, key, 'too short'
+  end
+
+  def digest
+    Digest::MD5.digest(value) # pretend this is secure
+  end
+end
+
+class AccountForm < Preform::Form
+  attr_reader :email, :password
+
+  def validate
+    @email    = EmailField.new(:email, params['email'])
+    @password = PasswordField.new(:password, params['password'])
+
+    errors.merge!(email.errors)
+    errors.merge!(password.errors)
+  end
+
+  def attributes
+    { email: email.value, password_digest: password.digest }
+  end
+end
+
+def assert_valid(form)
+  assert form.valid?, "#{form} is not valid, it should be"
+end
+
+def refute_valid(form)
+  assert !form.valid?, "#{form} is valid, it should not be"
+end
+
+def assert_errors_includes(form, key, msg)
+  assert form.errors[key].include?(msg), "#{form.errors[key]} does not include #{msg}, it should"
+end
+
+setup do
+  invalid_params = { 'email' => '', 'password' => '123456'}
+
+  AccountForm.new(invalid_params)
+end
+
+test 'invalid form' do |form|
+  refute_valid form
+
+  assert_errors_includes form, :email, 'invalid format'
+
+  assert_errors_includes form, :password, 'too short'
+end
+
+setup do
+  valid_params = { 'email' => 'something@example.com', 'password' => 'sosecret' }
+
+  AccountForm.new(valid_params)
+end
+
+test 'valid form' do |form|
+  assert_valid form
+end
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: preform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  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: 
+email:
+- weissst@mail.gvsu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/preform.rb
+- preform.gemspec
+- test/perform_test.rb
+homepage: https://github.com/sirscriptalot/preform
+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.11
+signing_key: 
+specification_version: 4
+summary: Preform
+test_files: []