rshade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1a648fd8621c8dfe519955fc273f5a22314a8e2a6fb372296e4694f11ed6db6
+  data.tar.gz: 9d7f218e95562c710111e7fcfd95f528c61d808dbcc5bab044de559565e2be52
+SHA512:
+  metadata.gz: 786170c5c9181173d21177c709ce58844d2cae4d500c1cbb8542eb58e51e43195bebebb3567dffabd5d97fe95d052235215f97b2d8c90e2997fb068d8c292282
+  data.tar.gz: 8df21732b47f6a15ffb38ea09c1dfe5755e6df65b5552c9721a0d509267dbd4e29c33cf63fd0a11c1949c07a2ee2bd283708dd6f9c7dfcd280387bc4720ab67d

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.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rshade.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    rshade (0.1.0)
+      colorize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rshade!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ivan Lopatin
+
+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,44 @@
+# RShade  
+  
+ 
+![warcraft shade](https://github.com/gingray/rshade/raw/master/shade.jpg)
+
+Ruby Shade or RShade gem to help you to reveal which code are used in program execution.
+
+  
+```ruby
+trace = RShade::Trace.new  
+trace.reveal do  
+  #your code here
+end
+```
+
+## Installation  
+  
+Add this line to your application's Gemfile:  
+  
+```ruby  
+gem 'rshade'  
+```  
+  
+And then execute:  
+  
+ $ bundle  
+Or install it yourself as:  
+  
+ $ gem install rshade  
+## Usage  
+  
+TODO: Write usage instructions here  
+  
+## TODO  
+Use stack to keep connections between current method and caller  
+take a look on https://github.com/matugm/visual-call-graph  
+  
+## Contributing  
+  
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rshade.  
+  
+## 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 "rshade"
+
+# 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/rshade.rb

@@ -0,0 +1,10 @@
+require 'colorize'
+require "rshade/helper"
+require "rshade/source_node"
+require "rshade/filter"
+require "rshade/trace"
+require "rshade/rspec"
+require "rshade/version"
+
+module RShade
+end

data/lib/rshade/filter.rb

@@ -0,0 +1,23 @@
+module RShade
+  class Filter
+    RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
+    def call(path)
+      return false unless path
+
+      exclude_path.none? { |item| path.include? item }
+    end
+
+    def exclude_path
+      @path_arr ||= begin
+        [ENV['GEM_PATH'].split(':'), parse_ruby_version].flatten.compact
+      end
+    end
+
+    def parse_ruby_version
+      val = RUBY_VERSION_PATTERN.match(ENV['GEM_PATH'])
+      return nil unless val
+
+      val[0]
+    end
+  end
+end

data/lib/rshade/helper.rb

@@ -0,0 +1,14 @@
+module RShade
+  module Helper
+    def pretty_print(root)
+      str = StringIO.new
+      str.write "\n\n"
+      str.write "---\n".colorize(:yellow)
+      root.traverse do |node|
+        str.write"#{' ' * node.level}#{node.pretty}\n" if node.valid?
+      end
+      str.write '---'.colorize(:yellow)
+      str.string
+    end
+  end
+end

data/lib/rshade/rspec.rb

@@ -0,0 +1,27 @@
+module RShade
+  REPORTS = []
+
+  module RSpecHelper
+    def rshade_reveal(&block)
+      raise 'No block given' unless block_given?
+
+      trace = Trace.new
+      trace.reveal do
+        yield
+      end
+
+      REPORTS.push trace.show
+    end
+  end
+end
+
+if defined? RSpec
+  RSpec.configure do |c|
+    c.include RShade::RSpecHelper
+
+    c.after(:suite) do
+      RShade::REPORTS.each(&method(:puts))
+      RShade::REPORTS.clear
+    end
+  end
+end

data/lib/rshade/source_node.rb

@@ -0,0 +1,69 @@
+module RShade
+  class SourceNode
+    attr_accessor :nodes, :value, :parent
+
+    def initialize(parent, value = nil)
+      @nodes = []
+      @value = value || { valid: true, level: 0 }
+      @value[:valid] = true unless @value.has_key?(:valid)
+      @parent = parent
+    end
+
+    def add(node)
+      @nodes << node
+    end
+
+    def valid?
+      @value[:valid]
+    end
+
+    def toggle_valid(state)
+      @value[:valid] = state
+    end
+
+    def level
+      @value[:level] || 0
+    end
+
+    def klass
+      @value[:klass]
+    end
+
+    def method_name
+      @value[:method_name]
+    end
+
+    def path
+      @value[:path]
+    end
+
+    def lineno
+      @value[:lineno]
+    end
+
+    def pretty
+      class_method = "#{klass}##{method_name}".colorize(:green)
+      full_path = "#{path}:#{lineno}".colorize(:blue)
+      "#{class_method} -> #{full_path}"
+    end
+
+    def filter(node = self, &block)
+      return unless block_given?
+
+      node.nodes.each do |item|
+        filter(item, &block)
+      end
+
+      unless yield(node)
+        node.toggle_valid false
+      end
+    end
+
+    def traverse(node = self, &block)
+      return unless block_given?
+
+      yield(node)
+      node.nodes.each { |leaf| traverse(leaf, &block) }
+    end
+  end
+end

data/lib/rshade/trace.rb

@@ -0,0 +1,44 @@
+module RShade
+  class Trace
+    include RShade::Helper
+    attr_accessor :source_tree, :open, :close, :set
+    EVENTS = %i[call return].freeze
+
+    def initialize
+      @source_tree = SourceNode.new(nil)
+      @tp = TracePoint.new(*EVENTS, &method(:process_trace))
+      @filter = RShade::Filter.new
+      @stack = [@source_tree]
+    end
+
+    def reveal
+      return unless block_given?
+
+      @tp.enable
+      yield
+    ensure
+      @tp.disable
+    end
+
+    def show
+      @source_tree.filter do |node|
+        next true unless node.parent
+
+        @filter.call(node.path)
+      end
+      pretty_print @source_tree
+    end
+
+    def process_trace(tp)
+      if tp.event == :call
+        parent = @stack.last
+        hash = { level: @stack.size, path: tp.path, lineno: tp.lineno, klass: tp.defined_class, method_name: tp.method_id }
+        node = SourceNode.new(parent, hash)
+        parent.add node
+        @stack.push node
+      end
+
+      @stack.pop if tp.event == :return && @stack.size > 1
+    end
+  end
+end

data/lib/rshade/version.rb

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

data/rshade.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rshade/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rshade"
+  spec.version       = RShade::VERSION
+  spec.authors       = ["Ivan Lopatin"]
+  spec.email         = ["gingray.dev@gmail.com"]
+
+  spec.summary       = %q{https://github.com/gingray/rshade}
+  spec.description   = %q{https://github.com/gingray/rshade}
+  spec.homepage      = "https://github.com/gingray/rshade"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/gingray/rshade"
+    spec.metadata["changelog_uri"] = "https://github.com/gingray/rshade/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_runtime_dependency 'colorize'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rshade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Lopatin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: https://github.com/gingray/rshade
+email:
+- gingray.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rshade.rb
+- lib/rshade/filter.rb
+- lib/rshade/helper.rb
+- lib/rshade/rspec.rb
+- lib/rshade/source_node.rb
+- lib/rshade/trace.rb
+- lib/rshade/version.rb
+- rshade.gemspec
+- shade.jpg
+homepage: https://github.com/gingray/rshade
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gingray/rshade
+  source_code_uri: https://github.com/gingray/rshade
+  changelog_uri: https://github.com/gingray/rshade/CHANGELOG.md
+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.7.8
+signing_key: 
+specification_version: 4
+summary: https://github.com/gingray/rshade
+test_files: []