usable 3.6.1 → 3.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65a97333f23a303a3c720b5273197c5c9233af0a
-  data.tar.gz: 7338a13fdfeabf4b929d4b3dfcfb7fdd87d1a15e
+  metadata.gz: e54cf5fe16514640297183af2af12a092aaf91a6
+  data.tar.gz: f709d8c6daec561b606ab642e87883a83a7d17b1
 SHA512:
-  metadata.gz: '097a30063e9d48dbf90053e81d7f9617cb019ed3bdae6a93a05bd11f5b2890740042d9c11d19367635e7f3795f3105cbcd2a7a8bd6fdb80aaca9ef5374cb8cca'
-  data.tar.gz: 6cd0b759bc97a406b5750a39f5d49d5f838f4ed3de190c1d869f578cd97df13e60014016e40980b2e9859e00ee2fa93bc34f3e0f7889d468a5044afc686b88e2
+  metadata.gz: eed3a4121398ecdf306c1bef04d04e9702d0cde1a3f3e34b9895eeaa6d9721d76b0881ec82ff47078d4f8d3edd02936c6d311c0365b6252558e376df9f86e399
+  data.tar.gz: 70c4103c6acdedadf2c8c56ed078bcdf813e4bc33d33dba2aeb2ad5e9ffcad2debea3df677db82071f34a62dfe823e02da7d8d42e97b08a6bc310709c2732378

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+3.6.2 (1/23/2016)
+=================
+
+* Update Railtie to _always_ freeze Usable _after_ `Rails.application.eager_load!`
+* Add `Usable.logger` to help debugging (default level: `Logger::ERROR`)
+
 3.6.1 (1/23/2016)
 =================
 

data/README.md

@@ -132,7 +132,8 @@ Mixin => MixinUsed
 
 #### __since 3.6__
 
-Eager-load and freeze usables in production Rails environments with the `frozen` setting:
+Eager-load and freeze usables in production Rails environments with the `frozen` setting. Note that `config.cache_classes`
+(Rails 3+) or `config.eager_load` (Rails 4+) must also be true, since it hooks into Rails' eager load process.
 
 ```ruby
 config.usable_config.frozen = true

data/lib/usable.rb

@@ -6,15 +6,32 @@ require 'usable/mod_extender'
 require 'usable/config'
 
 module Usable
+  def self.logger
+    @logger ||= begin
+      require 'logger'
+      Logger.new(STDOUT).tap do |config|
+        config.formatter = proc { |*args| "[#{name}] #{args[0]}: #{args[-1]}\n" }
+        config.level = Logger::ERROR
+      end
+    end
+  end
+
+  def self.logger=(obj)
+    @logger = obj
+  end
+
   # Keep track of extended classes and modules so we can freeze all usables on boot in production environments
   def self.extended_constants
     @extended_constants ||= Set.new
   end
 
   def self.freeze
+    logger.debug { "freezing! #{extended_constants.to_a}" }
+    extended_constants
     super
+    # This may eager load classes, which is why we freeze ourselves first,
+    # so the +extended+ hook doesn't try to modify @extended_constants while we're iterating over it
     extended_constants.each { |const| const.usables.freeze }
-    extended_constants.freeze
     self
   end
 

data/lib/usable/eager_load.rb

@@ -0,0 +1,7 @@
+module Usable
+  module EagerLoad
+    def eager_load!
+      super.tap { Usable.freeze unless Usable.frozen? }
+    end
+  end
+end

data/lib/usable/railtie.rb

@@ -1,6 +1,13 @@
 class Usable::Railtie < Rails::Railtie
   config.usable_config = Struct.new(:frozen).new(false)
-  config.after_initialize do |app|
-    Usable.freeze if app.config.usable_config.frozen
+
+  # This was the only way to consistently hook into the end of the Rails eager load process. The +after_initialize+ hook works great, except when
+  # +Rails.application.eager_load!+ is called directly from a third-party gem (e.g. Resque rake task), in which case the order is not guaranteed.
+  # The solution instead is to overload +eager_load!+
+  initializer 'usable' do |app|
+    if app.config.usable_config.frozen
+      require 'usable/eager_load'
+      app.class.prepend Usable::EagerLoad
+    end
   end
 end

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "3.6.1".freeze
+  VERSION = "3.6.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.6.2
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - lib/usable/config.rb
 - lib/usable/config_multi.rb
 - lib/usable/config_register.rb
+- lib/usable/eager_load.rb
 - lib/usable/mod_extender.rb
 - lib/usable/railtie.rb
 - lib/usable/struct.rb