usable 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 012d85e8c84454e2b546f05763299d4157d768ac
-  data.tar.gz: 44c5faec64db7d6dcc843c97dbf04601b6900039
+  metadata.gz: 5dd9e5a4f0ef7f2d80c5e58c0465af4215842155
+  data.tar.gz: 26c44236196a65f58ee95aaf5609f54c6f90017e
 SHA512:
-  metadata.gz: e5b18af041a6be1df266076067657767c6dcdbb050c0a71e08cfcc348077966d0a86ffd6607d42ab6cab85e526b7fa1f23f65bc99925c49242f8d9031f39ae7d
-  data.tar.gz: 4297b9a8d18efe624a92a8a03859930f37a937a812f9cb2f662df7260c3036f385206431c28e322a753eb6dee34a26730beebe1ff7725d902937405267929218
+  metadata.gz: c479a93b7bea7ec97fe3bcff61cf5d9ca19ea6f07082b78f0c28e017193be670dcdabb5b48c1d5664a8e320d530028bf0436e14ff22ce2e3d334cc2b309cd645
+  data.tar.gz: c0c5ef4f78fa3c6713b0f23baa3b6d1cc7e11209d61c3cb1c2c5b36127d372f9283d3c34dd421fc544e64d494a2fdd5a9758fca7a95c5dc043228efb3c887fb4

data/README.md

@@ -5,11 +5,11 @@ Rack style mixins for Ruby objects. Mount your modules like you mean it!
 ```ruby
 module VersionKit
   def save_version
-    "Saving up to #{self.class.config.max_versions} versions to #{self.class.config.table_name}"
+    "Saving up to #{self.class.usable_config.max_versions} versions to #{self.class.usable_config.table_name}"
   end
 
   def destroy_version
-    "Deleting versions from #{self.class.config.table_name}"
+    "Deleting versions from #{self.class.usable_config.table_name}"
   end
 end
   
@@ -22,26 +22,48 @@ class Model
   end
 end
 
->> Model.config.table_name
+>> Model.usable_config.table_name
 => "custom_versions"
->> Model.new.versions      
+>> Model.new.save_version
 => "Saving up to 10 versions to custom_versions"
->> Model.new.destroy_version     
+>> Model.usable_config.available_methods[:save_version].bind(self).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
 => nil
 ```
-You can also define a custom module within the "usable" module that defines the methods which can be configured to be
-extended or excluded. The module must be named "Spec" and be defined one level inside the namespace. For example:
+What's going on here? Well `#save_versions` is now extended onto the `Model` class, but `#destroy_version` is not!
+
+## But wait, you undefined my methods?
+
+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`.
+
+## Seperate 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
+conflicts will be resolved by giving precedence to the parent module.
+
+For example:
 
 ```ruby
 module VersionKit
-  module Spec
+  module UsableSpec
     def version
-      "spec version included"
+      "yo"
+    end
+    
+    def name
+      "nope"
     end
   end
   
-  def version
-    "this version not included"
+  def name
+    "yup"
   end
   
   def self.included(base)
@@ -52,8 +74,12 @@ end
 >> Example = Class.new.extend Usable
 => Example
 >> Example.usable VersionKit
-spec version included
+yo
 => Example
+>> Example.new.version
+=> "yo"
+>> Example.new.name
+=> "yup"
 ```
 
 ## Installation
@@ -64,10 +90,6 @@ Add this line to your application's Gemfile:
 gem 'usable'
 ```
 
-Or install it yourself as:
-
-    $ gem install usable
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -76,5 +98,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/usable.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ridiculous/usable.
 

data/bin/console

@@ -12,11 +12,11 @@ require "usable"
 
 module VersionKit
   def save_version
-    "Saving up to #{self.class.config.max_versions} versions to #{self.class.config.table_name}"
+    "Saving up to #{self.class.usable_config.max_versions} versions to #{self.class.usable_config.table_name}"
   end
 
   def destroy_version
-    "Deleting versions from #{self.class.config.table_name}"
+    "Deleting versions from #{self.class.usable_config.table_name}"
   end
 end
 

data/lib/usable/config.rb

@@ -5,11 +5,20 @@ module Usable
     end
 
     def available_methods
-      modules.each_with_object({}) do |mod, result|
+      modules.each_with_object(Hash.new(default_method)) do |mod, result|
         mod.instance_methods.each do |method_name|
           result[method_name] = mod.instance_method method_name
         end
       end
     end
+
+    def default_method
+      Null.instance_method(:null)
+    end
+
+    module Null
+      def null(*, &block)
+      end
+    end
   end
 end

data/lib/usable/mod_extender.rb

@@ -4,25 +4,25 @@ module Usable
 
     def initialize(mod, config = OpenStruct.new)
       @mod = mod
-      @copy = has_spec? ? mod.const_get(:Spec).dup : mod.dup
+      @copy = has_spec? ? mod.const_get(:UsableSpec).dup : mod.dup
       @config = config
     end
 
+    # @note Destructive
     def call
-      copy.prepend override
+      override
+      copy
     end
 
     def override
       unwanted = config.only ? copy.instance_methods - Array(config.only) : []
-      Module.new do
-        unwanted.each do |method_name|
-          define_method(method_name) { |*| }
-        end
+      unwanted.each do |method_name|
+        copy.send :remove_method, method_name
       end
     end
 
     def has_spec?
-      mod.const_defined?(:Spec)
+      mod.const_defined?(:UsableSpec)
     end
   end
 end

data/lib/usable/version.rb

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

data/lib/usable.rb

@@ -13,7 +13,7 @@ module Usable
   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 Spec 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 of
   #   methods of that as the +available_methods+
   #
   # @example
@@ -24,8 +24,8 @@ module Usable
   #   end
   #
   # @note Hides methods
-  # @note We include the primary mod when there is a Spec set because any instance method defined on the mod are not
-  #   configurable and should therefore takes precedence over those defined in the Spec
+  # @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
   def usable(mod, options = {})
     options.each { |k, v| usable_config.public_send "#{k}=", v }
     yield usable_config if block_given?

metadata

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