call_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 613db64e5b8ff52a92392341f19cc625aa28ced3f27c15a38da75096eadf5d48
+  data.tar.gz: f459c45b112209952385bf5b5a2b554cb36743d894b8af784a34c128dac501cf
+SHA512:
+  metadata.gz: 335789e5630e506a0b3619714b5b94dbb67d94b8239c3208804cc070d0b1a5caf08178f4085e351110d2c84429fc9534bd929754757b37cedeb1cd0d923afcea
+  data.tar.gz: f16262c8c53c6e572f7dcb2ca1db6d99a39ccaf781c77fb39d91abe3f66c0a9876376f862f3bebd5e6486b05109adc41aa7e3e187199d1c8be8a853169512634

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in call_logger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    call_logger (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-doc (0.13.5)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  call_logger!
+  pry
+  pry-doc
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Maciej Rzasa
+
+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,101 @@
+# CallLogger
+
+A debugging tool that let you log method usage.
+
+```
+class Calculator
+  include CallLogger
+
+  log def times(a, b)
+    a*b
+  end
+end
+
+Calculator.new.times(3,4)
+# times(2, 3)
+# times => 6
+# => 7
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'call_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install call_logger
+
+## Usage
+
+Include it to a class being debugged and the prepend a method definition with `log`:
+
+```
+class Calculator
+  include CallLogger
+
+  log def times(a, b)
+    a*b
+  end
+end
+```
+
+`.log` accepts method name, so you can pass it explicitly:
+
+```
+class Calculator
+  include CallLogger
+
+  def times(a, b)
+    a*b
+  end
+
+  log :times
+end
+```
+
+### Configuration
+
+There are two pluggable components: `Logger` and `Formatter`. `Formatter` preperes messages to be printed and `Logger` sents them to the
+output stream (whatever it is). This documentation uses default ones, but they can be easily configured:
+
+```
+::CallLogger.configure do |config|
+  config.logger = CustomLogger.new
+  config.formatter = CustomFormatter.new
+end
+```
+
+* `Logger` should provide a `#call` method accepting a single paramter.
+* `Formatter` should provide two methods:
+  * `#begin_message(method, args)` - accepting method name and it's arguments; called before method execution
+  * `#end_message(method, result)` - accepting method name and it's result; called after method execution
+
+## TODO
+
+* [] class methods
+* [] multiple method names
+* [] handle blocks
+* [] logging all methods defined in the class
+* [] doc: Rails integration
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/call_logger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "call_logger"
+
+# 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(__FILE__)

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/call_logger.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "call_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "call_logger"
+  spec.version       = CallLogger::VERSION
+  spec.authors       = ["Maciej Rzasa"]
+  spec.email         = ["maciejrzasa@gmail.com"]
+
+  spec.summary       = %q{Debugging tool that logs parameters and results of calling bloks and methods.}
+  spec.description   = %q{Decorate a method or wrap a code block to see in logs when they're called.}
+  spec.homepage      = "https://github.com/mrzasa/call_logger"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+end

data/lib/call_logger/call_logger.rb

@@ -0,0 +1,17 @@
+module CallLogger
+  class CallLogger
+    attr_reader :formatter, :logger
+
+    def initialize(formatter:, logger: )
+      @formatter = formatter
+      @logger = logger
+    end
+
+    def log(method, args)
+      logger.call(formatter.begin_message(method, args))
+      result = yield
+      logger.call(formatter.end_message(method, result))
+      result
+    end
+  end
+end

data/lib/call_logger/configuration.rb

@@ -0,0 +1,13 @@
+module CallLogger
+  class Configuration
+    attr_accessor :logger, :formatter
+
+    def logger
+      @logger || ::CallLogger::Logger.new
+    end
+
+    def formatter
+      @formatter || ::CallLogger::Formatter.new
+    end
+  end
+end

data/lib/call_logger/formatter.rb

@@ -0,0 +1,12 @@
+module CallLogger
+  class Formatter
+    def begin_message(method, args)
+      "#{method}(#{args.join(', ')})"
+    end
+
+    # args?
+    def end_message(method, result)
+      "#{method} => #{result}"
+    end
+  end
+end

data/lib/call_logger/logger.rb

@@ -0,0 +1,8 @@
+module CallLogger
+  # Simple puts logger
+  class Logger
+    def call(message)
+      puts message
+    end
+  end
+end

data/lib/call_logger/version.rb

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

data/lib/call_logger.rb

@@ -0,0 +1,37 @@
+require "call_logger/version"
+
+require 'call_logger/formatter'
+require 'call_logger/logger'
+require 'call_logger/configuration'
+require 'call_logger/call_logger'
+
+module CallLogger
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def log(method, args, &block)
+    call_logger = ::CallLogger::CallLogger.new(logger: ::CallLogger.configuration.logger, formatter: ::CallLogger.configuration.formatter)
+    call_logger.log(method, args, &block)
+  end
+
+  module ClassMethods
+    def log(method)
+      alias_method "#{method}_without_log", method
+      define_method method do |*args|
+        log(method, args) do
+          send("#{method}_without_log", *args)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: call_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maciej Rzasa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-doc
+  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: Decorate a method or wrap a code block to see in logs when they're called.
+email:
+- maciejrzasa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- call_logger.gemspec
+- lib/call_logger.rb
+- lib/call_logger/call_logger.rb
+- lib/call_logger/configuration.rb
+- lib/call_logger/formatter.rb
+- lib/call_logger/logger.rb
+- lib/call_logger/version.rb
+homepage: https://github.com/mrzasa/call_logger
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Debugging tool that logs parameters and results of calling bloks and methods.
+test_files: []