much-mixin 0.0.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28fac94ed0a9f228774a872d2a0300825f5eb92c0e7b382af265936f21abd30b
-  data.tar.gz: 42992da0c84c834ac2b864fb08a02fa9dd4c252d143512052cdc9cfbde46e8e4
+  metadata.gz: 622a26403cc037812349be1ac6393a9b267edabab50137fb0fa22822a22bbd74
+  data.tar.gz: e4f1741bf4d76cbf19801e28c444b13d1d105c1904f6ceb25521f9661e9551bd
 SHA512:
-  metadata.gz: c2229eca4fda26cb23d960904055554436682e86a7bf2c760042727024f65d84691d721313a67c35226af2032034ae89065cd8a7105294644ddc19e0cc592f7e
-  data.tar.gz: c3acfab039cea2a7de5177b46fa4e47603626f0890927960dd59bbb4c38d1292b69188b2d783a52bd4f077a8c14c576e60fc159ae00602ee5c3108f11a6dbae8
+  metadata.gz: f60941f782d2429172804bbbbd019f4e5861826c1e35f98fc57891b00c692fc6fa2253d6770c271fd96797f69d7b0515a1c5f20e9471ee0bb7cdaf583ee9850b
+  data.tar.gz: 9d28a55999e7bff176243d45cbd5a087864d82449841793a152df65d17ac9b02deee595549575c565afab36fcd19d668d3c4c6e408241a2d9a504d973cceb5ba

data/README.md

@@ -19,13 +19,13 @@ module MyMuchMixin
 end
 ```
 
-Mix `MuchMixin` in on other mixins that act as "plugins" to other components.  Define included hooks using `mixin_included` that will be class eval'd in the scope of the receiver.
+Mix `MuchMixin` in on mix-ins. Define included hooks using `mixin_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.
+This allows you to define multiple hooks separately and ensures each hook will only be executed once - even if your mix-in is mixed-in multiple times on the same receiver.
 
 ### `mixin_class_methods` / `mixin_instance_methods`
 
-MuchMixin provides convenience methods for defining instance/class methods on plugin receivers:
+MuchMixin provides convenience methods for defining instance/class methods on receivers:
 
 ```ruby
 requre "much-mixin"
@@ -47,7 +47,7 @@ end
 
 ### `after_mixin_included`
 
-These hooks work just like the `mixin_included` hooks, except they are evaluated _after_ any plugin class/instance methods have been evaluated. E.g. use this to call a class method that the plugin defines.
+These hooks work just like the `mixin_included` hooks, except they are evaluated _after_ any mix-in class/instance methods have been evaluated. E.g. use this to call a class method that the mix-in defines.
 
 ```ruby
 requre "much-mixin"
@@ -56,11 +56,11 @@ module MyMuchMixin
   include MuchMixin
 
   after_mixin_included do
-    configure_the_plugin
+    configure_the_mixin
   end
 
   mixin_class_methods do
-    def configure_the_plugin
+    def configure_the_mixin
       # ...
     end
   end

data/lib/much-mixin.rb

@@ -8,37 +8,37 @@ module MuchMixin
   end
 
   module ClassMethods
-    # 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 `mixin_included` blocks
-    def included(plugin_receiver)
-      return if plugin_receiver.include?(self.much_mixin_included_detector)
-      plugin_receiver.send(:include, self.much_mixin_included_detector)
+    # Install an included block that first checks if the mix-in has already been
+    # included. If it has not been, include the receiver mixin and run all of
+    # the `mixin_included` blocks.
+    def included(mixin_receiver)
+      return if mixin_receiver.include?(self.much_mixin_included_detector)
+      mixin_receiver.send(:include, self.much_mixin_included_detector)
 
       self.much_mixin_included_blocks.each do |block|
-        plugin_receiver.class_eval(&block)
+        mixin_receiver.class_eval(&block)
       end
 
-      self.much_plugin_class_method_blocks.each do |block|
+      self.much_mixin_class_method_blocks.each do |block|
         self.much_mixin_class_methods_module.class_eval(&block)
       end
-      plugin_receiver.send(:extend, self.much_mixin_class_methods_module)
+      mixin_receiver.send(:extend, self.much_mixin_class_methods_module)
 
-      self.much_plugin_instance_method_blocks.each do |block|
+      self.much_mixin_instance_method_blocks.each do |block|
         self.much_mixin_instance_methods_module.class_eval(&block)
       end
-      plugin_receiver.send(:include, self.much_mixin_instance_methods_module)
+      mixin_receiver.send(:include, self.much_mixin_instance_methods_module)
 
-      self.much_plugin_after_included_blocks.each do |block|
-        plugin_receiver.class_eval(&block)
+      self.much_mixin_after_included_blocks.each do |block|
+        mixin_receiver.class_eval(&block)
       end
     end
 
-    # 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-mixin
+    # The included detector is an empty module that is only used to detect if
+    # the mix-in has been included or not. It doesn't add any behavior or
+    # methods to the receiver and uses `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-mixin.
     def much_mixin_included_detector
       @much_mixin_included_detector ||= Module.new.tap do |m|
         self.const_set("MuchMixinIncludedDetector", m)
@@ -61,36 +61,32 @@ module MuchMixin
       @much_mixin_included_blocks ||= []
     end
 
-    def much_plugin_after_included_blocks
-      @much_plugin_after_included_blocks ||= []
+    def much_mixin_after_included_blocks
+      @much_mixin_after_included_blocks ||= []
     end
 
-    def much_plugin_class_method_blocks
-      @much_plugin_class_method_blocks ||= []
+    def much_mixin_class_method_blocks
+      @much_mixin_class_method_blocks ||= []
     end
 
-    def much_plugin_instance_method_blocks
-      @much_plugin_instance_method_blocks ||= []
+    def much_mixin_instance_method_blocks
+      @much_mixin_instance_method_blocks ||= []
     end
 
     def mixin_included(&block)
       self.much_mixin_included_blocks << block
     end
-    alias_method :plugin_included, :mixin_included
 
     def after_mixin_included(&block)
-      self.much_plugin_after_included_blocks << block
+      self.much_mixin_after_included_blocks << block
     end
-    alias_method :after_plugin_included, :after_mixin_included
 
     def mixin_class_methods(&block)
-      self.much_plugin_class_method_blocks << block
+      self.much_mixin_class_method_blocks << block
     end
-    alias_method :plugin_class_methods, :mixin_class_methods
 
     def mixin_instance_methods(&block)
-      self.much_plugin_instance_method_blocks << block
+      self.much_mixin_instance_method_blocks << block
     end
-    alias_method :plugin_instance_methods, :mixin_instance_methods
   end
 end

data/lib/much-mixin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MuchMixin
-  VERSION = "0.0.1"
+  VERSION = "0.2.3"
 end

data/test/system/much-mixin_tests.rb

@@ -11,15 +11,15 @@ module MuchMixin
     end
     subject{ @my_class }
 
-    should "class eval the plugin included block on MyClass" do
+    should "class eval the mix-in included block on MyClass" do
       assert_equal "another", subject.another
     end
 
-    should "add the plugin class methods to MyClass" do
+    should "add the mix-in class methods to MyClass" do
       assert_equal "a-class-method", MyClass.a_class_method
     end
 
-    should "add the plugin instance methods to MyClass" do
+    should "add the mix-in instance methods to MyClass" do
       assert_equal "an-instance-method", subject.an_instance_method
     end
 

data/test/unit/much-mixin_tests.rb

@@ -25,9 +25,9 @@ module MuchMixin
       assert_same exp, subject.much_mixin_included_detector
     end
 
-    should "have no plugin included blocks by default" do
+    should "have no mix-in included blocks by default" do
       assert_empty subject.much_mixin_included_blocks
-      assert_empty subject.much_plugin_after_included_blocks
+      assert_empty subject.much_mixin_after_included_blocks
     end
 
     should "append blocks" do
@@ -52,7 +52,7 @@ module MuchMixin
       end
     end
 
-    should "call the plugin included blocks" do
+    should "call the mix-in included blocks" do
       assert_equal 0, @receiver.block1_count
       assert_equal 0, @receiver.block2_count
       assert_equal 0, @receiver.do_something_count

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: much-mixin
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Kelly Redding
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: assert
@@ -40,13 +40,11 @@ files:
 - bench/script.rb
 - lib/much-mixin.rb
 - lib/much-mixin/version.rb
-- lib/much-plugin.rb
 - log/.gitkeep
 - much-mixin.gemspec
 - test/helper.rb
 - test/support/factory.rb
 - test/system/much-mixin_tests.rb
-- test/system/much-plugin_tests.rb
 - test/unit/much-mixin_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/much-mixin
@@ -76,5 +74,4 @@ test_files:
 - test/helper.rb
 - test/support/factory.rb
 - test/system/much-mixin_tests.rb
-- test/system/much-plugin_tests.rb
 - test/unit/much-mixin_tests.rb

data/lib/much-plugin.rb

@@ -1,3 +0,0 @@
-require "much-mixin"
-
-MuchPlugin = MuchMixin

data/test/system/much-plugin_tests.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "assert"
-require "much-plugin"
-
-module MuchMixin
-  class SystemTests < Assert::Context
-    desc "MuchMixin"
-    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 MyMuchMixin
-      include MuchMixin
-
-      mixin_included do
-        include AnotherMixin
-      end
-
-      mixin_class_methods do
-        def a_class_method
-          "a-class-method"
-        end
-      end
-
-      mixin_instance_methods do
-        def an_instance_method
-          "an-instance-method"
-        end
-      end
-    end
-
-    class MyClass
-      include MyMuchMixin
-    end
-  end
-end