timber 2.6.2 → 3.0.0

data/spec/support/action_controller.rb

@@ -1,8 +0,0 @@
-begin
-  require "action_controller"
-rescue LoadError
-end
-
-if defined?(::ActionController::Base)
-  ::ActionController::Base.prepend_view_path("#{File.dirname(__FILE__)}/rails/templates")
-end

data/spec/support/active_record.rb

@@ -1,32 +0,0 @@
-begin
-  require 'active_record'
-rescue LoadError
-end
-
-if defined?(::ActiveRecord::Base)
-  ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-  ActiveRecord::Schema.define do
-    self.verbose = false
-
-    create_table :organizations, :force => true do |t|
-      t.string :name
-
-      t.timestamps :null => false
-    end
-
-    create_table :users, :force => true do |t|
-      t.integer :age
-      t.string :email
-      t.string :first_name
-
-      t.timestamps :null => false
-    end
-
-  end
-
-  class Organization < ::ActiveRecord::Base
-  end
-
-  class User < ::ActiveRecord::Base
-  end
-end

data/spec/support/rails.rb

@@ -1,67 +0,0 @@
-begin
-  require "rails"
-rescue LoadError
-end
-
-if defined?(::Rails)
-  # Defualt the rails logger to nothing, each test shoould be
-  # responsible for setting up the logger
-  logger = Timber::Logger.new(nil) # change to STDOUT to see rails logs
-  Rails.logger = logger
-
-  class RailsApp < Rails::Application
-    if ::Rails.version =~ /^3\./
-      config.secret_token = '1e05af2b349457936a41427e63450937'
-    else
-      config.secret_key_base = '1e05af2b349457936a41427e63450937'
-    end
-
-    # This ensures our tests fail, otherwise exceptions get swallowed by ActionDispatch::DebugExceptions
-    config.action_dispatch.show_exceptions = false
-    config.active_support.deprecation = :stderr
-    config.eager_load = false
-  end
-
-  RailsApp.initialize!
-
-  module Support
-    module Rails
-      def dispatch_rails_request(path, additional_env_options = {})
-        application = ::Rails.application
-        env = application.respond_to?(:env_config) ? application.env_config.clone : application.env_defaults.clone
-        env["rack.request.cookie_hash"] = {}.with_indifferent_access
-        env["CONTENT_LENGTH"] = 100
-        env["REMOTE_ADDR"] = "123.456.789.10"
-        env["HTTP_X_REQUEST_ID"] = "unique-request-id-1234"
-        env["action_dispatch.request_id"] = env["HTTP_X_REQUEST_ID"]
-        env = env.merge(additional_env_options)
-        ::Rack::MockRequest.new(application).get(path, env)
-      end
-
-      def with_rails_logger(logger)
-        old_logger = ::Rails.logger
-
-        # We have to set these again because rails set's these after initialization.
-        # Since we've already booted the rails app we need to update them all as we
-        # change the logger.
-        #
-        # You can see here that they use simple class attribute, hence the reason we need
-        # to update all of them: https://github.com/rails/rails/blob/700ec897f97c60016ad748236bf3a49ef15a20de/actionview/lib/action_view/base.rb#L157
-        ::ActionCable::Server::Base.logger = logger if defined?(::ActionCable::Server::Base) && ::ActionCable::Server::Base.respond_to?(:logger=)
-        ::ActionController::Base.logger = logger if defined?(::ActionController::Base) && ::ActionController::Base.respond_to?(:logger=)
-        ::ActionMailer::Base.logger = logger if defined?(::ActionMailer::Base) && ::ActionMailer::Base.respond_to?(:logger=)
-        ::ActionView::Base.logger = logger if defined?(::ActionView::Base) && ::ActionView::Base.respond_to?(:logger=)
-        ::ActiveRecord::Base.logger = logger if defined?(::ActiveRecord::Base) && ::ActiveRecord::Base.respond_to?(:logger=)
-        ::Rails.logger = logger
-
-        yield
-
-        ::Rails.logger = old_logger
-      end
-    end
-  end
-
-  RSpec.configure do |config|
-    config.include Support::Rails
-  end
-end

data/spec/support/rails/templates/_partial.html

@@ -1 +0,0 @@
-I am a partial

data/spec/support/rails/templates/template.html

@@ -1 +0,0 @@
-I am a template

data/spec/timber/cli/config_file_spec.rb

@@ -1,26 +0,0 @@
-require "spec_helper"
-
-describe Timber::CLI::ConfigFile, :rails_23 => true do
-  let(:api) { Timber::CLI::API.new("abcd1234") }
-  let(:file_helper) { @file_helper = Timber::CLI::FileHelper.new(api) }
-  let(:path) { "config/initializers/timber.rb" }
-  let(:config_file) { described_class.new(path, file_helper) }
-  let(:initial_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For common configuration options see:\n# https://timber.io/docs/languages/ruby/configuration\n#\n# For a full list of configuration options see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
-  let(:contents_hook) { "# Add additional configuration here." }
-
-  describe ".create!" do
-    it "should create" do
-      expect(config_file.file_helper).to receive(:write).with(path, initial_contents).exactly(1).times
-      config_file.create!
-    end
-  end
-
-  describe ".logrageify!" do
-    it "should not set the option in the config file" do
-      allow(config_file).to receive(:log_rage?).and_return(true)
-      config_file.logrageify!
-      new_contents = initial_contents.gsub(contents_hook, "config.logrageify!\n\n#{contents_hook}")
-      expect(config_file.send(:content)).to eq(new_contents)
-    end
-  end
-end

data/spec/timber/cli/installers/config_file_spec.rb

@@ -1,36 +0,0 @@
-require "spec_helper"
-
-describe Timber::CLI::Installers::ConfigFile, :rails_23 => true do
-  let(:api_key) { "abcd1234" }
-  let(:app) do
-    attributes = {
-      "api_key" => api_key,
-      "environment" => "development",
-      "heroku_drain_url" => "http://drain.heroku.com",
-      "name" => "My Rails App",
-      "platform_type" => "other"
-    }
-    Timber::CLI::API::Application.new(attributes)
-  end
-  let(:api) { Timber::CLI::API.new(api_key) }
-  let(:input) { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:io) { Timber::CLI::IO.new(io_out: output, io_in: input) }
-  let(:installer) { described_class.new(io, api) }
-  let(:initial_config_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For common configuration options see:\n# https://timber.io/docs/languages/ruby/configuration\n#\n# For a full list of configuration options see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
-
-  describe ".run" do
-    it "should run properly" do
-      path = "/path/to/file"
-      config_file = Timber::CLI::ConfigFile.new(path, installer.file_helper)
-
-      expect(Timber::CLI::ConfigFile).to receive(:new).with(path, installer.file_helper).and_return(config_file)
-      expect(config_file).to receive(:exists?).exactly(1).times.and_return(false)
-      expect(installer).to receive(:lograge?).exactly(1).times.and_return(true)
-      expect(config_file).to receive(:logrageify!).exactly(1).times
-      expect(config_file).to receive(:create!).exactly(1).times
-
-      installer.run(app, path)
-    end
-  end
-end

data/spec/timber/cli/installers/other_spec.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-
-require "spec_helper"
-
-describe Timber::CLI::Installers::Other, :rails_23 => true do
-  let(:api_key) { "abcd1234" }
-  let(:app) do
-    attributes = {
-      "api_key" => api_key,
-      "environment" => "development",
-      "heroku_drain_url" => "http://drain.heroku.com",
-      "name" => "My Rails App",
-      "platform_type" => "other"
-    }
-    Timber::CLI::API::Application.new(attributes)
-  end
-  let(:api) { Timber::CLI::API.new(api_key) }
-  let(:input) { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:io) { Timber::CLI::IO.new(io_out: output, io_in: input) }
-  let(:installer) { described_class.new(io, api) }
-
-  describe ".run" do
-    context "heroku" do
-      before(:each) do
-        app.platform_type = "heroku"
-      end
-
-      it "should run properly" do
-        expect(installer).to receive(:install_stdout).exactly(1).times
-        expect(installer).to receive(:ask_to_proceed).exactly(1).times
-
-        installer.run(app)
-      end
-    end
-
-    context "non-heroku" do
-      it "should run properly" do
-        api_key_code = "'#{api_key}'"
-        expect(installer).to receive(:get_api_key_storage_preference).exactly(1).times.and_return(:inline)
-        expect(installer).to receive(:get_api_key_code).with(:inline).exactly(1).times.and_return(api_key_code)
-        expect(installer).to receive(:install_http).with(api_key_code).exactly(1).times
-        expect(installer).to receive(:ask_to_proceed).exactly(1).times
-
-        installer.run(app)
-      end
-    end
-  end
-end

data/spec/timber/cli/installers/rails_spec.rb

@@ -1,364 +0,0 @@
-require "spec_helper"
-
-describe Timber::CLI::Installers::Rails, :rails_23 => true do
-  let(:api_key) { "abcd1234" }
-  let(:app) do
-    attributes = {
-      "api_key" => api_key,
-      "environment" => "development",
-      "heroku_drain_url" => "http://drain.heroku.com",
-      "name" => "My Rails App",
-      "platform_type" => "other"
-    }
-    Timber::CLI::API::Application.new(attributes)
-  end
-  let(:api) { Timber::CLI::API.new(api_key) }
-  let(:input) { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:io) { Timber::CLI::IO.new(io_out: output, io_in: input) }
-  let(:installer) { described_class.new(io, api) }
-  let(:logger_code) { defined?(ActiveSupport::TaggedLogging) ? "ActiveSupport::TaggedLogging.new(logger)" : "logger" }
-
-  describe ".run" do
-    context "development" do
-      it "should execute properly" do
-        expect(installer).to receive(:install_initializer).with(app).exactly(1).times
-        expect(installer).to receive(:install_development_environment).with(app).exactly(1).times
-        expect(installer).to receive(:install_test_environment).with(app).exactly(1).times
-        expect(installer).to_not receive(:install_app_environment)
-
-        installer.run(app)
-      end
-    end
-
-    context "staging" do
-      before(:each) do
-        app.environment = "staging"
-      end
-
-      it "should execute properly" do
-        expect(installer).to receive(:install_initializer).with(app).exactly(1).times
-        expect(installer).to receive(:install_development_environment).with(app).exactly(1).times
-        expect(installer).to receive(:install_test_environment).with(app).exactly(1).times
-        expect(installer).to receive(:install_app_environment).with(app).exactly(1).times
-
-        installer.run(app)
-      end
-    end
-
-    context "production" do
-      before(:each) do
-        app.environment = "production"
-      end
-
-      it "should execute properly" do
-        expect(installer).to receive(:install_initializer).with(app).exactly(1).times
-        expect(installer).to receive(:install_development_environment).with(app).exactly(1).times
-        expect(installer).to receive(:install_test_environment).with(app).exactly(1).times
-        expect(installer).to receive(:install_app_environment).with(app).exactly(1).times
-
-        installer.run(app)
-      end
-    end
-  end
-
-  describe ".install_initializer" do
-    it "should create a config file" do
-      config_file_path = "config/initializers/timber.rb"
-      expect_any_instance_of(Timber::CLI::Installers::ConfigFile).to receive(:run).with(app, config_file_path).exactly(1).times
-
-      installer.send(:install_initializer, app)
-    end
-  end
-
-  describe ".install_development_environment" do
-    let(:env_file_path) { "config/environments/development.rb" }
-
-    context "env file exists" do
-      context "not installed" do
-        context "send logs" do
-          it "should setup properly" do
-            expect(installer).to receive(:get_environment_file_path).
-              with("development").
-              exactly(1).times.
-              and_return(env_file_path)
-
-            expect(installer).to receive(:already_installed?).
-              with(env_file_path).
-              exactly(1).times.
-              and_return(false)
-
-            expect(installer).to receive(:get_development_preference).
-              with(app).
-              exactly(1).times.
-              and_return(:send)
-
-            expected_code = <<-CODE
-  # Install the Timber.io logger
-  # ----------------------------
-  # Remove the `http_device` to stop sending development logs to Timber.
-  # Be sure to keep the `file_device` or replace it with `STDOUT`.
-  http_device = Timber::LogDevices::HTTP.new('#{app.api_key}')
-  file_device = File.open("\#{Rails.root}/log/development.log", "a")
-  file_device.binmode
-  log_devices = [http_device, file_device]
-
-  # Do not modify below this line. It's important to keep the `Timber::Logger`
-  # because it provides an API for logging structured data and capturing context.
-  logger = Timber::Logger.new(*log_devices)
-  logger.level = config.log_level
-  config.logger = #{logger_code}
-CODE
-
-            expect(installer).to receive(:install_logger).
-              with(env_file_path, expected_code).
-              exactly(1).times
-
-            result = installer.send(:install_development_environment, app)
-            expect(result).to eq(:http)
-          end
-        end
-
-        context "dont send" do
-          it "should setup properly" do
-            expect(installer).to receive(:get_environment_file_path).
-              with("development").
-              exactly(1).times.
-              and_return(env_file_path)
-
-            expect(installer).to receive(:already_installed?).
-              with(env_file_path).
-              exactly(1).times.
-              and_return(false)
-
-            expect(installer).to receive(:get_development_preference).
-              with(app).
-              exactly(1).times.
-              and_return(:dont_send)
-
-            expect(installer).to receive(:install_stdout).
-              with(env_file_path).
-              exactly(1).times
-
-            result = installer.send(:install_development_environment, app)
-            expect(result).to eq(:stdout)
-          end
-        end
-      end
-
-      context "installed" do
-        it "should skip" do
-          expect(installer).to receive(:get_environment_file_path).
-            with("development").
-            exactly(1).times.
-            and_return(env_file_path)
-
-          expect(installer).to receive(:already_installed?).
-            with(env_file_path).
-            exactly(1).times.
-            and_return(true)
-
-          result = installer.send(:install_development_environment, app)
-          expect(result).to eq(:already_installed)
-        end
-      end
-    end
-  end
-
-  describe ".install_test_environment" do
-    let(:env_file_path) { "config/environments/test.rb" }
-
-    context "env file exists" do
-      context "not installed" do
-        it "should setup properly" do
-          expect(installer).to receive(:get_environment_file_path).
-            with("test").
-            exactly(1).times.
-            and_return(env_file_path)
-
-          expect(installer).to receive(:already_installed?).
-            with(env_file_path).
-            exactly(1).times.
-            and_return(false)
-
-          expect(installer).to receive(:install_nil).
-            with(env_file_path).
-            exactly(1).times
-
-          result = installer.send(:install_test_environment, app)
-          expect(result).to eq(:nil)
-        end
-      end
-
-      context "installed" do
-        it "should skip" do
-          expect(installer).to receive(:get_environment_file_path).
-            with("test").
-            exactly(1).times.
-            and_return(env_file_path)
-
-          expect(installer).to receive(:already_installed?).
-            with(env_file_path).
-            exactly(1).times.
-            and_return(true)
-
-          result = installer.send(:install_test_environment, app)
-          expect(result).to eq(:already_installed)
-        end
-      end
-    end
-  end
-
-  describe ".install_app_environment" do
-    context "production" do
-      before(:each) do
-        app.environment = "production"
-      end
-
-      let(:env_file_path) { "config/environments/production.rb" }
-
-      context "env file exists" do
-        context "not installed" do
-          context "http" do
-            it "should setup properly" do
-              expect(installer).to receive(:get_environment_file_path).
-                with("production").
-                exactly(1).times.
-                and_return(env_file_path)
-
-              expect(installer).to receive(:already_installed?).
-                with(env_file_path).
-                exactly(1).times.
-                and_return(false)
-
-              expect(installer).to receive(:get_delivery_strategy).
-                with(app).
-                exactly(1).times.
-                and_return(:http)
-
-              expect(installer).to receive(:get_api_key_storage_preference).
-                exactly(1).times.
-                and_return(:inline)
-
-              expect(installer).to receive(:install_http).
-                with(env_file_path, :inline).
-                exactly(1).times
-
-              result = installer.send(:install_app_environment, app)
-              expect(result).to eq(:http)
-            end
-          end
-
-          context "stdout" do
-            it "should setup properly" do
-              expect(installer).to receive(:get_environment_file_path).
-                with("production").
-                exactly(1).times.
-                and_return(env_file_path)
-
-              expect(installer).to receive(:already_installed?).
-                with(env_file_path).
-                exactly(1).times.
-                and_return(false)
-
-              expect(installer).to receive(:get_delivery_strategy).
-                with(app).
-                exactly(1).times.
-                and_return(:stdout)
-
-              expect(installer).to receive(:install_stdout).
-                with(env_file_path).
-                exactly(1).times
-
-              result = installer.send(:install_app_environment, app)
-              expect(result).to eq(:stdout)
-            end
-          end
-        end
-
-        context "installed" do
-          it "should skip" do
-            expect(installer).to receive(:get_environment_file_path).
-              with("production").
-              exactly(1).times.
-              and_return(env_file_path)
-
-            expect(installer).to receive(:already_installed?).
-              with(env_file_path).
-              exactly(1).times.
-              and_return(true)
-
-            result = installer.send(:install_app_environment, app)
-            expect(result).to eq(:already_installed)
-          end
-        end
-      end
-    end
-  end
-
-  describe ".get_environment_file_path" do
-    it "should return the file if it exists" do
-      env_file_path = "config/environments/development.rb"
-      expect(installer.file_helper).to receive(:exists?).with(env_file_path).exactly(1).times.and_return(true)
-
-      result = installer.send(:get_environment_file_path, "development")
-      expect(result).to eq(env_file_path)
-    end
-
-    it "should return nil if it does not exist" do
-      env_file_path = "config/environments/production.rb"
-      expect(installer.file_helper).to receive(:exists?).with(env_file_path).exactly(1).times.and_return(false)
-
-      result = installer.send(:get_environment_file_path, "production")
-      expect(result).to eq(nil)
-    end
-  end
-
-  describe ".install_nil" do
-    it "should pass the proper code" do
-      env_file_path = "config/environments/development.rb"
-
-      expected_code = <<-CODE
-  # Install the Timber.io logger
-  # ----------------------------
-  # `nil` is passed to disable logging. It's important to keep the `Timber::Logger`
-  # because it provides an API for logging structured data and capturing context.
-  logger = Timber::Logger.new(nil)
-  logger.level = config.log_level
-  config.logger = #{logger_code}
-CODE
-
-      expect(installer).to receive(:install_logger).
-        with(env_file_path, expected_code).
-        exactly(1).times
-
-      installer.send(:install_nil, env_file_path)
-    end
-  end
-
-  describe ".install_logger" do
-    context "not installed" do
-      it "should pass the proper code" do
-        env_file_path = "config/environments/development.rb"
-
-        logger_code = "my code"
-
-        current_contents = "\nend"
-
-        expect(installer.file_helper).to receive(:read).
-          with(env_file_path).
-          exactly(1).times.
-          and_return(current_contents)
-
-        new_contents = "\n\nmy code\nend"
-
-        expect(installer.file_helper).to receive(:write).
-          with(env_file_path, new_contents).
-          exactly(1).times.
-          and_return("\nend")
-
-        installer.send(:install_logger, env_file_path, logger_code)
-      end
-    end
-  end
-end