stack_trace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b44fd93d88276fa812cfa13f22d2cbee7ab4fa3007c32372ef0a2ba8bccee182
+  data.tar.gz: a9308ce4f7223a1bd72860c4a1db54d81328ec0992c4135f94c9055c0a7c6f3d
+SHA512:
+  metadata.gz: 7e655afe6d165fe287322d42ad5d1244d59f05151656dfbae99efdc3ac8c78030fec755eca1a3264daeff2435e564cec7ffd0a780e9b12ad9d5289135ea342c9
+  data.tar.gz: 01d0bee421dc2e2c021d3bcb8c38bef1bda022384a711d9d04eaa323043d3af9bbdb7b84dbc5efd30fa82b0fe275bf7bf0e2c4132e8fe0649f636d521988d52a

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/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stack_trace.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mehmet Emin INAC
+
+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,39 @@
+# StackTrace
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stack_trace`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stack_trace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stack_trace
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stack_trace.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stack_trace"
+
+# 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/stack_trace/span.rb

@@ -0,0 +1,61 @@
+# frozen-string-literal: true
+
+module StackTrace
+  class Span
+    attr_accessor :value, :exception
+    attr_reader :method_name, :args, :spans
+
+    def initialize(method_name, *args)
+      self.started_at = Time.now.to_f
+      self.method_name = method_name
+      self.args = args
+      self.spans = []
+    end
+
+    def add(method_name, *args)
+      (spans << span = Span.new(method_name, *args)) && span
+    end
+
+    def close
+      @finished_at = Time.now.to_f
+      @closed = true
+    end
+
+    def open?
+      !@closed
+    end
+
+    def time
+      case time_ns
+      when 0..1_000
+        "#{time_ns} ns"
+      when 0..1_000_000
+        "#{time_ns / 1_000} µs"
+      when 0..1_000_000_000
+        "#{time_ns / 1_000_000} ms"
+      else
+        "#{time_ns / 1_000_000_000} s"
+      end
+    end
+
+    def as_json
+      {
+        method_name: method_name,
+        arguments: args,
+        value: value,
+        exception: exception,
+        time: time,
+        spans: spans.map(&:as_json)
+      }
+    end
+
+    private
+
+    attr_accessor :started_at, :finished_at
+    attr_writer :method_name, :args, :spans
+
+    def time_ns
+      (finished_at - started_at) * 1_000_000_000
+    end
+  end
+end

data/lib/stack_trace/trace.rb

@@ -0,0 +1,55 @@
+# frozen-string-literal: true
+
+module StackTrace
+  class Trace
+    class << self
+      def track(method_name, *args)
+        span = current.add(method_name, *args)
+        span.value = yield
+      rescue StandardError => e
+        span.exception = e
+        raise e
+      ensure
+        span.close
+      end
+
+      def start
+        @current = new
+      end
+
+      def current
+        @current ||= new
+      end
+
+      def as_json
+        current.as_json
+      end
+    end
+
+    attr_reader :spans
+
+    def initialize
+      @spans = []
+    end
+
+    def add(method_name, *args)
+      add_to_active_span(method_name, *args) || create_new_span(method_name, *args)
+    end
+
+    def as_json
+      { spans: spans.map(&:as_json) }
+    end
+
+    private
+
+    def add_to_active_span(method_name, *args)
+      return unless @current_span&.open?
+
+      @current_span.add(method_name, *args)
+    end
+
+    def create_new_span(method_name, *args)
+      (spans << @current_span = Span.new(method_name, *args)) && @current_span
+    end
+  end
+end

data/lib/stack_trace/version.rb

@@ -0,0 +1,3 @@
+module StackTrace
+  VERSION = "0.1.0"
+end

data/lib/stack_trace.rb

@@ -0,0 +1,43 @@
+# frozen-string-literal: true
+
+require "stack_trace/version"
+require "stack_trace/span"
+require "stack_trace/trace"
+
+module StackTrace
+  def trace(*method_names)
+    self.traced_methods = method_names
+  end
+
+  def method_added(method_name)
+    return unless should_override?(method_name)
+
+    overridden_methods << method_name
+    define_trace_method(method_name)
+  end
+
+  private
+
+  attr_accessor :traced_methods
+
+  def should_override?(method_name)
+    traced_methods.include?(method_name) && !overridden_methods.include?(method_name)
+  end
+
+  def overridden_methods
+    @overridden_methods ||= []
+  end
+
+  def define_trace_method(method_name)
+    traced_method_name = traced_method_name(method_name)
+    alias_method(traced_method_name, method_name)
+
+    define_method(method_name) do |*args|
+      Trace.track(method_name, *args) { send(traced_method_name, *args) }
+    end
+  end
+
+  def traced_method_name(original_method_name)
+    "_traced_#{original_method_name}"
+  end
+end

data/stack_trace.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stack_trace/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stack_trace"
+  spec.version       = StackTrace::VERSION
+  spec.authors       = ["Mehmet Emin INAC"]
+  spec.email         = ["mehmetemininac@gmail.com"]
+
+  spec.summary       = "Tracks the execution of methods configured"
+  spec.description   = "This library tracks the execution of methods, their arguments, return values etc."
+  spec.homepage      = "https://github.com/meinac/stack_trace"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: stack_trace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mehmet Emin INAC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-27 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: This library tracks the execution of methods, their arguments, return
+  values etc.
+email:
+- mehmetemininac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stack_trace.rb
+- lib/stack_trace/span.rb
+- lib/stack_trace/trace.rb
+- lib/stack_trace/version.rb
+- stack_trace.gemspec
+homepage: https://github.com/meinac/stack_trace
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Tracks the execution of methods configured
+test_files: []