much-plugin 0.0.1 → 0.1.0

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rake', "~> 10.4.0"
-gem 'pry', "~> 0.9.0"
+gem 'pry',  "~> 0.9.0"

data/README.md

@@ -1,10 +1,30 @@
 # MuchPlugin
 
-TODO: Write a gem description
+An API to ensure mixin included logic (the "plugin") only runs once.
 
 ## Usage
 
-TODO: Write code samples and usage instructions here
+```ruby
+requre 'much-plugin'
+
+module MyPluginMixin
+  include MuchPlugin
+
+  plugin_included do
+
+    # ... do some stuff ...
+    # - will be class eval'd in the scope of the receiver of `MyPluginMixin`
+    # - will only be executed once per receiver, no matter how many times
+    #   `MyPluginMixin` is included in that receiver
+
+  end
+
+end
+```
+
+Mix `MuchPlugin` in on other mixins that act as "plugins" to other components.  Define included hooks using `plugin_included` that will be class eval'd in the scope of the receiver.
+
+This allows you to define multiple hooks separately and ensures each hook will only be executed once - even if your plugin is mixed in multiple times on the same receiver.
 
 ## Installation
 

data/lib/much-plugin.rb

@@ -1,5 +1,36 @@
 require "much-plugin/version"
 
 module MuchPlugin
-  # TODO: your code goes here...
+
+  def self.included(receiver)
+    receiver.class_eval do
+      extend ClassMethods
+
+      # 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.
+
+      def self.included(plugin_receiver)
+        return if self.much_plugin_receivers.include?(plugin_receiver)
+
+        self.much_plugin_receivers.push(plugin_receiver)
+        self.much_plugin_included_hooks.each do |hook|
+          plugin_receiver.class_eval(&hook)
+        end
+      end
+
+    end
+  end
+
+  module ClassMethods
+
+    def much_plugin_receivers;      @much_plugin_receivers      ||= []; end
+    def much_plugin_included_hooks; @much_plugin_included_hooks ||= []; end
+
+    def plugin_included(&hook)
+      self.much_plugin_included_hooks << hook
+    end
+
+  end
+
 end

data/lib/much-plugin/version.rb

@@ -1,3 +1,3 @@
 module MuchPlugin
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/much-plugin.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version     = MuchPlugin::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.description = %q{Much plugin.}
-  gem.summary     = %q{Much plugin.}
+  gem.description = %q{An API to ensure mixin included logic (the "plugin") only runs once.}
+  gem.summary     = %q{An API to ensure mixin included logic (the "plugin") only runs once.}
   gem.homepage    = "http://github.com/redding/much-plugin"
   gem.license     = 'MIT'
 
@@ -18,6 +18,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.14"])
+  gem.add_development_dependency("assert", ["~> 2.15"])
 
 end

data/test/helper.rb

@@ -8,5 +8,3 @@ $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 require 'pry'
 
 require 'test/support/factory'
-
-# TODO: put test helpers here...

data/test/unit/much-plugin_tests.rb

@@ -0,0 +1,101 @@
+require 'assert'
+require 'much-plugin'
+
+module MuchPlugin
+
+  class UnitTests < Assert::Context
+    desc "MuchPlugin"
+    setup do
+      @hook1 = proc{ 1 }
+      @hook2 = proc{ 2 }
+
+      @plugin = Module.new{ include MuchPlugin }
+    end
+    subject{ @plugin }
+
+    should have_imeths :much_plugin_included_hooks, :much_plugin_receivers
+    should have_imeths :plugin_included
+
+    should "have no plugin included hooks by default" do
+      assert_empty subject.much_plugin_included_hooks
+    end
+
+    should "have no plugin receivers by default" do
+      assert_empty subject.much_plugin_receivers
+    end
+
+    should "append hooks" do
+      subject.plugin_included(&@hook1)
+      subject.plugin_included(&@hook2)
+
+      assert_equal @hook1, subject.much_plugin_included_hooks.first
+      assert_equal @hook2, subject.much_plugin_included_hooks.last
+    end
+
+  end
+
+  class MixedInTests < UnitTests
+    desc "when mixed in"
+    setup do
+      @receiver = Class.new do
+        def self.inc_hook1;   @hook1_count ||= 0; @hook1_count += 1; end
+        def self.hook1_count; @hook1_count ||= 0; end
+        def self.inc_hook2;   @hook2_count ||= 0; @hook2_count += 1; end
+        def self.hook2_count; @hook2_count ||= 0; end
+      end
+    end
+
+    should "call the plugin included hooks" do
+      assert_equal 0, @receiver.hook1_count
+      assert_equal 0, @receiver.hook2_count
+
+      @receiver.send(:include, TestPlugin)
+
+      assert_equal 1, @receiver.hook1_count
+      assert_equal 1, @receiver.hook2_count
+    end
+
+    should "call hooks only once no matter even if previously mixed in" do
+      @receiver.send(:include, TestPlugin)
+
+      assert_equal 1, @receiver.hook1_count
+      assert_equal 1, @receiver.hook2_count
+
+      @receiver.send(:include, TestPlugin)
+
+      assert_equal 1, @receiver.hook1_count
+      assert_equal 1, @receiver.hook2_count
+    end
+
+    should "call hooks only once even if mixed in by a 3rd party" do
+      third_party = Module.new do
+        def self.included(receiver)
+          receiver.send(:include, TestPlugin)
+        end
+      end
+      @receiver.send(:include, third_party)
+
+      assert_equal 1, @receiver.hook1_count
+      assert_equal 1, @receiver.hook2_count
+
+      @receiver.send(:include, TestPlugin)
+
+      assert_equal 1, @receiver.hook1_count
+      assert_equal 1, @receiver.hook2_count
+
+      @receiver.send(:include, third_party)
+
+      assert_equal 1, @receiver.hook1_count
+      assert_equal 1, @receiver.hook2_count
+    end
+
+    TestPlugin = Module.new do
+      include MuchPlugin
+
+      plugin_included{ inc_hook1 }
+      plugin_included{ inc_hook2 }
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: much-plugin
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-07-17 00:00:00 Z
+date: 2015-11-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -24,16 +24,16 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 29
         segments: 
         - 2
-        - 14
-        version: "2.14"
+        - 15
+        version: "2.15"
   type: :development
   name: assert
   version_requirements: *id001
   prerelease: false
-description: Much plugin.
+description: An API to ensure mixin included logic (the "plugin") only runs once.
 email: 
 - kelly@kellyredding.com
 - collin.redding@me.com
@@ -46,7 +46,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/much-plugin.rb
@@ -55,6 +55,7 @@ files:
 - much-plugin.gemspec
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/much-plugin_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/much-plugin
 licenses: 
@@ -88,7 +89,8 @@ rubyforge_project:
 rubygems_version: 1.8.29
 signing_key: 
 specification_version: 3
-summary: Much plugin.
+summary: An API to ensure mixin included logic (the "plugin") only runs once.
 test_files: 
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/much-plugin_tests.rb