caller_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 170210b9d7d1c0fe0f6caf0b358cfbccec98e54c
+  data.tar.gz: fd1c8f249534e9d62ff28e55d1ebd1014832ded1
+SHA512:
+  metadata.gz: 81309e4dc08389dc2f29bd8d45d43c1375e96aa739c4694db5adeeb84fb94bd9d7b0dba99b4a98bdd5e229babdad073f863f75c1df244026aba7bf06d460302d
+  data.tar.gz: 5ad9e14f9dcf5a4324372c54ed072a7425081506f7d007fb1574f722abc119f78df32cd45d9143ad7c6fbd3a9ac283efdcb705b12258cd61424c025a212893b3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ken
+
+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,41 @@
+# CallerLog
+
+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/caller_log`. 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 'caller_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caller_log
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/ken/caller_log.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caller_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caller_log"
+  spec.version       = CallerLog::VERSION
+  spec.authors       = ["ken"]
+  spec.email         = ["block24block@gmail.com"]
+
+  spec.summary       = %q{Log every call to a object}
+  spec.homepage      = 'https://github.com/turnon/caller_log'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "dcr"
+  spec.add_dependency "binding_of_callers"
+  spec.add_dependency "nokogiri", "~> 1.7.1"
+end

data/lib/caller_log/log.rb

@@ -0,0 +1,80 @@
+require 'set'
+require 'nokogiri'
+require 'binding_of_callers/pry'
+require 'cgi'
+
+module CallerLog
+
+  class Log
+
+    attr_reader :file, :html, :lock
+
+    def initialize file
+      file = File.new file, 'a+' unless File === file
+      @file = file
+      @html = Html.new
+      @lock = Mutex.new
+    end
+
+    def puts record
+      lock.synchronize do
+        html.add record
+        File.open file, 'w+' do |f|
+          f.puts html.to_s
+        end
+      end
+    end
+
+    class Html
+
+      Template = File.expand_path('../template.html', __FILE__)
+
+      attr_reader :base, :threads
+
+      def initialize
+        @base = File.open(Template) { |f| Nokogiri::HTML(f) }
+        @threads = Set.new
+      end
+
+      def add record
+        new_thread_fragment
+        new_call_fragment record
+        new_stack_fragment record
+      end
+
+      def new_thread_fragment
+        return if threads.include?(id = Thread.current.object_id)
+        thread = Nokogiri::HTML::DocumentFragment.parse <<-EOHTML
+<li id='thread-#{id}'>
+  <input type="checkbox" name=threads value='#{id}' checked='checked'>#{id}</input>
+</li>
+EOHTML
+        base.at_css('.threads') << thread
+        threads << id
+      end
+
+      def new_call_fragment record
+        time = record.time.strftime "%F %T"
+        call = Nokogiri::HTML::DocumentFragment.parse <<-EOHTML
+<li id='call-#{record.object_id}' class='thread-#{Thread.current.object_id} call'>
+  <span class='time'>#{time}</span><span class='class_and_method'>#{record.module}##{record.method_id}</span>
+</li>
+EOHTML
+        base.at_css('.calls') << call
+      end
+
+      def new_stack_fragment record
+        callers = record.callers.map do |c|
+          class_and_method = CGI::escapeHTML "#{c.klass}#{c.call_symbol}#{c.frame_env}"
+          "<p><span class='class_and_method'>#{class_and_method}</span><span class='location'>#{c.file}:#{c.line}</span></p>"
+        end.join
+        stack = "<li class='call-#{record.object_id}'>#{callers}</li>"
+        base.at_css('.stacks') << stack
+      end
+
+      def to_s
+        base.to_s
+      end
+    end
+  end
+end

data/lib/caller_log/template.html

@@ -0,0 +1,110 @@
+<!DOCTYPE HTML>
+<html>
+  <head>
+    <meta charset='utf-8'/>
+    <style>
+ul {
+    padding-left: 0;
+}
+
+li {
+  list-style: none;
+  margin-bottom: .8rem;
+}
+
+ul.threads li {
+    float: left;
+    margin-top: -.5rem;
+}
+
+ul.calls {
+    position: fixed;
+    margin-top: 2rem;
+    top: 1rem;
+    bottom: 0;
+    width: 18rem;
+    overflow: auto;
+}
+
+ul.stacks {
+    position: fixed;
+    left: 20rem;
+    top: 1rem;
+    bottom: 0;
+    margin-top: 2rem;
+    overflow: auto;
+    width: calc(100% - 20rem);
+}
+
+p {
+    margin:0 0 0 0;
+}
+
+span.time {
+    display: block;
+    font-size: smaller;
+}
+
+.stacks span.class_and_method {
+  color: gray;
+  margin-right: .5rem;
+}
+
+.hidden {
+    display: none;
+}
+
+ul.stacks li {
+  display: none;
+}
+
+ul.stacks li.show {
+    display: block;
+}
+    </style>
+  </head>
+  <body>
+    <ul class='threads'>
+    </ul>
+    <ul class='calls'>
+    </ul>
+    <ul class='stacks'>
+    </ul>
+    <script>
+(function(){
+
+  function calls_in_thread(id){
+    return document.querySelectorAll('.thread-' + id);
+  }
+
+  function show_call(thread_id){
+    calls_in_thread(thread_id).forEach(function(call){
+      call.classList.remove('hidden');
+    });
+    return true;
+  }
+
+  function hide_call(thread_id){
+    calls_in_thread(thread_id).forEach(function(call){
+      call.classList.add('hidden');
+    });
+  }
+
+  function toggle_stack(call_li){
+    var curr_shown = document.querySelector('.show')
+    curr_shown && curr_shown.classList.remove('show');
+    document.querySelector('.' + call_li.id).classList.add('show');
+  }
+
+  var body = document.getElementsByTagName('body')[0];
+
+  body.addEventListener('click', function(e){
+    var target = e.target;
+    target.type == 'checkbox' && target.checked && show_call(target.value) || hide_call(target.value);
+    e.target.parentElement.classList.contains('call') && toggle_stack(e.target.parentElement);
+  }, false);
+
+})();
+    </script>
+  </body>
+</html>

data/lib/caller_log/version.rb

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

data/lib/caller_log.rb

@@ -0,0 +1,29 @@
+require 'caller_log/version'
+require 'caller_log/log'
+require 'binding_of_callers'
+require 'dcr'
+
+module CallerLog
+  class << self
+
+    def instance *args
+      raise ArgumentError,
+        "wrong number of arguments (given #{args.count}, expected more than 1)" if args.count < 2
+      log_file = args.pop
+      modules = Array args
+
+      log = Log.new log_file
+
+      modules.each do |mod|
+        mod.instance_methods(false).each do |method_id|
+          Dcr.instance mod, method_id do |method, *para, &blk|
+            record =  OpenStruct.new time: Time.now, module: mod, method_id: method_id, callers: binding.of_callers[2..-1]
+            log.puts record
+            method.call *para, &blk
+          end
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: caller_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ken
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dcr
+  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: binding_of_callers
+  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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+description: 
+email:
+- block24block@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caller_log.gemspec
+- lib/caller_log.rb
+- lib/caller_log/log.rb
+- lib/caller_log/template.html
+- lib/caller_log/version.rb
+homepage: https://github.com/turnon/caller_log
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Log every call to a object
+test_files: []