scrivener-contrib 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9909e7ad08610ce637d73a6e7042ed1c78f3f520
-  data.tar.gz: b70b640e41ae7dcf0ba642d827314328242eca79
+  metadata.gz: 4a16cd30105eac68800e11f51f739224b01d54a3
+  data.tar.gz: d099f993fa188551d24a58a23969022adf4d4a73
 SHA512:
-  metadata.gz: 0df8f451f9f037e8be147685fd321bad834ffe953f0f3c705574db80815ef666f7e473c57fc9b0bab699e28fbbb275bca70d6cdd229577a52032698b59d37124
-  data.tar.gz: ac08a267c75050c979b435369339855b79c3553c774613868aae654cfa4d01910e7ba9f6c08d4bdc05a26815180e231937bb6b75645ca8e0c9d251431711b933
+  metadata.gz: e88abacc21018fc224976f7a01788fdf73acfd8bd257e98e5da914d3784abf4f061d1257190f934f736257165acc6ba552e12189abbd738f1a6a98dfb0ca0ee0
+  data.tar.gz: e203513b47c9f2673abaf2741e8271c818c19dbdbf1fc03fb0c817930a6a38d80b9df27ab2738acd3ba8e376447b2922aa4ed73412ea648106f0502167076e60

data/.gems

@@ -1,3 +1,5 @@
-cutest -v 1.2.1
-ohm -v 2.0.1
-scrivener -v 0.2.0
+cutest -v 1.2.2
+ohm -v 2.2.0
+scrivener -v 0.4.0
+sequel -v 4.20.0
+sqlite3 -v 1.3.10

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Francesco Rodríguez, Mayn Kjær
+Copyright (c) 2014-Present Harmoni LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 scrivener-contrib
 =================
 
-Extra validations for Scrivener
+Extra validations for Scrivener.
 
 Usage
 -----
@@ -9,10 +9,11 @@ Usage
 The extra validations are:
 
 ```ruby
-assert_confirmation(:password)
-assert_minimum_length(:password, 6)
-assert_maximum_length(:name, 50)
-assert_exact_length(:idnum, 8)
+assert_confirmation(:attribute)
+assert_minimum_length(:attribute, integer)
+assert_maximum_length(:attribute, integer)
+assert_exact_length(:attribute, integer)
+assert_unique(:attribute, :Model)
 ```
 
 This is a basic example:
@@ -20,8 +21,9 @@ This is a basic example:
 ```ruby
 require "scrivener"
 require "scrivener/contrib"
+require "scrivener/ohm" # or require "scrivener/sequel"
 
-class Signup < Scrivener
+class SignUp < Scrivener
   attr_accessor :username
   attr_accessor :name
   attr_accessor :idnum
@@ -36,8 +38,33 @@ class Signup < Scrivener
 
     assert_maximum_length(:name, 50)
     assert_exact_length(:idnum, 8)
+
+    if assert_present(:username)
+      assert_unique(:username, :User)
+    end
   end
 end
+
+signup = SignUp.new(
+  username: "repeated",
+  password: "123",
+  name: _very_long_name
+)
+
+signup.valid?
+# => false
+
+signup.errors[:password]
+# => [:not_confirmed, :too_short]
+
+signup.errors[:username]
+# => [:not_unique]
+
+signup.errors[:name]
+# => [:too_long]
+
+signup.errors[:idnum]
+# => [:wrong_length]
 ```
 
 Installation

data/lib/scrivener/contrib.rb

@@ -1,21 +1,80 @@
-require_relative "ohm" if defined?(Ohm)
-
 class Scrivener
   module Validations
-    def assert_confirmation(att, error = [att, :not_confirmed])
-      assert(send(:"#{att}_confirmation") == send(att), error)
-    end
-
+    # Validates that minimum size of the specified attribute.
+    #
+    #   class SignUp < Scrivener
+    #     attr_accessor :password
+    #
+    #     def validate
+    #       assert_minimum_length(:password, 8)
+    #     end
+    #   end
+    #
+    #   signup = Signup.new(password: "short")
+    #   signup.valid? # => false
+    #   signup.errors[:password] # => [:too_short]
+    #
     def assert_minimum_length(att, val, error = [att, :too_short])
       assert(send(att).to_s.length >= val, error)
     end
 
+    # Validates that maximum size of the specified attribute.
+    #
+    #   class SignUp < Scrivener
+    #     attr_accessor :password
+    #
+    #     def validate
+    #       assert_minimum_length(:password, 72)
+    #     end
+    #   end
+    #
+    #   signup = Signup.new(password: _very_long_password)
+    #   signup.valid? # => false
+    #   signup.errors[:password] # => [:too_long]
+    #
     def assert_maximum_length(att, val, error = [att, :too_long])
       assert(send(att).to_s.length <= val, error)
     end
 
+    # Validates that the specified attribute matches exactly the
+    # length restriction supplied.
+    #
+    #   class SignUp < Scrivener
+    #     attr_accessor :status
+    #
+    #     def validate
+    #       assert_exact_length(:status, 1)
+    #     end
+    #   end
+    #
+    #   signup = Signup.new(status: "10")
+    #   signup.valid? # => false
+    #   signup.errors[:status] # => [:wrong_length]
+    #
     def assert_exact_length(att, val, error = [att, :wrong_length])
       assert(send(att).to_s.length == val, error)
     end
+
+    # Encapsulates the pattern of wanting to validate a password or
+    # email address field with a confirmation.
+    #
+    #   class SignUp < Scrivener
+    #     attr_accessor :password, :password_confirmation
+    #
+    #     def validate
+    #       assert_present(:password)
+    #       assert_confirmation(:password)
+    #     end
+    #   end
+    #
+    #   signup = SignUp.new
+    #   signup.password = "123456"
+    #   signup.password_confirmation = "nonsense"
+    #   signup.valid? # => false
+    #   signup.errors[:password] # => [:not_confirmed]
+    #
+    def assert_confirmation(att, error = [att, :not_confirmed])
+      assert(send(:"#{att}_confirmation") == send(att), error)
+    end
   end
 end

data/lib/scrivener/ohm.rb

@@ -1,20 +1,33 @@
+require_relative "utils"
+
 class Scrivener
   module Validations
+    # Validates that an attribute is unique.
+    #
+    #   class User < Ohm::Model
+    #     attribute :email
+    #
+    #     unique :email
+    #   end
+    #
+    #   class SignUp < Scrivener
+    #     attr_accessor :email
+    #
+    #     def validate
+    #       assert_unique(:email, :User)
+    #     end
+    #   end
+    #
+    #   user = User.create(email: "mayn.kjaer@gmail.com")
+    #   signup = SignUp.new(email: user.email)
+    #   signup.valid? # => false
+    #   signup.errors[:email] # => [:not_unique]
+    #
     def assert_unique(att, model, error = [att, :not_unique])
-      model  = Utils.const(self.class, model)
+      model = Utils.const(self.class, model)
       record = model.with(att, send(att))
 
       assert(record.nil?, error)
     end
-
-    module Utils # :nodoc:
-      def self.const(context, name)
-        case name
-        when Symbol, String
-          context.const_get(name)
-        else name
-        end
-      end
-    end
   end
 end

data/lib/scrivener/sequel.rb

@@ -0,0 +1,30 @@
+require_relative "utils"
+
+class Scrivener
+  module Validations
+    # Validates that an attribute is unique.
+    #
+    #   class User < Sequel::Model
+    #   end
+    #
+    #   class SignUp < Scrivener
+    #     attr_accessor :email
+    #
+    #     def validate
+    #       assert_unique(:email, :User)
+    #     end
+    #   end
+    #
+    #   user = User.create(email: "frodsan@me.com")
+    #   signup = SignUp.new(email: user.email)
+    #   signup.valid? # => false
+    #   signup.errors[:email] # => [:not_unique]
+    #
+    def assert_unique(att, model, error = [att, :not_unique])
+      model = Utils.const(self.class, model)
+      record = model[att => send(att)]
+
+      assert(record.nil?, error)
+    end
+  end
+end

data/lib/scrivener/utils.rb

@@ -0,0 +1,13 @@
+class Scrivener
+  module Validations
+    module Utils # :nodoc:
+      def self.const(context, name)
+        case name
+        when Symbol, String
+          context.const_get(name)
+        else name
+        end
+      end
+    end
+  end
+end

data/makefile

@@ -1,4 +1,8 @@
+.DEFAULT_GOAL := test
 .PHONY: test
 
+gem:
+	gem build *.gemspec
+
 test:
 	cutest test/*.rb

data/scrivener-contrib.gemspec

@@ -1,14 +1,19 @@
 Gem::Specification.new do |s|
   s.name = "scrivener-contrib"
-  s.version = "1.0.0"
-  s.summary = "Extra validation helpers for Scrivener."
+  s.version = "1.1.0"
+  s.summary = "Extra validations for Scrivener."
   s.description = s.summary
   s.authors = ["Francesco Rodríguez", "Mayn Kjær"]
   s.email = ["frodsan@me.com", "mayn.kjaer@gmail.com"]
-  s.homepage = "https://github.com/harmoni-io/scrivener-contrib"
+  s.homepage = "https://github.com/harmoni/scrivener-contrib"
   s.license = "MIT"
 
   s.files = `git ls-files`.split("\n")
 
+  s.add_dependency "scrivener"
+
   s.add_development_dependency "cutest"
+  s.add_development_dependency "ohm"
+  s.add_development_dependency "sequel"
+  s.add_development_dependency "sqlite3"
 end

data/test/ohm.rb

@@ -1,5 +1,6 @@
 require "ohm"
 require_relative "helper"
+require_relative "../lib/scrivener/ohm"
 
 Ohm.redis = Redic.new("redis://localhost:6379")
 Ohm.redis.call("SELECT", "30")
@@ -22,7 +23,7 @@ prepare do
 end
 
 test "invalid if attribute is already taken" do
-  user   = User.create(email: "aquiles@me.com")
+  user = User.create(email: "aquiles@me.com")
   signup = Signup.new(email: user.email)
 
   assert !(signup.valid?)

data/test/sequel.rb

@@ -0,0 +1,39 @@
+require "sequel"
+require_relative "helper"
+require_relative "../lib/scrivener/sequel"
+
+DB = Sequel.sqlite
+
+DB.create_table(:users) do
+  String :email
+end
+
+class User < Sequel::Model
+end
+
+class Signup < Scrivener
+  attr_accessor :email
+
+  def validate
+    assert_unique :email, :User
+  end
+end
+
+prepare do
+  DB[:users].truncate
+end
+
+test "invalid if attribute is already taken" do
+  user = User.create(email: "aquiles@me.com")
+  signup = Signup.new(email: user.email)
+
+  assert !(signup.valid?)
+  assert_equal [:not_unique], signup.errors[:email]
+end
+
+test "valid if attribute is not taken" do
+  signup = Signup.new(email: "aquiles@me.com")
+
+  assert signup.valid?
+  assert signup.errors.empty?
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scrivener-contrib
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Francesco Rodríguez
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: scrivener
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,49 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Extra validation helpers for Scrivener.
+- !ruby/object:Gem::Dependency
+  name: ohm
+  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: sequel
+  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: 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'
+description: Extra validations for Scrivener.
 email:
 - frodsan@me.com
 - mayn.kjaer@gmail.com
@@ -39,13 +95,16 @@ files:
 - README.md
 - lib/scrivener/contrib.rb
 - lib/scrivener/ohm.rb
+- lib/scrivener/sequel.rb
+- lib/scrivener/utils.rb
 - makefile
 - scrivener-contrib.gemspec
 - test/confirmation.rb
 - test/helper.rb
 - test/length.rb
 - test/ohm.rb
-homepage: https://github.com/harmoni-io/scrivener-contrib
+- test/sequel.rb
+homepage: https://github.com/harmoni/scrivener-contrib
 licenses:
 - MIT
 metadata: {}
@@ -65,8 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Extra validation helpers for Scrivener.
+summary: Extra validations for Scrivener.
 test_files: []