raygun 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p194@raygun --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Carbon Five
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+<img src="https://raw.github.com/carbonfive/raygun/master/marvin.jpg" align="right"/>
+
+# Raygun
+
+__NOTE: Currently a work in progress and not yet representative of best practices. Soon the veil will be lifted.__
+
+Command line Rails application generator that builds a new project skeleton configured with all of the Carbon Five
+best practices baked right in.
+
+Inspired by and code shamelessly lifted from ThoughtBot's Suspenders. Thanks!
+
+Major tools/libraries:
+
+* Rails
+* PostgreSQL
+* Slim
+* Less
+* Bootstrap
+* Sorcery
+* Cancan
+* RSpec
+* Factory Girl
+* Guard
+
+And many tweaks, patterns and common recipes.
+
+## Projects Goals
+
+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.
+
+## Installation
+
+  $ gem install raygun
+
+## Usage
+
+  $ raygun your-project
+
+Once your project is baked out, you can easily kick the wheels:
+
+  $ cd your-project
+
+  # Prep the database
+  $ rake db:create db:migrate db:test:prepare
+
+  # Run the specs
+  $ rake spec
+
+  # Load some sample data, fire up the app and open it in a browser
+  $ rake db:seed db:sample_data
+  $ rails s
+  $ open http://0.0.0.0:3000
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,24 @@
+# TODOs
+
+Looking for inspiration? Here are some ideas for things that still could be done.
+
+* Cleanup/refactor raygun code (a few simple helpers would help out a whole lot)
+* Automated testing of raygun (e.g. generate an app and run its specs?)
+* Raygun on CI
+* Add the concept of an admin / super user
+* Invite user flow
+* Use cancan to restrict access to /users to an admin
+* 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)
+* JS testing
+* Use foreigner for database constraints
+* Fast tests best practices
+* Use guard (rspec, livereload, js testing, etc)
+* Paperclip + S3 configuration
+* Application monitoring
+* Analytics
+* One step configuration for Heroku (production and acceptance)
+* One step configuration on CI

data/bin/raygun

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', 'lib', 'raygun', 'generators', 'app_generator'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'raygun', 'actions'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'raygun', 'app_builder'), File.dirname(__FILE__))
+
+templates_root = File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+Raygun::AppGenerator.source_root templates_root
+Raygun::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Raygun::AppGenerator.start

data/lib/raygun/actions.rb

@@ -0,0 +1,26 @@
+module Raygun
+  module Actions
+    #def concat_file(source, destination)
+    #  contents = IO.read(find_in_source_paths(source))
+    #  append_file destination, contents
+    #end
+    #
+
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      unless contents.gsub!(find, replace)
+        raise "#{find.inspect} not found in #{relative_path}"
+      end
+      File.open(path, "w") { |file| file.write(contents) }
+    end
+
+    def action_mailer_host(rails_env, host)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  config.action_mailer.default_url_options = { :host => '#{host}' }",
+        :before => "\nend"
+      )
+    end
+  end
+end

data/lib/raygun/app_builder.rb

@@ -0,0 +1,283 @@
+module Raygun
+  class AppBuilder < Rails::AppBuilder
+    include Raygun::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def replace_public_index
+      template '_public/index.html.erb', 'public/index.html', force: true
+    end
+
+    def remove_rails_logo_image
+      remove_file 'app/assets/images/rails.png'
+    end
+
+    def remove_application_layout
+      remove_file 'app/views/layouts/application.html.erb'
+    end
+
+    def enable_factory_girl_syntax
+      copy_file '_spec/support/factory_girl.rb', 'spec/support/factory_girl.rb'
+    end
+
+    def enable_threadsafe_mode
+      uncomment_lines 'config/environments/production.rb', 'config.threadsafe!'
+    end
+
+    def initialize_on_precompile
+      inject_into_file 'config/application.rb',
+                       "\n    config.assets.initialize_on_precompile = false",
+                       after: 'config.assets.enabled = true'
+    end
+
+    def setup_acceptance_environment
+      run 'cp config/environments/production.rb config/environments/acceptance.rb'
+    end
+
+    def create_application_layout
+      template '_app/views/layouts/application.html.slim.erb',
+               'app/views/layouts/application.html.slim',
+               force: true
+    end
+
+    def use_postgres_config_template
+      template '_config/database.yml.erb', 'config/database.yml', force: true
+    end
+
+    def create_database
+      bundle_command 'exec rake db:create'
+    end
+
+    def configure_rvm
+      template 'rvmrc.erb', '.rvmrc', rvm_ruby: rvm_ruby
+    end
+
+    def configure_gemfile
+      run 'gem install bundler'
+      copy_file 'Gemfile_customized', 'Gemfile', force: true
+    end
+
+    def setup_generators
+      %w(_form index show new edit).each do |view|
+        template = "lib/templates/slim/scaffold/#{view}.html.slim"
+        remove_file template
+        copy_file   "_lib/templates/slim/scaffold/#{view}.html.slim", template
+      end
+    end
+
+    def configure_rspec
+      generators_config = <<-RUBY
+
+    config.generators do |generate|
+      generate.stylesheets false
+      #generate.helpers     false
+      generate.route_specs false
+      #generate.view_specs  false
+    end
+
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', generators_config
+
+      copy_file '_lib/templates/rspec/scaffold/controller_spec.rb',
+                'lib/templates/rspec/scaffold/controller_spec.rb'
+    end
+
+    def generate_rspec
+      generate 'rspec:install'
+    end
+
+    def add_rspec_support
+      shared_transaction = <<-RUBY
+
+# Forces all threads to share the same connection. This works on
+# Capybara because it starts the web server in a thread.
+#
+# http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/
+
+class ActiveRecord::Base
+  mattr_accessor :shared_connection
+  @@shared_connection = nil
+
+  def self.connection
+    @@shared_connection || retrieve_connection
+  end
+end
+
+ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection
+
+# Turn down the logging while testing.
+Rails.logger.level = 4
+RUBY
+
+      append_to_file 'spec/spec_helper.rb', shared_transaction
+
+      copy_file '_spec/support/accept_values.rb', 'spec/support/accept_values.rb'
+    end
+
+    def configure_time_zone
+      'config/application.rb'.tap do |fn|
+        #inject_into_file fn, '    config.active_record.default_timezone = :utc\n', after: "'Central Time (US & Canada)'\n"
+        #uncomment_lines  fn, 'config.time_zone'
+        gsub_file        fn, 'Central Time (US & Canada)', 'Pacific Time (US & Canada)'
+      end
+    end
+
+    def configure_action_mailer
+      action_mailer_host 'development', "#{app_name}.local"
+      action_mailer_host 'test',        "example.com"
+      action_mailer_host 'acceptance',  "acceptance.#{app_name}.com"
+      action_mailer_host 'production',  "#{app_name}.com"
+    end
+
+    def add_lib_to_load_path
+      'config/application.rb'.tap do |fn|
+        gsub_file       fn, '#{config.root}/extras', '#{config.root}/lib'
+        uncomment_lines fn, 'config.autoload_paths'
+      end
+    end
+
+    def add_email_validator
+      # CN: I'm not thrilled with this use of the lib directory, but it's not that unusual. Would love to hear what
+      # other folks think about where such things should live.
+      copy_file '_lib/email_validator.rb', 'lib/email_validator.rb'
+    end
+
+    def setup_simple_form
+      generate 'simple_form:install --bootstrap -s'
+
+      replace_in_file 'config/initializers/simple_form.rb',
+                      %(# config.label_text = lambda { |label, required| "\#{required} \#{label}" }),
+                      %(config.label_text = lambda { |label, required| "\#{label}" })
+    end
+
+    def setup_authentication
+      # User model
+      generate 'scaffold user email:string name:string'
+
+      remove_file 'app/models/user.rb'
+      remove_file 'spec/factories/users.rb'
+      remove_file 'spec/requests/users_spec.rb'
+      create_users_migration = 'db/migrate/' + Dir.new('./db/migrate').entries.select { |e| e =~ /create_users/ }.first
+      remove_file create_users_migration
+
+      generate 'sorcery:install brute_force_protection activity_logging user_activation remember_me reset_password external'
+
+      copy_file '_app/models/user.rb', 'app/models/user.rb', force: true
+      copy_file '_spec/support/sorcery.rb', 'spec/support/sorcery.rb'
+      copy_file '_spec/factories/users.rb', 'spec/factories/users.rb', force: true
+      copy_file '_spec/models/user_spec.rb', 'spec/models/user_spec.rb', force: true
+
+      inject_into_file 'app/controllers/users_controller.rb',
+                       "\n  before_filter :require_login\n\n",
+                       after: "UsersController < ApplicationController\n"
+
+      # User mailer (has to happen before sorcery config changes)
+      generate 'mailer UserMailer activation_needed_email activation_success_email reset_password_email'
+      copy_file '_app/mailers/user_mailer.rb', 'app/mailers/user_mailer.rb', force: true
+      copy_file '_spec/mailers/user_mailer_spec.rb', 'spec/mailers/user_mailer_spec.rb', force: true
+
+      %w(activation_needed_email activation_success_email reset_password_email).each do |fn|
+        remove_file "app/views/user_mailer/#{fn}.text.slim"
+
+        %w(html.erb text.erb).each do |ext|
+          copy_file "_app/views/user_mailer/#{fn}.#{ext}", "app/views/user_mailer/#{fn}.#{ext}", force: true
+        end
+      end
+
+      remove_dir 'spec/fixtures/user_mailer'
+
+      # Patch sorcery configuration and migrations
+      sorcery_core_migration = 'db/migrate/' + Dir.new('./db/migrate').entries.select { |e| e =~ /sorcery_core/ }.first
+      inject_into_file sorcery_core_migration, "      t.string :name\n", after: "create_table :users do |t|\n"
+      comment_lines sorcery_core_migration, /^.* t.string :username.*$\n/
+
+      'config/initializers/sorcery.rb'.tap do |fn|
+        replace_in_file fn, 'config.user_class = "User"',        'config.user_class = User'
+        replace_in_file fn, '# user.username_attribute_names =', 'user.username_attribute_names = :email'
+        replace_in_file fn, '# user.user_activation_mailer =',   'user.user_activation_mailer = UserMailer'
+        replace_in_file fn, '# user.reset_password_mailer =',    'user.reset_password_mailer = UserMailer'
+        #replace_in_file sorcery_rb, /# user.unlock_token_mailer =.*$/,   'user.unlock_token_mailer = UserMailer'
+      end
+
+      # Routes, controllers, helpers and views
+      route "resources :password_resets, only: [:new, :create, :edit, :update]"
+      route "match 'sign_up/:token/activate' => 'registrations#activate', via: :get"
+      route "match 'sign_up' => 'registrations#create', via: :post"
+      route "match 'sign_up' => 'registrations#new', via: :get"
+      route "resources :registrations, only: [:new, :create, :activate]"
+      route "resources :user_sessions, only: [:new, :create, :destroy]"
+      route "match 'sign_out' => 'user_sessions#destroy', as: :sign_out"
+      route "match 'sign_in'  => 'user_sessions#new',     as: :sign_in"
+
+      copy_file '_app/controllers/application_controller.rb',
+                'app/controllers/application_controller.rb',
+                force: true
+
+      copy_file '_app/helpers/application_helper.rb',
+                'app/helpers/application_helper.rb',
+                force: true
+
+      copy_file '_app/models/user_session.rb',
+                'app/models/user_session.rb'
+
+      copy_file '_app/controllers/user_sessions_controller.rb',
+                'app/controllers/user_sessions_controller.rb'
+
+      copy_file '_app/views/user_sessions/new.html.slim',
+                'app/views/user_sessions/new.html.slim'
+
+      copy_file '_spec/support/user_sessions_request_helper.rb',
+                'spec/support/user_sessions_request_helper.rb'
+
+      copy_file '_spec/requests/user_sessions_spec.rb',
+                'spec/requests/user_sessions_spec.rb'
+
+      copy_file '_app/controllers/registrations_controller.rb',
+                'app/controllers/registrations_controller.rb'
+
+      directory '_app/views/registrations', 'app/views/registrations'
+
+      copy_file '_app/controllers/password_resets_controller.rb',
+                'app/controllers/password_resets_controller.rb'
+
+      directory '_app/views/password_resets', 'app/views/password_resets'
+
+      copy_file '_app/views/password_resets/edit.html.slim',
+                'app/views/password_resets/edit.html.slim'
+
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      directory   '_app/assets/stylesheets', 'app/assets/stylesheets'
+    end
+
+    def setup_javascripts
+      inject_into_file 'app/assets/javascripts/application.js',
+                       "//= require twitter/bootstrap\n",
+                       after: "require jquery_ujs\n"
+    end
+
+    def copy_rake_tasks
+      copy_file '_lib/tasks/db.rake', 'lib/tasks/db.rake'
+      copy_file '_db/sample_data.rb', 'db/sample_data.rb'
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb', /Application\.routes\.draw do.*end/m, "Application.routes.draw do\nend"
+    end
+
+    def convert_to_19_hash_syntax
+      run 'hash_syntax -n'
+    end
+
+    def consistent_quoting
+      gsub_file 'config/application.rb', '"utf-8"', "'utf-8'"
+      %w(acceptance production).each do |fn|
+        gsub_file "config/environments/#{fn}.rb", '"X-Sendfile"', "'X-Sendfile'"
+      end
+    end
+  end
+end

data/lib/raygun/generators/app_generator.rb

@@ -0,0 +1,182 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require 'rvm'
+
+module Raygun
+  class AppGenerator < Rails::Generators::AppGenerator
+
+    class_option :database, type: :string, aliases: '-d', default: 'postgresql',
+                 desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :skip_test_unit, type: :boolean, aliases: '-T', default: true,
+                 desc: "Skip Test::Unit files"
+
+    def finish_template
+      invoke :raygun_customization
+      super
+    end
+
+    def raygun_customization
+      rvm_original_env = RVM.current.expanded_name
+
+      invoke :remove_files_we_dont_need
+      invoke :remove_routes_comment_lines
+      invoke :setup_development_environment
+      invoke :setup_production_environment
+      invoke :setup_acceptance_environment
+      #invoke :setup_staging_environment
+      # FUTURE autodetect rvm or rbenv
+      invoke :configure_rvm
+      # FUTURE invoke :configure_rbenv
+      invoke :customize_gemfile
+      invoke :setup_database
+      invoke :setup_generators
+      invoke :create_raygun_views
+      invoke :configure_app
+      invoke :setup_javascripts
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+
+      # Go back to the original rvm environment.
+      @@env.use!(rvm_original_env)
+
+      invoke :knits_and_picks
+      invoke :outro
+    end
+
+    def remove_files_we_dont_need
+      say "Removing unwanted files."
+      build :remove_rails_logo_image
+      build :remove_application_layout
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def setup_development_environment
+      say "Setting up the development environment."
+      build :raise_delivery_errors
+      build :enable_factory_girl_syntax
+    end
+
+    def setup_production_environment
+      say "Setting up the production environment."
+      build :enable_threadsafe_mode
+    end
+
+    def setup_acceptance_environment
+      say "Setting up the acceptance environment."
+      build :setup_acceptance_environment
+      build :initialize_on_precompile
+    end
+
+    def configure_rvm
+      say "Configuring RVM"
+
+      @@env = RVM::Environment.new
+
+      @@env.gemset_create(app_name)
+      @@env.gemset_use!(app_name)
+
+      build :configure_rvm
+    end
+
+    def customize_gemfile
+      say "Customizing the Gemfile."
+      build :configure_gemfile
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+      build :use_postgres_config_template
+      build :create_database
+    end
+
+    def setup_generators
+      say 'Installing custom view generator templates'
+      build :setup_generators
+    end
+
+    def create_raygun_views
+      say 'Creating views and layouts'
+      build :replace_public_index
+      build :create_partials_directory
+      #build :create_shared_flashes
+      #build :create_shared_javascripts
+      build :create_application_layout
+    end
+
+    def configure_app
+      say 'Configuring app'
+
+      build :configure_rspec
+      build :generate_rspec
+      build :add_rspec_support
+
+      build :configure_time_zone
+      build :configure_action_mailer
+      build :add_lib_to_load_path
+      build :add_email_validator
+      build :setup_simple_form
+      build :setup_authentication
+      build :setup_default_rake_task
+      #build :setup_guard
+    end
+
+    def setup_stylesheets
+      say "Configuring stylesheets"
+      build :setup_stylesheets
+    end
+
+    def setup_javascripts
+      say "Configuring javascripts"
+      build :setup_javascripts
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_rake_tasks
+    end
+
+    def knits_and_picks
+      say 'Converting old hash syntax and fixing knit picks'
+      build :convert_to_19_hash_syntax
+      build :consistent_quoting
+    end
+
+    def outro
+      say ""
+      say "You're done! Next steps..."
+      say ""
+      say "# Prepare the database"
+      say "  $ cd #{ARGV[0]}"
+      say "  $ rake db:create db:migrate db:test:prepare"
+      say ""
+      say "# Run the specs (they should all pass)"
+      say "  $ rake spec"
+      say ""
+      say "# Load reference and sample data, then run the app and check things out"
+      say "  $ rake db:seed db:sample_data"
+      say "  $ rails s"
+      say "  $ open http://0.0.0.0:3000"
+      say ""
+      say "Enjoy your Carbon Five flavored Rails application!"
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    def rvm_ruby
+      @@env.expanded_name.match(/(.*)@/)[1]
+    end
+
+    protected
+
+    def get_builder_class
+      Raygun::AppBuilder
+    end
+  end
+end

data/lib/raygun/version.rb

@@ -0,0 +1,3 @@
+module Raygun
+  VERSION = "0.0.2"
+end

data/raygun.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raygun/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "raygun"
+  gem.version       = Raygun::VERSION
+  gem.authors       = ["Christian Nelson"]
+  gem.email         = ["christian@carbonfive.com"]
+  gem.description   = %q{Carbon Five Rails application generator}
+  gem.summary       = %q{Generates and customizes Rails applications with Carbon Five best practices baked in.}
+  gem.homepage      = "https://github.com/carbonfive/raygun"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rails',       '3.2.8'
+  gem.add_dependency 'bundler',     '>= 1.2'
+  gem.add_dependency 'rvm',         '>= 1.11.3.5'
+  gem.add_dependency 'hash_syntax', '>= 1.0'
+end