code42template 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25f9b6b6283c1adf734c7de322de2cad8a852a2b
+  data.tar.gz: 542e7cfd66f20c16858cab5a6fb45a1360326d7c
+SHA512:
+  metadata.gz: 4d469c1365c42a9e90dad4acd623984f85f1ee14d406c9f8ad596b713b0011cb33847a82ba34039571824a6520b83f1c60d6a635735be9725e6fcec7ed6b1010
+  data.tar.gz: 98b2e35b070cdadbbf7f7976df6b2e8a8b3dfa5723cc2eca0b1aae609419af9d39ce1efddc31bc68a4596de2f9caaa00c7e0d4303ff3150f89d82f857e9536bd

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+*.swp
+Gemfile.lock
+/.bundle
+/tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm: 2.3.0
+cache: bundler
+sudo: false
+before_install:
+  - "echo '--colour' > ~/.rspec"
+  - git config --global user.name 'Travis CI'
+  - git config --global user.email 'travis-ci@example.com'
+install: bundle install
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/NEWS.md

@@ -0,0 +1,56 @@
+0.0.1 (January 28 2016)
+
+* Initial setup
+* Ruby 2.3.0
+* Rails 4.2.5
+* App layout and flashes
+* Customize error pages
+* Git init and .gitignore
+* Postgresql as database
+* pt-BR locale
+* Readme
+* Remove config and routes comment lines
+* Setup script
+* Setup secret token
+
+1.0.0 (April 06 2016)
+
+* Add `quiet_assets` as development dependency
+* Generate rake, rails and rspec binstubs with Spring
+* Make Shoulda Matchers work with Spring
+* Add `binding_of_caller` gem
+* Add `better_errors` gem
+* Add `pry-byebug` and `pry-rails` gems
+* Add `bullet` as development dependency
+* Add Bundler Audit to scan Gemfile for insecure dependencies per CVEs.
+* Add Dotenv to development and test environments to load environment variables from the `.env` file.
+* Add `brakeman`
+* Add `letter_opener`
+* Add `rubocop`
+
+1.0.1 (July 02 2016)
+
+* Fix bug: remove missing jquery from generated application.js
+
+2.0.0 (July 27 2016)
+
+* Setup rspec with reasonable default settings out of the box
+* Setup capybara and database\_cleaner out of the box
+* Include optional config for phantomjs / poltergeist
+* Include webpack (webpack-rails) and NPM to replace sprockets' JS
+* use foreman to manage processes: rails server, webpack dev server and sidekiq 
+* Include JS test runners: karma and mocha
+* Upgrade Ruby to 2.3.1
+* Upgrade Rails to 5.0
+* Drop quiet\_assets in favor of Rails 5' native similar feature
+* Add Heroku support upon app creation
+* Tune up deploy with Heroku
+* Add Puma as the default application server
+* Add codeclimate configuration
+* Add sidekiq / ActiveJob as background job runner
+* Add rubocop configuration
+* Add rake health command and make CI use it
+* Cleanup unnecessary gems
+* Improve bin/setup script
+* Do not remove comments from generated files anymore
+* Improve README

data/README.md

@@ -0,0 +1,280 @@
+# Code42Template
+
+This is the base application used at [Codeminer
+42](http://www.codeminer42.com/). It uses **Rails 5** to manage the backend and
+**Node.js / Webpack** to manage the frontend. The purpose of this project is
+to:
+
+- Provide a minimal and well-configured application generator.
+- Improve some Rails defaults.
+- Unleash the full power of the JavaScript ecosystem within Rails by making it
+  a **first class citizen**. We replace JS sprockets with **Webpack**.
+- Enforce **code style guidelines**.
+- Provide _basic_ **security**.
+- Have Ruby and JS test frameworks configured out of the box with a few
+  hand-picked tools.
+- Provide opinionated defaults on infrastructure: **Travis** for CI and
+**Heroku** deploys working out of the box. We want apps to leverage the best
+Heroku has to offer, such as decreased devops maintenance burden, pipelines,
+review apps, etc.
+
+This template does **NOT** aim to:
+
+- Encourage having too many dependencies. Dependencies are not cheap, and each
+  bundled tool must have a _good_ reason to be included.
+- Make you use JavaScript for everything, but rather to provide better
+  tools to work with the language. Just because we use Webpack it does not
+  mean you have to turn your app into an SPA.
+- Provide "pattern" gems (e.g. decorator). Patterns are usually
+  project-specific and most of them can be achieved **without** any gems or
+  libraries.
+- Be a silver bullet. This is tailored for the majority of Rails applications
+  you may want to build, but we know it won't work sometimes.
+
+## Pre-requisites
+
+- [Ruby](https://www.ruby-lang.org) >= 2.3.1
+- [Bundler](http://bundler.io/)
+- Either [rbenv](https://github.com/rbenv/rbenv) /
+[ruby-build](https://github.com/rbenv/ruby-build) or
+[rvm](https://github.com/rvm/rvm)
+- [Node.js](https://nodejs.org) >= 6.2.0
+- [NPM](https://www.npmjs.com/)
+- [nvm](https://github.com/creationix/nvm)
+- [Git](https://git-scm.com/)
+- [PostgreSQL](https://www.postgresql.org/)
+- [Heroku Toolbelt](https://toolbelt.heroku.com/)
+- [Redis](http://redis.io/) - primarily for use with [Sidekiq](http://sidekiq.org/)
+- [PhantomJS](http://phantomjs.org/)
+
+
+## Installation
+
+Install the gem:
+
+```sh
+gem install code42template
+```
+
+This will make the `code42template` command accessible throughout your `PATH`.
+
+## Configuring your environment
+
+### PostgreSQL
+
+**development** and **test** databases are automatically setup for you.
+While running the generator it's assumed that:
+
+- The PostgreSQL server is running.
+- You have a PostgreSQL user named after your UNIX login.
+- Your PostgreSQL user has a _blank_ password.
+
+It's OK if your PG settings happen to be different from this; DB creation will
+fail, but you can do it manually thereafter.
+
+At a basic level, here's how to setup PostgreSQL on Linux:
+
+```sh
+# Creates a user
+sudo -u postgres createuser -s my_user_name
+
+# Runs psql
+sudo -u postgres psql
+
+# Change your use password within psql. Leave it blank.
+[local] thiago@thiago=# \password my_user_name
+```
+
+### Heroku
+
+Automatic Heroku setup is optional, but if you want to use it we assume you've
+already logged in with your Heroku credentials. If you haven't, you'll need to
+run `heroku login`. Also remember to set the correct account if you happen to
+use the [multiple accounts](https://github.com/heroku/heroku-accounts) plugin.
+
+## Generating your app
+
+You can generate a new app with the following command:
+
+```sh
+code42template myapp
+```
+
+To generate and configure your new app with Heroku:
+
+```sh
+code42template myapp --heroku true
+```
+
+## Starting up your app
+
+```sh
+$ cd my_app_folder
+$ foreman start
+```
+
+This command runs Webpack dev server, Rails server and Sidekiq all at once.
+Note that Your redis server has to be up and running because of Sidekiq. To
+customize these processes you can edit `Procfile`.
+
+Now you can work as you'd usually work in any Rails application, with automatic
+Ruby and JS file reloads out of the box.
+
+## Basic hands-on guide
+
+### App setup
+
+Your team can use the following command after cloning the git repository:
+
+```sh
+bin/setup
+```
+### Deploy
+
+Deploy your app with the following command:
+
+```sh
+# Replace `MY_ENV` with `production` or `staging`.
+bin/deploy MY_ENV
+```
+
+This command pushes your code to Heroku, migrates your database and restarts
+your dynos. It will work out of the box if you've generated your app with
+`--heroku true`. If not, please create `staging` and `production` git remotes
+pointing to the respective Heroku remotes.
+
+### Health check
+
+Check your app's health with the `rake health` command. It runs the following
+tasks:
+
+- `rspec` runs your Ruby and Rails specs.
+- If you app happens to be below 90% test coverage the `rspec` command will fail.
+- `npm run test`: runs JS unit and integration tests
+- `bundle-audit` and `brakeman` check if your app does not have basic
+  security holes.
+- `rubocop` makes sure your code adheres to style guidelines.
+
+### Continuous integration
+
+A `travis.yml` file is also included: it runs the `rake health` command, among
+other setup tasks. You must still manually configure your remote repo with
+Travis integration, though.
+
+### Improved JavaScript
+
+JS files must live at the `app/assets/javascripts` folder. JS packages can be
+managed with NPM and the `package.json` file.
+
+You can write your JS code in **ES2015** because of
+[babel](https://babeljs.io/). ES2015 Import statements will automatically work
+without having to specify the full path.
+
+### CSS
+
+We still use the asset pipeline for CSS.
+
+### Testing
+
+#### Ruby tests
+
+Use the following command to run all your specs:
+
+```sh
+rspec
+```
+
+We use the following tools:
+
+- [rspec](https://github.com/rspec/rspec)
+- [capybara](https://github.com/jnicklas/capybara) and
+  [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner)
+- [factory_girl](https://github.com/thoughtbot/factory_girl)
+- [poltergeist](https://github.com/teampoltergeist/poltergeist) (for JS feature
+  tests)
+- [simplecov](https://github.com/colszowka/simplecov) for helping out with test
+  coverage
+
+
+Refer to the [rspec-rails](https://github.com/rspec/rspec-rails) to learn which
+kinds of specs are available.
+
+Note that you can require the following files to setup your tests:
+
+- For light unit tests you can require `spec_helper.rb`. It won't boot up
+  the Rails environment.
+- For tests needing Rails you can require `rails_helper.rb`.
+- For feature tests require `feature_helper.rb`. It will compile your assets
+  and make feature tests run correctly.
+
+Regarding feature tests, they are configured to run seamlessly with Webpack.
+
+#### JavaScript tests
+
+JavaScript tests must live at the `spec/javascripts` folder. Some smoke
+tests are included in every app.
+
+- `mocha` is used for unit tests. Unit tests **must not depend** on global JS
+objects such as `window`. They must live at `spec/javascripts/unit` and can be
+run with:
+
+        npm test:unit
+        npm test:unit:watch # runs tests automatically in every change
+
+- `karma` and `phantomjs` are used for integration tests. That means you _can_
+use browser-only global JS objects such as `window`. They must live at
+`spec/javascript/integration` and can be run with:
+
+        npm test:integration
+        npm test:integration:watch
+
+- Run _all_ the tests (unit + integration) with the following command:
+
+        npm test
+
+- Debug your tests in the browser with webpack-dev-server. This command will
+output a URL where you can run all tests:
+
+        npm test:browser
+
+### Application server
+
+We use [puma](https://github.com/puma/puma) as our application server, which
+happens to be [Heroku's default
+recommendation](https://devcenter.heroku.com/changelog-items/594).
+        
+### Background jobs
+
+Our tool of choice is Sidekiq, which is configured as ActiveJob's backend. We
+include a `sidekiq.yml` configuration file with default settings, but you are
+encouraged to tune it to your application needs.
+
+### Debugging
+
+- [pry-rails](https://github.com/rweng/pry-rails)
+- [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug)
+- [better-errors](https://github.com/charliesome/better_errors) instead of Web
+  Console.
+
+### Performance and Profiling
+
+* [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler) for
+helping out with performance issues
+* [spring](https://github.com/rails/spring) for fast Rails actions via
+pre-loading
+* [bullet](https://github.com/flyerhzm/bullet) yeah, it's very easy to miss out
+N+1 queries, that's why we include this gem by default
+
+Spring binstubs are automatically generated within the `bin` folder.
+
+### Environment variables
+
+* [Dotenv](https://github.com/bkeepers/dotenv) for loading environment variables
+
+## Credits
+
+The template uses the [Suspenders](https://github.com/thoughtbot/suspenders)
+gem from Thoughtbot as starting point.
+
+[![codeminer42](http://s3.amazonaws.com/cm42_prod/assets/logo-codeminer-horizontal-c0516b1b78a8713270da02c3a0645560.png)](http://codeminer42.com)
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+desc 'Run the test suite'
+task :default => :rspec

data/bin/code42template

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'code42template/version'
+
+if Code42Template::RUBY_VERSION != ::RUBY_VERSION
+  abort "ERROR: You must use this tool with Ruby version #{Code42Template::RUBY_VERSION}"
+end
+
+require 'code42template'
+
+if ['-v', '--version'].include? ARGV[0]
+  puts Code42Template::VERSION
+  exit 0
+end
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Code42Template::AppGenerator.source_root templates_root
+Code42Template::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Code42Template::AppGenerator.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# Run this script immediately after cloning the codebase.
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Add binstubs to PATH in ~/.zshenv like this:
+#   export PATH=".git/safe/../../bin:$PATH"
+mkdir -p .git/safe

data/code42template.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'code42template/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= #{Code42Template::RUBY_VERSION}"
+  s.authors = ['codeminer42']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+code42template is the base Rails project used at Codeminer 42.
+  HERE
+
+  s.email = 'suporte@codeminer42.com'
+  s.executables = ['code42template']
+  s.extra_rdoc_files = %w[README.md]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/Codeminer42/code42template'
+  s.name = 'code42template'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a minimal Rails / Webpack app."
+  s.version = Code42Template::VERSION
+
+  s.add_dependency 'bundler'
+  s.add_dependency 'rails', Code42Template::RAILS_VERSION
+
+  s.add_development_dependency 'rspec'
+end

data/lib/code42template/actions.rb

@@ -0,0 +1,28 @@
+module Code42Template
+  module Actions
+    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 configure_application_file(config)
+      inject_into_file(
+        "config/application.rb",
+        "\n\n    #{config}",
+        before: "\n  end"
+      )
+    end
+
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  #{config}",
+        before: "\nend"
+      )
+    end
+  end
+end

data/lib/code42template/adapters/heroku.rb

@@ -0,0 +1,174 @@
+module Code42Template
+  module Adapters
+    class Heroku
+      HEROKU_BUILDPACK_URLS = %w(
+        heroku/nodejs
+        heroku/ruby
+        https://github.com/febeling/webpack-rails-buildpack.git
+      )
+
+      def initialize(app_builder)
+        @app_builder = app_builder
+      end
+
+      def create_heroku_apps(flags)
+        create_staging_heroku_app(flags)
+        create_production_heroku_app(flags)
+      end
+
+      def create_deploy_script
+        @app_builder.copy_file "bin_deploy", "bin/deploy"
+        @app_builder.run "chmod a+x bin/deploy"
+      end
+
+      def update_readme_with_deploy
+        instructions = <<~MARKDOWN
+        ## Deploying
+
+        If you have previously run the `./bin/setup` script,
+        you can deploy to staging and production with:
+
+            $ ./bin/deploy staging
+            $ ./bin/deploy production
+
+        We currently use the following buildpacks:
+
+        - heroku/nodejs
+        - heroku/ruby
+        - https://github.com/febeling/webpack-rails-buildpack.git
+
+        Please be sure to configure these buildpacks in the same sequence
+        presented here in both staging and production, or else the deploy will
+        not work.
+        MARKDOWN
+
+        @app_builder.append_file "README.md", instructions
+      end
+
+      def set_heroku_remotes
+        remotes = <<~SHELL
+          #{command_to_join_heroku_app('staging')}
+          #{command_to_join_heroku_app('production')}
+
+          git config heroku.remote staging
+        SHELL
+
+        @app_builder.append_file 'bin/setup', remotes
+      end
+
+      def create_staging_heroku_app(flags)
+        app_name = heroku_app_name_for('staging')
+
+        run_toolbelt_command "create #{app_name} #{flags}", "staging"
+      end
+
+      def create_production_heroku_app(flags)
+        app_name = heroku_app_name_for('production')
+
+        run_toolbelt_command "create #{app_name} #{flags}", "production"
+      end
+
+      def set_heroku_rails_secrets
+        %w(staging production).each do |environment|
+          run_toolbelt_command(
+            "config:add SECRET_KEY_BASE=#{generate_secret}",
+            environment,
+          )
+        end
+      end
+
+      def set_heroku_rails_environment
+        %w(staging production).each do |environment|
+          run_toolbelt_command("config:add RAILS_ENV=production", environment)
+        end
+      end
+
+      def create_review_apps_setup_script
+        @app_builder.template(
+          'bin_setup_review_app.erb',
+          'bin/setup_review_app',
+          force: true,
+        )
+        @app_builder.run 'chmod a+x bin/setup_review_app'
+      end
+
+      def create_heroku_pipeline
+        run_toolbelt_command(
+          "pipelines:create #{heroku_app_name} \
+            -a #{heroku_app_name}-staging --stage staging",
+          'staging',
+        )
+
+        run_toolbelt_command(
+          "pipelines:add #{heroku_app_name} \
+            -a #{heroku_app_name}-production --stage production",
+          'production',
+        )
+      end
+
+      def configure_heroku_buildpacks
+        %w(staging production).each do |environment|
+          app_name = heroku_app_name_for(environment)
+
+          run_toolbelt_command("buildpacks:clear -a #{app_name}", environment)
+
+          HEROKU_BUILDPACK_URLS.each do |buildpack_url|
+            run_toolbelt_command(
+              "buildpacks:add #{buildpack_url} -a #{app_name}",
+              environment
+            )
+          end
+        end
+      end
+
+      def set_heroku_serve_static_files
+        %w(staging production).each do |environment|
+          run_toolbelt_command(
+            'config:add RAILS_SERVE_STATIC_FILES=true',
+            environment,
+          )
+        end
+      end
+
+      def set_heroku_application_host
+        %w(staging production).each do |environment|
+          run_toolbelt_command(
+            "config:add APPLICATION_HOST=#{heroku_app_name}-#{environment}.herokuapp.com",
+            environment,
+          )
+        end
+      end
+
+      private
+
+      def command_to_join_heroku_app(environment)
+        heroku_app_name = heroku_app_name_for(environment)
+
+        <<~SHELL
+        if heroku join --app #{heroku_app_name} &> /dev/null; then
+          git remote add #{environment} git@heroku.com:#{heroku_app_name}.git || true
+          printf 'You are a collaborator on the "#{heroku_app_name}" Heroku app\n'
+        else
+          printf 'Ask for access to the "#{heroku_app_name}" Heroku app\n'
+        fi
+        SHELL
+      end
+
+      def heroku_app_name
+        @app_builder.app_name.dasherize
+      end
+
+      def heroku_app_name_for(environment)
+        "#{heroku_app_name}-#{environment}"
+      end
+
+      def generate_secret
+        SecureRandom.hex(64)
+      end
+
+      def run_toolbelt_command(command, environment)
+        @app_builder.run("heroku #{command} --remote #{environment}")
+      end
+    end
+  end
+end