log_syringe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 778a39f06f29bd4e07ad07c7617bdd7de4c61a28
+  data.tar.gz: 18cc51c5db478d24981ff844d744a026bb2e9b0e
+SHA512:
+  metadata.gz: f164a1cd231ee857271969aff419d80f7addb10e91e886a695f883c8090f822cda1a8cd5e7519e5a3f6d39c6e1146127bc1b6a44421ac82a42c8047b28d81bbb
+  data.tar.gz: 1c04a6a12a1a6ee44b58fb3a97740dacd822a4b8348a505af783f1a1ef775bece94d6a75c1994cfcff12c3a32b52150cdae80465ee97eba61638794a6c835421

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/
+/log/

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.simplecov

@@ -0,0 +1,9 @@
+unless ARGV.any? { |e| e =~ /guard-rspec/ }
+  SimpleCov.start do
+    coverage_dir 'log/coverage'
+    formatter SimpleCov::Formatter::HTMLFormatter
+
+    command_name 'rspec'
+    maximum_coverage_drop 1
+  end
+end

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,5 @@
+--charset utf-8
+--markup markdown
+--list-undoc compact
+--output-dir doc/yardoc
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log_syringe.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # 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)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 MESO Digital Services GmbH
+
+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,73 @@
+# LogSyringe
+
+[![Build Status](https://travis-ci.org/meso-unimpressed/log_syringe.svg?branch=master)](https://travis-ci.org/meso-unimpressed/log_syringe)
+[![Code Climate](https://codeclimate.com/github/meso-unimpressed/log_syringe/badges/gpa.svg)](https://codeclimate.com/github/meso-unimpressed/log_syringe)
+[![Test Coverage](https://codeclimate.com/github/meso-unimpressed/log_syringe/badges/coverage.svg)](https://codeclimate.com/github/meso-unimpressed/log_syringe/coverage)
+
+Add logging to your application without cluttering your code with logger calls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log_syringe'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_syringe
+
+## Usage
+
+Write your code:
+
+``` ruby
+class MyClass
+  def some_method(an_argument)
+    do_something
+  end
+end
+```
+
+Set up a logger for LogSyringe:
+
+``` ruby
+LogSyringe.logger = Logger.new(STDOUT)
+```
+
+Inject logging with LogSyringe:
+
+``` ruby
+LogSyringe.define(MyClass) do
+  log_method(:some_method) do |logger, instance, stats|
+    logger.info(
+      "some_method was called in #{instance} with params #{stats[:params]}"
+    )
+  end
+end
+```
+
+For full documentation see http://www.rubydoc.info/github/meso-unimpressed/log_syringe/master
+
+## 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/meso-unimpressed/log_syringe.
+

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'log_syringe'
+
+# 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/log_syringe.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'log_syringe/version'
+require 'log_syringe/dsl'
+
+# Top level namespace
+module LogSyringe
+  class << self
+    # The logger to be passed to log_method blocks
+    attr_accessor :logger
+
+    # Define logging for a class/module
+    # @param klass [Module] The class or module to define logging for
+    # @example
+    #   LogSyringe.define(MyClass) do
+    #     log_method(:some_method) do |logger, instance, stats|
+    #       logger.info(
+    #         "some method called on #{instance} with #{stats[:args]}"
+    #       )
+    #     end
+    #   end
+    def define(klass, &block)
+      DSL.new(klass, &block)
+    end
+  end
+end

data/lib/log_syringe/dsl.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module LogSyringe
+  # DSL that is exposed for defining logging
+  class DSL
+    def initialize(klass, &block)
+      @klass = klass
+      @logging_layer = Module.new
+      instance_eval(&block)
+      klass.prepend(@logging_layer)
+    end
+
+    # Wrap a given method with logging
+    # @param name [Symbol] The method to wrap
+    # @yieldparam logger [Logger] The global logger instance
+    # @yieldparam instance The instance the method was called on
+    # @yieldparam stats [Hash] Information about the method call.
+    #   It contains the following information: +:args [Array]+ the arguments the
+    #   method was called with, +:error [Error]+ the error that was
+    #   raised (if any), +:result+ the return value of the method
+    #   (if no exception was raised), +:runtime+ the runtime for the method
+    #   (if no exception was raised).
+    # @example
+    #   log_method(:some_method) do |logger, instance, stats|
+    #     logger.info(
+    #       "some_method called on #{instance} with args #{stats[:args]}. " \
+    #       "runtime: #{stats[:runtime]}"
+    #     )
+    #   end
+    def log_method(name, &block)
+      check_method_exists!(name)
+      define_logging_method(
+        name, method(:measure_runtime), method(:logging), &block
+      )
+    end
+
+    private
+
+    def measure_runtime
+      started = Time.now
+      yield_result = yield
+      [yield_result, Time.now - started]
+    end
+
+    def logging(instance, args, error, result, runtime)
+      yield(
+        LogSyringe.logger, instance,
+        args: args,
+        error: error,
+        result: result,
+        runtime: runtime
+      )
+    end
+
+    def define_logging_method(name, measure_runtime, logging, &dsl_block)
+      @logging_layer.send(:define_method, name) do |*args, &block|
+        begin
+          result, runtime = measure_runtime.call { super(*args, &block) }
+          logging.call(self, args, nil, result, runtime, &dsl_block)
+          result
+        rescue StandardError => error
+          logging.call(self, args, error, nil, nil, &dsl_block)
+          raise error
+        end
+      end
+    end
+
+    def check_method_exists!(name)
+      return if @klass.instance_methods.include?(name)
+      raise ArgumentError, "#{@klass} does not define method #{name}"
+    end
+  end
+end

data/lib/log_syringe/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module LogSyringe
+  # Current version for this gem
+  VERSION = '0.1.0'
+end

data/log_syringe.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_syringe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'log_syringe'
+  spec.version       = LogSyringe::VERSION
+  spec.authors       = ['Joakim Reinert']
+  spec.email         = ['reinert@meso.net']
+
+  spec.summary       = 'Unintrusive logging for ruby applications'
+  spec.description   =
+    'Adds logging to your application without cluttering your code with ' \
+    'logger calls'
+  spec.homepage      = 'https://github.com/meso-unimpressed/log_syringe'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{spec/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.4'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.8'
+  spec.add_development_dependency 'guard', '~> 2.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'simplecov', '~> 0.1'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: log_syringe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joakim Reinert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Adds logging to your application without cluttering your code with logger
+  calls
+email:
+- reinert@meso.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log_syringe.rb
+- lib/log_syringe/dsl.rb
+- lib/log_syringe/version.rb
+- log_syringe.gemspec
+homepage: https://github.com/meso-unimpressed/log_syringe
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Unintrusive logging for ruby applications
+test_files: []