wagon_rails 0.1.0

data/lib/wagon_rails/generators/app_generator.rb

@@ -0,0 +1,198 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module WagonRails
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, type: :string, aliases: "-d", default: "postgresql",
+      desc: "Configure for selected database (options: #{DATABASES.join("/")})"
+
+    class_option :skip_heroku, type: :boolean, default: false,
+      desc: "Create production Heroku app"
+
+    class_option :skip_github, type: :boolean, default: false,
+      desc: "Create GitHub repository"
+
+    class_option :skip_test_unit, type: :boolean, aliases: "-T", default: true,
+      desc: "Skip Test::Unit files"
+
+    class_option :skip_turbolinks, type: :boolean, default: true,
+      desc: "Skip turbolinks gem"
+
+    class_option :skip_bundle, type: :boolean, aliases: "-B", default: true,
+      desc: "Don't run bundle install"
+
+    def finish_template
+      invoke :wagon_rails_customization
+      super
+    end
+
+    def wagon_rails_customization
+      invoke :setup_git
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_production_environment
+      invoke :create_wagon_rails_views
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :setup_javascripts
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :add_root_route
+      invoke :setup_auth
+      invoke :setup_database
+      invoke :create_github_repo
+      invoke :first_commit
+      invoke :create_heroku_app
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' ==
+        [: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 :set_development_delivery_method
+      build :raise_on_unpermitted_parameters
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+      build :enable_rack_deflater
+    end
+
+    def create_wagon_rails_views
+      say 'Creating wagon_rails views'
+      build :create_partials_directory
+      build :create_shared_flashes
+      build :create_application_layout
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_rack_timeout
+      build :configure_simple_form
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :configure_puma
+      build :setup_foreman
+      build :setup_figaro
+      build :setup_paperclip
+      build :copy_application_yml
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_javascripts
+      say 'Set up javascripts'
+      build :setup_javascripts
+    end
+
+    def setup_git
+      unless options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def setup_auth
+      build :generate_devise
+      build :generate_user
+      build :install_navbar
+      build :generate_devise_views
+      build :generate_pundit
+      build :setup_application_controller
+    end
+
+    def create_heroku_app
+      unless options[:skip_heroku]
+        say "Creating Heroku app"
+        build :create_heroku_app
+        build :set_heroku_remote
+        build :provide_deploy_script
+        build :add_host_to_application_yml
+        build :commit, "Add heroku deploy script"
+      end
+    end
+
+    def create_github_repo
+      unless options[:skip_github]
+        say 'Creating Github repo'
+        build :create_github_repo
+      end
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    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 remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def add_root_route
+      build :copy_home
+      build :configure_high_voltage
+    end
+
+    def first_commit
+      build :commit, "New rails app generated with lewagon/wagon-rails gem"
+    end
+
+    def outro
+      say "Congratulations! You're ready to rock!"
+      unless options[:skip_heroku]
+        say 'Once in the rails folder, you can deploy to Heroku with:'
+        say '  $ bin/deploy'
+      end
+    end
+
+    protected
+
+    def get_builder_class
+      WagonRails::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/wagon_rails/version.rb

@@ -0,0 +1,5 @@
+module WagonRails
+  RAILS_VERSION = "4.2.0"
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = "0.1.0"
+end

data/lib/wagon_rails.rb

@@ -0,0 +1,4 @@
+require 'wagon_rails/version'
+require 'wagon_rails/generators/app_generator'
+require 'wagon_rails/actions'
+require 'wagon_rails/app_builder'

data/templates/Gemfile.erb

@@ -0,0 +1,42 @@
+source "https://rubygems.org"
+source "https://rails-assets.org"
+
+ruby "<%= WagonRails::RUBY_VERSION %>"
+
+gem "rails", "<%= WagonRails::RAILS_VERSION %>"
+gem "pg"
+gem "figaro"
+gem "simple_form"
+gem "country_select"
+gem "high_voltage"
+gem "devise"
+gem "pundit"
+gem "paperclip"
+gem "aws-sdk"
+
+gem "jquery-rails"
+gem "sass-rails", "~> 5.0"
+gem "uglifier"
+gem "bootstrap-sass"
+gem "font-awesome-sass"
+
+gem "rails-i18n"
+gem "devise-i18n"
+gem "devise-i18n-views"
+
+group :development, :test do
+  gem "spring"
+  gem "annotate"
+  gem "binding_of_caller"
+  gem "better_errors"
+  gem "quiet_assets"
+  gem "pry-byebug"
+  gem "pry-rails"
+  gem "letter_opener"
+end
+
+group :production do
+  gem "rails_12factor"
+  gem "puma"
+  gem "rack-timeout"
+end

data/templates/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -C config/puma.rb

data/templates/README.md.erb

@@ -0,0 +1,32 @@
+# <%= app_name.humanize %>
+
+## Getting Started
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+    % ./bin/setup
+
+It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up
+your machine with [this script].
+
+[this script]: https://github.com/thoughtbot/laptop
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+If you don't have `foreman`, see [Foreman's install instructions][foreman]. It
+is [purposefully excluded from the project's `Gemfile`][exclude].
+
+[foreman]: https://github.com/ddollar/foreman
+[exclude]: https://github.com/ddollar/foreman/pull/437#issuecomment-41110407
+
+## Guidelines
+
+Use the following guides for getting things done, programming well, and
+programming in style.
+
+* [Protocol](http://github.com/thoughtbot/guides/blob/master/protocol)
+* [Best Practices](http://github.com/thoughtbot/guides/blob/master/best-practices)
+* [Style](http://github.com/thoughtbot/guides/blob/master/style)

data/templates/_flashes.html.erb

@@ -0,0 +1,18 @@
+<div class="container">
+  <div class="row">
+    <div class="col-xs-12">
+      <% if notice %>
+        <div class="alert alert-info alert-dismissible" role="alert">
+          <button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+          <%= notice %>
+        </div>
+      <% end %>
+      <% if alert %>
+        <div class="alert alert-warning alert-dismissible" role="alert">
+          <button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+          <%= alert %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/templates/action_mailer.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end

data/templates/application.js

@@ -0,0 +1,9 @@
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap-sprockets
+
+//= require_tree ./app
+
+
+// Please do not put any code in here. Create a new .js file in
+// app/assets/javascripts/app instead, and put your code there

data/templates/application.yml

@@ -0,0 +1,6 @@
+# This file is not versioned by git, so not shared on GitHub
+# If you add something here, inform your colleagues over a **secure** channel.
+
+S3_BUCKET_NAME: "TODO"
+AWS_ACCESS_KEY_ID: "TODO"
+AWS_SECRET_ACCESS_KEY: "TODO"

data/templates/application_controller.rb

@@ -0,0 +1,26 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+  before_filter :authenticate_user!, unless: :pages_controller?
+
+  include Pundit
+  protect_from_forgery
+  after_action :verify_authorized, except: :index, unless: :devise_or_pages_controller?
+  after_action :verify_policy_scoped, only: :index, unless: :devise_or_pages_controller?
+
+  rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
+
+  private
+
+  def user_not_authorized
+    flash[:error] = I18n.t('controllers.application.user_not_authorized', default: "You can't access this page.")
+    redirect_to(tracks_path)
+  end
+
+  def devise_or_pages_controller?
+    devise_controller? || pages_controller?
+  end
+
+  def pages_controller?
+    controller_name == "pages"  # Brought by the `high_voltage` gem
+  end
+end

data/templates/bin_deploy

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# Run this script to deploy the app to Heroku.
+
+set -e
+
+git push heroku master
+heroku run rake db:migrate
+heroku restart

data/templates/config_i18n_tasks.yml

@@ -0,0 +1,13 @@
+search:
+  paths:
+    - "app/controllers"
+    - "app/helpers"
+    - "app/presenters"
+    - "app/views"
+
+ignore_unused:
+  - activerecord.*
+  - date.*
+  - simple_form.*
+  - time.*
+  - titles.*

data/templates/devise_registrations_new.html.erb

@@ -0,0 +1,16 @@
+<div class="container">
+  <div class="row">
+    <div class="col-sm-6 col-sm-offset-3">
+      <h2><%= t('.sign_up', default: "Sign up") %></h2>
+      <%= simple_form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+        <%= f.error_notification %>
+
+        <%= f.input :email, required: true, autofocus: true %>
+        <%= f.input :password, required: true %>
+        <%= f.button :submit, t('.sign_up', default: "Sign up"), class: "btn btn-primary" %>
+      <% end %>
+
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/templates/devise_sessions_new.html.erb

@@ -0,0 +1,16 @@
+<div class="container">
+  <div class="row">
+    <div class="col-xs-12 col-sm-6 col-sm-offset-3">
+      <h2><%= t(".sign_in", default: "Sign in") %></h2>
+
+      <%= simple_form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
+          <%= f.input :email, required: false, autofocus: true %>
+          <%= f.input :password, required: false %>
+          <%= f.input :remember_me, as: :boolean if devise_mapping.rememberable? %>
+          <%= f.button :submit, t(".sign_in", default: "Sign in"), class: "btn btn-primary" %>
+      <% end %>
+
+      <%= render "devise/shared/links" %>
+    </div>
+  </div>
+</div>

data/templates/disable_xml_params.rb

@@ -0,0 +1,3 @@
+# Protect against injection attacks
+# http://www.kb.cert.org/vuls/id/380039
+ActionDispatch::ParamsParser::DEFAULT_PARSERS.delete(Mime::XML)

data/templates/errors.rb

@@ -0,0 +1,34 @@
+require "net/http"
+require "net/smtp"
+
+# Example:
+#   begin
+#     some http call
+#   rescue *HTTP_ERRORS => error
+#     notify_hoptoad error
+#   end
+
+HTTP_ERRORS = [
+  EOFError,
+  Errno::ECONNRESET,
+  Errno::EINVAL,
+  Net::HTTPBadResponse,
+  Net::HTTPHeaderSyntaxError,
+  Net::ProtocolError,
+  Timeout::Error
+]
+
+SMTP_SERVER_ERRORS = [
+  IOError,
+  Net::SMTPAuthenticationError,
+  Net::SMTPServerBusy,
+  Net::SMTPUnknownError,
+  TimeoutError
+]
+
+SMTP_CLIENT_ERRORS = [
+  Net::SMTPFatalError,
+  Net::SMTPSyntaxError
+]
+
+SMTP_ERRORS = SMTP_SERVER_ERRORS + SMTP_CLIENT_ERRORS

data/templates/high_voltage.rb

@@ -0,0 +1,4 @@
+HighVoltage.configure do |config|
+  config.home_page = 'home'
+  config.route_drawer = HighVoltage::RouteDrawers::Root
+end

data/templates/json_encoding.rb

@@ -0,0 +1 @@
+ActiveSupport::JSON::Encoding.time_precision = 0

data/templates/paperclip.rb

@@ -0,0 +1,8 @@
+Paperclip::Attachment.default_options[:storage] = :s3
+Paperclip::Attachment.default_options[:url] = ':s3_domain_url'
+Paperclip::Attachment.default_options[:path] = '/:rails_env/:class/:attachment/:id_partition/:style/:filename'
+Paperclip::Attachment.default_options[:s3_credentials] = {
+  bucket:             ENV['S3_BUCKET_NAME'],        # \
+  access_key_id:      ENV['AWS_ACCESS_KEY_ID'],     #  |- DO NOT replace this
+  secret_access_key:  ENV['AWS_SECRET_ACCESS_KEY']  # /
+}

data/templates/postgresql_database.yml.erb

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

data/templates/puma.rb

@@ -0,0 +1,15 @@
+workers Integer(ENV['WEB_CONCURRENCY'] || 2)
+threads_count = Integer(ENV['MAX_THREADS'] || 5)
+threads threads_count, threads_count
+
+preload_app!
+
+rackup      DefaultRackup
+port        ENV['PORT']     || 3000
+environment ENV['RACK_ENV'] || 'development'
+
+on_worker_boot do
+  # Worker specific setup for Rails 4.1+
+  # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot
+  ActiveRecord::Base.establish_connection
+end

data/templates/rack_timeout.rb

@@ -0,0 +1,3 @@
+if defined?(Rack::Timeout)
+  Rack::Timeout.timeout = (ENV["RACK_TIMEOUT"] || 25).to_i
+end

data/templates/smtp.rb

@@ -0,0 +1,8 @@
+ActionMailer::Base.smtp_settings = {
+  :port =>           '587',
+  :address =>        'smtp.mandrillapp.com',
+  :user_name =>      ENV['MANDRILL_USERNAME'],
+  :password =>       ENV['MANDRILL_APIKEY'],
+  :domain =>         'heroku.com',
+  :authentication => :plain
+}

data/templates/wagon_rails_gitignore

@@ -0,0 +1,12 @@
+!.keep
+*.DS_Store
+*.swo
+*.swp
+/.bundle
+/.foreman
+/log/*
+/public/system
+/public/assets
+/tags
+/tmp/*
+/config/application.yml

data/templates/wagon_rails_home.html.erb

@@ -0,0 +1,28 @@
+<%= content_for(:title) do %>
+  Home
+<% end %>
+
+<%= content_for(:description) do %>
+  <%# TODO %>
+<% end %>
+
+<div class="container">
+  <div class="row">
+    <div class="col-xs-12 col-sm-8 col-sm-offset-2">
+      <h1>Welcome!</h1>
+
+      <h2>This is the homepage</h2>
+
+      <p>
+        Find me in <code>app/views/pages/home.html.erb</code>
+      </p>
+
+      <p>
+        Thanks to the <a href="https://github.com/thoughtbot/high_voltage">high_voltage</a>
+        gem, if you need more static pages (like <code>/contact</code> or <code>/about-us</code>),
+        just create a file in the <code>app/views/pages</code> folder, the route will be automatically
+        available without you adding any controller or touching the <code>config/routes.rb</code> file!
+      </p>
+    </div>
+  </div>
+</div>

data/templates/wagon_rails_layout.html.erb.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%%= yield(:title) || "Wagon Rails" %></title>
+  <meta name="description" content="<%%= (yield(:description) || "").squish %>">
+
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <%%= stylesheet_link_tag :application, media: "all" %>
+  <%%= csrf_meta_tags %>
+</head>
+<body>
+  <%%= render "shared/navbar" %>
+  <%%= render "shared/flashes" %>
+
+  <%%= yield %>
+
+  <%%= javascript_include_tag :application %>
+  <%%= yield(:after_js) %>
+
+</body>
+</html>

data/wagon_rails.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'wagon_rails/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= #{WagonRails::RUBY_VERSION}"
+  s.authors = ['ssaunier']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+WagonRails is a base Rails project with all the best practises and gems
+taught at Le Wagon's FullStack Bootcamp. Students can jump start their
+project without losing one day to set up everything.
+  HERE
+
+  s.email = 'seb@lewagon_rails'
+  s.executables = ['wagon_rails']
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/lewagon/wagon_rails'
+  s.license = 'MIT'
+  s.name = 'wagon_rails'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using Le Wagon's best practices (FullStack Bootcamp)"
+  # s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = WagonRails::VERSION
+
+  s.add_dependency 'bundler', '~> 1.3'
+  s.add_dependency 'rails', WagonRails::RAILS_VERSION
+
+  # s.add_development_dependency 'rspec', '~> 2.0'
+  # s.add_development_dependency 'capybara', '~> 2.2', '>= 2.2.0'
+end