state_of_the_nation 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72a6818e2ace1bf60670b197c86a09d4dc925ed5
-  data.tar.gz: bb28045766320c669452430634fe58cfda921304
+  metadata.gz: f860e2aab34bc7885c2de966a79665080b07179e
+  data.tar.gz: 349d751236999d5bc792d24a8f1ebc8b4cdace48
 SHA512:
-  metadata.gz: ec3602725f892040ae4c022a68b85b0a35e8efc5c3126818769a390ce6fc253dd8d9c3bf7db2dbbed0668c38ff15f1044d139c1da26d4d15827a324bd11c963c
-  data.tar.gz: a2afdc5264ef33b14dfe0a82f1c5ee03c260174bca002c634663ac885dbf0c60731d028757a3ce8be6b922ae341c2c7c610f998851be28bfe4a447d9b5056368
+  metadata.gz: 66d9caa5d36028657ef95c22e2eea1083d0f7750735c6763fca06e9fbd1143c2757a2dc30ae2950e89932d20e16f66b488ed787abc3fef1be028ca0c02689850
+  data.tar.gz: e68a543d34ee71d55167a9e1db1a7857a916194f9349fcbc21f5a7615d404458b48814cec0df528459b3ca11eb0dab15e89e3fed940af4409da077abdfc228c8

data/README.md

@@ -52,6 +52,25 @@ usa.active_senators(Date.new(2015, 1, 1))
 
 
 ```
+## IdentityCache Support
+
+StateOfTheNation optionally supports fetching child records out of an IdentityCache cache instead of reading directly from the SQL table. 
+
+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.
+
+```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:
@@ -76,5 +95,5 @@ 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](contributor-covenant.org) code of conduct.
+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

@@ -24,6 +24,7 @@ module StateOfTheNation
         @finish_key = finish_key
 
         define_method "active?" do |time = Time.now.utc|
+          time = should_round_timestamps? ? time.round : time
           (finish.blank? || finish > time) && start <= time
         end
 
@@ -36,17 +37,32 @@ module StateOfTheNation
     end
 
     def has_active(association_plural)
-      add_child_methods(plural: association_plural, single: false)
+      @association_plural = association_plural
+      add_child_methods(plural: @association_plural, single: false, with_identity_cache: false)
+
+      def with_identity_cache
+        add_child_methods(plural: @association_plural, single: false, with_identity_cache: true)
+        self
+      end
+
+      self
     end
 
     def has_uniquely_active(association_singular)
-      association_plural = association_singular.to_s.pluralize
-      add_child_methods(plural: association_plural, single: true)
+      @association_plural = association_singular.to_s.pluralize
+      add_child_methods(plural: @association_plural, single: true, with_identity_cache: false)
+
+      def with_identity_cache
+        add_child_methods(plural: @association_plural, single: true, with_identity_cache: true)
+        self
+      end
+
+      self
     end
 
     private
 
-    def add_child_methods(plural:, single:)
+    def add_child_methods(plural:, single:, with_identity_cache:)
       child_class = self.reflect_on_association(plural).klass
       name = self.name.demodulize.underscore.to_sym
       child_class.instance_variable_set(:@parent_association, name)
@@ -55,10 +71,25 @@ module StateOfTheNation
       association = single ? plural.singularize : plural
 
       define_method "active_#{association}" do |time = Time.now.utc|
-        collection = send(plural.to_sym).select { |r| r.send("active?", time) }
+        time = should_round_timestamps? ? time.round : time
+        method_name = with_identity_cache ? "fetch_#{plural}" : plural.to_sym
+        collection = send(method_name).select { |r| r.send("active?", time) }
         single ? collection.first : collection
       end
     end
+
+    def should_round_timestamps?
+      # MySQL datetime fields do not support millisecond resolution while
+      # PostgreSQL's do. To prevent issues with near identical timestamps not
+      # comparing as expected in .active? methods we'll choose the resolution
+      # appropriate for the database adapter backing the model.
+      case self.connection.adapter_name
+      when /PostgreSQL/
+        false
+      else
+        true
+      end
+    end
   end
 
   private
@@ -131,4 +162,8 @@ module StateOfTheNation
   def finish_key
     self.class.finish_key
   end
+
+  def should_round_timestamps?
+    self.class.send(:should_round_timestamps?)
+  end
 end

data/lib/state_of_the_nation/version.rb

@@ -1,3 +1,3 @@
 module StateOfTheNation
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_of_the_nation
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Patrick O'Doherty
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler