usable 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e971571c1349c6977b3e0d8050536a2d1d75f76
-  data.tar.gz: cc1dcf9e4678b7ae565e3a4e8bcb111b5253b853
+  metadata.gz: e880dacf65e19267ebe16ba66d5ec85759f8e17d
+  data.tar.gz: 7bd498ea658d2cff0b13207a27d98df96e740442
 SHA512:
-  metadata.gz: c2c23c4aefe50a4cec3a8ee7232ecaf7f84f5f1d71a5f1f33fe7212cb08581c4301ebd6143fa3ccaa839691c0f2ce171d88d39af9bb6f0ff035733c07d6d3bec
-  data.tar.gz: 5cce2ae60678d9ce8cd1ac1230d84c27d53ca77338cedc31cd5ab3fbb676d0bb840cf1ea8e7cff3edaa1b983172d319655292d7a76091cc3fda2661c9e6179b3
+  metadata.gz: 8b4f4ce971e0f34b25190b69f67c1df97fe6e9b8ce1960d4ce10b2ec5e988f1b74187a0ef9882553be2a4aedd179220534d8e822a0f57c1d5cd068a1862e824f
+  data.tar.gz: fd4f4fdf322c535abea6f95d50ac02dcf3731f3aaa153b12729d2d37acd50b0ee04dca8432132c0adc083760b482e4f42cd081cd9dbc7ea4fc9684034752d017

data/.rspec

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

data/README.md

@@ -1,6 +1,6 @@
 # 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)
 
-A simple way to mount and configure your modules. Usable gives you control over which methods are included, and a simple
+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.
 
 ```ruby
@@ -31,7 +31,21 @@ model = Model.new
 model.save_version     # => "Saving up to 10 versions to custom_versions"
 model.destroy_version  # => NoMethodError: undefined method `destroy_version' for #<Model:...
 ```
-`Model` now has a `#save_versions` method but no `#destroy_version` method.
+`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
+```
+
+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|
+  config.only = "Will be set on `Model.usable_config.only`"
+end
+```
 
 ## Confidently calling methods
 

data/bin/console

@@ -54,11 +54,19 @@ class Model
   end
 end
 
+module PersistenceOverride
+  def save
+    'nope'
+  end
+end
+
 class Example
   extend Usable
   usable Mixin, only: [:name, :from_spec]
 end
 
+Model.usable PersistenceOverride, method: 'prepend'
+
 require "irb"
 
 IRB.start

data/lib/usable/mod_extender.rb

@@ -1,35 +1,62 @@
 module Usable
   class ModExtender
     attr_reader :name
-    attr_accessor :copy, :mod, :config
+    attr_accessor :copy, :mod, :options
 
-    def initialize(mod, config = OpenStruct.new)
+    def initialize(mod, options = {})
       @mod = mod
+      @options = options
+      @options[:method] ||= :include
       if has_spec?
         @copy = mod.const_get(:UsableSpec).dup
         @name = "#{mod.name}UsableSpec"
       else
-        @copy =  mod.dup
+        @copy = mod.dup
         @name = mod.name
       end
-      @config = config
     end
 
-    # @note Destructive
     def call
       override
       copy
     end
 
+    # @note Destructive, as it changes the dup'd mod
     def override
-      unwanted = config.only ? copy.instance_methods - Array(config.only) : []
+      unwanted = options[:only] ? copy.instance_methods - Array(options[:only]) : []
       unwanted.each do |method_name|
         copy.send :remove_method, method_name
       end
     end
 
+    # @description Directly include a module whose methods you want made available in +usable_config.available_methods+
+    #   Gives the module a name when including so that it shows up properly in the list of ancestors
+    def use!(target)
+      const_name = "#{mod_name}Used"
+      override
+      target.send :remove_const, const_name if target.const_defined? const_name, false
+      target.const_set const_name, copy
+      target.usable_config.modules << copy
+      target.send options[:method], copy
+    end
+
+    # @description Sends the method to the target with the original module
+    def use_original!(target)
+      return unless has_spec?
+      target.usable_config.modules << mod
+      target.send options[:method], mod
+    end
+
     def has_spec?
       mod.const_defined?(:UsableSpec)
     end
+
+    def mod_name
+      if name
+        name.split('::').last
+      else
+        "UsableMod#{Time.now.strftime('%s')}"
+      end
+    end
   end
 end

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "1.2.1".freeze
+  VERSION = "1.3.0".freeze
 end

data/lib/usable.rb

@@ -5,48 +5,43 @@ require 'usable/mod_extender'
 require 'usable/config'
 
 module Usable
-
   def usable_config
     @usable_config ||= Config.new
   end
   attr_writer :usable_config
 
   # @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 of
+  #   the target class. Checks if there is a module named UsableSpec within the given mods namespace and uses the instance
   #   methods of that as the +available_methods+
   #
   # @example
   #
   #   class Example
   #     extend Usable
-  #     usable VersionKit, only: :save_version
+  #     usable Mixin, only: [:foo, :bar] do |config|
+  #       config.baz = "Available as `Example.usable_config.baz`"
+  #     end
   #   end
   #
   # @note Hides methods
-  # @note We include the primary mod when there is a UsableSpec set because any instance method defined on the mod are not
-  #   configurable and should therefore takes precedence over those defined in the UsableSpec
+  # @note We include the primary mod when there is a UsableSpec set because any instance methods defined on the mod are
+  #   not configurable and should therefore takes precedence over those defined in the UsableSpec
+  #
+  # @param [Module] mod
+  # @param [Hash] options Customize the extension of the module as well as define config settings on the target
+  # @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 = {})
+    usable_options = { only: options.delete(:only), method: options.delete(:method) }
     options.each { |k, v| usable_config.public_send "#{k}=", v }
     yield usable_config if block_given?
-    mod_ext = ModExtender.new mod, usable_config
-    usable! mod_ext
-    usable! mod if mod_ext.has_spec?
+    mod_ext = ModExtender.new mod, usable_options
+    mod_ext.use! self
+    mod_ext.use_original! self
     mod_ext
   end
 
-  # @description Directly include a module whose methods you want made available in +usable_config.available_methods+
-  #   Gives the module a name when including so that it shows up properly in the list of ancestors
-  def usable!(mod)
-    mod_name = mod.name ? mod.name.split('::').last : "UsableMod#{Time.now.strftime('%s')}"
-    const_name = "#{mod_name}Used"
-    mod = mod.call if mod.respond_to? :call
-    remove_const const_name if const_defined? const_name, false
-    const_set const_name, mod
-    usable_config.modules << mod
-    send :include, mod
-  end
-
   # @return [Method] bound to the given -context-
   def usable_method(context, method_name)
     usable_config.available_methods[method_name].bind(context)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"