gnarails 0.9.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 The Gnar Company
+
+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,136 @@
+# Gnarails
+
+Create a gnarly rails app, ready to go with all the base functionality you can
+expect from any rails application developed by The Gnar Company.
+
+## Usage
+
+This template relies on pronto, which needs [cmake](https://cmake.org/) installed.
+
+### Using the CLI
+
+```sh
+$ gem install gnarails
+$ gnarails new <APP_NAME>
+```
+
+### Using the template
+
+If you want to reference the template directly and don't want to use the
+gnarails CLI command, you may clone the project (or reference the template from
+its HTTP location on github):
+
+```sh
+$ rails new <APP_NAME> -m https://raw.githubusercontent.com/TheGnarCo/gnarails/master/gnarly.rb --skip-test-unit --database=postgresql
+```
+
+A`.railsrc` is provided. If you'd like to symlink it to your home directory, it'll run `rails new` with the options to run with postgres and not including test-unit. This `.railsrc` can be personalized to include the `--template=path/to/gnarly.rb` option depending on where you locally store this repo if you'd like to use this template every time.
+
+## Usage with React
+
+### Using the CLI
+
+```sh
+$ gem install gnarails
+$ gnarails new <APP_NAME> --webpack=react
+```
+
+### Using the template
+
+```sh
+$ rails new <APP_NAME> -m https://raw.githubusercontent.com/TheGnarCo/gnarails/master/gnarly.rb --skip-test-unit --database=postgresql --webpack=react
+```
+
+## Post-Install
+
+```sh
+$ cd <APP_NAME>
+$ bin/bundle
+$ bin/rails db:create
+$ bin/rails db:migrate
+```
+
+_For React Apps_
+
+```sh
+$ bin/yarn
+$ bin/yarn test
+```
+
+### Setting up pronto on CI
+
+Pronto can be used to comment on pull requests for various automated checks of
+changes made in a particular diff. To complete the setup of this tool for your
+repository, you must identify a github account that pronto will comment as on
+every PR, and update the following:
+
+* Generate a Personal Access Token from the github account.
+  - Settings > Developer settings > Personal access tokens > Generate new token.
+  - Use the repo name for the token description.
+  - Provide the repo scope.
+  - Generate the token.
+  - Store/copy the token temporarily.
+
+* Store the token value in circle.
+  - Find the repo settings.
+  - Build Settings > Environment Variables.
+  - Add Variable.
+  - Name the variable `PRONTO_GITHUB_ACCESS_TOKEN` with the value from the previous Personal Access Token.
+
+## Usage with Docker
+
+A `Dockerfile` and `docker-compose.yml` file are created by default. When run with `--webpack=react`,
+there are two `Dockerfile`s: one for the Rails server and one for the assets server.
+
+To use Docker, run:
+
+```sh
+docker-compose build
+```
+
+then set up the database:
+
+```sh
+docker-compose run web rails db:create
+docker-compose run web rails db:migrate
+```
+
+finally, start the server and visit `localhost:3000`:
+
+```sh
+docker-compose up
+```
+
+## Switching out Capybara Driver
+If you'd like to not run your tests headless, for example, to troubleshoot an issue and see what's on the screen, modify the `driven_by` driver in `spec/support/system_test_configuration.rb` to use `:selenium_chrome` instead of `:selenium_chrome_headless`. After the change, this block should look as follows:
+
+```ruby
+config.before(:each, type: :system, js: true) do
+  driven_by :selenium_chrome
+end
+```
+
+## Running the Application
+
+```sh
+$ bin/rails s
+```
+
+_For React Apps_
+
+In a separate terminal window/tab
+
+```sh
+$ bin/yarn start
+```
+
+Visit `localhost:3000` in your browser
+
+## About The Gnar Company
+
+![The Gnar Company](https://avatars0.githubusercontent.com/u/17011419?s=100&v=4)
+
+The Gnar Company is a Boston-based development company that builds robust
+web and mobile apps designed for the long haul.
+
+For more information see [our website](https://www.thegnar.co/).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/ci_pronto

@@ -0,0 +1,6 @@
+#!/bin/bash
+#
+# Script for running pronto on CI
+export PRONTO_PULL_REQUEST_ID=${CI_PULL_REQUEST##*/}
+
+bundle exec pronto run -f text github_pr github_status -c origin/master

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gnarails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/generate-react-test-app.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec exe/gnarails new rails-react-test-app --webpack=react

data/bin/generate-test-app.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+bundle exec exe/gnarails new rails-test-app
+
+mkdir rails-test-app/app/views/job_postings
+mkdir rails-test-app/db/migrate
+mkdir rails-test-app/spec/factories
+mkdir rails-test-app/spec/models
+mkdir rails-test-app/spec/system
+mkdir rails-test-app/spec/requests
+
+cp test-app/app/controllers/job_postings_controller.rb rails-test-app/app/controllers/job_postings_controller.rb
+cp test-app/app/models/job_posting.rb rails-test-app/app/models/job_posting.rb
+cp test-app/app/models/comment.rb rails-test-app/app/models/comment.rb
+cp test-app/app/views/job_postings/index.html.erb rails-test-app/app/views/job_postings/index.html.erb
+yes | cp test-app/app/views/layouts/application.html.erb rails-test-app/app/views/layouts/application.html.erb
+yes | cp test-app/config/routes.rb rails-test-app/config/routes.rb
+cp test-app/db/migrate/20170918002433_create_job_postings.rb rails-test-app/db/migrate/20170918002433_create_job_postings.rb
+cp test-app/db/migrate/20170918002455_create_comments.rb rails-test-app/db/migrate/20170918002455_create_comments.rb
+cp test-app/spec/factories/job_postings.rb rails-test-app/spec/factories/job_postings.rb
+cp test-app/spec/models/job_posting_spec.rb rails-test-app/spec/models/job_posting_spec.rb
+cp test-app/spec/system/viewing_all_job_postings_spec.rb rails-test-app/spec/system/viewing_all_job_postings_spec.rb
+cp test-app/spec/requests/status_spec.rb rails-test-app/spec/requests/status_spec.rb

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test-setup.sh

@@ -0,0 +1,8 @@
+sh ./bin/generate-test-app.sh
+
+cd rails-test-app
+bundle
+bundle exec rake db:drop
+bundle exec rake db:setup
+bundle exec rails db:migrate
+cd ..

data/exe/gnarails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "gnarails"
+Gnarails::Cli::Application.start(ARGV)

data/gnarails.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gnarails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gnarails"
+  spec.version       = Gnarails::VERSION
+  spec.authors       = ["The Gnar Company"]
+  spec.email         = ["hi@thegnar.co"]
+
+  spec.summary       = "Easily create a gnarly rails app."
+  spec.homepage      = "https://github.com/TheGnarCo/gnarails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "rails"
+  spec.add_dependency "rspec-rails"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "gnar-style"
+  spec.add_development_dependency "pronto"
+  spec.add_development_dependency "pronto-rubocop"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/gnarly.rb

@@ -0,0 +1,395 @@
+# Add the current directory to the path Thor uses
+# to look up files
+def source_paths
+  Array(super) +
+    [File.expand_path(File.dirname(__FILE__))]
+end
+
+RUBY_VERSION = "2.5.0".freeze
+
+JS_DEPENDENCIES = [
+  "babel-preset-es2015".freeze,
+  "babel-preset-stage-0".freeze,
+  "classnames".freeze,
+  "es6-object-assign".freeze,
+  "es6-promise".freeze,
+  "history".freeze,
+  "lodash".freeze,
+  "react-entity-getter".freeze,
+  "react-redux".freeze,
+  "react-router".freeze,
+  "react-router-dom".freeze,
+  "react-router-redux@next".freeze,
+  "redux".freeze,
+  "redux-form".freeze,
+  "redux-thunk".freeze,
+  "schlepp".freeze,
+].freeze
+
+JS_DEV_DEPENDENCIES = [
+  "babel-eslint".freeze,
+  "enzyme".freeze,
+  "enzyme-adapter-react-16".freeze,
+  "eslint".freeze,
+  "eslint-config-airbnb".freeze,
+  "eslint-plugin-import".freeze,
+  "eslint-plugin-jsx-a11y@^5.1.1".freeze,
+  "eslint-plugin-react".freeze,
+  "expect".freeze,
+  "jsdom".freeze,
+  "mocha".freeze,
+  "nock".freeze,
+  "react-dom".freeze,
+  "react-test-renderer".freeze,
+  "redux-mock-store".freeze,
+].freeze
+
+def create_gnarly_rails_app
+  add_gems
+  setup_database
+  add_ruby_version
+  setup_scss
+  setup_gitignore
+  setup_testing
+  setup_analysis
+  setup_environments
+  setup_readme
+  post_bundle
+end
+
+def add_gems
+  gem_group :development, :test do
+    gem 'axe-matchers'
+    gem 'bullet'
+    gem 'bundler-audit'
+    gem 'capybara'
+    gem 'dotenv-rails'
+    gem 'factory_bot_rails'
+    gem 'gnar-style', require: false
+    gem 'lol_dba'
+    gem 'okcomputer'
+    gem 'pronto'
+    gem 'pronto-brakeman', require: false
+    gem 'pronto-rubocop', require: false
+    gem 'pronto-scss', require: false
+    gem 'pry-rails'
+    gem 'rspec-its'
+    gem 'rspec-rails'
+    gem 'scss_lint', require: false
+    gem 'selenium-webdriver'
+    gem 'shoulda-matchers'
+    gem 'simplecov', require: false
+  end
+end
+
+def setup_database
+  remove_file "config/database.yml"
+  copy_file "templates/database.yml", "config/database.yml"
+  gsub_file "config/database.yml", "__application_name__", app_name
+
+  gsub_file "Gemfile", /.*sqlite.*\n/, ""
+end
+
+def add_ruby_version
+  insert_into_file "Gemfile", after: "source 'https://rubygems.org'" do
+    "\nruby \"#{RUBY_VERSION}\""
+  end
+
+  copy_file "templates/.ruby-version", ".ruby-version"
+  gsub_file ".ruby-version", "__ruby_version__", RUBY_VERSION
+end
+
+def setup_scss
+  run "mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss"
+end
+
+def setup_gitignore
+  remove_file ".gitignore"
+  copy_file "templates/.gitignore", ".gitignore"
+end
+
+def setup_testing
+  setup_rspec
+  setup_factory_bot
+  setup_system_tests
+  setup_shoulda
+  setup_bullet
+  limit_test_logging
+end
+
+def setup_rspec
+  generate "rspec:install"
+  remove_file ".rspec"
+  copy_file "templates/.rspec", ".rspec"
+  gsub_file "spec/rails_helper.rb",
+    "# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }",
+    "Dir[Rails.root.join(\"spec/support/**/*.rb\")].each { |f| require f }"
+end
+
+def setup_factory_bot
+  copy_file "templates/spec/support/factory_bot.rb", "spec/support/factory_bot.rb"
+end
+
+def setup_system_tests
+  copy_file "templates/spec/support/system_test_configuration.rb",
+    "spec/support/system_test_configuration.rb"
+
+  insert_into_file "spec/rails_helper.rb", after: "Rails is not loaded until this point!\n" do
+    system_tests_rails_helper_text
+  end
+
+  append_to_file "spec/rails_helper.rb" do
+    "\nCapybara.default_max_wait_time = 3\n"
+  end
+end
+
+def system_tests_rails_helper_text
+  <<~SYSTEM_TESTS
+    require "capybara/rails"
+    require "axe/rspec"
+    require "selenium/webdriver"
+  SYSTEM_TESTS
+end
+
+def setup_shoulda
+  append_to_file "spec/rails_helper.rb" do
+    shoulda_rails_helper_text
+  end
+end
+
+def shoulda_rails_helper_text
+  <<~SHOULDA
+
+    Shoulda::Matchers.configure do |config|
+      config.integrate do |with|
+        with.test_framework :rspec
+        with.library :rails
+      end
+    end
+  SHOULDA
+end
+
+def setup_bullet
+  insert_into_file "config/environments/test.rb", after: "Rails.application.configure do" do
+    bullet_test_env_text
+  end
+
+  insert_into_file "spec/rails_helper.rb", after: "RSpec.configure do |config|" do
+    bullet_rails_helper_text
+  end
+end
+
+def bullet_test_env_text
+  <<-BULLET_TEST
+
+  # Bullet gem initialization
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.raise = true
+  end
+  BULLET_TEST
+end
+
+def bullet_rails_helper_text
+  <<-BULLET_RAILS
+
+  if Bullet.enable?
+    config.before(:each) do
+      Bullet.start_request
+    end
+
+    config.after(:each) do
+      Bullet.perform_out_of_channel_notifications if Bullet.notification?
+      Bullet.end_request
+    end
+  end
+  BULLET_RAILS
+end
+
+def limit_test_logging
+  insert_into_file "config/environments/test.rb", after: "Rails.application.configure do" do
+    <<-TEST_LOGGING
+
+  unless ENV[\"RAILS_ENABLE_TEST_LOG\"]
+    config.logger = Logger.new(nil)
+    config.log_level = :fatal
+  end
+    TEST_LOGGING
+  end
+end
+
+def setup_analysis
+  setup_linting
+  setup_pronto
+  setup_brakeman
+  setup_simplecov
+end
+
+def setup_linting
+  copy_file "templates/.rubocop.yml", ".rubocop.yml"
+  copy_file "templates/.scss-lint.yml", ".scss-lint.yml"
+end
+
+def setup_pronto
+  copy_file "templates/.pronto.yml", ".pronto.yml"
+  copy_file "templates/script/ci_pronto", "script/ci_pronto"
+  run "chmod +x script/ci_pronto"
+end
+
+def setup_brakeman
+  copy_file "templates/script/brakeman", "script/brakeman"
+  run "chmod +x script/brakeman"
+end
+
+def setup_simplecov
+  prepend_to_file "spec/spec_helper.rb" do
+    <<~SIMPLECOV
+      require "simplecov"
+
+      # Save to CircleCI's artifacts directory if we're on CircleCI
+      if ENV["CIRCLE_ARTIFACTS"]
+        dir = File.join(ENV["CIRCLE_ARTIFACTS"], "coverage")
+        SimpleCov.coverage_dir(dir)
+      end
+
+      SimpleCov.start "rails" if (ENV["CI"] || ENV["COVERAGE"])
+
+    SIMPLECOV
+  end
+end
+
+def setup_environments
+  setup_dotenv
+  setup_ci
+  setup_docker
+end
+
+def setup_dotenv
+  copy_file "templates/.env.development", ".env.development"
+  copy_file "templates/.env.test", ".env.test"
+  gsub_file ".env.development", "__application_name__", app_name
+  gsub_file ".env.test", "__application_name__", app_name
+end
+
+def setup_ci
+  copy_file "templates/.circleci/config.yml", ".circleci/config.yml"
+  gsub_file ".circleci/config.yml", "__ruby_version__", RUBY_VERSION
+  gsub_file ".circleci/config.yml", "__application_name__", app_name
+end
+
+def setup_docker
+  copy_file "templates/Dockerfile", "Dockerfile"
+  gsub_file "Dockerfile", "__ruby_version__", RUBY_VERSION
+
+  if react?
+    setup_docker_react
+  else
+    setup_docker_standard
+  end
+end
+
+def setup_docker_standard
+  copy_file "templates/.env.docker/.env.docker-standard", ".env.docker"
+  copy_file "templates/docker-compose.yml/docker-compose-standard.yml", "docker-compose.yml"
+end
+
+def setup_docker_react
+  copy_file "templates/Dockerfile-assets", "Dockerfile-assets"
+  gsub_file "Dockerfile-assets", "__ruby_version__", RUBY_VERSION
+  copy_file "templates/.env.docker/.env.docker-webpack", ".env.docker"
+  copy_file "templates/.env.docker-assets", ".env.docker-assets"
+  copy_file "templates/docker-compose.yml/docker-compose-webpack.yml", "docker-compose.yml"
+end
+
+def setup_readme
+  remove_file "README.md"
+  copy_file "templates/README.md", "README.md"
+  gsub_file "README.md", "__application_name__", app_name
+end
+
+def react?
+  options[:webpack] == "react"
+end
+
+def post_bundle
+  after_bundle do
+    setup_react if react?
+    remove_dir "test"
+    git :init
+
+    puts ""
+    ascii_art
+    post_install_instructions
+  end
+end
+
+def ascii_art
+  puts "  _____     __        _     ____     ____     "
+  puts " / / \\ \\   |  \\      | |   /    \\   |    \\    "
+  puts "| |  | |   |   \\     | |  |  /\\  |  | |\\  \\   "
+  puts "| |   -    |    \\    | |  | |  | |  | | |  |  "
+  puts "| |        |  |\\ \\   | |  | |__| |  | |/  /   "
+  puts "| |  / --  |  | \\ \\  | |  | |  | |  |    /    "
+  puts "| |    \\ \\ |  |  \\ \\ | |  | |  | |  | |\\ \\    "
+  puts " \\ \\   | | |  |   \\ \\| |  | |  | |  | | \\ \\   "
+  puts "  \\  --/ / |  |    \\   |  | |  | |  | |  \\ \\  "
+  puts "   -----/  |__|     \\__|  |_|  |_|  |_|   \\_\\ "
+end
+
+def post_install_instructions
+  puts "\n\nNEXT STEPS"
+  puts "=========="
+  puts "* Install Google Chrome for acceptance tests"
+  puts "* Install ChromeDriver for default headless acceptance tests: brew install chromedriver"
+  puts "* Follow the post-install instructions to set up circle to allow gnarbot to comment on PRs."
+  puts "  * https://github.com/TheGnarCo/gnarails#post-install"
+end
+
+def setup_react
+  install_js_deps
+  add_js_files
+  modify_js_files
+  modify_npm_scripts
+end
+
+def install_js_deps
+  puts "Installing Gnar react packages"
+  run "yarn add #{JS_DEPENDENCIES.join(' ')}"
+  run "yarn add --dev #{JS_DEV_DEPENDENCIES.join(' ')}"
+end
+
+def add_js_files
+  directory "templates/react/js", "app/javascript"
+  directory "templates/react/views", "app/views"
+  copy_file "templates/react/layout.html.erb", "app/views/layouts/application.html.erb", force: true
+  copy_file "templates/react/rails_routes.rb", "config/routes.rb", force: true
+  copy_file "templates/react/controllers/home_controller.rb", "app/controllers/home_controller.rb"
+  copy_file "templates/react/.babelrc", ".babelrc", force: true
+  copy_file "templates/react/.eslintrc.js", ".eslintrc.js", force: true
+end
+
+def modify_js_files
+  gsub_file "app/views/layouts/application.html.erb",
+    "placeholder_application_title",
+    app_name.tr("-", "_").titleize
+  gsub_file "app/javascript/app_constants/index.js",
+    "  APP_NAME: 'CHANGE_ME',",
+    "  APP_NAME: '#{app_name}',"
+  remove_file "app/javascript/packs/application.js"
+end
+
+def modify_npm_scripts
+  insert_into_file "package.json", before: "  \"dependencies\": {\n" do
+    <<-NPM_SCRIPTS
+  "scripts": {
+    "start": "./bin/webpack-dev-server",
+    "mocha": "NODE_PATH=./app/javascript mocha --compilers js:babel-register --require babel-polyfill --require app/javascript/test/.setup.js --recursive './app/javascript/**/*.tests.js*'",
+    "lint": "eslint app/javascript",
+    "test": "npm run lint && npm run mocha"
+  },
+    NPM_SCRIPTS
+  end
+end
+
+create_gnarly_rails_app