method_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 417132135fa7ef54658e9ceb061a153536066b88
+  data.tar.gz: f0443d2e3e5628d1a8365990a05db8f93ae4e632
+SHA512:
+  metadata.gz: c945be4ad3f79749058bd6a25579a5efea31875c2cdaad91b05fc655b847304623df7e0cad57c7df503e10f73e472b9b6e56e3d0c1d2cf2c772c9e98161c1ddc
+  data.tar.gz: a33500daef6251f4d910a1c431e05c4a219b180819320e2add72f61a87652084b4236180761f0f617e78f4a8e82f6398748556761c2d77d49cbc090243aeb4f9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bartosz Bonisławski
+
+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,45 @@
+# MethodLogger
+
+Ultra simple gem that contains module that you can include to any class to log all method calls to standard output or/and
+file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'method_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_logger
+
+## Usage
+
+Include mixin in your class like this:
+```ruby
+include MethodLogger::mixin({})
+```
+
+You can customize it by passing options to mixin in hash. Default options are:
+
+ignored_methods: [] # [Array of symbols] used to ignore methods that we don't need to see
+logger: Logger.new(File.open(options[:filename], 'a+')) # if you don't like basic ruby logger, you can pass your own. It
+must respond to #info
+formatter: DefaultFormatter.new # this is used for formatting. You can pass any object that responds to #call method
+filename: 'method_logger_log.txt' # filename to put logs in default logger
+log_to_file: false # determines if it should log to file
+log_to_stdout: true # determines if it should log to standard output
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/method_logger.
+
+## 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 "method_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/lib/method_logger.rb

@@ -0,0 +1,64 @@
+require 'logger'
+require "method_logger/version"
+
+module MethodLogger
+  class Mixin < Module
+    def initialize(options = {})
+      @_options = default_options.merge(options)
+      @_methods = options[:methods]
+    end
+
+    def included(base_class)
+      options = @_options
+      methods = @_methods || base_class.instance_methods(false) + base_class.private_instance_methods(false)
+      methods -= options[:ignored_methods]
+      formatter = options.delete(:formatter) || default_formatter
+      logger = options[:logger] || default_logger(options)
+
+      base_class.class_eval do
+        methods.each do |method_name|
+          method = instance_method(method_name)
+
+          define_method(method_name) do |*args, &block|
+            return_value = method.bind(self).call(*args, &block)
+            text = formatter.call(base_class, method_name, args.inspect, return_value.inspect)
+            puts(text) if options[:log_to_stdout]
+            logger.info(text) if options[:log_to_file]
+            return_value
+          end
+        end
+      end
+    end
+
+    private
+
+    def default_options
+      {
+        ignored_methods: [],
+        logger: nil,
+        formatter: DefaultFormatter.new,
+        filename: 'method_logger_log.txt',
+        log_to_file: false,
+        log_to_stdout: true
+      }
+    end
+
+    def default_logger(options)
+      Logger.new(File.open(options[:filename], 'a+'))
+    end
+
+    def default_formatter
+      DefaultFormatter.new
+    end
+  end
+
+  def self.mixin(options = {})
+    Mixin.new(options)
+  end
+
+  class DefaultFormatter
+    def call(base_class, method_name, args, return_value)
+      "#{base_class}##{method_name}(#{args}) was called and returned #{return_value}"
+    end
+  end
+end

data/lib/method_logger/version.rb

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

data/method_logger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "method_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "method_logger"
+  spec.version       = MethodLogger::VERSION
+  spec.authors       = ["Bartosz Bonisławski"]
+  spec.email         = ["b.bonislawski@hotmail.com"]
+
+  spec.summary       = %q{Gem that logs all method calls in your class}
+  spec.homepage      = "https://github.com/bbonislawski/method_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: method_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bartosz Bonisławski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 
+email:
+- b.bonislawski@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/method_logger.rb
+- lib/method_logger/version.rb
+- method_logger.gemspec
+homepage: https://github.com/bbonislawski/method_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.6.13
+signing_key: 
+specification_version: 4
+summary: Gem that logs all method calls in your class
+test_files: []