much-plugin 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 7f75f3177a2f12db73711551a7ae1c1f8676addf
-  data.tar.gz: 5fe30d9b7dc34dcb998a1a47b7ea37e1f3b0de80
-SHA512: 
-  metadata.gz: 9792123b848b0fb119f42d7fc13ba15ec2d7af55eab316137f3b4a782912f830668859bcc6683ace7827920ee72000178133b6f92534d2448788f0a73b4c77a6
-  data.tar.gz: cb9a718201fa65522e4570ba8cee508b2c7818ccab7e99c50aa52c52ea666b016f9330202b5ca28bf33b7d1aca5a6f0f77e74cd3a8cb762949ecc136184315eb
+---
+SHA256:
+  metadata.gz: baebd1ccaff9c505af4deac64f758ccad4a5f41a8bc5e94ad3fd3bdcc6a6a8cb
+  data.tar.gz: 8da8eca30eb1766bb3d3c5b0beab9a271a0b27ac7c2d281d169b0f7b4be0110f
+SHA512:
+  metadata.gz: 66e7398810226de3fda5cc76e8c298f15a8e38b1b56647e6abd9751c9469fd2f2919fbfd668747807e68b274304ecc3f08035c0341c596abcf2a45458cb2d56f
+  data.tar.gz: dbdaf8782afdad32471fdf75eba18e7ac05f1dc423167808fdb4794ae1c2a3cf924d2009685fcaf353c74fc15bcc519d660f351c302c2072de2223e827f9078f

data/Gemfile

@@ -3,3 +3,6 @@ source "https://rubygems.org"
 gemspec
 
 gem 'pry', "~> 0.9.0"
+
+# to release, uncomment this and run `bundle exec ggem r -f`
+gem 'ggem'

data/README.md

@@ -5,20 +5,17 @@ An API to ensure mixin included logic (the "plugin") only runs once.
 ## Usage
 
 ```ruby
-requre 'much-plugin'
+requre "much-plugin"
 
 module MyPluginMixin
   include MuchPlugin
 
   plugin_included do
-
-    # ... do some stuff ...
+    # 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
 ```
 
@@ -26,6 +23,69 @@ Mix `MuchPlugin` in on other mixins that act as "plugins" to other components.
 
 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.
 
+### `plugin_class_methods` / `plugin_instance_methods`
+
+MuchPlugin provides convenience methods for defining instance/class methods on plugin receivers:
+
+```ruby
+requre "much-plugin"
+
+module MyPluginMixin
+  include MuchPlugin
+
+  plugin_class_methods do
+    # define some methods ...
+    # - these methods will become class methods on the receiver
+  end
+
+  plugin_instance_methods do
+    # define some methods ...
+    # - these methods will become instance methods on the receiver
+  end
+end
+```
+
+## Example
+
+```ruby
+requre "much-plugin"
+
+module AnotherMixin
+  def another
+    "another"
+  end
+end
+
+module MyPlugin
+  include MuchPlugin
+
+  plugin_included do
+    include AnotherMixin
+  end
+
+  plugin_class_methods do
+    def a_class_method
+      "a-class-method"
+    end
+  end
+
+  plugin_instance_methods do
+    def an_instance_method
+      "an-instance-method"
+    end
+  end
+end
+
+class MyClass
+  include MyPlugin
+end
+
+my_class = MyClass.new
+my_class.another            # => "another"
+my_class.an_instance_method # => "an-instance-method"
+MyClass.a_class_method      # => "a-class-method"
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/much-plugin.rb

@@ -1,23 +1,31 @@
 require "much-plugin/version"
 
 module MuchPlugin
-
   def self.included(receiver)
     receiver.class_eval{ extend ClassMethods }
   end
 
   module ClassMethods
-
-    # install an included hook that first checks if this plugin's receiver mixin
+    # install an included block 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
+    # and run all of the `plugin_included` blocks
     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_included_hooks.each do |hook|
-        plugin_receiver.class_eval(&hook)
+      self.much_plugin_included_blocks.each do |block|
+        plugin_receiver.class_eval(&block)
+      end
+
+      self.much_plugin_class_method_blocks.each do |block|
+        self.much_plugin_class_methods_module.class_eval(&block)
+      end
+      plugin_receiver.send(:extend, self.much_plugin_class_methods_module)
+
+      self.much_plugin_instance_method_blocks.each do |block|
+        self.much_plugin_instance_methods_module.class_eval(&block)
       end
+      plugin_receiver.send(:include, self.much_plugin_instance_methods_module)
     end
 
     # the included detector is an empty module that is only used to detect if
@@ -31,12 +39,40 @@ module MuchPlugin
       end
     end
 
-    def much_plugin_included_hooks; @much_plugin_included_hooks ||= []; end
+    def much_plugin_class_methods_module
+      @much_plugin_class_methods_module ||= Module.new.tap do |m|
+        self.const_set("MuchPluginClassMethods", m)
+      end
+    end
 
-    def plugin_included(&hook)
-      self.much_plugin_included_hooks << hook
+    def much_plugin_instance_methods_module
+      @much_plugin_instance_methods_module ||= Module.new.tap do |m|
+        self.const_set("MuchPluginInstanceMethods", m)
+      end
     end
 
-  end
+    def much_plugin_included_blocks
+      @much_plugin_included_blocks ||= []
+    end
 
+    def much_plugin_class_method_blocks
+      @much_plugin_class_method_blocks ||= []
+    end
+
+    def much_plugin_instance_method_blocks
+      @much_plugin_instance_method_blocks ||= []
+    end
+
+    def plugin_included(&block)
+      self.much_plugin_included_blocks << block
+    end
+
+    def plugin_class_methods(&block)
+      self.much_plugin_class_method_blocks << block
+    end
+
+    def plugin_instance_methods(&block)
+      self.much_plugin_instance_method_blocks << block
+    end
+  end
 end

data/lib/much-plugin/version.rb

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

data/much-plugin.gemspec

@@ -5,7 +5,7 @@ require "much-plugin/version"
 
 Gem::Specification.new do |gem|
   gem.name        = "much-plugin"
-  gem.version     = "0.2.0" #MuchPlugin::VERSION
+  gem.version     = 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.}
@@ -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.16.1"])
+  gem.add_development_dependency("assert", ["~> 2.17.0"])
 
 end

data/test/support/factory.rb

@@ -1,4 +1,4 @@
-require 'assert/factory'
+require "assert/factory"
 
 module Factory
   extend Assert::Factory

data/test/system/much-plugin_tests.rb

@@ -0,0 +1,54 @@
+require "assert"
+require "much-plugin"
+
+module MuchPlugin
+  class SystemTests < Assert::Context
+    desc "MuchPlugin"
+    setup do
+      @my_class = MyClass.new
+    end
+    subject{ @my_class }
+
+    should "class eval the plugin included block on MyClass" do
+      assert_equal "another", subject.another
+    end
+
+    should "add the plugin class methods to MyClass" do
+      assert_equal "a-class-method", MyClass.a_class_method
+    end
+
+    should "add the plugin instance methods to MyClass" do
+      assert_equal "an-instance-method", subject.an_instance_method
+    end
+
+    module AnotherMixin
+      def another
+        "another"
+      end
+    end
+
+    module MyPlugin
+      include MuchPlugin
+
+      plugin_included do
+        include AnotherMixin
+      end
+
+      plugin_class_methods do
+        def a_class_method
+          "a-class-method"
+        end
+      end
+
+      plugin_instance_methods do
+        def an_instance_method
+          "an-instance-method"
+        end
+      end
+    end
+
+    class MyClass
+      include MyPlugin
+    end
+  end
+end

data/test/unit/much-plugin_tests.rb

@@ -1,19 +1,18 @@
-require 'assert'
-require 'much-plugin'
+require "assert"
+require "much-plugin"
 
 module MuchPlugin
-
   class UnitTests < Assert::Context
     desc "MuchPlugin"
     setup do
-      @hook1 = proc{ 1 }
-      @hook2 = proc{ 2 }
+      @block1 = proc{ 1 }
+      @block2 = proc{ 2 }
 
       @plugin = Module.new{ include MuchPlugin }
     end
     subject{ @plugin }
 
-    should have_imeths :much_plugin_included_detector, :much_plugin_included_hooks
+    should have_imeths :much_plugin_included_detector, :much_plugin_included_blocks
     should have_imeths :plugin_included
 
     should "know its included detector" do
@@ -24,54 +23,53 @@ module MuchPlugin
       assert_same exp, subject.much_plugin_included_detector
     end
 
-    should "have no plugin included hooks by default" do
-      assert_empty subject.much_plugin_included_hooks
+    should "have no plugin included blocks by default" do
+      assert_empty subject.much_plugin_included_blocks
     end
 
-    should "append hooks" do
-      subject.plugin_included(&@hook1)
-      subject.plugin_included(&@hook2)
+    should "append blocks" do
+      subject.plugin_included(&@block1)
+      subject.plugin_included(&@block2)
 
-      assert_equal @hook1, subject.much_plugin_included_hooks.first
-      assert_equal @hook2, subject.much_plugin_included_hooks.last
+      assert_equal @block1, subject.much_plugin_included_blocks.first
+      assert_equal @block2, subject.much_plugin_included_blocks.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
+        def self.inc_block1;   @block1_count ||= 0; @block1_count += 1; end
+        def self.block1_count; @block1_count ||= 0; end
+        def self.inc_block2;   @block2_count ||= 0; @block2_count += 1; end
+        def self.block2_count; @block2_count ||= 0; end
       end
     end
 
-    should "call the plugin included hooks" do
-      assert_equal 0, @receiver.hook1_count
-      assert_equal 0, @receiver.hook2_count
+    should "call the plugin included blocks" do
+      assert_equal 0, @receiver.block1_count
+      assert_equal 0, @receiver.block2_count
 
       @receiver.send(:include, TestPlugin)
 
-      assert_equal 1, @receiver.hook1_count
-      assert_equal 1, @receiver.hook2_count
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
     end
 
-    should "call hooks only once no matter even if previously mixed in" do
+    should "call blocks 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
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
 
       @receiver.send(:include, TestPlugin)
 
-      assert_equal 1, @receiver.hook1_count
-      assert_equal 1, @receiver.hook2_count
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
     end
 
-    should "call hooks only once even if mixed in by a 3rd party" do
+    should "call blocks only once even if mixed in by a 3rd party" do
       third_party = Module.new do
         def self.included(receiver)
           receiver.send(:include, TestPlugin)
@@ -79,27 +77,25 @@ module MuchPlugin
       end
       @receiver.send(:include, third_party)
 
-      assert_equal 1, @receiver.hook1_count
-      assert_equal 1, @receiver.hook2_count
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
 
       @receiver.send(:include, TestPlugin)
 
-      assert_equal 1, @receiver.hook1_count
-      assert_equal 1, @receiver.hook2_count
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
 
       @receiver.send(:include, third_party)
 
-      assert_equal 1, @receiver.hook1_count
-      assert_equal 1, @receiver.hook2_count
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
     end
 
     TestPlugin = Module.new do
       include MuchPlugin
 
-      plugin_included{ inc_hook1 }
-      plugin_included{ inc_hook2 }
+      plugin_included{ inc_block1 }
+      plugin_included{ inc_block2 }
     end
-
   end
-
 end

metadata

@@ -1,39 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: much-plugin
-version: !ruby/object:Gem::Version 
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Kelly Redding
 - Collin Redding
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2016-06-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2019-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: assert
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.16.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.0
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.0
 description: An API to ensure mixin included logic (the "plugin") only runs once.
-email: 
+email:
 - kelly@kellyredding.com
 - collin.redding@me.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -44,35 +44,35 @@ files:
 - much-plugin.gemspec
 - test/helper.rb
 - test/support/factory.rb
+- test/system/much-plugin_tests.rb
 - test/unit/much-plugin_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/much-plugin
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - &id002 
-    - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: An API to ensure mixin included logic (the "plugin") only runs once.
-test_files: 
+test_files:
 - test/helper.rb
 - test/support/factory.rb
+- test/system/much-plugin_tests.rb
 - test/unit/much-plugin_tests.rb