trace_location 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfb14ac437de0918b84efe14862be77d28176b7475d1b033bf914ae8f6e54e0d
+  data.tar.gz: ef716fc6e91843c70c19604b578dc6ad018446c61af963e7b13c9517619afe60
+SHA512:
+  metadata.gz: cb20ffc9c0988b9462abf62a0d4ca52c65c6226a21d3519c330dfd216da6b46326607b070f4a2fd242990e39a67514f91ed2a7841c363743861bb08e83f2b83f
+  data.tar.gz: 553834e64150421138a7302b03c11ad1f3b4c5f2c64256eb056df8cd9f10a4457b4da2608002543e7fafd7f71b8cbfed0dbc59a618d68e8038266c8da2003a5a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trace_location.gemspec
+gemspec
+
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    trace_location (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  trace_location!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshiyuki Hirano
+
+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,96 @@
+# TraceLocation
+
+TraceLocation gem provides logs a tracing result of `:call` and `:return`. It's useful for reading the huge codes (e.g. Ruby on Rails) and tracing its process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trace_location'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trace_location
+
+## Usage
+
+You just surround the code which you want to track the process.
+For example, when you want to track the process of Rails application request/response:
+
+```
+% bin/rails c
+Running via Spring preloader in process 40741
+Loading development environment (Rails 5.2.3)
+irb(main):001:0> env = Rack::MockRequest.env_for('http://localhost:3000/api/stories')
+irb(main):002:0> TraceLocation.trace { status, headers, body = Rails.application.call(env) }
+Created at /path/to/sampleapp/log/trace_location-2019050105051556706139.log
+=> true
+```
+
+Then you can get a log like this:
+
+```
+Logged by TraceLocation gem at 2019-05-01 05:22:19 -0500
+https://github.com/yhirano55/trace_location
+
+[Tracing events] C: Call, R: Return
+
+R <internal:prelude>:138#enable
+C /vendor/bundle/gems/railties-5.2.3/lib/rails.rb:39#application
+R /vendor/bundle/gems/railties-5.2.3/lib/rails.rb:41#application
+C /vendor/bundle/gems/railties-5.2.3/lib/rails/engine.rb:522#call
+  C /vendor/bundle/gems/railties-5.2.3/lib/rails/application.rb:607#build_request
+    C /vendor/bundle/gems/railties-5.2.3/lib/rails/engine.rb:705#build_request
+      C /vendor/bundle/gems/railties-5.2.3/lib/rails/application.rb:247#env_config
+      R /vendor/bundle/gems/railties-5.2.3/lib/rails/application.rb:275#env_config
+      C /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/request.rb:59#initialize
+        C /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:40#initialize
+          C /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/url.rb:186#initialize
+            C /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/filter_parameters.rb:34#initialize
+            R /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/filter_parameters.rb:39#initialize
+          R /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/url.rb:190#initialize
+        R /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:43#initialize
+      R /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/request.rb:67#initialize
+      C /vendor/bundle/gems/railties-5.2.3/lib/rails/engine.rb:534#routes
+      R /vendor/bundle/gems/railties-5.2.3/lib/rails/engine.rb:538#routes
+      C /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/request.rb:142#routes=
+        C /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:68#set_header
+        R /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:70#set_header
+      R /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/request.rb:144#routes=
+      C /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:129#script_name
+        C /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:52#get_header
+        R /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:54#get_header
+      R /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:129#script_name
+      C /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/request.rb:150#engine_script_name=
+        C /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/http/request.rb:138#routes
+          C /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:52#get_header
+          R /vendor/bundle/gems/rack-2.0.7/lib/rack/request.rb:54#get_header
+..................
+(an omission)
+..................
+                R /vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/middleware/static.rb:128#call
+                C /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:9#respond_to?
+                  C /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:9#respond_to?
+                    C /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:9#respond_to?
+                      C /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:9#respond_to?
+                        C /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:9#respond_to?
+                        R /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:15#respond_to?
+                      R /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:15#respond_to?
+                    R /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:15#respond_to?
+                  R /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:15#respond_to?
+                R /vendor/bundle/gems/rack-2.0.7/lib/rack/body_proxy.rb:15#respond_to?
+              R /vendor/bundle/gems/rack-2.0.7/lib/rack/sendfile.rb:140#call
+            R /vendor/bundle/gems/railties-5.2.3/lib/rails/engine.rb:525#call
+
+Result: [200, {"Content-Type"=>"application/json; charset=utf-8", "ETag"=>"W/\"42334f8fba25471804e2cfa66fa989a7\"", "Cache-Control"=>"max-age=0, private, must-revalidate", "X-Request-Id"=>"f30153ff-3446-453a-a547-34c4b3766bfc", "X-Runtime"=>"0.455604"}, #<Rack::BodyProxy:0x00007f957960a430 @body=#<Rack::BodyProxy:0x00007f957f1c1f08 @body=#<Rack::BodyProxy:0x00007f957f1a8c10 @body=#<Rack::BodyProxy:0x00007f957f198040 @body=#<Rack::BodyProxy:0x00007f957f17bf58 @body=["[{\"id\":1,\"title\":\"The boy who cried 'wolf!'\",\"parentId\":1},{\"id\":2,\"title\":\"story 2\",\"parentId\":4},{\"id\":3,\"title\":\"story 3\",\"parentId\":null},{\"id\":4,\"title\":\"story 4\",\"parentId\":null},{\"id\":5,\"title\":\"story 1\",\"parentId\":null},{\"id\":6,\"title\":\"story 6\",\"parentId\":null},{\"id\":7,\"title\":\"story 7\",\"parentId\":null},{\"id\":8,\"title\":\"story 8\",\"parentId\":null},{\"id\":9,\"title\":\"story 9\",\"parentId\":null},{\"id\":10,\"title\":\"story 10\",\"parentId\":null},{\"id\":11,\"title\":\"story 11\",\"parentId\":null},{\"id\":12,\"title\":\"story 12\",\"parentId\":null},{\"id\":13,\"title\":\"story 13\",\"parentId\":null}]"], @block=#<Proc:0x00007f957f17ae78@/path/to/sampleapp/vendor/bundle/gems/rack-2.0.7/lib/rack/etag.rb:30>, @closed=false>, @block=#<Proc:0x00007f957f1a2d38@/path/to/sampleapp/vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/middleware/executor.rb:15>, @closed=false>, @block=#<Proc:0x00007f957f1b3728@/path/to/sampleapp/vendor/bundle/gems/railties-5.2.3/lib/rails/rack/logger.rb:39>, @closed=false>, @block=#<Proc:0x00007f957f1c07c0@/path/to/sampleapp/vendor/bundle/gems/activesupport-5.2.3/lib/active_support/cache/strategy/local_cache_middleware.rb:30>, @closed=false>, @block=#<Proc:0x00007f95796096c0@/path/to/sampleapp/vendor/bundle/gems/actionpack-5.2.3/lib/action_dispatch/middleware/executor.rb:15>, @closed=false>]
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'trace_location'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/trace_location.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'trace_location/version'
+require_relative 'trace_location/config'
+require_relative 'trace_location/tracer'
+
+begin
+  require 'rails'
+  require_relative 'trace_location/railtie'
+rescue LoadError
+  nil
+end
+
+module TraceLocation # :nodoc:
+  def self.trace(options = {}, &block)
+    Tracer.new(options).call(&block)
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/trace_location/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TraceLocation
+  class Config # :nodoc:
+    attr_accessor :root_dir, :dest_dir
+
+    def initialize
+      @root_dir = Dir.pwd
+      @dest_dir = Dir.pwd
+    end
+  end
+end

data/lib/trace_location/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TraceLocation
+  class Railtie < ::Rails::Railtie # :nodoc:
+    config.after_initialize do
+      ::TraceLocation.configure do |config|
+        config.root_dir = Rails.root
+        config.dest_dir = Rails.root.join('log')
+      end
+    end
+  end
+end

data/lib/trace_location/tracer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module TraceLocation
+  class Tracer # :nodoc:
+    EVENTS = { call: 'C', return: 'R' }.freeze
+    INDENT_SPACES = 2
+    INDENT_STRING = ' '
+
+    def initialize(options = {})
+      @root_dir = options.fetch(:root_dir) { TraceLocation.config.root_dir }
+      @dest_dir = options.fetch(:dest_dir) { TraceLocation.config.dest_dir }
+    end
+
+    def call(&block)
+      logs = []
+      nest = 0
+      trace_point = TracePoint.new(:call, :return) do |tp|
+        case tp.event
+        when :call
+          logs << build_log(trace_point: tp, nest: nest, root_dir: root_dir)
+          nest += 1
+        when :return
+          nest = nest.positive? ? nest - 1 : 0
+          logs << build_log(trace_point: tp, nest: nest, root_dir: root_dir)
+        end
+      end
+
+      trace_point.enable
+      result = block.call
+      trace_point.disable
+
+      current = Time.now
+      filename = "trace_location-#{current.strftime('%Y%m%d%H%m%s')}.log"
+      file_path = File.join(dest_dir, filename)
+      File.open(file_path, 'w+') do |io|
+        io.puts "Logged by TraceLocation gem at #{current}"
+        io.puts 'https://github.com/yhirano55/trace_location'
+        io.puts
+        io.puts '[Tracing events] C: Call, R: Return'
+        io.puts
+        io.puts logs.join("\n")
+        io.puts
+        io.puts "Result: #{result.inspect}"
+      end
+      $stdout.puts "Created at #{file_path}"
+      true
+    rescue StandardError => e
+      $stdout.puts "Failure: #{e.message}"
+      false
+    ensure
+      trace_point.disable if trace_point.enabled?
+    end
+
+    private
+
+    attr_reader :root_dir, :dest_dir, :block
+
+    def build_log(trace_point:, nest:, root_dir:)
+      indent    = indent(nest)
+      event     = EVENTS[trace_point.event]
+      path      = trace_point.path.to_s.gsub(/#{root_dir}/, '')
+      lineno    = trace_point.lineno
+      method_id = trace_point.method_id
+
+      %(#{indent}#{event} #{path}:#{lineno}##{method_id})
+    end
+
+    def indent(nest)
+      INDENT_STRING * (nest * INDENT_SPACES)
+    end
+  end
+end

data/lib/trace_location/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TraceLocation
+  VERSION = '0.1.0'
+end

data/trace_location.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trace_location/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'trace_location'
+  s.version       = TraceLocation::VERSION
+  s.authors       = ['Yoshiyuki Hirano']
+  s.email         = ['yhirano@me.com']
+  s.homepage      = 'https://github.com/yhirano55/trace_location'
+  s.summary       = 'logs a tracing result of :call and :return'
+  s.description   = %(TraceLocation gem provides logs a tracing result of `:call` and `:return`. It's useful for reading the huge codes (e.g. Ruby on Rails) and tracing its process.)
+  s.license       = 'MIT'
+  s.files         = Dir.chdir(File.expand_path('.', __dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.5.0'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: trace_location
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: TraceLocation gem provides logs a tracing result of `:call` and `:return`.
+  It's useful for reading the huge codes (e.g. Ruby on Rails) and tracing its process.
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/trace_location.rb
+- lib/trace_location/config.rb
+- lib/trace_location/railtie.rb
+- lib/trace_location/tracer.rb
+- lib/trace_location/version.rb
+- trace_location.gemspec
+homepage: https://github.com/yhirano55/trace_location
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: logs a tracing result of :call and :return
+test_files: []