suspenders 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15e552d7d17ba6f3e6abcce8e48e7357f759b3d5
-  data.tar.gz: cf5e84b547ccc981b720be0e0db2a853836fa557
+  metadata.gz: b73d9dd152a7c46d51d98d0855f6d9386be74344
+  data.tar.gz: 17e0abffef3c289c9554a22a7faa896f30cb4b58
 SHA512:
-  metadata.gz: fc35351a500d302415077fcedc6809df78b8872c9988ba04c1b9cf1274f88063e412c0a20e84c9e56884ba409e19fb3967c7d3490152f36b38325eddcf632d89
-  data.tar.gz: f689a5d0f922bb1ffcc8f7e152ffa664ad1275ace7ed67abb9f13526be6bb2c28cdb7d2255ee5e1ed8b4ddb0d096830a96c7263e7e4a892aabb1638d8b2a864f
+  metadata.gz: 3545288487aafdea1f0a80f4ec51bca609962b5e69bf59a3096c9e8516bf5d640aa6bc9d3b9d033927e58fc0dc719107a3f378b1a13b7fb25fa2c156db5df678
+  data.tar.gz: add7e9af12cab579a0e9a7f638e0f3d99125348484a709003957031132c6c8b98095854e4199df130bb4b858fe61ff2ca65cc7e4683b4ddc94c7695a68d6a359

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    suspenders (1.11.0)
+    suspenders (1.12.0)
       bundler (~> 1.3)
       rails (~> 4.1.0)
 
@@ -120,7 +120,7 @@ GEM
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (1.1.0)
+    tzinfo (1.2.0)
       thread_safe (~> 0.1)
     xpath (2.0.0)
       nokogiri (~> 1.3)

data/NEWS.md

@@ -1,3 +1,16 @@
+1.12.0 (May 26, 2014)
+
+* Fix `rake dev:prime` now that Suspenders-generated apps require some `ENV`
+  variables to be set.
+* Ensure `EMAIL_RECIPIENTS` is set on staging.
+* Clear `ActionMailer` deliveries before every test.
+* Include New Relic configuration file.
+* Add Formulaic gem for integration testing HTML forms.
+* Set up the Segment.io adapter for analytics and event tracking through
+  services such as Google Analytics and Intercom.
+* Prepare staging and production environments to serve static assets through a
+  CDN.
+
 1.11.0 (May 17, 2014)
 
 * Generate a Rails 4.1.1 app and implement fixes for compatibility.

data/README.md

@@ -47,9 +47,9 @@ It includes application gems like:
   avoid accidentally sending emails to real people from staging
 * [Simple Form](https://github.com/plataformatec/simple_form) for form markup
   and style
-* [Unicorn](https://github.com/defunkt/unicorn) to serve HTTP requests
 * [Title](https://github.com/calebthompson/title) for storing titles in
   translations
+* [Unicorn](https://github.com/defunkt/unicorn) to serve HTTP requests
 
 And gems only for staging and production like:
 
@@ -70,6 +70,8 @@ And testing gems like:
   [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for
   integration testing
 * [Factory Girl](https://github.com/thoughtbot/factory_girl) for test data
+* [Formulaic](https://github.com/thoughtbot/formulaic) for integration testing
+  HTML forms
 * [RSpec](https://github.com/rspec/rspec) for unit testing
 * [RSpec Mocks](https://github.com/rspec/rspec-mocks) for stubbing and spying
 * [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) for common
@@ -92,6 +94,8 @@ Suspenders also comes with:
 * An automatically-created `SECRET_KEY_BASE` environment variable in all
   environments.
 * Configuration for [Travis Pro][travis] continuous integration.
+* The analytics adapter [Segment.io][segment] (and therefore config for Google
+  Analytics, Intercom, Facebook Ads, Twitter Ads, etc.).
 
 [bin]: http://robots.thoughtbot.com/bin-setup
 [compress]: http://robots.thoughtbot.com/content-compression-with-rack-deflater/
@@ -100,6 +104,7 @@ Suspenders also comes with:
 [binstub]: https://github.com/thoughtbot/suspenders/pull/282
 [i18n]: https://github.com/thoughtbot/suspenders/pull/304
 [travis]: http://docs.travis-ci.com/user/travis-pro/
+[segment]: https://segment.io
 
 Heroku
 ------

data/lib/suspenders/actions.rb

@@ -21,15 +21,5 @@ module Suspenders
         before: "\nend"
       )
     end
-
-    def download_file(uri_string, destination)
-      uri = URI.parse(uri_string)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true if uri_string =~ /^https/
-      request = Net::HTTP::Get.new(uri.path)
-      contents = http.request(request).body
-      path = File.join(destination_root, destination)
-      File.open(path, "w") { |file| file.write(contents) }
-    end
   end
 end

data/lib/suspenders/app_builder.rb

@@ -55,6 +55,10 @@ module Suspenders
       copy_file 'factory_girl_rspec.rb', 'spec/support/factory_girl.rb'
     end
 
+    def configure_newrelic
+      template 'newrelic.yml.erb', 'config/newrelic.yml'
+    end
+
     def configure_smtp
       copy_file 'smtp.rb', 'config/smtp.rb'
 
@@ -82,6 +86,20 @@ module Suspenders
         :after => "config.serve_static_assets = false\n"
     end
 
+    def setup_asset_host
+      replace_in_file 'config/environments/production.rb',
+        '# config.action_controller.asset_host = "http://assets.example.com"',
+        "config.action_controller.asset_host = ENV.fetch('ASSET_HOST')"
+
+      replace_in_file 'config/environments/production.rb',
+        "config.assets.version = '1.0'",
+        "config.assets.version = ENV.fetch('ASSETS_VERSION')"
+
+      replace_in_file 'config/environments/production.rb',
+        'config.serve_static_assets = false',
+        'config.static_cache_control = "public, max-age=#{1.year.to_i}"'
+    end
+
     def setup_staging_environment
       staging_file = 'config/environments/staging.rb'
       copy_file 'staging.rb', staging_file
@@ -174,6 +192,10 @@ end
       run 'rails g delayed_job:active_record'
     end
 
+    def configure_action_mailer_in_specs
+      copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb'
+    end
+
     def configure_time_zone
       config = <<-RUBY
     config.active_record.default_timezone = :utc
@@ -278,6 +300,11 @@ heroku join --app #{app_name}-production
       run "#{path_addition} hub create #{repo_name}"
     end
 
+    def setup_segment_io
+      copy_file '_analytics.html.erb',
+        'app/views/application/_analytics.html.erb'
+    end
+
     def copy_miscellaneous_files
       copy_file 'errors.rb', 'config/initializers/errors.rb'
     end

data/lib/suspenders/generators/app_generator.rb

@@ -38,6 +38,7 @@ module Suspenders
       invoke :setup_database
       invoke :create_heroku_apps
       invoke :create_github_repo
+      invoke :setup_segment_io
       invoke :outro
     end
 
@@ -81,12 +82,15 @@ module Suspenders
       build :configure_spec_support_features
       build :configure_travis
       build :configure_i18n_in_specs
+      build :configure_action_mailer_in_specs
     end
 
     def setup_production_environment
       say 'Setting up the production environment'
+      build :configure_newrelic
       build :configure_smtp
       build :enable_rack_deflater
+      build :setup_asset_host
     end
 
     def setup_staging_environment
@@ -154,6 +158,11 @@ module Suspenders
       end
     end
 
+    def setup_segment_io
+      say 'Setting up Segment.io'
+      build :setup_segment_io
+    end
+
     def setup_gitignore
       build :gitignore_files
     end

data/lib/suspenders/version.rb

@@ -1,4 +1,4 @@
 module Suspenders
   RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
-  VERSION = '1.11.0'
+  VERSION = '1.12.0'
 end

data/spec/features/new_project_spec.rb

@@ -16,6 +16,7 @@ feature 'Suspend a new project with default configuration' do
 
     staging_file = IO.read("#{project_path}/config/environments/staging.rb")
     config_stub = "Rails.application.configure do"
+
     expect(staging_file).to match(/^require_relative 'production'/)
     expect(staging_file).to match(/#{config_stub}/), staging_file
   end
@@ -24,6 +25,7 @@ feature 'Suspend a new project with default configuration' do
     run_suspenders
 
     ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
     expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
   end
 
@@ -31,6 +33,37 @@ feature 'Suspend a new project with default configuration' do
     run_suspenders
 
     secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
     expect(secrets_file).to match(/secret_key_base: <%= ENV\['SECRET_KEY_BASE'\] %>/)
   end
+
+
+  scenario 'action mailer support file is added' do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  scenario 'newrelic.yml reads NewRelic license from env' do
+    run_suspenders
+
+    newrelic_file = IO.read("#{project_path}/config/newrelic.yml")
+
+    expect(newrelic_file).to match(
+      /license_key: '<%= ENV\['NEW_RELIC_LICENSE_KEY'\] %>'/
+    )
+  end
+
+  scenario 'records pageviews through Segment.io if ENV variable set' do
+    run_suspenders
+
+    expect(analytics_partial).
+      to include("<% if ENV['SEGMENT_IO_KEY'] %>")
+    expect(analytics_partial).
+      to include("window.analytics.load('<%= ENV['SEGMENT_IO_KEY'] %>');")
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.erb")
+  end
 end

data/templates/Gemfile.erb

@@ -38,6 +38,7 @@ end
 group :test do
   gem 'capybara-webkit', '>= 1.0.0'
   gem 'database_cleaner'
+  gem 'formulaic'
   gem 'launchy'
   gem 'shoulda-matchers', require: false
   gem 'simplecov', require: false

data/templates/_analytics.html.erb

@@ -0,0 +1,7 @@
+<% if ENV['SEGMENT_IO_KEY'] %>
+  <script type="text/javascript">
+    window.analytics=window.analytics||[],window.analytics.methods=["identify","group","track","page","pageview","alias","ready","on","once","off","trackLink","trackForm","trackClick","trackSubmit"],window.analytics.factory=function(t){return function(){var a=Array.prototype.slice.call(arguments);return a.unshift(t),window.analytics.push(a),window.analytics}};for(var i=0;i<window.analytics.methods.length;i++){var key=window.analytics.methods[i];window.analytics[key]=window.analytics.factory(key)}window.analytics.load=function(t){if(!document.getElementById("analytics-js")){var a=document.createElement("script");a.type="text/javascript",a.id="analytics-js",a.async=!0,a.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.io/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n)}},window.analytics.SNIPPET_VERSION="2.0.9",
+    window.analytics.load('<%= ENV['SEGMENT_IO_KEY'] %>');
+    window.analytics.page();
+  </script>
+<% end %>

data/templates/_javascript.html.erb

@@ -2,6 +2,8 @@
 
 <%= yield :javascript %>
 
+<%= render 'analytics' %>
+
 <% if Rails.env.test? %>
   <%= javascript_tag do %>
     $.fx.off = true;

data/templates/action_mailer.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end

data/templates/bin_setup

@@ -9,17 +9,17 @@ set -e
 # Set up Ruby dependencies via Bundler
 bundle install
 
+# Set up configurable environment variables
+if [ ! -f .env ]; then
+  cp .sample.env .env
+fi
+
 # Set up database and add any development seed data
 bundle exec rake dev:prime
 
 # Add binstubs to PATH via export PATH=".git/safe/../../bin:$PATH" in ~/.zshenv
 mkdir -p .git/safe
 
-# Set up configurable environment variables
-if [ ! -f .env ]; then
-  cp .sample.env .env
-fi
-
 # Pick a port for Foreman
 echo "port: 7000" > .foreman
 

data/templates/newrelic.yml.erb

@@ -0,0 +1,34 @@
+common: &default_settings
+  app_name: '<%= app_name %>'
+  audit_log:
+    enabled: false
+  browser_monitoring:
+    auto_instrument: true
+  capture_params: false
+  developer_mode: false
+  error_collector:
+    capture_source: true
+    enabled: true
+    ignore_errors: 'ActionController::RoutingError,Sinatra::NotFound'
+  license_key: '<%%= ENV['NEW_RELIC_LICENSE_KEY'] %>'
+  log_level: info
+  monitor_mode: true
+  transaction_tracer:
+    enabled: true
+    record_sql: obfuscated
+    stack_trace_threshold: 0.500
+    transaction_threshold: apdex_f
+development:
+  <<: *default_settings
+  monitor_mode: false
+  developer_mode: true
+test:
+  <<: *default_settings
+  monitor_mode: false
+production:
+  <<: *default_settings
+  monitor_mode: true
+staging:
+  <<: *default_settings
+  app_name: '<%= app_name %> (Staging)'
+  monitor_mode: true

data/templates/spec_helper.rb

@@ -21,6 +21,8 @@ RSpec.configure do |config|
   end
 
   config.include Features, type: :feature
+  config.include Formulaic::Dsl, type: :feature
+
   config.infer_base_class_for_anonymous_controllers = false
   config.order = 'random'
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/templates/staging.rb

@@ -1,3 +1,5 @@
 require_relative 'production'
 
-Mail.register_interceptor RecipientInterceptor.new(ENV['EMAIL_RECIPIENTS'])
+Mail.register_interceptor(
+  RecipientInterceptor.new(ENV.fetch('EMAIL_RECIPIENTS'))
+)

data/templates/travis.yml.erb

@@ -27,3 +27,5 @@ notifications:
     - false
 rvm:
   - <%= Suspenders::RUBY_VERSION %>
+addons:
+  postgresql: "9.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suspenders
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - thoughtbot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-17 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,8 +139,10 @@ files:
 - templates/Gemfile.erb
 - templates/Procfile
 - templates/README.md.erb
+- templates/_analytics.html.erb
 - templates/_flashes.html.erb
 - templates/_javascript.html.erb
+- templates/action_mailer.rb
 - templates/application.css.scss
 - templates/background_jobs_rspec.rb
 - templates/bin_setup
@@ -151,6 +153,7 @@ files:
 - templates/errors.rb
 - templates/factory_girl_rspec.rb
 - templates/i18n.rb
+- templates/newrelic.yml.erb
 - templates/postgresql_database.yml.erb
 - templates/rack_timeout.rb
 - templates/sample.env