usable 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f7f30e1bcf362f74f31d504c1d8dcde61186cd8
-  data.tar.gz: c62e74cf53de5e985e17e5c6d80b7eb06cbb55a4
+  metadata.gz: 18d15fe43c88882ead95863b946d7ee496b37bff
+  data.tar.gz: 06d47996bebf7e130062441d55e5104f39635dbc
 SHA512:
-  metadata.gz: 56fadf0636c4eefa597f4e8f4ee0b518e21bc0ef512746160131ea248742884977b1d7f80d303256ebd80658f6f2b7fe47a9c22d439aa4adf364901051f48df1
-  data.tar.gz: 19a2ec805bb337dc7a404d2f9452812667bcac73e8742814934b91b4ae08d5017183d6c41a0a019dee4b11b17023a3a60a51c08fcc161fddde4a9170d5bc863f
+  metadata.gz: 8ffbe8e76c89a3f04eaf70dc4edc61aaa9e03f80cc06c567ec99146108515e1c2a594c7def908ac622d0483b6e90bb0f2380a309066e4c31a5cc2e836c341a2e
+  data.tar.gz: 35c77816de2bbf4a99bbd33fdc9c2754cafcc2ea3f39f0719b8b34315a3fb62cc66f885d8074df396a2b472b1cc902d76516eaca1e179ef7adc20fbd897e6c25

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+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)
 ==================
 

data/README.md

@@ -3,12 +3,16 @@
 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. 
 
+Configure a module to be usable
 ```ruby
 module VersionMixin
   extend Usable
-  config.max_versions = 25
-  config.table_name = 'versions'
-  config.model { Audit }
+
+  config do
+    max_versions 25
+    table_name 'versions'
+    observer { Class.new }
+  end
   
   def save_version
     "Saving #{usables.max_versions} #{usables.table_name}"
@@ -18,7 +22,10 @@ module VersionMixin
     "Deleting versions from #{usables.table_name}"
   end
 end
+```
 
+Include the module into a class using `usable`, which will copy over any configuration options
+```ruby
 class Model
   extend Usable
 
@@ -32,9 +39,12 @@ class Model
 end
 
 model = Model.new
-model.save_version     # => "Saving 10 versions"
-model.destroy_version  # => NoMethodError: undefined method `destroy_version' for #<Model:...
+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:
 
@@ -42,6 +52,8 @@ using `include`. Ruby 2+ offers the `prepend` method, which can be used instead
 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:
 
@@ -114,10 +126,41 @@ Add this line to your application's Gemfile:
 gem 'usable'
 ```
 
-## TODO
+## Tips and Tricks
+
+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
 
-* Support blocks for config values (e.g. `config.user { User.first }`)
+class User
+  extend Usable
+  usable Human, Robot
+end
+
+User.usables.speak       # => "beep bop"
+User.usables.human.speak # => "Hello"
+User.usables.robot.speak # => "beep bop"
+```
 
+Import just a module's constants with this little trick:
+
+```ruby
+usable ExampleMod, only: []
+```
 
 ## Development
 

data/lib/usable/config.rb

@@ -47,7 +47,7 @@ module Usable
       else
         spec method_name, *args
       end
-    rescue => e
+    rescue NoMethodError
       super
     end
 

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "2.2.1".freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/usable.rb

@@ -20,19 +20,21 @@ module Usable
         end
       end
     else
+      # Define +config+ when added to a module
       base.instance_eval do
         def config(&block)
-          usables(&block)
+          if block
+            usables.instance_eval &block
+          else
+            usables
+          end
         end unless defined? config
       end
     end
   end
 
-  # @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
@@ -54,30 +56,33 @@ 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 self
-  def usable(mod, options = {}, &block)
-    ModExtender.new(mod, only: options.delete(:only), method: options.delete(:method)).call self
-    # 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
-      scope += mod.usables
-      self.usables += mod.usables
-    end
-    # any left over -options- are considered "config" settings
-    if options
-      [scope, usables].each { |x| options.each { |k, v| x[k] = v } }
-    end
-    if block_given?
-      [scope, usables].each { |x| x.instance_eval &block }
-    end
-    if mod.const_defined?(:InstanceMethods)
-      send :include, mod.const_get(:InstanceMethods)
-    end
-    if mod.const_defined?(:ClassMethods)
-      send :extend, mod.const_get(:ClassMethods)
+  def usable(*args, &block)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    args.each do |mod|
+      ModExtender.new(mod, only: options.delete(:only), method: options.delete(:method)).call self
+      # 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
+        scope += mod.usables
+        self.usables += mod.usables
+      end
+      # any left over -options- are considered "config" settings
+      if options
+        [scope, usables].each { |x| options.each { |k, v| x[k] = v } }
+      end
+      if block_given?
+        [scope, usables].each { |x| x.instance_eval &block }
+      end
+      if mod.const_defined?(:InstanceMethods, false)
+        send :include, mod.const_get(:InstanceMethods, false)
+      end
+      if mod.const_defined?(:ClassMethods, false)
+        send :extend, mod.const_get(:ClassMethods, false)
+      end
     end
     self
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-15 00:00:00.000000000 Z
+date: 2016-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler