sapience 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3bb0b1bdb49281387b1d631b711ec681856297f
-  data.tar.gz: 11a904f638a18b0abc193ba568833548459e8787
+  metadata.gz: 14d3cb7ced5f31db60bee83527aa91fa14054562
+  data.tar.gz: cbdbeb2b580049917ff6914f30750ca757ba953d
 SHA512:
-  metadata.gz: 8c5c673b3aa0c29703ac2e573e4061a168af7247e71d5f7e26546e5faa1084b431620a1c0bc4cc91bf24833b9a29cfc932c58ddc07aa41dcd6c4a8ef73a8b860
-  data.tar.gz: 14eb31b23384a30fd49f2cd7d28bd0e6bb14152cbc586a606f010025a4d0514dafadada052ae7bc91e228ada47454d976cba461051b6728e2ceee922ef5f4efa
+  metadata.gz: d6a2d9d9e32281d0c8f74c8ba387a721e287aacbc33d4e7d3d896db74340ea9af40ca52b5defc95f6b3fe50cf9239ad582fb9544deef783e5c960312f74a9ced
+  data.tar.gz: feff9250b817af7363881bdba3311ea0b0c1c02b701e441e793840424bb7393615522b7b8570e43d5c726f2e70cdc872babf1611151736e9b4c9b4f426f97cb6

data/.simplecov

@@ -1,22 +1,18 @@
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
+require "simplecov-json"
 
-  # require "coveralls"
-  # Coveralls.wear!
-else
-  require "simplecov-json"
-  SimpleCov.maximum_coverage_drop 1
+coverage_dir = './coverage/sapience'
+FileUtils.rm_rf coverage_dir
 
-  SimpleCov.formatters = [
-    SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::JSONFormatter,
-  ]
+SimpleCov.coverage_dir coverage_dir
+SimpleCov.command_name "sapience"
+SimpleCov.maximum_coverage_drop 1
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+]
 
-  SimpleCov.start do
-    add_filter "/spec/"
-    add_filter "/bin/"
-    add_filter "/gemfiles/"
-  end
-
-end
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/bin/"
+  add_filter "/gemfiles/"
+end

data/.travis.yml

@@ -1,10 +1,21 @@
 sudo: required
+dist: trusty
 language: ruby
 services:
   - docker
+
+before_script:
+  - mkdir -p coverage/rails coverage/grape coverage/sapience
+
 script:
-  - docker-compose run -e TRAVIS=$TRAVIS -e TRAVIS_BRANCH=$TRAVIS_BRANCH -e TRAVIS_JOB_ID=$TRAVIS_JOB_ID -e TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST rspec
-  - docker-compose run -e TRAVIS=$TRAVIS -e TRAVIS_BRANCH=$TRAVIS_BRANCH -e TRAVIS_JOB_ID=$TRAVIS_JOB_ID -e TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST test_app
+  - docker-compose run rspec
+  - docker-compose run rails
+  - docker-compose run grape
+
+after_success:
+  - chown -R $(whoami) coverage
+  - bundle exec rake coverage:merge coverage:send
+
 notifications:
   slack:
     secure: apFwkfBQ+3NDJgcLNCHQori9qtr6ePaN3Xx7Sy7NVWwYm9BHNxoX/FN8/hxR63JjXrf1C0hK0FLQ0TiA0BN9PgEEIecg78BvWUwMClDDiwhyYN3H0Bbg35PUFtgDIrOGpu/TYlxNmdHEDYEAxaWsl9wSds8pAJsN6m7VTjGfBwJUDcOiM4L1eRpbp7smPqOjmuQFuOJnO8YkPb+6nUfz53cJrMRUdha89Vgmvnw6cP4/Ms1TsL3vKmMSVbGGh/6WNKPjU6IbuUjwlsh6a9xWxQOk6Wnis/Z+kA+T0XbLMuTLLmzRDuql1tjJeMPi+wukmK1a7GjpPkpkzAgwLQ/CkjTBfIRbMyaBYSuAciuOY8PDtCcT4WLwEvdZbkFmhAdSr1RYxIBpONVfZ/5DT3bpk71+O74OIBqxG6NmkiZ0B6u9/KxbnIINLVAcVaqsN8sdSqWlWKzPm45BfGPXGjmGGgIVFU31rs+W5Zs7IYMNUjZxabYKIv9TsBONbogfbcoGZA+rWWUnQdjypNWJS9wyQDvJ4btxqy8YhDfaV6gF30Un5JcAggMutzKJiYi+qAeh0uN3/9XoXV2N6XBnh58h8ny1NY+0vklWhtFGR1wfFAqkDskvCIZabSeJ5bFM6FtNbNKq9tYciS+eAO1vEYQVDFt9eY2uZF2mFDKRnEegHMU=

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+load "lib/tasks/coverage.rake"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/docker-compose.yml

@@ -10,7 +10,9 @@ services:
       RABBITMQ_DEFAULT_USER: sapience
       RABBITMQ_DEFAULT_PASS: tests
 
-  rails:
+
+
+  base:
     image: ruby:2.3
     cpu_shares: 4
     # Specify the directory from where all commands sent to the container will be
@@ -27,14 +29,14 @@ services:
       # Mount our app code directory (".") into our app containers at the
       # "/usr/src/app" folder:
       - .:/usr/src/app
-
       # Mount the 'gems' volume on the folder that stores bundled gems:
       - gems:/usr/local/bundle
 
 
+
   rspec:
     extends:
-      service: rails
+      service: base
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rake
     depends_on:
@@ -43,10 +45,12 @@ services:
       CODECLIMATE_REPO_TOKEN: 204dc055302da6aed94379e249aa0645636d1d1794920c62db05c5fa968215de
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 
-  test_app:
+
+
+  rails:
     extends:
-      service: rails
-    working_dir: /usr/src/app/test_app
+      service: base
+    working_dir: /usr/src/app/test_apps/rails
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rspec
     depends_on:
@@ -54,3 +58,14 @@ services:
     environment:
       AMQP: amqp://sapience:tests@rabbitmq:5672
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+
+
+  grape:
+    extends:
+      service: base
+    working_dir: /usr/src/app/test_apps/grape
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec rspec
+    environment:
+      PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

data/lib/sapience/appender/stream.rb

@@ -61,7 +61,7 @@ module Sapience
       # rubocop:disable AbcSize, CyclomaticComplexity, PerceivedComplexity
       def initialize(options = {}, &block)
         unless options[:io] || options[:file_name]
-          fail "Sapience::Appender::Stream missing mandatory parameter :file_name or :io"
+          fail ArgumentError, "missing mandatory argument :file_name or :io"
         end
 
         opts = options.dup

data/lib/sapience/extensions/action_cable/tagged_logger_proxy.rb

@@ -1,10 +1,8 @@
-if defined?(ActionCable)
-  class ActionCable::Connection::TaggedLoggerProxy # rubocop:disable ClassAndModuleChildren
-    alias_method :orig_tag, :tag
+class ActionCable::Connection::TaggedLoggerProxy # rubocop:disable ClassAndModuleChildren
+  alias_method :orig_tag, :tag
 
-    def tag(logger, &block)
-      current_tags = tags - logger.tags
-      logger.tagged(*current_tags, &block)
-    end
+  def tag(logger, &block)
+    current_tags = tags - logger.tags
+    logger.tagged(*current_tags, &block)
   end
-end
+end

data/lib/sapience/extensions/active_model_serializers/logging.rb

@@ -1,21 +1,19 @@
 # Patch ActiveModelSerializers logger
 
-if defined?(ActiveModelSerializers)
-  require "active_model_serializers/logging"
+require "active_model_serializers/logging"
 
-  module ActiveModelSerializers::Logging # rubocop:disable ClassAndModuleChildren
-    def self.included(base)
-      base.send(:include, Sapience::Loggable)
-    end
+module ActiveModelSerializers::Logging # rubocop:disable ClassAndModuleChildren
+  def self.included(base)
+    base.send(:include, Sapience::Loggable)
+  end
 
-    private
+  private
 
-    alias_method :orig_tag_logger, :tag_logger
+  alias_method :orig_tag_logger, :tag_logger
 
-    def tag_logger(*tags, &block)
-      logger.tagged(*tags, &block)
-    end
+  def tag_logger(*tags, &block)
+    logger.tagged(*tags, &block)
   end
-
-  ActiveModelSerializers.send(:include, Sapience::Loggable)
 end
+
+ActiveModelSerializers.send(:include, Sapience::Loggable)

data/lib/sapience/extensions/grape/middleware/logging.rb

@@ -26,30 +26,28 @@ module Sapience
             nil
           end
 
-          def call!(env)
-            super
-          end
-
           protected
 
-          def response
-            super
-          rescue
-            nil
-          end
-
           def parameters # rubocop:disable AbcSize
             {
-              status: (response.nil? ? "fail" : response.status),
-              db_runtime: db_runtime,
-              view_runtime: view_runtime,
-              total_runtime: total_runtime,
               method: request.request_method,
-              path: request.path,
-              params: request.params,
+              request_path: request.path,
+              format: "json",
+              status: response.try(:status),
+              class_name: env['api.endpoint'].options[:for].to_s,
+              action: "index",
               host: request.host,
               ip: (request.env["HTTP_X_FORWARDED_FOR"] || request.env["REMOTE_ADDR"]),
               ua: request.env["HTTP_USER_AGENT"],
+              # route: "test_controller#index",
+              # message: "Completed #index",
+              tags: Sapience.tags,
+              params: request.params,
+              runtimes: {
+                total: total_runtime,
+                view: view_runtime,
+                db: db_runtime,
+              },
             }
           end
 

data/lib/sapience/rails.rb

@@ -1,11 +1,8 @@
 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"
@@ -57,6 +54,9 @@ module Sapience
 
     # Before any initializers run, but after the gems have been loaded
     config.after_initialize do
+      require "sapience/extensions/action_cable/tagged_logger_proxy" if defined?(ActionCable)
+      require "sapience/extensions/active_model_serializers/logging" if defined?(ActiveModelSerializers)
+      require "sapience/extensions/active_job/logging" if defined?(ActiveJob)
       # Replace the Bugsnag logger
       Bugsnag.configure { |config| config.logger = Sapience[Bugsnag] } if defined?(Bugsnag)
       Sapience::Extensions::ActionController::LogSubscriber.attach_to :action_controller

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/lib/sapience.rb

@@ -17,7 +17,6 @@ require "sapience/formatters/json"
 
 require "sapience/config_loader"
 require "sapience/configuration"
-require "sapience/configuration/grape"
 require "sapience/base"
 require "sapience/log"
 require "sapience/logger"

data/lib/tasks/coverage.rake

@@ -0,0 +1,68 @@
+COVERAGE_FILE = ".simplecov".freeze
+COVERAGE_BKP_FILE = ".simplecov.bkp".freeze
+
+def coverage_dir
+  p File.join(Dir.pwd, "coverage")
+end
+
+def hide_coverage_config
+  FileUtils.mv COVERAGE_FILE, COVERAGE_BKP_FILE if File.exist?(COVERAGE_FILE)
+end
+
+def unhide_coverage_config
+  FileUtils.mv COVERAGE_BKP_FILE, COVERAGE_FILE if File.exist?(COVERAGE_BKP_FILE)
+end
+
+namespace :coverage do
+  task :merge do
+    hide_coverage_config
+    require "json"
+    require "simplecov/version"
+    require "simplecov/result"
+    require "simplecov-html"
+    require "simplecov-json"
+
+    coverage_file_pattern = "{rails,sapience,grape}/.resultset.json"
+    json_files = Dir[File.join(coverage_dir, coverage_file_pattern)]
+
+    merged_hash = {}
+    json_files.each do |json_file|
+      content = File.read(json_file)
+      content.gsub!(%r{\/usr\/src\/app}, Dir.pwd) # not inside docker anymore
+      JSON.parse(content).each do |command_name, data|
+        puts "#{json_file} –> '#{command_name}'"
+        merged_hash = SimpleCov::Result.from_hash(command_name => data).original_result.merge_resultset(merged_hash)
+      end
+    end
+
+    merged_result = SimpleCov::Result.new(merged_hash)
+    result_file = File.join(coverage_dir, ".resultset.json")
+    FileUtils.rm result_file if File.exist?(result_file)
+    File.write(result_file, merged_result.to_hash.to_json)
+
+    SimpleCov.coverage_dir coverage_dir
+    [SimpleCov::Formatter::JSONFormatter, SimpleCov::Formatter::HTMLFormatter].each do |formatter|
+      formatter.new.format(merged_result)
+    end
+
+    unhide_coverage_config
+  end
+
+  task :send do
+    hide_coverage_config
+    require "json"
+    require "codeclimate-test-reporter"
+    CodeClimate::TestReporter.configure do |config|
+      config.branch = "master"
+    end
+
+    require "code_climate/test_reporter/ci" if ENV["CI"]
+    ENV["CODECLIMATE_REPO_TOKEN"] = "204dc055302da6aed94379e249aa0645636d1d1794920c62db05c5fa968215de"
+    resultset_file   = File.join(coverage_dir, ".resultset.json")
+    result_hash      = JSON.parse(File.read(resultset_file))
+    simplecov_result = SimpleCov::Result.from_hash(result_hash)
+
+    CodeClimate::TestReporter::Formatter.new.format(simplecov_result)
+    unhide_coverage_config
+  end
+end

data/test_apps/grape/.simplecov

@@ -0,0 +1,25 @@
+require "simplecov-json"
+
+coverage_dir = '../../coverage/grape'
+FileUtils.rm_rf coverage_dir
+
+SimpleCov.coverage_dir coverage_dir
+SimpleCov.command_name "grape"
+SimpleCov.maximum_coverage_drop 1
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+]
+SimpleCov.start do
+  profiles.delete(:root_filter)
+  filters.clear
+  add_filter do |src|
+    if src.filename =~ %r{sapience\-rb|\/usr\/src\/app/}
+      src.filename.include?("test_apps/grape")
+    else
+      true
+    end
+  end
+
+  add_group "Sapience", "../"
+end

data/test_apps/grape/Gemfile

@@ -0,0 +1,30 @@
+source "https://rubygems.org"
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem "grape"
+# Use Puma as the app server
+gem "puma", "~> 3.0"
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+gem "sapience", path: "../.."
+gem "sentry-raven"
+gem "statsd-ruby"
+gem "active_model_serializers"
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem "byebug", platform: :mri
+  # gem "pry-nav"
+  gem "pry-byebug", platform: :mri
+  gem "rspec"
+  gem "racksh"
+end
+
+group :test do
+  gem "rspec-its"
+  gem "simplecov"
+  gem "simplecov-json"
+  gem "fuubar"
+end

data/test_apps/grape/Rakefile.rb

@@ -0,0 +1,8 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require_relative "lib/ping"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/test_apps/grape/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'lib/ping/api'
+
+run Ping::API

data/test_apps/grape/lib/ping/api.rb

@@ -0,0 +1,16 @@
+require "grape"
+require "grape/api"
+require "sapience/grape"
+
+module Ping
+  class API < ::Grape::API
+    format :json
+    use Sapience::Extensions::Grape::Middleware::Logging, logger: Grape::API.logger
+    prefix :api
+
+    desc "Returns pong."
+    get :ping do
+      { ping: "PONG" }
+    end
+  end
+end

data/test_apps/grape/lib/ping.rb

@@ -0,0 +1,3 @@
+module Ping
+  require_relative "ping/api"
+end

data/test_apps/grape/spec/lib/ping/api_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Ping::API do
+  include Rack::Test::Methods
+
+  def app
+    Ping::API
+  end
+
+  context "GET /api/ping" do
+    let(:logger) { Grape::API.logger }
+
+    specify do
+      get "/api/ping"
+      expect(last_response.body).to match(/PONG/)
+    end
+
+    it "logs something" do
+      expect(logger).to receive(:info).with(
+        method:       "GET",
+        request_path: "/api/ping",
+        format:       "json",
+        status:       200,
+        class_name:   "Ping::API",
+        action:       "index",
+        host:         "example.org",
+        ip:           "127.0.0.1",
+        ua:           nil,
+        tags:         [],
+        params:       {},
+        runtimes:     a_hash_including(
+                        total: kind_of(Float),
+                        view:  kind_of(Float),
+                        db:    kind_of(Float),
+                      ),
+      )
+      get "/api/ping"
+
+    end
+  end
+end

data/test_apps/grape/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "simplecov"
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "sapience/grape"
+require "rspec/its"
+require "ping"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.default_formatter = "doc" if config.files_to_run.one?
+  config.order = :random
+  Kernel.srand config.seed
+  config.before(:each) do
+    Sapience.reset!
+  end
+end

data/test_apps/rails/.gitignore

@@ -0,0 +1,38 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history

data/test_apps/rails/.simplecov

@@ -0,0 +1,25 @@
+require "simplecov-json"
+
+coverage_dir = '../../coverage/rails'
+FileUtils.rm_rf coverage_dir
+
+SimpleCov.coverage_dir coverage_dir
+SimpleCov.command_name "rails"
+SimpleCov.maximum_coverage_drop 1
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+]
+SimpleCov.start do
+  profiles.delete(:root_filter)
+  filters.clear
+  add_filter do |src|
+    if src.filename =~ %r{sapience\-rb|\/usr\/src\/app/}
+      src.filename.include?("test_apps/rails")
+    else
+      true
+    end
+  end
+
+  add_group "Sapience", "../"
+end

data/{test_app → test_apps/rails}/Gemfile

@@ -14,18 +14,18 @@ gem "puma", "~> 3.0"
 
 # Use Capistrano for deployment
 # gem 'capistrano-rails', group: :development
-gem "sapience", path: "../", require: "sapience/rails"
+gem "sapience", path: "../..", require: "sapience/rails"
 gem "sentry-raven"
 gem "statsd-ruby"
+gem "active_model_serializers"
 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
   gem "byebug", platform: :mri
   # gem "pry-nav"
-  gem "pry-byebug"
+  gem "pry-byebug", platform: :mri
   gem "rspec-rails"
   gem "factory_girl_rails"
 end
@@ -38,9 +38,9 @@ end
 
 group :test do
   gem "rspec-its"
-  gem "bunny-mock"
-  gem "rspec-wait"
   gem "rails-controller-testing"
+  gem "simplecov"
+  gem "simplecov-json"
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem