scrivener_errors 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc214a28a79f0457445e3d49ccc42d79a3cba275
+  data.tar.gz: aca56643715833b6c0a29615df33c7d8caac0d7d
+SHA512:
+  metadata.gz: 43443a3c67fe493225a1bdc93ee9a3671621d1a3eb337a973a703c3403e656374b56fc5721936e8ff23cb467eedc71acf0cfa7c3a8e341ab982cbf46ecebd82d
+  data.tar.gz: a2d94fe0bec84d0ec589a50fbbccb24685ae84754509610b73d2c7e01e2dde263f518c3c9a1253e7899ca3490ad7f64b524174b574dbc04a6d1e03defd682c40

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Brendon Murphy
+
+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,56 @@
+Scrivener Errors
+================
+
+Basic error messages for [Scrivener](https://github.com/soveran/scrivener)
+filters.
+
+Description
+-----------
+
+Scrivener errors are returned has a hash with a format like:
+
+```ruby
+{:email => [:not_email], :password => [:not_present]}
+```
+
+This can be represented instead as a string like:
+
+```
+Email is not an email, password can't be blank
+```
+
+ScrivenerErrors will present these error hashes as a string
+or list of errors message for use in failure notices or
+form errors.
+
+This also comes with a small plugin for [Cuba](http://cuba.is/)
+to get the error message easily, `ScrivenerErrors::Helpers`.
+
+Installation
+------------
+
+    $ gem install scrivener_errors
+
+Usage
+-----
+
+```ruby
+# Setup the plugin for Cuba
+Cuba.plugin ScrivenerErrors::Helpers
+
+# Inside a Cuba action
+filter = Signup.new(req.params)
+if !filter.valid?
+  session[:error] = filter_errors(filter)
+  res.redirect "/some_form"
+end
+```
+
+Notes
+-----
+
+Currently there's no I18n in use.  The error messages are
+from a small English mapped hash at the moment.
+
+An error type that is not found will be represented like
+"Password is invalid" by default.

data/Rakefile

@@ -0,0 +1,6 @@
+task :test do
+  require "cutest"
+  Cutest.run(Dir["test/*.rb"])
+end
+
+task :default => :test

data/lib/scrivener_errors.rb

@@ -0,0 +1,50 @@
+class ScrivenerErrors
+  attr_reader :scrivener
+
+  MESSAGES = {
+    :not_email    => "is not an email",
+    :not_decimal  => "is not a decimal",
+    :not_in_range => "has invalid length",
+    :not_numeric  => "is not a number",
+    :not_present  => "can't be blank",
+    :not_url      => "is not a url",
+    :too_short    => "is too short"
+  }.freeze
+
+  def initialize(scrivener)
+    @scrivener = scrivener
+    ensure_validated
+  end
+
+  def ensure_validated
+    if scrivener.errors == {}
+      scrivener.valid?
+    end
+  end
+
+  def to_s
+    messages.join(', ').capitalize
+  end
+  alias :message :to_s
+
+  def messages
+    scrivener.errors.inject([]) do |memo, error|
+      att = error[0]
+      memo.concat error[1].map {|e| error_string(att, e) }
+      memo
+    end
+  end
+
+  def error_string(att, error)
+    att = att.to_s.tr('_', ' ')
+    failure   = MESSAGES.fetch(error, 'is invalid')
+
+    [att, failure].join(' ')
+  end
+
+  module Helpers
+    def filter_errors(scrivener)
+      ScrivenerErrors.new(scrivener).to_s
+    end
+  end
+end

data/scrivener_errors.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = "scrivener_errors"
+  s.version     = "0.0.3"
+  s.summary     = "Basic error messages for Scrivener filters"
+  s.description = s.summary
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = "http://github.com/bemurphy/scrivener_errors"
+  s.license     = "MIT"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb"
+  ]
+
+  s.add_development_dependency "cutest", "~> 1.2"
+  s.add_development_dependency "scrivener", "~> 0.2"
+end

data/test/scrivener_errors_test.rb

@@ -0,0 +1,74 @@
+require_relative "../lib/scrivener_errors"
+require "scrivener"
+
+class SignUp < Scrivener
+  attr_accessor :email, :password, :password_confirmation
+
+  def validate
+    assert_email :email
+
+    if assert_present :password
+      assert_length :password, (8..99)
+      assert(password == password_confirmation,
+             [:password_confirmation, :not_confirmed])
+    end
+  end
+end
+
+scope do
+  test "error messages" do
+    filter = SignUp.new(email: 'john',
+                        password: 'password',
+                        password_confirmation: 'p4ssw3rd')
+
+    messages = ScrivenerErrors.new(filter).messages
+    assert_equal "email is not an email", messages[0]
+    assert_equal "password confirmation is invalid", messages[1]
+  end
+
+  test "multiple errors on a single attribute" do
+    filter = SignUp.new(email: 'john@example.com',
+                        password: 'x',
+                        password_confirmation: 'y')
+
+    messages = ScrivenerErrors.new(filter).messages
+    assert_equal "password has invalid length", messages[0]
+    assert_equal "password confirmation is invalid", messages[1]
+  end
+
+  test "no errors" do
+    filter = SignUp.new(email: 'john@example.com',
+                        password: 'password',
+                        password_confirmation: 'password')
+
+    messages = ScrivenerErrors.new(filter).messages
+    assert_equal [], messages
+  end
+
+  test "converting to a string" do
+    filter = SignUp.new(email: 'john',
+                        password: 'password',
+                        password_confirmation: 'y')
+
+    assert_equal(
+      "Email is not an email, password confirmation is invalid",
+      ScrivenerErrors.new(filter).message
+    )
+  end
+end
+
+scope do
+  test "filter errors to a string" do
+    object = Object.new
+    object.extend ScrivenerErrors::Helpers
+
+    filter = SignUp.new(email: 'john',
+                        password: 'password',
+                        password_confirmation: 'y')
+
+    assert_equal(
+      "Email is not an email, password confirmation is invalid",
+      object.filter_errors(filter)
+    )
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: scrivener_errors
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 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'
+- !ruby/object:Gem::Dependency
+  name: scrivener
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Basic error messages for Scrivener filters
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/scrivener_errors.rb
+- scrivener_errors.gemspec
+- test/scrivener_errors_test.rb
+homepage: http://github.com/bemurphy/scrivener_errors
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Basic error messages for Scrivener filters
+test_files: []