much-mixin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28fac94ed0a9f228774a872d2a0300825f5eb92c0e7b382af265936f21abd30b
+  data.tar.gz: 42992da0c84c834ac2b864fb08a02fa9dd4c252d143512052cdc9cfbde46e8e4
+SHA512:
+  metadata.gz: c2229eca4fda26cb23d960904055554436682e86a7bf2c760042727024f65d84691d721313a67c35226af2032034ae89065cd8a7105294644ddc19e0cc592f7e
+  data.tar.gz: c3acfab039cea2a7de5177b46fa4e47603626f0890927960dd59bbb4c38d1292b69188b2d783a52bd4f077a8c14c576e60fc159ae00602ee5c3108f11a6dbae8

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.log
+*.rbc
+.rbx/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "~> 2.5"
+
+gemspec
+
+gem "pry"
+
+# to release, uncomment this and run `bundle exec ggem r -f`
+# gem "ggem"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-Present Kelly Redding and Collin Redding
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# MuchMixin
+
+Enhanced mix-in API.
+
+## Usage
+
+```ruby
+requre "much-mixin"
+
+module MyMuchMixin
+  include MuchMixin
+
+  mixin_included do
+    # do some stuff ...
+    # - will be class eval'd in the scope of the receiver of `MyMuchMixin`
+    # - will only be executed once per receiver, no matter how many times
+    #   `MyMuchMixin` is included in that receiver
+  end
+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.
+
+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.
+
+### `mixin_class_methods` / `mixin_instance_methods`
+
+MuchMixin provides convenience methods for defining instance/class methods on plugin receivers:
+
+```ruby
+requre "much-mixin"
+
+module MyMuchMixin
+  include MuchMixin
+
+  mixin_class_methods do
+    # define some methods ...
+    # - these methods will become class methods on the receiver
+  end
+
+  mixin_instance_methods do
+    # define some methods ...
+    # - these methods will become instance methods on the receiver
+  end
+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.
+
+```ruby
+requre "much-mixin"
+
+module MyMuchMixin
+  include MuchMixin
+
+  after_mixin_included do
+    configure_the_plugin
+  end
+
+  mixin_class_methods do
+    def configure_the_plugin
+      # ...
+    end
+  end
+end
+```
+
+## Example
+
+```ruby
+requre "much-mixin"
+
+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
+
+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:
+
+    gem "much-mixin"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install much-mixin
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bench/script.rb

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

data/lib/much-mixin.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "much-mixin/version"
+
+module MuchMixin
+  def self.included(receiver)
+    receiver.class_eval{ extend ClassMethods }
+  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)
+
+      self.much_mixin_included_blocks.each do |block|
+        plugin_receiver.class_eval(&block)
+      end
+
+      self.much_plugin_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)
+
+      self.much_plugin_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)
+
+      self.much_plugin_after_included_blocks.each do |block|
+        plugin_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
+    def much_mixin_included_detector
+      @much_mixin_included_detector ||= Module.new.tap do |m|
+        self.const_set("MuchMixinIncludedDetector", m)
+      end
+    end
+
+    def much_mixin_class_methods_module
+      @much_mixin_class_methods_module ||= Module.new.tap do |m|
+        self.const_set("MuchMixinClassMethods", m)
+      end
+    end
+
+    def much_mixin_instance_methods_module
+      @much_mixin_instance_methods_module ||= Module.new.tap do |m|
+        self.const_set("MuchMixinInstanceMethods", m)
+      end
+    end
+
+    def much_mixin_included_blocks
+      @much_mixin_included_blocks ||= []
+    end
+
+    def much_plugin_after_included_blocks
+      @much_plugin_after_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 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
+    end
+    alias_method :after_plugin_included, :after_mixin_included
+
+    def mixin_class_methods(&block)
+      self.much_plugin_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
+    end
+    alias_method :plugin_instance_methods, :mixin_instance_methods
+  end
+end

data/lib/much-mixin/version.rb

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

data/lib/much-plugin.rb

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

data/much-mixin.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "much-mixin/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "much-mixin"
+  gem.version     = MuchMixin::VERSION
+  gem.authors     = ["Kelly Redding", "Collin Redding"]
+  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
+  gem.summary     = %q{Enhanced mix-in API.}
+  gem.description = %q{Enhanced mix-in API.}
+  gem.homepage    = "http://github.com/redding/much-mixin"
+  gem.license     = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.5"
+
+  gem.add_development_dependency("assert", ["~> 2.19.2"])
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# this file is automatically required when you run `assert`
+# put any test helpers here
+
+# add the root dir to the load path
+$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
+
+# require pry for debugging (`binding.pry`)
+require "pry"
+
+require "test/support/factory"

data/test/support/factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "assert/factory"
+
+module Factory
+  extend Assert::Factory
+end

data/test/system/much-mixin_tests.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "assert"
+require "much-mixin"
+
+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

data/test/system/much-plugin_tests.rb

@@ -0,0 +1,56 @@
+# 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

data/test/unit/much-mixin_tests.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "assert"
+require "much-mixin"
+
+module MuchMixin
+  class UnitTests < Assert::Context
+    desc "MuchMixin"
+    setup do
+      @block1 = proc{ 1 }
+      @block2 = proc{ 2 }
+
+      @muchmixin = Module.new{ include MuchMixin }
+    end
+    subject{ @muchmixin }
+
+    should have_imeths :much_mixin_included_detector, :much_mixin_included_blocks
+    should have_imeths :mixin_included, :after_mixin_included
+
+    should "know its included detector" do
+      mixin = subject.much_mixin_included_detector
+      assert_instance_of Module, mixin
+      assert_same mixin, subject.much_mixin_included_detector
+      exp = subject::MuchMixinIncludedDetector
+      assert_same exp, subject.much_mixin_included_detector
+    end
+
+    should "have no plugin included blocks by default" do
+      assert_empty subject.much_mixin_included_blocks
+      assert_empty subject.much_plugin_after_included_blocks
+    end
+
+    should "append blocks" do
+      subject.mixin_included(&@block1)
+      subject.mixin_included(&@block2)
+
+      assert_equal @block1, subject.much_mixin_included_blocks.first
+      assert_equal @block2, subject.much_mixin_included_blocks.last
+    end
+  end
+
+  class MixedInTests < UnitTests
+    desc "when mixed in"
+    setup do
+      @receiver = Class.new do
+        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
+
+        def self.do_something_count; @do_something_count ||= 0; end
+      end
+    end
+
+    should "call the plugin included blocks" do
+      assert_equal 0, @receiver.block1_count
+      assert_equal 0, @receiver.block2_count
+      assert_equal 0, @receiver.do_something_count
+
+      @receiver.send(:include, TestMuchMixin)
+
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
+      assert_equal 1, @receiver.do_something_count
+    end
+
+    should "call blocks only once no matter even if previously mixed in" do
+      @receiver.send(:include, TestMuchMixin)
+
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
+      assert_equal 1, @receiver.do_something_count
+
+      @receiver.send(:include, TestMuchMixin)
+
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
+      assert_equal 1, @receiver.do_something_count
+    end
+
+    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, TestMuchMixin)
+        end
+      end
+      @receiver.send(:include, third_party)
+
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
+      assert_equal 1, @receiver.do_something_count
+
+      @receiver.send(:include, TestMuchMixin)
+
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
+      assert_equal 1, @receiver.do_something_count
+
+      @receiver.send(:include, third_party)
+
+      assert_equal 1, @receiver.block1_count
+      assert_equal 1, @receiver.block2_count
+      assert_equal 1, @receiver.do_something_count
+    end
+  end
+
+  TestMuchMixin =
+    Module.new do
+      include MuchMixin
+
+      mixin_included{ inc_block1 }
+      after_mixin_included{
+        inc_block2
+        do_something
+      }
+
+      mixin_class_methods do
+        def do_something
+          @do_something_count ||= 0
+          @do_something_count += 1
+        end
+      end
+    end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: much-mixin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kelly Redding
+- Collin Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.2
+description: Enhanced mix-in API.
+email:
+- kelly@kellyredding.com
+- collin.redding@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Enhanced mix-in API.
+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