qq 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 862a2cd90b5250cf9b88e39dbf7393ed16118dca
+  data.tar.gz: 234ba9609d7c38c6019755308a6048299c18d3df
+SHA512:
+  metadata.gz: 0971bd8de1779756b33608026cad14a7e162e68cb5a419abcdb21df58433ef20a48aea964e399c32f1573919ed58e1065033de04b0926cfdf554f073f47c5528
+  data.tar.gz: 6e331cfa370512cdc875d05e3d642c3020458a99ae30aa01b9235ad68aebe1f8218185025abe9ea09b44672baf7f7a2b6f88fd9edcf6894b43e976cad9798e9e

data/bin/qq

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'optparse'
+require 'tmpdir'
+
+QFILE = File.join(Dir.tmpdir, 'q')
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "usage: qq [options]"
+
+  opts.on('--tmpdir', 'Print system tempdir to stdout.') do
+    puts Dir.tmpdir
+    exit
+  end
+
+  opts.on('--truncate', 'Truncate qq temp file.') do
+    File.truncate(QFILE, 0)
+    exit
+  end
+
+  opts.on('-h', '--help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+FileUtils.touch(QFILE) unless File.exists?(QFILE)
+exec 'tail', '-f', QFILE
+

data/lib/qq.rb

@@ -0,0 +1,86 @@
+require 'pp'
+require 'tmpdir'
+require 'thread'
+require 'parser'
+require 'unparser'
+
+# QQ improves puts debugging.
+#
+# All output goes to 'q' in your `Dir.tempdir`, normally '/tmp/q'.
+#
+# touch /tmp/q && tail -f /tmp/q
+#
+# To print the value of something require 'qq' and use qq() anywhere you would
+# have previously used  pp(), puts etc and searched log files, $stderr, $stdout
+# etc. for your debugging.
+#
+# @example
+#   require 'qq'; qq('hello world')
+# @see Python https://github.com/zestyping/q
+# @see Go https://github.com/y0ssar1an/q
+#--
+# TODO: Calling Q twice on the same line will cause issues because
+# Thread::Backtrace::Location doesn't give us a character only a line.
+class QQ < Parser::AST::Processor
+  NORMAL, YELLOW, CYAN = "\x1b[0m", "\x1b[33m", "\x1b[36m"
+
+  @@mutex ||= Mutex.new
+  @@start ||= Time.now
+  @@location ||= nil
+
+  # @see Kernel#qq
+  #--
+  # TODO: Complain if called directly.
+  def initialize location, args
+    @location, @args = location, args
+    @@mutex.synchronize do
+      begin
+        # Parse the statement that generated the argument from source.
+        process(Parser::CurrentRuby.parse(File.read(location.absolute_path)))
+      rescue StandardError
+        # Failed to parse or embedded Ruby (HAML, ERB, ...) prints the position of each argument in qq()
+        # location preamble/header.
+        # line:0 arg:0 = ...
+        # line:0 arg:1 = ...
+        write args.each_with_index.map{|arg, position| [arg, 'line:%d arg:%d' % [@location.lineno, position]]}
+      end
+    end
+  end
+
+  def on_send ast_node
+    return unless ast_node.loc.line == @location.lineno
+    ast_receiver, ast_method, *ast_args = *ast_node
+
+    return if ast_receiver || ast_method != :qq
+    write @args.zip(ast_args).map{|arg, ast_arg| [arg, ast_arg.loc.expression.source]}
+  end
+
+  protected
+  def write args
+    File.open(File.join(Dir.tmpdir, 'q'), 'a') do |fh|
+      now = Time.now
+
+      if @@start <= now - 2 || @@location&.label != @location.label
+        fh.write "\n%s[%s] %s\n" % [NORMAL, now.strftime('%T'), @location]
+        @@start = now
+      end
+
+      args.each do |arg, arg_source|
+        fh.write [YELLOW, "%1.3fs " % (now - @@start), NORMAL, arg_source, ' = ', CYAN].join
+        PP.pp(arg, fh)
+        fh.write NORMAL
+      end
+
+      @@location = @location
+    end
+  end
+end
+
+module Kernel
+  # Pretty print statements with QQ.
+  #
+  # @example qq('hello world')
+  def qq *args
+    QQ.new(caller_locations(1, 1).first, args)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: qq
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Shane Hanna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Improved puts debugging output for busy Ruby programmers.
+email: shane.hanna@gmail.com
+executables:
+- qq
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/qq
+- lib/qq.rb
+homepage: https://github.com/techspaceco/qq
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Improved pp debugging.
+test_files: []