rails-replicator 0.1.0

data/lib/replicator/generators/app_generator.rb

@@ -0,0 +1,207 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Replicator
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, :type => :string, :aliases => '-d', :default => 'postgresql',
+      :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :heroku, :type => :boolean, :aliases => '-H', :default => false,
+      :desc => 'Create staging and production Heroku apps'
+
+    class_option :github, :type => :string, :aliases => '-G', :default => nil,
+      :desc => 'Create Github repository and add remote origin pointed to repo'
+
+    class_option :skip_test_unit, :type => :boolean, :aliases => '-T', :default => true,
+      :desc => 'Skip Test::Unit files'
+
+    def finish_template
+      invoke :replicator_customization
+      super
+    end
+
+    def replicator_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 :create_replicator_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :update_routes
+      invoke :migrate_database
+      invoke :setup_git
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :outro
+    end
+
+    def remove_files_we_dont_need
+      build :remove_public_index
+      build :remove_rails_logo_image
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+      build :setup_rvmrc
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :configure_generators
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :enable_factory_girl_syntax
+      build :test_factories_first
+      build :generate_rspec
+      build :configure_rspec
+      build :use_rspec_binstub
+      build :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_capybara_webkit
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def create_replicator_views
+      say 'Creating replicator views'
+      build :create_partials_directory
+      build :create_shared_flashes
+      build :create_shared_javascripts
+      build :create_application_layout
+    end
+
+    def setup_coffeescript
+      say 'Setting up CoffeeScript defaults'
+      build :remove_turbolinks
+      build :create_common_javascripts
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :blacklist_active_record_attributes
+      build :configure_strong_parameters
+      build :configure_time_zone
+      build :configure_time_formats
+      build :configure_rack_timeout
+      build :disable_xml_params
+      build :setup_default_rake_task
+      build :setup_application_helper
+      build :configure_unicorn
+      build :setup_foreman
+      build :setup_guard
+      build :setup_devise_and_cancan
+      build :generate_pages_controller
+      build :setup_admin_section
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_git
+      say 'Initializing git'
+      invoke :setup_gitignore
+      invoke :init_git
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say 'Creating Heroku apps'
+        build :create_heroku_apps
+        build :set_heroku_remotes
+      end
+    end
+
+    def create_github_repo
+      if options[:github]
+        say 'Creating Github repo'
+        build :create_github_repo, options[:github]
+      end
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    end
+
+    def copy_libraries
+      say 'Copying libraries'
+      build :copy_libraries
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+
+    def update_routes
+      build :update_routes
+    end
+
+    def migrate_database
+      say 'Migrating database'
+      build :migrate_database
+    end
+
+    def outro
+      say 'Congratulations! Replication complete!'
+      say "Remember to run 'rails generate airbrake' with your API key."
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    protected
+
+    def get_builder_class
+      Replicator::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/replicator/version.rb

@@ -0,0 +1,3 @@
+module Replicator
+  VERSION = '0.1.0'
+end

data/replicator.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'replicator/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_dependency 'bundler', '~> 1.3'
+  s.add_dependency 'rails', '4.0.0'
+  s.authors = ['teleporter']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+Rails application generator used at Teleporter, based on thoughtbot/suspenders.
+  HERE
+
+  s.email = 'hire@teleporter.io'
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |file| File.basename(file) }
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/teleporter/replicator'
+  s.license = 'MIT'
+  s.name = 'rails-replicator'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using Teleporter's best practices."
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Replicator::VERSION
+end

data/templates/Gemfile_clean

@@ -0,0 +1,68 @@
+source 'https://rubygems.org'
+
+ruby '2.0.0'
+
+gem 'airbrake', '~> 3.1'
+# gem 'ancestry', '~> 2.0'
+gem 'bootstrap-sass', github: 'thomas-mcdonald/bootstrap-sass', branch: '3'
+gem 'cancan', '~> 1.6'
+gem 'coffee-rails', '~> 4.0'
+gem 'delayed_job_active_record', '~> 4.0'
+gem 'devise', '~> 3.1'
+gem 'email_validator', '~> 1.4'
+gem 'figaro', '~> 0.7'
+gem 'font-awesome-rails', '~> 3.2'
+gem 'jquery-rails', '~> 3.0'
+gem 'neat', '~> 1.4'
+gem 'newrelic_rpm', '~> 3.6'
+gem 'pg', '~> 0.17'
+gem 'rack-timeout', '~> 0.0'
+gem 'rails', '4.0.0'
+gem 'recipient_interceptor', '~> 0.1'
+gem 'rolify', '~> 3.2'
+gem 'sass-rails', '~> 4.0'
+gem 'slim', '~> 2.0'
+# gem 'stripe', '~> 1.7'
+gem 'tinymce-rails', '~> 4.0'
+gem 'turbolinks', '~> 1.3'
+gem 'uglifier', '~> 1.3'
+
+group :development do
+  gem 'better_errors', '~> 1.0'
+  gem 'binding_of_caller', platforms: [:mri_19, :mri_20, :rbx]
+  gem 'guard-bundler', '~> 1.0'
+  gem 'guard-rails', '~> 0.4'
+  gem 'guard-rspec', '~> 2.5'
+  gem 'haml-rails', '~> 0.4'
+  gem 'haml2slim', '~> 0.4'
+  gem 'html2haml', '~> 1.0'
+  gem 'hub', '~> 1.10', require: nil
+  gem 'quiet_assets', '~> 1.0'
+  gem 'rb-fchange', '~> 0.0', require: false
+  gem 'rb-fsevent', '~> 0.9', require: false
+  gem 'rb-inotify', '~> 0.9', require: false
+end
+
+group :development, :test do
+  gem 'factory_girl_rails', '~> 4.2'
+  gem 'guard-spork', '~> 1.5'
+  gem 'guard-rspec', '~> 2.5'
+  gem 'rspec-rails', '~> 2.14'
+  gem 'spork-rails', github: 'sporkrb/spork-rails'
+end
+
+group :staging, :production do
+  gem 'rails_12factor', '~> 0.0' # heroku asset pipeline helper
+  gem 'unicorn', '~> 4.6'
+end
+
+group :test do
+  gem 'capybara', '~> 2.1'
+  gem 'database_cleaner', '~> 1.0'
+  gem 'email_spec', '~> 1.5'
+  gem 'launchy', '~> 2.3'
+  gem 'shoulda-matchers', '~> 2.4'
+  gem 'simplecov', '~> 0.7', require: false
+  gem 'timecop', '~> 0.6'
+  gem 'webmock', '~> 1.13'
+end

data/templates/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec unicorn -p $PORT -c ./config/unicorn.rb
+worker: bundle exec rake jobs:work

data/templates/README.md.erb

@@ -0,0 +1,5 @@
+# <%= app_name %>
+
+Congrats! You've just created a Rails applications using [Replicator](https://github.com/teleporter/replicator).
+
+Now it's time to get to work!

data/templates/_flashes.html.slim.erb

@@ -0,0 +1,13 @@
+- flash.each do |name, msg|
+  - if name.to_s == 'alert'
+    .alert.alert-danger
+      = link_to "×".html_safe, '#', 'data-dismiss' => 'alert', 'aria-hidden' => 'true', class: 'close'
+      i.icon-remove
+      |   
+      = msg
+  - else
+    .alert.alert-success
+      = link_to "×".html_safe, '#', 'data-dismiss' => 'alert', 'aria-hidden' => 'true', class: 'close'
+      i.icon-ok
+      |   
+      = msg

data/templates/_javascript.html.slim.erb

@@ -0,0 +1,7 @@
+= javascript_include_tag :application
+
+= yield :javascript
+
+- if Rails.env.test?
+  javascript:
+    $.ajaxSetup({ async: false });

data/templates/ability.rb

@@ -0,0 +1,15 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= User.new # guest user (not logged in)
+    if user.has_role? :admin
+      can :manage, :all
+    else
+      can :read, :all
+      # can :read, Page do |page|
+      #   page.published?
+      # end
+    end
+  end
+end

data/templates/admin_base_controller.rb

@@ -0,0 +1,14 @@
+class Admin::BaseController < ApplicationController
+  before_filter :authenticate_as_admin
+
+private
+  def authenticate_as_admin
+    unless user_is_an_admin?
+      redirect_to root_path, alert: 'You must first login as an admin to do that!'
+    end
+  end
+
+  def user_is_an_admin?
+    current_user && current_user.has_role?(:admin)
+  end
+end

data/templates/admin_dashboard_controller.rb

@@ -0,0 +1,4 @@
+class Admin::DashboardController < Admin::BaseController
+  def index
+  end
+end

data/templates/application.css.sass

@@ -0,0 +1,12 @@
+// vendor
+@import bootstrap
+@import font-awesome
+
+// core
+@import typography/forms
+
+// layout
+// @import layout/header
+
+// widgets
+// @import widgets/some-widget

data/templates/application.html.slim.erb

@@ -0,0 +1,24 @@
+doctype html
+html
+  head
+    title = content_for?(:title) ? yield(:title) : "<%= app_name %>"
+    meta name="viewport" content="width=device-width, initial-scale=1.0"
+    = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
+    = javascript_include_tag "application", "data-turbolinks-track" => true
+    = csrf_meta_tags
+  body
+    .page
+      nav.page-nav.navbar.navbar-default role="navigation"
+        .container
+          = link_to "<%= app_name %>", '/', class: 'navbar-brand'
+          ul.nav.navbar-nav
+          ul.nav.navbar-nav.pull-right
+            - if user_signed_in?
+              li = link_to "Logout", logout_path, method: :delete
+            - else
+              li = link_to "Sign Up", signup_path
+              li = link_to "Login", login_path
+      .container
+        = render 'flashes'
+        = yield
+    = render 'javascript'

data/templates/application.js

@@ -0,0 +1,8 @@
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require bootstrap
+
+$(function () {
+  // jquery onload...
+});

data/templates/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def set_title(value)
+    content_for(:title, value)
+  end
+end

data/templates/background_jobs_rspec.rb

@@ -0,0 +1,19 @@
+module BackgroundJobs
+  def run_background_jobs_immediately
+    delay_jobs = Delayed::Worker.delay_jobs
+    Delayed::Worker.delay_jobs = false
+    yield
+  ensure
+    Delayed::Worker.delay_jobs = delay_jobs
+  end
+end
+
+RSpec.configure do |config|
+  config.around(:each, type: :feature) do |example|
+    run_background_jobs_immediately do
+      example.run
+    end
+  end
+
+  config.include BackgroundJobs
+end

data/templates/bin_setup

@@ -0,0 +1,26 @@
+#!/usr/bin/env sh
+
+# Set up Rails app. Run this script immediately after cloning the codebase.
+# https://github.com/thoughtbot/guides/tree/master/protocol
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Set up the database
+bundle exec rake db:setup
+
+# Set up configurable environment variables
+if [ ! -f .env ]; then
+  cp .sample.env .env
+fi
+
+# Pick a port for Foreman
+echo "port: 3000" > .foreman
+
+# Set up DNS via Pow
+# if [ -d ~/.pow ]
+# then
+#   echo 7000 > ~/.pow/`basename $PWD`
+# else
+#   echo "Pow not set up but the team uses it for this project. Setup: http://goo.gl/RaDPO"
+# fi

data/templates/config_locales_en.yml

@@ -0,0 +1,11 @@
+en:
+  date:
+    formats:
+      default: '%m/%d/%Y'
+      with_weekday: '%a %m/%d/%y'
+
+  time:
+    formats:
+      default: '%a, %b %-d, %Y at %r'
+      date: '%b %-d, %Y'
+      short: '%B %d'

data/templates/database.yml.erb

@@ -0,0 +1,12 @@
+development: &default
+  adapter: postgresql
+  database: <%= app_name %>_dev
+  host: localhost
+  encoding: utf8
+  min_messages: warning
+  pool: 5
+  timeout: 5000
+
+test:
+  <<: *default
+  database: <%= app_name %>_test

data/templates/database_cleaner_rspec.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:deletion)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :deletion
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/templates/devise/confirmations/new.html.slim

@@ -0,0 +1,12 @@
+h1.page-header Resend confirmation instructions
+
+= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f|
+  = devise_error_messages!
+  .form-group
+    = f.label :email, class: 'form-label'
+    = f.email_field :email, autofocus: true, class: 'form-control'
+
+  .form-actions
+    = f.submit 'Resend confirmation instructions', class: 'btn btn-primary btn-lg'
+
+= render 'devise/shared/links'

data/templates/devise/mailer/confirmation_instructions.html.erb

@@ -0,0 +1,5 @@
+<p>Welcome <%= @email %>!</p>
+
+<p>You can confirm your account email through the link below:</p>
+
+<p><%= link_to 'Confirm my account', confirmation_url(@resource, :confirmation_token => @token) %></p>

data/templates/devise/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,8 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Someone has requested a link to change your password. You can do this through the link below.</p>
+
+<p><%= link_to 'Change my password', edit_password_url(@resource, :reset_password_token => @token) %></p>
+
+<p>If you didn't request this, please ignore this email.</p>
+<p>Your password won't change until you access the link above and create a new one.</p>

data/templates/devise/mailer/unlock_instructions.html.erb

@@ -0,0 +1,7 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
+
+<p>Click the link below to unlock your account:</p>
+
+<p><%= link_to 'Unlock my account', unlock_url(@resource, :unlock_token => @token) %></p>

data/templates/devise/passwords/edit.html.slim

@@ -0,0 +1,19 @@
+.col-md-6.col-md-offset-3
+  h1.page-header Change your password
+
+  = form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f|
+    = devise_error_messages!
+    = f.hidden_field :reset_password_token
+
+    .form-group
+      = f.label :password, 'New password', class: 'form-label'
+      = f.password_field :password, autofocus: true, class: 'form-control'
+
+    .form-group
+      = f.label :password_confirmation, 'Confirm new password', class: 'form-label'
+      = f.password_field :password_confirmation, class: 'form-control'
+
+    .form-action
+      = f.submit 'Change my password', class: 'btn btn-primary btn-lg'
+
+  = render 'devise/shared/links'

data/templates/devise/passwords/new.html.slim

@@ -0,0 +1,14 @@
+.col-md-6.col-md-offset-3
+  h1.page-header Forgot your password?
+
+  = form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f|
+    = devise_error_messages!
+
+    .form-group
+      = f.label :email, class: 'form-label'
+      = f.email_field :email, autofocus: true, class: 'form-control'
+
+    .form-actions
+      = f.submit 'Send me reset password instructions', class: 'btn btn-primary btn-lg'
+
+  = render 'devise/shared/links'

data/templates/devise/registrations/edit.html.slim

@@ -0,0 +1,36 @@
+.col-md-6.col-md-offset-3
+  h1.page-header Edit #{resource_name.to_s.humanize}
+
+  = form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f|
+    = devise_error_messages!
+
+    .form-group
+      = f.label :email, class: 'form-label'
+      = f.email_field :email, autofocus: true, class: 'form-control'
+
+    - if devise_mapping.confirmable? && resource.pending_reconfirmation?
+      .alert.alert-success Currently waiting confirmation for: #{resource.unconfirmed_email}
+
+    .form-group
+      = f.label :password, class: 'form-label'
+      i (leave blank if you don't want to change it)
+      = f.password_field :password, autocomplete: "off", class: 'form-control'
+
+    .form-group
+      = f.label :password_confirmation, class: 'form-label'
+      = f.password_field :password_confirmation, class: 'form-control'
+
+    .form-group
+      = f.label :current_password, class: 'form-label'
+      i (we need your current password to confirm your changes)
+      = f.password_field :current_password, class: 'form-control'
+
+    = f.submit "Update", class: 'btn btn-primary btn-lg'
+
+  h3 Cancel my account
+
+  p
+    | Unhappy? 
+    = button_to 'Cancel my account', registration_path(resource_name), data: { confirm: "Are you sure?" }, method: :delete, class: 'btn btn-danger'
+
+  p = link_to 'Back', :back

data/templates/devise/registrations/new.html.slim

@@ -0,0 +1,22 @@
+.col-md-6.col-md-offset-3
+  h1.page-header Sign up
+
+  = form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f|
+    = devise_error_messages!
+
+    .form-group
+      = f.label :email, class: 'form-label'
+      = f.email_field :email, autofocus: true, class: 'form-control'
+
+    .form-group
+      = f.label :password, class: 'form-label'
+      = f.password_field :password, class: 'form-control'
+
+    .form-group
+      = f.label :password_confirmation, class: 'form-label'
+      = f.password_field :password_confirmation, class: 'form-control'
+
+    .form-actions
+      = f.submit 'Sign up', class: 'btn btn-primary btn-lg'
+
+  = render 'devise/shared/links'