auto_logger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 501704c30b5cbb6ee8a98ea0b049111576c57086
+  data.tar.gz: 713275f9fa9e5d0fd02fee45ab331cab887ac7a7
+SHA512:
+  metadata.gz: 0a6691516eef1e4a1cdca45ce1319be3a75e5b79c230824df256e40bf7f8caab46a5eac9b078aa6eebf42c9b1e4e06658fb42f6c0da928b1db342ec531ab206a
+  data.tar.gz: 70cafd1d6dfbd2a067eb9ae577d6bfdc6b38a98f94e59b543228faf0cac5ea8aaf8a8b8f98626537660173774778e238506377a5f263f3f2ffd55dfad6b941df

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danil@brandymint.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 auto_logger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    auto_logger (0.1.0)
+      activesupport
+      beautiful-log
+      logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.8.0)
+    beautiful-log (0.2.2)
+      awesome_print (~> 1.8.0)
+      colorize (~> 0.8.1)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    logger (1.2.8)
+    minitest (5.11.3)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  auto_logger!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Danil Pismenny
+
+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,65 @@
+# AutoLogger
+[![Build
+Status](https://travis-ci.org/BrandyMint/auto_logger.svg)](https://travis-ci.org/BrandyMint/auto_logger)
+
+Упрощяет подключение уникальных логгеров для модулей и классов. После
+подключения в модуль или класс через `include AutoLogger` добавляет метод
+`logger` который пишет логи в файл автоматически сформированные из измени
+модуля/класса в каталог `./log`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auto_logger
+
+## Usage
+
+```
+module SomeService
+  include AutoLogger
+
+  def perform
+    logger.info 'some' # writes info into ./logs/some_service.log
+  end
+end
+```
+
+Иногда необходимо насильно указать имя файла для лога. Например при подключении
+в модули/класс без имени, в частности в grape-контролерах:
+
+```
+class PublicAPI::OrdersAPI < Grape::API
+  helpers do
+    include AutoLogger::Named.new(name: :orders_api)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/dapi/auto_logger. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AutoLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dapi/auto_logger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/auto_logger.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "auto_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_logger"
+  spec.version       = AutoLogger::VERSION
+  spec.authors       = ["Danil Pismenny"]
+  spec.email         = ["danil@brandymint.ru"]
+
+  spec.summary       = %q{'logger' method configured with class/module name}
+  spec.description   = %q{Mixin that adds `logger` method authomatically configured to use log name from module/class}
+  spec.homepage      = "https://github.com/BrandyMint/auto_logger"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+    #raise "RubyGems 2.0 or newer is required to protect against " \
+      #"public gem pushes."
+  #end
+
+  # 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_runtime_dependency 'beautiful-log'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'logger'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

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

@@ -0,0 +1,28 @@
+# Source: https://blog.bigbinary.com/2014/03/03/logger-formatting-in-rails.html
+module AutoLogger
+  class Formatter < Beautiful::Log::Formatter
+    BACKTRACE_SEVERITIES = %w(ERROR FATAL DEBUG)
+
+    include ActiveSupport::TaggedLogging::Formatter
+
+    def message_header(timestamp, severity, backtrace)
+      header = ["[#{timestamp.strftime(datetime_format)}]"]
+
+      if Rails.env.production?
+        header << "(pida=#{$PROCESS_ID})"
+        header << Thread.current[:request_id] if Thread.current[:request_id]
+        header << "#{file_line(backtrace,severity)}"
+      end
+      #header << format('%5s', severity)
+      header << severity.first
+
+      header.join(' ')
+    end
+
+    private
+
+    def file_line(backtrace_lines, severity)
+      super backtrace_lines if BACKTRACE_SEVERITIES.include? severity
+    end
+  end
+end

data/lib/auto_logger/named.rb

@@ -0,0 +1,10 @@
+module AutoLogger
+  class Named < Module
+    def self.new(name: nil)
+      Module.new do
+        include AutoLogger
+        define_method(:_auto_logger_file_name) { name }
+      end
+    end
+  end
+end

data/lib/auto_logger/version.rb

@@ -0,0 +1,3 @@
+module AutoLogger
+  VERSION = "0.1.1"
+end

data/lib/auto_logger.rb

@@ -0,0 +1,74 @@
+require 'logger'
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+require 'beautiful/log'
+
+require "auto_logger/version"
+require "auto_logger/formatter"
+require "auto_logger/named"
+
+# Миксин добавляет в класс метод `logger` который пишет лог
+# в файл с названием класса
+#
+#
+# Использование:
+#
+# class CurrencyRatesWorker
+#  include AutoLogger
+#
+#  def perform
+#   logger.info 'start'
+
+# Чтобы указать имя лог файла используйте AutoLogger::Named:
+#
+# class CurrencyRatesWorker
+# include AutoLogger::Named.new(name: 'filename')
+
+
+module AutoLogger
+  DEFAULT_LOG_DIR = './log'
+
+  mattr_accessor :log_dir
+
+  private
+
+  def logger
+    @logger ||= _build_auto_logger
+  end
+
+  # Логируем вместе с временем выполнения
+  #
+  def bm_log(message)
+    res = nil
+    bm = Benchmark.measure { res = yield }
+    logger.info "#{message}: #{bm}"
+    res
+  end
+
+  def _auto_logger_file_name
+    self.class.to_s.underscore.gsub('/','_')
+  end
+
+  def _auto_logger_file
+    file = "#{_auto_logger_file_name}.log"
+
+    if log_dir.present?
+      File.join(log_dir, file)
+
+    elsif defined? Rails
+      Rails.root.join filename
+
+    else
+      File.join(DEFAULT_LOG_DIR, file)
+    end
+  end
+
+  def _log_formatter
+    !defined?(Rails) || Rails.env.test? ? Logger::Formatter.new : Formatter.new
+  end
+
+  def _build_auto_logger
+    ActiveSupport::Logger.new(_auto_logger_file).
+      tap { |logger| logger.formatter = _log_formatter }
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: auto_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Danil Pismenny
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: beautiful-log
+  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: activesupport
+  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: logger
+  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.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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Mixin that adds `logger` method authomatically configured to use log
+  name from module/class
+email:
+- danil@brandymint.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_logger.gemspec
+- bin/console
+- bin/setup
+- lib/auto_logger.rb
+- lib/auto_logger/formatter.rb
+- lib/auto_logger/named.rb
+- lib/auto_logger/version.rb
+- log/.gitkeep
+homepage: https://github.com/BrandyMint/auto_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.14.1
+signing_key: 
+specification_version: 4
+summary: "'logger' method configured with class/module name"
+test_files: []