usable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97cce0168afce1846a0d35f692a9880e517dbe7e
-  data.tar.gz: 9fde115f8e348ef8fa94f9b79f231f1dce592026
+  metadata.gz: e6ce8a1897bd2183446ed294714d2dbb6bd4f1b3
+  data.tar.gz: 24de43ed69870b8a62906f04a1125db2ba1e84ff
 SHA512:
-  metadata.gz: 3a19a138c0a0ddfb9a6c980cb4abaac2477f2458e95ca3a6a1bd07c6f6f6fcd1f5e53d5ce2e6c1ef08a14b3a065ce68bc817f12545a1bd59497587e39f0beab8
-  data.tar.gz: 6f8fd5859cdd1f1afac52db4555d374fc5cad64a578239358a7d6b2d4ff9eccc780281c314cf11c8324bfbbcde3367c27555dc7c14e8dfb7a1cb63deb653eda5
+  metadata.gz: c2d8bd54e08e2c2b46450cb1dc916df6d5915bb526f52f7b50de6d6dcdc6940b19e7380160adc1cf70ec820f6b18110eff225069424dd8f3c815582041b42542
+  data.tar.gz: 663d86bd5095d61a06f639fcb7cf31aa35398c9239353f0418f6d3324c12ada5f8795daee2a89c5baa8ff44459b5a5522616caa251d363a10ac7a13000e61934

data/README.md

@@ -3,26 +3,57 @@
 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}"
+  end
+
+  def destroy_version
+    "Deleting versions from #{self.class.config.table_name}"
+  end
+end
+  
 class Model
   extend Usable
-  
-  module Versionable
-    def versions
-      "Saving #{self.class.config.max_versions} versions to #{self.class.config.table_name}"
-    end
+
+  usable VersionKit, only: :save_version do |config|
+    config.max_versions = 10
+    config.table_name = 'custom_versions'
   end
+end
 
-  # with options hash
-  use Versionable, table_name: 'custom_versions'
+>> Model.config.table_name
+=> "custom_versions"
+>> Model.new.versions      
+=> "Saving up to 10 versions to custom_versions"
+>> Model.new.destroy_version     
+=> 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:
 
-  # or with block
-  use Versionable do |config|
-    config.max_versions = 10
+```ruby
+module VersionKit
+  module Spec
+    def version
+      "spec version included"
+    end
+  end
+  
+  def version
+    "this version not included"
+  end
+  
+  def self.included(base)
+    puts base.usable_config.available_methods[:version].bind(self).call
   end
 end
 
-Model.config.table_name #=> 'custom_versions'
-Model.new.versions #=> "Saving 10 versions to custom_versions"
+>> Example = Class.new.extend Usable
+=> Example
+>> Example.usable VersionKit
+spec version included
+=> Example
 ```
 
 ## Installation

data/bin/console

@@ -10,5 +10,25 @@ require "usable"
 # require "pry"
 # Pry.start
 
+module VersionKit
+  def save_version
+    "Saving up to #{self.class.config.max_versions} versions to #{self.class.config.table_name}"
+  end
+
+  def destroy_version
+    "Deleting versions from #{self.class.config.table_name}"
+  end
+end
+
+class Model
+  extend Usable
+
+  usable VersionKit, only: :save_version do |config|
+    config.max_versions = 10
+    config.table_name = 'custom_versions'
+  end
+end
+
 require "irb"
+
 IRB.start

data/lib/usable/scoped.rb

@@ -13,7 +13,7 @@ module Usable
       base.extend Configurable
     end
 
-    def use(mod, options = {})
+    def usable(mod, options = {})
       send :include, mod unless self < mod
       if block_given?
         yield configs[mod]
@@ -42,12 +42,12 @@ end
     extend Usable::Scoped
 
   # with options hash
-    use Versionable, table_name: 'custom_versions'
+    usable Versionable, table_name: 'custom_versions'
   # or with block
-    use Versionable do |config|
+    usable Versionable do |config|
       config.max_versions = 10
     end
-    use Notable do |config|
+    usable Notable do |config|
       config.max_versions = 20
       config.table_name = 'custom_notes'
     end

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/usable.rb

@@ -2,19 +2,60 @@ require "ostruct"
 require "usable/version"
 
 module Usable
-  def config
-    @config ||= Config.new
+  def usable_config
+    @usable_config ||= Config.new
   end
 
-  def use(mod, options = {})
-    send :include, mod unless self < mod
+  alias_method :config, :usable_config unless method_defined?(:config)
+
+  def usable(mod, options = {})
+    options.each { |k, v| usable_config.public_send "#{k}=", v }
     if block_given?
-      yield config
+      yield usable_config
+    end
+    wrapped_mod = spec(mod).dup
+    wrapped_mod.prepend build_null_mod(wrapped_mod)
+    usable_config.modules[mod] = wrapped_mod
+    if has_spec?(mod)
+      send :include, mod
+    else
+      send :include, usable_config.modules[mod]
+    end
+  end
+
+  # @description Stub out any "unwanted" methods
+  def build_null_mod(mod)
+    unwanted = usable_config.only ? mod.instance_methods - Array(usable_config.only) : []
+    Module.new do
+      unwanted.each do |method_name|
+        define_method(method_name) { |*| }
+      end
+    end
+  end
+
+  def has_spec?(mod)
+    mod.const_defined?(:Spec)
+  end
+
+  def spec(mod)
+    if has_spec?(mod)
+      mod.const_get(:Spec)
     else
-      options.each { |k, v| config.public_send "#{k}=", v }
+      mod
     end
   end
 
   class Config < OpenStruct
+    def available_methods
+      modules.each_with_object({}) do |(_, mod_copy), result|
+        mod_copy.instance_methods.each do |method_name|
+          result[method_name] = mod_copy.instance_method method_name
+        end
+      end
+    end
+
+    def modules
+      @modules ||= {}
+    end
   end
 end

metadata

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