mtrack 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f9c9bb07bed7e3b987ad36fc5a7652a0d16c251
-  data.tar.gz: b979016ffe198365cc5a8cac84cb55a13833598f
+  metadata.gz: e4d96deb7df700e5f8bfa2ba688be09d7aa1073a
+  data.tar.gz: 927dded6ddd652b48bb95d59e4ea7971dbd084ec
 SHA512:
-  metadata.gz: 0652e5ba511e35770f6235913a33d6d3dff5c73e741c6be565380f7ddc31154f27de449ad77b437f7196493cb44a686f2543d4864adb97223a6eed7c7279a5a0
-  data.tar.gz: 6ae8c5a491700c4936d3c5579731cf0521b85d2d3e7c768d8a71cd57feacd51ed559f4dbf3c12e77fb805d8df77c9ea9df428bc3acbc02897049a217a50f3817
+  metadata.gz: 81679f5a7f76711e69250c4009ec6a752f9e90325db75d969c8ce967105294e754bdbef5feae328d554ffc03f259457f63da9a2540b0046a9838bfa1e40a3dd8
+  data.tar.gz: 6dd4234f6fe0efda95ea980dbaa903fe7a02963231815a0a25c9d9a53d935f1ceaae86b5b248e8aabfe346f6d6c6f48641e09d141ef4ea269830045b21e201dc

data/Gemfile

@@ -7,7 +7,7 @@ group :development do
   gem "guard-rubocop", "~> 1.2.0"
   gem "libnotify", "~> 0.8.4"
   gem "pry", "~> 0.10.1"
-  gem "rubocop", "~> 0.27.0"
+  gem "rubocop", "~> 0.27.1"
 end
 
 group :development, :test do

data/Guardfile

@@ -5,6 +5,8 @@ guard :rspec, :cmd => "rspec -fd" do
 end
 
 guard :rubocop do
-  watch(/.+\.rb$/)
-  watch(/(?:.+\/)?\.rubocop\.yml$/) {|m| File.dirname(m[0]) }
+  watch(/^.+\.rb$/)
+  watch(/^(?:.+\/)?\.rubocop\.yml$/) {|m| File.dirname(m[0]) }
+  watch(/^(?:.+\/)?.+\.gemspec$/)
+  watch(/^(?:.+\/)?(?:Gem|Rake)file$/)
 end

data/lib/mtrack/extension.rb

@@ -0,0 +1,48 @@
+module MTrack
+  ##
+  # This module is extended by Mixin and all custom extensions of Mixin. You should not extend this module directly,
+  # instead simply include Mixin into your custom extension:
+  #
+  #   module MyExtension
+  #     include MTrack::Mixin
+  #     # Define custom methods here.
+  #   end
+  #
+  #   module M
+  #     extend MyExtension
+  #     # You can use MTrack's and MyExtension's methods here.
+  #   end
+  #
+  # If you're overriding the +extended+ or +included+ methods in your custom extension always make sure to call +super+,
+  # so MTrack can be properly initialized.
+  module Extension
+    private
+
+    ##
+    # call-seq:
+    #   extended(submodule) => submodule
+    #
+    # Initializes a State variable on the Class or Module that extended Mixin.
+    #
+    # Returns passed +submodule+.
+    def extended(submodule)
+      super
+      submodule.instance_eval { @__mtrack__ ||= State.new }
+      submodule
+    end
+
+    ##
+    # call-seq:
+    #   included(submodule) => submodule
+    #
+    # Initializes +submodule+ as a custom extension of Mixin. The new custom extension +submodule+ can then be extended
+    # by a Class or Module just like Mixin, or included further to generate other, more specific custom extensions.
+    #
+    # Returns passed +submodule+.
+    def included(submodule)
+      super
+      submodule.instance_eval { extend Extension }
+      submodule
+    end
+  end
+end

data/lib/mtrack/mixin.rb

@@ -1,23 +1,29 @@
+require "mtrack/extension"
 require "mtrack/state"
 
 module MTrack
   ##
   # This module provides the #track_methods method to Classes or Modules that
-  # mix it in. It also enables the extended Class or Module to pass tracked
+  # extend it. It also enables the extended Class or Module to pass tracked
   # methods to its subclasses and submodules.
   module Mixin
+    extend Extension
+
     class << self
       private
 
       ##
       # call-seq:
-      #   extended(submodule) => submodule
+      #   init_heir(submodule, state) => submodule
       #
-      # Initializes a State variable on the Class or Module that extended Mixin.
+      # Sets +state+ as the super-state of +submodule+ (Class or Module).
       #
       # Returns passed +submodule+.
-      def extended(submodule)
-        submodule.instance_eval { @__mtrack__ ||= State.new }
+      def init_heir(submodule, state)
+        submodule.instance_eval do
+          extend Mixin
+          @__mtrack__.add_super_state state
+        end
         submodule
       end
 
@@ -102,12 +108,8 @@ module MTrack
     #
     # Returns passed +submodule+.
     def included(submodule)
-      state = @__mtrack__
-      submodule.instance_eval do
-        extend Mixin
-        @__mtrack__.add_super_state state
-      end
-      submodule
+      super
+      Mixin.send(:init_heir, submodule, @__mtrack__)
     end
 
     ##
@@ -118,7 +120,10 @@ module MTrack
     # inherited from the current Class.
     #
     # Returns passed +submodule+.
-    alias_method :inherited, :included
+    def inherited(submodule)
+      super
+      Mixin.send(:init_heir, submodule, @__mtrack__)
+    end
 
     ##
     # call-seq:
@@ -129,6 +134,7 @@ module MTrack
     #
     # Returns passed +name+.
     def method_added(name)
+      super
       @__mtrack__.delete_undefined name
     end
 
@@ -140,6 +146,7 @@ module MTrack
     #
     # Returns passed +name+.
     def method_removed(name)
+      super
       @__mtrack__.delete_tracked name
     end
 
@@ -153,6 +160,7 @@ module MTrack
     #
     # Returns passed +name+.
     def method_undefined(name)
+      super
       @__mtrack__.delete_tracked name
       @__mtrack__.add_undefined name
     end

data/lib/mtrack/version.rb

@@ -20,5 +20,5 @@
 #   D.tracked_methods  #=> #<Set: {:method_1, :method_2, :method_3}>
 module MTrack
   # Current version of MTrack.
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/spec/{lib/.rubocop.yml → .rubocop.yml}

@@ -1,4 +1,4 @@
 inherit_from:
-  - ../../.rubocop.yml
+  - ../.rubocop.yml
 Metrics/LineLength:
   Max: 140

data/spec/lib/mtrack/mixin_spec.rb

@@ -24,10 +24,39 @@ describe MTrack::Mixin do
   end
 
   describe "hierarchy" do
+    let(:base_extension_1) do
+      Module.new.tap do |m|
+        m.module_eval do
+          include MTrack::Mixin
+          define_method :base_extension_1_meth, METHOD_DEFINITION
+        end
+      end
+    end
+
+    let(:base_extension_2) do
+      Module.new.tap do |m|
+        m.module_eval do
+          include MTrack::Mixin
+          define_method :base_extension_2_meth, METHOD_DEFINITION
+        end
+      end
+    end
+
+    let(:sub_extension) do
+      be = base_extension_1
+      Module.new.tap do |m|
+        m.module_eval do
+          include be
+          define_method :sub_extension_meth, METHOD_DEFINITION
+        end
+      end
+    end
+
     let(:base_module_1) do
+      ext = sub_extension
       Module.new.tap do |m|
         m.module_eval do
-          extend MTrack::Mixin
+          extend ext
           define_method :unt_1, METHOD_DEFINITION
           track_methods { define_method :meth, METHOD_DEFINITION }
           track_methods :numbers do
@@ -40,9 +69,10 @@ describe MTrack::Mixin do
     end
 
     let(:base_module_2) do
+      ext = base_extension_2
       Module.new.tap do |m|
         m.module_eval do
-          extend MTrack::Mixin
+          extend ext
           define_method :unt_2, METHOD_DEFINITION
           track_methods { define_method :meth, METHOD_DEFINITION }
           track_methods :numbers do
@@ -159,6 +189,10 @@ describe MTrack::Mixin do
         subject.module_eval { define_method :meth, METHOD_DEFINITION }
         expect(subject.tracked_methods).to be_empty
       end
+
+      it "has custom extensions as ancestors" do
+        expect(subject.singleton_methods.map(&:to_sym)).to include(:base_extension_1_meth, :sub_extension_meth)
+      end
     end
 
     context "base module 2" do
@@ -183,6 +217,10 @@ describe MTrack::Mixin do
         subject.module_eval { define_method :meth, METHOD_DEFINITION }
         expect(subject.tracked_methods).to be_empty
       end
+
+      it "has custom extensions as ancestors" do
+        expect(subject.singleton_methods.map(&:to_sym)).to include(:base_extension_2_meth)
+      end
     end
 
     context "base module 3" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtrack
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Gabriel de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies: []
 description: MTrack extends the functionality of modules and classes and enables them
   to define public methods within groups. These methods can then be queried back even
@@ -29,12 +29,13 @@ files:
 - README.md
 - Rakefile
 - lib/mtrack.rb
+- lib/mtrack/extension.rb
 - lib/mtrack/mixin.rb
 - lib/mtrack/state.rb
 - lib/mtrack/state/group.rb
 - lib/mtrack/version.rb
 - mtrack.gemspec
-- spec/lib/.rubocop.yml
+- spec/.rubocop.yml
 - spec/lib/mtrack/mixin_spec.rb
 - spec/lib/mtrack/state/group_spec.rb
 - spec/lib/mtrack/state_spec.rb
@@ -67,7 +68,7 @@ signing_key:
 specification_version: 4
 summary: Group and track methods on classes and modules.
 test_files:
-- spec/lib/.rubocop.yml
+- spec/.rubocop.yml
 - spec/lib/mtrack/mixin_spec.rb
 - spec/lib/mtrack/state/group_spec.rb
 - spec/lib/mtrack/state_spec.rb