suspenders 0.3.4 → 0.3.5

data/Gemfile.lock

@@ -1,38 +1,38 @@
 PATH
   remote: .
   specs:
-    suspenders (0.3.3)
+    suspenders (0.3.4)
       bundler (>= 1.1)
-      rails (= 3.2.3)
+      rails (= 3.2.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.3)
-      actionpack (= 3.2.3)
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
       mail (~> 2.4.4)
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.1)
       rack (~> 1.4.0)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
       builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-    activesupport (3.2.3)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
@@ -57,14 +57,14 @@ GEM
       json (>= 1.4.6)
     hike (1.2.1)
     i18n (0.6.0)
-    journey (1.0.3)
+    journey (1.0.4)
     json (1.6.6)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.18)
-    multi_json (1.2.0)
+    multi_json (1.3.6)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -73,21 +73,21 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.2.3)
-      actionmailer (= 3.2.3)
-      actionpack (= 3.2.3)
-      activerecord (= 3.2.3)
-      activeresource (= 3.2.3)
-      activesupport (= 3.2.3)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
       bundler (~> 1.0)
-      railties (= 3.2.3)
-    railties (3.2.3)
-      actionpack (= 3.2.3)
-      activesupport (= 3.2.3)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.6)
+      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -99,17 +99,17 @@ GEM
     rspec-expectations (2.9.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
-    sprockets (2.1.2)
+    sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     term-ansicolor (1.0.7)
-    thor (0.14.6)
+    thor (0.15.2)
     tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.32)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby

data/README.md

@@ -83,7 +83,7 @@ If you're running OS X, we recommend the [GCC OSX installer](https://github.com/
 We use [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for full-stack Javascript integration testing.
 It requires you have QT installed on your machine before running Suspenders.
 
-Instructions for installing QT on most systems are [available here](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-QT).
+Instructions for installing QT on most systems are [available here](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit).
 
 PostgreSQL needs to be installed and running for the `db:create` rake task.
 

data/lib/suspenders/app_builder.rb

@@ -18,6 +18,11 @@ module Suspenders
       replace_in_file "config/environments/development.rb", "raise_delivery_errors = false", "raise_delivery_errors = true"
     end
 
+    def enable_factory_girl_syntax
+      copy_file "factory_girl_syntax_rspec.rb", "spec/support/factory_girl.rb"
+      copy_file "factory_girl_syntax_cucumber.rb", "features/support/factory_girl.rb"
+    end
+
     def setup_staging_environment
       run "cp config/environments/production.rb config/environments/staging.rb"
     end

data/lib/suspenders/generators/app_generator.rb

@@ -48,6 +48,7 @@ module Suspenders
     def setup_development_environment
       say "Setting up the development environment"
       build(:raise_delivery_errors)
+      build(:enable_factory_girl_syntax)
     end
 
     def setup_staging_environment

data/lib/suspenders/version.rb

@@ -1,3 +1,3 @@
 module Suspenders
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

data/suspenders.gemspec

@@ -27,7 +27,7 @@ rush to build something amazing; don't use it if you like missing deadlines.
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md LICENSE]
 
-  s.add_dependency('rails', '3.2.3')
+  s.add_dependency('rails', '3.2.6')
   s.add_dependency('bundler', '>= 1.1')
 
   s.add_development_dependency('cucumber', '~> 1.1.9')

data/templates/Gemfile_additions

@@ -9,25 +9,25 @@ gem 'copycopter_client'
 gem 'airbrake'
 
 group :development do
-  gem "heroku"
+  gem 'heroku'
 end
 
 group :development, :test do
-  gem "rspec-rails", "~> 2.9.0"
-  gem "ruby-debug19"
-  gem "sham_rack"
+  gem 'rspec-rails', '~> 2.9.0'
+  gem 'ruby-debug19'
+  gem 'sham_rack'
 end
 
 group :test do
-  gem "cucumber-rails", "1.3.0"
-  gem "capybara-webkit", "~> 0.11.0"
-  gem "factory_girl_rails"
-  gem "bourne"
-  gem "database_cleaner"
-  gem "timecop"
-  gem "shoulda-matchers"
-  gem "launchy"
-  gem "email_spec"
+  gem 'cucumber-rails', '1.3.0'
+  gem 'capybara-webkit', '~> 0.11.0'
+  gem 'factory_girl_rails'
+  gem 'bourne'
+  gem 'database_cleaner'
+  gem 'timecop'
+  gem 'shoulda-matchers'
+  gem 'launchy'
+  gem 'email_spec'
 end
 
 group :staging, :production do

data/templates/README.md.erb

@@ -0,0 +1,316 @@
+Rails app
+=========
+
+Rails 3.1 app running on Ruby 1.9.2 and deployed to Heroku's Cedar
+stack. It has an RSpec and Cucumber test suite which should be run
+before committing to the master branch.
+
+OS X preparation
+----------------
+
+Postgres:
+
+    brew install postgres --no-python
+
+Install Qt:
+
+    brew install qt
+
+Debian preparation
+------------------
+
+Install Qt:
+
+    sudo apt-get install libqt4-dev libqtwebkit-dev
+
+Laptop setup
+------------
+
+Getting the code:
+
+    git clone git@github.com:<account>/<repo>.git
+
+Setting up Ruby:
+
+    rvm install 1.9.2
+    rvm use 1.9.2 --default
+    gem install bundler git_remote_branch heroku taps
+
+App:
+
+    cd app
+    bundle --binstubs
+    rake db:create
+    rake db:schema:load
+
+Configuration
+-------------
+
+Install the Heroku config plugin:
+
+    heroku plugins:install git://github.com/ddollar/heroku-config.git
+
+Pull the Heroku config from staging:
+
+    heroku config:pull --remote staging
+
+You'll see credentials as config vars. Delete lines that don't apply.
+
+Running tests
+-------------
+
+Run the whole test suite with:
+
+    rake
+
+Run individual features:
+
+    cucumber features/visitor_signs_in.feature
+
+Run individual specs:
+
+    rspec spec/models/user_spec.rb
+
+Tab complete to make it even faster!
+
+When a spec or feature file has many specs in them, you sometimes want to run just what you're working on. In that case, specify a line number:
+
+    rspec spec/models/user_spec.rb:8
+    cucumber features/visitor_signs_in.feature:105
+
+Development process
+-------------------
+
+Choose a Github Issue.
+
+Create a local feature branch off of master for development.
+
+    git checkout master
+    git pull
+    git checkout -b 123-feature-xyz
+
+Do work in your feature branch and commit the changes.
+
+    git add -A
+    git status
+    git commit
+
+Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+    [#123] Summary of changes
+
+    * More information about commit
+    * More information about commit
+
+A good commit message:
+
+* Prefixes the subject line with a Github Issue number.
+* Uses the present tense.
+
+Share your feature branch
+
+    git push origin [branch]
+
+Rebase frequently to incorporate upstream changes.
+
+    git checkout master
+    git pull
+    git checkout [branch]
+    git rebase master
+    <resolve conflicts>
+
+Interactive rebase (squash) your commits (if necessary).
+
+    git rebase -i master
+
+At this point the automated test suite must pass, and it must work and look good in your browser.
+
+Merge your branch back to master and push your changes.
+
+    git checkout master
+    git diff --stat master [branch]
+    git merge [branch] --ff-only
+    git push origin master
+
+Delete your remote feature branch.
+
+    git push origin :[branch]
+
+Delete your local feature branch.
+
+    git branch -d [branch]
+
+Close Github Issue.
+
+Deploying
+---------
+
+Periodically use [pgbackups](http://devcenter.heroku.com/articles/pgbackups) to pull latest production data.
+
+Merge master into staging
+
+    git checkout master
+    git reset --hard origin/master
+    git pull
+    git checkout staging
+    git reset --hard origin/staging
+    git log staging..master
+    git diff --stat staging master
+    git merge master
+    git push origin staging
+
+Enable maintenance mode if required by database changes
+
+    heroku maintenance:on --app <%= app_name %>
+
+Deploy staging to Heroku
+
+    git push <%= app_name %> staging:master
+
+Run new migrations if necessary
+
+    heroku rake db:migrate --app <%= app_name %>
+
+Restart the dynos if migrations were run
+
+    heroku restart --app <%= app_name %>
+
+Disable maintenance mode if it's on
+
+    heroku maintenance:off --app <%= app_name %>
+
+[Introspect](http://blog.heroku.com/archives/2011/6/24/the_new_heroku_3_visibility_introspection/) to make sure everything's OK
+
+    watch heroku ps --app <%= app_name %>
+
+[Rollback](http://devcenter.heroku.com/articles/releases) code if there was a problem
+
+Production is the same:
+
+* Use pgbackups to capture a DB backup
+* Merge staging into production
+* Enable maintenance mode if required by database changes
+* Deploy production to Heroku
+* Run new migrations if necessary
+* Restart dynos if migrations were run
+* Rollback code and use pgbackups to restore if there was a problem (turn on maintenance mode first if not already enabled)
+* Disable maintenance mode if it's on
+* Introspect to make sure everything's OK.
+
+Heroku
+------
+
+To access data on Heroku:
+
+    heroku console --app <%= app_name %>
+
+That will give you a Rails console. Run ActiveRecord queries from there.
+
+To run a rake task on Heroku:
+
+    heroku rake db:migrate --app <%= app_name %>
+
+Any rake task can be run with `heroku rake ...`
+
+To dump staging or production data into your development environment:
+
+    heroku db:pull --app <%= app_name %>
+
+You will see progress bars for each DB index and table.
+
+We can create a database backup at any time:
+
+    heroku pgbackups:capture --app <%= app_name %> --expire
+
+View backups:
+
+    heroku pgbackups --app <%= app_name %>
+
+To destroy a backup:
+
+    heroku pgbackups:destroy b003 --app <%= app_name %>
+
+Transfer production data to staging:
+
+    heroku pgbackups:capture --app <%= app_name %> --expire
+    heroku pgbackups:restore DATABASE `heroku pgbackups:url --app <%= app_name %>` --app <%= app_name %>-staging
+
+More information in the [Dev Center](http://devcenter.heroku.com/articles/pgbackups).
+
+To check the status of running app servers, background jobs, cron jobs, etc:
+
+    heroku ps --app <%= app_name %>
+
+Programming
+-----------
+
+We use [the thoughtbot style guide](http://build.thoughtbot.com/style-guide/) on this project. As of April 9, 2012:
+
+Formatting
+----------
+
+* Use 2 spaces for indentation. Don't use tabs.
+* In ERb files, indent both Ruby and HTML.
+* Include parenthesis in method definitions that take arguments.
+* Do not include parenthesis in method definitions that don't take arguments.
+* Do not use an empty line at the beginning or end of methods, blocks or conditionals.
+* Use an empty line between methods, blocks and conditionals.
+* Don't line up assignments, arguments, or hash properties.
+* In Javascript, keep curly braces on the same line as an opening function, if, or other block.
+* Break up longer statements into multiple lines or methods. Most developers have editors at or below 120 columns.
+* If a single statement is split over several lines, indent all but the first line of the statement.
+
+Conditions
+----------
+
+* Ternaries are harder to read than an if/else. Use an if/else.
+* Prefer `if` with positive conditions over `unless`.
+* Prefer `unless` over `if not`.
+
+Ruby Conventions
+----------------
+
+* Define class methods using `def self.method` rather than `class << self` blocks.
+* Use curly braces for one-line blocks and `do`..`end` for multi-line blocks.
+* Prefer `&&` and `||` over `and` and `or`.
+* Use `each` instead of `for`.
+* Constants are all uppercase: CONSTANTS
+* Class and module names are camelcase: ClassNames
+* Method and variable names are underscored: `method_and_local_variables`
+* Methods that ask a question end in a question mark: asks_a_yes_no_question?
+* Mutating versions of methods end in an exclaimation point: gsub! for gsub
+* Exception-raising versions of methods end in an exclaimation point: save! for save
+* Always include a blank line before access specifiers like protected, public, and private.
+* Indent access specifiers equal to method definitions.
+* Indent protected and private methods equal to public methods.
+
+Javascript and Coffeescript Conventions
+---------------------------------------
+
+* Constants are all uppercase: CONSTANTS
+* Prototype names are camel case: ClassNames
+* Function and variable names are camel case after the first letter: `functionAndVariableNames`
+* Internal functions and variable names start with an underscore: `_internalVariables`
+* Define functions that operate on the window or DOM in the scope of the window.
+* Initialize empty objects and hashes using `{}`.
+* Initialize arrays using `[]`.
+* Extending the base classes by adding functions onto their prototypes is acceptable.
+
+Naming
+------
+
+* Reveal intent.
+* Be consistent.
+* Use verbs and nouns appropriately.
+* Name the enumeration parameter the singular of the collection.
+* Avoid one-letter variable names.
+* Avoid hungarian notiation or type information in names (for example, `szName` or `user_array`).
+
+General Best Practices
+----------------------
+
+* Prefer short methods. One line is best.
+* Avoid [Feature Envy](http://c2.com/cgi/wiki?FeatureEnvySmell). Tell, don't ask.
+* Exceptions should be exceptional.
+* Don't swallow exceptions or "fail silently".
+* Prefer readable code over comments.

data/templates/factory_girl_syntax_cucumber.rb

@@ -0,0 +1 @@
+World(FactoryGirl::Syntax::Methods)

data/templates/factory_girl_syntax_rspec.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/templates/suspenders_layout.html.erb.erb

@@ -8,13 +8,13 @@
   <%%= csrf_meta_tags %>
 </head>
 <body class="<%%= body_class %>">
-  <div id="header">
+  <header>
     <%% if signed_in? -%>
       <%%= link_to "Sign out", sign_out_path, :method => :delete %>
     <%% else -%>
       <%%= link_to "Sign in", sign_in_path %>
     <%% end -%>
-  </div>
+  </header>
   <%%= render 'shared/flashes' -%>
   <%%= yield %>
   <%%= render 'shared/javascript' %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suspenders
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 3.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 3.2.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -115,12 +115,14 @@ files:
 - templates/Gemfile_additions
 - templates/HEROKU_README.md
 - templates/Procfile
-- templates/README.md
+- templates/README.md.erb
 - templates/_flashes.html.erb
 - templates/_javascript.html.erb
 - templates/email_validator.rb
 - templates/errors.rb
 - templates/factory_girl_steps.rb
+- templates/factory_girl_syntax_cucumber.rb
+- templates/factory_girl_syntax_rspec.rb
 - templates/import_scss_styles
 - templates/javascripts/prefilled_input.js
 - templates/postgresql_database.yml.erb
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Generate a Rails app using thoughtbot's best practices.

data/templates/README.md

@@ -1,81 +0,0 @@
-Rails app
-=========
-
-This is a Rails 3.1 app running on Ruby 1.9.2 and deployed to Heroku's Cedar stack. It has an RSpec and Cucumber test suite which should be run before commiting to the master branch.
-
-Laptop setup
-------------
-
-Use our laptop script to get Homebrew, Postgres, Redis, RVM, Ruby 1.9.2, and Bundler:
-
-    https://github.com/thoughtbot/laptop
-
-Use our dotfiles to get commands like `git up` and `git down` for a clean git history:
-
-    https://github.com/thoughtbot/dotfiles
-
-Get the code:
-
-    git clone git@github.com:your-account/your-app.git
-
-Set up the app:
-
-    cd your-app
-    bundle
-    bake db:create
-    bake db:migrate
-
-Running tests
--------------
-
-Run the whole test suite with:
-
-    bake
-
-Run individual specs like:
-
-    s spec/models/user_spec.rb
-
-Run individual features like:
-
-    cuc features/visitor_signs_in.feature
-
-Tab complete to make it even faster!
-
-When a spec or feature file has many specs in them, you sometimes want to run just what you're working on. In that case, specify a line number:
-
-    s spec/models/user_spec.rb:8
-    cuc features/visitor_signs_in.feature:105
-
-Development process
--------------------
-
-To run the app in development mode, use Foreman, which was installed from the `laptop` script:
-
-    foreman start
-
-It will pick up on the Procfile and use Thin as the app server instead of Webrick, which will also be used by Heroku's Cedar stack.
-
-    git pull --rebase
-    grb create feature-branch
-    bake
-
-This creates a new branch for your feature. Name it something relevant. Run the tests to make sure everything's passing. Then, implement the feature.
-
-    bake
-    git add -A
-    git commit -m "my awesome feature"
-    git push origin feature-branch
-
-Open up the Github repo, change into your feature-branch branch. Press the "Pull request" button. It should automatically choose the commits that are different between master and your feature-branch. Create a pull request and share the link in Campfire with the team. When someone else gives you the thumbs-up, you can merge into master:
-
-    git up
-    git down
-    git push origin master
-
-For more details and screenshots of the feature branch code review process, read [this blog post](http://robots.thoughtbot.com/post/2831837714/feature-branch-code-reviews).
-
-Most importantly
-----------------
-
-Have fun!