qp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 248e54482422d481aededf02d0583067c59b6f92
+  data.tar.gz: 984a2f8d55f3ce4ea74954fa8752a07242c4265a
+SHA512:
+  metadata.gz: 0d1e9495160de283603c76ffdacc71a88aad80e51a4f6bbd3fad0b18f7dbb54790177cb33c21c24a13a73edde06c9e2a410c0684f839a10c85b799f5191e8b16
+  data.tar.gz: 85aa81deffccdaeee8420aa0865f4aa5c1697a7d604973c5245d2bf34d4f93fe0f028efad2b6a3cc743f678d3286b5ac4ba6c4249f56fc7b2929a2543be6f22f

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Geoff Hayes
+
+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,59 @@
+# Qp
+
+Qp is a simple ruby gem for inline code debugging
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qp
+
+## Usage
+
+Q.p is a call-inclusive log message
+
+```ruby
+  name = "Doug"
+  Q.p [name, 'band', 3]
+
+  # prints `Q.p Q.p [name, 'band', 3] -> ["Doug","band",3]`
+```
+
+T.p is a benchmark trace point, showing difference since last call (keeps state via IVar)
+
+```ruby
+  T.p
+  sleep 1
+  T.p
+```
+
+```
+15:54:21,263 Track Place 1 /Code/qp/spec/t_spec.rb:6:in `block (2 levels) in <top (required)>' {} +0.00ms (d+)
+15:54:21,375 Track Place 2 /Code/qp/spec/t_spec.rb:8:in `block (2 levels) in <top (required)>' {} +100.99ms (d+100.99ms)
+```
+
+T.p can also accept maps which will show in output `T.p {extra: "information"}` and a "threshold" parameter
+
+```ruby
+  T.p {extra: "information"}
+  sleep 2
+  T.p {threshold: 100} # Since longer than 100 ms from last tp, will raise an exception
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/qp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/qp.rb

@@ -0,0 +1,3 @@
+require "qp/version"
+require "qp/q"
+require "qp/t"

data/lib/qp/q.rb

@@ -0,0 +1,20 @@
+
+module Q
+  def self.p(*args, &block)
+    callable = block || args[0]
+
+    if callable.respond_to?(:yield)
+      source = callable.source.strip if RUBY_VERSION[0].to_i >= 2
+      
+      puts "#{source} -> #{callable.yield}"
+    else
+      if RUBY_VERSION[0].to_i >= 2
+        cl = caller_locations[0]
+
+        source = File.readlines(cl.path)[cl.lineno-1].strip
+      end
+
+      puts "#{source} -> #{args.join(',')}"
+    end
+  end
+end

data/lib/qp/t.rb

@@ -0,0 +1,31 @@
+
+module T
+  def self.p(map={})
+    threshold = map.delete(:threshold)
+    scope = caller[0..(map.delete(:scope) || 0)]
+
+    @tp = ( @tp || 0 ) + 1
+
+    now = Time.now.to_f
+    @first_tp ||= now
+    @last_tp ||= 0
+
+    total_diff = sprintf("%.2fms", ( now - @first_tp ) * 1000)
+
+    if @last_tp.zero?
+      delta_ms = nil
+      delta_formatted = nil
+    else
+      delta_ms = ( now - @last_tp ) * 1000
+      delta_formatted = sprintf("%.2fms", delta_ms)
+    end
+
+    puts [ Time.now.strftime("%T,%L"), 'Track Place', @tp, scope, map, "+#{total_diff} (d+#{delta_formatted})" ].join(" ")
+
+    if threshold && delta_ms && delta_ms > threshold
+      raise "Delta took longer than threshold (#{delta_formatted} > #{threshold}ms) in #{scope}", map: map
+    end
+    
+    @last_tp = now
+  end
+end

data/lib/qp/version.rb

@@ -0,0 +1,3 @@
+module Qp
+  VERSION = "0.0.1"
+end

data/qp.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qp"
+  spec.version       = Qp::VERSION
+  spec.authors       = ["Geoff Hayes"]
+  spec.email         = ["hayesgm@gmail.com"]
+  spec.description   = %q{Qp is a simple tool for inline debugging}
+  spec.summary       = %q{Run `qp my_object` to get `/User/you/code/my_file.rb: "qp my_object" -> "object value"`. More features including simple benchmarking.}
+  spec.homepage      = "https://github.com/hayesgm/qp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/q_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Q do
+
+  it "should print command" do
+    Q.p "hi mom"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'qp'
+
+RSpec.configure do |config|
+
+end

data/spec/t_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe T do
+
+  it "should handle 100ms sleep" do
+    T.p
+    sleep 0.1
+    T.p
+  end
+
+  it "should print benchmark differences" do
+    T.p msg: "hi mom"
+
+    T.p msg: "hi dad"
+  end
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: qp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Geoff Hayes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Qp is a simple tool for inline debugging
+email:
+- hayesgm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/qp.rb
+- lib/qp/q.rb
+- lib/qp/t.rb
+- lib/qp/version.rb
+- qp.gemspec
+- spec/q_spec.rb
+- spec/spec_helper.rb
+- spec/t_spec.rb
+homepage: https://github.com/hayesgm/qp
+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.4.1
+signing_key: 
+specification_version: 4
+summary: 'Run `qp my_object` to get `/User/you/code/my_file.rb: "qp my_object" ->
+  "object value"`. More features including simple benchmarking.'
+test_files:
+- spec/q_spec.rb
+- spec/spec_helper.rb
+- spec/t_spec.rb
+has_rdoc: