lograge_activejob 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e882dd826cb3f77ced0cfc6420d28f22afc479b
+  data.tar.gz: f0c1e07395a0fff6e92ef1066b8f9cf096e795a9
+SHA512:
+  metadata.gz: c1dd557c8c493faa2f11704a64b882b7e164fc7fdbb01a14d8596eb1a1759bc52aefb766f52eb3a273b4c3fe13cddea2e4f786e4e62a5cd97637389cef3c02cf
+  data.tar.gz: e74475e6e25d6daf59b916fc111b4d28e06fe337eb907133a0dac9141a8d90148ed73cf65481f82d32b67a63c61b69c002ce6926a8079b5ed85f8941b982ae75

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.3.3
+before_install: gem install bundler -v 1.16.1

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 m.ooba@ashita-team.com. 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,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lograge_activejob.gemspec
+gemspec
+
+group :test do
+  gem 'pry'
+  gem 'activejob', '~> 5'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 MasaruTech
+
+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,52 @@
+# LogrageActivejob
+
+Add ActiveJobs log for Lograge
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lograge'
+gem 'lograge_activejob'
+```
+
+Please remember about [Lograge configuration](https://github.com/roidrage/lograge#installation).
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lograge_activejob
+
+# Custom setup
+
+You can configure additional fields, which will be logged for every exception.
+
+```ruby
+# config/initializers/lograge_activejob.rb
+Rails.application.configure do
+  config.lograge_activejob.custom_options = lambda do |event|
+    {
+      event_time: event.time.iso8601,
+      status: event.payload[:exception_object].blank? ? 200 : 500
+    }
+  end
+end
+```
+
+## 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/masaru-tech/lograge_activejob. 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).

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 "lograge_activejob"
+
+# 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/lograge_activejob/log_subscriber.rb

@@ -0,0 +1,43 @@
+require 'active_support/log_subscriber'
+
+module LogrageActivejob
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def perform(event)
+      data = initial_data(event)
+      data.merge!(custom_options(event))
+      formatted_message = Lograge.formatter.call(data)
+      logger.send(Lograge.log_level, formatted_message)
+    end
+
+    private
+      def logger
+        Lograge.logger.presence || super
+      end
+
+      def initial_data(event)
+        payload = event.payload
+        job = payload[:job]
+        ex = payload[:exception_object]
+
+        {
+          event_name: event.name,
+          job_class: job.class.name,
+          job_id: job.job_id,
+          adapter_class: event.payload[:adapter].class.name.demodulize,
+          queue_name: job.queue_name,
+          args: job.arguments,
+          duration: event.duration.round(2), # ms
+          message: ex&.message,
+          backtrace: ex&.backtrace,
+        }.compact
+      end
+
+      def custom_options(event)
+        LogrageActivejob.custom_options(event) || {}
+      end
+
+      def scheduled_at(job)
+        Time.at(job.scheduled_at).utc if job.scheduled_at
+      end
+  end
+end

data/lib/lograge_activejob/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module LogrageActivejob
+  Config = Struct.new(:custom_options)
+
+  class Railtie < Rails::Railtie
+    config.lograge_activejob = Config.new
+
+    config.after_initialize do |app|
+      LogrageActivejob.setup(app) if app.config.lograge.enabled
+    end
+  end
+end

data/lib/lograge_activejob/version.rb

@@ -0,0 +1,3 @@
+module LogrageActivejob
+  VERSION = '0.1.0'
+end

data/lib/lograge_activejob.rb

@@ -0,0 +1,24 @@
+require 'lograge_activejob/version'
+require 'lograge_activejob/log_subscriber'
+
+module LogrageActivejob
+  module_function
+
+  mattr_writer :custom_options
+  self.custom_options = nil
+
+  def custom_options(event)
+    if @@custom_options.respond_to?(:call)
+      @@custom_options.call(event)
+    else
+      @@custom_options
+    end
+  end
+
+  def setup(app)
+    LogrageActivejob.custom_options = app.config.lograge_activejob.custom_options
+    LogrageActivejob::LogSubscriber.attach_to :active_job
+  end
+end
+
+require 'lograge_activejob/railtie' if defined?(Rails)

data/lograge_activejob.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lograge_activejob/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lograge_activejob'
+  spec.version       = LogrageActivejob::VERSION
+  spec.authors       = ['MasaruTech']
+  spec.email         = ['masaru.tech@gmail.com']
+
+  spec.summary       = 'Lograge for ActiveJobs.'
+  spec.description   = 'Lograge for ActiveJobs.'
+  spec.homepage      = 'https://github.com/masaru-tech/lograge_activejob'
+  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_runtime_dependency 'activesupport', '>= 4', '< 5.3'
+  spec.add_runtime_dependency 'railties', '>= 4', '< 5.3'
+  spec.add_runtime_dependency 'lograge', '< 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: lograge_activejob
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MasaruTech
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.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: 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: Lograge for ActiveJobs.
+email:
+- masaru.tech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lograge_activejob.rb
+- lib/lograge_activejob/log_subscriber.rb
+- lib/lograge_activejob/railtie.rb
+- lib/lograge_activejob/version.rb
+- lograge_activejob.gemspec
+homepage: https://github.com/masaru-tech/lograge_activejob
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Lograge for ActiveJobs.
+test_files: []