scrivener 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1646faeced5318ac81a17b7fc8d05b59508b0d9
+  data.tar.gz: 80b3fa99edfe7c6e079bafa33fe3e90870701d5d
+SHA512:
+  metadata.gz: 207456238ab18834fa1ab9834610e19a20def26196fac1780edaee47ed6046d2581cbae5c0a07e58877c4a30b85e5a3a347b21406b0a910900ae19488c5e1ea7
+  data.tar.gz: 5a8fe4ca21cd06578fa4287324f44ce58420ac8c9f7d87f1dccd34e0df3348eb7c2c10aa176a2ec6dd52cce3649a68af8dc1afdc152f789af22f1b4d2caecb27

data/README.md

@@ -23,7 +23,7 @@ and its features are a subset of Bureaucrat's. For a more robust and tested
 solution, please [check it](https://github.com/tizoc/bureaucrat).
 
 This library exists to satify the need of extracting Ohm's validations for
-reuse in other scenarios. By doing this, all projects using Ohm::Validations
+reuse in other scenarios. By doing this, all projects using `Ohm::Validations`
 will be able to profit from extra assertions such as those provided by
 [ohm-contrib](https://github.com/cyx/ohm-contrib).
 
@@ -32,35 +32,35 @@ Usage
 
 Using Scrivener feels very natural no matter what underlying model you are
 using. As it provides its own validation and whitelisting features, you can
-chose to ignore the ones that come bundled with ORMs.
+choose to ignore the ones that come bundled with ORMs.
 
 This short example illustrates how to move the validation and whitelisting
 responsibilities away from the model and into Scrivener:
 
 ```ruby
-    # We use Sequel::Model in this example, but it applies to other ORMs such
-    # as Ohm or ActiveRecord.
-    class Article < Sequel::Model
-
-      # Whitelist for mass assigned attributes.
-      set_allowed_columns :title, :body, :state
-
-      # Validations for all contexts.
-      def validate
-        validates_presence :title
-        validates_presence :body
-        validates_presence :state
-      end
-    end
+# We use Sequel::Model in this example, but it applies to other ORMs such
+# as Ohm or ActiveRecord.
+class Article < Sequel::Model
+
+  # Whitelist for mass assigned attributes.
+  set_allowed_columns :title, :body, :state
+
+  # Validations for all contexts.
+  def validate
+    validates_presence :title
+    validates_presence :body
+    validates_presence :state
+  end
+end
 
-    title = "Bartleby, the Scrivener"
-    body  = "I am a rather elderly man..."
+title = "Bartleby, the Scrivener"
+body  = "I am a rather elderly man..."
 
-    # When using the model...
-    article = Article.new(title: title, body: body)
+# When using the model...
+article = Article.new(title: title, body: body)
 
-    article.valid?            #=> false
-    article.errors.on(:state) #=> ["cannot be empty"]
+article.valid?            #=> false
+article.errors.on(:state) #=> ["cannot be empty"]
 ```
 
 Of course, what you would do instead is declare `:title` and `:body` as allowed
@@ -72,55 +72,94 @@ feature and in others is a minor obstacle.
 Now see what happens with Scrivener:
 
 ```ruby
-    # Now the model has no validations or whitelists. It may still have schema
-    # constraints, which is a good practice to enforce data integrity.
-    class Article < Sequel::Model
-    end
+# Now the model has no validations or whitelists. It may still have schema
+# constraints, which is a good practice to enforce data integrity.
+class Article < Sequel::Model
+end
+
+# The attribute accessors are the only fields that will be set. If more
+# fields are sent when using mass assignment, a NoMethodError exception is
+# raised.
+#
+# Note how in this example we don't accept the status attribute.
+class Edit < Scrivener
+  attr_accessor :title
+  attr_accessor :body
+
+  def validate
+    assert_present :title
+    assert_present :body
+  end
+end
+
+edit = Edit.new(title: title, body: body)
+edit.valid?               #=> true
+
+article = Article.new(edit.attributes)
+article.save
+
+# And now we only ask for the status.
+class Publish < Scrivener
+  attr_accessor :status
+
+  def validate
+    assert_format :status, /^(published|draft)$/
+  end
+end
+
+publish = Publish.new(status: "published")
+publish.valid?            #=> true
+
+article.update_attributes(publish.attributes)
+
+# If we try to change other fields...
+publish = Publish.new(status: "published", title: "foo")
+#=> NoMethodError: undefined method `title=' for #<Publish...>
+```
 
-    # The attribute accessors are the only fields that will be set. If more
-    # fields are sent when using mass assignment, a NoMethodError exception is
-    # raised.
-    #
-    # Note how in this example we don't ask the name on signup.
-    class Edit < Scrivener
-      attr_accessor :title
-      attr_accessor :body
-
-      def validate
-        assert_present :title
-        assert_present :body
-      end
-    end
+It's important to note that using Scrivener implies a greater risk than using
+the model validations. Having a central repository of mass assignable
+attributes and validations is more secure in most scenarios.
+
+Slices
+------
 
-    edit = Edit.new(title: title, body: body)
-    edit.valid?               #=> true
+If you don't need all the attributes after the filtering is done,
+you can fetch just the ones you need. For example:
 
-    article = Article.new(edit.attributes)
-    article.save
+```ruby
+class SignUp < Scrivener
+  attr_accessor :email
+  attr_accessor :password
+  attr_accessor :password_confirmation
 
-    # And now we only ask for the status.
-    class Publish < Scrivener
-      attr_accessor :status
+  def validate
+    assert_email :email
 
-      def validate
-        assert_format :status, /^(published|draft)$/
-      end
+    if assert_present :password
+      assert_equal :password, :password_confirmation
     end
+  end
 
-    publish = Publish.new(status: "published")
-    publish.valid?            #=> true
+  def assert_equal(f1, f2)
+    assert send(f1) == send(f2), [f1, f2, :not_equal]
+  end
+end
 
-    article.update_attributes(publish.attributes)
+filter = SignUp.new(email: "info@example.com",
+                    password: "monkey",
+                    password_confirmation: "monkey")
 
-    # If we try to change other fields...
-    publish = Publish.new(status: "published", title: "foo")
-    #=> NoMethodError: undefined method `title=' for #<Publish...>
-```
 
-It's important to note that using Scrivener implies a greater risk than using
-the model validations. Having a central repository of mass assignable
-attributes and validations is more secure in most scenarios.
+# If the validation succeeds, we only need email and password to
+# create a new user, and we can discard the password_confirmation.
+if filter.valid?
+  User.create(filter.slice(:email, :password))
+end
+```
 
+By calling `slice` with a list of attributes, you get a hash with only
+those key/value pairs.
 
 Assertions
 -----------
@@ -135,9 +174,9 @@ second parameter to the list of errors if the first parameter evaluates
 to false.
 
 ``` ruby
-    def assert(value, error)
-       value or errors[error.first].push(error.last) && false
-    end
+def assert(value, error)
+   value or errors[error.first].push(error.last) && false
+end
 ```
 
 ### assert_present
@@ -174,9 +213,9 @@ Checks that a given field is contained within a set of values (i.e.
 like an `ENUM`).
 
 ``` ruby
-    def validate
-      assert_member :state, %w{pending paid delivered}
-    end
+def validate
+  assert_member :state, %w{pending paid delivered}
+end
 ```
 
 The error code for this assertion is `:not_valid`
@@ -186,9 +225,9 @@ The error code for this assertion is `:not_valid`
 Checks that a given field's length falls under a specified range.
 
 ``` ruby
-    def validate
-      assert_length :username, 3..20
-    end
+def validate
+  assert_length :username, 3..20
+end
 ```
 
 The error code for this assertion is `:not_in_range`.
@@ -200,7 +239,6 @@ of the word. Valid numbers are: 0.1, .1, 1, 1.1, 3.14159, etc.
 
 The error code for this assertion is `:not_decimal`.
 
-
 Installation
 ------------
 

data/lib/scrivener.rb

@@ -1,16 +1,13 @@
-require File.expand_path("scrivener/validations", File.dirname(__FILE__))
+require_relative "scrivener/validations"
 
 class Scrivener
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 
   include Validations
 
   # Initialize with a hash of attributes and values.
   # If extra attributes are sent, a NoMethodError exception will be raised.
   #
-  # The grand daddy of all assertions. If you want to build custom
-  # assertions, or even quick and dirty ones, you can simply use this method.
-  #
   # @example
   #
   #   class EditPost < Scrivener
@@ -37,8 +34,8 @@ class Scrivener
   #   # Now it's safe to initialize the model.
   #   post = Post.new(edit.attributes)
   #   post.save
-  def initialize(attrs)
-    attrs.each do |key, val|
+  def initialize(atts)
+    atts.each do |key, val|
       send(:"#{key}=", val)
     end
   end
@@ -54,5 +51,12 @@ class Scrivener
       end
     end
   end
-end
 
+  def slice(*keys)
+    Hash.new.tap do |atts|
+      keys.each do |att|
+        atts[att] = send(att)
+      end
+    end
+  end
+end

data/test/scrivener_test.rb

@@ -27,6 +27,14 @@ scope do
 
     assert_equal atts, s.attributes
   end
+
+  test "return only the required attributes" do
+    atts = { :a => 1, :b => 2 }
+
+    s = S.new(atts)
+
+    assert_equal s.slice(:a), { :a => 1 }
+  end
 end
 
 class T < Scrivener
@@ -190,4 +198,4 @@ scope do
       assert p.valid?
     end
   end
-end
+end

metadata

@@ -1,27 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: scrivener
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-24 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2156191960 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156191960
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Scrivener removes the validation responsibility from models and acts
   as a filter for whitelisted attributes.
 email:
@@ -40,26 +42,25 @@ files:
 - test/scrivener_test.rb
 homepage: http://github.com/soveran/scrivener
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Validation frontend for models.
 test_files: []