smart_rspec 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48b874a311311e784f28124875c47496d24341a4
-  data.tar.gz: 58bcf16c460903b3c77fb796bd62e95ce37ef177
+  metadata.gz: 5ff5716dab4e7adc48ce3d9a68f5ac08335c9447
+  data.tar.gz: e00030e125016a66de204b9d106ae68e60d39ab3
 SHA512:
-  metadata.gz: 28623faa3ad5c10172b668672598cfaf0da6725bb4532fb3e7ad40043ddeb390ccbbf5252115b3874edadd374023d96acd30ff4cf2a59fdd479dc84846630f17
-  data.tar.gz: 65f2a44c1f27a69ac5ac9ead3b7e88d97ef1e471b5dba36c0121a6f229a6d2157383f740bb7a111bf0f8962c8ae7d46578e38b5da735114a1c1e94b18e519ccf
+  metadata.gz: e84dac0dff7b0985a9a7925c61444e34bd26854ad5c354809932bfe74111207534dde371f239ed279af497afed89eb41520e4393cdf26cec96848031983c41b8
+  data.tar.gz: 2ff5953423af3958d6fda0586f1794927024569f1f8114fcfc5587a848685d4345510a43474da70e015e0b6e8c9705c493a59f074b46c66d3acab26f55925ad8

data/README.md

@@ -20,13 +20,14 @@ Execute:
     $ bundle
 
 Require the gem at the top of your `spec/rails_helper.rb` (or equivalent):
-``` ruby 
+
+``` ruby
 require 'smart_rspec'
 ```
 
 Then include the SmartRspec module:
 
-``` ruby 
+``` ruby
 RSpec.configure do |config|
   config.include SmartRspec
 end
@@ -39,17 +40,22 @@ end
     * [belongs_to, has_one, has_many](#belongs_to-has_one-has_many)
     * [fails_validation_of](#fails_validation_of)
 * [Matchers](#matchers)
-  * [be_ascending](#be_ascending)
-  * [be_descending](#be_descending)
-  * [be_boolean](#be_boolean)
-  * [be_email](#be_email)
-  * [be_url](#be_url)
-  * [be_image_url](#be_image_url)
-  * [have](#have)
-  * [have_at_least](#have_at_least)
-  * [have_at_most](#have_at_most)
-  * [have_error_on](#have_error_on)
-  * [include_items](#include_items)
+  * ["Be" matchers](#)
+    * [be_ascending](#be_ascending)
+    * [be_a_bad_request](#be_a_bad_request)
+    * [be_a_list_of](#be_a_list_of)
+    * [be_boolean](#be_boolean)
+    * [be_descending](#be_descending)
+    * [be_email](#be_email)
+    * [be_image_url](#be_image_url)
+    * [be_url](#be_url)
+  * ["Have" matchers](#)
+    * [have](#have)
+    * [have_at_least](#have_at_least)
+    * [have_at_most](#have_at_most)
+    * [have_error_on](#have_error_on)
+  * [Other matchers](#)
+    * [include_items](#include_items)
 
 ### Macros
 
@@ -61,7 +67,7 @@ It builds specs for model attributes and test its type, enumerated values and de
 ``` ruby
 RSpec.describe User, type: :model do
     subject { FactoryGirl.build(:user) }
-    
+
     has_attributes :email, type: :String
     has_attributes :is_admin, type: :Boolean
     has_attributes :score, type: :Integer, default: 0
@@ -75,25 +81,27 @@ It builds specs and test model associations like `belongs_to`, `has_one` and `ha
 ``` ruby
 RSpec.describe User, type: :model do
     subject { FactoryGirl.build(:user) }
-    
+
     belongs_to :business
     has_one :project
     has_many :tasks
 end
 ```
 
-#### fails_validation_of 
+#### fails_validation_of
 
-It builds specs forcing model validations to fail, it means that you will only turn its specs into green when you specify the corresponding validation in the model.
+It builds specs and forces model validations to fail, meaning that you will only turn specs into green when you specify the corresponding validation in the model. In order to get a nice semantics it's recommended to use the `fails_validation_of` macro within a "when invalid" context, like:
 
 ``` ruby
 RSpec.describe User, type: :model do
     subject { FactoryGirl.build(:user) }
-    
-    fails_validation_of :email, presence: true, email: true
-    fails_validation_of :name, length: { maximum: 80 }, uniqueness: true
-    fails_validation_of :username, length: { minimum: 10 }, exclusion: { in: %w(foo bar) }
-    # Other validations...
+
+    context 'when invalid' do
+      fails_validation_of :email, presence: true, email: true
+      fails_validation_of :name, length: { maximum: 80 }, uniqueness: true
+      fails_validation_of :username, length: { minimum: 10 }, exclusion: { in: %w(foo bar) }
+      # Other validations...
+    end
 end
 ```
 
@@ -124,72 +132,97 @@ fails_validation_of :foo, format: { with: /foo/, mock: 'bar' }
 
 SmartRspec gathers a collection of custom useful matchers:
 
-#### be_ascending
+#### "Be" matchers
+
+##### be_ascending
 
 ``` ruby
 it { expect([1, 2, 3, 4]).to be_ascending }
 it { expect([1, 4, 2, 3]).not_to be_ascending }
 ```
 
-#### be_descending
+##### be_a_bad_request
 ``` ruby
-it { expect([4, 3, 2, 1]).to be_descending }
-it { expect([1, 2, 3, 4]).not_to be_descending }
+context 'unauthenticated' do
+  subject { get :profile }
+  it { is_expected.to be_a_bad_request }
+end
+
+context 'authenticated' do
+  before { sign_in user }
+  subject { get :profile }
+  it { is_expected.to_not be_a_bad_request }
+end
 ```
 
-#### be_boolean
+##### be_a_list_of
+``` ruby
+it { expect(Foo.fetch_api).to be_a_list_of(Foo)) }
+```
+
+##### be_boolean
 ``` ruby
 it { expect(true).to be_boolean }
 it { expect('true').not_to be_boolean }
 ```
 
-#### be_email
+##### be_descending
 ``` ruby
-it { expect('tiagopog@gmail.com').to be_email }
-it { expect('tiagopog@gmail').not_to be_email }
+it { expect([4, 3, 2, 1]).to be_descending }
+it { expect([1, 2, 3, 4]).not_to be_descending }
 ```
 
-#### be_url
+##### be_email
 ``` ruby
-it { expect('http://adtangerine.com').to be_url }
-it { expect('adtangerine.com').not_to be_url }
+it { expect('tiagopog@gmail.com').to be_email }
+it { expect('tiagopog@gmail').not_to be_email }
 ```
 
-#### be_image_url
+##### be_image_url
 ``` ruby
 it { expect('http://adtangerine.com/foobar.png').to be_image_url }
 it { expect('http://adtangerine.com/foobar.jpg').not_to be_image_url(:gif) }
 it { expect('http://adtangerine.com/foo/bar').not_to be_image_url }
 ```
 
-#### have(x).items
+##### be_url
+``` ruby
+it { expect('http://adtangerine.com').to be_url }
+it { expect('adtangerine.com').not_to be_url }
+```
+
+#### "Have" matchers
+
+##### have(x).items
 ``` ruby
 it { expect([1]).to have(1).item }
 it { expect(%w(foo bar)).to have(2).items }
 it { expect(%w(foo bar)).not_to have(1).item }
 ```
 
-#### have_at_least
+##### have_at_least
 ``` ruby
 it { expect(%w(foo bar foobar)).to have_at_least(3).items }
 ```
 
-#### have_at_most
+##### have_at_most
 ``` ruby
 it { expect(%w(foo bar foobar)).to have_at_most(3).items }
 ```
-#### have_error_on
+
+##### have_error_on
 ``` ruby
-subject(:user) { FactoryGirl.build(:user, email: nil) }
+subject { User.new(email: nil, name: Faker::Name.name) }
 
 it 'has an invalid email' do
-    user.valid?
-    expect(user).to have_error_on(:email)
-    expect(user).not_to have_error_on(:email)
+  subject.valid?
+  is_expected.to have_error_on(:email)
 end
 ```
 
-#### include_items
+#### Other matchers
+
+##### include_items
 ``` ruby
 it { expect(%w(foo bar foobar)).to include_items(%w(foo bar foobar)) }
 ```
@@ -198,7 +231,9 @@ it { expect(%w(foo bar foobar)).to include_items(%w(foo bar foobar)) }
 
 - Create macros for model scopes;
 - Create macros for controllers;
-- Add more matchers.
+- Add more matchers;
+- Take groups of matchers into modules;
+- Turn the whole into "A" in Code Climate.
 
 ## Contributing
 

data/lib/smart_rspec/matchers/be_matchers.rb

@@ -0,0 +1,46 @@
+module SmartRspec
+  module Matchers
+    module BeMatchers
+      extend RSpec::Matchers::DSL
+
+      matcher :be_ascending do
+        match { |actual| actual == actual.sort  }
+      end
+
+      matcher :be_a_bad_request do
+        match do |response|
+          response.code.to_s =~ /^4/
+        end
+      end
+
+      matcher :be_a_list_of do |klass|
+        match do |collection|
+          collection.all? { |e| e.is_a?(klass) }
+        end
+      end
+
+      matcher :be_boolean do
+        match { |actual| [true, false].include?(actual) }
+      end
+
+      matcher :be_descending do
+        match do |actual|
+          actual.each_cons(2).all? { |i, j| i >= j  }
+        end
+      end
+
+      matcher :be_email do
+        match { |actual| actual =~ build_regex(:email) }
+      end
+
+      matcher :be_image_url do |*types|
+        match { |actual| actual =~ build_regex(:image, types) }
+      end
+
+      matcher :be_url do
+        match { |actual| actual =~ build_regex(:uri) }
+      end
+    end
+  end
+end
+

data/lib/smart_rspec/matchers/other_matchers.rb

@@ -0,0 +1,16 @@
+module SmartRspec
+  module Matchers
+    module OtherMatchers
+      extend RSpec::Matchers::DSL
+
+      matcher :have_error_on do |attr|
+        match { |actual| actual.errors.keys.include?(attr) }
+      end
+
+      matcher :include_items do |items|
+        match { |actual| (items - actual).empty? }
+      end
+    end
+  end
+end
+

data/lib/smart_rspec/matchers.rb

@@ -1,45 +1,12 @@
-require 'rspec/matchers'
-require 'rspec/collection_matchers'
 require 'smart_rspec/support/regexes'
+require 'smart_rspec/matchers/be_matchers'
+require 'smart_rspec/matchers/other_matchers'
 
 module SmartRspec
   module Matchers
-    extend RSpec::Matchers::DSL
     include SmartRspec::Support::Regexes
-
-    matcher :be_boolean do
-      match { |actual| [true, false].include?(actual) }
-    end
-
-    matcher :be_email do
-      match { |actual| actual =~ build_regex(:email) }
-    end
-
-    matcher :be_url do
-      match { |actual| actual =~ build_regex(:uri) }
-    end
-
-    matcher :be_image_url do |*types|
-      match { |actual| actual =~ build_regex(:image, types) }
-    end
-
-    matcher :have_error_on do |attr|
-      match { |actual| actual.errors.keys.include?(attr) }
-    end
-
-    matcher :include_items do |items|
-      match { |actual| (items - actual).empty? }
-    end
-
-    matcher :be_ascending do
-      match { |actual| actual == actual.sort  }
-    end
-
-    matcher :be_descending do
-      match do |actual|
-        actual.each_cons(2).all? { |i, j| i >= j  }
-      end
-    end
+    include SmartRspec::Matchers::BeMatchers
+    include SmartRspec::Matchers::OtherMatchers
   end
 end
 

data/lib/smart_rspec/version.rb

@@ -1,3 +1,3 @@
 module SmartRspec
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/smart_rspec.rb

@@ -1,7 +1,8 @@
+%w(macros matchers support/expectations).each { |f| require "smart_rspec/#{f}" }
+
 require 'active_support/concern'
-require 'smart_rspec/macros'
-require 'smart_rspec/matchers'
-require 'smart_rspec/support/expectations'
+require 'rspec/collection_matchers'
+require 'rspec/matchers'
 
 include SmartRspec::Matchers
 

data/spec/smart_rspec/matchers_spec.rb

@@ -111,21 +111,19 @@ describe 'SmartRspec Matchers' do
   end
 
   describe '#have_error_on' do
-    subject(:mock) { User.new(email: nil) }
+    subject { User.new(email: nil, name: Faker::Name.name) }
 
     context 'when valid' do
       it do
-        mock.valid?
-        expect(mock).to have_error_on(:email)
+        subject.valid?
+        is_expected.to have_error_on(:email)
       end
     end
 
     context 'when invalid' do
       it do
-        mock.email = Faker::Internet.email
-        mock.valid?
-
-        expect(mock).not_to have_error_on(:email)
+        subject.valid?
+        is_expected.not_to have_error_on(:name)
       end
     end
   end
@@ -140,5 +138,35 @@ describe 'SmartRspec Matchers' do
       it { expect(%w(foo bar foobar)).not_to include_items(%w(lorem)) }
     end
   end
-end
 
+  describe '#be_a_list_of' do
+    context 'when valid' do
+      subject { Array.new(3, User.new) }
+      it { is_expected.to be_a_list_of(User) }
+    end
+
+    context 'when invalid' do
+      subject { Array.new(3, User.new) << nil }
+      it { is_expected.to_not be_a_list_of(User) }
+    end
+  end
+
+  describe '#be_a_bad_request' do
+    let(:response) { double('http response') }
+
+    context 'ok' do
+      before { allow(response).to receive(:code).and_return(200) }
+      it { expect(response).to_not be_a_bad_request }
+    end
+
+    context 'not found' do
+      before { allow(response).to receive(:code).and_return(404) }
+      it { expect(response).to be_a_bad_request }
+    end
+
+    context 'unauthorized' do
+      before { allow(response).to receive(:code).and_return(401) }
+      it { expect(response).to be_a_bad_request }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Tiago Guedes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,6 +118,8 @@ files:
 - lib/smart_rspec.rb
 - lib/smart_rspec/macros.rb
 - lib/smart_rspec/matchers.rb
+- lib/smart_rspec/matchers/be_matchers.rb
+- lib/smart_rspec/matchers/other_matchers.rb
 - lib/smart_rspec/support/assertions.rb
 - lib/smart_rspec/support/expectations.rb
 - lib/smart_rspec/support/regexes.rb