smart_rspec 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ff36ef01dd0d51c6bab2614a6613201973dd7c7
-  data.tar.gz: cdf57909342d77f99b5ccf3b0fe3766343da5591
+SHA256:
+  metadata.gz: f654ae1cc1194b77fafaf9efd5084b2c1346201ea076baca1e20d6c7f8182517
+  data.tar.gz: ee86c887ebf82fdce3818de765eb5ae4748b7f7efec18534303a30b34c98b3fd
 SHA512:
-  metadata.gz: 8e1f3afcc473a3fb8b25a21da76bbc6a4cbfd09d7e93746f15b3e224f8b4f24f438f42266906e99e4389e9ffde7f07311790d16133d2e892117f11efc22f3e72
-  data.tar.gz: ec5b1078402f12aa22cd125eceef70a1ea96ce4d639186c20505733dc7045d9a9e2be90b5f9abc4571c78ec54480a42bbd12e32994084596948835f13a4a7fbe
+  metadata.gz: 459bc117fd8ff6f167c89fd94ed8dc2af1a6b7ce93d8d65fdb0cba4a2e2b2616e81c03bf371602d3c8549a5b5876d2c76afcd6b42b4a1754807df3801ad0bd2d
+  data.tar.gz: fa832dc1c221c3a46e0eb316324bb0f7ccb35d7363e87200c7533a3e896de4f8120096ad8c2e1b682b9e5ea875f3d6c156ed7a9827486402418a3e53abb24e03

data/.travis.yml

@@ -1,6 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.3.3

data/README.md

@@ -51,7 +51,6 @@ end
     * [be_a_list_of](#be_a_list_of)
     * [be_ascending](#be_ascending)
     * [be_descending](#be_descending)
-    * [be_a_bad_request](#be_a_bad_request)
   * ["Have" matchers](#have-matchers)
     * [have](#have)
     * [have_at_least](#have_at_least)
@@ -180,20 +179,6 @@ it { expect([4, 3, 2, 1]).to be_descending }
 it { expect([1, 2, 3, 4]).not_to be_descending }
 ```
 
-##### be_a_bad_request
-``` ruby
-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
-```
-
 #### Have matchers
 
 ##### have(x).items

data/lib/smart_rspec/macros.rb

@@ -1,7 +1,7 @@
-require 'smart_rspec/support/assertions'
+require 'smart_rspec/support/model/assertions'
 
 module SmartRspec::Macros
-  include SmartRspec::Support::Assertions
+  include SmartRspec::Support::Model::Assertions
 
   def belongs_to(*associations)
     assert_association :belongs_to, associations
@@ -31,4 +31,3 @@ module SmartRspec::Macros
     end
   end
 end
-

data/lib/smart_rspec/matchers/be_matchers.rb

@@ -7,12 +7,6 @@ module SmartRspec
         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) }

data/lib/smart_rspec/matchers/json_api_matchers.rb

@@ -0,0 +1,43 @@
+module SmartRspec
+  module Matchers
+    module JsonApiMatchers
+      extend RSpec::Matchers::DSL
+      include SmartRspec::Support::Controller::Response
+
+      matcher :have_primary_data do |expected|
+        match do |response|
+          json(response).collection.all? do |record|
+            !record['id'].to_s.empty? && record['type'] == expected
+          end
+        end
+      end
+
+      matcher :have_data_attributes do |fields|
+        match do |response|
+          json(response).check_keys_in('attributes', fields)
+        end
+      end
+
+      matcher :have_relationships do |relationships|
+        match do |response|
+          json(response).check_keys_in('relationships', relationships)
+        end
+      end
+
+      matcher :have_included_relationships do
+        match do |response|
+          json(response)
+          return false if included_data.empty? || relationship_data.empty?
+          included_data.size == relationship_data.size &&
+            (included_data - relationship_data).empty?
+        end
+      end
+
+      matcher :have_meta_record_count do |count|
+        match do |response|
+          json(response).meta_record_count == count
+        end
+      end
+    end
+  end
+end

data/lib/smart_rspec/matchers/other_matchers.rb

@@ -13,4 +13,3 @@ module SmartRspec
     end
   end
 end
-

data/lib/smart_rspec/matchers.rb

@@ -1,12 +1,14 @@
 require 'smart_rspec/support/regexes'
+require 'smart_rspec/support/controller/response'
 require 'smart_rspec/matchers/be_matchers'
+require 'smart_rspec/matchers/json_api_matchers'
 require 'smart_rspec/matchers/other_matchers'
 
 module SmartRspec
   module Matchers
     include SmartRspec::Support::Regexes
     include SmartRspec::Matchers::BeMatchers
+    include SmartRspec::Matchers::JsonApiMatchers
     include SmartRspec::Matchers::OtherMatchers
   end
 end
-

data/lib/smart_rspec/support/controller/response.rb

@@ -0,0 +1,47 @@
+require 'json'
+
+module SmartRspec
+  module Support
+    module Controller
+      module Response
+        def json(response)
+          @json ||= JSON.parse(response.body)
+          self
+        end
+
+        def error
+          @error ||= @json['errors'].first
+        end
+
+        def collection
+          @collection ||= [@json['data']].flatten
+        end
+
+        def meta_record_count
+          @json['meta']['record_count']
+        end
+
+        def relationship_data
+          @relationship_data ||= collection.flat_map do |record|
+            record['relationships'].flat_map do |_, relation|
+              [relation['data']].flatten.map { |data| data.slice('type', 'id') }
+            end.compact
+          end
+        end
+
+        def included_data
+          return [] if @json['included'].nil?
+          @included_data ||= @json['included'].flat_map do |record|
+            record.slice('type', 'id')
+          end
+        end
+
+        def check_keys_in(member, keys)
+          collection.all? do |record|
+            record[member].keys.sort == keys.sort
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart_rspec/support/model/assertions.rb

@@ -0,0 +1,112 @@
+module SmartRspec
+  module Support
+    module Model
+      module Assertions
+        def validates_email_of(attr, validation)
+          it 'has an invalid format' do
+            %w(foobar foobar@ @foobar foo@bar).each do |e|
+              be_valid_expectation(attr, e, subject.dup)
+            end
+          end
+        end
+
+        def validates_exclusion_of(attr, validation)
+          it 'has a reserved value' do
+            be_valid_expectation(attr, validation[:in].sample)
+          end
+        end
+
+        def validates_format_of(attr, validation)
+          it 'does not match the required format' do
+            mock, with =
+              validation.values_at(:mock).first,
+              validation.values_at(:with).first
+
+            if mock && with && with !~ mock
+              be_valid_expectation(attr, mock)
+            else
+              raise ArgumentError, ':with and :mock are required when using the :format validation'
+            end
+          end
+        end
+
+        def validates_inclusion_of(attr, validation)
+          it 'is out of the scope of possible values' do
+            begin
+              value = SecureRandom.hex
+            end while validation[:in].include?(value)
+            be_valid_expectation(attr, value)
+          end
+        end
+
+        def validates_length_of(attr, validation)
+          validation.each do |key, value|
+            next unless [:in, :is, :maximum, :minimum, :within].include?(key)
+            txt, n = build_length_validation(key, value)
+            it txt do
+              be_valid_expectation(attr, 'x' * n)
+            end
+          end
+        end
+
+        def validates_presence_of(attr, validation)
+          it 'is blank' do
+            be_valid_expectation(attr, nil, subject.dup)
+          end
+        end
+
+        def validates_uniqueness_of(attr, validation)
+          it 'is already in use' do
+            if !validation.is_a?(Hash) || !validation.has_key?(:mock)
+              raise ArgumentError, 'A "mock" must be set when validating the uniqueness of a record'
+            elsif subject.persisted? || subject.save
+              mock, scope = validation.values_at(:mock, :scope)
+              mock.send("#{scope}=", subject.send(scope)) unless scope.to_s.empty?
+              be_valid_expectation(attr, subject.send(attr), mock)
+            end
+          end
+        end
+
+        def assert_has_attributes(attrs, options) type_str = build_type_str(options)
+          attrs.each do |attr|
+            it %Q(has an attribute named "#{attr}"#{type_str}) do
+              expect(subject).to respond_to(attr)
+              has_attributes_expectation(attr, options)
+            end
+          end
+        end
+
+        def assert_association(type, associations)
+          associations.each do |model|
+            it "#{type.to_s.gsub('_', ' ')} #{model}" do
+              expect(subject).to respond_to(model)
+              association_expectation(type, model)
+            end
+          end
+        end
+
+        def build_length_validation(key, value)
+          case key
+          when :in, :within then ['is out of the length range', value.max + 1]
+          when :is, :minimum then ["is #{key == :is ? 'invalid' : 'too short'}", value - 1]
+          when :maximum then ['is too long', value + 1]
+          end
+        end
+
+        def build_type_str(options)
+          if !options.nil? && options[:type]
+            " (%s%s%s)" % [
+              ('Enumerated ' if options[:enum]),
+              options[:type],
+              (", default: #{options[:default]}" if options[:default])
+            ]
+          end
+        end
+
+        # def scoped_validation?(validation)
+        #   validation.is_a?(Hash) && ([:scope, :mock] - validation.keys).empty?
+        # end
+      end
+    end
+  end
+end

data/lib/smart_rspec/support/model/expectations.rb

@@ -0,0 +1,43 @@
+module SmartRspec
+  module Support
+    module Model
+      module Expectations
+        def be_valid_expectation(attr, value = nil, mock = nil)
+          mock ||= subject
+          mock.send("#{attr}=", value)
+
+          expect(mock).not_to be_valid
+          expect(mock).to have_error_on(attr)
+        end
+
+        def default_expectation(attr, value)
+          expect(subject.send(attr)).to eq(value)
+        end
+
+        def enum_expectation(attr, value)
+          expect(value).to include(subject.send(attr).to_sym)
+        end
+
+        def type_expectation(attr, value)
+          assert_type = value != :Boolean ? be_kind_of(Kernel.const_get(value)) : be_boolean
+          expect(subject.send(attr)).to assert_type
+        end
+
+        def has_attributes_expectation(attr, options) options.each do |key, value|
+            send("#{key}_expectation", attr, value)
+          end
+        end
+
+        def association_expectation(type, model)
+          if type == :has_many
+            expect(subject).to respond_to("#{model.to_s.singularize}_ids")
+          elsif type == :belongs_to
+            %W(#{model}= #{model}_id #{model}_id=).each do |method|
+              expect(subject).to respond_to(method)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart_rspec/version.rb

@@ -1,3 +1,3 @@
 module SmartRspec
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'.freeze
 end

data/lib/smart_rspec.rb

@@ -2,7 +2,7 @@ require 'active_support/concern'
 require 'rspec/collection_matchers'
 require 'rspec/matchers'
 
-%w(macros matchers support/expectations).each { |f| require "smart_rspec/#{f}" }
+%w(macros matchers support/model/expectations).each { |f| require "smart_rspec/#{f}" }
 
 include SmartRspec::Matchers
 
@@ -10,11 +10,10 @@ module SmartRspec
   extend ActiveSupport::Concern
 
   included do
-    include SmartRspec::Support::Expectations
+    include SmartRspec::Support::Model::Expectations
   end
 
   module ClassMethods
     include SmartRspec::Macros
   end
 end
-

data/smart_rspec.gemspec

@@ -3,8 +3,7 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'smart_rspec/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'smart_rspec'
+Gem::Specification.new do |spec| spec.name          = 'smart_rspec'
   spec.version       = SmartRspec::VERSION
   spec.authors       = ['Tiago Guedes']
   spec.email         = ['tiagopog@gmail.com']
@@ -18,11 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '~> 4.1'
+  spec.add_runtime_dependency 'activesupport', '~> 6.0'
   spec.add_runtime_dependency 'rspec-collection_matchers', '~> 1.1', '>= 1.1.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'faker', '~> 1.4'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'faker', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
 end

data/spec/fixtures/response.rb

@@ -0,0 +1,11 @@
+module Fixtures
+  class Response
+    def initialize
+      @file = File.read('spec/fixtures/users.json')
+    end
+
+    def body
+      @file
+    end
+  end
+end

data/spec/{factories → fixtures}/user.rb

@@ -1,6 +1,6 @@
 require 'smart_rspec/support/regexes'
 
-module Factories
+module Fixtures
   class User
     include SmartRspec::Support::Regexes
 
@@ -17,30 +17,42 @@ module Factories
 
     attr_accessor :email, :system, :system_id, :project, :project_id,
                   :name, :username, :is_admin, :score, :admin, :father,
-                  :mother, :articles, :rates
+                  :mother, :articles, :rates, :errors
 
-    attr_reader :id, :errors
+    attr_reader :id
+
+    attr_writer :locale
 
     def initialize(attrs = {})
       attrs.each { |key, value| self.send("#{key}=", value) }
       set_defaults
-      @@collection << self
     end
 
     class << self
       attr_reader :collection
+
+      def create(attrs)
+        user = User.new(attrs)
+        @@collection << user && user
+      end
+
+      def find_by(key, value)
+        @@collection.find { |e| e.send(key) == value }
+      end
+    end
+
+    def save
+      @@collection << self
     end
 
     def locale
       @locale.to_s unless @locale.nil?
     end
 
-    def locale=(locale)
-      [:en, :pt].include?(locale) && @locale = locale
+    def persisted?
+      User.find_by(:id, id)
     end
 
-    def persisted?; true end
-
     def valid?
       %w(email father locale name username).each { |e| send("check_#{e}") }
       @errors.nil?
@@ -51,6 +63,8 @@ module Factories
     def check_email
       if !email || (email && email !~ build_regex(:email))
         @errors.merge!({ email: @@error_message[:blank] })
+      elsif User.find_by(:email, email)
+        @errors.merge!({ email: @@error_message[:uniqueness] })
       end
     end
 
@@ -61,7 +75,7 @@ module Factories
     end
 
     def check_locale
-      unless [:en, :pt].include?(locale)
+      unless %w(en pt).include?(locale)
         @errors.merge!({ locale: @@error_message[:inclusion] })
       end
     end
@@ -73,18 +87,19 @@ module Factories
     end
 
     def check_username
-      other_user = @@collection.select { |e| e.name == name && e.username == username && e.id != id }.first
-      if username && (other_user || %w(foo bar).include?(username))
-        @errors.merge!({ username: @@error_message[other_user ? :uniqueness : :exclusion] })
+      if username.to_s.empty?
+        @errors.merge!({ username: @@error_message[:blank] })
+      elsif %w(foo bar).include?(username)
+        @errors.merge!({ username: @@error_message[:exclusion] })
+      elsif User.find_by(:username, username)
+        @errors.merge!({ username: @@error_message[:uniqueness] })
       end
     end
 
     def set_defaults
       @@last_id = @id = @@last_id + 1
-      { errors: {}, is_admin: false, score: 0, locale: :en }.each do |key, value|
-        eval "@#{key} ||= #{value.inspect}"
-      end
+      attrs = { errors: {}, is_admin: false, score: 0, locale: :en }
+      attrs.each { |key, value| send("#{key}=", value) }
     end
   end
 end
-

data/spec/fixtures/users.json

@@ -0,0 +1,81 @@
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "users",
+      "links": {
+        "self": "http://api.myawesomesite.com/users/1"
+      },
+      "attributes": {
+        "first_name": "Tiago",
+        "last_name": "Guedes",
+        "full_name": "Tiago Guedes",
+        "birthday": "1988-22-12"
+      },
+      "relationships": {
+        "posts": {
+          "links": {
+            "self": "http://api.myawesomesite.com/users/1/relationships/posts",
+            "related": "http://api.myawesomesite.com/users/1/posts"
+          },
+          "data": [
+            {
+              "type": "posts",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "id": "2",
+      "type": "users",
+      "links": {
+        "self": "http://api.myawesomesite.com/users/2"
+      },
+      "attributes": {
+        "first_name": "Douglas",
+        "last_name": "André",
+        "full_name": "Douglas André",
+        "birthday": null
+      },
+      "relationships": {
+        "posts": {
+          "links": {
+            "self": "http://api.myawesomesite.com/users/2/relationships/posts",
+            "related": "http://api.myawesomesite.com/users/2/posts"
+          },
+          "data": []
+        }
+      }
+    }
+  ],
+  "included": [
+    {
+      "id": "1",
+      "type": "posts",
+      "links": {
+        "self": "http://api.myawesomesite.com/posts/1"
+      },
+      "attributes": {
+        "title": "An awesome post",
+        "body": "Lorem ipsum dolot sit amet"
+      },
+      "relationships": {
+        "author": {
+          "links": {
+            "self": "http://api.myawesomesite.com/posts/1/relationships/author",
+            "related": "http://api.myawesomesite.com/posts/1/author"
+          }
+        }
+      }
+    }
+  ],
+  "meta": {
+    "record_count": 2
+  },
+  "links": {
+    "first": "http://api.myawesomesite.com/users?include=posts&page%5Blimit%5D=2&page%5Boffset%5D=0",
+    "last": "http://api.myawesomesite.com/users?include=posts&page%5Blimit%5D=2&page%5Boffset%5D=0"
+  }
+}

data/spec/smart_rspec/macros_spec.rb

@@ -3,17 +3,14 @@ require 'spec_helper'
 describe SmartRspec::Macros do
   include SmartRspec
 
-  before(:all) do
-    attrs = {
-      email: Faker::Internet.email,
-      name: Faker::Name.name,
+  subject(:user) do
+    User.create({
+      email:    Faker::Internet.email,
+      name:     Faker::Name.name,
       username: Faker::Internet.user_name
-    }
-    @user = User.new(attrs)
+    })
   end
 
-  subject { @user }
-
   describe '#belongs_to' do
     context 'when it receives a single arg' do
       belongs_to :system
@@ -59,11 +56,16 @@ describe SmartRspec::Macros do
 
   describe '#fails_validation_of' do
     context 'when it receives a single arg' do
-      user = User.new(email: Faker::Internet.email)
+      new_user =
+        User.new({
+          email:    Faker::Internet.email,
+          name:     Faker::Name.name,
+          username: Faker::Internet.user_name
+        })
 
-      fails_validation_of :email, presence: true, email: true, uniqueness: true
+      fails_validation_of :email, presence: true, email: true, uniqueness: { mock: new_user }
       fails_validation_of :name, length: { maximum: 80 }
-      fails_validation_of :username, uniqueness: { scope: :name, mock: user }, exclusion: { in: %w(foo bar) }
+      fails_validation_of :username, uniqueness: { mock: new_user }, exclusion: { in: %w(foo bar) }
       fails_validation_of :locale, inclusion: { in: %w(en pt) }
       fails_validation_of :father, format: { with: /foo/, mock: 'bar' }
     end
@@ -73,4 +75,3 @@ describe SmartRspec::Macros do
     end
   end
 end
-