suspenders 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9143fdabbeb2429e35b159d7d05ebd723ca630f9
-  data.tar.gz: 3dda26b01f294506f39591fc5e9399fed50c3c4f
+  metadata.gz: 0f7d09cee5a10cf3cbe9b1aa85666f7d11085889
+  data.tar.gz: 1dfe58a3f0553599f33821571a5551883feebafc
 SHA512:
-  metadata.gz: 3728b65694bec8e195af833a2eaf0be99939c5e8d918e0d5f7eace2fa06ab5a435369542d5402d3d831e9b611f49888a8a5654476b6aa4f661a2865e91788338
-  data.tar.gz: 57fa6bab849dd3df3ee5af8c6173faeb0de308e12d65fc57dfdf15abab8b7031e41e49c6d05f7a087ca6da0cf4530c5d5b38e2808a7510a8f1b8d77201679a2a
+  metadata.gz: e9152f3b09f3c6b3613113faa1a78857b8dddd956af2e735fe3d953471bcca215fef056482cec2daacb8f0420047d25a18113ab6f8387aadeb447dbe84b1fb85
+  data.tar.gz: cd4d52db35d9e70931108c9a21f75f1dc66f2b38bab38ddb9891f03916dca84329997824af7315b6f2b3bd5c051dd39654273e1e5c62bb5693bccb681672bc55

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    suspenders (1.6.0)
+    suspenders (1.7.0)
       bundler (~> 1.3)
       rails (= 4.0.0)
 
@@ -56,7 +56,7 @@ GEM
     gherkin (2.12.0-x86-mingw32)
       multi_json (~> 1.3)
     hike (1.2.3)
-    i18n (0.6.5)
+    i18n (0.6.9)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)

data/NEWS.md

@@ -1,3 +1,12 @@
+1.7.0 (December 6, 2013)
+
+* Keep `db/schema.rb` under version control.
+* Fast-fail if any part of `bin/setup` fails.
+* Move secret key out of version control.
+* Create `.ruby-version` in generated applications.
+* Add placeholder modules and directories for feature specs.
+* Improve README to include setup instructions.
+
 1.6.0 (November 28, 2013)
 
 * Do not create `.rspec` file as the settings are not project-specific.
@@ -6,7 +15,7 @@
 * Add `--skip-git` option.
 * Disable jQuery animations in Rails integration tests that execute JavaScript.
 * Fix git remote bug.
-* Add `Rack::Timeout` to compress responses with Gzip.
+* Add `Rack::Deflater` to compress responses with Gzip.
 
 1.5.1 (September 10, 2013)
 

data/README.md

@@ -82,6 +82,16 @@ Suspenders also comes with:
 [compress]: http://robots.thoughtbot.com/content-compression-with-rack-deflater/
 [fast]: http://robots.thoughtbot.com/testing-your-factories-first
 
+Suspenders fixes several of Rails' [insecure defaults]:
+
+* Suspenders uses Unicorn instead of WEBrick, allowing less verbose Server
+  headers.
+* Suspenders is configured to pull your application secret key base from an
+  environment variable, which means you won't need to risk placing it in version
+  control.
+
+[insecure defaults]: http://blog.codeclimate.com/blog/2013/03/27/rails-insecure-defaults/
+
 Heroku
 ------
 

data/features/heroku_true.feature

@@ -7,3 +7,5 @@ Feature: Creating a Heroku app
       | --heroku | true  |
     Then the "test_project-staging" Heroku app should exist
     And the "test_project-production" Heroku app should exist
+    And the "staging" Heroku remote should have "SECRET_KEY_BASE" configured
+    And the "production" Heroku remote should have "SECRET_KEY_BASE" configured

data/features/rake_clean.feature

@@ -6,10 +6,39 @@ Feature: Rake works in the suspended project
   Scenario: Running rake in the suspended project
     When I suspend a project called "test_project"
     And I cd to the "test_project" root
+    And I obtain a fresh checkout
+    And I setup the project
     Then I can cleanly rake the project
 
-  Scenario: Making a spec then running rake
+  Scenario: Making a model spec then running rake
     When I suspend a project called "test_project"
     And I cd to the "test_project" root
+    And I obtain a fresh checkout
+    And I setup the project
     And I generate "model post title:string"
+    And I run migrations
     Then I can cleanly rake the project
+
+  Scenario: Making a feature spec then running rake
+    When I suspend a project called "test_project"
+    And I cd to the "test_project" root
+    And I obtain a fresh checkout
+    And I setup the project
+    And I write to "spec/features/example_spec.rb" with:
+      """
+      require 'spec_helper'
+
+      feature 'Example feature spec' do
+        scenario 'using a method from the Features module' do
+          expect(example_method).to eq('Expected Value')
+        end
+      end
+      """
+    And I write to "spec/support/features/example.rb" with:
+      """
+      module Features
+        def example_method
+          'Expected Value'
+        end
+      end
+      """

data/features/step_definitions/suspenders_steps.rb

@@ -6,6 +6,18 @@ When 'I run rake' do
   end
 end
 
+When 'I run migrations' do
+  in_current_dir do
+    run_simple 'bundle exec rake db:migrate'
+  end
+end
+
+When 'I obtain a fresh checkout' do
+  in_current_dir do
+    run_simple 'git clean --force -x -d'
+  end
+end
+
 When 'I run the rake task "$task_name"' do |task_name|
   in_current_dir do
     run_simple "bundle exec rake #{task_name}"
@@ -26,6 +38,10 @@ end
 When 'I suspend a project called "$project_name"' do |project_name|
   suspenders_bin = File.expand_path(File.join('..', '..', 'bin', 'suspenders'), File.dirname(__FILE__))
   run_simple "#{suspenders_bin} #{project_name}"
+  cd project_name
+  run_simple 'git add -A'
+  run_simple 'git commit -m "Initial commit"'
+  cd '..'
 end
 
 When %r{I suspend a project called "([^"]*)" with:} do |project_name, arguments_table|
@@ -40,12 +56,13 @@ When 'I cd to the "$test_project" root' do |dirname|
   cd dirname
 end
 
+When 'I setup the project' do
+  run_simple 'bin/setup'
+end
+
 Then 'I can cleanly rake the project' do
   steps %{
-    And I run the rake task "db:create"
-    And I run the rake task "db:migrate"
-    And I run the rake task "db:test:prepare"
-    And I run rake
+    When I run rake
   }
 end
 
@@ -63,6 +80,10 @@ Then %r{the "([^"]*)" Heroku app should exist} do |app_name|
   FakeHeroku.should have_created_app(app_name)
 end
 
+Then %r{the "([^"]+)" Heroku remote should have "([^"]+)" configured} do |remote_name, config_name|
+  FakeHeroku.configured_vars_for(remote_name).should include(config_name)
+end
+
 Then %r{the "([^"]*)" Github repo should exist} do |repo_name|
   FakeGithub.should have_created_repo(repo_name)
 end

data/features/support/fake_heroku.rb

@@ -7,7 +7,7 @@ class FakeHeroku
 
   def run!
     File.open(RECORDER, 'a') do |file|
-      file.write @args.join(' ')
+      file.puts @args.join(' ')
     end
   end
 
@@ -18,4 +18,13 @@ class FakeHeroku
   def self.has_created_app?(app_name)
     File.open(RECORDER, 'r').read.include?("create #{app_name}")
   end
+
+  def self.configured_vars_for(remote_name)
+    File.open(RECORDER, 'r').
+      each_line.
+      grep(/^config:add .* --remote=#{remote_name}/) { |line|
+        line.scan(/([A-Z_]+)=[^ ]*/)
+      }.
+      flatten
+  end
 end

data/lib/suspenders/app_builder.rb

@@ -98,6 +98,12 @@ module Suspenders
         "Mail.register_interceptor RecipientInterceptor.new(ENV['EMAIL_RECIPIENTS'])\n"
     end
 
+    def setup_secret_token
+      template 'secret_token.rb',
+        'config/initializers/secret_token.rb',
+        :force => true
+    end
+
     def create_partials_directory
       empty_directory 'app/views/application'
     end
@@ -132,7 +138,7 @@ module Suspenders
     end
 
     def create_database
-      bundle_command 'exec rake db:create'
+      bundle_command 'exec rake db:create db:migrate'
     end
 
     def replace_gemfile
@@ -143,12 +149,18 @@ module Suspenders
     def set_ruby_to_version_being_used
       inject_into_file 'Gemfile', "\n\nruby '#{RUBY_VERSION}'",
         after: /source 'https:\/\/rubygems.org'/
+      create_file '.ruby-version', "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}\n"
     end
 
     def enable_database_cleaner
       copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
     end
 
+    def configure_spec_support_features
+      empty_directory_with_keep_file 'spec/features'
+      empty_directory_with_keep_file 'spec/support/features'
+    end
+
     def configure_rspec
       remove_file 'spec/spec_helper.rb'
       copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
@@ -250,6 +262,12 @@ git remote add production git@heroku.com:#{app_name}-production.git
       append_file 'bin/setup', remotes
     end
 
+    def set_heroku_rails_secrets
+      path_addition = override_path_for_tests
+      run "#{path_addition} heroku config:add SECRET_KEY_BASE=#{generate_secret} --remote=staging"
+      run "#{path_addition} heroku config:add SECRET_KEY_BASE=#{generate_secret} --remote=production"
+    end
+
     def create_github_repo(repo_name)
       path_addition = override_path_for_tests
       run "#{path_addition} hub create #{repo_name}"
@@ -299,5 +317,9 @@ git remote add production git@heroku.com:#{app_name}-production.git
     def factories_spec_rake_task
       IO.read find_in_source_paths('factories_spec_rake_task.rb')
     end
+
+    def generate_secret
+      SecureRandom.hex(64)
+    end
   end
 end

data/lib/suspenders/generators/app_generator.rb

@@ -23,11 +23,11 @@ module Suspenders
     def suspenders_customization
       invoke :remove_files_we_dont_need
       invoke :customize_gemfile
-      invoke :setup_database
       invoke :setup_development_environment
       invoke :setup_test_environment
       invoke :setup_production_environment
       invoke :setup_staging_environment
+      invoke :setup_secret_token
       invoke :create_suspenders_views
       invoke :setup_coffeescript
       invoke :configure_app
@@ -36,6 +36,7 @@ module Suspenders
       invoke :customize_error_pages
       invoke :remove_routes_comment_lines
       invoke :setup_git
+      invoke :setup_database
       invoke :create_heroku_apps
       invoke :create_github_repo
       invoke :outro
@@ -79,7 +80,7 @@ module Suspenders
       build :use_rspec_binstub
       build :configure_background_jobs_for_rspec
       build :enable_database_cleaner
-      build :configure_capybara_webkit
+      build :configure_spec_support_features
     end
 
     def setup_production_environment
@@ -93,6 +94,11 @@ module Suspenders
       build :setup_staging_environment
     end
 
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
     def create_suspenders_views
       say 'Creating suspenders views'
       build :create_partials_directory
@@ -139,6 +145,7 @@ module Suspenders
         say 'Creating Heroku apps'
         build :create_heroku_apps
         build :set_heroku_remotes
+        build :set_heroku_rails_secrets
       end
     end
 

data/lib/suspenders/version.rb

@@ -1,3 +1,3 @@
 module Suspenders
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/templates/README.md.erb

@@ -1,5 +1,21 @@
-You look great in Suspenders
-============================
+<%= app_name.humanize %>
+<%= '=' * app_name.humanize.length %>
+
+Getting Started
+---------------
+
+This repository comes equipped with a self-setup script!
+
+    % ./bin/setup
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+[foreman]: http://ddollar.github.io/foreman/
+
+Guidelines
+----------
 
 Use the following guides for getting things done, programming well, and
 programming in style.

data/templates/bin_setup

@@ -3,6 +3,9 @@
 # Set up Rails app. Run this script immediately after cloning the codebase.
 # https://github.com/thoughtbot/guides/tree/master/protocol
 
+# Exit if any subcommand fails
+set -e
+
 # Set up Ruby dependencies via Bundler
 bundle install
 

data/templates/sample.env

@@ -1,2 +1,3 @@
 # http://ddollar.github.com/foreman/
 RACK_ENV=development
+SECRET_KEY_BASE=development_secret

data/templates/secret_token.rb

@@ -0,0 +1,10 @@
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+<%= app_const %>.config.secret_key_base = ENV['SECRET_KEY_BASE']

data/templates/spec_helper.rb

@@ -10,12 +10,17 @@ require 'webmock/rspec'
 
 Dir[Rails.root.join('spec/support/**/*.rb')].each { |file| require file }
 
+module Features
+  # Extend this module in spec/support/features/*.rb
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
 
   config.fail_fast = true
+  config.include Features, type: :feature
   config.infer_base_class_for_anonymous_controllers = false
   config.order = 'random'
   config.use_transactional_fixtures = false

data/templates/suspenders_gitignore

@@ -6,7 +6,6 @@
 .sass-cache/
 coverage/*
 db/*.sqlite3
-db/schema.rb
 log/*
 public/system
 rerun.txt

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suspenders
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - thoughtbot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - templates/postgresql_database.yml.erb
 - templates/rack_timeout.rb
 - templates/sample.env
+- templates/secret_token.rb
 - templates/smtp.rb
 - templates/spec_helper.rb
 - templates/suspenders_gitignore
@@ -147,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Generate a Rails app using thoughtbot's best practices.