usable 3.6.2 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e54cf5fe16514640297183af2af12a092aaf91a6
-  data.tar.gz: f709d8c6daec561b606ab642e87883a83a7d17b1
+  metadata.gz: 85a5d98a29cbcaf36c27e6d3a6589eaf70634d70
+  data.tar.gz: 7870c49de78b222deef406fb651fab8699b31af3
 SHA512:
-  metadata.gz: eed3a4121398ecdf306c1bef04d04e9702d0cde1a3f3e34b9895eeaa6d9721d76b0881ec82ff47078d4f8d3edd02936c6d311c0365b6252558e376df9f86e399
-  data.tar.gz: 70c4103c6acdedadf2c8c56ed078bcdf813e4bc33d33dba2aeb2ad5e9ffcad2debea3df677db82071f34a62dfe823e02da7d8d42e97b08a6bc310709c2732378
+  metadata.gz: a08a319b8131e5c14aca95d31c35694ff7092723954151a7c459659c49ae3b1968446ba36842e5291c90c4ae9379c5592d3ebae8c099a87f10dbca431f5485c9
+  data.tar.gz: f509d164aa06ee5cc710be5ce6f3a5b15234a80bd3377be0b9b7f1e3c8844c980e088c380e9d7d9c3ca8fb5a745a137189e4751e6dc3a384894e065bc5862dac

data/lib/usable/version.rb

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

data/lib/usable.rb

@@ -63,11 +63,27 @@ module Usable
     extended_constants << base unless Usable.frozen?
   end
 
-  def inherited(base)
+  def self.copy_usables(context, recipient)
     unless Usable.frozen?
-      base.usables += usables
-      Usable.extended_constants << base
+      recipient.usables += context.usables
+      Usable.extended_constants << recipient
     end
+  end
+
+  def inherited(base)
+    Usable.copy_usables(self, base)
+    super
+  end
+
+  def extended(base)
+    base.extend(Usable) unless base.respond_to?(:usables)
+    Usable.copy_usables(self, base)
+    super
+  end
+
+  def included(base)
+    base.extend(Usable) unless base.respond_to?(:usables)
+    Usable.copy_usables(self, base)
     super
   end
 

data/usable.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ridiculous/usable"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").keep_if { |f| f =~ /usable/ and f !~ /spec\// }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.7.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,18 +65,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/usable.rb
 - lib/usable/config.rb
 - lib/usable/config_multi.rb

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem
-.byebug_history

data/.rspec

@@ -1 +0,0 @@
---color

data/.ruby-gemset

@@ -1 +0,0 @@
-usable

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.4.0

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.5
-  - 2.3.3
-  - 2.4.0
-before_install: gem install bundler -v 1.10.5

data/CHANGELOG.md

@@ -1,69 +0,0 @@
-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)
-=================
-
-* Fix issue with trying to modify Usable.extended_constants when freezing Usable because it may eager-load subclasses of a class that extends Usable
-
-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)
-=================
-
-* FIX - Can marshal Usable configs
-* NEW - Track extended modules and constants so they can be eagerloaded and frozen in certain environments
-
-3.4.0 (12/22/2016)
-==================
-
-* FIX - Copying usable attributes from a module to class/module works as expected
-* NEW - Pass `only: :constants` when mounting a module to import just the constants from a module
-
-3.3.0 (12/4/2016)
-=================
-
-* FIX - `Usable::ModExtender` doesn't require the target to be "usable"
-* NEW - `Usable::Struct(a: :b)` creates value classes with defaults (optional `require 'usable/struct'`)
-* NEW - `usables.merge` converts usables to a hash and merges w/ the other
-* NEW - Usable::Config#initialize takes a hash to set the initial attributes
-* NEW - Usable politely defines `.config(&block)`
-* FIX - `usables.freeze` to also freeze `@spec` so errors are raised when modifying
-
-3.2 (12/1/2016)
-===============
-
-* Improve performance of reads by defining usable attributes as methods
-* `usables._spec` is now `usables.spec`
-
-3.1 (11/30/2016)
-================
-
-* Convert +usables+ to a hash with +to_h+
-
-3.0 (11/4/2016)
-===============
-
-* Multiple mods can be given to +usable+ simultaneously
-* The +usables+ method no longer accepts a block (for performance reasons)
-* Fix bug in Config#method_missing that was swallowing errors
-* Fix bug in scoping Instance and Class method mods to the target module
-
-2.2.1 (10/14/2016)
-==================
-
-* Usable config is copied correctly when extending a usable module
-
-2.2.0 (9/30/2016)
-==================
-
-* [[PR #6](https://github.com/ridiculous/usable/pull/6))] Config options accept blocks that will be lazy loaded once and memoized for future calls
-* [[Issue #4](https://github.com/ridiculous/usable/issues/4)] Fix bug in `Config#respond_to_missing?`
-

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in usable.gemspec
-gemspec
-
-if RUBY_VERSION >= '2.0'
-  # gem 'object_tracker'
-  gem 'byebug'
-end
-

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Ryan Buckley
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/README.md

@@ -1,219 +0,0 @@
-# Usable [![Gem Version](https://badge.fury.io/rb/usable.svg)](http://badge.fury.io/rb/usable) [![Build Status](https://travis-ci.org/ridiculous/usable.svg)](https://travis-ci.org/ridiculous/usable) [![Code Climate](https://codeclimate.com/github/ridiculous/usable/badges/gpa.svg)](https://codeclimate.com/github/ridiculous/usable)
-
-Usable provides an elegant way to mount and configure your modules. Class level settings can be configured on a per module basis,
-available to both the module and including class. Allows you to include only the methods you want. 
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'usable'
-```
-
-## Usage
-
-Configure a module to have "usable" defaults:
-```ruby
-module VersionMixin
-  extend Usable
-
-  config do
-    max_versions 25
-    table_name 'versions'
-    observer { Class.new }
-  end
-  
-  def save_version
-    "Saving #{usables.max_versions} #{usables.table_name}"
-  end
-
-  def destroy_version
-    "Deleting versions from #{usables.table_name}"
-  end
-end
-```
-
-Include the module into a class using `usable`, which will copy over the configs:
-```ruby
-class Model
-  extend Usable
-
-  usable VersionMixin, only: :save_version do
-    max_versions 10
-  end
-
-  def save
-    save_version
-  end
-end
-
-model = Model.new
-model.save_version         # => "Saving 10 versions"
-model.destroy_version      # => NoMethodError: undefined method `destroy_version' for #<Model:...
-model.usables.max_versions # => 10
-model.usables.table_name   # => "version"
-```
-
-`Model` now has a `#save_versions` method but no `#destroy_version` method. Usable has effectively mixed in the given module
-using `include`. Ruby 2+ offers the `prepend` method, which can be used instead by specifying it as the `:method` option:
-
-```ruby
-Model.usable VersionMixin, method: :prepend
-```
-
-A usable module can also be extended onto a class with `method: :extend`
-
-Usable reserves the `:only` and `:method` keys. All other keys in the given hash are defined as config settings. If you really
-want to define a config on the target class with one of these names, you can simply define them in the block:
-
-```ruby
-Model.usable VersionMixin, only: [:save_version] do
-  only "Will be set on `Model.usables.only` and namespaced under `Model.usables.version_mixin.only`"
-end
-```
-
-## Configuring Modules
-
-Configuration settings defined on a "usable" module will be copied to the including class. Usable defines
-a `config` method on extended modules (alias for `usables`) to use for setting default configuration options:
-
-```ruby
-module Mixin
-  extend Usable
-  config.language = :en
-  config do
-    country 'US'
-    state 'Hawaii'
-    census({
-      population: 1_400_00,
-      daily_visitors: 218_150
-    })
-  end
-end
-
-Model.usable Mixin
-Model.usables[:state]                 # => 'Hawaii'
-Model.usables.census[:daily_visitors] # => 218150
-```
-
-## Confidently calling methods
-
-We should all be writing [confident code](http://www.confidentruby.com/), which is why you might want to call configurable
-methods through the `usable_method` class and instance method. Methods passed in with the `:only` option
-will _always_ return `nil` when called. Thus, the confidence.
-
-Here's the same example as above, rewritten to call methods through the Usable interface:
-
-```ruby
-Model.usable_method(model, :save_version).call    # => "Saving up to 10 versions to custom_versions"
-model.usable_method(:save_version).call           # => "Saving up to 10 versions to custom_versions"
-Model.usable_method(model, :destroy_version).call # => nil
-```
-
-## Module Naming Conventions
-
-Modules with the following names found within the target module's namespace will be automatically used.
-
-* `ClassMethods`
-* `InstanceMethods`
-
-## Notes
-
-If the given module is modified by the `:only` option, then Usable will duplicate the module so that it doesn't mutate
-it globally. Duplicating a module returns an anonymous module. But anonymous mods in the ancestor list can be confusing.
-So Usable gives the modified module a name, which is the same name as the original module but with "Used" appended.
-
-```ruby
-Mixin => MixinUsed
-```
-
-## Tips and Tricks
-
-#### __since 3.6__
-
-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
-```
-
-#### __since 3.4__
-
-Import just a module's constants:
-
-```ruby
-usable ExampleMod, only: :constants
-```
-
-Currently works with `usable ExampleMod, only: []` since version 2.0
-
-#### __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:
-
-```ruby
-class Route < Usable::Struct(paths: %w[api v2 v3])
-end
-
-Route.usables.to_h          # => {:paths=>["api", "v2", "v3"]}
-Route.new.paths             # => ["api", "v2", "v3"] 
-Route.new(paths: nil).paths # => nil
-```
-
-#### __since version 2.0__
-
-When usable modules define the same config setting, the last one mounted takes precedence. Fortunately,
-Usable also "stacks" config settings by namespacing them:
-
-```ruby
-module Robot
-  extend Usable
-  config do
-    speak 'beep bop'
-  end
-end
-
-module Human
-  extend Usable
-  config do
-    speak 'Hello'
-  end
-end
-
-class User
-  extend Usable
-  usable Human, Robot
-end
-
-User.usables.speak       # => "beep bop"
-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.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ridiculous/usable.
-

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-begin
-  require 'rspec/scaffold'
-rescue LoadError
-  nil
-end
-
-RSpec::Core::RakeTask.new(:spec)
-task default: :spec

data/bin/console

@@ -1,99 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "usable"
-require "usable/struct"
-require "byebug"
-require "irb"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-module VersionMixin
-  def save_version
-    "Saving up to #{usables.max_versions} versions to #{usables.table_name}"
-  end
-
-  def destroy_version
-    "Deleting versions from #{usables.table_name}"
-  end
-end
-
-module Mixin
-  extend Usable
-  config.language = :en
-  config do
-    country 'US'
-    state 'Hawaii'
-    census({
-             population: 1_400_00,
-             daily_visitors: 218_150
-           })
-  end
-
-  def name
-    "defined by Mixin"
-  end
-end
-
-class Model
-  extend Usable
-
-  usable VersionMixin, only: :save_version do
-    max_versions 10
-    table_name 'custom_versions'
-  end
-
-  def save
-    usable_method(:save_version).call
-  end
-end
-
-module PersistenceOverride
-  def save
-    'nope'
-  end
-end
-
-module Nested
-  module Extension
-    def go
-      'going'
-    end
-  end
-end
-
-class Example
-  extend Usable
-  usable Mixin
-  usable VersionMixin do
-    max_versions 10
-    model { Model }
-  end
-  usable Nested::Extension
-end
-
-Model.usable PersistenceOverride, method: 'prepend'
-
-def run_tests(subject)
-  if subject.usables.instance_variable_get(:@lazy_loads).to_a != [:model]
-    puts "Test @lazy_loads FAILED! Expected: #{[:model]}, Actual: #{subject.usables.instance_variable_get(:@lazy_loads)}"
-  end
-  if subject.usables.model != Model
-    puts "Test #model FAILED! Expected: #{Model}, Actual: #{subject.usables.model}"
-  end
-  if subject.usables.max_versions != 10
-    puts "Test #max_version FAILED! Expected: #{10}, Actual: #{subject.usables.max_versions}"
-  end
-  if subject.usables.model.new.save != 'nope'
-    puts "Test #save FAILED! Expected: 'nope', Actual: #{subject.usables.model.new.save}"
-  end
-end
-
-run_tests Example
-
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here