loba 0.3.1 → 1.0.0

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
-addons:
-    code_climate:
-        repo_token: 8e4f3d6c483544a1479af37a53ca72b968cf77cdf7a050e3e163cf526444d832
-after_success:
-  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem 'yard'
-end
-
-group :test do
-  gem 'codeclimate-test-reporter', require: nil
-  gem 'simplecov', require: false
-end

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

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

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/loba.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'loba/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "loba"
-  spec.version       = Loba::VERSION
-  spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ["Richard Newman"]
-  spec.email         = ["richard@newmanworks.com"]
-
-  spec.summary       = %q{Loba: Easy tracing for debugging.}
-  spec.description   = %q{Handy methods for adding trace lines to output or Rails logs.}
-  spec.homepage      = "https://github.com/rdnewman/loba"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.1.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-
-  spec.add_dependency "binding_of_caller", "~> 0.7"
-  spec.add_dependency "colorize", "~> 0.7"
-end

data/readme/ts.md

@@ -1,45 +0,0 @@
-#### Timestamp notices:  `Loba.ts`
-Outputs a timestamped notice, useful for quick traces to see the code path and easier than, say, [Kernel#set_trace_func](http://ruby-doc.org/core-2.2.3/Kernel.html#method-i-set_trace_func).
-Also does a simple elapsed time check since the previous timestamp notice to help with quick, minimalist profiling.
-
-For example,
-
-```
-[TIMESTAMP] #=0002, diff=93.478016, at=1451444972.970602    (in=/home/usracct/src/myapp/app/models/target.rb:55:in `some_calculation')
-```
-
-To invoke,
-
-```
-Loba.ts    # no arguments
-```
-
-`Loba.timestamp` is an alias for `Loba.ts`.
-
-The resulting notice output format is
-
-```
-[TIMESTAMP] #=nnnn, diff=ss.ssssss, at=tttttttttt.tttttt    (in=/path/to/code/somecode.rb:LL:in 'some_method')
-```
-
-where
-*   `nnn` ("#=") is a sequential numbering (1, 2, 3, ...) of timestamp notices,
-*   `ss.ssssss` ("diff=") is number of seconds since the last timestamp notice was output (i.e., relative time),
-*   `tttttttttt.tttttt` ("at=") is Time.now (as seconds) (i.e., absolute time),
-*   `/path/to/code/somecode.rb` ("in=") is the source code file that invoked `Loba.ts`,
-*   `LL` ("in=...:") is the line number of the source code file that invoked `Loba.ts`, and
-*   `some_method`is the method in which `Loba.ts` was invoked.
-
-
-##### Options
-
-As the last argument, an options hash may be provided:
-*   `production`: true if this value notice is enabled when running in :production environment (see ["Environment Notes"](README.md#environment-notes)) \[_default: `false`_\]
-
-###### Example 5: Using options hash
-```ruby
-Loba.ts production: true
-```
-```ruby
-Loba.ts {production: true}
-```

data/readme/val.md

@@ -1,117 +0,0 @@
-#### Value notices:  `Loba.val`
-
-Inserts line to Rails.logger.debug (or to STDOUT if Rails.logger not available) showing value with method and class identification
-
-```
-Loba.val :var_sym         # the :var_sym argument is the variable or method name given as a symbol (see below)
-```
-
-or
-
-```
-Loba.val some_identifier  # directly give a variable or method name instead of a symbol (see below)
-```
-
-or
-
-```
-Loba.val some_identifier, "My label:"  # same as direct variable, but allows a custom label
-```
-
-Will produce a notice similar to the following:
-
-```
-[Target.some_calculation] my_var: 54       (in /home/usracct/src/myapp/app/models/target.rb:55:in `some_calculation')
-```
-
-###### Example 1: Using simple Symbol as argument
-```ruby
-class HelloWorld
-  def hello(name)
-Loba.val :name       # best to put Loba statement to far left for easy removal when done
-    puts "Hello, #{name}!"
-  end
-end
-HelloWorld.new.hello("Charlie")
-#=> [HelloWorld#hello] name: Charlie        (in /path/to/file/hello_world.rb:3:in `hello')
-#=> Hello, Charlie!
-```
-
-###### Example 2: Using more complex Symbol as argument
-```ruby
-class HelloWorld
-  def hello(name)
-    myHash = {somename: name}
-# Loba.val :myHash[name]  won't work directly, but...
-Loba.val "myHash[name]".to_sym   # will work -- just express the name as a String and cast to a Symbol
-    puts "Hello, #{name}!"
-  end
-end
-HelloWorld.new.hello("Charlie")
-#=> [HelloWorld#hello] myHash[name]: Charlie        (in /path/to/file/hello_world.rb:5:in `hello')
-#=> Hello, Charlie!
-```
-
-###### Example 3: Using a non-Symbol as argument without a label
-```ruby
-class HelloWorld
-  def hello(name)
-Loba.val name
-    puts "Hello, #{name}!"
-  end
-end
-HelloWorld.new.hello("Charlie")
-#=> [HelloWorld#hello] Charlie        (in /path/to/file/hello_world.rb:3:in `hello')
-#=> Hello, Charlie!
-```
-
-###### Example 4: Using a non-Symbol as argument with a label
-```ruby
-class HelloWorld
-  def hello(name)
-Loba.val name, "Name:"
-    puts "Hello, #{name}!"
-  end
-end
-HelloWorld.new.hello("Charlie")
-#=> [HelloWorld#hello] Name: Charlie        (in /path/to/file/hello_world.rb:3:in `hello')
-#=> Hello, Charlie!
-```
-
-##### Notice format:
-
-The resulting notice output format is
-
-```
-[ccccc.mmmmm] vvvvv: rrrrr         (in /path/to/code/somecode.rb:LL:in 'some_method')
-```
-
-where
-*   `ccccc` is the name of the class from where `Loba.val` was invoked,
-*   `mmmmm` is the name of the method from where `Loba.val` was invoked,
-*   `vvvvv` is generally the name of the variable for which `Loba.val` is inspecting, or any custom label given,
-*   `rrrrr` is the result of inspecting what `Loba.val` was invoked against,
-*   `/path/to/code/somecode.rb` is the source code file that invoked `Loba.val`,
-*   `LL` is the line number of the source code file that invoked `Loba.val`, and
-*   `some_method`is the method in which `Loba.val` was invoked.
-
-
-Notes:
-*   `ccccc`:  Ruby supports anonymous classes (e.g., `= Class.new`).  If an anonymous class, "<anonymous class>" will be output here.
-*   `mmmmm`:  Ruby supports anonymous methods, procs, and lambdas.  If an anonymous method, et al, "<anonymous method>" will be output here.
-*   `vvvvv`:  This depends on the argument being provided:  if a symbol, then this field will use that symbol to determine the name and present it here.  If not, nothing will appear for this field.
-*   `rrrrr`:  The value of the variable given to `Loba.val`.  `inspect` may be used (see [options](#options) below).
-
-##### Options
-
-As the last argument, an options hash may be provided:
-*   `inspect`: true if this value notice is to use #inspect against the content being evaluated \[_default: `true`_\]
-*   `production`: true if this value notice is enabled when running in :production environment (see ["Environment Notes"](README.md#environment-notes)) \[_default: `false`_\]
-
-###### Example 5: Using options hash
-```ruby
-Loba.val name, "Name:", inspect: false, production: true
-```
-```ruby
-Loba.val :name, nil, {production: true}
-```