logion 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be8e6f2bd8f3e0b454a4d84146da86c40603c4bf
+  data.tar.gz: 1eda10f8e112c492920fc8536b8061af7a616033
+SHA512:
+  metadata.gz: 6875a5407fe0b56b8efb0381b70308de61f9186c57c18c4377c112d65ed29054149161ac8f0516de9cd89cbd0ef83884a8f7b3885f0b12ae57941f2dd67bdaf8
+  data.tar.gz: 8ee522fb25fdf7d100c1f3e78d7a7168af87df3fb29e0ae40d2bdeb4d1312502cb54ae34b2e43c06dad3f2432289b1c9d2ad097b573c275721071ad21637ff59

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Logion
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Logion'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/config/initializers/logion.rb

@@ -0,0 +1 @@
+Logion::Logion.new

data/lib/logion/engine.rb

@@ -0,0 +1,15 @@
+module Logion
+  super_class = if Object.const_defined?('Rails')
+    ::Rails::Engine
+  else
+    Object
+  end
+
+  class Engine < super_class
+    require 'colorize'
+    require 'rspec'
+    require 'rspec/core/formatters/base_formatter'
+    require 'logion/formatter'
+    require 'logion/logger_patcher'
+  end
+end

data/lib/logion/formatter.rb

@@ -0,0 +1,36 @@
+module Logion
+  class Formatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self, :example_failed, :dump_failures
+
+    def initialize(output)
+      @output = output
+    end
+
+    def example_failed(notification)
+      show_failure_debug_info(notification.example)
+    end
+
+    def dump_failures(notification)
+      return if notification.failure_notifications.empty?
+      notification.examples.each do |example|
+        next unless example.exception
+        show_failure_debug_info(example)
+      end
+    end
+
+    private
+
+    def show_failure_debug_info(example)
+      @output.puts(::Logion::Logion.colorize('----------------------------', color: :yellow))
+      @output.puts(::Logion::Logion.colorize(example.rerun_argument, color: :yellow, background: :blue))
+      @output.puts(::Logion::Logion.colorize(example.metadata[:log_location].to_s, color: :white, background: :blue))
+      if example.metadata[:screenshot].is_a?(Hash)
+        example.metadata[:screenshot].each do |type, path|
+          colorful_type = ::Logion::Logion.colorize(type.to_s, color: :black, background: :white)
+          colorful_path = ::Logion::Logion.colorize(path.to_s, color: :black, background: :light_blue)
+          @output.puts("#{ colorful_type } #{ colorful_path }")
+        end
+      end
+    end
+  end
+end

data/lib/logion/logger_patcher.rb

@@ -0,0 +1,58 @@
+module Logion
+  class LoggerPatcher
+    attr_accessor :logger, :logion_instance
+
+    def initialize(logion_instance)
+      self.logion_instance = logion_instance
+      self.logger          = logion_instance.logger
+
+      additional_logging =  proc do |*args, &block|
+        log_to_separate_file *args, &block
+      end
+
+      logger.instance_variable_set '@additional_logging', additional_logging
+
+      # we don't want to ruin your pretty logger, so lets extend it
+      def logger.add(*args, &block)
+        @additional_logging.call(*args, &block)
+        super
+      end
+    end
+
+    def severity_colors(severity_name)
+      {
+          WARN:    [:black, :yellow],
+          DEBUG:   [:white, :blue],
+          INFO:    [:black, :green],
+          FATAL:   [:white, :red],
+          ERROR:   [:black, :light_red],
+          UNKNOWN: [:white, :black]
+      }[severity_name]
+    end
+
+    def format_log_entry(severity, message = nil, progname = nil, *_rest)
+      message ||= progname
+
+      severity_name = Logger::Severity.constants.find do |name|
+        Logger::Severity.const_get(name) == severity
+      end
+
+      color, background = severity_colors(severity_name)
+
+      prefix = "#{ Process.pid } #{ '%10s' % "(#{ severity_name })" }:"
+      prefix = ::Logion::Logion.colorize(prefix, color: color, background: background)
+
+      "#{ prefix } #{ message }"
+    end
+
+    def log_to_separate_file(*args, &block)
+      info_file = logion_instance.log_path_holder
+
+      if File.exists?(info_file)
+        separate_log    = File.read(info_file)
+        formatted_entry = format_log_entry(*args, &block)
+        open(separate_log, 'a') { |f| f.puts formatted_entry }
+      end
+    end
+  end
+end

data/lib/logion/version.rb

@@ -0,0 +1,3 @@
+module Logion
+  VERSION = "0.0.2"
+end

data/lib/logion.rb

@@ -0,0 +1,119 @@
+require "logion/engine"
+
+module Logion
+  class Logion
+    attr_accessor :options
+
+    def self.colorize(string, *args, &block)
+      return string if Object.const_defined?(:Colored)
+      string.colorize(*args, &block)
+    end
+
+    DEFAULT_CONFIG = {
+      split_per_occurance: true,
+      log_path_holder:     -> { Pathname.new('tmp').join ".current_spec_log_path#{ ENV['TEST_ENV_NUMBER'] }" },
+      log_base:            -> { Pathname.new('tmp').join 'log', "tests#{ ENV['TEST_ENV_NUMBER'] }" },
+      add_hooks:           ->(logion) { fail "Rspec not present!" },
+      logger:              -> { fail 'No logger provided' },
+      separator:           lambda do |logion, example, action|
+        logion.logger.debug colorize("#{ example.rerun_argument } #{ action }:", color: :white, background: :red)
+      end,
+      patcher_class:       ::Logion::LoggerPatcher
+    }
+
+    RAILS_DEFAULTS = {
+      log_path_holder:     -> { Rails.root.join 'tmp', ".current_spec_log_path#{ ENV['TEST_ENV_NUMBER'] }" },
+      log_base:            -> { Rails.root.join 'tmp', 'log', "tests#{ ENV['TEST_ENV_NUMBER'] }" },
+      logger:              -> { Rails.logger }
+    }
+
+    RSPEC_DEFAULTS = {
+      add_hooks:           ->(logion) { logion.configure_rspec },
+    }
+
+    [DEFAULT_CONFIG, RAILS_DEFAULTS, RSPEC_DEFAULTS].flat_map(&:keys).each do |param|
+      define_method param do |*args|
+        if self.options[param].is_a?(Proc)
+          proc = self.options[param]
+          proc.(*[self, *args].first(proc.arity))
+        else
+          self.options[param]
+        end
+      end
+    end
+
+    def initialize(init_options = {})
+      defaults = DEFAULT_CONFIG
+
+      if Object.const_defined?('Rails')
+        defaults.merge! RAILS_DEFAULTS
+      end
+
+      if Object.const_defined?('RSpec')
+        defaults.merge! RSPEC_DEFAULTS
+      end
+
+      self.options = defaults.merge init_options
+      add_hooks
+    end
+
+    def configure_rspec
+      me = self
+      formatter_klass = ::Logion::Formatter
+
+      RSpec.configure do |config|
+        config.add_formatter(formatter_klass)
+
+        config.before(:suite) do
+          me.init
+        end
+
+        config.before(:each) do |example|
+          me.before(example)
+        end
+
+        config.after(:each) do |example|
+          me.after(example)
+        end
+      end
+    end
+
+    def init
+      FileUtils.rm_f log_path_holder
+      FileUtils.remove_dir log_base, force: true
+      @log_patcher = patcher_class.new self
+    end
+
+    def before(example)
+      relative_path = example.rerun_argument.sub(/:(\d+)$/, '/\1.log')
+      location      = log_base.join(relative_path)
+      location      = safe_location(location, relative_path)
+
+      location.dirname.mkpath
+      example.metadata[:log_location] = location
+      File.write(log_path_holder, location.to_s)
+      separator example, :start
+    end
+
+    def after(example)
+      separator example, :end
+      FileUtils.rm log_path_holder
+    end
+
+    private
+
+    def safe_location(location, relative_path)
+      uniq_location = location
+      if split_per_occurance
+        suffix        = 0
+
+        while File.exists? uniq_location
+          suffix += 1
+          safe_relative_path = relative_path.sub(/\.log$/, ".#{ suffix }.log")
+          uniq_location      = log_base.join safe_relative_path
+        end
+      end
+      uniq_location
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: logion
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Valery Guskov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: colorize
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  prerelease: false
+  type: :runtime
+description: A hacky gem to output per-example logs
+email:
+- valerijs.gusjkovs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- config/initializers/logion.rb
+- lib/logion.rb
+- lib/logion/engine.rb
+- lib/logion/formatter.rb
+- lib/logion/logger_patcher.rb
+- lib/logion/version.rb
+homepage:
+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.4.6
+signing_key:
+specification_version: 4
+summary: Output logs per example
+test_files: []