usable 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d621f72fd2963cd0ed5e82ca9a52458a412ac982
-  data.tar.gz: 870b80be3fa3fb74e178ad5204b806a78c37a3a8
+  metadata.gz: 248031af23fb6b13a611f3ad52aed2b485e13042
+  data.tar.gz: 7d43e66f04750393514a83e5cf6af8950aecd242
 SHA512:
-  metadata.gz: 15e90259cd4528fbedd199d8b2024622d8b93ef4f534e65de55b5aae5ef11e694cdb30ed0d73a542fff333f5cba796dae6488b34118f22bae25e591d952a5ced
-  data.tar.gz: 9bfb0cbe38beb7b8e5b7d76cbb8395cd02f1f552a8abe0417d908546b1df38ae186537888dfc9a9ebd78a63495ea4c97128423421091e4cb7e1a3ce8ba49db71
+  metadata.gz: f33b9468b3368318c1eb79d692e168a05de74378307e8c8006c162511f2d6636ebf9f0f186c16ea85f08e63e2217212e110a7edc0328069d9c3667c40ffb7201
+  data.tar.gz: ca0191741f597b8c6c948135cc121c906a36ea6586e5d1a3aea6ac36d3a6b645162eace8e908675788be19cca9d895135b646be6504ea5022494e7cac1f93296

data/README.md

@@ -1,29 +1,33 @@
 # 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)
 
-An elegant way to mount and configure your modules. Usable gives you control over which methods are included, and a simple
-interface to help you call dynamic methods with confidence.
+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. 
 
 ```ruby
 module VersionMixin
+  extend Usable
+  usables[:max_versions] = 25
+  usables[:table_name] = 'versions'
+  
   def save_version
-    "Saving up to #{self.class.usable_config.max_versions} versions to #{self.class.usable_config.table_name}"
+    "Saving up to #{usables.max_versions} versions to #{usables.table_name}"
   end
 
   def destroy_version
-    "Deleting versions from #{self.class.usable_config.table_name}"
+    "Deleting versions from #{usables.table_name}"
   end
 end
 
 class Model
   extend Usable
 
-  usable VersionMixin, only: :save_version do |config|
-    config.max_versions = 10
-    config.table_name = 'custom_versions'
+  usable VersionMixin, only: :save_version do
+    max_versions 10
+    table_name 'custom_versions'
   end
 
   def save
-    self.class.usable_method(self, :save_version).call
+    usable_method(:save_version).call
   end
 end
 
@@ -38,8 +42,8 @@ using `include`. Ruby 2+ offers the `prepend` method, which can be used instead
 Model.usable VersionMixin, method: :prepend
 ```
 
-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:
+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 |config|
@@ -50,13 +54,14 @@ end
 ## 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 level function. Methods passed in with the `:only` option
+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
 ```
 

data/bin/console

@@ -12,15 +12,18 @@ require "usable"
 
 module VersionMixin
   def save_version
-    "Saving up to #{self.class.usable_config.max_versions} versions to #{self.class.usable_config.table_name}"
+    "Saving up to #{usables.max_versions} versions to #{usables.table_name}"
   end
 
   def destroy_version
-    "Deleting versions from #{self.class.usable_config.table_name}"
+    "Deleting versions from #{usables.table_name}"
   end
 end
 
 module Mixin
+  extend Usable
+  usables[:max_versions] = 20
+
   def name
     "defined by Mixin"
   end
@@ -44,13 +47,13 @@ end
 class Model
   extend Usable
 
-  usable VersionMixin, only: :save_version do |config|
-    config.max_versions = 10
-    config.table_name = 'custom_versions'
+  usable VersionMixin, only: :save_version do
+    max_versions 10
+    table_name 'custom_versions'
   end
 
   def save
-    self.class.usable_method(self, :save_version).call
+    usable_method(:save_version).call
   end
 end
 
@@ -60,10 +63,21 @@ module PersistenceOverride
   end
 end
 
+module Nested
+  module Extension
+    def go
+      'going'
+    end
+  end
+end
+
 class Example
   extend Usable
   usable Mixin
-  usable VersionMixin, max_versions: 10
+  usable VersionMixin do
+    max_versions 10
+  end
+  usable Nested::Extension
 end
 
 Model.usable PersistenceOverride, method: 'prepend'

data/lib/usable/config.rb

@@ -1,27 +1,59 @@
 module Usable
-  class Config < OpenStruct
-    def modules
-      @modules ||= []
+  class Config
+    # = Class
+    # Store and manage configuration settings. Keep methods to a minimum since this class relies on method_missing to read
+    # and write to the underlying @spec object
+    #
+
+    def available_methods
+      modules.each_with_object(Hash.new(Null.instance_method(:default_method))) do |mod, result|
+        mod.instance_methods.each do |method_name|
+          result[method_name] = mod.instance_method method_name
+        end
+      end
     end
 
     def add_module(mod)
       modules << mod
     end
 
-    def available_methods
-      modules.each_with_object(Hash.new(default_method)) do |mod, result|
-        mod.instance_methods.each do |method_name|
-          result[method_name] = mod.instance_method method_name
-        end
+    def modules
+      @modules ||= []
+    end
+
+    def each(&block)
+      @spec.to_h.each(&block)
+    end
+
+    def spec(key, value = nil)
+      @spec ||= OpenStruct.new
+      if value
+        @spec[key.to_s.tr('=', '')] = value
+      else
+        @spec[key]
       end
     end
 
-    def default_method
-      Null.instance_method(:default_method)
+    def [](key)
+      spec key
+    end
+
+    def []=(key, val)
+      spec key, val
+    end
+
+    def method_missing(method_name, *args)
+      spec method_name, *args
+    rescue
+      super
+    end
+
+    def respond_to_missing?(method_name, _private = false)
+      method_name.to_s.end_with?('=') || spec.respond_to?(method_name)
     end
 
     module Null
-      def default_method(*, &block)
+      def default_method(*, &_block)
       end
     end
   end

data/lib/usable/mod_extender.rb

@@ -30,7 +30,7 @@ module Usable
       end
     end
 
-    # @description Directly include a module whose methods you want made available in +usable_config.available_methods+
+    # @description Directly include a module whose methods you want made available in +usables.available_methods+
     #   Gives the module a name when including so that it shows up properly in the list of ancestors
     def use!(target)
       override
@@ -39,14 +39,14 @@ module Usable
         target.send :remove_const, const_name if target.const_defined? const_name, false
         target.const_set const_name, copy
       end
-      target.usable_config.modules << copy
+      target.usables.add_module copy
       target.send options[:method], copy
     end
 
     # @description Includes or prepends the original module onto the target
     def use_original!(target)
       return unless has_spec?
-      target.usable_config.modules << mod
+      target.usables.add_module mod
       target.send options[:method], mod
     end
 

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "1.4.0".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/usable.rb

@@ -5,10 +5,35 @@ require 'usable/mod_extender'
 require 'usable/config'
 
 module Usable
-  def usable_config
-    @usable_config ||= Config.new
+
+  # @description Define an instance level version of +usables+
+  def self.extended(base)
+    base.class_eval do
+      def usables
+        self.class.usables
+      end
+
+      def usable_method(method_name)
+        self.class.usable_method(self, method_name)
+      end
+    end
+    unless base.is_a? Class
+      base.instance_eval do
+        def config(&block)
+          usables(&block)
+        end unless defined? config
+      end
+    end
   end
-  attr_writer :usable_config
+
+  # @description Read and write configuration options
+  def usables
+    @usables ||= Config.new
+    return @usables unless block_given?
+    @usables.instance_eval &Proc.new
+  end
+
+  attr_writer :usables
 
   # @description Configures the +available_methods+ of a module using the given options or block and then includes it on
   #   the target class. Checks if there is a module named UsableSpec within the given mods namespace and uses the instance
@@ -18,8 +43,8 @@ module Usable
   #
   #   class Example
   #     extend Usable
-  #     usable Mixin, only: [:foo, :bar] do |config|
-  #       config.baz = "Available as `Example.usable_config.baz`"
+  #     usable Mixin, only: [:foo, :bar] do
+  #       baz "Available as `Example.usables.baz` or `Example.usables.mixin.baz`"
   #     end
   #   end
   #
@@ -32,13 +57,22 @@ module Usable
   # @option [Array,Symbol]  :only Limit which methods are copied from the module
   # @option [String,Symbol] :method (:include) The method to use for including the module
   # @return [ModExtender] containing the original and modified module
-  def usable(mod, options = {})
+  def usable(mod, options = {}, &block)
     usable_options = { only: options.delete(:only), method: options.delete(:method) }
-    if mod.respond_to? :usable_config
-      mod.usable_config.to_h.each { |k, v| usable_config.public_send "#{k}=", v }
+    # Define settings on @usables and on the scoped @usables
+    scope = Config.new
+    if mod.name
+      scope_name = mod.name.split('::').last.gsub(/\B([A-Z])([a-z_0-9])/, '_\1\2').downcase
+      usables[scope_name] = scope
+    end
+    if mod.respond_to? :usables
+      mod.usables.each do |k, v|
+        [scope, usables].each { |x| x.spec k, v }
+      end
     end
-    options.each { |k, v| usable_config.public_send "#{k}=", v }
-    yield usable_config if block_given?
+    [scope, usables].each { |x| options.each { |k, v| x[k] = v } }
+    [scope, usables].each { |x| x.instance_eval &block } if block_given?
+    # Include module
     mod_ext = ModExtender.new mod, usable_options
     mod_ext.use! self
     mod_ext.use_original! self
@@ -48,6 +82,6 @@ module Usable
 
   # @return [Method] bound to the given -context-
   def usable_method(context, method_name)
-    usable_config.available_methods[method_name].bind(context)
+    usables.available_methods[method_name].bind(context)
   end
 end

data/usable.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["arebuckley@gmail.com"]
 
   spec.summary       = %q{Mounts and configures modules}
-  spec.description   = %q{An elegant way to mount and configure your modules. Usable gives you control over which methods are included.}
+  spec.description   = %q{Usable provides an elegant way to mount and configure your modules}
   spec.homepage      = "https://github.com/ridiculous/usable"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,8 +58,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-description: An elegant way to mount and configure your modules. Usable gives you
-  control over which methods are included.
+description: Usable provides an elegant way to mount and configure your modules
 email:
 - arebuckley@gmail.com
 executables: []