mtrack 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 560415a9be1f9e76a1a0ea6d7de1d349a4878deb
-  data.tar.gz: 2faa7e600966d3f2c686c30aeaf05e0c5f627136
+  metadata.gz: 0bfca617210cbd6c56886b4eb185dc4fd6953204
+  data.tar.gz: d3af2f661de85f44e958ec5090515b40c032bd44
 SHA512:
-  metadata.gz: 1c3242c119adc1f937409f5334bbf2fd41ac5b8a8db5eda1acb21ff07a74bfa6e074f95ad086d256ec873e687e5b10c57c6112113ed555527ecd325f61212675
-  data.tar.gz: 162df5d0a5f8cbedcd9ac48e6c4d126ffb2dde583e669c6ad3f8c978259b577874739d193342dfba993e0f58b059e39e3cc57cb32538f3317f57496fa6200395
+  metadata.gz: a186ed9e60cd1dec8355f127ae9b5b19000804726b169b0e23baa49c5a2e4610dfd6d13d0a2abe676c5bd4ec375dbe2f5487b448cc5468a7490b6a72d3d7e49a
+  data.tar.gz: 57a5be4b178c3215f3ea0d58cb4632be748be4b2cc2453193aff60b5c53890090af23154f28f4b964309e467eadea1eb29bace8319df13c5011deeb9499aedc3

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec, cmd: "rspec" do
+guard :rspec, cmd: "rspec -fd" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$}) {|m| "spec/lib/#{m[1]}_spec.rb" }
   watch("spec/spec_helper.rb") { "spec" }

data/README.md

@@ -11,6 +11,7 @@
 [travis]: http://travis-ci.org/gdeoliveira/mtrack
 [codeclimate]: https://codeclimate.com/github/gdeoliveira/mtrack
 [gemnasium]: https://gemnasium.com/gdeoliveira/mtrack
+[gemnasium]: https://gemnasium.com/gdeoliveira/mtrack#development-dependencies
 [inch-ci]: http://inch-ci.org/github/gdeoliveira/mtrack
 
 MTrack extends the functionality of Modules and Classes and enables them to

data/lib/mtrack/core.rb

@@ -13,9 +13,7 @@ module MTrack
     # call-seq:
     #   tracked_methods(group_name = nil) => set
     #
-    # Returns a set containing the currently tracked methods. An optional
-    # +group_name+ parameter can be passed to get the tracked methods of groups
-    # othen than the default +nil+ group.
+    # Returns a set containing the currently tracked methods for a +group_name+.
     #
     #   class C
     #     track_methods :my_group do
@@ -75,5 +73,26 @@ module MTrack
       @__mtrack__.delete_tracked name
       @__mtrack__.add_undefined name
     end
+
+    ##
+    # call-seq:
+    #   track_methods_with_block(group_name) {|| ... } => set
+    #
+    # All the methods defined within the block will be tracked under the
+    # +group_name+ parameter.
+    #
+    # Returns a set containing the methods that were defined within the block.
+    def track_methods_with_block(group_name, &b)
+      old_methods = public_instance_methods(false)
+
+      begin
+        module_eval(&b)
+      ensure
+        tracked = (public_instance_methods(false) - old_methods).map(&:to_sym).to_set
+        @__mtrack__[group_name].merge_tracked tracked unless tracked.empty?
+      end
+
+      tracked
+    end
   end
 end

data/lib/mtrack/module_mixin.rb

@@ -35,18 +35,8 @@ module MTrack
     def track_methods(group_name = nil, &b)
       @__mtrack__ ||= State.new
       extend Core
-
-      if block_given?
-        old_methods = public_instance_methods(false)
-        begin
-          module_eval(&b)
-        ensure
-          tracked = (public_instance_methods(false) - old_methods).map(&:to_sym).to_set
-          @__mtrack__[group_name].merge_tracked tracked unless tracked.empty?
-        end
-      end
-
-      tracked || Set.new
+      return track_methods_with_block(group_name, &b) if block_given?
+      Set.new
     end
   end
 end

data/lib/mtrack/state.rb

@@ -14,6 +14,9 @@ module MTrack
     #
     # Creates a new State instance. An optional +super_state+ parameter can be
     # passed that will be added to #super_states.
+    #
+    #   super_state = MTrack::State.new
+    #   sub_state = MTrack::State.new(super_state)
     def initialize(super_state = nil)
       self.groups = {}
       self.super_states = super_state ? Set[super_state] : Set.new
@@ -24,8 +27,9 @@ module MTrack
     # call-seq:
     #   state[group_name] => group
     #
-    # Returns a particular group in #groups. If the group doesn't exist it will
-    # be created.
+    # Accepts a +group_name+ passed as a parameter.
+    #
+    # Returns an existing or a new group associated with +group_name+.
     def [](group_name)
       groups[group_name] ||= Group.new
     end
@@ -34,7 +38,9 @@ module MTrack
     # call-seq:
     #   add_super_state(state) => state
     #
-    # Adds a new state to #super_states.
+    # Adds a new +state+ to the #super_states set.
+    #
+    # Returns passed +state+.
     def add_super_state(state)
       super_states.add state
       state
@@ -45,6 +51,8 @@ module MTrack
     #   add_undefined(name) => name
     #
     # Adds +name+ to the #undefined methods set.
+    #
+    # Returns passed +name+.
     def add_undefined(name)
       undefined.add name
       name
@@ -55,6 +63,8 @@ module MTrack
     #   delete_tracked(name) => name
     #
     # Removes method +name+ from all #groups.
+    #
+    # Returns passed +name+.
     def delete_tracked(name)
       groups.each {|k, v| v.delete_tracked name }
       name
@@ -65,6 +75,8 @@ module MTrack
     #   delete_undefined(name) => name
     #
     # Removes +name+ from the #undefined methods set.
+    #
+    # Returns passed +name+.
     def delete_undefined(name)
       undefined.delete name
       name
@@ -74,9 +86,7 @@ module MTrack
     # call-seq:
     #   tracked(group_name = nil) => set
     #
-    # Returns a set containing the currently tracked methods. An optional
-    # +group_name+ parameter can be passed to get the tracked methods of groups
-    # othen than the default +nil+ group.
+    # Returns a set containing the currently tracked methods for a +group_name+.
     def tracked(group_name = nil)
       ret_val = merge_super_states group_name
       ret_val.merge groups[group_name].tracked unless groups[group_name].nil?

data/lib/mtrack/state/group.rb

@@ -21,6 +21,8 @@ module MTrack
       #   delete_tracked(name) => name
       #
       # Removes method +name+ from tracked methods.
+      #
+      # Returns passed +name+.
       def delete_tracked(name)
         @tracked.delete name
         name
@@ -31,6 +33,8 @@ module MTrack
       #   merge_tracked(names) => names
       #
       # Adds method +names+ to tracked methods.
+      #
+      # Returns passed +names+.
       def merge_tracked(names)
         @tracked.merge names
         names

data/lib/mtrack/version.rb

@@ -20,5 +20,5 @@
 module MTrack
 
   # Current version of MTrack.
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/mtrack/module_mixin_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe MTrack::ModuleMixin do
+  describe "#track_methods" do
+    context "no block given" do
+      it "returns an empty set" do
+        ret_val = ::Module.new.module_eval { track_methods :group }
+        expect(ret_val).to be_a(Set)
+        expect(ret_val).to be_empty
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtrack
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gabriel de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-08-22 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
@@ -35,6 +35,7 @@ files:
 - lib/mtrack/version.rb
 - mtrack.gemspec
 - spec/lib/mtrack/core_spec.rb
+- spec/lib/mtrack/module_mixin_spec.rb
 - spec/lib/mtrack/state/group_spec.rb
 - spec/lib/mtrack/state_spec.rb
 - spec/lib/mtrack/version_spec.rb
@@ -67,6 +68,7 @@ specification_version: 4
 summary: Group and track methods on classes and modules.
 test_files:
 - spec/lib/mtrack/core_spec.rb
+- spec/lib/mtrack/module_mixin_spec.rb
 - spec/lib/mtrack/state/group_spec.rb
 - spec/lib/mtrack/state_spec.rb
 - spec/lib/mtrack/version_spec.rb