ruby_snooper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f76024cd4ebf598fc71e2ff34cb6d9cda4e53fa2cad98444c9db29fe005437e
+  data.tar.gz: cdab886d2524496c6d27bc8006cabd820f02f7f2d9485260b9f74b9a57c20195
+SHA512:
+  metadata.gz: 25b10369c1480cbe774ae9bd566a95a2c207d5f55a58578cb50f4ebf86e4f923d3a6c8d4ba669c582faf5735c761bf7638ff1b1a39574b85e52e0d4800de0c96
+  data.tar.gz: e12afbdb620569e1be113b45a37dd44ef038e3363ff25a15e1edb21c477c6c6c2d534c7b61b7acfaf52ddc3e9a54367ea7a36c25fd61732a837bd4be9013b591

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec
+.rspec_status

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at koyama.gakugai@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby_snooper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    ruby_snooper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    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.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruby_snooper!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 nanonanomachine
+
+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,87 @@
+# RubySnooper
+
+RubySnooper is Poort man's debugger heavily inspired by [PySnooper](https://github.com/cool-RR/PySnooper)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_snooper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_snooper
+
+## Usage
+
+```ruby
+class SampleClass
+  extend RubySnooper
+  snoop :sample_instance_method
+  snoop_class_methods :sample_class_method
+
+  def self.sample_class_method(arg1, arg2)
+    arg1 = arg1 + 1
+    arg3 = arg1 + arg2
+    arg3 * 2
+  end
+
+  def sample_instance_method(arg1, arg2)
+    arg1 = arg1 + 1
+    arg3 = arg1 + arg2
+    arg3 * 2
+  end
+end
+
+SampleClass.new.sample_instance_method(1, 2)
+SampleClass.sample_class_method(1, 2)
+```
+
+The output to stderr is:
+
+```
+From /some/file/path.rb
+Starting var arg1 = 1, arg2 = 2, arg3 = nil
+02:06:31,239 call   59     def sample_instance_method(arg1, arg2)
+02:06:31,239 line   60       arg1 = arg1 + 1
+Modified var arg1 = 2
+02:06:31,239 line   61       arg3 = arg1 + arg2
+Modified var arg3 = 4
+02:06:31,239 line   62       arg3 * 2
+02:06:31,239 return 63     end
+Return value 8
+From /some/file/path.rb
+Starting var arg1 = 1, arg2 = 2, arg3 = nil
+02:06:31,240 call   53     def self.sample_class_method(arg1, arg2)
+02:06:31,240 line   54       arg1 = arg1 + 1
+Modified var arg1 = 2
+02:06:31,240 line   55       arg3 = arg1 + arg2
+Modified var arg3 = 4
+02:06:31,241 line   56       arg3 * 2
+02:06:31,241 return 57     end
+Return value 8
+```
+
+## 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]/ruby_snooper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubySnooper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_snooper/blob/master/CODE_OF_CONDUCT.md).

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 "ruby_snooper"
+
+# 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/ruby_snooper/trace_writer.rb

@@ -0,0 +1,120 @@
+module RubySnooper
+  class TraceWriter
+    def initialize(method_names, caller_path)
+      @method_names = method_names
+      @caller_path = caller_path
+      @source_cache = {}
+      @lines = []
+      @return = nil
+    end
+
+    def code_for(filename)
+      @source_cache[filename] ||= IO.readlines(filename, chomp: true)
+    end
+
+    def print
+      @lines.each(&:print)
+      @return.print
+    end
+
+    def trace_point
+      @trace_point ||= TracePoint.new(:call, :line, :return) do |tp|
+        next unless @method_names.include?(tp.method_id)
+        next if tp.path != @caller_path
+
+        local_variables = tp.binding.local_variables.map do |name|
+          [name, tp.binding.local_variable_get(name).inspect]
+        end.to_h
+
+        if @lines.count > 0
+          new_variables = local_variables.select { |key,value| !@lines.last.local_variables.has_key?(key) }
+          modified_variables = local_variables.select {|key, value| @lines.last.local_variables.has_key?(key) && value != @lines.last.local_variables[key] }
+        end
+
+        case tp.event
+        when :call, :line
+          @lines << Line.new(
+            tp.method_id,
+            tp.event,
+            tp.lineno,
+            Time.now,
+            code_for(tp.path)[tp.lineno - 1],
+            local_variables,
+            new_variables,
+            modified_variables,
+            tp.path,
+          )
+        when :return
+          @return = Return.new(
+            tp.method_id,
+            tp.event,
+            tp.lineno,
+            Time.now,
+            code_for(tp.path)[tp.lineno - 1],
+            tp.return_value,
+            tp.path,
+          )
+        end
+      end
+    end
+
+    class Line
+      attr_reader :method_id, :event, :number, :time, :code, :local_variables, :new_variables, :modified_variables
+
+      def initialize(method_id, event, number, time, code, local_variables, new_variables, modified_variables, file_path)
+        @method_id = method_id
+        @event = event
+        @number = number
+        @time = time
+        @code = code
+        @local_variables = local_variables
+        @new_variables = new_variables
+        @modified_variables = modified_variables
+        @file_path = file_path
+      end
+
+      def print
+        STDERR.puts "From #{@file_path}" if @event == :call
+        print_variables
+        STDERR.puts "#{Time.now.strftime("%T,%L")} #{@event}   #{number} #{code}"
+      end
+
+      private
+
+      def print_variables
+        case @event
+        when :call
+          STDERR.puts "Starting var #{variables_str(@local_variables)}"
+        when :line
+          STDERR.puts "New var      #{variables_str(@new_variables)}" if @new_variables.count > 0
+          STDERR.puts "Modified var #{variables_str(@modified_variables)}" if @modified_variables.count > 0
+        end
+      end
+
+      def variables_str(variables)
+        variables.map do |key, value|
+          "#{key} = #{value}"
+        end.join(', ')
+      end
+    end
+
+    class Return
+      attr_reader :method_id, :event, :number, :time, :code, :return_value
+
+      def initialize(method_id, event, number, time, code, return_value, file_path)
+        @method_id = method_id
+        @event = event
+        @number = number
+        @time = time
+        @code = code
+        @return_value = return_value
+        @file_path = file_path
+      end
+
+      def print
+        STDERR.puts "#{Time.now.strftime("%T,%L")} #{@event} #{@number} #{@code}"
+        STDERR.puts "Return value #{@return_value}"
+      end
+    end
+  end
+end

data/lib/ruby_snooper/version.rb

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

data/lib/ruby_snooper.rb

@@ -0,0 +1,38 @@
+require "ruby_snooper/version"
+require "ruby_snooper/trace_writer"
+
+module RubySnooper
+  class Error < StandardError; end
+
+  CLASS_NAME_PATTERN = /\<class\:(\w+)\>/.freeze
+
+  def snoop(*method_names)
+    prepend to_prepend(method_names)
+  end
+
+  def snoop_class_methods(*method_names)
+    Kernel.const_get(caller_locations.first.label.match(CLASS_NAME_PATTERN)[1])
+          .singleton_class
+          .prepend(to_prepend(method_names))
+  end
+
+  private
+
+  def to_prepend(method_names)
+    Module.new do
+      method_names.each do |method_name|
+        define_method(method_name) do |*args, &block|
+          trace_writer = TraceWriter.new(
+            method_names,
+            caller_locations.first.path,
+          )
+          trace_writer.trace_point.enable
+          super(*args,&block).tap do
+            trace_writer.trace_point.disable
+            trace_writer.print
+          end
+        end
+      end
+    end
+  end
+end

data/ruby_snooper.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_snooper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_snooper"
+  spec.version       = RubySnooper::VERSION
+  spec.authors       = ["nanonanomachine"]
+  spec.email         = ["koyama.gakugai@gmail.com"]
+
+  spec.summary       = %q{Poort man's debugger heavily inspired by PySnooper}
+  spec.description   = %q{Poort man's debugger heavily inspired by PySnooper}
+  spec.homepage      = "https://github.com/nanonanomachine/ruby_snooper"
+  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", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ruby_snooper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nanonanomachine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: Poort man's debugger heavily inspired by PySnooper
+email:
+- koyama.gakugai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_snooper.rb
+- lib/ruby_snooper/trace_writer.rb
+- lib/ruby_snooper/version.rb
+- ruby_snooper.gemspec
+homepage: https://github.com/nanonanomachine/ruby_snooper
+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.1
+signing_key: 
+specification_version: 4
+summary: Poort man's debugger heavily inspired by PySnooper
+test_files: []