putter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f928a1b2e12bba00884974d440d4fec3b6bca2ea
+  data.tar.gz: c66cd8bf87b7e5366a7fdfc53707c8cb2c330ab8
+SHA512:
+  metadata.gz: acf21e52a6333edb6e04d165c05fc5da9576666a03b987d77fa0d5cb23496cdf4fc0447ad1b56cbd50805f94ff89ba4207554756ce737b0a90905cebc6598a53
+  data.tar.gz: f09d6ef04b68101be677cb7e978ea9c2deeb1ae76a86e763f7c4b12416dc4576e48ed6a62843cb4b0645cd50c221d364041fc30325118e046ac2b6b60e66ec52

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+putter-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--require "spec_helper"
+--order rand
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+putter

data/.ruby-version

@@ -0,0 +1 @@
+2.1.8

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at john.dewyze@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    putter (0.0.1)
+      colorize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    colorize (0.7.7)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  pry (~> 0.10.3)
+  putter!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John DeWyze
+
+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,103 @@
+# Putter
+
+It rhymes with gooder, not gutter.
+
+Putter is a tool for more easily implementing puts debugging. Instead of littering files with various puts statements, you can wrap an object with a follower and print out anytime a method is called on that object. This will follow the object throughout its path in the stack.
+
+For now Putter can only follow a specific the speficic object that it wraps. It currently does not watch a class to see what objects were passed to it unless that specific instance of the class is passed through the stack.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'putter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install putter
+
+## Usage
+
+### Putter.follow
+
+Currently there is only one use for Putter, the `follow` method.
+
+```ruby
+class MyObject
+  def hello(arg, punc)
+    "Hello #{arg.to_s}#{punc}"
+  end
+end
+
+module Service
+  def self.do_stuff(obj)
+    obj.hello(:world, "!")
+  end
+end
+
+object = Putter.follow(MyObject.new)
+Service.do_stuff(object)
+```
+
+Will output:
+
+```bash
+Putter Debugging:  Object instance
+-----------------
+          Method:  :value
+            Args:  [:world, "!"]
+          Result:  "Hello world!"
+```
+
+#### `Putter.follow` Options
+
+```ruby
+Putter.follow(
+  object_to_follow,
+  label: "My object"  # Label to use after "Putter Debugging:  My object". Will be "ClassName" for classes or "ClassName instance" for instances,
+  methods: ["value"]  # If the value is nil, then all methods will be watched. Otherwise, this is an array of methods to print debugging input for
+)
+```
+
+## Configuration
+
+Putter currently has 3 configuration options:
+
+```ruby
+Putter.configure do |config|
+  # 'method_strategy' takes a block that receives three arguments with the label, method, and args array, respectively. This block will be used after each method is called, "puts" statements can be used, or any other method callbacks that are helpful.
+  # Defaults to Putter::PrintStrategy::MethodStrategy
+  config.method_strategy = Proc.new {|label, method, args| puts "Label: #{label}, Method: #{method}, Args: #{args}" }
+
+  # 'result_strategy' takes a block that receives a single argument outputs the results of the method call
+  # Defaults to Putter::PrintStrategy::ResultStrategy
+  config.result_strategy = Proc.new {|result| puts "The result was #{result}" }
+
+  # 'print_results' determines whether or not to print the results block at all.
+  # Defaults to true.
+  config.print_results = false
+end
+```
+
+## Planned Features
+Feel free to open a PR to implement any of these if they are not yet added:
+
+- Ability to watch any instance of a class calling a method
+- Active Record specific printing
+- Errors for when attempting to follow a `BasicObject`
+- Protected methods (so things like `inspect` don't cause stack level too deep errors
+- Checking Rails.env to double check that putter is not called in production
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/putter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/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/lib/putter/configuration.rb

@@ -0,0 +1,11 @@
+module Putter
+  class Configuration
+    attr_accessor :method_strategy, :print_results, :result_strategy
+
+    def initialize
+      @method_strategy = PrintStrategy::MethodStrategy
+      @result_strategy = PrintStrategy::ResultStrategy
+      @print_results = true
+    end
+  end
+end

data/lib/putter/follower.rb

@@ -0,0 +1,68 @@
+module Putter
+  class Follower < BasicObject
+    attr_reader :object, :proxied_methods, :proxy
+
+    def initialize(obj, options={})
+      @object = obj
+      @proxy = MethodProxy.new
+      @object.singleton_class.send(:prepend, proxy)
+      _set_options(options)
+    end
+
+    def method_missing(method, *args, &blk)
+      if _add_method?(method)
+        add_method(method)
+      end
+
+      if blk
+        @object.send(method, *args, &blk)
+      else
+        @object.send(method, *args)
+      end
+    end
+
+    def add_method(method)
+      @proxy.instance_exec(@label, _print_results?) do |label, print_results|
+        define_method(method) do |*proxy_args, &blk|
+          ::Putter.configuration.method_strategy.call label, method, proxy_args
+          result = super *proxy_args, &blk
+          ::Putter.configuration.result_strategy.call result if print_results
+          result
+        end
+      end
+    end
+
+    def _add_method?(method)
+      return (@proxy_all_methods || proxied_methods.include?(method.to_s)) &&
+              !@proxy.instance_methods.include?(method)
+    end
+
+    def _set_label(label)
+      if !label.nil?
+        @label = label
+      elsif @object.class == ::Class
+        @label = @object.name
+      else
+        @label = @object.class.name + " instance"
+      end
+    end
+
+    def _print_results?
+      ::Putter.configuration.print_results
+    end
+
+    def _set_methods(methods)
+      if methods.nil?
+        @proxy_all_methods = true
+      else
+        @proxied_methods = methods.map(&:to_s)
+        @proxy_all_methods = false
+      end
+    end
+
+    def _set_options(options)
+      _set_label(options[:label])
+      _set_methods(options[:methods])
+    end
+  end
+end

data/lib/putter/method_proxy.rb

@@ -0,0 +1,4 @@
+module Putter
+  class MethodProxy < Module
+  end
+end

data/lib/putter/print_strategy.rb

@@ -0,0 +1,17 @@
+require "colorize"
+
+module Putter
+  module PrintStrategy
+    MethodStrategy = Proc.new do |label, method, args|
+      puts "\tPutter Debugging:  ".colorize(:cyan) + "#{label}".colorize(:green)
+      puts "\t-----------------".colorize(:cyan)
+      puts "\t\t  Method:  ".colorize(:cyan) + ":#{method}".colorize(:green)
+      puts "\t\t    Args:  ".colorize(:cyan) + "#{args}".colorize(:green)
+      puts
+    end
+
+    ResultStrategy = Proc.new do |result|
+      puts "\t\t  Result:  ".colorize(:cyan) + "#{result}".colorize(:green)
+    end
+  end
+end

data/lib/putter/version.rb

@@ -0,0 +1,3 @@
+module Putter
+  VERSION = "0.1.0"
+end

data/lib/putter.rb

@@ -0,0 +1,27 @@
+require "putter/configuration"
+require "putter/follower"
+require "putter/method_proxy"
+require "putter/print_strategy"
+require "putter/version"
+
+module Putter
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.follow(obj, options={})
+    Putter::Follower.new(obj, options)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+end

data/putter.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'putter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "putter"
+  spec.version       = Putter::VERSION
+  spec.authors       = ["John DeWyze"]
+  spec.email         = ["john.dewyze@gmail.com"]
+
+  spec.description   = "Putter provides a variety of methods to easily use puts debugging. It can reveal what methods are called, the arguments that were passed in, and what the result of the method call."
+  spec.summary       = "Putter makes puts debugging easy."
+  spec.homepage      = "https://github.com/dewyze/putter"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'colorize', '~> 0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: putter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John DeWyze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-29 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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Putter provides a variety of methods to easily use puts debugging. It
+  can reveal what methods are called, the arguments that were passed in, and what
+  the result of the method call.
+email:
+- john.dewyze@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/putter.rb
+- lib/putter/configuration.rb
+- lib/putter/follower.rb
+- lib/putter/method_proxy.rb
+- lib/putter/print_strategy.rb
+- lib/putter/version.rb
+- putter.gemspec
+homepage: https://github.com/dewyze/putter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Putter makes puts debugging easy.
+test_files: []