much-plugin 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  data.tar.gz: 84f275cfa293994f90ba140878ad4ed41eb9d858
-  metadata.gz: 260ffbd14617020d9552de0c32cc715e31e40964
+  metadata.gz: 7f75f3177a2f12db73711551a7ae1c1f8676addf
+  data.tar.gz: 5fe30d9b7dc34dcb998a1a47b7ea37e1f3b0de80
 SHA512: 
-  data.tar.gz: 07044deac53c6a4bc29ff6fcc7e58a099e404f1dff5bef1195be897d03e916e8da6f56f76f61ebfdf953dc90d0e67befcad1d08080936e9a9114105255f5dc1d
-  metadata.gz: c5459f146e1162ba23cb234bdedcc2e3126985eddf1be2308da30a099f4453fd836f502684483b48c73c04727d7b79681badb1d80545a1c405d40e80eca9539a
+  metadata.gz: 9792123b848b0fb119f42d7fc13ba15ec2d7af55eab316137f3b4a782912f830668859bcc6683ace7827920ee72000178133b6f92534d2448788f0a73b4c77a6
+  data.tar.gz: cb9a718201fa65522e4570ba8cee508b2c7818ccab7e99c50aa52c52ea666b016f9330202b5ca28bf33b7d1aca5a6f0f77e74cd3a8cb762949ecc136184315eb

data/bench/script.rb

@@ -0,0 +1,27 @@
+require 'much-plugin'
+require 'benchmark'
+
+module Methods; end
+
+module MyMixin
+  def self.included(receiver)
+    receiver.class_eval{ include Methods }
+  end
+end
+
+module MyPlugin
+  include MuchPlugin
+
+  plugin_included do
+    include Methods
+  end
+end
+
+Benchmark.bmbm do |x|
+  x.report("MyMixin") do
+    10_000.times{ Class.new{ include MyMixin } }
+  end
+  x.report("MyPlugin") do
+    10_000.times{ Class.new{ include MyPlugin } }
+  end
+end

data/lib/much-plugin.rb

@@ -3,28 +3,34 @@ require "much-plugin/version"
 module MuchPlugin
 
   def self.included(receiver)
-    receiver.class_eval do
-      extend ClassMethods
+    receiver.class_eval{ extend ClassMethods }
+  end
 
-      # install an included hook that first checks if this plugin has
-      # already been installed on the reciever.  If it has not been,
-      # class eval each callback on the receiver.
+  module ClassMethods
 
-      def self.included(plugin_receiver)
-        return if self.much_plugin_receivers.include?(plugin_receiver)
+    # install an included hook that first checks if this plugin's receiver mixin
+    # has already been included.  If it has not been, include the receiver mixin
+    # and run all of the `plugin_included` hooks
+    def included(plugin_receiver)
+      return if plugin_receiver.include?(self.much_plugin_included_detector)
+      plugin_receiver.send(:include, self.much_plugin_included_detector)
 
-        self.much_plugin_receivers.push(plugin_receiver)
-        self.much_plugin_included_hooks.each do |hook|
-          plugin_receiver.class_eval(&hook)
-        end
+      self.much_plugin_included_hooks.each do |hook|
+        plugin_receiver.class_eval(&hook)
       end
-
     end
-  end
 
-  module ClassMethods
+    # the included detector is an empty module that is only used to detect if
+    # the plugin has been included or not, it doesn't add any behavior or
+    # methods to the object receiving the plugin; we use `const_set` to name the
+    # module so if its seen in the ancestors it doesn't look like some random
+    # module and it can be tracked back to much-plugin
+    def much_plugin_included_detector
+      @much_plugin_included_detector ||= Module.new.tap do |m|
+        self.const_set("MuchPluginIncludedDetector", m)
+      end
+    end
 
-    def much_plugin_receivers;      @much_plugin_receivers      ||= []; end
     def much_plugin_included_hooks; @much_plugin_included_hooks ||= []; end
 
     def plugin_included(&hook)

data/lib/much-plugin/version.rb

@@ -1,3 +1,3 @@
 module MuchPlugin
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/much-plugin.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require File.expand_path("../lib/much-plugin/version", __FILE__)
+require "much-plugin/version"
 
 Gem::Specification.new do |gem|
   gem.name        = "much-plugin"
-  gem.version     = MuchPlugin::VERSION
+  gem.version     = "0.2.0" #MuchPlugin::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
   gem.summary     = %q{An API to ensure mixin included logic (the "plugin") only runs once.}

data/test/unit/much-plugin_tests.rb

@@ -13,15 +13,19 @@ module MuchPlugin
     end
     subject{ @plugin }
 
-    should have_imeths :much_plugin_included_hooks, :much_plugin_receivers
+    should have_imeths :much_plugin_included_detector, :much_plugin_included_hooks
     should have_imeths :plugin_included
 
-    should "have no plugin included hooks by default" do
-      assert_empty subject.much_plugin_included_hooks
+    should "know its included detector" do
+      mixin = subject.much_plugin_included_detector
+      assert_instance_of Module, mixin
+      assert_same mixin, subject.much_plugin_included_detector
+      exp = subject::MuchPluginIncludedDetector
+      assert_same exp, subject.much_plugin_included_detector
     end
 
-    should "have no plugin receivers by default" do
-      assert_empty subject.much_plugin_receivers
+    should "have no plugin included hooks by default" do
+      assert_empty subject.much_plugin_included_hooks
     end
 
     should "append hooks" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: much-plugin
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-06-01 00:00:00 Z
+date: 2016-06-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -37,6 +37,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- bench/script.rb
 - lib/much-plugin.rb
 - lib/much-plugin/version.rb
 - log/.gitkeep
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: An API to ensure mixin included logic (the "plugin") only runs once.