rails_12factor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa77a0787444de4f8d1ba207c773851023384f37
-  data.tar.gz: 924d95878fe54d165d292da486c3f0e9ce87820e
+  metadata.gz: a2c21639f4ac7dee459a542944ceedd99e89b71f
+  data.tar.gz: 92010a998269ab120ced4cdc6b0214e240eaf1ce
 SHA512:
-  metadata.gz: 3ea3dc4a30de8e1838f1d643f5b4024ba85f61aadb3d0cd7ac673169d35ad080e32700d2f5a57a46e99650ec316127f4d24329de0f225ab02b656952244a0b6b
-  data.tar.gz: 5f214e7bb89871537212da78756bc1193605cee59d45151a5b7197416e7a54bfa7dcaf98d247e2e58fc5972ff845e0ecd6c32932ce73b160664bd33dee7c4615
+  metadata.gz: a2bb874ff19b97341b568d5fa248cc90ec065e09ebb253fa204bee316f55cebe42d14e323f9e5b4783e6885933ece7b25c297dd5360572fadfa696b6e91d076b
+  data.tar.gz: d16f99f2632dc5493a00e5933a5364bf6392ffb8ca155393fca097cf9dbca0f00e99353aa0aec2ae047c33e60ffaea095a2ded16f432efa57f78e7d3eb56c04f

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rails_on_heroku.gemspec
+# Specify your gem's dependencies in rails_12factor.gemspec
 gemspec

data/README.md

@@ -1,68 +1,53 @@
-# Rails on Heroku
+# Rails 12factor
 
-Makes running your Rails app on Heroku easier.
+Makes running your Rails app easier. Based on the ideas behind [12factor.net](http://twelve-factor.net)
 
 ## What
 
-This gem enables serving assets in production, and setting your logger to standard out. Both of which are required for Rails4
+Rails gets a lot right when it comes to twelve-factor apps, but it could still be better. The two biggest areas right now is that in production [logs should be directed to stdout](http://www.twelve-factor.net/logs) and [dev/prod parity](http://www.twelve-factor.net/dev-prod-parity) while delivering assets.
+
+This gem enables serving assets in production and setting your logger to standard out, both of which are required for to run a Rails 4 application on a twelve-factor provider.
 
 ## Install
 
 In your `Gemfile` add:
 
-```
-gem 'rails_12factor'
+```ruby
+gem 'rails_12factor', group: :production
 ```
 
 Then run
 
-```
+```sh
 $ bundle install
 ```
 
-Now you're good to go. See the Heroku Quick start guide for information on deploying
-
+Now you're good to go.
 
 ## How
 
-This gem adds two other gems `rails_serve_static_assets` and `rails_stdout_logging`. Which are required to run your Rails app on Heroku if you want to use logplex and serve your assets in production. Here is how they work:
+This gem adds two other gems `rails_serve_static_assets` and `rails_stdout_logging`. These gems are required to run your Rails app with both logging aggregation and static assets serving in production. All you need to do to get the functionality of both gems is to add the `rails_twelve-factor` gem to your project. Here is how they work:
 
 ## Rails 4 Logging
 
-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.
+By default Rails writes its logs to a specific file, which is convenient if you only have one log file to tail. When you start scaling to multiple instances running your app, 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’ve  talked to uses a custom logger to replace Rail's default functionality. By using the `rails_stdout_logging` gem, the logger is set 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).
+The gem `rails_stdout_logging` ensures that your logs will be sent to standard out, and from there the twelve-factor platform can send them to a log aggregation service ( like  [logplex](https://github.com/heroku/logplex) on Heroku, or [Papertrail](https://papertrailapp.com)) so you can access them from one place. By using stdout instead of files, you can [treat logs as event streams](http://www.twelve-factor.net/logs).
 
 
 ## Rails 4 Serve Static Assets
 
-In the default Rails development environment assets are served through a middleware called [sprockets](https://github.com/sstephenson/sprockets). In production however most non-heroku Rails deployments will put their ruby server behind reverse HTTP proxy server such as Nginx which can load balance their sites and can serve static files directly. When Nginx sees a request for an asset such as `/assets/rails.png` it will grab it from disk at `/public/assets/rails.png` and serve it. The Rails server will never even sees the request.
+In the default Rails development environment assets are served through a middleware called [sprockets](https://github.com/sstephenson/sprockets). In production however most one-off Rails deployments will put their ruby server behind a reverse HTTP proxy server such as Nginx, which can then load balance the app and serve static files directly. When Nginx sees a request for an asset such as `/assets/rails.png` it will grab it from disk at `/public/assets/rails.png` and serve it. The Rails server will never see these requests.
 
-On Heroku, Nginx is not needed to run your application. Our [routing layer](https://devcenter.heroku.com/articles/http-routing) handles load balancing while you scale out horizontally. The caching behavior of Nginx is not needed if your application is serving static assets through an [edge caching CDN](https://en.wikipedia.org/wiki/Content_delivery_network).
+On a twelve-factor platform, Nginx is typically not required to run your application. Your app should be capable of handling requests directly, or through a [routing layer](https://devcenter.heroku.com/articles/http-routing) that may handles load balancing while you scale out horizontally. Note that the caching behavior of Nginx is not needed if your application is serving static assets through an [edge caching CDN](https://en.wikipedia.org/wiki/Content_delivery_network), which is generally recommended.
 
-By default Rails4 will return a 404 if an asset is not handled via an external proxy such as Nginx. While this default behavior will help you debug your Nginx configuration, it makes a default Rails app with assets unusable on Heroku. To fix this we've released a gem `rails_serve_static_assets`.
+By default Rails 4 will return a 404 if an asset is not handled via an external proxy such as Nginx. While this default behavior may help you debug your Nginx configuration, it makes a default Rails app with assets unusable on a twelve-factor platform. To fix this we've released a gem: `rails_serve_static_assets`.
 
-This gem, `rails_serve_static_assets`, enables your Rails server to deliver your assets instead of returning a 404. You can use this to populate an edge cache CDN, or serve files directly from your web app. This gives your app total control and allows you to do things like redirects, or setting headers in your Ruby code. To enable this behavior in your app we only need to set this one configuration option through this gem:
-
-```
-config.serve_static_assets = true
-```
+The `rails_serve_static_assets` gem enables your Rails server to deliver your assets directly, instead of returning a 404. You can use this to populate an edge cache CDN, or serve files directly from your web app. This gives your app total control, allowing you to do things like redirects or setting headers in your Ruby code. The gem achives this behavior in your app by simply setting a single configuration option, `config.serve_static_assets = true`. By using the `rails_serve_static_assets` gem, you do not need to set this configuration manually.
 
-Note: this gem will set this value for you, you don't need to change any configuration manually.
-
-All you need to do to get this functionality of both gems is add the `rails_12factor` gem to your project.
-
-## Why?
-
-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.
 
 
 ## 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.
-
+We will be working with Rails and the Rails core team to make future versions of Rails work on twelve-factor platforms out of the box. Until then you'll need to add this gem to your project.
 

data/lib/rails_12factor/version.rb

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

data/rails_12factor.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/rails_12factor/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Richard Schneeman", "Terence Lee"]
   gem.email         = ["richard@heroku.com", "terence@heroku.com"]
-  gem.description   = %q{Make Running Rails 4 on Heroku easier}
-  gem.summary       = %q{Configures your app to log to stdout and to serve assets in production.}
+  gem.description   = %q{Run Rails the 12factor way}
+  gem.summary       = %q{ Following best practices from http://12factor.net run a maintainable, clean, and scalable app on Rails}
   gem.homepage      = "https://github.com/heroku/rails_12factor"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_12factor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Richard Schneeman
@@ -39,7 +39,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Make Running Rails 4 on Heroku easier
+description: Run Rails the 12factor way
 email:
 - richard@heroku.com
 - terence@heroku.com
@@ -78,5 +78,6 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Configures your app to log to stdout and to serve assets in production.
+summary: Following best practices from http://12factor.net run a maintainable, clean,
+  and scalable app on Rails
 test_files: []