rspec-active_record 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc22932934c76f5aa353ae21165ccccb5dbe12ae02b23384b4bf2be5c3fb2400
-  data.tar.gz: ceba6e1dd8edd17ba0b732a458e2a71be87a916213b8a6500394d011e3322074
+  metadata.gz: c8db7110108ac53ef5b6ef595d04cd711410217b5fce21a27cd94ffebae23ece
+  data.tar.gz: bc6c9a9d25c119dd8681f6b45166646a6770693910b802228ecd6552c86f2192
 SHA512:
-  metadata.gz: 4895273f1779660e100f207e9497979f07eaf973ddc1133b138ac56d7b1339bc632387a7ac0a1aa8b8fea0903a644fb5d043f76e5e2eb23289ee916240e60085
-  data.tar.gz: 6ee9a41affc0b83ad13cbb54a0c1da7ac0187c13a7ea0bb5104df6f9ed5e8511572f2bab8a9eb5e45a0960faad7d8e76e55e44274aaf3735feff702d990e9e8b
+  metadata.gz: 321aa7bb887b01fb0e893b878acba02068612ea15719e647563652dcba7508bd1673d5765c916258ce278df72bbf9381b3897109a9e213391fb6e5213f609845
+  data.tar.gz: 2bd092467cc39b93cd27744c6944a9306ab98be4355abf31e0a5834c21c462ff93332140dd700b05d2fd2fb1e5d0b03fb88d060cd19cb17c796391b1d72400a2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+- Add support for times in create_record
+
+## [0.2.0] - 2024-07-12
+
+- Add support for negative matchers
+
 ## [0.1.0] - 2023-04-23
 
 - Initial release

data/README.md

@@ -4,9 +4,19 @@ Implements helper methods & matchers when working with RSpec & ActiveRecord.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add it to Gemfile:
 
-    $ bundle add rspec-active_record --group test
+```ruby
+group :test do
+  gem "rspec-active_record", require: false
+end
+```
+
+And require it in your `rails_helper` or `spec_helper` after `rspec/rails`:
+
+```ruby
+require "rspec/active_record"
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
@@ -20,6 +30,13 @@ Check that block creates a record:
 
 ```ruby
 expect { User.create!(name: "RSpec User") }.to create_record(User)
+expect { User.create!(name: "RSpec User") }.to not_create_record(Company)
+```
+
+Sometimes you also need to match specific count of records:
+```ruby
+expect { User.create!(name: "RSpec User") }.to create_record(User).once
+expect { User.create!(name: "RSpec User") }.to create_record(User).times(1)
 ```
 
 You can also make sure that attributes match, if it fails you'll get RSpec diff between created record and what you expected:
@@ -44,6 +61,7 @@ expect { user.update!(name: "RSpec User") }.to change_record(user).to(name: "RSp
 Sometimes it's useful to specify what the attributes should've been initially:
 ```ruby
 expect { user.update!(name: "RSpec User") }.to change_record(user).from(name: "Initial Name")
+expect { user.name = "RSpec User" }.to not_change_record(user).from(name: "Initial Name")
 ```
 
 ### destroy_record
@@ -51,6 +69,7 @@ expect { user.update!(name: "RSpec User") }.to change_record(user).from(name: "I
 Check that code destroys a record:
 ```ruby
 expect { user.destroy! }.to destroy_record(user)
+expect { user.save! }.to not_destroy_record(user)
 ```
 
 ### stub_class

data/lib/rspec/active_record/change_record.rb

@@ -7,13 +7,13 @@ module RSpec
       include RSpec::Matchers::BuiltIn::BaseMatcher::HashFormatting
 
       # Attributes of record should match these after block is executed
-      def to(**attributes)
+      def to(attributes)
         @to = attributes
         self
       end
 
       # Attributes of record should match these before block is executed
-      def from(**attributes)
+      def from(attributes)
         @from = attributes
         self
       end
@@ -78,10 +78,6 @@ module RSpec
 
       private
 
-      def format_hash(hash)
-        improve_hash_formatting RSpec::Support::ObjectFormatter.format(surface_descriptions_in(hash))
-      end
-
       def diff_unless_match(record, attributes)
         diff(record, attributes) unless match_attributes?(record, attributes)
       end

data/lib/rspec/active_record/create_record.rb

@@ -3,20 +3,37 @@
 module RSpec
   module ActiveRecord
     # A matcher
-    class CreateRecord
-      include RSpec::Matchers::Composable
+    class CreateRecord < Matcher
       include RSpec::Matchers::BuiltIn::BaseMatcher::HashFormatting
 
       def initialize(scope)
         @scope = scope
+        super()
       end
 
       # Make sure that created record matches attributes
-      def matching(**attributes)
+      def matching(attributes)
         @attributes = attributes
         self
       end
 
+      def times(times)
+        @times = times
+        self
+      end
+
+      def once
+        times(1)
+      end
+
+      def twice
+        times(2)
+      end
+
+      def thrice
+        times(3)
+      end
+
       def supports_block_expectations?
         true
       end
@@ -25,25 +42,25 @@ module RSpec
         existing_ids = @scope.ids
         block.call
 
-        @new_records = @scope.where.not(@scope.primary_key => existing_ids)
+        @new_records = @scope.where.not(@scope.primary_key => existing_ids).to_a
 
-        if @attributes
-          match_attributes?
-        else
-          @new_records.present?
-        end
+        match_times? && match_attributes? && @new_records.present?
       end
 
       def description
         message = "create #{scope_name}"
-        if @attributes
-          message += " matching #{RSpec::Support::ObjectFormatter.format(surface_descriptions_in(@attributes))}"
-        end
+        message += " #{@times} time#{"s" if @times != 1}" if @times
+        message += " matching #{format_hash(@attributes)}" if @attributes
         improve_hash_formatting message
       end
 
       def failure_message
-        add_diff "expected to #{description} but did not"
+        failure = "expected to #{description} but"
+        if !match_times?
+          "#{failure} created #{@new_records.size}"
+        else
+          add_diff "#{failure} did not"
+        end
       end
 
       def failure_message_when_negated
@@ -57,8 +74,13 @@ module RSpec
         message
       end
 
+      def match_times?
+        @times.nil? || @times == @new_records.size
+      end
+
       def match_attributes?
-        @new_records.any? { |record| RSpec::Matchers::BuiltIn::HaveAttributes.new(@attributes).matches?(record) }
+        @attributes.nil? ||
+          @new_records.any? { |record| RSpec::Matchers::BuiltIn::HaveAttributes.new(@attributes).matches?(record) }
       end
 
       def scope_name

data/lib/rspec/active_record/matcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RSpec
+  module ActiveRecord
+    # A matcher
+    class Matcher
+      include RSpec::Matchers::Composable
+
+      def supports_block_expectations?
+        true
+      end
+
+      private
+
+      def format_hash(hash)
+        improve_hash_formatting RSpec::Support::ObjectFormatter.format(surface_descriptions_in(hash))
+      end
+    end
+  end
+end

data/lib/rspec/active_record/record_matcher.rb

@@ -3,17 +3,12 @@
 module RSpec
   module ActiveRecord
     # A matcher
-    class RecordMatcher
-      include RSpec::Matchers::Composable
-
+    class RecordMatcher < Matcher
       def initialize(record)
+        super()
         @record = record
       end
 
-      def supports_block_expectations?
-        true
-      end
-
       private
 
       def format_record

data/lib/rspec/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module ActiveRecord
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rspec/active_record.rb

@@ -12,6 +12,7 @@ module RSpec
     autoload :CreateRecord, "rspec/active_record/create_record"
     autoload :DestroyRecord, "rspec/active_record/destroy_record"
     autoload :DiffForMultipleRecords, "rspec/active_record/diff_for_multiple_records"
+    autoload :Matcher, "rspec/active_record/matcher"
     autoload :RecordMatcher, "rspec/active_record/record_matcher"
     autoload :StubModels, "rspec/active_record/stub_models"
     autoload :VERSION, "rspec/active_record/version"
@@ -53,3 +54,7 @@ module RSpec
   end
 end
 RSpec.configuration.include RSpec::ActiveRecord
+
+RSpec::Matchers.define_negated_matcher :not_create_record, :create_record
+RSpec::Matchers.define_negated_matcher :not_change_record, :change_record
+RSpec::Matchers.define_negated_matcher :not_destroy_record, :destroy_record

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-active_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrius Chamentauskas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -141,6 +141,7 @@ files:
 - lib/rspec/active_record/create_record.rb
 - lib/rspec/active_record/destroy_record.rb
 - lib/rspec/active_record/diff_for_multiple_records.rb
+- lib/rspec/active_record/matcher.rb
 - lib/rspec/active_record/record_matcher.rb
 - lib/rspec/active_record/stub_models.rb
 - lib/rspec/active_record/version.rb