aqui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d04f21ddc9b10acfea60005040e69869af7e65e6
+  data.tar.gz: a736934f6c3e348002fad72f02f2c6cf25c9bec1
+SHA512:
+  metadata.gz: cd0a4f8d2bc9e540bcac9a71c9cb760f8155d99ea2e3eb7d58666cd6f66388a4ea48b93101e567956cbea3a116bb36b43dcff12c1e522c4d876d63a4c311b6fa
+  data.tar.gz: a26c56ebf9d5e248a40b64863336717057c3f9e34e3fb585c97ccc4d8c8b90f19342943309b91500e19f4cd73b73d50c317653ceeabc51cf23747523f2a8abc6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/StringLiterals:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 2.1.1
+- 2.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aqui.gemspec
+gemspec
+gem 'rspec'
+gem 'guard-rspec'
+gem 'ruby_gntp'
+gem 'guard-rubocop'
+gem 'simplecov'
+gem 'coveralls'
+gem 'codeclimate-test-reporter'

data/Guardfile

@@ -0,0 +1,83 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+  watch(%r{^lib/aqui/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 hank
+
+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,53 @@
+# Aqui
+
+[![Build Status](https://travis-ci.org/hstove/aqui.svg?branch=master)](https://travis-ci.org/hstove/aqui)
+[![Code Climate](https://codeclimate.com/github/hstove/aqui.png)](https://codeclimate.com/github/hstove/aqui)
+[![Coverage Status](https://coveralls.io/repos/hstove/aqui/badge.svg)](https://coveralls.io/r/hstove/aqui)
+
+A gem for making sure some code is running.
+
+Sometimes when coding, you run into a situation where you want to make sure
+a bit of code is being executed by your application. You might end up
+typing something like:
+
+~~~ruby
+try_this
+puts 'this is running'
+try_another
+puts 'blasfdd'
+~~~
+
+This way, you can run your code and check your logs to see if the `put`
+methods were called. If this short and simple effective method works for you,
+then give `aqui` a shot next time. It looks like this:
+
+~~~ruby
+try_this
+aqui
+try_another
+aqui
+~~~
+
+This time, the output is colorized and contains information about where the code is running:
+
+![screenshot](http://i.imgur.com/2AdA8YB.png)
+
+## Installation
+
+```ruby
+gem 'aqui'
+```
+
+## Usage
+
+```ruby
+aqui
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/aqui/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,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+end
+
+task default: :spec

data/aqui.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aqui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aqui"
+  spec.version       = Aqui::VERSION
+  spec.authors       = ["hank"]
+  spec.email         = ["hstove@gmail.com"]
+  spec.summary       = "Log \"I'm Here!\" in your code"
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'colorize'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/aqui/colorizer.rb

@@ -0,0 +1,39 @@
+module Aqui
+  # A class for providing the message of `aqui`
+  class Colorizer
+    def initialize(message, object)
+      @parser = Aqui::Parser.new(message)
+      @object = object
+    end
+
+    def file
+      @parser.file.colorize(:light_yellow)
+    end
+
+    def line_break
+      ':'.colorize(:light_green)
+    end
+
+    def line_number
+      @parser.line_number.colorize(:light_cyan)
+    end
+
+    def spacer
+      ' - '.colorize(:light_green)
+    end
+
+    def object_class
+      @object.class.to_s.colorize(:light_white)
+    end
+
+    def message
+      [
+        file,
+        line_break,
+        line_number,
+        spacer,
+        object_class
+      ].join('')
+    end
+  end
+end

data/lib/aqui/ext.rb

@@ -0,0 +1,8 @@
+# Extend the top-level `Object` class to provide the `aqui` method
+class Object
+  def aqui
+    colorizer = Aqui::Colorizer.new(caller[0], self)
+    print colorizer.message
+    print "\n"
+  end
+end

data/lib/aqui/parser.rb

@@ -0,0 +1,21 @@
+module Aqui
+  # A parser to get the useful parts of `caller`
+  class Parser
+    attr_accessor :caller_message
+    def initialize(caller_message)
+      @caller_message = caller_message
+    end
+
+    def parts
+      @parts ||= @caller_message[0..@caller_message.index(':in `')].split(':')
+    end
+
+    def file
+      parts[0].gsub(Dir.pwd + '/', '')
+    end
+
+    def line_number
+      parts[1]
+    end
+  end
+end

data/lib/aqui/version.rb

@@ -0,0 +1,4 @@
+# Version File
+module Aqui
+  VERSION = "0.0.1"
+end

data/lib/aqui.rb

@@ -0,0 +1,5 @@
+require 'aqui/version'
+require 'aqui/parser'
+require 'aqui/colorizer'
+require 'aqui/ext'
+require 'colorize'

data/script/console.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require "irb/completion"
+require "bundler/setup"
+Bundler.require
+
+IRB.start

data/script/demo.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+Bundler.require
+
+class ClassName
+  def go
+    1 + 2
+    aqui
+    3 + 4
+    aqui
+  end
+end
+
+Model.new.go

data/spec/ext_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Aqui do
+  describe Object do
+    it { expect { aqui }.to output(/#{self.class}/).to_stdout }
+    it { expect { aqui }.to output(/spec\/ext_spec.rb/).to_stdout }
+
+    # useful for debugging
+    # it { aqui }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+require 'simplecov'
+SimpleCov.start
+require 'coveralls'
+# require 'codeclimate-test-reporter'
+require 'bundler'
+Bundler.require(:default, :development)
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter,
+  # CodeClimate::TestReporter::Formatter
+]
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: aqui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hank
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- hstove@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aqui.gemspec
+- lib/aqui.rb
+- lib/aqui/colorizer.rb
+- lib/aqui/ext.rb
+- lib/aqui/parser.rb
+- lib/aqui/version.rb
+- script/console.rb
+- script/demo.rb
+- spec/ext_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Log "I'm Here!" in your code
+test_files:
+- spec/ext_spec.rb
+- spec/spec_helper.rb