usable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd9e5a4f0ef7f2d80c5e58c0465af4215842155
-  data.tar.gz: 26c44236196a65f58ee95aaf5609f54c6f90017e
+  metadata.gz: 4838af9eb7ede803ba0bb91bcdde9f4500db8bf9
+  data.tar.gz: 68fb23ea8a2e2ad941f420aca9f797d7cba37e4c
 SHA512:
-  metadata.gz: c479a93b7bea7ec97fe3bcff61cf5d9ca19ea6f07082b78f0c28e017193be670dcdabb5b48c1d5664a8e320d530028bf0436e14ff22ce2e3d334cc2b309cd645
-  data.tar.gz: c0c5ef4f78fa3c6713b0f23baa3b6d1cc7e11209d61c3cb1c2c5b36127d372f9283d3c34dd421fc544e64d494a2fdd5a9758fca7a95c5dc043228efb3c887fb4
+  metadata.gz: da020287fc46e438e2c1dfad79eb90ae4e9aca2b8dcfe0c01bc01d1be91f4f661b1d88237c4765cb487d2a316e0f74350eeb535e93ca107bb21a6539127be752
+  data.tar.gz: 6d68fcda221aec13e6933e90612c344ec7a410b4bdeac1e59b8498d916734e2a9e55acd310566e8a4c36c66725b0205719b6e21a0fb84f856b642ac9c41de2fd

data/README.md

@@ -1,6 +1,7 @@
-# Usable
+# Usable [![Gem Version](https://badge.fury.io/rb/usable.svg)](http://badge.fury.io/rb/usable)
 
-Rack style mixins for Ruby objects. Mount your modules like you mean it!
+A simple way to mount and configure your modules. Usable gives you control over which methods are included, and the class
+level config provides a safe interface for calling them.
 
 ```ruby
 module VersionKit
@@ -26,11 +27,11 @@ end
 => "custom_versions"
 >> Model.new.save_version
 => "Saving up to 10 versions to custom_versions"
->> Model.usable_config.available_methods[:save_version].bind(self).call
+>> Model.usable_config.available_methods[:save_version].bind(Model.new).call
 => "Saving up to 10 versions to custom_versions"
 >> Model.new.respond_to? :destroy_version     
 => false
->> Model.usable_config.available_methods[:destroy_version].bind(self).call
+>> Model.usable_config.available_methods[:destroy_version].bind(Model.new).call
 => nil
 ```
 What's going on here? Well `#save_versions` is now extended onto the `Model` class, but `#destroy_version` is not!
@@ -40,9 +41,9 @@ What's going on here? Well `#save_versions` is now extended onto the `Model` cla
 Yes. Well ... yes, at least on the copy of the module included in the target class. But, checking if an object responds
 to a method all time doesn't produce very [confident code](http://www.confidentruby.com/). That's why it is encouraged
 to reference methods through the `Model.usable_config.available_methods` hash. This way you can confidently call methods,
-just don't rely on the return value! Methods that are removed via `:only` will return `nil`.
+just don't rely on the return value, because methods that are removed via `:only` will return `nil`.
 
-## Seperate included module from configurable methods
+## Separate included module from configurable methods
 
 Sometimes you want to define methods on the module but not have them be configurable. Define a module within the usable 
 module namespace and name it `UsableSpec`, and `Usable` will use that module to configure the available methods. Any naming

data/lib/usable.rb

@@ -26,16 +26,24 @@ module Usable
   # @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
+  # @return [ModExtender] containing the original and modified module
   def usable(mod, options = {})
     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.call
+    usable! mod_ext
     usable! mod if mod_ext.has_spec?
+    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.nil? ? "UsableMod#{Time.now.strftime('%s')}" : mod.name.split('::').last
+    const_name = "#{mod_name}Used"
+    mod = mod.call if mod.respond_to? :call
+    remove_const const_name if const_defined? const_name
+    const_set const_name, mod
     usable_config.modules << mod
     send :include, mod
   end

data/lib/usable/config.rb

@@ -4,6 +4,10 @@ module Usable
       @modules ||= []
     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|
@@ -13,11 +17,11 @@ module Usable
     end
 
     def default_method
-      Null.instance_method(:null)
+      Null.instance_method(:default_method)
     end
 
     module Null
-      def null(*, &block)
+      def default_method(*, &block)
       end
     end
   end

data/lib/usable/mod_extender.rb

@@ -1,9 +1,11 @@
 module Usable
   class ModExtender
+    attr_reader :name
     attr_accessor :copy, :mod, :config
 
     def initialize(mod, config = OpenStruct.new)
       @mod = mod
+      @name = mod.name
       @copy = has_spec? ? mod.const_get(:UsableSpec).dup : mod.dup
       @config = config
     end

data/lib/usable/scoped.rb

@@ -14,7 +14,7 @@ module Usable
     end
 
     def usable(mod, options = {})
-      send :include, mod unless self < mod
+      send :include, mod
       if block_given?
         yield configs[mod]
       else

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/usable.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ryan Buckley"]
   spec.email         = ["arebuckley@gmail.com"]
 
-  spec.summary       = %q{Rack style mixins}
-  spec.description   = %q{Rack style mixins which provide a convention for passing options to your modules.}
+  spec.summary       = %q{Mounts and configures modules}
+  spec.description   = %q{A simple way to mount and configure your modules. Usable gives you control over which methods are included.}
   spec.homepage      = "https://github.com/ridiculous/usable"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,8 +78,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-description: Rack style mixins which provide a convention for passing options to your
-  modules.
+description: A simple way to mount and configure your modules. Usable gives you control
+  over which methods are included.
 email:
 - arebuckley@gmail.com
 executables: []
@@ -91,7 +91,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- LICENSE.md
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -103,7 +103,8 @@ files:
 - lib/usable/version.rb
 - usable.gemspec
 homepage: https://github.com/ridiculous/usable
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -124,5 +125,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Rack style mixins
+summary: Mounts and configures modules
 test_files: []