rails_stdout_logging 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a4392b1c9b8fbb3f3113e56f1c2bd0ca5dada05
-  data.tar.gz: 1fba8dd578f13f3a3938c6bc7eb330f3b2648c6b
+  metadata.gz: f962b41cfcf24041cc6771adb5e9ac114c9417b4
+  data.tar.gz: de22b58d015a3f9fe5f8b8b65e1369fc9cf66ce5
 SHA512:
-  metadata.gz: 6d1873e2afc444dc1cab8068d0c2894162c86a2f4c49b16762f4ef266fa93466603db3fa9e6adaae906f29ff8dbeb1c3f86c41cceb44b14f8e954238d6dd6eb6
-  data.tar.gz: 4906e2de889d805ed5f32dbeeab202527b91db6b59fc5fa2e4a56eddf94430647a9a01662af67bbf4a5e5ecb2d1911352762f78e029a48914a089dc5c5df71d6
+  metadata.gz: 3f4827c5113e041ae50ecdacdf8e5428c44b4cbe1be9f40321f1e962610f5f35f5fe1cf20b8befd9180b652d0584b805dd36eaba13a6e84128eaa8a16d34a4ae
+  data.tar.gz: 4b55501983ca0569b03dfd171e2778d8ec69025ac33b2614683f78cd0020c9e3faa1b3acba5268c5aee1a79aa1397293913ab3cef01067a1231399aebdd81011

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.log
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/rails_3.0.x.gemfile
+  - gemfiles/rails_3.1.x.gemfile
+  - gemfiles/rails_3.2.x.gemfile
+  - gemfiles/rails_4.0.x.gemfile

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-3.0.x" do
+  gem "rails", "~> 3.0.0"
+end
+
+appraise "rails-3.1.x" do
+  gem "rails", "~> 3.1.0"
+end
+
+appraise "rails-3.2.x" do
+  gem "rails", "~> 3.2.0"
+end
+
+appraise "rails-4.0.x" do
+  gem "rails", "~> 4.0.0"
+end

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rails_stdout_logging.gemspec
 gemspec
+
+gem 'appraisal'
+
+gem 'rake'
+gem "capybara"
+gem "launchy"
+
+gem "sqlite3",                          :platform => [:ruby, :mswin, :mingw]
+gem "activerecord-jdbcsqlite3-adapter", '>= 1.3.0.beta', :platform => :jruby

data/README.md

@@ -1,4 +1,61 @@
-# rails_stdout_logging
+# Rails Stdout Logging
+
+Rails gem to configure your app to log to standard out.
+
+[![Build Status](https://travis-ci.org/heroku/rails_stdout_logging.png?branch=master)](https://travis-ci.org/heroku/rails_stdout_logging)
+
+Supports:
+
+- Rails 3
+- Rails 4
+
+
+
+## Install
+
+In your `Gemfile` add:
+
+```
+gem 'rails_stdout_logging'
+```
+
+Then run
+
+```
+$ bundle install`
+```
+
+You also need the `rails_serve_static_assets` gem. You can get both of them together by installing `rails_on_heroku` gem.
+
+## Why is this needed?
+
+By default Rails writes its logs to a file which is convenient but only you only have one log file to tail. When you start scaling your app to multiple machines or dynos then finding a single request or failure across multiple files becomes much harder. Storing logs on disk can also take down a server if the hard drive fills up. Because of these limitations: every Rails core member we talked to uses a custom logger to replace Rail's default functionality. By using the `rails_stdout_logging` gem with Heroku, we set the logger for you.
+
+The gem `rails_stdout_logging` ensures that your logs will be sent to standard out, from there Heroku sends them to [logplex](https://github.com/heroku/logplex) so you can access them from the command line, `$ heroku logs --tail`, or from enabled addons like [papertrail](https://addons.heroku.com/papertrail). By using Heroku's logplex, you can [treat logs as event streams](http://www.12factor.net/logs).
+
+## Why Didn't I need this before?
+
+Why do you need to include this gem in Rails 4 and not Rails 3? Rails4 is getting rid of the concept of plugins. Before libraries were easily distributed as Gems and in the form of Engines, Rails had a folder `vendor/plugins`. Any code you put there would be initialized much like a Gem is today. This was a very simple and easy way to share and use libraries, but it wasn't very maintainable. You could use a library, and make a change locally and then deploy which makes your version incompatible from future versions. Even worse there was no concept of versioning aside from source control, so semantic versioning was out of the question. For these reasons and more Rails3 deprecated plugins. With Rails4 plugins have been removed completely. Why does this affect your app on Heroku?
+
+In the past Heroku has used plugins as a safe way to configure your application where code was needed. While we advocate [separating config from code](http://12factor.net), this was the only option if we wanted your apps to work with no changes from you. With Rails3 Heroku will add the asset serving and standardout logging plugins to your app automatically. With Rails4, Heroku needs you to add these libraries to your Gemfile.
+
+It is important to note that unlike Gems, plugins do not have a dependency resolution phase like what happens when you run `bundle install`. Heroku does not and will not add anything to your Gemfile on compilation.
+
+## Tests
+
+Since we're playing with stdout we need to capture stdout. If you want to use the non captured version use `DEBUG_STDOUT` instead. The `puts` method should still behave as you expect.
+
+We're using appraisal to build multiple gemfiles for different versions of Rails.
+
+You can run all tests by running
+
+```
+$ bundle exec rake appraisal test
+```
+
+
+## The Future
+
+We will be working with Rails and the Rails core team to make future versions of Rails work on Heroku out of the box. Until then you'll need to add this gem to your project.
 
-Configure a Rails 2 or 3 app to log to STDOUT by default
 

data/Rakefile

@@ -1,2 +1,29 @@
 #!/usr/bin/env rake
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
 require "bundler/gem_tasks"
+
+require 'rake'
+require 'rdoc/task'
+
+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
+
+require 'appraisal'

data/gemfiles/rails_3.0.x.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "capybara"
+gem "launchy"
+gem "sqlite3", :platform=>[:ruby, :mswin, :mingw]
+gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.beta", :platform=>:jruby
+gem "rails", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_3.1.x.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "capybara"
+gem "launchy"
+gem "sqlite3", :platform=>[:ruby, :mswin, :mingw]
+gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.beta", :platform=>:jruby
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_3.2.x.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "capybara"
+gem "launchy"
+gem "sqlite3", :platform=>[:ruby, :mswin, :mingw]
+gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.beta", :platform=>:jruby
+gem "rails", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_4.0.x.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "capybara"
+gem "launchy"
+gem "sqlite3", :platform=>[:ruby, :mswin, :mingw]
+gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.beta", :platform=>:jruby
+gem "rails", "~> 4.0.0"
+
+gemspec :path=>"../"

data/lib/rails_stdout_logging.rb

@@ -1,4 +1,2 @@
-
-
 require "rails_stdout_logging/version"
 require "rails_stdout_logging/railtie" if defined?(Rails)

data/lib/rails_stdout_logging/rails.rb

@@ -1,9 +1,8 @@
 module RailsStdoutLogging
   class Rails
-
     def self.heroku_stdout_logger
-      logger = Logger.new(STDOUT)
-      logger = ActiveSupport::TaggedLogging.new(logger) if defined?(ActiveSupport::TaggedLogging)
+      logger       = Logger.new(STDOUT)
+      logger       = ActiveSupport::TaggedLogging.new(logger) if defined?(ActiveSupport::TaggedLogging)
       logger.level = Logger.const_get(log_level)
       logger
     end

data/lib/rails_stdout_logging/railtie.rb

@@ -2,7 +2,7 @@ require 'rails_stdout_logging/rails3'
 
 module RailsStdoutLogging
   class Railtie < ::Rails::Railtie
-    config.after_initialize do
+    config.before_initialize do
       Rails3.set_logger(config)
     end
   end

data/lib/rails_stdout_logging/version.rb

@@ -1,3 +1,3 @@
 module RailsStdoutLogging
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/{rails_log_stdout.gemspec → rails_stdout_logging.gemspec}

@@ -13,5 +13,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "rails_stdout_logging"
   gem.require_paths = ["lib"]
+  gem.license       = "MIT"
   gem.version       = RailsStdoutLogging::VERSION
 end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# 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 File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/bar_controller.rb

@@ -0,0 +1,12 @@
+## This controller uses includes
+
+class BarController < ApplicationController
+
+  def index
+    Rails.logger.info "Logging with Rails.logger" # Printed to STDOUT
+    logger.info "Logging with logger"             # Not printed to STDOUT
+  end
+
+  def update
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/bar/index.html.erb

@@ -0,0 +1 @@
+Index

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "rails_stdout_logging"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end