strip_attributes 1.1.1 → 1.2.0

data/README.md

@@ -15,7 +15,7 @@ a single attribute (`:only => :field`) or arrays of attributes (`:except =>
 Include the gem in your Gemfile:
 
 ```ruby
-gem "strip_attributes", "~> 1.0"
+gem "strip_attributes", "~> 1.2"
 ```
 
 ## Examples
@@ -59,44 +59,89 @@ class User
 end
 ```
 
-### Outside of Rails
-
-If you want to use this outside of Rails, just require
-`strip_attributes/active_model` and you models will get the `strip_attributes`
-class method.
+### Using it with [`ActiveAttr`](https://github.com/cgriego/active_attr)
 
 ```ruby
-require "strip_attributes/active_model"
-class SomeModel < ActiveRecord::Base
+class Person
+  include ActiveAttr::Model
+  include ActiveModel::Validations::Callbacks
+
+  attribute :name
+  attribute :email
+
   strip_attributes
 end
+
 ```
 
 ## Testing
 
-StripAttributes provides shoulda-compatible macros for easier testing of
-attribute assignment.
+StripAttributes provides an RSpec/Shoulda-compatible matcher for easier
+testing of attribute assignment. You can use this with
+[RSpec](http://rspec.info/), [Shoulda](https://github.com/thoughtbot/shoulda),
+or [Minitest-Matchers](https://github.com/zenspider/minitest-matchers).
 
-### Setup `test_helper.rb`
+### Setup `spec_helper.rb` or `test_helper.rb`
 
-To initialize, extend `StripAttributes::Shoulda::Macros` in your
-`test_helper.rb`:
+To initialize **RSpec**, add this to your `spec_helper.rb`:
 
 ```ruby
-require "strip_attributes/shoulda"
+require "strip_attributes/matchers"
+RSpec.configure do |config|
+  config.include StripAttributes::Matchers
+end
+```
+
+To initialize **Shoulda (with test-unit)**, add this to your `test_helper.rb`:
+
+```ruby
+require "strip_attributes/matchers"
 class Test::Unit::TestCase
-  extend StripAttributes::Shoulda::Macros
+  include StripAttributes::Matchers
+  extend StripAttributes::Matchers
+end
+```
+
+To initialize **Minitest-Matchers**, add this to your `test_helper.rb`:
+
+```ruby
+require "strip_attributes/matchers"
+class MiniTest::Spec
+  include StripAttributes::Matchers
 end
 ```
 
 ### Writing Tests
 
-And in your unit tests:
+**Rspec**:
+
+```ruby
+describe User do
+  it { should strip_attribute :name }
+  it { should strip_attribute :email }
+  it { should_not strip_attribute :password }
+end
+```
+
+**Shoulda (with test-unit)**:
 
 ```ruby
 class UserTest < ActiveSupport::TestCase
-  should_strip_attributes :name, :email
-  should_not_strip_attributes :password
+  should strip_attribute :name
+  should strip_attribute :email
+  should_not strip_attribute :password
+end
+```
+
+**Minitest-Matchers**:
+
+```ruby
+describe User do
+  subject { User.new }
+
+  must { strip_attribute :name }
+  must { strip_attribute :email }
+  wont { strip_attribute :password }
 end
 ```
 
@@ -116,5 +161,5 @@ support.
 
 ## License
 
-Copyright (c) 2007-2011 Ryan McGeary released under the [MIT
+Copyright (c) 2007-2013 Ryan McGeary released under the [MIT
 license](http://en.wikipedia.org/wiki/MIT_License)

data/lib/strip_attributes/matchers.rb

@@ -0,0 +1,44 @@
+module StripAttributes
+  module Matchers
+
+    # Whitespace is stripped from the beginning and end of the attribute
+    #
+    # RSpec Examples:
+    #
+    #   it { should strip_attribute(:first_name) }
+    #   it { should_not strip_attribute(:password) }
+    #
+    # Minitest Matchers Examples:
+    #
+    #   must { strip_attribute :first_name }
+    #   wont { strip_attribute :password }
+    def strip_attribute(attribute)
+      StripAttributeMatcher.new(attribute)
+    end
+
+    class StripAttributeMatcher
+      def initialize(attribute)
+        @attribute = attribute
+      end
+
+      def matches?(subject)
+        subject.send("#{@attribute}=", " string ")
+        subject.valid?
+        subject.send(@attribute) == "string"
+      end
+
+      def failure_message
+        "Expected whitespace to be stripped from `#{@attribute}`, but it was not"
+      end
+
+      def negative_failure_message
+        "Expected whitespace to remain on `#{@attribute}`, but it was stripped"
+      end
+
+      def description
+        "strip whitespace from ##{@attribute}"
+      end
+    end
+
+  end
+end

data/lib/strip_attributes/shoulda/macros.rb

@@ -3,7 +3,10 @@ require "shoulda/context"
 module StripAttributes
   module Shoulda
     module Macros
+      # Deprecated. Use `should strip_attribute :attribute` instead.
       def should_strip_attributes(*attributes)
+        warn "[DEPRECATION] should_strip_attributes is deprecated. " <<
+             "Use `should strip_attribute :attribute` instead."
         attributes.each do |attribute|
           attribute = attribute.to_sym
           should "strip whitespace from #{attribute}" do
@@ -14,7 +17,10 @@ module StripAttributes
         end
       end
 
+      # Deprecated. Use `should_not strip_attribute :attribute` instead.
       def should_not_strip_attributes(*attributes)
+        warn "[DEPRECATION] should_not_strip_attributes is deprecated. " <<
+             "Use `should_not strip_attribute :attribute` instead."
         attributes.each do |attribute|
           attribute = attribute.to_sym
           should "not strip whitespace from #{attribute}" do

data/lib/strip_attributes/shoulda.rb

@@ -1 +1,3 @@
+warn "[DEPRECATION] strip_attributes/shoulda is deprecated. " <<
+     "Try strip_attributes/matchers instead."
 require "strip_attributes/shoulda/macros"

data/lib/strip_attributes/version.rb

@@ -1,3 +1,3 @@
 module StripAttributes
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/test/matchers_test.rb

@@ -0,0 +1,41 @@
+require "minitest/matchers"
+require "test_helper"
+require "strip_attributes/matchers"
+
+class SampleMockRecord < Tableless
+  attributes :stripped1, :stripped2, :stripped3
+  attributes :unstripped1, :unstripped2, :unstripped3
+
+  strip_attributes :only => [:stripped1, :stripped2, :stripped3]
+end
+
+describe SampleMockRecord do
+  include StripAttributes::Matchers
+
+  subject { SampleMockRecord.new }
+
+  must { strip_attribute :stripped1 }
+  must { strip_attribute :stripped2 }
+  must { strip_attribute :stripped3 }
+  wont { strip_attribute :unstripped1 }
+  wont { strip_attribute :unstripped2 }
+  wont { strip_attribute :unstripped3 }
+
+  it "should fail when testing for strip on an unstripped attribute" do
+    begin
+      assert_must strip_attribute(:unstripped1)
+      assert false
+    rescue
+      assert true
+    end
+  end
+
+  it "should fail when testing for no strip on a stripped attribute" do
+    begin
+      assert_wont strip_attribute(:stripped1)
+      assert false
+    rescue
+      assert true
+    end
+  end
+end

data/test/strip_attributes_test.rb

@@ -31,7 +31,7 @@ class StripExceptThreeMockRecord < Tableless
   strip_attributes :except => [:foo, :bar, :biz]
 end
 
-class StripAttributesTest < Test::Unit::TestCase
+class StripAttributesTest < MiniTest::Unit::TestCase
   def setup
     @init_params = { :foo => "\tfoo", :bar => "bar \t ", :biz => "\tbiz ", :baz => "", :bang => " " }
   end

data/test/test_helper.rb

@@ -1,4 +1,5 @@
-require "test/unit"
+require "minitest/autorun"
+require "minitest/pride"
 require "active_record"
 require "active_support/core_ext/hash/indifferent_access"
 require "strip_attributes"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: strip_attributes
 version: !ruby/object:Gem::Version
-  version: 1.1.1
   prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Ryan McGeary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -20,13 +20,29 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: minitest-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  prerelease: false
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -36,13 +52,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+  prerelease: false
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -50,15 +66,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '10.0'
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '10.0'
+  prerelease: false
 description: StripAttributes automatically strips all ActiveRecord model attributes
   of leading and trailing whitespace before validation. If the attribute is blank,
   it strips the value to nil.
@@ -68,10 +84,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/strip_attributes/matchers.rb
 - lib/strip_attributes/shoulda/macros.rb
 - lib/strip_attributes/shoulda.rb
 - lib/strip_attributes/version.rb
 - lib/strip_attributes.rb
+- test/matchers_test.rb
 - test/strip_attributes_test.rb
 - test/test_helper.rb
 - README.md
@@ -86,25 +104,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -1824406782290119143
+      hash: 4383093810651620729
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -1824406782290119143
+      hash: 4383093810651620729
+      version: '0'
 requirements: []
-rubyforge_project: strip_attributes
+rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Whitespace cleanup for ActiveModel attributes
 test_files:
+- test/matchers_test.rb
 - test/strip_attributes_test.rb
 - test/test_helper.rb