log_require 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aaf2298b38e7e53984adf32fa37f47e7be09684
+  data.tar.gz: 693dd61a3a0551afe4354a44846a44e0b7d726cf
+SHA512:
+  metadata.gz: 5edf0918b1d41ab18d2057b4a076f3caaececd4c4ac48f8e6be01d856a66ffc2632dc973dd40df98590f41ac826cdaef3c1a75801480bf4e775c18054598b46d
+  data.tar.gz: c7b4421a7d82696c595f58ebc80392ad42208e2d47868ee3e50a1b3d97344d985c4f4b3c48dbfc94544f237deb4602473d9f2e6d177c89ad642e66204a4fbf14

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "yard", "~> 0.7"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0", :git => "https://github.com/chetan/jeweler.git", :branch => "bixby"
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+GIT
+  remote: https://github.com/chetan/jeweler.git
+  revision: b90381a3958daae7f3ce3d8c4d710fe39e72443b
+  branch: bixby
+  specs:
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.1)
+    highline (1.6.21)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    thread_safe (0.3.4)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0)!
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Chetan Sarva
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# log_require
+
+Log all calls to Kernel#require
+
+## Usage
+
+This library should generally not be added to a `Gemfile`. Simply install it: 
+
+```bash
+$ gem install log_require
+```
+
+Then use it like so:
+
+```text
+$ ruby -rlog_require ./a.rb
+require: ./b.rb             >> ./a.rb:9
+require: ./c.rb             >> ./b.rb:2
+require: openssl            >> ./c.rb:2
+require: openssl.so         >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:17
+require: digest.so          >> ruby-2.1.3/lib/ruby/2.1.0/digest.rb:1
+require: openssl/bn         >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:19
+require: openssl/cipher     >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:20
+require: openssl/config     >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:21
+require: stringio           >> ruby-2.1.3/lib/ruby/2.1.0/openssl/config.rb:13
+require: openssl/digest     >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:22
+require: openssl/x509       >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:23
+require: openssl/ssl        >> ruby-2.1.3/lib/ruby/2.1.0/openssl.rb:24
+require: openssl/buffering  >> ruby-2.1.3/lib/ruby/2.1.0/openssl/ssl.rb:17
+require: fcntl              >> ruby-2.1.3/lib/ruby/2.1.0/openssl/ssl.rb:18
+require: ./d.rb             >> ./a.rb:10
+require: ./e.rb             >> ./d.rb:2
+require: ./f.rb             >> ./e.rb:2
+require: ./g.rb             >> ./d.rb:3
+```
+
+Output is written to STDERR by default.
+
+The following environment variables can also be used to control the output:
+
+* LOG_REQUIRE="filename" -- write to file instead of STDERR
+* LOG_REQUIRE_GRAPH=1 -- display tree output
+
+## Contributing to log_require
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Chetan Sarva. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "log_require"
+  gem.homepage = "http://github.com/chetan/log_require"
+  gem.license = "MIT"
+  gem.summary = %Q{Log all calls to Kernel#require}
+  gem.description = %Q{Small utility to help track down that stray library}
+  gem.email = "chetan@pixelcop.net"
+  gem.authors = ["Chetan Sarva"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+task :default => :build

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/log_require/flat.rb

@@ -0,0 +1,24 @@
+
+module LogRequire
+  module Flat
+
+    # Log the `require` call to STDERR or, optionally, a file
+    def log_require(name)
+      # cleanup the caller name (only interested in path relative to gem or lib)
+      c, l = LogRequire.clean_caller(caller.first)
+
+      if LogRequire.file? then
+        $log_require.puts "#{name},#{c},#{l}"
+
+      else
+        pad = 110-name.length
+        pad = pad > 0 ? pad : 1
+        pad = (" " * pad)
+        STDERR.puts "require: #{name}#{pad}>> #{c}:#{l}"
+      end
+
+      return require_without_log(name)
+    end
+
+  end
+end

data/lib/log_require/graph.rb

@@ -0,0 +1,40 @@
+
+module LogRequire
+  module Graph
+
+    def log_require(name)
+      # cleanup the caller name (only interested in path relative to gem or lib)
+      stack = caller
+      c, l = LogRequire.clean_caller(stack.first)
+
+      # clean up the require stack
+      while !LogRequire.find_caller(stack, $log_require_stack.last) do
+        $log_require_stack.pop
+      end
+
+      # cleanup the frame pointer
+      while !LogRequire.find_caller(stack, $log_require_frame.caller) do
+        $log_require_frame = $log_require_frame.parent
+      end
+
+      while !$log_require_frame.root?() &&
+        ($log_require_frame.caller == $log_require_frame.parent.caller || $log_require_frame.caller == c) do
+
+        $log_require_frame = $log_require_frame.parent
+      end
+
+      # add on to the stack
+      if ! $log_require_stack.include?(c) then
+        $log_require_stack << c
+      end
+
+      # log the node
+      new_node = $log_require_frame.add_child(c, name)
+      $log_require_frame = new_node
+
+      # dot he actual require
+      new_node.result = require_without_log(name)
+    end
+
+  end
+end

data/lib/log_require/node.rb

@@ -0,0 +1,63 @@
+
+module LogRequire
+  class Node
+
+    attr_reader :parent, :caller, :name, :children
+    attr_accessor :result
+
+    def initialize(parent, caller, name, dupe_caller=false)
+      @parent      = parent
+      @caller      = caller
+      @name        = name
+      @children    = []
+      @dupe_caller = dupe_caller
+      @result      = false
+    end
+
+    def self.root
+      @root ||= new(nil, nil, :root)
+    end
+
+    def parent
+      if root? then
+        self
+      else
+        @parent
+      end
+    end
+
+    def root?
+      @parent.nil? && @name == :root
+    end
+
+    def add_child(caller, name)
+      dupe_caller = (!@children.empty? and @children.last.caller == caller)
+      @children << (node = Node.new(self, caller, name, dupe_caller))
+      node
+    end
+
+    def print_children(io, indent=1)
+      @children.each do |child|
+        io.puts child.to_graph_s(indent)
+        child.print_children(io, indent+2)
+      end
+    end
+
+    def to_graph_s(indent=1)
+      if root? then
+        "--+ root"
+      else
+        s = ""
+        s += "#{'|  '*indent}|--+ #{@caller}\n" if !@dupe_caller
+        s += "#{'|  '*(indent+1)}|--" + (@children.empty?() ? "=" : "+") + " #{@name}" +
+          (@result ? "" : " (#{@result})")
+        s
+      end
+    end
+
+    def to_s
+      "#{@caller} -> #{@name} (#{@result})"
+    end
+
+  end
+end

data/lib/log_require.rb

@@ -0,0 +1,70 @@
+
+require "log_require/flat"
+require "log_require/graph"
+require "log_require/node"
+
+module LogRequire
+
+  def self.graph?
+    !ENV["LOG_REQUIRE_GRAPH"].nil?
+  end
+
+  def self.file?
+    !ENV["LOG_REQUIRE"].nil?
+  end
+
+  def self.setup
+    io = if file? then
+      File.open(ENV["LOG_REQUIRE"], 'w')
+    else
+      STDERR
+    end
+
+    if graph? then
+      $log_require_stack = []
+      $log_require_frame = Node.root
+      Kernel.include(LogRequire::Graph)
+      at_exit do
+        io.puts
+        io.puts LogRequire::Node.root.to_graph_s()
+        LogRequire::Node.root.print_children(io)
+      end
+
+    else
+      $log_require = io
+      if file? then
+        io.puts "require name,caller,line number"
+      end
+      Kernel.include(LogRequire::Flat)
+    end
+  end
+
+  def self.clean_caller(c)
+    if c =~ %r{ruby-[\d.]+/gems/(.*):(\d+):in `.*$} ||
+       c =~ %r{(ruby-[\d.]+/lib/ruby/[\d.]+/.*):(\d+):in `.*$} ||
+       c =~ %r{(ruby/site_ruby/[\d.]+/.*):(\d+):in `.*$} ||
+       c =~ %r{^(.*?):(\d+):in `.*$} then
+
+       return [$1, $2]
+    end
+  end
+
+  def self.find_caller(arr, c)
+    arr.each do |s|
+      if s =~ /#{c}:\d+:in/ then
+        return true
+      end
+    end
+    false
+  end
+end
+
+module Kernel
+
+  if !method_defined?(:log_require) then
+    LogRequire.setup
+    alias_method :require_without_log, :require
+    alias_method :require, :log_require
+  end
+
+end

data/log_require.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: log_require 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "log_require"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Chetan Sarva"]
+  s.date = "2014-10-30"
+  s.description = "Small utility to help track down that stray library"
+  s.email = "chetan@pixelcop.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/log_require.rb",
+    "lib/log_require/flat.rb",
+    "lib/log_require/graph.rb",
+    "lib/log_require/node.rb",
+    "log_require.gemspec",
+    "test/a.rb",
+    "test/b.rb",
+    "test/c.rb",
+    "test/d.rb",
+    "test/e.rb",
+    "test/f.rb",
+    "test/g.rb"
+  ]
+  s.homepage = "http://github.com/chetan/log_require"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.2"
+  s.summary = "Log all calls to Kernel#require"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+  end
+end
+

data/test/a.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# expected output:
+#
+# a -> b -> c -> openssl
+# d -> e -> f
+#   -> g
+
+require "./b.rb"
+require "./d.rb"
+

data/test/b.rb

@@ -0,0 +1,2 @@
+
+require "./c.rb"

data/test/c.rb

@@ -0,0 +1,2 @@
+
+require "openssl"

data/test/d.rb

@@ -0,0 +1,3 @@
+
+require "./e.rb"
+require "./g.rb"

data/test/e.rb

@@ -0,0 +1,2 @@
+
+require "./f.rb"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: log_require
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chetan Sarva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Small utility to help track down that stray library
+email: chetan@pixelcop.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/log_require.rb
+- lib/log_require/flat.rb
+- lib/log_require/graph.rb
+- lib/log_require/node.rb
+- log_require.gemspec
+- test/a.rb
+- test/b.rb
+- test/c.rb
+- test/d.rb
+- test/e.rb
+- test/f.rb
+- test/g.rb
+homepage: http://github.com/chetan/log_require
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Log all calls to Kernel#require
+test_files: []