usable 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 248031af23fb6b13a611f3ad52aed2b485e13042
-  data.tar.gz: 7d43e66f04750393514a83e5cf6af8950aecd242
+  metadata.gz: a14205274f753668d3b6bc7002739321e22f445f
+  data.tar.gz: a21a914e5cf9850a7c4bb88708f187a017e0bad7
 SHA512:
-  metadata.gz: f33b9468b3368318c1eb79d692e168a05de74378307e8c8006c162511f2d6636ebf9f0f186c16ea85f08e63e2217212e110a7edc0328069d9c3667c40ffb7201
-  data.tar.gz: ca0191741f597b8c6c948135cc121c906a36ea6586e5d1a3aea6ac36d3a6b645162eace8e908675788be19cca9d895135b646be6504ea5022494e7cac1f93296
+  metadata.gz: 7f784949ee494ce858e395e5066cbcb48e9dcd153975d71eac80ed3fb1bda5f473547cc43e41ebbfded0567ebb5ab69543b9f935714ff371d7a5e52a25562f65
+  data.tar.gz: 2231963745230a5a9eae47652db32a6b5ba874c887aab232f3fee3e0e73b41b216803baef6943a888a241d450997336fa62dd24597086bf2e380ac6e7e723764

data/README.md

@@ -27,7 +27,7 @@ class Model
   end
 
   def save
-    usable_method(:save_version).call
+    save_version
   end
 end
 
@@ -46,11 +46,35 @@ Usable reserves the `:only` and `:method` keys. All other keys in the given hash
 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`"
+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'
+    spec :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
@@ -71,44 +95,6 @@ Modules with the following names found within the target module's namespace will
 
 `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:
-
-```ruby
-module Mixin
-  def name
-    "defined by Mixin"
-  end
-
-  def from_mixin
-    "always here"
-  end
-
-  # @description Usable will apply the :only option to just the methods defined by this module
-  module UsableSpec
-    def from_spec
-      "can be excluded"
-    end
-
-    def name
-      "defined by UsableSpec"
-    end
-  end
-end
-
-class Example
-  extend Usable
-  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, Example::MixinUsableSpecUsed, Object, Kernel, BasicObject] (ruby -v 2.3.0)
-```
-
 ## Notes
 
 If the given module is modified by the `:only` option, then Usable will duplicate the module so that it doesn't mutate

data/bin/console

@@ -27,21 +27,6 @@ module Mixin
   def name
     "defined by Mixin"
   end
-
-  def from_mixin
-    "always here"
-  end
-
-  # @description Usable will apply the :only to just the methods defined by this module
-  module UsableSpec
-    def from_spec
-      "can be excluded"
-    end
-
-    def name
-      "defined by UsableSpec"
-    end
-  end
 end
 
 class Model

data/lib/usable/mod_extender.rb

@@ -1,8 +1,5 @@
 module Usable
   class ModExtender
-    SPEC = :UsableSpec
-    CLASS_MODULE = :ClassMethods
-
     attr_reader :name
     attr_accessor :copy, :mod, :options, :unwanted
 
@@ -10,29 +7,17 @@ module Usable
       @mod = mod
       @options = options
       @options[:method] ||= :include
-      if has_spec?
-        @copy = mod.const_get SPEC
-        @name = "#{mod.name}UsableSpec"
-      else
-        @copy = mod
-        @name = mod.name
-      end
+      @copy = mod
+      @name = mod.name
       @unwanted = options[:only] ? @copy.instance_methods - Array(options[:only]) : []
       if @unwanted.any?
         @copy = @copy.dup
       end
     end
 
-    # @note Destructive, as it changes @copy
-    def override
-      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 +usables.available_methods+
     #   Gives the module a name when including so that it shows up properly in the list of ancestors
-    def use!(target)
+    def call(target)
       override
       if copy.name.nil?
         const_name = "#{mod_name}Used"
@@ -43,21 +28,23 @@ module Usable
       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.usables.add_module mod
-      target.send options[:method], mod
+    # @note Destructive, as it changes @copy
+    def override
+      unwanted.each do |method_name|
+        copy.send :remove_method, method_name
+      end
     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
+      return unless mod.const_defined? :ClassMethods
+      target.extend mod.const_get :ClassMethods
     end
 
-    def has_spec?
-      mod.const_defined? SPEC
+    # @description Extends the target with the module's ClassMethod mod
+    def use_instance_methods!(target)
+      return unless mod.const_defined? :InstanceMethods
+      target.include mod.const_get :InstanceMethods
     end
 
     def mod_name

data/lib/usable/version.rb

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

data/lib/usable.rb

@@ -35,9 +35,7 @@ module Usable
 
   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
-  #   methods of that as the +available_methods+
+  # @description Includes the given module with a set of options or block to configure it
   #
   # @example
   #
@@ -49,9 +47,6 @@ module Usable
   #   end
   #
   # @note Hides methods
-  # @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
@@ -72,12 +67,10 @@ module Usable
     end
     [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
-    mod_ext.use_class_methods! self
-    mod_ext
+    ModExtender.new(mod, usable_options).call self
+    self.include mod.const_get(:InstanceMethods) if self.const_defined? :InstanceMethods
+    self.extend mod.const_get(:ClassMethods) if self.const_defined? :ClassMethods
+    self
   end
 
   # @return [Method] bound to the given -context-

metadata

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