modloc 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d828e83257acf60a86178a143df9b1a41d13fd9
-  data.tar.gz: 152c53cb8b81b6c1ace8752adb33af2468fadea2
+  metadata.gz: ca8ae9a543450d386a817f7b42c3e09f575fafc4
+  data.tar.gz: 8db499218ab780294c1854bbe19ade874458ce7d
 SHA512:
-  metadata.gz: c485f555ccb94195fff4997bc77c5459b449bde83b646715845049461bb9e7906ffc59c77a16f8a264e714df18ea0f8cb981cefdd5221c4e9372cb397bf6d6b7
-  data.tar.gz: d153366efff7711335250d7e7a60cf4009b356cb103fe98efd909952ef2f9c059c78d5a4831c40a6e2f43575df04e68e6d28611f72983e8fb16cc389bfa8b87a
+  metadata.gz: 8a5cf4b1e6b4e7c1f29fa31688f46484c0d92c2b151f66fdeb32f0a0860a13892dcdd0823f54cce4672de07fc3333f4b32e49053e9b38f62028c72c6ae21da8a
+  data.tar.gz: 677045b9fa24edccc97cf9c7e5c1634d51e5052fd911e89649671623c52e2e846ca591d28683e0176c4d56c3a0db6dab7999133f91e2e4d2b22446d7a632cd63

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  Excludes:
+    - vendor/bundle/**
+    - spec/**

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+cache: bundler

data/README.md

@@ -1,7 +1,17 @@
 # Modloc
 
+[![Version](http://allthebadges.io/jwaldrip/modloc/badge_fury.png)](http://allthebadges.io/jwaldrip/modloc/badge_fury)
+[![Dependencies](http://allthebadges.io/jwaldrip/modloc/gemnasium.png)](http://allthebadges.io/jwaldrip/modloc/gemnasium)
+[![Build Status](http://allthebadges.io/jwaldrip/modloc/travis.png)](http://allthebadges.io/jwaldrip/modloc/travis)
+[![Coverage](http://allthebadges.io/jwaldrip/modloc/coveralls.png)](http://allthebadges.io/jwaldrip/modloc/coveralls)
+[![Code Climate](http://allthebadges.io/jwaldrip/modloc/code_climate.png)](http://allthebadges.io/jwaldrip/modloc/code_climate)
+
+--
+
 Source locations for modules and classes in your app.
 
+**Works in Ruby >= 2.0.0**
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/lib/modloc.rb

@@ -1,5 +1,8 @@
-require "modloc/version"
-require "modloc/core_ext/module"
+require 'modloc/version'
+require 'modloc/core_ext/module'
 
+# Find the source location of any module or class
 module Modloc
+  autoload :Source, 'modloc/source'
+  autoload :Locator, 'modloc/locator'
 end

data/lib/modloc/core_ext/module.rb

@@ -1,23 +1,8 @@
+# Extensions to ruby's module class
 class Module
-
+  # Returns all the source locations for a given module
+  # @return [Array]
   def source_locations
-    found_files = $LOADED_FEATURES.select do |file|
-      File.read(file) =~ source_regex rescue nil
-    end
-    found_files.map do |file|
-      bof_match = File.read(file).match(%r{(.*\n)*#{source_regex.source}})
-      line = bof_match.to_s.lines.size
-      [file, line]
-    end
+    Modloc::Locator.new(self).find
   end
-
-  private
-
-  def source_regex
-    rxp = name.split('::').map do |name|
-      "(module |class |::)#{name}"
-    end.join('(\s*#.*\n)*\s*')
-    %r{#{rxp}}
-  end
-
 end

data/lib/modloc/locator.rb

@@ -0,0 +1,41 @@
+module Modloc
+  # Locator for a given module or class
+  class Locator
+    # Create a new locator for a module or class
+    # @param mod [Module, Class]
+    def initialize(mod)
+      @mod = mod
+    end
+
+    # Finds all the locations of a given module or class
+    # @return [Array]
+    def find
+      valid_sources.reduce([]) do |locations, source|
+        locations + source.locate_all(source_regex)
+      end
+    end
+
+    private
+
+    def valid_sources
+      ruby_files.select { |file| file.strip =~ source_regex }
+    end
+
+    def ruby_files
+      files.select { |file| file.ext == '.rb' }
+    end
+
+    def files
+      $LOADED_FEATURES.map { |f| Source.new(f) }
+    end
+
+    def source_regex
+      rxp = @mod.name.split('::').each_with_index.map do |name, index|
+        group = 'module |class '
+        group << '|::' unless index == 0
+        "(#{group})#{name}"
+      end.join('(\s*#.*\n)*\s*')
+      /#{rxp}/
+    end
+  end
+end

data/lib/modloc/source.rb

@@ -0,0 +1,46 @@
+module Modloc
+  # A Modloc source string
+  class Source < String
+    autoload :Line, 'modloc/source/line'
+
+    attr_reader :path, :ext
+
+    # Creates a new Modloc source object
+    # @param file [String]
+    def initialize(file)
+      @ext  = File.extname(file)
+      @path = file
+      super File.read file
+    rescue Errno::ENOENT
+      super ''
+    end
+
+    # Returns the sources lines as line objects
+    # @return [Array<Modloc::Source::Line>]
+    def lines
+      super.map { |line| Line.new line }
+    end
+
+    # Locate all the locations matching a given pattern
+    # @param pattern [Regexp]
+    # @return [Array]
+    def locate_all(pattern)
+      [].tap do |locations|
+        strip.lines.each_with_index.reduce('') do |contents, (line, index)|
+          line_num = index + 1
+          contents << line
+          if contents.match(/#{pattern.source}\n\z/)
+            locations << [path, line_num]
+          end
+          contents
+        end
+      end
+    end
+
+    # Return the source without comments or whitespace for each line
+    # @return [Modloc::Source]
+    def strip
+      dup.replace lines.map(&:strip).join
+    end
+  end
+end

data/lib/modloc/source/line.rb

@@ -0,0 +1,24 @@
+module Modloc
+  # A line string
+  class Source::Line < String
+    # initialize a new line object
+    # @param contents [String]
+    def initialize(contents)
+      super contents
+    end
+
+    # Strip the line of whitespace and comments
+    # @return [Modloc::Source::Line]
+    def strip
+      val = super.concat "\n"
+      val.strip_comment
+    end
+
+    protected
+
+    # Strips a comment from a line
+    def strip_comment
+      gsub(/#([^{].*\n)?/, "\n")
+    end
+  end
+end

data/lib/modloc/version.rb

@@ -1,3 +1,5 @@
+# Modloc
 module Modloc
-  VERSION = "0.0.1"
+  # Latest Version
+  VERSION = '1.0.0'
 end

data/modloc.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Modloc::VERSION
   spec.authors       = ["Jason Waldrip"]
   spec.email         = ["jason@waldrip.net"]
-  spec.summary       = "Find the source location of a given module or class"
+  spec.summary       = "Find the source location of any module or class"
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "activesupport", "~> 4.0"
   spec.add_development_dependency "pry", "~> 0.9"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "inch"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "coveralls"
 end

data/spec/fixtures/sample.rb

@@ -0,0 +1,62 @@
+# Top Level
+class Foo
+end
+
+module Bar
+end
+
+# Nested
+class Foo
+  module Baz
+  end
+end
+
+class Foo
+  class Raz
+  end
+end
+
+module Bar
+  module Baz
+  end
+end
+
+module Bar
+  class Raz
+  end
+end
+
+# Nested With Comments
+class Foo
+  # This is a comment
+  module Baz
+  end
+end
+
+class Foo
+  # This is a comment
+  class Raz
+  end
+end
+
+module Bar
+  # This is a comment
+  module Baz
+  end
+end
+
+module Bar
+  # This is a comment
+  class Raz
+  end
+end
+
+# Namespaced
+module Foo::Taz
+end
+
+class Bar::Saz
+end
+
+# As a comment
+# class Foo

data/spec/lib/modloc/core_ext/module_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'fixtures/sample'
+
+describe Module do
+
+  def sample_with_line(line)
+    dir  = File.dirname(__FILE__)
+    file = File.join dir, '../../../fixtures/sample.rb'
+    expect(File.exist? file).to be_true
+    file = File.expand_path file
+    [file, line]
+  end
+
+  def lines(*lines)
+    lines.map do |line|
+      sample_with_line(line)
+    end.sort
+  end
+
+  describe '#source_locations' do
+    context 'for Foo' do
+      it 'should return the proper locations' do
+        expect(Foo.source_locations)
+        .to eq lines(2, 9, 14, 30, 36)
+      end
+    end
+
+    context 'for Bar' do
+      it 'should return the proper locations' do
+        expect(Bar.source_locations)
+        .to eq lines(5, 19, 24, 42, 48)
+      end
+    end
+
+    context 'for Foo::Baz' do
+      it 'should return the proper locations' do
+        expect(Foo::Baz.source_locations)
+        .to eq lines(10, 32)
+      end
+    end
+
+    context 'for Bar::Baz' do
+      it 'should return the proper locations' do
+        expect(Bar::Baz.source_locations)
+        .to eq lines(20, 44)
+      end
+    end
+
+    context 'for Foo::Raz' do
+      it 'should return the proper locations' do
+        expect(Foo::Raz.source_locations)
+        .to eq lines(15, 38)
+      end
+    end
+
+    context 'for Bar::Raz' do
+      it 'should return the proper locations' do
+        expect(Bar::Raz.source_locations)
+        .to eq lines(25, 50)
+      end
+    end
+
+    context 'for Foo::Taz' do
+      it 'should return the proper locations' do
+        expect(Foo::Taz.source_locations)
+        .to eq lines(55)
+      end
+    end
+
+    context 'for Boo::Saz' do
+      it 'should return the proper locations' do
+        expect(Bar::Saz.source_locations)
+        .to eq lines(58)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,9 +1,19 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+$LOAD_PATH.unshift File.expand_path File.dirname(__FILE__)
+
+require 'simplecov'
+require 'coveralls'
+require 'pry'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'modloc'
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modloc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Waldrip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,35 +39,77 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,14 +131,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/modloc.rb
 - lib/modloc/core_ext/module.rb
+- lib/modloc/locator.rb
+- lib/modloc/source.rb
+- lib/modloc/source/line.rb
 - lib/modloc/version.rb
 - modloc.gemspec
+- spec/fixtures/sample.rb
+- spec/lib/modloc/core_ext/module_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -121,7 +170,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Find the source location of a given module or class
+summary: Find the source location of any module or class
 test_files:
+- spec/fixtures/sample.rb
+- spec/lib/modloc/core_ext/module_spec.rb
 - spec/spec_helper.rb
 has_rdoc: