scriba 0.0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a528ea559e6201610d1acf1c5089f8bd283aa0e
+  data.tar.gz: 292212ef584125ff89a62ad102b6234ec1662d2c
+SHA512:
+  metadata.gz: 91d0bdad1416952999202d06d0473f04c2f89cb426c7c3bc5a54f6c31aed2130bf2c2ae21faa0649fa7c7a418b9531251f3d30c4e6e7a5c9f485856e9fba4e5b
+  data.tar.gz: b6556347da194c438ce0077533c6bf2289c33aa5cc5b4ec7c942f897c37ec820af5e1f917e43b1afe323fc573ba2208b20d56ad2b14350b74cf96bc87eca164c

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2015 Michel Martens
+Copyright (c) 2011-2015 Francesco Rodríguez
+
+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,2 @@
+scriba
+======

data/lib/scriba/assertions.rb

@@ -0,0 +1,56 @@
+module Scriba::Assertions
+  protected
+
+  EMAIL = /\A([\w\!\#$\%\&\'\*\+\-\/\=\?\^\end\|\}\~]+\.)*
+          [\w\!\#$\%\&\'\*\+\-\/\=\?\^\end\|\}\~]+@
+          ((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+
+          [a-z]{2,12})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)\z/ix
+
+  def assert_email(att, message = :not_email)
+    assert_format(att, EMAIL, message: message)
+  end
+
+  def assert_equal(att, value, message = :not_equal)
+    assert(value === send(att), att, message: message)
+  end
+
+  def assert_format(att, format, message = :not_valid)
+    assert(format === send(att).to_s, att, message: message)
+  end
+
+  def assert_length(att, length, message = :wrong_length)
+    assert(send(att).to_s.length == length, att, message: message, length: length)
+  end
+
+  def assert_maximum_length(att, length, message = :too_long)
+    assert(send(att).to_s.length <= length, att, message: message, length: length)
+  end
+
+  def assert_minimum_length(att, length, message = :too_short)
+    assert(send(att).to_s.length >= length, att, message: message, length: length)
+  end
+
+  BLANK = /\A[[:space:]]*\z/
+
+  def assert_present(att, message = :not_present)
+    assert(!(BLANK === send(att).to_s), att, message: message)
+  end
+
+  URL = /\A(http|https):\/\/([a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,12}|(2
+          5[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}
+          |localhost)(:[0-9]{1,5})?(\/.*)?\z/ix
+
+  def assert_url(att, message = :not_url)
+    assert_format(att, URL, message: message)
+  end
+
+  private
+
+  def assert(value, att, options = {})
+    value or add_error(att, options) && false
+  end
+
+  def add_error(att, options)
+    @errors[att] << generate_message(options)
+  end
+end

data/lib/scriba/messages.rb

@@ -0,0 +1,25 @@
+module Scriba::Messages
+  DEFAULTS = {
+    not_email: "must be a valid email",
+    not_equal: "doesn't match",
+    not_present: "is required",
+    not_unique: "is already taken",
+    not_url: "is an invalid URL",
+    not_valid: "is invalid",
+    too_long: "must be maximum %{length} characters",
+    too_short: "must be minimum %{length} characters",
+    wrong_length: "must be %{length} characters"
+  }
+
+  private
+
+  def generate_message(options)
+    message = options.delete(:message) || :not_valid
+
+    if message.is_a?(Symbol)
+      return sprintf(DEFAULTS[message], options)
+    else
+      return message
+    end
+  end
+end

data/lib/scriba.rb

@@ -0,0 +1,57 @@
+class Scriba
+  require_relative "scriba/assertions"
+  require_relative "scriba/messages"
+
+  include Scriba::Assertions
+  include Scriba::Messages
+
+  def self.inherited(subclass)
+    subclass.attribute(*attributes)
+  end
+
+  def self.attribute(*atts)
+    attributes.replace(attributes | atts)
+    attr_accessor(*atts)
+  end
+
+  def self.attributes
+    @attributes ||= []
+  end
+
+  attr :errors
+
+  def initialize(atts = {})
+    atts.each do |att, value|
+      accessor = "#{att}="
+
+      if respond_to?(accessor)
+        send(accessor, value)
+      end
+    end
+
+    @errors = Hash.new { |hash, key| hash[key] = [] }
+  end
+
+  def attributes
+    return slice(*self.class.attributes)
+  end
+
+  def slice(*atts)
+    return atts.each_with_object({}) { |att, hash| hash[att] = send(att) }
+  end
+
+  def valid?
+    @errors.clear
+
+    validate
+
+    return @errors.empty?
+  end
+
+  def invalid?
+    return !valid?
+  end
+
+  def validate
+  end
+end

data/makefile

@@ -0,0 +1,7 @@
+.PHONY: test
+
+gem:
+	gem build *.gemspec
+
+test:
+	cutest test/*.rb

data/scriba.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = "scriba"
+  s.version     = "0.0.1.alpha1"
+  s.summary     = "Validation frontend for models."
+  s.description = s.summary + " Inspired by the scrivener gem."
+  s.authors     = ["Francesco Rodríguez"]
+  s.email       = ["frodsan@me.com"]
+  s.homepage    = "https://github.com/harmoni/scriba"
+  s.license     = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest", "~> 1.2"
+end

data/test/assertions.rb

@@ -0,0 +1,162 @@
+require_relative "helper"
+
+test "email assertion" do
+  class A < Scriba
+    attribute :email
+
+    def validate
+      assert_email :email
+    end
+  end
+
+  filter = A.new(email: "wrong@email")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:email)
+
+  filter.email = "me@me.com"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "equal assertion" do
+  class A < Scriba
+    attribute :password
+    attribute :password_confirmation
+
+    def validate
+      assert_equal :password, password_confirmation
+    end
+  end
+
+  filter = A.new(password: "123", password_confirmation: "1234")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:password)
+
+  filter.password_confirmation = "123"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "format assertion" do
+  class A < Scriba
+    attribute :name
+
+    def validate
+      assert_format :name, /\A[a-zA-Z\d\s]*\z/
+    end
+  end
+
+  filter = A.new(name: "wr/ngname")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:name)
+
+  filter.name = "mememe"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "exact length assertion" do
+  class A < Scriba
+    attribute :id
+
+    def validate
+      assert_length :id, 8
+    end
+  end
+
+  filter = A.new(id: "")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:id)
+
+  filter.id = "12345678"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "maximum length assertion" do
+  class A < Scriba
+    attribute :name
+
+    def validate
+      assert_maximum_length :name, 1
+    end
+  end
+
+  filter = A.new(name: "12")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:name)
+
+  filter.name = "1"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "minimum length assertion" do
+  class A < Scriba
+    attribute :name
+
+    def validate
+      assert_minimum_length :name, 1
+    end
+  end
+
+  filter = A.new(name: "")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:name)
+
+  filter.name = "mememe"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "presence assertion" do
+  class A < Scriba
+    attribute :name
+
+    def validate
+      assert_present :name
+    end
+  end
+
+  filter = A.new(name: " \r \t \n ")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:name)
+
+  filter.name = "mememe"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end
+
+test "url assertion" do
+  class A < Scriba
+    attribute :url
+
+    def validate
+      assert_url :url
+    end
+  end
+
+  filter = A.new(url: "masds.@me.com")
+
+  assert !filter.valid?
+  assert filter.errors.key?(:url)
+
+  filter.url = "http://harmoni.io"
+
+  assert filter.valid?
+  assert filter.errors.empty?
+end

data/test/attributes.rb

@@ -0,0 +1,37 @@
+require_relative "helper"
+
+class Signup < Scriba
+  attribute :username
+  attribute :password
+end
+
+test "return defined attributes" do
+  attrs = { username: "me", password: "100%sexy" }
+  signup = Signup.new(attrs)
+
+  assert_equal attrs, signup.attributes
+end
+
+test "ignore extra fields" do
+  signup = Signup.new(username: "me", not_exists: 1)
+
+  assert signup.attributes.key?(:username)
+  assert !signup.attributes.key?(:not_exists)
+end
+
+test "filter required attributes" do
+  signup = Signup.new(username: "me", password: "123456")
+  attrs = signup.slice(:username)
+
+  assert [:username] == attrs.keys
+end
+
+test "attributes are inheritable" do
+  class SpecialSignup < Signup
+    attribute :referral
+  end
+
+  attrs = Signup.attributes + [:referral]
+
+  assert_equal attrs, SpecialSignup.attributes
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/scriba"

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: scriba
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha1
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-30 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: Validation frontend for models. Inspired by the scrivener gem.
+email:
+- frodsan@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- LICENSE
+- README.md
+- lib/scriba.rb
+- lib/scriba/assertions.rb
+- lib/scriba/messages.rb
+- makefile
+- scriba.gemspec
+- test/assertions.rb
+- test/attributes.rb
+- test/helper.rb
+homepage: https://github.com/harmoni/scriba
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Validation frontend for models.
+test_files: []