active_record_block_matchers 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56549819eb77b8a9e445755d2ed4d66c8a7c78d7
-  data.tar.gz: 5eae4e2fbe09eff5486f783ff296b437b92c84bd
+  metadata.gz: eeeaef70749a55d2326e700d7c5bfbb00f15101a
+  data.tar.gz: 5ab0c836a3c6f8bdf0be53aaf20bcd57f748a949
 SHA512:
-  metadata.gz: a8702eb8afc69876c8b15bb624124de2aae8c0735e8c05a9f6faf67fc7cf470c3163e2332c1fee2faf6c97dec8d7a3d8695e74e0264f550eaa465e87ab210316
-  data.tar.gz: 4f957401eac7b5b596bf04dbe6a402f2ba0c88d12facf8e7f017c29ba1bee72b410de8834dc1f3e4c2ac9849664f761aba6b77ce88122b946320d1967965363b
+  metadata.gz: 395c2b2dbbdc5629545b800f174d03153509f58e700e3954f630d0c016cb343f70ca3cb0b43a25965db3b558e1e88c1e2addb254378043c7fcbd81092c024973
+  data.tar.gz: 9c8bb147aabcfa50531cbbf40d50e2be7cae215e10a071eff716c88f21a8ff2d06ceaeb0abea7ef4e535868acdb8c59bee99070d4a23c600b68c5560bd1176c6

data/README.md

@@ -98,8 +98,6 @@ expect { User.create!(username: "BOB", password: "BlueSteel45") }
 
 **Gotcha Warning:** Be careful about your block syntax when chaining `.which` in your tests. If you write the above example with a `do...end`, the example will parse like this: `expect {...}.to(create_a(User).which) do |user| ... end`, so your block will not execute, and it may appear that your test is passing, when it is not.
 
-This matcher relies on a `created_at` column existing on the given model class.  The name of this column can be configured via `ActiveRecordBlockMatchers::Config.created_at_column_name = "your_column_name"`
-
 #### `create`
 
 aliases: `create_records`
@@ -156,6 +154,40 @@ expect { User.create!(username: "bob"); User.create!(username: "rhonda") }
   )
 ```
 
+## Record Retrieval Strategies
+
+There are currently two retrieval strategies implemented: `:id` and `:timestamp`. `:id` is the default, but this can be configured via the `default_strategy` configuration variable (more details [below](#configuration)).
+
+The ID and Timestamp Strategies work similarly. The ID Strategy queries the appropriate table(s) to find the highest ID value(s) before the block, then finds new records by looking for records with an ID that higher than that. The Timestamp Strategy uses `Time.current` to record the time before the block. Then it finds new records by looking for records that have a timestamp later than that.
+
+The ID Strategy is the default because it doesn't rely on time values that may be imprecise or mocked out. The Timestamp Strategy is useful if your tables don't have autoincrementing integer primary keys.
+
+## Configuration
+
+You can configure the column names used by the ID or Timestamp Strategies. Put code like this in your `spec_helper.rb` or similar file:
+
+```ruby
+ActiveRecordBlockMatchers.configure do |config|
+
+  # default value is "id"
+  config.id_column_name = "primary_key"
+
+  # default value is "created_at"
+  config.created_at_column_name = "created_timestamp"
+
+  # default value is :id
+  # must be one of [:id, :timestamp]
+  config.default_strategy = :timestamp
+end
+```
+
+You can also override the default strategy for individual assertions if needed:
+
+```ruby
+Timecop.freeze
+expect { Person.create! }.to create_a(Person, strategy: :id)
+```
+
 
 ## Development
 

data/active_record_block_matchers.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "pry", "~> 0.10.1"
   spec.add_development_dependency "sqlite3", "~> 1.3.10"
+  spec.add_development_dependency "database_cleaner", "~> 1.5.1"
   spec.add_development_dependency "standalone_migrations", "~> 2.1.5"
 end

data/lib/active_record_block_matchers/config.rb

@@ -1,6 +1,18 @@
 module ActiveRecordBlockMatchers
   class Config
 
+    def self.configure
+      yield self
+    end
+
+    def self.default_strategy
+      @default_strategy || :id
+    end
+
+    def self.default_strategy=(strategy_key)
+      @default_strategy = strategy_key.to_sym
+    end
+
     def self.created_at_column_name
       @created_at_column_name || "created_at"
     end
@@ -8,5 +20,13 @@ module ActiveRecordBlockMatchers
     def self.created_at_column_name=(column_name)
       @created_at_column_name = column_name
     end
+
+    def self.id_column_name
+      @id_column_name || "id"
+    end
+
+    def self.id_column_name=(column_name)
+      @id_column_name = column_name
+    end
   end
 end

data/lib/active_record_block_matchers/create_a_new_matcher.rb

@@ -13,14 +13,13 @@ RSpec::Matchers.define :create_a_new do |klass|
     @which_block = block
   end
 
-  match do |block|
-    time_before = Time.current
+  match do |options={}, block|
+    fetching_strategy =
+      ActiveRecordBlockMatchers::Strategies.for_key(options[:strategy]).new(block)
 
-    block.call
+    @created_records = fetching_strategy.new_records([klass])[klass]
 
-    column_name = ActiveRecordBlockMatchers::Config.created_at_column_name
-    @created_records = klass.where("#{column_name} > ?", time_before)
-    return false unless @created_records.count == 1
+    return false unless @created_records.count == 1 # ? this shouldn't be necessary for all strategies...
 
     record = @created_records.first
 

data/lib/active_record_block_matchers/create_records_matcher.rb

@@ -20,16 +20,11 @@ RSpec::Matchers.define :create_records do |record_counts|
     @which_block = block
   end
 
-  match do |block|
-    time_before = Time.current
+  match do |options={}, block|
+    fetching_strategy =
+      ActiveRecordBlockMatchers::Strategies.for_key(options[:strategy]).new(block)
 
-    block.call
-
-    @new_records =
-      record_counts.keys.each_with_object({}) do |klass, new_records|
-        column_name = ActiveRecordBlockMatchers::Config.created_at_column_name
-        new_records[klass] = klass.where("#{column_name} > ?", time_before).to_a
-      end
+    @new_records = fetching_strategy.new_records(record_counts.keys)
 
     @incorrect_counts =
       @new_records.each_with_object({}) do |(klass, new_records), incorrect|

data/lib/active_record_block_matchers/strategies.rb

@@ -0,0 +1,31 @@
+module ActiveRecordBlockMatchers
+  class Strategies
+
+    def self.all_strategies
+      @all_strategies ||= {
+        id: IdStrategy,
+        timestamp: TimestampStrategy,
+      }
+    end
+
+    def self.default
+      get_strategy!(Config.default_strategy)
+    end
+
+    def self.for_key(strategy_key)
+      if strategy_key.nil?
+        default
+      else
+        get_strategy!(strategy_key)
+      end
+    end
+
+    private
+
+    def self.get_strategy!(strategy_key)
+      all_strategies.fetch(strategy_key)
+    rescue KeyError
+      raise UnknownStrategyError, "#{strategy_key.inspect} is not a known strategy (known strategies are #{all_strategies.keys})"
+    end
+  end
+end

data/lib/active_record_block_matchers/strategies/id_strategy.rb

@@ -0,0 +1,29 @@
+module ActiveRecordBlockMatchers
+  class IdStrategy
+
+    def initialize(block)
+      @block = block
+    end
+
+    def new_records(classes)
+      ids_before = classes.each_with_object({}) do |klass, ids_before|
+        ids_before[klass] = klass.select("MAX(#{column_name}) as max_id").first.try(:max_id) || 0
+      end
+
+      block.call
+
+      classes.each_with_object({}) do |klass, new_records|
+        id_before = ids_before[klass]
+        new_records[klass] = klass.where("#{column_name} > ?", id_before).to_a
+      end
+    end
+
+    private
+
+    attr_reader :block
+
+    def column_name
+      @column_name ||= ActiveRecordBlockMatchers::Config.id_column_name
+    end
+  end
+end

data/lib/active_record_block_matchers/strategies/timestamp_strategy.rb

@@ -0,0 +1,26 @@
+module ActiveRecordBlockMatchers
+  class TimestampStrategy
+
+    def initialize(block)
+      @block = block
+    end
+
+    def new_records(classes)
+      time_before = Time.current
+
+      block.call
+
+      classes.each_with_object({}) do |klass, new_records|
+        new_records[klass] = klass.where("#{column_name} > ?", time_before).to_a
+      end
+    end
+
+    private
+
+    attr_reader :block
+
+    def column_name
+      @column_name ||= ActiveRecordBlockMatchers::Config.created_at_column_name
+    end
+  end
+end

data/lib/active_record_block_matchers/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordBlockMatchers
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_block_matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nathan Wallace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: standalone_migrations
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +162,9 @@ files:
 - lib/active_record_block_matchers/config.rb
 - lib/active_record_block_matchers/create_a_new_matcher.rb
 - lib/active_record_block_matchers/create_records_matcher.rb
+- lib/active_record_block_matchers/strategies.rb
+- lib/active_record_block_matchers/strategies/id_strategy.rb
+- lib/active_record_block_matchers/strategies/timestamp_strategy.rb
 - lib/active_record_block_matchers/version.rb
 homepage: https://github.com/nwallace/active_record_block_matchers
 licenses: