sapience 0.2.4 → 0.2.5

data/lib/sapience/logger.rb

@@ -7,31 +7,6 @@ module Sapience
   class Logger < Base # rubocop:disable ClassLength, ClassVars
     include Sapience::Concerns::Compatibility
 
-    # Returns a Logger instance
-    #
-    # Return the logger for a specific class, supports class specific log levels
-    #   logger = Sapience::Logger.new(self)
-    # OR
-    #   logger = Sapience::Logger.new('MyClass')
-    #
-    # Parameters:
-    #  application
-    #    A class, module or a string with the application/class name
-    #    to be used in the logger
-    #
-    #  level
-    #    The initial log level to start with for this logger instance
-    #    Default: Sapience.config.default_level
-    #
-    #  filter [Regexp|Proc]
-    #    RegExp: Only include log messages where the class name matches the supplied
-    #    regular expression. All other messages will be ignored
-    #    Proc: Only include log messages where the supplied Proc returns true
-    #          The Proc must return true or false
-    def initialize(klass, level = nil, filter = nil)
-      super
-    end
-
     # Flush all queued log entries disk, database, etc.
     #  All queued log messages are written and then each appender is flushed in turn
     def self.flush # rubocop:disable AbcSize
@@ -73,51 +48,6 @@ module Sapience
       Sapience.remove_appender(appender)
     end
 
-    @@lag_check_interval = 5000
-    @@lag_threshold_s    = 30
-
-    # Returns the check_interval which is the number of messages between checks
-    # to determine if the appender thread is falling behind
-    def self.lag_check_interval
-      @@lag_check_interval
-    end
-
-    # Set the check_interval which is the number of messages between checks
-    # to determine if the appender thread is falling behind
-    def self.lag_check_interval=(lag_check_interval)
-      @@lag_check_interval = lag_check_interval
-    end
-
-    # Returns the amount of time in seconds
-    # to determine if the appender thread is falling behind
-    def self.lag_threshold_s
-      @@lag_threshold_s
-    end
-
-    # Allow the internal logger to be overridden from its default to STDERR
-    #   Can be replaced with another Ruby logger or Rails logger, but never to
-    #   Sapience::Logger itself since it is for reporting problems
-    #   while trying to log to the various appenders
-    def self.logger=(logger)
-      @@logger = logger
-    end
-
-    # Place log request on the queue for the Appender thread to write to each
-    # appender in the order that they were registered
-    def log(log, message = nil, progname = nil, &block)
-      # Compatibility with ::Logger
-      return add(log, message, progname, &block) unless log.is_a?(Sapience::Log)
-      @@appender_thread << lambda do
-        Sapience.appenders.each do |appender|
-          begin
-            appender.log(log)
-          rescue StandardError => exc
-            logger.error "Appender thread: Failed to log to appender: #{appender.inspect}", exc
-          end
-        end
-      end if @@appender_thread
-    end
-
     @@appender_thread = nil
 
     # Internal logger for Sapience
@@ -135,7 +65,7 @@ module Sapience
     def self.start_appender_thread
       return false if appender_thread_active?
 
-      @@appender_thread = Concurrent::SingleThreadExecutor.new
+      @@appender_thread = Sapience.log_executor_class.new
       fail "Failed to start Appender Thread" unless @@appender_thread
       true
     end
@@ -151,6 +81,55 @@ module Sapience
     def self.appender_thread
       @@appender_thread
     end
+
+    # Allow the internal logger to be overridden from its default to STDERR
+    #   Can be replaced with another Ruby logger or Rails logger, but never to
+    #   Sapience::Logger itself since it is for reporting problems
+    #   while trying to log to the various appenders
+    def self.logger=(logger)
+      @@logger = logger
+    end
+
+    # Returns a Logger instance
+    #
+    # Return the logger for a specific class, supports class specific log levels
+    #   logger = Sapience::Logger.new(self)
+    # OR
+    #   logger = Sapience::Logger.new('MyClass')
+    #
+    # Parameters:
+    #  application
+    #    A class, module or a string with the application/class name
+    #    to be used in the logger
+    #
+    #  level
+    #    The initial log level to start with for this logger instance
+    #    Default: Sapience.config.default_level
+    #
+    #  filter [Regexp|Proc]
+    #    RegExp: Only include log messages where the class name matches the supplied
+    #    regular expression. All other messages will be ignored
+    #    Proc: Only include log messages where the supplied Proc returns true
+    #          The Proc must return true or false
+    def initialize(klass, level = nil, filter = nil)
+      super
+    end
+
+    # Place log request on the queue for the Appender thread to write to each
+    # appender in the order that they were registered
+    def log(log, message = nil, progname = nil, &block)
+      # Compatibility with ::Logger
+      return add(log, message, progname, &block) unless log.is_a?(Sapience::Log)
+      @@appender_thread << lambda do
+        Sapience.appenders.each do |appender|
+          begin
+            appender.log(log)
+          rescue StandardError => exc
+            self.class.logger.error "Appender thread: Failed to log to appender: #{appender.inspect}", exc
+          end
+        end
+      end if @@appender_thread
+    end
     # rubocop:enable BlockNesting, AssignmentInCondition, PerceivedComplexity, CyclomaticComplexity, AbcSize, LineLength, RescueException
   end
 end

data/lib/sapience/rails.rb

@@ -1,4 +1,15 @@
 require "sapience"
+require "sapience/extensions/action_cable/tagged_logger_proxy"
+require "sapience/extensions/action_controller/live"
+require "sapience/extensions/action_controller/log_subscriber"
+require "sapience/extensions/action_dispatch/debug_exceptions"
+require "sapience/extensions/action_view/streaming_template_renderer"
+require "sapience/extensions/active_job/logging"
+require "sapience/extensions/active_model_serializers/logging"
+require "sapience/extensions/active_record/log_subscriber"
+require "sapience/extensions/rails/rack/logger"
+require "sapience/extensions/rails/rack/logger_info_as_debug"
+require "sapience/extensions/action_view/log_subscriber"
 
 module Sapience
   class Rails < ::Rails::Engine
@@ -35,38 +46,24 @@ module Sapience
       Raven.send(:include) { Sapience::Loggable }
 
       # Replace the Sneakers logger
-      Sneakers.logger             = Sapience[Sneakers] if defined?(Sneakers)
+      Sneakers.configure(log: Sapience[Sneakers]) if defined?(Sneakers)
 
       # Replace the Bugsnag logger
       Bugsnag.configure { |config| config.logger = Sapience[Bugsnag] } if defined?(Bugsnag)
 
       # Set the logger for concurrent-ruby
       Concurrent.global_logger = Sapience[Concurrent] if defined?(Concurrent)
-
-      # Rails Patches
-      Kernel.require "sapience/extensions/action_cable/tagged_logger_proxy" if defined?(ActionCable)
-      Kernel.require "sapience/extensions/action_controller/live" if defined?(ActionController::Live)
-      Kernel.require "sapience/extensions/action_dispatch/debug_exceptions" if defined?(ActionDispatch::DebugExceptions)
-      if defined?(ActionView::StreamingTemplateRenderer::Body)
-        Kernel.require "sapience/extensions/action_view/streaming_template_renderer"
-      end
-      Kernel.require "sapience/extensions/active_job/logging" if defined?(ActiveJob)
-      Kernel.require "sapience/extensions/active_model_serializers/logging" if defined?(ActiveModelSerializers)
-      Kernel.require "sapience/extensions/action_controller/log_subscriber" if defined?(ActionController)
-      Kernel.require "sapience/extensions/active_record/log_subscriber" if defined?(ActiveRecord::LogSubscriber)
-      Kernel.require "sapience/extensions/rails/rack/logger" if defined?(::Rails::Rack::Logger)
-      Kernel.require "sapience/extensions/rails/rack/logger_info_as_debug" if defined?(::Rails::Rack::Logger)
-      Kernel.require "sapience/extensions/action_view/log_subscriber" if defined?(ActionView::LogSubscriber)
-      if defined?(ActionView::LogSubscriber)
-        Kernel.require "sapience/extensions/action_controller/log_subscriber_processing"
-      end
     end
 
     # Before any initializers run, but after the gems have been loaded
     config.after_initialize do
       # Replace the Bugsnag logger
       Bugsnag.configure { |config| config.logger = Sapience[Bugsnag] } if defined?(Bugsnag)
+      Sapience::Extensions::ActionController::LogSubscriber.attach_to :action_controller
+      # Sapience::Extensions::ActiveSupport::MailerLogSubscriber.attach_to :action_mailer
+      Sapience::Extensions::ActiveRecord::LogSubscriber.attach_to :active_record
+      Sapience::Extensions::ActionView::LogSubscriber.attach_to :action_view
+      # Sapience::Extensions::ActiveJob::LogSubscriber.attach_to :active_job
     end
-
   end
 end

data/lib/sapience/sapience.rb

@@ -1,6 +1,7 @@
 require "concurrent"
 require "socket"
 require "sapience/descendants"
+require "English"
 
 # Example:
 #
@@ -19,12 +20,16 @@ require "sapience/descendants"
 
 # rubocop:disable ClassVars
 module Sapience
+  UnknownClass = Class.new(NameError)
   @@configured = nil
 
   # Logging levels in order of most detailed to most severe
   LEVELS = [:trace, :debug, :info, :warn, :error, :fatal].freeze
   DEFAULT_ENV = "default".freeze
 
+  # TODO: Should we really always read from file?
+  # What if someone wants to configure sapience with a block
+  # without reading the default.yml?
   def self.config
     @@config ||= begin
       config    = ConfigLoader.load_from_file
@@ -48,6 +53,7 @@ module Sapience
     @@logger = nil
     @@metrix = nil
     @@configured = nil
+    clear_tags!
     reset_appenders!
   end
 
@@ -68,6 +74,8 @@ module Sapience
     end
   end
 
+  # TODO: Maybe when configuring with a block we should create a new config?
+  # See the TODO note on .config for more information
   def self.configure(force: false)
     yield config if block_given?
     return config if configured? && force == false
@@ -162,7 +170,7 @@ module Sapience
   #   logger.debug("Login time", user: 'Joe', duration: 100, ip_address: '127.0.0.1')
   def self.add_appender(appender, options = {}, _deprecated_level = nil, &_block)
     fail ArgumentError, "options should be a hash" unless options.is_a?(Hash)
-    options.deep_symbolize_keys!
+    options.deep_symbolize_keyz!
     appender_class = constantize_symbol(appender)
     validate_appender!(appender_class)
 
@@ -273,19 +281,6 @@ module Sapience
     Thread.current[:sapience_tags].pop
   end
 
-  # Add the supplied named tags to the list of tags to log for this thread whilst
-  # the supplied block is active.
-  #
-  # Returns result of block
-  #
-  # Example:
-  def self.named_tags(tag)
-    (Thread.current[:sapience_tags] ||= []) << tag
-    yield
-  ensure
-    Thread.current[:sapience_tags].pop
-  end
-
   # Add the supplied tags to the list of tags to log for this thread whilst
   # the supplied block is active.
   # Returns result of block
@@ -314,6 +309,10 @@ module Sapience
     new_tags
   end
 
+  def self.clear_tags!
+    Thread.current[:sapience_tags] = []
+  end
+
   # Remove specified number of tags from the current tag list
   def self.pop_tags(quantity = 1)
     t = Thread.current[:sapience_tags]
@@ -366,11 +365,13 @@ module Sapience
 
   reset_appenders!
 
+  def self.log_executor_class
+    constantize_symbol(config.log_executor, "Concurrent")
+  end
+
   def self.constantize_symbol(symbol, namespace = "Sapience::Appender")
-    klass = "#{namespace}::#{camelize(symbol.to_s)}"
-    constantize(klass)
-  rescue NameError
-    raise(ArgumentError, "Could not convert symbol: #{symbol} to a class in: #{namespace}. Looking for: #{klass}")
+    class_name = "#{namespace}::#{symbol.camelize}"
+    constantize(class_name)
   end
 
   def self.constantize(class_name)
@@ -380,16 +381,11 @@ module Sapience
     else
       class_name.split("::").inject(Object) { |o, name| o.const_get(name) } # rubocop:disable SingleLineBlockParams
     end
+  rescue NameError
+    raise UnknownClass, "Could not find class: #{class_name}."
   end
 
-  # Borrow from Rails, when not running Rails
-  def self.camelize(term) # rubocop:disable AbcSize
-    string = term.to_s
-    string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
-    string.gsub!(/(?:_|(\/))([a-z\d]*)/i) do
-      "#{Regexp.last_match[1]}#{inflections.acronyms[Regexp.last_match[2]] || Regexp.last_match[2].capitalize}"
-    end
-    string.gsub!("/".freeze, "::".freeze)
-    string
+  def self.root
+    @_root ||= Gem::Specification.find_by_name("sapience").gem_dir
   end
 end

data/lib/sapience/subscriber.rb

@@ -105,9 +105,7 @@ module Sapience
     # rubocop:disable CyclomaticComplexity, AbcSize, PerceivedComplexity
     def extract_formatter(formatter, &block)
       case
-      when formatter.is_a?(Symbol)
-        Sapience.constantize_symbol(formatter, "Sapience::Formatters").new
-      when formatter.is_a?(String)
+      when formatter.is_a?(Symbol) || formatter.is_a?(String)
         Sapience.constantize_symbol(formatter, "Sapience::Formatters").new
       when formatter.is_a?(Hash) && formatter.size > 0
         fmt, options = formatter.first
@@ -123,15 +121,5 @@ module Sapience
       end
     end
     # rubocop:enable CyclomaticComplexity, AbcSize, PerceivedComplexity
-
-    SUBSCRIBER_OPTIONS = [:level, :formatter, :filter, :application, :host].freeze
-
-    # Returns [Hash] the subscriber common options from the supplied Hash
-    def extract_subscriber_options!(options)
-      subscriber_options = {}
-      SUBSCRIBER_OPTIONS.each { |key| subscriber_options[key] = options.delete(key) if options.key?(key) }
-      subscriber_options
-    end
-
   end
 end

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/lib/sapience.rb

@@ -1,4 +1,8 @@
 require "sapience/version"
+require "sapience/ansi_colors"
+require "sapience/core_ext/hash"
+require "sapience/core_ext/symbol"
+require "sapience/core_ext/thread"
 require "sapience/sapience"
 
 # @formatter:off
@@ -14,9 +18,6 @@ require "sapience/formatters/json"
 require "sapience/config_loader"
 require "sapience/configuration"
 require "sapience/configuration/grape"
-require "sapience/ansi_colors"
-require "sapience/core_ext/hash"
-require "sapience/core_ext/thread"
 require "sapience/base"
 require "sapience/log"
 require "sapience/logger"

data/sapience.gemspec

@@ -36,7 +36,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-json"
   spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "sentry-raven"
+  spec.add_development_dependency "dogstatsd-ruby"
+  spec.add_development_dependency "rails", "~> 5.0.0.1"
+  spec.add_development_dependency "grape"
+  spec.add_development_dependency "active_model_serializers", "~> 0.10.0"
   spec.add_development_dependency "codeclimate-test-reporter"
-  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "gem-release"
 end

data/test_app/Gemfile

@@ -17,6 +17,9 @@ gem "puma", "~> 3.0"
 gem "sapience", path: "../", require: "sapience/rails"
 gem "sentry-raven"
 gem "statsd-ruby"
+gem "sneakers"
+gem "slim-rails"
+gem "active_model_serializers"
 
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
@@ -24,6 +27,7 @@ group :development, :test do
   # gem "pry-nav"
   gem "pry-byebug"
   gem "rspec-rails"
+  gem "factory_girl_rails"
 end
 
 group :development do
@@ -34,6 +38,9 @@ end
 
 group :test do
   gem "rspec-its"
+  gem "bunny-mock"
+  gem "rspec-wait"
+  gem "rails-controller-testing"
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

data/test_app/Rakefile

@@ -4,6 +4,8 @@ require_relative "config/application"
 
 Rails.application.load_tasks
 
+require "sneakers/tasks"
+
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 

data/test_app/app/models/post.rb

@@ -1,3 +1,3 @@
 class Post < ApplicationRecord
-  belongs_to :author
+  belongs_to :author, class_name: User
 end

data/test_app/app/views/posts/_form.html.slim

@@ -0,0 +1,18 @@
+= form_for @post do |f|
+  - if @post.errors.any?
+    #error_explanation
+      h2 = "#{pluralize(@post.errors.count, "error")} prohibited this post from being saved:"
+      ul
+        - @post.errors.full_messages.each do |message|
+          li = message
+
+  .field
+    = f.label :title
+    = f.text_field :title
+  .field
+    = f.label :body
+    = f.text_field :body
+  .field
+    = f.label :author
+    = f.text_field :author
+  .actions = f.submit

data/test_app/app/views/posts/edit.html.slim

@@ -0,0 +1,8 @@
+h1 Editing post
+
+== render 'form'
+
+= link_to 'Show', @post
+'|
+= link_to 'Back', posts_path
+

data/test_app/app/views/posts/index.html.slim

@@ -0,0 +1,25 @@
+h1 Listing posts
+
+table
+  thead
+    tr
+      th Title
+      th Body
+      th Author
+      th
+      th
+      th
+
+  tbody
+    - @posts.each do |post|
+      tr
+        td = post.title
+        td = post.body
+        td = post.author
+        td = link_to 'Show', post
+        td = link_to 'Edit', edit_post_path(post)
+        td = link_to 'Destroy', post, data: { confirm: 'Are you sure?' }, method: :delete
+
+br
+
+= link_to 'New Post', new_post_path

data/test_app/app/views/posts/new.html.slim

@@ -0,0 +1,5 @@
+h1 New post
+
+== render 'form'
+
+= link_to 'Back', posts_path

data/test_app/app/views/posts/show.html.slim

@@ -0,0 +1,15 @@
+p#notice = notice
+
+p
+  strong Title:
+  = @post.title
+p
+  strong Body:
+  = @post.body
+p
+  strong Author:
+  = @post.author
+
+= link_to 'Edit', edit_post_path(@post)
+'|
+= link_to 'Back', posts_path

data/test_app/app/workers/test_worker.rb

@@ -0,0 +1,17 @@
+require_relative "../../../spec/support/file_helper"
+
+class TestWorker
+  QUEUE_NAME  = :sneakers_queue
+  ROUTING_KEY  = :sneakers_routing_key
+  VERIFICATION_FILE = "tmp/sneakers.verified".freeze
+
+  include Sneakers::Worker
+  include FileHelper
+
+  from_queue QUEUE_NAME, routing_key: ROUTING_KEY
+
+  def work(_message)
+    create_file(VERIFICATION_FILE)
+    ack!
+  end
+end

data/test_app/bin/sneakers

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "serverengine"
+require "sneakers"
+require "sneakers/runner"
+require_relative "../app/workers/test_worker"
+require_relative "../config/initializers/sneakers"
+
+runner = Sneakers::Runner.new([TestWorker])
+runner.run

data/test_app/config/initializers/sneakers.rb

@@ -0,0 +1,15 @@
+require "serverengine"
+require "sneakers"
+
+p ENV.fetch("AMQP") { "amqp://guest:guest@localhost:5672" }
+
+Sneakers.configure(
+  amqp:               ENV.fetch("AMQP") { "amqp://guest:guest@localhost:5672" },
+  exchange_type:      :direct,
+  log:                Sapience[Sneakers], # Log file
+  exchange:           "sapience", # AMQP exchange
+  durable:            false, # Is queue durable?
+  ack:                true, # Must we acknowledge?
+  metrics:            Sapience.metrix,
+)
+Sapience.logger.level = Logger::DEBUG

data/test_app/config/sapience_example.yml

@@ -0,0 +1,24 @@
+---
+default:
+  log_level: error
+  appenders:
+    - stream:
+        file_name: log/error.log
+        formatter: default
+
+development:
+  log_level: debug
+  appenders:
+    - stream:
+        io: STDOUT
+        formatter: color
+    - stream:
+        file_name: log/development.log
+        formatter: color
+
+test:
+  log_level: fatal
+  appenders:
+    - stream:
+        file_name: log/fatal.log
+        formatter: json

data/test_app/db/migrate/{20160812093621_create_posts.rb → 20160902141445_create_posts.rb}

@@ -3,7 +3,7 @@ class CreatePosts < ActiveRecord::Migration[5.0]
     create_table :posts do |t|
       t.string :title
       t.string :body
-      t.belongs_to :author, foreign_key: { name: :posts_users_fk }
+      t.belongs_to :author, foreign_key: true
 
       t.timestamps
     end

data/test_app/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20160812093621) do
+ActiveRecord::Schema.define(version: 20160902141445) do
 
   create_table "posts", force: :cascade do |t|
     t.string   "title"

data/test_app/lib/external_sneaker.rb

@@ -0,0 +1,46 @@
+require "timeout"
+
+class ExternalSneaker
+  attr_accessor :worker_pid, :start_command
+
+  def initialize(start_command)
+    fail ArgumentError, "start_command was expected" if start_command.nil?
+
+    self.start_command = start_command
+  end
+
+  def start
+    puts "Trying to start #{start_command}..."
+    self.worker_pid = fork do
+      start_child
+    end
+
+    at_exit do
+      stop_child
+    end
+  end
+
+  private
+
+  def start_child
+    exec({ "RAILS_ENV" => Rails.env, "WORKERS" => "TestWorker" }, start_command)
+  end
+
+  def stop_child # rubocop:disable AbcSize
+    puts "Trying to stop #{start_command}, pid: #{worker_pid}"
+
+    # send TERM and wait for exit
+    Process.kill("TERM", worker_pid)
+
+    begin
+      Timeout.timeout(10) do
+        Process.waitpid(worker_pid)
+        puts "Process #{start_command} stopped successfully"
+      end
+    rescue Timeout::Error
+      # Kill process if could not exit in 10 seconds
+      puts "Sending KILL signal to #{start_command}, pid: #{worker_pid}"
+      Process.kill("KILL", worker_pid)
+    end
+  end
+end

data/test_app/spec/factories/posts.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :post do
+    title "This is a post"
+    body "It has a lot of content"
+    association :author, factory: :user
+  end
+end

data/test_app/spec/factories/users.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  sequence(:username) { |i| "mrcool#{i}" }
+  sequence(:email) { |i| "so#{i}@cool.com" }
+  factory :user do
+    username
+    email
+  end
+end