where_is 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a012ba070db98cb6a10ef134a01fc5be8b17da90
-  data.tar.gz: 740bb63ccd485920eefd11928cb52a1bddc0c81c
+  metadata.gz: f306ef08ef7d1741687639fb23e8fd2c548aa596
+  data.tar.gz: d192d9414cede7645d027df092051882a0b71598
 SHA512:
-  metadata.gz: 8cf7fd43576061fbd78b9d90ffbe940a95f36fa245932e06415531e2fc3b6624353c8a263cf086cf4aa8d8e1da657e8beba70e029736c90eb78de16443e6172f
-  data.tar.gz: c2ba717c045b4e09121fcf621df53e8ec1437a989e332071ab3d62bb8ad672a910222cb29dd0c1c62ee1e9b384a760f24074765b10a2f0888cef7489756b1a3d
+  metadata.gz: 574345e79412de82a51dbf8df6c4391931b283854e7eccf869be8a051ea295ab39a77c32b56d3c1083839b7e25d6d7102fe9e975eb805f264c7f54bd723fd07f
+  data.tar.gz: 7dcbd32e3a79404686153d5582fa13b9db90e110098090a0bf0ec16109b99da493c8883aa3c70e3fceb883a97922897d599ca6d00e9c9f4c14061a425cb87cad

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  DisplayCopNames: true
+
+Style/PredicateName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -24,10 +24,25 @@ Or install it yourself as:
 # Where.is takes a class and an optional method
 
 Where.is(Where, :is)
-# => ["/Users/david/.rvm/gems/ruby-2.2.3/gems/where_is-0.1.0/lib/where_is.rb", 5]
+# => ["/Users/david/.rvm/gems/ruby-2.3.1/gems/where_is-0.1.0/lib/where_is.rb", 5]
 
 Where.is(IRB)
-# => ["/Users/david/.rvm/rubies/ruby-2.2.3/lib/ruby/2.2.0/irb/inspector.rb", 23]
+# => ["/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.2.0/irb/inspector.rb", 24]
+
+
+# Where.are takes a class and an optional method and will return all definitions
+# of the method/class
+Where.are(Where, :is)
+
+
+Where.are(IRB)
+# => [
+#  ["/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/inspector.rb", 24],
+#  ["/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/workspace.rb", 112],
+#  ["(eval)", 2],
+#  ["/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb.rb", 350],
+#  ["/Users/david/.rvm/rubies/ruby-2.3.1/lib/ruby/2.3.0/irb/init.rb", 16]
+#]
 ```
 
 ## Development

data/Rakefile

@@ -1,2 +1,6 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+task default: :rubocop
+
+RuboCop::RakeTask.new(:rubocop)

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "where_is"
+require 'bundler/setup'
+require 'where_is'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "where_is"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/where_is/version.rb

@@ -1,3 +1,3 @@
 module Where
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/lib/where_is.rb

@@ -1,7 +1,7 @@
-require "where_is/version"
+require 'where_is/version'
 
 module Where
-  class <<self
+  class << self
     def is(klass, method = nil)
       if method
         begin
@@ -14,6 +14,18 @@ module Where
       end
     end
 
+    def are(klass, method = nil)
+      if method
+        begin
+          Where.are_instance_methods(klass, method)
+        rescue NameError
+          Where.are_methods(klass, method)
+        end
+      else
+        Where.is_class(klass)
+      end
+    end
+
     def is_proc(proc)
       source_location(proc)
     end
@@ -27,62 +39,79 @@ module Where
     end
 
     def are_methods(klass, method_name)
-      are_via_extractor(:method, klass, method_name)
+      methods = are_via_extractor(:method, klass, method_name)
+      source_locations = group_and_combine_source_locations(methods)
+
+      if source_locations.empty?
+        raise NameError, "#{klass} has no methods called #{method_name}"
+      end
+
+      source_locations
     end
 
     def are_instance_methods(klass, method_name)
-      are_via_extractor(:method, klass, method_name)
+      methods = are_via_extractor(:instance_method, klass, method_name)
+      source_locations = group_and_combine_source_locations(methods)
+
+      if source_locations.empty?
+        raise NameError, "#{klass} has no methods called #{method_name}"
+      end
+
+      source_locations
     end
 
     def is_class(klass)
       methods = defined_methods(klass)
-      file_groups = methods.group_by{|sl| sl[0]}
-      file_counts = file_groups.map do |file, sls|
-        lines = sls.map{|sl| sl[1]}
-        count = lines.size
-        line = lines.min
-        {file: file, count: count, line: line}
+      source_locations = group_and_combine_source_locations(methods)
+
+      if source_locations.empty?
+        raise NameError, "#{klass} has no methods" if methods.empty?
+        raise NameError, "#{klass} only has built-in methods " \
+                             "(#{methods.size} in total)"
       end
-      file_counts.sort_by{|fc| fc[:count]}.map{|fc| [fc[:file], fc[:line]]}
+
+      source_locations
     end
 
-    # Raises ArgumentError if klass does not have any Ruby methods defined in it.
     def is_class_primarily(klass)
-      source_locations = is_class(klass)
-      if source_locations.empty?
-        methods = defined_methods(klass)
-        raise ArgumentError, (methods.empty? ?
-            "#{klass} has no methods" :
-            "#{klass} only has built-in methods (#{methods.size} in total)"
-        )
-      end
-      source_locations[0]
+      is_class(klass)[0]
     end
 
     private
 
     def source_location(method)
-      method.source_location || (
-      method.to_s =~ /: (.*)>/
-      $1
-      )
+      method.source_location || method.to_s[/: (.*)>/, 1]
+    end
+
+    def group_and_combine_source_locations(source_locations)
+      file_groups = source_locations.group_by { |src_loc| src_loc[0] }.to_a
+
+      file_groups.map! do |file, src_locs|
+        lines = src_locs.map { |sl| sl[1] }
+        count = lines.size
+        line = lines.min
+        { file: file, count: count, line: line }
+      end
+
+      file_groups.sort_by! { |fc| fc[:count] }
+      file_groups.map { |fc| [fc[:file], fc[:line]] }
     end
 
     def are_via_extractor(extractor, klass, method_name)
-      methods = klass.ancestors.map do |ancestor|
-        method = ancestor.send(extractor, method_name)
-        if method.owner == ancestor
-          source_location(method)
-        else
+      klass.ancestors.map do |ancestor|
+        begin
+          source_location(ancestor.send(extractor, method_name))
+        rescue NameError
           nil
         end
-      end
-      methods.compact
+      end.compact
     end
 
     def defined_methods(klass)
-      methods = klass.methods(false).map{|m| klass.method(m)} +
-          klass.instance_methods(false).map{|m| klass.instance_method(m)}
+      methods = klass.methods(false)
+                     .map { |m| klass.method(m) }
+      methods += klass.instance_methods(false)
+                      .map { |m| klass.instance_method(m) }
       methods.map(&:source_location).compact
     end
   end

data/where_is.gemspec

@@ -4,23 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'where_is/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "where_is"
+  spec.name          = 'where_is'
   spec.version       = Where::VERSION
-  spec.authors       = ["Dave Allie"]
-  spec.email         = ["dave@tanda.co"]
+  spec.authors       = ['Dave Allie']
+  spec.email         = ['dave@daveallie.com']
 
-  spec.summary       = %q{A little Ruby gem for finding the source location where class and methods are defined.}
-  spec.description   = %q{A little Ruby gem for finding the source location where class and methods are defined.}
-  spec.homepage      = "https://github.com/daveallie/where_is"
-  spec.license       = "MIT"
+  spec.summary       = 'A little Ruby gem for finding the source location' \
+                       ' where class and methods are defined.'
+  spec.description   = 'A little Ruby gem for finding the source location' \
+                       ' where class and methods are defined.'
+  spec.homepage      = 'https://github.com/daveallie/where_is'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: where_is
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dave Allie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,15 +38,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
 description: A little Ruby gem for finding the source location where class and methods
   are defined.
 email:
-- dave@tanda.co
+- dave@daveallie.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -77,10 +92,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A little Ruby gem for finding the source location where class and methods
   are defined.
 test_files: []
-has_rdoc: