raygun 0.0.16 → 0.0.17

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.0.17 [2013-01-17]
+
+* Configure .rbenv-version, .rvmrc, and Gemfile with the version of ruby used to execute raygun.
+* Improve the detfault email content.
+* Improve the raygun and app_prototype READMEs.
+* Use $PORT to set the server port for Heroku compatibility, with default set in .env.
+* .ruby-version instead of .rbenv-version (as recommended by rbenv).
+* Add a unique database constraint on users.email.
+
 ## 0.0.16 [2013-01-04]
 
 * Improved authorization rules so that users can't delete themselves and non-admin can't access users controller :new.

data/README.md

@@ -3,7 +3,7 @@
 # Raygun
 
 Rails application generator that builds a new project skeleton configured with Carbon Five preferences and
-best practices baked right in. Spend less time configuring stuff and more building cool stuff.
+best practices baked right in. Spend less time configuring and more building cool features.
 
 Major tools/libraries:
 
@@ -17,9 +17,13 @@ Major tools/libraries:
 * RSpec
 * Factory Girl
 * Jasmine
+* SimpleCov
 * Guard (rspec, jasmine, livereload)
+* And many tweaks, patterns and common recipes.
 
-And many tweaks, patterns and common recipes.
+Raygun includes generator templates for controllers, views, and specs so that generated code follows best
+practices. For example, view generation produces bootstrap compatible markup and rspec specs use factory
+girl when appropriate.
 
 Inspired by Xavier Shay and ThoughtBot's Suspenders. Thanks!
 
@@ -27,9 +31,10 @@ Inspired by Xavier Shay and ThoughtBot's Suspenders. Thanks!
 
 Raygun...
 
-* should generate a new rails application that's ready for feature development immediately.
-* should generate an application that has best practices that apply to most projects baked in.
-* is a forum for discussing what should or should not be included as part of a standard stack.
+* Generates a new rails application that's ready for immediate feature development.
+* Generates an application that has best practices that apply to most projects baked in.
+* Generates an application that includes specs for all build in functionality.
+* Is a forum for discussing what should or should not be included as part of a standard stack.
 
 ## Installation
 
@@ -37,19 +42,22 @@ Raygun...
 
 ## Prerequisites
 
-Be sure you met these requirements before using raygun, otherwise you won't make it very far (misfire!).
+To generate an application, you only need the raygun gem.
+
+To run your new application's specs or fire up its server, you'll need to meet these requirements.
 
-* Ruby 1.9.3-p327 (rvm and rbenv supported)
 * PostgreSQL 9.x with superuser 'postgres' with no password (```createuser -s postgres```)
 * PhantomJS for JavaScript testing (```brew install phantomjs```)
 
-If you're using another ruby, just change the Gemfile, .rvmrc and/or .rbenv as necessary before running bundle.
+The generated app will be configured to use the ruby version that was used to invoke raygun. If you're using
+another ruby, just change the ```Gemfile```, ```.rvmrc``` and/or ```.rbenv-version``` as necessary.
 
 ## Usage
 
     $ raygun your-project
 
-Once your project is baked out, you can easily kick the wheels:
+Once your project is baked out, you can easily kick the wheels. Be sure that you have the prerequities
+covered (see above).
 
     $ cd your-project
     $ gem install bundler
@@ -77,7 +85,7 @@ Once your project is baked out, you can easily kick the wheels:
 
 Generate an example app using your local development version of raygun:
 
-    ./bin/raygun tmp/example_app
+    $ ./bin/raygun tmp/example_app
 
 ## Changes
 

data/TODO.md

@@ -3,11 +3,8 @@
 Looking for inspiration? Here are some ideas for things that still could be done. Don't forget to check the open issus too.
 
 * Automated testing of raygun (e.g. generate an app and run its specs?)
-* Raygun on CI
 * Invite user flow
-* Use cancan to allow users to edit only themselves and admins to edit any user
 * Continue to improve bootstrap view templates
-* CSS/less best practices for file organization
 * JS/coffeescript best practices
 * Add pagination to the default index scaffold (kaminari)
 * Use foreigner for database constraints

data/app_prototype/.env

@@ -0,0 +1,6 @@
+# Set environment variables needed for development here. These values will be
+# used unless they're already set.
+#
+# http://ddollar.github.com/foreman/#ENVIRONMENT
+
+PORT=3000

data/app_prototype/.gitignore

@@ -6,6 +6,7 @@
 
 # Ignore bundler config
 /.bundle
+/gem_graph.png
 
 # Ignore the default SQLite database
 /db/*.sqlite3

data/app_prototype/.rvmrc

@@ -1 +1 @@
-rvm use ruby-1.9.3-p327@app_prototype --create
+rvm use ruby-1.9.3-p327@app-prototype --create

data/app_prototype/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 ruby '1.9.3'
 
 gem 'thin'
-gem 'rails', '~> 3.2.9'
+gem 'rails', '~> 3.2.11'
 gem 'slim-rails'
 gem 'jquery-rails'
 gem 'sorcery'
@@ -20,12 +20,15 @@ group :assets do
   gem 'less-rails-bootstrap'
   gem 'coffee-rails'
   gem 'uglifier'
-  gem 'therubyracer', platforms: :ruby
+
+  # Heroku suggests that these gems aren't necessary, but they're required to compile less assets on deploy.
+  gem 'therubyracer'
+  gem 'libv8', '~> 3.11.8'
 end
 
 group :test, :development do
   gem 'rspec-rails', '~> 2.12.0'
-  gem 'capybara', github: 'jnicklas/capybara' # Switch from github once issue #882 is resolved.
+  gem 'capybara', '~> 2.0'
   gem 'capybara-email'
   gem 'factory_girl_rails'
   gem 'jasminerice'

data/app_prototype/Procfile

@@ -1 +1,2 @@
-web: rails server -p 3000
+web:    rails server -p $PORT
+#worker: bundle exec rake jobs:work

data/app_prototype/README.md

@@ -1,31 +1,58 @@
-Overview
-========
+# App Prototype
 
 ...
 
-Requirements
-============
+Generated with [Raygun](https://github.com/carbonfive/raygun).
 
-* ruby 1.9.3-p327
-* postgresql 9.? (user 'postgres' with no password)
+# Requirements
 
-Running the Specs
-=================
+To run the specs or fire up the server, be sure you have these:
 
-$ rake db:setup db:test:prepare
-$ rake
+* Ruby 1.9.3-p327
+* PostgreSQL 9.x with superuser 'postgres' with no password (```createuser -s postgres```)
+* PhantomJS for JavaScript testing (```brew install phantomjs```)
 
-Running the Application
-=======================
+# Development
 
-$ foreman start
+### First Time Setup
 
-Using Guard
-===========
+After cloning, run these commands to install missing gems and prepare the database.
 
-$ bundle exec guard -c
+    $ gem install bundler
+    $ bundle update
+    $ rake db:setup db:sample_data
 
-Considerations
-==============
+Note, ```rake db:sample_data``` loads a small set of data for development. Check out ```db/sample_data.rb``` for details.
+
+### Running the Specs
+
+To run all ruby and jasmine specs.
+
+    $ rake
+
+Again, with coverage for the ruby specs:
+
+    $ rake spec:coverage
+
+### Running the Application Locally
+
+    $ foreman start
+    $ open http://0.0.0.0:3000"
+
+### Using Guard
+
+Guard is configured to run ruby and jasmine specs, and also listen for livereload connections. Growl is used for notifications.
+
+    $ bundle exec guard
+
+### Deploying to Heroku
+
+Install the heroku toolbelt if you don't already have it (https://toolbelt.heroku.com/).
+
+    $ heroku apps:create app-prototype
+    $ git push heroku master
+    $ heroku run rake db:setup
+
+# Considerations
 
 ...

data/app_prototype/app/assets/stylesheets/_navbar.less

@@ -0,0 +1,5 @@
+// Navbar
+
+.wrapper > .container {
+  padding-top: 60px; // Push the content down so that it's below our pinned navbar.
+}

data/app_prototype/app/assets/stylesheets/application.css.less

@@ -1,8 +1,3 @@
 @import 'twitter/bootstrap';
+@import '_navbar';
 @import '_footer';
-
-// Navbar
-
-.wrapper > .container {
-  padding-top: 60px; // Push the content down so that it's below our pinned navbar.
-}

data/app_prototype/app/controllers/users_controller.rb

@@ -20,17 +20,17 @@ class UsersController < ApplicationController
     @user = User.new(params[:user])
 
     if @user.save
-      redirect_to @user, notice: 'User was successfully created.'
+      redirect_to @user, notice: "User was successfully created."
     else
-      render action: "new"
+      render action: 'new'
     end
   end
 
   def update
     if @user.update_attributes(params[:user])
-      redirect_to @user, notice: 'User was successfully updated.'
+      redirect_to @user, notice: "User was successfully updated."
     else
-      render action: "edit"
+      render action: 'edit'
     end
   end
 

data/app_prototype/app/models/user.rb

@@ -1,6 +1,6 @@
 class User < ActiveRecord::Base
 
-  attr_accessible :name, :email, :password, :password_confirmation
+  attr_accessible :name, :email, :password
 
   authenticates_with_sorcery!
 

data/app_prototype/app/views/layouts/application.html.slim

@@ -33,4 +33,4 @@ html
 
     footer
       .container
-        p © 2012 All rights reserved.
+        p © 2013 All rights reserved.

data/app_prototype/app/views/user_mailer/activation_needed_email.html.erb

@@ -4,9 +4,9 @@
     <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
   </head>
   <body>
-    <h1>Welcome to example.com, <%= @user.email %></h1>
+    <h1>Welcome to App Prototype, <%= @user.email %></h1>
     <p>
-      You have successfully signed up to example.com,
+      You have successfully signed up to app-prototype.herokuapp.com,
       your username is: <%= @user.email %>.<br/>
     </p>
     <p>

data/app_prototype/app/views/user_mailer/activation_needed_email.text.erb

@@ -1,7 +1,7 @@
-Welcome to example.com, <%= @user.email %>
+Welcome to App Prototype, <%= @user.email %>!
 ===============================================
  
-You have successfully signed up to example.com,
+You have successfully signed up to app-prototype.herokuapp.com,
 your username is: <%= @user.email %>.
  
 To login to the site, just follow this link: <%= activation_url(@user.activation_token) %>

data/app_prototype/app/views/user_mailer/activation_success_email.html.erb

@@ -4,13 +4,13 @@
     <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
   </head>
   <body>
-    <h1>Congratz, <%= @user.email %></h1>
+    <h1>Congratulations, <%= @user.email %>!</h1>
     <p>
-      You have successfully activated your example.com account,
+      You have successfully activated your App Prototype account,
       your username is: <%= @user.email %>.<br/>
     </p>
     <p>
-      To login to the site, just follow this link: <%= link_to sign_in_url, sign_in_url %>.
+      <%= link_to "Sign In Now", sign_in_url %>.
     </p>
     <p>Thanks for joining and have a great day!</p>
   </body>

data/app_prototype/app/views/user_mailer/activation_success_email.text.erb

@@ -1,9 +1,9 @@
-Congratz, <%= @user.email %>
+Congratulations, <%= @user.email %>!
 ===============================================
  
-You have successfully activated your example.com account,
+You have successfully activated your App Prototype account,
 your username is: <%= @user.email %>.
  
-To login to the site, just follow this link: <%= sign_in_url %>
+Go ahead and sign in to the site: <%= sign_in_url %>
  
 Thanks for joining and have a great day!

data/app_prototype/app/views/user_mailer/reset_password_email.html.erb

@@ -6,10 +6,10 @@
   <body>
     <h1>Hello, <%= @user.email %></h1>
     <p>
-      You have requested to reset your password.
+      Someone requested to reset your password. If it wasn't you, just disregard this email.
     </p>
     <p>
-      To choose a new password, just follow this link: <%= link_to reset_password_url(@user.reset_password_token), reset_password_url(@user.reset_password_token) %>.
+      To choose a new password, follow this link: <%= link_to reset_password_url(@user.reset_password_token), reset_password_url(@user.reset_password_token) %>.
     </p>
     <p>Have a great day!</p>
   </body>

data/app_prototype/app/views/user_mailer/reset_password_email.text.erb

@@ -1,8 +1,8 @@
 Hello, <%= @user.email %>
 ===============================================
+
+Someone requested to reset your password. If it wasn't you, just disregard this email.
  
-You have requested to reset your password.
- 
-To choose a new password, just follow this link: <%= reset_password_url(@user.reset_password_token) %>
+To choose a new password, follow this link: <%= reset_password_url(@user.reset_password_token) %>
  
 Have a great day!

data/app_prototype/config/database.yml

@@ -7,7 +7,7 @@ development: &default
   pool: 5
   timeout: 5000
 
-test: &TEST
+test:
   <<: *default
   database: app_prototype_test
   min_messages: warning

data/app_prototype/config/environments/acceptance.rb

@@ -63,7 +63,7 @@ AppPrototype::Application.configure do
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
-  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
 
-  config.action_mailer.default_url_options = { host: 'app_prototype-acceptance.herokuapp.com' }
+  config.action_mailer.default_url_options = { host: 'app-prototype-acceptance.herokuapp.com' }
 end

data/app_prototype/config/environments/production.rb

@@ -65,5 +65,5 @@ AppPrototype::Application.configure do
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
 
-  config.action_mailer.default_url_options = { host: 'app_prototype.herokuapp.com' }
+  config.action_mailer.default_url_options = { host: 'app-prototype.herokuapp.com' }
 end

data/app_prototype/config/environments/test.rb

@@ -22,7 +22,7 @@ AppPrototype::Application.configure do
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the

data/app_prototype/config/initializers/email.rb

@@ -1,11 +1,13 @@
 # http://www.mikeperham.com/2012/12/09/12-gems-of-christmas-4-mailcatcher-and-mail_view/
 
+mailcatcher_port = 1025
+
 begin
-  sock = TCPSocket.new('localhost', 1025)
+  sock = TCPSocket.new('localhost', mailcatcher_port)
   sock.close
   catcher = true
 rescue
   catcher = false
 end
 
-ActionMailer::Base.smtp_settings = (Rails.env.development? && catcher) ? { host: 'localhost', port: '1025', } : {}
+ActionMailer::Base.smtp_settings = (Rails.env.development? && catcher) ? { host: 'localhost', port: mailcatcher_port, } : {}

data/app_prototype/db/migrate/20121128215324_sorcery_core.rb

@@ -9,9 +9,11 @@ class SorceryCore < ActiveRecord::Migration
 
       t.timestamps
     end
+
+    add_index :users, :email, unique: true
   end
 
   def self.down
     drop_table :users
   end
-end
+end

data/app_prototype/db/schema.rb

@@ -46,6 +46,7 @@ ActiveRecord::Schema.define(:version => 20121128215337) do
   end
 
   add_index "users", ["activation_token"], :name => "index_users_on_activation_token"
+  add_index "users", ["email"], :name => "index_users_on_email", :unique => true
   add_index "users", ["last_logout_at", "last_activity_at"], :name => "index_users_on_last_logout_at_and_last_activity_at"
   add_index "users", ["remember_me_token"], :name => "index_users_on_remember_me_token"
   add_index "users", ["reset_password_token"], :name => "index_users_on_reset_password_token"

data/app_prototype/spec/mailers/user_mailer_spec.rb

@@ -41,7 +41,7 @@ describe UserMailer do
     end
 
     it "renders the body" do
-      expect(mail.body.encoded).to match "You have requested to reset your password."
+      expect(mail.body.encoded).to match "Someone requested to reset your password."
     end
   end
 

data/bin/raygun

@@ -19,11 +19,16 @@ unless ARGV[0]
   exit 1
 end
 
-app_dir = ARGV[0]
-app_name_snake = File.basename(app_dir).gsub('-', '_')
+app_dir  = ARGV[0]
+app_name = File.basename(app_dir).gsub(/\s+/, '-')
+app_name_dash  = app_name.gsub('_', '-')
+app_name_snake = app_name.gsub('-', '_')
 app_name_camel = camelize(app_name_snake)
 app_name_title = titleize(app_name_snake)
 
+ruby_version_patchlevel = `ruby -e 'print "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"'`
+ruby_version            = `ruby -e 'print "#{RUBY_VERSION}"'`
+
 puts
 puts "Creating new app #{app_name_camel} in directory #{app_dir}..."
 puts
@@ -32,9 +37,12 @@ FileUtils.cp_r(File.expand_path('../../app_prototype', __FILE__), app_dir)
 
 Dir.chdir(app_dir) do
   `find . -type f -print | xargs sed -i '' 's/AppPrototype/#{app_name_camel}/g'`
+  `find . -type f -print | xargs sed -i '' 's/app-prototype/#{app_name_dash}/g'`
   `find . -type f -print | xargs sed -i '' 's/app_prototype/#{app_name_snake}/g'`
   `find . -type f -print | xargs sed -i '' 's/App Prototype/#{app_name_title}/g'`
   `sed -i '' 's/SUPER_SECRET_TOKEN_REPLACE_ME_TODO/#{SecureRandom.hex(128)}/' config/initializers/secret_token.rb`
+  `sed -i '' 's/1.9.3-p327/#{ruby_version_patchlevel}/g' .rvmrc .ruby-version`
+  `sed -i '' 's/1.9.3/#{ruby_version}/g' Gemfile`
 
   puts "Done! Next steps..."
   puts ""

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies: []
 description: Carbon Five Rails application generator
 email:
@@ -30,9 +30,10 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- app_prototype/.env
 - app_prototype/.gitignore
-- app_prototype/.rbenv-version
 - app_prototype/.rspec
+- app_prototype/.ruby-version
 - app_prototype/.rvmrc
 - app_prototype/Gemfile
 - app_prototype/Guardfile
@@ -42,6 +43,7 @@ files:
 - app_prototype/app/assets/javascripts/application.js
 - app_prototype/app/assets/javascripts/users.js.coffee
 - app_prototype/app/assets/stylesheets/_footer.less
+- app_prototype/app/assets/stylesheets/_navbar.less
 - app_prototype/app/assets/stylesheets/application.css.less
 - app_prototype/app/controllers/application_controller.rb
 - app_prototype/app/controllers/password_resets_controller.rb