usable 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfe5fb1828e71f868ce8e7e5b6dd28c53ae83297
-  data.tar.gz: c805110e6ce80fe03dd10121a02c4ca4642f0e97
+  metadata.gz: acf388167647552fa9165b44809ff9bdd6476656
+  data.tar.gz: 8bb5bec7ddaab0870a58559b856da4bf833f749d
 SHA512:
-  metadata.gz: 38054c2946e9a2a35462955f718a7884dcb62ec6a16e95e44fc17ed7b9a386c52be3fd2a7500b1e2c6603bae0f919426b0c2b4e7a15c3fa0d6f284edd9689793
-  data.tar.gz: 60ec033a5d2e7d080ad387e6b564735bf0f24300a413afceb8634b198a3c51e0c3ce2d5c7bc843e052878bcb275cdc1218234d694bfc8d3204dc0b92a64b7a79
+  metadata.gz: 15ddd01992f892bbd75ba9c21996a24aa36c2de2800fbca78d15c8a737b6718151a5bf0d5b94476353f0a5c3707cd708d1818a4233917366549b7a39e3e9db0c
+  data.tar.gz: 6bfeeabc1b77aef3abf2f2d59c0886106adc7ec0eff2878146da405a9197a5f2b3dee4a15b7a586dbe6f01f079199cfcaab64c723af31f95a2c5d2d88f437f74

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.0
+ruby-2.4.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+3.6.0 (1/19/2016)
+=================
+
+* NEW - Add Rails setting `usable_config.frozen` to freeze Usable in a after initialize Railtie
+* NEW - Add inherited hook to copy usable config to subclasses
+
 3.5.0 (1/18/2016)
 =================
 

data/README.md

@@ -130,7 +130,15 @@ Mixin => MixinUsed
 
 ## Tips and Tricks
 
-#### __3.4__ _-(unreleased)_
+#### __since 3.6__
+
+Eager-load and freeze usables in production Rails environments with the `frozen` setting:
+
+```ruby
+config.usable_config.frozen = true
+```
+
+#### __since 3.4__
 
 Import just a module's constants:
 
@@ -140,7 +148,7 @@ usable ExampleMod, only: :constants
 
 Currently works with `usable ExampleMod, only: []` since version 2.0
 
-#### __since version 3.3__ _- (not required)_
+#### __since 3.3__ _- (not required)_
 The `Usable::Struct` function is available for creating value objects with defaults. If you `require "usable/struct"` the
 class function is available to create classes:
 
@@ -183,6 +191,21 @@ User.usables.human.speak # => "Hello"
 User.usables.robot.speak # => "beep bop"
 ```
 
+## Production
+
+When running in production you may want to eager-load any lazily defined attributes and freeze them, ensuring thread safety.
+Usable provides a [railtie](http://edgeguides.rubyonrails.org/configuring.html) that can be configured to freeze Usable and
+and constants extended with Usable.
+
+Enable the frozen setting:
+```ruby
+# config/production.rb
+Acme::Application.configure do
+  # Freeze all +usables+ after initialize, eager-loading any lazily defined attributes
+  config.usable_config.frozen = true
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/usable/config.rb

@@ -37,6 +37,7 @@ module Usable
 
     alias to_hash to_h
     alias marshal_dump to_h
+    alias marshal_load initialize
 
     def merge(other)
       to_h.merge(other)
@@ -77,10 +78,16 @@ module Usable
       super
     end
 
-    def marshal_load(attributes = {})
-      initialize(attributes)
+    def inspect
+      nested, locals = @spec.to_h.partition { |_, value| value.is_a?(Usable::Config) }
+      nested.map! { |key, _| [key, '{...}'] }
+      locals.concat nested
+      locals.map! { |key, v| %(@#{key}=#{v.inspect}) }
+      "<Usable::Config:0x00#{(object_id << 1).to_s(16)} #{locals.join(', ')}>"
     end
 
+    alias to_s inspect
+
     private
 
     # @note Handles the case where the value may be defined with a block, in which case it's a method

data/lib/usable/railtie.rb

@@ -1,7 +1,6 @@
 class Usable::Railtie < Rails::Railtie
-  config.after_initialize do
-    if Rails.env !~ /test|development/
-      Usable.extended_constants.map { |const| const.usables.freeze }
-    end
+  config.usable_config = Struct.new(:frozen).new(false)
+  config.after_initialize do |app|
+    Usable.freeze if app.config.usable_config.frozen
   end
 end

data/lib/usable/struct.rb

@@ -5,10 +5,6 @@ module Usable
 
       self.usables = Usable::Config.new(attributes)
 
-      define_singleton_method(:inherited) do |child|
-        child.usables = usables.clone
-      end
-
       attributes.keys.each do |key|
         define_method(key) { @attrs[key] }
         define_method("#{key}=") { |new_val| @attrs[key] = new_val }

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "3.5.0".freeze
+  VERSION = "3.6.0".freeze
 end

data/lib/usable.rb

@@ -11,6 +11,12 @@ module Usable
     @extended_constants ||= Set.new
   end
 
+  def self.freeze
+    extended_constants.each { |const| const.usables.freeze }
+    extended_constants.freeze
+    super
+  end
+
   def self.extended(base)
     if base.is_a? Class
       # Define an instance level version of +usables+
@@ -39,6 +45,12 @@ module Usable
     extended_constants << base
   end
 
+  def inherited(base)
+    base.usables += usables
+    Usable.extended_constants << base
+    super
+  end
+
   def usables
     @usables ||= Config.new
   end
@@ -98,3 +110,5 @@ module Usable
     usables.available_methods[method_name].bind(context)
   end
 end
+
+require 'usable/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Mounts and configures modules