robert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0ca595b26c5a3f3e3b633cb9bee8bade4944d5c
+  data.tar.gz: e84ab645d934bb08b3acd16e4ca977b600faf29d
+SHA512:
+  metadata.gz: 5318c53a44551c098e1b9ed069192a089f52a41af039b0e2d252c91d9a37854e00ecb00ffd0186b7a64da3af056c4e842b357d9bd1370b5ea5074ebe7b7bf3ac
+  data.tar.gz: b289fcee70b6410a98dd690d8c002f6097cd266b0041ff90acfade14a9c1b8e70236ecbb4b45dea5251590b0a1c473059d92f4e44491f7f4515ba57e8a0ca160

data/.gitignore

@@ -0,0 +1 @@
+.gs/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'cutest', '~> 1.2'
+end

data/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    clap (1.0.0)
+    cutest (1.2.3)
+      clap
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cutest (~> 1.2)
+
+BUNDLED WITH
+   1.15.4

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,91 @@
+# Robert
+
+Robert is an implementation of the builder pattern that first runs the given
+arguments through a validation process.
+
+## Installation
+
+`gem install robert`
+
+## Usage
+
+Robert is helpful in creating form objects (validating Rack params),
+implementing business logic (service objects, if you will) and much more.
+Basically if you do not trust the data, run it through Robert.
+
+```ruby
+  class Post
+    attr_accessor :title, :body
+
+    def initialize(attributes)
+      attributes.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    end
+  end
+
+  class PostBuilder < Robert
+    attr_accessor :title, :body
+
+    private
+
+    def validate
+      error :title, :is_empty { empty? }
+      error :body,  :is_empty { empty? }
+    end
+  end
+
+  builder = PostBuilder.new(title: 'Title', body: '')
+
+  result = builder.build(Post)
+
+  result # false
+
+  builder.errors # { body: [:is_empty] }
+
+  builder.body = 'body'
+
+  result = builder.build(Post)
+
+  result.is_a?(Post) # true
+```
+
+Check out the tests for more examples.
+
+## API
+
+`::build` - Convenience for `::new(params).build(klass)`
+
+`::build!` - Convenience for `::new(params).build!(klass)`
+
+`#attributes` - Hash of attributes that have been validated (successfully) and "cleaned".
+
+`#errors` - Hash of errors.
+
+`#build` - Initializes the given class if valid or returns false.
+
+`#build!` - Initializes the given class if valid or raises.
+
+`#clean` - Template method for cleaning values before assigning them the attributes hash.
+
+`#error` - Bread and butter of the library. For a given attribute, adds error if the given block returns false. The block is evaluated in context of the attribute itself.
+
+`#validate` - Template method for implementing your validation logic.
+
+`#valid?` - Checks to see if the builder is valid.
+
+### Gotchas
+
+Sending `#errors` before `#valid?` will return the default errors
+(an empty Hash by default), which will give the appearance of a valid object.
+The reason for this is that if you have an html view and are rendering
+a form/builder's errors, you don't want to `#errors` to trigger validation
+on the initial page load.
+
+## Prior Art
+
+Robert is inspired by the following libraries:
+
+* [Scrivener](https://github.com/soveran/scrivener)
+* [Hatch](https://github.com/tonchis/hatch)
+* [Django's Forms](https://www.djangoproject.com)

data/Rakefile

@@ -0,0 +1,20 @@
+desc 'open irb in gs context'
+task :console do
+  sh './bin/gs irb -r ./app.rb'
+end
+
+task :default do
+  sh 'rake -T'
+end
+
+desc 'installs gems'
+task :install do
+  sh 'mkdir -p .gs & ./bin/gs bundle install --system'
+end
+
+desc 'tests the given [test]_test.rb'
+task :test, :name do |t, args|
+  name = args[:name] || "*"
+
+  sh "./bin/gs cutest -r ./lib/robert ./test/#{name}_test.rb"
+end

data/bin/gs

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2012 Michel Martens
+#
+# 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.
+#
+# https://github.com/soveran/gs
+
+help = <<EOS
+GS(1)
+
+NAME
+      gs -- Gemset management
+
+SYNOPSIS
+      gs init
+      gs help
+      gs [command]
+
+DESCRIPTION
+      When called with no arguments, it starts a shell session and
+      configures the variables GEM_HOME, GEM_PATH and PATH to point
+      to the $PWD/.gs directory. In addition, it sets the GS_NAME
+      variable with the name of the current gemset (useful for PS1).
+
+      init
+          Creates the $PWD/.gs directory.
+
+      help
+          Displays this message.
+
+      [command]
+          An optional command that will be executed under gs shell
+          session and return to the caller session once finished.
+EOS
+
+case ARGV[0]
+when "init" then Dir.mkdir(".gs"); exec($0)
+when "help" then puts help
+else
+  if File.directory?(".gs")
+    pwd = Dir.pwd
+    env = ENV.to_hash
+    env["GS_NAME"]  = File.basename(pwd)
+    env["GEM_HOME"] = pwd + "/.gs"
+    env["GEM_PATH"] = pwd + "/.gs:#{`gem env path`.strip}"
+    env["PATH"]     = pwd + "/.gs/bin:#{ENV['PATH']}"
+
+    if ARGV.length > 0
+      exec env, *ARGV
+    else
+      exec env, ENV["SHELL"] || ENV["COMSPEC"]
+    end
+  else
+    puts "Directory .gs not found. Try `gs help`."
+    exit 1
+  end
+end

data/lib/robert.rb

@@ -0,0 +1,92 @@
+class Robert
+  VERSION = '0.1.0'
+
+  class ValidationError < StandardError; end
+
+  class << self
+    def build(klass, args = {})
+      new(args).build(klass)
+    end
+
+    def build!(klass, args = {})
+      new(args).build!(klass)
+    end
+  end
+
+  attr_reader :attributes, :errors
+
+  def initialize(args = {})
+    args.each do |key, value|
+      writer = :"#{key}="
+
+      if respond_to?(writer)
+        send(writer, value)
+      end
+    end
+
+    reset
+  end
+
+  def default_attributes
+    {}
+  end
+
+  def default_errors
+    Hash.new { |h, k| h[k] = [] }
+  end
+
+  def build(klass)
+    valid? && klass.new(attributes)
+  end
+
+  def build!(klass)
+    build(klass) || raise(ValidationError, errors)
+  end
+
+  def valid?
+    reset
+
+    validate
+
+    errors.empty?
+  end
+
+  private
+
+  def add_attribute(key, value)
+    attributes[key] = clean(value) unless errors.has_key?(key)
+  end
+
+  def add_error(key, error)
+    attributes.delete(key)
+
+    errors[key] << error
+  end
+
+  def clean(value)
+    value
+  end
+
+  def error(key, error, &condition)
+    value = send(key)
+
+    if value.instance_eval &condition
+      add_error(key, error)
+
+      true
+    else
+      add_attribute(key, value)
+
+      false
+    end
+  end
+
+  def reset
+    @attributes = default_attributes
+    @errors = default_errors
+  end
+
+  def validate
+    raise NotImplementedError
+  end
+end

data/robert.gemspec

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

data/test/robert_test.rb

@@ -0,0 +1,160 @@
+class Email
+  LENGTH = 5..255
+
+  attr_reader :email
+
+  def initialize(email)
+    @email = email
+  end
+
+  def length
+    email.length
+  end
+
+  def too_short?
+    length < LENGTH.min
+  end
+
+  def too_long?
+    length > LENGTH.max
+  end
+
+  def to_s
+    email.to_s
+  end
+end
+
+class User
+  attr_accessor :email
+
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      send(:"#{key}=", value)
+    end
+  end
+end
+
+class UserBuilder < Robert
+  attr_writer :email
+
+  def email
+    Email.new(@email.to_s)
+  end
+
+  private
+
+  def clean(value)
+    value.to_s
+  end
+
+  def validate
+    error :email, :too_short { too_short? } or
+    error :email, :too_long { too_long? }
+  end
+end
+
+test '::build builds object when valid' do
+  params = { email: 'valid@example.com' }
+
+  assert UserBuilder.build(User, params).is_a?(User)
+end
+
+test '::build returns false when invalid' do
+  params = { email: '' }
+
+  assert !UserBuilder.build(User, params)
+end
+
+test '::build! builds object when valid' do
+  params = { email: 'valid@example.com' }
+
+  assert UserBuilder.build!(User, params).is_a?(User)
+end
+
+test '::build! raises when invalid' do
+  params = { email: '' }
+
+  assert_raise Robert::ValidationError do
+    UserBuilder.build!(User, params)
+  end
+end
+
+test '#build builds object when valid' do
+  params = { email: 'valid@example.com' }
+
+  builder = UserBuilder.new(params)
+
+  assert builder.build(User).is_a?(User)
+end
+
+test '#build returns false when invalid' do
+  params = { email: '' }
+
+  builder = UserBuilder.new(params)
+
+  assert !builder.build(User)
+end
+
+test '#build! builds object when valid' do
+  params = { email: 'valid@example.com' }
+
+  builder = UserBuilder.new(params)
+
+  assert builder.build!(User).is_a?(User)
+end
+
+test '#build! raises when invalid' do
+  params = { email: '' }
+
+  builder = UserBuilder.new(params)
+
+  assert_raise Robert::ValidationError do
+    builder.build!(User)
+  end
+end
+
+test '#valid? captures valid attributes' do
+  params = { email: 'valid@example.com' }
+
+  builder = UserBuilder.new(params)
+
+  assert !builder.attributes.include?(:email)
+
+  assert builder.valid?
+
+  assert builder.attributes.include?(:email)
+
+  builder.email = ''
+
+  assert !builder.valid?
+
+  assert !builder.attributes.include?(:email)
+end
+
+test '#valid? captured attributes are cleaned' do
+  params = { email: 'valid@example.com' }
+
+  builder = UserBuilder.new(params)
+
+  assert builder.valid?
+
+  assert builder.attributes.include?(:email)
+
+  assert builder.attributes[:email].is_a?(String)
+
+  assert !builder.attributes[:email].is_a?(Email)
+end
+
+test '#valid? adds errors for conditions' do
+  params = { email: '' }
+
+  builder = UserBuilder.new(params)
+
+  assert !builder.errors.has_key?(:email)
+
+  assert !builder.valid?
+
+  assert builder.errors.has_key?(:email)
+
+  assert builder.errors[:email].include?(:too_short)
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: robert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- weissst@mail.gvsu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/gs
+- lib/robert.rb
+- robert.gemspec
+- test/robert_test.rb
+homepage: https://github.com/sirscriptalot/robert
+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: Robert
+test_files: []