quicklog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 540c01430363a89c339bf55b650a5563f0dc229b
+  data.tar.gz: e3509431bcd34d3be8aaff11f1cce7fd6f9aec7e
+SHA512:
+  metadata.gz: 89eaaef654497b4d3c705a0df98cb1e1c02f3de6607204b419208abe1437aadf0838e89b039db50a69078a4b7b84129232951ce1242f1a6a2b982a726c963901
+  data.tar.gz: 6622a0d6323bd05a6aaa6fc529243ad4cb8226ee6b3a7d54db0ff1a31004a06ec741be07de4e8c4d8fcf1ad7543b78b500a3956f5220ebfba18d0014df26f3b5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Florent Guilleux
+
+MIT License
+
+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,55 @@
+# Quicklog
+
+Provides an easy way to log a variable value with its label.
+
+Instead of doing
+
+    puts "my_var = #{my_var}"
+
+write
+
+    ql :my_var
+
+For Ruby 2+ only.
+
+## Examples
+
+* logging an object attribute: `ql :"@user.name"`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quicklog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quicklog
+
+## Credits
+
+I wanted the same kind of functionality that the [lll gem](http://rubygems.org/gems/lll) offers, but with a shorter syntax.
+
+I found the solution I needed in this [stackoverflow answer](http://stackoverflow.com/a/1385047/117704).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## TODO
+
+* display in reverse video
+* allow logging of strings, ie `ql "hi!"`
+* use inspect to output the expression
+* use Awesome Print if available
+* allow logging of string + variable: `ql "hi!", :my_var`
+* allow logging of several variables: `ql :my_var1, :my_var2, :my_var3`
+* logs through Rails.logger if available

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+end
+
+desc "Run tests"
+task default: :test

data/lib/quicklog/version.rb

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

data/lib/quicklog.rb

@@ -0,0 +1,18 @@
+require "quicklog/version"
+require 'debug_inspector'
+
+module Quicklog
+  def self.ql var_symbol
+    RubyVM::DebugInspector.open do |inspector|
+      value = eval var_symbol.to_s, inspector.frame_binding(3)
+      puts "#{var_symbol} = #{value}"
+    end
+  end
+end
+
+module Kernel
+  def ql var_symbol
+    Quicklog.ql var_symbol
+  end
+  module_function :ql
+end

data/quicklog.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quicklog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quicklog"
+  spec.version       = Quicklog::VERSION
+  spec.authors       = ["Florent Guilleux"]
+  spec.email         = ["florent2@gmail.com"]
+  spec.description   = %q{easy logging of a variable value with its label}
+  spec.summary       = %q{easy logging of a variable value with its label}
+  spec.homepage      = "http://github.com/Florent2/quicklog"
+  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.4"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+end

data/test/test_quicklog.rb

@@ -0,0 +1,17 @@
+require "minitest/autorun"
+require "mocha/setup"
+require "quicklog"
+
+class QuicklogTest < Minitest::Test
+  def test_log_variable_label_and_value
+    my_var = 2
+    $stdout.expects(:puts).with("my_var = 2")
+    ql :my_var
+  end
+
+  def test_log_object_attribute
+    person = Struct.new(:name).new "David"
+    $stdout.expects(:puts).with("person.name = David")
+    ql :"person.name"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: quicklog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Florent Guilleux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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: mocha
+  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: easy logging of a variable value with its label
+email:
+- florent2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quicklog.rb
+- lib/quicklog/version.rb
+- quicklog.gemspec
+- test/test_quicklog.rb
+homepage: http://github.com/Florent2/quicklog
+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.1.5
+signing_key: 
+specification_version: 4
+summary: easy logging of a variable value with its label
+test_files:
+- test/test_quicklog.rb