where_is 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4c855bcddc4646e2e9d75948b465b5c411a9400
-  data.tar.gz: e9fdf1137a464bf2b0dabf9e49aae76efcb067e7
+  metadata.gz: fafe31e85d2512640fca1b7ee5b1825a98cfab24
+  data.tar.gz: a065ccec36e61485627f51e83d04cac52974f472
 SHA512:
-  metadata.gz: 4d3cff0fd27d01e9d0050a8807f940f534e8f4068a9fd6afdc15495aa00819aa102f01426f4d8366a0a02e4f607a463709a78dc20d5a449ef1d85e0fc6e43cb9
-  data.tar.gz: 3c78c4e6b42232cb3e3c6d4b00da77417b652009c6460e115aef7a9aeb302e83a2bb516e7c765398fe326dd4e245bde9b14cc6e30bc81abc11157c08043ba731
+  metadata.gz: fcb11e5fd41273ff08c25e7b93d8ff40cbad9e1070f9bb313a2868913660809aeaddfc7ff7ca609897a5d06798f7a4b0404017bf6bb62a002f8a1d920b9f1bfb
+  data.tar.gz: b5fa1f0e3d1fe01eda1bb100445ea4b7ae1c46b8529c84d0474e9e33444662767214b6547b4738014458af02c47516adf80b746b3764f176825ae49c527eae38

data/README.md

@@ -50,6 +50,19 @@ Where.are(IRB)
 # ]
 
 
+# Where.ignore sets a global array of ignored regexes or partial strings. 
+# Any item with a `file` key that matches the ignore will be omitted.
+Where.ignore = [/inspector/]
+# => [/inspector/]
+  
+Where.are(IRB)
+# => [
+#   {:file=>"/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/workspace.rb", :line=>112, :path=>"/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/workspace.rb:112"}, 
+#   {:file=>"(eval)", :line=>2, :path=>"(eval):2"}, 
+#   {:file=>"/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb.rb", :line=>350, :path=>"/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb.rb:350"}, 
+#   {:file=>"/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/init.rb", :line=>16, :path=>"/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/init.rb:16"}
+# ]
+
 Where.is(String, :unknown_method)
 # NameError: undefined method `unknown_method' for class `#<Class:String>'
 ```

data/lib/where_is.rb

@@ -1,7 +1,10 @@
+require 'where_is/extractors'
 require 'where_is/version'
 
 module Where
   class << self
+    include Where::Extractors
+
     def is(klass, method = nil)
       are(klass, method)[0]
     end
@@ -30,6 +33,10 @@ module Where
       are_instance_methods(klass, method_name)[0]
     end
 
+    def is_class_primarily(klass)
+      is_class(klass)[0]
+    end
+
     def are_methods(klass, method_name)
       ensured_class = ensure_class(klass)
       methods = are_via_extractor(:method, ensured_class, method_name)
@@ -54,10 +61,6 @@ module Where
       source_locations
     end
 
-    def is_class_primarily(klass)
-      is_class(klass)[0]
-    end
-
     def is_class(klass)
       ensured_class = ensure_class(klass)
       methods = defined_methods(ensured_class)
@@ -66,63 +69,10 @@ module Where
       if source_locations.empty?
         raise NameError, "#{ensured_class} has no methods" if methods.empty?
         raise NameError, "#{ensured_class} only has built-in methods " \
-                             "(#{methods.size} in total)"
+                         "(#{methods.size} in total)"
       end
 
       source_locations
     end
-
-    private
-
-    def ensure_class(klass)
-      [Class, Module].include?(klass.class) ? klass : klass.class
-    end
-
-    def source_location(method)
-      source_location = method.source_location
-      source_location = [method.to_s[/: (.*)>/, 1]] if source_location.nil?
-
-      # source_location is a 2 element array
-      # [filename, line_number]
-      # some terminals (eg. iterm) will jump to the file if you cmd+click it
-      # but they can jump to the specific line if you concat file & line number
-      filename, line = source_location
-      build_location_hash(filename, line)
-    end
-
-    def group_and_combine_source_locations(source_locations)
-      file_groups = source_locations.group_by { |src_loc| src_loc[:file] }.to_a
-
-      file_groups.map! do |file, src_locs|
-        lines = src_locs.map { |sl| sl[:line] }
-        count = lines.size
-        line = lines.min
-        { count: count, data: build_location_hash(file, line) }
-      end
-
-      file_groups.sort_by { |fc| fc[:count] }.map { |fc| fc[:data] }
-    end
-
-    def are_via_extractor(extractor, klass, method_name)
-      klass.ancestors.map do |ancestor|
-        begin
-          source_location(ancestor.send(extractor, method_name))
-        rescue NameError
-          nil
-        end
-      end.compact
-    end
-
-    def defined_methods(klass)
-      methods = klass.methods(false).map { |m| klass.method(m) }
-      methods += klass.instance_methods(false)
-                      .map { |m| klass.instance_method(m) }
-      source_locations = methods.map(&:source_location).compact
-      source_locations.map { |(file, line)| build_location_hash(file, line) }
-    end
-
-    def build_location_hash(file, line)
-      { file: file, line: line, path: [file, line].compact.join(':') }
-    end
   end
 end

data/lib/where_is/extractors.rb

@@ -0,0 +1,69 @@
+module Where
+  module Extractors
+    attr_accessor :ignore
+
+    private
+
+    def ensure_class(klass)
+      [Class, Module].include?(klass.class) ? klass : klass.class
+    end
+
+    def source_location(method)
+      source_location = method.source_location
+      source_location = [method.to_s[/: (.*)>/, 1]] if source_location.nil?
+
+      # source_location is a 2 element array
+      # [filename, line_number]
+      # some terminals (eg. iterm) will jump to the file if you cmd+click it
+      # but they can jump to the specific line if you concat file & line number
+      filename, line = source_location
+      build_location_hash(filename, line)
+    end
+
+    def group_and_combine_source_locations(source_locations)
+      file_groups = source_locations.group_by { |src_loc| src_loc[:file] }.to_a
+
+      file_groups.map! do |file, src_locs|
+        lines = src_locs.map { |sl| sl[:line] }
+        count = lines.size
+        line = lines.min
+        { count: count, data: build_location_hash(file, line) }
+      end
+
+      locations = file_groups.sort_by { |fc| fc[:count] }.map { |fc| fc[:data] }
+      process_ignores(locations)
+    end
+
+    def process_ignores(locations)
+      [@ignore].flatten.compact.each do |ign|
+        locations.reject! do |location|
+          location[:file].match(ign)
+        end
+      end
+
+      locations
+    end
+
+    def are_via_extractor(extractor, klass, method_name)
+      klass.ancestors.map do |ancestor|
+        begin
+          source_location(ancestor.send(extractor, method_name))
+        rescue NameError
+          nil
+        end
+      end.compact
+    end
+
+    def defined_methods(klass)
+      methods = klass.methods(false).map { |m| klass.method(m) }
+      methods += klass.instance_methods(false)
+                      .map { |m| klass.instance_method(m) }
+      source_locations = methods.map(&:source_location).compact
+      source_locations.map { |(file, line)| build_location_hash(file, line) }
+    end
+
+    def build_location_hash(file, line)
+      { file: file, line: line, path: [file, line].compact.join(':') }
+    end
+  end
+end

data/lib/where_is/version.rb

@@ -1,3 +1,3 @@
 module Where
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/where_is.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.56.0'
+  spec.add_development_dependency 'rubocop', '~> 0.57.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: where_is
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Dave Allie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.57.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.57.1
 description: A little Ruby gem for finding the source location where class and methods
   are defined.
 email:
@@ -79,6 +79,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/where_is.rb
+- lib/where_is/extractors.rb
 - lib/where_is/version.rb
 - where_is.gemspec
 homepage: https://github.com/daveallie/where_is