system_navigation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0877e736a201bde13a94bb2fd54462777c30878
-  data.tar.gz: 0f072306d97e8b2d3f2697c3601e279bc5b6ffdd
+  metadata.gz: b9f601aa746ea3e24e18be9512a868d9da486641
+  data.tar.gz: d73ce895b246cf274edefb11849d0d28a92637a1
 SHA512:
-  metadata.gz: 4d9106cdc061404ae1ab11859ce526994ed3e478d4f21fc200304af7cf56bff513bb4c6b2fb1485ddb6963048d7eaa722e257920269a50f971eee7c92a30fc4a
-  data.tar.gz: 41cb455b27e76c9bb4b54d5197d25a17f7823dc5f661ddebd3cdc5a15dc513834afb347279dda38f16f5da338bc709d30d174bf5166ab23a151c08f0c8085d16
+  metadata.gz: 6b54b78bbe3cb2bdb37ca96e13b0cd2a45bf4acff23cf0a453a450f46d9b4622f600775fed775d93eedaf5d7452c1544040d9fb2883119c26eb4e60c74e53004
+  data.tar.gz: 43f8a64c12f39bf151260de576446b2ac445b081160eb6fd806cd79d0960582688324f55a6924ce39bbd93a1f642d0334b8903905de38bdd4ea1feeb1f43016e

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 System Navigation changelog
 ===========================
 
+### v0.2.0 (June 19, 2015)
+
+* Initial release (for real now)
+
 ### v0.1.0 (June 11, 2015)
 
 * Initial release (sorta, not ready yet)

data/README.md

@@ -1,16 +1,39 @@
 SystemNavigation
 ==
 
-* Repository: [https://github.com/kyrylo/system_navigation/](https://github.com/kyrylo/system_navigation/)
+* [Repository](https://github.com/kyrylo/system_navigation/)
+* [Documentation](http://www.rubydoc.info/gems/system_navigation)
 
 Description
 -----------
 
-SystemNavigation is a Ruby library that provides support for the navigation and
-introspection of Ruby programs. It is inspired by the eponymous class in
-Pharo/Squeak.
+SystemNavigation is a Ruby library that provides additional introspection
+capabilities for Ruby programs. The library defines a number of useful methods
+that allow querying:
 
-Sneak peek:
+* methods for instance, class or global variables
+* methods for literals such as numbers, strings, symbols, etc.
+* methods for finding a specific string (method source search)
+* classes and modules that implement given methods
+* classes and modules that send messages
+* all classes and modules in gems
+* and many more...
+
+For the complete list of features please read the documentation or _read the
+tests_. All interaction with the library is done via the `SystemNavigation`
+class and its class methods. The description of the methods can be found in
+these places:
+
+* [SystemNavigation](http://www.rubydoc.info/gems/system_navigation/SystemNavigation)
+* [SystemNavigation::RubyEnvironment](http://www.rubydoc.info/gems/system_navigation/SystemNavigation/RubyEnvironment)
+
+Examples (full list in the documentation)
+--
+
+##### #all_accesses
+
+Retrieve all methods that access instance variables in the given class/module
+including its ancestors and children.
 
 ```ruby
 module M
@@ -35,27 +58,48 @@ sn.all_accesses(to: :@num, from: A)
 #=> [#<UnboundMethod: A#num>, #<UnboundMethod: A(M)#increment>, #<UnboundMethod: A#initialize>]
 ```
 
-And many more...
+##### #all_implementors_of
 
-Installation
-------------
+Find all classes and modules that implement the given message.
 
-All you need is to install the gem.
+```ruby
+sn = SystemNavigation.default
 
-    gem install system_navigation
+sn.all_implementors_of(:puts)
+#=> [ARGF.class, IO, Kernel, ..., YARD::Logger]
+```
 
-Synopsis
----
+##### #all_calls
 
-### Precaution
+Find all methods in Bundler that invoke the `1` literal.
 
-The library is very young and its API is far from stable. Some behaviours
-might be unexpected or bugged. Feel free to file issues if you feel like the
-result you expect isn't what you actually get.
+```ruby
+require 'bundler'
+
+sn = SystemNavigation.default
+
+sn.all_calls(on: 1, gem: 'bundler')
+#=> [#<UnboundMethod: #<Class:Bundler>#with_clean_env>, #<UnboundMethod: #<Class:Bundler>#eval_gemspec>]
+```
 
-### API
+##### #all_objects
 
-See the [API.md](/docs/API.md) file.
+Retrieve all objects defined in the system.
+
+```ruby
+sn = SystemNavigation.default
+
+sn.all_objects.map(&:class).uniq.count #=> 158
+```
+
+And many more...
+
+Installation
+------------
+
+All you need is to install the gem.
+
+    gem install system_navigation
 
 Limitations
 -----------
@@ -64,6 +108,11 @@ Supports *only* CRuby.
 
 * CRuby 2.2.2 and higher
 
+Credits
+-------
+
+* Inspired by Smalltalk
+
 License
 -------
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/system_navigation.rb

@@ -17,6 +17,12 @@ require_relative 'system_navigation/instruction_stream/decoder'
 require_relative 'system_navigation/instruction_stream/instruction'
 require_relative 'system_navigation/instruction_stream/instruction/attr_instruction'
 
+# SystemNavigation is a class that provides some introspection capabilities. It
+# is based on a Smalltalk class with a similar name. This is the only public
+# class in this library.
+#
+# @api public
+# @since 0.1.0
 class SystemNavigation
   # The VERSION file must be in the root directory of the library.
   VERSION_FILE = File.expand_path('../../VERSION', __FILE__)
@@ -31,19 +37,35 @@ class SystemNavigation
                  :all_behaviors, :all_classes, :all_classes_and_modules,
                  :all_modules, :all_objects
 
+  ##
+  # Creates a new instance of SystemNavigation. It is added for compatibility
+  # with Smalltalk users.
+  #
+  # @example
+  #   require 'system_navigation'
+  #
+  #   sn = SystemNavigation.default
   def self.default
     self.new
   end
 
+  VAR_TEMPLATE = /\A[\$@]@?.+/
+  private_constant :VAR_TEMPLATE
+
   def initialize
     @environment = SystemNavigation::RubyEnvironment.new
   end
 
   ##
-  # Query methods for instance variables in descending (subclasses) and
-  # ascending (superclasses) fashion.
+  # Query methods for instance/global/class variables in descending (subclasses)
+  # and ascending (superclasses) fashion.
   #
-  # @example Global
+  # @note This is a very costly operation, if you don't provide the +from+
+  #   argument
+  # @note This method _does_ _not_ perform _global_ queries,
+  #   only relative to +from+
+  #
+  # @example Global scope (start search from BasicObject)
   #   class A
   #     def initialize
   #       @foo = 1
@@ -57,7 +79,7 @@ class SystemNavigation
   #   sn.all_accesses(to: :@foo)
   #   #=> [#<UnboundMethod: A#initialize>, #<UnboundMethod: B#foo>]
   #
-  # @example Local
+  # @example Local scope
   #   class A
   #     def initialize
   #       @foo = 1
@@ -83,20 +105,45 @@ class SystemNavigation
   #   end
   #
   #   sn.all_accesses(to: :@foo, only_get: true)
-  #   #=> [#<UnboundMethod: B#foo>]
+  #   #=> [#<UnboundMethod: B#initialize>]
+  #
+  # @example Only set invokations
+  #   class A
+  #     def initialize
+  #       @foo = 1
+  #     end
+  #   end
+  #
+  #   class B
+  #     attr_reader :foo
+  #   end
+  #
+  #   sn.all_accesses(to: :@foo, only_set: true)
+  #   #=> [#<UnboundMethod: A#initialize>]
   #
-  # @param to [Symbol] The name of the instance variable to search for
+  # @example Accesses to global variables
+  #   sn.all_accesses(to: :$DEBUG)
+  #   #=> [#<UnboundMethod: Gem::Specification#inspect>, ...]
+  #
+  # @example Accesses to class variables
+  #   sn.all_accesses(to: :@@required_attributes)
+  #   #=> [#<UnboundMethod: Gem::Specification#validate>, ...]
+  #
+  # @param to [Symbol] The name of the instance/global/class variable to search
+  #   for
   # @param from [Class] The class that limits the scope of the query. Optional.
   #   If omitted, performs the query starting from the top of the object
   #   hierarchy (BasicObject)
   # @param only_get [Boolean] Limits the scope of the query only to methods that
-  #   write into the +ivar+. Optional. Mutually exclusive with +only_set+
+  #   write into the +var+. Optional. Mutually exclusive with +only_set+
   # @param only_set [Boolean] Limits the scope of the query only to methods that
-  #   read from the +ivar+. Optional. Mutually exclusive with +only_get+
-  # @return [Array<UnboundMethod>] methods that access the +ivar+ according to
+  #   read from the +var+. Optional. Mutually exclusive with +only_get+
+  # @return [Array<UnboundMethod>] methods that access the +var+ according to
   #   the given scope
-  # @note This is a very costly operation, if you don't provide the +from+
-  #   argument
+  # @raise [ArgumentError] if both +:only_get+ and +:only_set+ were provided
+  # @raise [TypeError] if +:from+ is not a class
+  # @raise [ArgumentError] if +:to+ is not a Symbol representing either of
+  #   these: class variable, instance variable, global variable
   def all_accesses(to:, from: nil, only_get: nil, only_set: nil)
     if only_set && only_get
       fail ArgumentError, 'both only_get and only_set were provided'
@@ -106,15 +153,32 @@ class SystemNavigation
       fail TypeError, "from must be a Class (#{from.class} given)"
     end
 
+    unless to.match(VAR_TEMPLATE)
+      fail ArgumentError, 'invalid argument for the `to:` attribute'
+    end
+
     (from || BasicObject).with_all_sub_and_superclasses.flat_map do |klass|
       klass.select_methods_that_access(to, only_get, only_set)
     end
   end
 
   ##
-  # Query methods for literals they call.
+  # Query methods for literals they call. The supported literals:
+  #   * Hashes (only simple Hashes that consist of literals itself)
+  #   * Arrays (only simple Arrays that consist of literals itself)
+  #   * +true+, +false+ and +nil+
+  #   * Integers (same Integers represented with different notations are treated
+  #     as the same number)
+  #   * Floats
+  #   * Strings
+  #   * Ranges
   #
-  # @example Global
+  # @note This is a very costly operation, if you don't provide the +from+
+  #   argument
+  # @note The list of supported literals can be found here:
+  #   http://ruby-doc.org/core-2.2.2/doc/syntax/literals_rdoc.html
+  #
+  # @example Global scope (every behaviour in this process)
   #   class A
   #     def foo
   #       :hello
@@ -130,7 +194,7 @@ class SystemNavigation
   #   sn.all_calls(on: :hello)
   #   #=> [#<UnboundMethod: A#foo>, #<UnboundMethod: B#bar>]
   #
-  # @example Local
+  # @example Local scope
   #   class A
   #     def foo
   #       :hello
@@ -158,10 +222,7 @@ class SystemNavigation
   # @param gem [String] Limits the scope of the query only to methods
   #   that are defined in the RubyGem +gem+ classes and modules. Optional.
   # @return [Array<UnboundMethod>] methods that call the given +literal+
-  # @note This is a very costly operation, if you don't provide the +from+
-  #   argument
-  # @note The list of supported literals can be found here:
-  #   http://ruby-doc.org/core-2.2.2/doc/syntax/literals_rdoc.html
+  # @raise [ArgumentError] if both keys (+from:+ and +gem:+) are given
   def all_calls(on:, from: nil, gem: nil)
     if from && gem
       fail ArgumentError, 'both from and gem were provided'
@@ -179,7 +240,7 @@ class SystemNavigation
   end
 
   ##
-  # Query classes for the methods they implement.
+  # Query classes for methods they implement.
   #
   # @example
   #   sn.all_classes_implementing(:~)
@@ -223,6 +284,9 @@ class SystemNavigation
   ##
   # Query gems for classes they implement.
   #
+  # @note This method is not precise. If a class/method in the given gem does
+  #   not implement any methods, it won't be included in the result.
+  #
   # @example
   #   sn.all_classes_in_gem_named('system_navigation')
   #   #=> [SystemNavigation::AncestorMethodFinder, ..., SystemNavigation]
@@ -237,6 +301,9 @@ class SystemNavigation
   ##
   # Query gems for modules they implement.
   #
+  # @note This method is not precise. If a class/method in the given gem does
+  #   not implement any methods, it won't be included in the result.
+  #
   # @example
   #   sn.all_modules_in_gem_named('pry-theme')
   #   #=> [PryTheme::Theme::DefaultAttrs, ..., PryTheme]
@@ -250,6 +317,9 @@ class SystemNavigation
   ##
   # Query gems for classes and modules they implement.
   #
+  # @note This method is not precise. If a class/method in the given gem does
+  #   not implement any methods, it won't be included in the result.
+  #
   # @example
   #   sn.all_classes_and_modules_in_gem_named('pry-theme')
   #   #=> [PryTheme::Preview, ..., PryTheme::Color256]
@@ -262,7 +332,7 @@ class SystemNavigation
   end
 
   ##
-  # Get all methods defined in current Ruby process.
+  # Get all methods defined in the current Ruby process.
   #
   # @example
   #   sn.all_methods
@@ -298,9 +368,8 @@ class SystemNavigation
   #     end
   #   end
   #
-  #
-  # sn.all_methods_with_source(string: 'hello_hi')
-  # #=> [#<UnboundMethod: B#bar>, #<UnboundMethod: A#foo>, #<UnboundMethod: M#foo>]
+  #   sn.all_methods_with_source(string: 'hello_hi')
+  #   #=> [#<UnboundMethod: B#bar>, #<UnboundMethod: A#foo>, #<UnboundMethod: M#foo>]
   #
   # @param string [String] The string to be searched for
   # @param match_case [Boolean] Whether to match case or not. Optional

data/lib/system_navigation/compiled_method.rb

@@ -4,6 +4,12 @@ class SystemNavigation
       self.new(method).compile
     end
 
+    IVAR = /\A@[^@]/
+    CVAR = /\A@@/
+    GVAR = /\A\$/
+
+    attr_reader :source
+
     def initialize(method)
       @method = method
       @scanner = SystemNavigation::InstructionStream.on(method)
@@ -47,12 +53,30 @@ class SystemNavigation
       exptree.includes?(literal)
     end
 
-    def reads_field?(ivar)
-      self.scan_for { @decoder.ivar_read_scan(ivar) }
+    def reads_field?(var)
+      case var
+      when IVAR
+        self.scan_for { @decoder.ivar_read_scan(var) }
+      when CVAR
+        self.scan_for { @decoder.cvar_read_scan(var) }
+      when GVAR
+        self.scan_for { @decoder.gvar_read_scan(var) }
+      else
+        raise ArgumentError, "unknown argument #{var}"
+      end
     end
 
-    def writes_field?(ivar)
-      self.scan_for { @decoder.ivar_write_scan(ivar) }
+    def writes_field?(var)
+      case var
+      when IVAR
+        self.scan_for { @decoder.ivar_write_scan(var) }
+      when CVAR
+        self.scan_for { @decoder.cvar_write_scan(var) }
+      when GVAR
+        self.scan_for { @decoder.gvar_write_scan(var) }
+      else
+        raise ArgumentError, "unknown argument #{var}"
+      end
     end
 
     def sends_message?(message)

data/lib/system_navigation/expression_tree.rb

@@ -60,6 +60,8 @@ class SystemNavigation
     end
 
     def unify(node)
+      return unless node
+
       node.each do |n|
         if n.instance_of?(Array)
           if n.size == 2 && n.all? { |num| num.instance_of?(Fixnum) }

data/lib/system_navigation/instruction_stream/decoder.rb

@@ -42,6 +42,30 @@ class SystemNavigation
         end
       end
 
+      def gvar_read_scan(gvar)
+        self.select_instructions(literal: gvar) do |_prev_prev, prev, instruction|
+          next instruction if instruction.reads_gvar?(gvar)
+        end
+      end
+
+      def gvar_write_scan(gvar)
+        self.select_instructions(literal: gvar) do |prev_prev, prev, instruction|
+          next instruction if instruction.writes_gvar?(gvar)
+        end
+      end
+
+      def cvar_read_scan(cvar)
+        self.select_instructions(literal: cvar) do |_prev_prev, prev, instruction|
+          next instruction if instruction.reads_cvar?(cvar)
+        end
+      end
+
+      def cvar_write_scan(cvar)
+        self.select_instructions(literal: cvar) do |prev_prev, prev, instruction|
+          next instruction if instruction.writes_cvar?(cvar)
+        end
+      end
+
       def literal_scan(literal)
         name = @scanner.method.original_name
 

data/lib/system_navigation/instruction_stream/instruction.rb

@@ -14,6 +14,8 @@ class SystemNavigation
         @lineno = nil
         @op_id = nil
         @ivar = nil
+        @gvar = nil
+        @cvar = nil
         @service_instruction = false
       end
 
@@ -25,7 +27,7 @@ class SystemNavigation
         parse_operand
         parse_lineno
         parse_op_id
-        parse_ivar
+        parse_var
 
         self
       end
@@ -57,7 +59,7 @@ class SystemNavigation
         elsif @raw.check(%r{/})
           @operand = @raw.scan(%r{/.*/})
         else
-          @operand = @raw.scan(/-?[0-9a-zA-Z:@_=.]+/)
+          @operand = @raw.scan(/-?[0-9a-zA-Z:@_=.$]+/)
 
           if @raw.peek(1) == ','
             @operand << @raw.scan(/[^\(]*/).rstrip
@@ -83,18 +85,51 @@ class SystemNavigation
         callinfo.terminate
       end
 
+      def parse_var
+        parse_ivar
+        parse_gvar
+        parse_cvar
+      end
+
       def parse_ivar
         return unless accessing_ivar?
 
         ivar = StringScanner.new(@operand)
         @ivar = ivar.scan(/:[^,]+/)[1..-1].to_sym
         ivar.terminate
+        @ivar
+      end
+
+      def parse_gvar
+        return unless accessing_gvar?
+
+        gvar = StringScanner.new(@operand)
+        @gvar = gvar.scan(/[^,]+/).to_sym
+        gvar.terminate
+        @gvar
+      end
+
+      def parse_cvar
+        return unless accessing_cvar?
+
+        cvar = StringScanner.new(@operand)
+        @cvar = cvar.scan(/:[^,]+/)[1..-1].to_sym
+        cvar.terminate
+        @cvar
       end
 
       def accessing_ivar?
         @opcode == 'getinstancevariable' || @opcode == 'setinstancevariable'
       end
 
+      def accessing_gvar?
+        @opcode == 'getglobal' || @opcode == 'setglobal'
+      end
+
+      def accessing_cvar?
+        @opcode == 'getclassvariable' || @opcode == 'setclassvariable'
+      end
+
       def vm_operative?
         @service_instruction == false
       end
@@ -108,19 +143,35 @@ class SystemNavigation
       end
 
       def dynamically_reads_ivar?
-        @op_id == 'instance_variable_get'
+        self.op_id == 'instance_variable_get'
       end
 
       def dynamically_writes_ivar?
         @op_id == 'instance_variable_set'
       end
 
+      def reads_gvar?(gvar)
+        @opcode == 'getglobal' && @gvar == gvar
+      end
+
+      def writes_gvar?(gvar)
+        @opcode == 'setglobal' && @gvar == gvar
+      end
+
+      def reads_cvar?(cvar)
+        @opcode == 'getclassvariable' && @cvar == cvar
+      end
+
+      def writes_cvar?(cvar)
+        @opcode == 'setclassvariable' && @cvar == cvar
+      end
+
       def evals?
-        @op_id == 'eval'
+        self.op_id == 'eval'
       end
 
       def putstrings?(str)
-        return false unless @opcode == 'putstring'
+        return false unless self.opcode == 'putstring'
 
         s = str.inspect
 
@@ -137,29 +188,32 @@ class SystemNavigation
       def putobjects?(str)
         return false unless @opcode == 'putobject'
 
-        return true if @operand.match(/(?::#{str}\z|\[.*:#{str},.*\])/)
+        s = (str.instance_of?(String) ? Regexp.escape(str) : str)
+
+        return true if @operand.match(/(?::#{s}\z|\[.*:#{s},.*\])/)
         return true if @operand == str.inspect
 
         false
       end
 
       def putnils?(str)
-        return false unless @opcode == 'putnil'
+        return false unless self.opcode == 'putnil'
         @operand == str.inspect
       end
 
       def duparrays?(str)
-        !!(@opcode == 'duparray' && @operand.match(/:#{str}[,\]]/))
+        s = case str
+            when Array, Hash then Regexp.escape(str.inspect)
+            else str
+            end
+
+        !!(self.opcode == 'duparray' && @operand.match(/:#{s}[,\]]/))
       end
 
       def sends_msg?(message)
         !!(sending? && @op_id == message.to_s)
       end
 
-      def operand
-        @operand
-      end
-
       def evaling_str
         @evaling_str ||= @operand.sub!(/\A"(.+)"/, '\1')
       end
@@ -175,6 +229,10 @@ class SystemNavigation
       def sending?
         @opcode == 'opt_send_without_block' || @opcode == 'send'
       end
+
+      protected
+
+      attr_reader :opcode, :op_id
     end
   end
 end

data/lib/system_navigation/method_query.rb

@@ -44,17 +44,17 @@ class SystemNavigation
       ).as_array.uniq.count == 1
     end
 
-    def find_accessing_methods(ivar:, only_set:, only_get:)
+    def find_accessing_methods(var:, only_set:, only_get:)
       self.instance_and_singleton_do(
         for_all: proc { |_scope, _selectors, method|
           compiled_method = CompiledMethod.compile(method)
           if only_set
-            compiled_method.unwrap if compiled_method.writes_field?(ivar)
+            compiled_method.unwrap if compiled_method.writes_field?(var)
           elsif only_get
-            compiled_method.unwrap if compiled_method.reads_field?(ivar)
+            compiled_method.unwrap if compiled_method.reads_field?(var)
           else
-            if compiled_method.reads_field?(ivar) ||
-               compiled_method.writes_field?(ivar)
+            if compiled_method.reads_field?(var) ||
+               compiled_method.writes_field?(var)
               compiled_method.unwrap
             end
           end

data/lib/system_navigation/module_refinement.rb

@@ -35,7 +35,7 @@ class SystemNavigation
         end
       end
 
-      def select_methods_that_access(ivar, only_get, only_set)
+      def select_methods_that_access(var, only_get, only_set)
         own_methods = self.own_methods
         if ancestor_methods.any?
           ancestor_methods.each do |methods|
@@ -48,7 +48,7 @@ class SystemNavigation
         MethodQuery.execute(
           collection: own_methods,
           query: :find_accessing_methods,
-          ivar: ivar,
+          var: var,
           only_get: only_get,
           only_set: only_set,
           behavior: self).as_array
@@ -207,10 +207,10 @@ class SystemNavigation
           query: :select_sent_messages)
       end
 
-      def which_selectors_store_into(ivar)
+      def which_selectors_store_into(var)
         self.selectors.select do |sel|
           meth = self.instance_method(sel)
-          meth.writes_field?(ivar)
+          meth.writes_field?(var)
         end
       end
 

data/lib/system_navigation/ruby_environment.rb

@@ -1,6 +1,12 @@
 class SystemNavigation
+  # @api private
+  # @since 0.1.0
   class RubyEnvironment
-    # Execute block on each class, metaclass, module and module's metaclass.
+    ##
+    # Execute +block+ on each class, metaclass, module and module's metaclass.
+    #
+    # @return [Enumerator] if +block+ was given
+    # @return [Enumerator] if +block+ is missing
     def all_behaviors(&block)
       enum = Enumerator.new do |y|
         ObjectSpace.each_object(Module) do |klass|
@@ -16,6 +22,11 @@ class SystemNavigation
       end
     end
 
+    ##
+    # Execute +block+ on each class (but not its metaclass).
+    #
+    # @return [Enumerator] if +block+ was given
+    # @return [Enumerator] if +block+ is missing
     def all_classes(&block)
       enum = Enumerator.new do |y|
         ObjectSpace.each_object(Class) do |klass|
@@ -30,6 +41,11 @@ class SystemNavigation
       end
     end
 
+    ##
+    # Execute +block+ on each class and module (but not their metaclasses).
+    #
+    # @return [Enumerator] if +block+ was given
+    # @return [Enumerator] if +block+ is missing
     def all_classes_and_modules(&block)
       enum = Enumerator.new do |y|
         ObjectSpace.each_object(Module) do |klass|
@@ -44,6 +60,11 @@ class SystemNavigation
       end
     end
 
+    ##
+    # Execute +block+ on each module (but not its metaclass).
+    #
+    # @return [Enumerator] if +block+ was given
+    # @return [Enumerator] if +block+ is missing
     def all_modules(&block)
       enum = Enumerator.new do |y|
         self.all_classes_and_modules.each do |klass|
@@ -58,10 +79,15 @@ class SystemNavigation
       end
     end
 
+    ##
+    # Execute +block+ on each object.
+    #
+    # @return [Enumerator] if +block+ was given
+    # @return [Enumerator] if +block+ is missing
     def all_objects(&block)
       enum = Enumerator.new do |y|
-        ObjectSpace.each_object do |klass|
-          y.yield klass
+        ObjectSpace.each_object do |obj|
+          y.yield obj
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: system_navigation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyrylo Silin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_method_source
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement