usable 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25b327952ba8a139e5c81f640b5d7100f6daabf5
-  data.tar.gz: 234c99e407ef28df46bb024a8656e5a1bce5c19b
+  metadata.gz: d621f72fd2963cd0ed5e82ca9a52458a412ac982
+  data.tar.gz: 870b80be3fa3fb74e178ad5204b806a78c37a3a8
 SHA512:
-  metadata.gz: ed4caf302df5b5f543f31ab9e15bae983d6366ee4c07a71eed728551e6bc22a5d96a1d25eaef5f54e9c513c0195b6773f72f2c044ee1fc49ae2fd3db81e8300d
-  data.tar.gz: b0232a418c5b063d47671ce3944ae6bb4dbbda93d3c278f32474e4595620bdb7ec9ebd8ea3c49cc11738e27d1865e96e068d6a6018c798f99435a9bb0c1f83db
+  metadata.gz: 15e90259cd4528fbedd199d8b2024622d8b93ef4f534e65de55b5aae5ef11e694cdb30ed0d73a542fff333f5cba796dae6488b34118f22bae25e591d952a5ced
+  data.tar.gz: 9bfb0cbe38beb7b8e5b7d76cbb8395cd02f1f552a8abe0417d908546b1df38ae186537888dfc9a9ebd78a63495ea4c97128423421091e4cb7e1a3ce8ba49db71

data/README.md

@@ -60,11 +60,14 @@ Model.usable_method(model, :save_version).call    # => "Saving up to 10 versions
 Model.usable_method(model, :destroy_version).call # => nil
 ```
 
-## Separate the _included_ module from the _configurable_ methods
+## Module Naming Conventions
 
-Sometimes you want to define methods on a module and have them always be included. To do this, define a module named 
-`UsableSpec` in the scope of the module you are mounting. `Usable` will detect this and use he "spec" module to configure 
-the available methods. Any naming conflicts will be resolved by giving precedence to the parent module.
+Modules with the following names found within the target module's namespace will be automatically used.
+
+`ClassMethods` - extended onto the target module.
+
+`UsableSpec` - tells usable which methods are configurable via the `:only` option. Any naming conflicts will be resolved by 
+giving precedence to the parent module.
 
 For example:
 
@@ -92,13 +95,13 @@ end
 
 class Example
   extend Usable
-  usable Mixin
+  usable Mixin, only: :from_spec
 end
 
 Example.new.from_spec   # => "can be excluded"
 Example.new.from_mixin  # => "always here"
 Example.new.name        # => "defined by Mixin"
-Example.ancestors       # => [Example, Mixin, Mixin::UsableSpec, Object, Kernel, BasicObject] (ruby -v 2.3.0)
+Example.ancestors       # => [Example, Mixin, Example::MixinUsableSpecUsed, Object, Kernel, BasicObject] (ruby -v 2.3.0)
 ```
 
 ## Notes

data/lib/usable/mod_extender.rb

@@ -1,5 +1,8 @@
 module Usable
   class ModExtender
+    SPEC = :UsableSpec
+    CLASS_MODULE = :ClassMethods
+
     attr_reader :name
     attr_accessor :copy, :mod, :options, :unwanted
 
@@ -8,7 +11,7 @@ module Usable
       @options = options
       @options[:method] ||= :include
       if has_spec?
-        @copy = mod.const_get(:UsableSpec)
+        @copy = mod.const_get SPEC
         @name = "#{mod.name}UsableSpec"
       else
         @copy = mod
@@ -40,15 +43,21 @@ module Usable
       target.send options[:method], copy
     end
 
-    # @description Sends the method to the target with the original module
+    # @description Includes or prepends the original module onto the target
     def use_original!(target)
       return unless has_spec?
       target.usable_config.modules << mod
       target.send options[:method], mod
     end
 
+    # @description Extends the target with the module's ClassMethod mod
+    def use_class_methods!(target)
+      return unless mod.const_defined? CLASS_MODULE
+      target.extend mod.const_get CLASS_MODULE
+    end
+
     def has_spec?
-      mod.const_defined?(:UsableSpec)
+      mod.const_defined? SPEC
     end
 
     def mod_name

data/lib/usable/version.rb

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

data/lib/usable.rb

@@ -34,11 +34,15 @@ module Usable
   # @return [ModExtender] containing the original and modified module
   def usable(mod, options = {})
     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 }
+    end
     options.each { |k, v| usable_config.public_send "#{k}=", v }
     yield usable_config if block_given?
     mod_ext = ModExtender.new mod, usable_options
     mod_ext.use! self
     mod_ext.use_original! self
+    mod_ext.use_class_methods! self
     mod_ext
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler