chronometer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fff074b1dca3ad619a10befadf147b9eef28c6d45ec30c56dd3d20b9b1e5972
-  data.tar.gz: daa35ae5b66a491c0b781b6cdc44d0476c8923b3f2aeba5c4ca902ab6a05d7fe
+  metadata.gz: 2dc6f536c735b6262063d5a3091e7675208e093ec96951006bec8dca45be910e
+  data.tar.gz: d636d8a2d12a4b63d7edc2b1e685dd072e87b728d5984b75a0f9767f140009a2
 SHA512:
-  metadata.gz: eb162839dc1cdab0ed373176ee660953e30141616c5c2005fe16a9f0cfe6db5bfed3ef5627b36b293ca6c0cb5d60ee8d20d7b116caf3843ba66ef5ccbc4f0af1
-  data.tar.gz: 22051243d4d84499be6b9a056f349ac81132c2b436078f071658e9a22323486485cf50b192dae87a2caf027c648c8c4a67d9eec5ccdfb48f8f58a647d4a47664
+  metadata.gz: 5d7f49faecbf4ebed41c43d4640a22ff9f9db2ece0cf6907f38a039f7fd05b10187464b260679228dd3c3a56b7db041231d9b44dfcd02b692d1b0e385aa5a42f
+  data.tar.gz: 513375c1f1b6a04070deb65253d17fd4598ce3cde492e3436f9797dc7953db126bb8d594ed597081097e31629e2dec54ad1fa0c0e09084b1f88b754ff84411f0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronometer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Samuel Giddins
@@ -88,16 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CODE_OF_CONDUCT.md
-- LICENSE.txt
-- README.md
 - exe/chronometer
-- lib/chronometer.rb
-- lib/chronometer/command.rb
-- lib/chronometer/dsl.rb
-- lib/chronometer/event.rb
-- lib/chronometer/trace_event.rb
-- lib/chronometer/version.rb
 homepage: https://github.com/segiddins
 licenses:
 - MIT

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 segiddins@squareup.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/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Samuel Giddins
-
-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

@@ -1,43 +0,0 @@
-# Chronometer
-
-A small gem that generates Chrome trace files for Ruby programs.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'chronometer'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install chronometer
-
-## Usage
-
-```
-$ chronometer CocoaPods.chronofile -- pod --version
-```
-
-## 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]/chronometer. 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 Chronometer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chronometer/blob/master/CODE_OF_CONDUCT.md).

data/lib/chronometer.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'chronometer/dsl'
-require_relative 'chronometer/event'
-require_relative 'chronometer/trace_event'
-require_relative 'chronometer/version'
-
-class Chronometer
-  attr_reader :trace_events
-
-  def self.from_file(path, contents: File.read(path))
-    new do
-      instance_eval(contents, path)
-    end
-  end
-
-  def initialize(&blk)
-    dsl = DSL.new
-    dsl.instance_exec(&blk)
-    @events = dsl.events
-    @tracepoints = dsl.tracepoints
-    @trace_event_queue = Queue.new
-    @trace_events = []
-  end
-
-  def install!
-    @events.each { |e| install_method_hook(e) }
-    @tracepoints.each { |tp| install_tracepoint(tp) }
-  end
-
-  def drain!
-    loop { @trace_events << @trace_event_queue.pop(true) }
-  rescue ThreadError
-    nil
-  end
-
-  def print_trace_event_report(dest, metadata: {})
-    raise ArgumentError, 'cannot manually specify :traceEvents' if metadata.key?(:traceEvents)
-    require 'json'
-    File.open(dest, 'w') do |f|
-      f << JSON.generate(metadata)
-      f.seek(-1, :CUR) # remove closing }
-      f << ',' unless metadata.empty?
-      f << '"traceEvents":['
-      @trace_events.each_with_index do |te, i|
-        f << ',' unless i == 0
-        f << JSON.generate(te.to_h)
-      end
-      f << ']}'
-    end
-  end
-
-  def self.timestamp_us
-    Time.now.utc.to_f.*(1_000_000).round
-  end
-
-  def register_trace_event(event)
-    @trace_event_queue << event
-  end
-
-  private
-
-  def install_method_hook(event)
-    cls = event.cls
-    method = event.method
-
-    unbound_method = cls.instance_method(method)
-    arg_labels = unbound_method.parameters.map(&:last)
-
-    timer = self
-
-    cls.send(:define_method, method) do |*args, &blk|
-      context = event.context&.call(self)
-      args_dict = arg_labels.zip(args).to_h
-      args_dict[:context] = context if context
-
-      start_time = ::Chronometer.timestamp_us
-
-      event_type = event.event_type
-      if event_type == :X
-        timer.register_trace_event TraceEvent.new(
-          process_id: Process.pid,
-          thread_id: Thread.current.object_id,
-          start_time_usec: ::Chronometer.timestamp_us,
-          event_type: :B,
-          name: event.name
-        )
-        event_type = :E
-      end
-
-      r0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      begin
-        unbound_method.bind(self).call(*args, &blk)
-      ensure
-        duration = Process.clock_gettime(Process::CLOCK_MONOTONIC).-(r0).*(1_000_000).round
-
-        timer.register_trace_event TraceEvent.new(
-          process_id: Process.pid,
-          thread_id: Thread.current.object_id,
-          start_time_usec: event_type == :E ? ::Chronometer.timestamp_us : start_time,
-          event_type: event_type,
-          name: event.name,
-          args: args_dict,
-          category: event.category,
-          duration: duration,
-          cls: cls,
-          method: method
-        )
-      end
-    end
-  end
-
-  def install_tracepoint(tracepoint)
-    event_name, blk = tracepoint
-    TracePoint.trace(event_name) do |tp|
-      next if tp.path == __FILE__
-      args = {
-        process_id: Process.pid,
-        thread_id: Thread.current.object_id,
-        start_time_usec: ::Chronometer.timestamp_us,
-        event_type: :I,
-        name: event_name
-      }
-      args.update blk&.call(tp)
-
-      te = TraceEvent.new(**args)
-      register_trace_event(te)
-    end
-  end
-end

data/lib/chronometer/command.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'claide'
-require 'chronometer'
-
-class Chronometer
-  module Command; end
-  class Command::Chronometer < CLAide::Command
-    self.version = VERSION
-
-    self.summary = "Trace a ruby program's execution using a chronofile"
-
-    self.arguments = [
-      CLAide::Argument.new('CHRONOFILE', true),
-      CLAide::Argument.new('RUBY_FILE', true),
-      CLAide::Argument.new('ARGUMENTS', false, true)
-    ]
-
-    def self.options
-      [
-        ['--output=TRACE', 'The path to the tracefile chronometer will write']
-      ].concat(super)
-    end
-
-    def initialize(argv)
-      @chronofile = argv.shift_argument
-      @output = argv.option('output', "#{@chronofile}.trace")
-      @file_to_load = argv.shift_argument
-      @arguments = argv.remainder! if @chronofile && @file_to_load
-      super
-    end
-
-    def validate!
-      super
-      help! 'Must supply a chronofile' unless @chronofile
-      @chronofile_contents = begin
-                               File.read(@chronofile)
-                             rescue StandardError
-                               help!("No such chronofile `#{@chronofile}`")
-                             end
-      help! 'Must supply a ruby file to load' unless @file_to_load
-      @file_to_load = ENV.fetch('PATH', '').split(File::PATH_SEPARATOR).push('.').reduce do |a, e|
-        next a if a
-        a ||= File.join(e, @file_to_load)
-        a &&= nil unless File.file?(a)
-        a
-      end
-      help! "Could not find `#{@file_to_load}`" unless @file_to_load
-    end
-
-    def run
-      argv = ::ARGV.dup
-      ::ARGV.replace(@arguments)
-      time { load(@file_to_load) }
-    ensure
-      ::ARGV.replace(argv)
-    end
-
-    private
-
-    def time
-      timer = ::Chronometer.from_file(@chronofile, contents: @chronofile_contents)
-      timer.install!
-
-      begin
-        yield
-      ensure
-        timer.drain!
-        timer.print_trace_event_report(@output, metadata: { meta_success: $ERROR_INFO.nil? })
-      end
-    end
-  end
-end

data/lib/chronometer/dsl.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-class Chronometer
-  class DSL
-    attr_reader :events, :tracepoints
-
-    def initialize
-      @events = []
-      @tracepoints = []
-    end
-
-    def for_class(cls)
-      @cls && raise('already in for_class')
-      @cls = cls
-
-      yield
-    ensure
-      @cls = nil
-    end
-
-    def for_singleton_class(cls, &blk)
-      for_class(cls.singleton_class, &blk)
-    end
-
-    def method(method_name, **opts)
-      opts[:name] ||= @cls.singleton_class? ? "#{ObjectSpace.each_object(@cls).to_a.last}.#{method_name}" : "#{@cls}##{method_name}"
-      opts.delete(:method) && raise('Cannot specify :method')
-      opts[:method] = method_name
-      opts[:event_type] ||= :X
-      opts[:cls] = @cls || raise('must be in for_class block')
-      events << Event.new(opts)
-    end
-
-    def methods(*method_names, **opts)
-      method_names.flatten.each do |method_name|
-        method method_name, **opts
-      end
-    end
-
-    def tracepoint(event_name, &blk)
-      @cls && raise('in for_class block')
-
-      tracepoints << [event_name, blk]
-    end
-  end
-  private_constant :DSL
-end

data/lib/chronometer/event.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-class Chronometer
-  class Event
-    attr_reader :cls, :method, :name, :category, :event_type, :context
-
-    def initialize(cls: nil, method: nil, name: nil, category: nil, event_type: nil, context: nil)
-      @cls = cls
-      @method = method
-      @name = name
-      @category = category
-      @event_type = event_type
-      @context = context
-    end
-  end
-  private_constant :Event
-end

data/lib/chronometer/trace_event.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-class Chronometer
-  class TraceEvent
-    attr_reader :process_id, :thread_id, :start_time_usec, :event_type, :name, :args, :category, :duration, :cls, :method
-
-    def initialize(process_id: nil, thread_id: nil, start_time_usec: nil, event_type: nil, name: nil, args: nil, category: nil, duration: nil, cls: nil, method: nil)
-      @process_id = process_id
-      @thread_id = thread_id
-      @start_time_usec = start_time_usec
-      @event_type = event_type
-      @name = name
-      @args = args
-      @category = category
-      @duration = duration
-      @cls = cls
-      @method = method
-    end
-
-    def to_h
-      compact_hash(
-        pid: process_id,
-        tid: thread_id,
-        ts: start_time_usec,
-        ph: event_type,
-        name: name,
-        args: args,
-        cat: category,
-        dur: duration
-      )
-    end
-
-    if {}.respond_to?(:compact)
-      def compact_hash(hash)
-        hash.compact
-      end
-    else
-      def compact_hash(hash)
-        hash.reject { |_k, v| v.nil? }
-      end
-    end
-  end
-  private_constant :TraceEvent
-end

data/lib/chronometer/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-class Chronometer
-  VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze
-end