state_of_the_nation 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cc3e890bee0ef29ba0095890cadf503ad9975b5
-  data.tar.gz: 3ccae7dc38f6c533598f6fe3c89e755e4b5373a1
+  metadata.gz: 611580ac0c208f088555adadcd019dc5a6b424c0
+  data.tar.gz: f1d1819db563048a4b7a980dbe9db17b72989735
 SHA512:
-  metadata.gz: 58bb0d7aacddcbcbf39d4eca1d0640b8639772846a76317c8608bf908c00b7cb5e51551b3004991f90e2316b321e83ad5067242e310f75207348c0c0965cfd3d
-  data.tar.gz: acbf4ad6533efab8b16b74eb69bb036785f46e7b54269bc1278cc11a2affe17e8a3396863f6c02ec2b5ad9efbf9f729fa8b602c078eaeb15d28c3966c3bb4719
+  metadata.gz: 71c4a3084eeae10dae78e09c1139132671d3d5e5bafe47f4f72deaeac8ecbcb0543d6d10f80d77166ea47ea7ec74d1b275ebf44390f1639383da1c830cb6896e
+  data.tar.gz: aec17ea9744fa0e7dc764944f4084922a4d4e2bed263892273047077a277d21936c36dc4d397057e2bbf00dff8ad2f7a0e81610a25a6bcdaf606bb3ec9402c26

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in state_of_the_nation.gemspec
 gemspec
+
+gem 'sqlite3', '~> 1.3.6'

data/README.md

@@ -2,9 +2,11 @@
 
 [![Build Status](https://travis-ci.org/intercom/state_of_the_nation.svg?branch=master)](https://travis-ci.org/intercom/state_of_the_nation)
 
-StateOfTheNation makes modeling state that changes over time easy with ActiveRecord, allowing you to query the active value at any point in time, as well as ensure that your records don't overlap at any point.
+StateOfTheNation helps model data whose _active_ state changes over time. It provides out-of-the-box query methods to locate the record or records active at any moment. Optionally, it also enforces _uniquely_ active constraints at the application level – ensuring that only one record in a collection is active at once.
 
-Take for example modeling the history of elected officials in the United States Government where multiple Senators and only one President may be "active" for any point in time. Modeling this with StateOfTheNation is easy like so:
+## Example
+
+Take elected officials in the US Government: multiple Senators are in office (i.e. active) at any point in time, but there's only one President.
 
 ```ruby
 class Country < ActiveRecord::Base
@@ -25,8 +27,6 @@ class Senator < ActiveRecord::Base
   belongs_to :country
   considered_active.from(:entered_office_at).until(:left_office_at)
 end
-
-
 ```
 
 With this collection of models we can easy record and query the list of elected officials at any point in time, and be confident that any new records that we create don't collide.
@@ -34,43 +34,42 @@ With this collection of models we can easy record and query the list of elected
 ```ruby
 
 usa = Country.create(name: "United States of America")
-obama = usa.presidents.create!(entered_office_at: Date.new(2009, 1, 20), left_office_at: nil)
-
-wyden = usa.senators.create!(entered_office_at: Date.new(1996, 2, 6), left_office_at: nil, name: "Ron Wyden")
-boxer = usa.senators.create!(entered_office_at: Date.new(1993, 1, 3), left_office_at: nil, name: "Barbara Boxer")
+obama = usa.presidents.create!(name: "Barack Obama", entered_office_at: Date.new(2009, 1, 20))
 
-usa.active_president(Date.new(2015, 1, 1)) 
+usa.senators.create!(name: "Ron Wyden", entered_office_at: Date.new(1996, 2, 6))
+usa.senators.create!(name: "Barbara Boxer", entered_office_at: Date.new(1993, 1, 3))
+usa.senators.create!(name: "Alan Cranston", entered_office_at: Date.new(1969, 1, 3), left_office_at: Date.new(1993, 1, 3))
 
-# => President(id: 1, name: "Barack Obama")
+usa.active_president(Date.new(2015))
+# => President(id: 1, name: "Barack Obama", …)
 
-usa.active_senators(Date.new(2015, 1, 1))
-# => [
-# Senator(id: 1, name: "Ron Wyden"),
-# Senator(id: 2, name: "Barbara Boxer")
-# ...
-# ]
+obama.active?
+#=> true
 
+usa.active_senators(Date.new(2015))
+# => [Senator(id: 1, name: "Ron Wyden", …), Senator(id: 2, name: "Barbara Boxer", …)]
 
+usa.presidents.create!(name: "Mitt Romney", entered_office_at: Date.new(2013, 1, 20))
+# => StateOfTheNation::ConflictError
 ```
+
 ## IdentityCache Support
 
-StateOfTheNation optionally supports fetching child records out of an IdentityCache cache instead of reading directly from the SQL table. 
+StateOfTheNation optionally supports fetching records through [IdentityCache](https://github.com/Shopify/identity_cache) instead of reading directly from the database.
 
-For example if the Country model uses IdentityCache to cache the has_many relationship to President, you can make StateOfTheNation use the IdentityCache methods by calling `.with_identity_cache` on your `has_active` or `has_uniquely_active` definitions like so.
+For example if the `Country` model uses IdentityCache to cache the `has_many` relationship to `President`, you can instruct StateOfTheNation to fetch from the cache by calling `.with_identity_cache` on your `has_active` or `has_uniquely_active` definitions:
 
 ```ruby
 class Country
   include IdentityCache
   include StateOfTheNation
-  
+
   has_many(:presidents)
   cache_has_many(:presidents)
   has_uniquely_active(:president).with_identity_cache
 end
 ```
 
-Now every time the `Country#active_president` method is called StateOfTheNation will read through the IdentityCache methods and avoid a SELECT operation if possible.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -96,4 +95,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/intercom/state_of_the_nation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
-

data/lib/state_of_the_nation.rb

@@ -1,4 +1,5 @@
-require "state_of_the_nation/errors"
+require "state_of_the_nation/errors/conflict_error"
+require "state_of_the_nation/errors/configuration_error"
 require "state_of_the_nation/version"
 require "state_of_the_nation/query_string"
 require "active_support/all"
@@ -105,13 +106,13 @@ module StateOfTheNation
 
   def prevent_active_collisions
     return unless prevent_multiple_active
-    raise ConfigurationError.new if bad_configuration?
+    raise ConfigurationError if bad_configuration?
     return unless model.present?
 
-    raise ConflictError.new if other_record_active_in_range?
+    raise ConflictError.new(self, other_records_active_in_range) if other_records_active_in_range.any?
   end
 
-  def other_record_active_in_range?
+  def other_records_active_in_range
     records = self.class.where(parent_association => model)
     # all records scoped to the model (e.g. all subscriptions for a customer)
 
@@ -126,7 +127,7 @@ module StateOfTheNation
     # find competing records which *finish* being active AFTER this record *starts* being active
     # (or ones which are not set to finish being active)
 
-    records.any?
+    records
   end
 
   def model

data/lib/state_of_the_nation/{errors.rb → errors/configuration_error.rb}

@@ -1,4 +1,3 @@
 module StateOfTheNation
   ConfigurationError = Class.new(StandardError)
-  ConflictError = Class.new(StandardError)
 end

data/lib/state_of_the_nation/errors/conflict_error.rb

@@ -0,0 +1,16 @@
+module StateOfTheNation
+  class ConflictError < StandardError
+    def initialize(record, conflicting_records)
+      super(<<-MSG.strip_heredoc)
+        Attempted to commit record
+
+          #{record.inspect}
+
+        But encountered a conflict with timestamps on the following records
+
+          #{conflicting_records.map { |record| "- #{record.inspect}" }.join("\n")}
+
+      MSG
+    end
+  end
+end

data/lib/state_of_the_nation/version.rb

@@ -1,3 +1,3 @@
 module StateOfTheNation
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/state_of_the_nation.gemspec

@@ -24,14 +24,16 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "mysql"
+  # spec.add_development_dependency "mysql"
   spec.add_development_dependency "pg"
+  spec.add_development_dependency "pry", "0.12.2"
+  spec.add_development_dependency "rb-readline"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "shoulda-matchers"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", "1.4.0"
 
-  spec.add_runtime_dependency "activesupport", ">= 4.0.0"
-  spec.add_runtime_dependency "activerecord", ">= 4.0.0"
+  spec.add_runtime_dependency "activesupport", ">= 5.0.0"
+  spec.add_runtime_dependency "activerecord", ">= 5.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_of_the_nation
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Patrick O'Doherty
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2019-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -127,44 +141,44 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
 description: State of the Nation makes modeling object history easy.
 email:
 - patrick@intercom.io
@@ -183,7 +197,8 @@ files:
 - bin/console
 - bin/setup
 - lib/state_of_the_nation.rb
-- lib/state_of_the_nation/errors.rb
+- lib/state_of_the_nation/errors/configuration_error.rb
+- lib/state_of_the_nation/errors/conflict_error.rb
 - lib/state_of_the_nation/query_string.rb
 - lib/state_of_the_nation/version.rb
 - state_of_the_nation.gemspec
@@ -207,9 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: An easy way to model state that changes over time with ActiveRecord
 test_files: []
-has_rdoc: