gnarails 0.9.0

data/lib/gnarails/cli/application.rb

@@ -0,0 +1,192 @@
+require "thor"
+
+module Gnarails
+  module Cli
+    class Application < Thor
+      include Thor::Actions
+
+      add_runtime_options!
+
+      WEBPACKS = %w[react vue angular elm stimulus].freeze
+
+      method_option :ruby,
+        type: :string,
+        aliases: "-r",
+        default: Thor::Util.ruby_command,
+        desc: "Path to the Ruby binary of your choice", banner: "PATH"
+
+      method_option :skip_namespace,
+        type: :boolean,
+        default: false,
+        desc: "Skip namespace (affects only isolated applications)"
+
+      method_option :skip_yarn,
+        type: :boolean,
+        default: false,
+        desc: "Don't use Yarn for managing JavaScript dependencies"
+
+      method_option :skip_gemfile,
+        type: :boolean,
+        default: false,
+        desc: "Don't create a Gemfile"
+
+      method_option :skip_git,
+        type: :boolean,
+        aliases: "-G",
+        default: false,
+        desc: "Skip .gitignore file"
+
+      method_option :skip_keeps,
+        type: :boolean,
+        default: false,
+        desc: "Skip source control .keep files"
+
+      method_option :skip_action_mailer,
+        type: :boolean,
+        aliases: "-M",
+        default: false,
+        desc: "Skip Action Mailer files"
+
+      method_option :skip_active_record,
+        type: :boolean,
+        aliases: "-O",
+        default: false,
+        desc: "Skip Active Record files"
+
+      method_option :skip_active_storage,
+        type: :boolean,
+        default: false,
+        desc: "Skip Active Storage files"
+
+      method_option :skip_puma,
+        type: :boolean,
+        aliases: "-P",
+        default: false,
+        desc: "Skip Puma related files"
+
+      method_option :skip_action_cable,
+        type: :boolean,
+        aliases: "-C",
+        default: false,
+        desc: "Skip Action Cable files"
+
+      method_option :skip_sprockets,
+        type: :boolean,
+        aliases: "-S",
+        default: false,
+        desc: "Skip Sprockets files"
+
+      method_option :skip_spring,
+        type: :boolean,
+        default: false,
+        desc: "Don't install Spring application preloader"
+
+      method_option :skip_listen,
+        type: :boolean,
+        default: false,
+        desc: "Don't generate configuration that depends on the listen gem"
+
+      method_option :skip_coffee,
+        type: :boolean,
+        default: false,
+        desc: "Don't use CoffeeScript"
+
+      method_option :skip_javascript,
+        type: :boolean,
+        aliases: "-J",
+        default: false,
+        desc: "Skip JavaScript files"
+
+      method_option :skip_turbolinks,
+        type: :boolean,
+        default: false,
+        desc: "Skip turbolinks gem"
+
+      method_option :skip_test,
+        type: :boolean,
+        aliases: "-T",
+        default: false,
+        desc: "Skip test files"
+
+      method_option :skip_system_test,
+        type: :boolean,
+        default: false,
+        desc: "Skip system test files"
+
+      method_option :skip_bootsnap,
+        type: :boolean,
+        default: false,
+        desc: "Skip bootsnap gem"
+
+      method_option :dev,
+        type: :boolean,
+        default: false,
+        desc: "Setup the application with Gemfile pointing to your Rails checkout"
+
+      method_option :edge,
+        type: :boolean,
+        default: false,
+        desc: "Setup the application with Gemfile pointing to Rails repository"
+
+      method_option :rc,
+        type: :string,
+        default: nil,
+        desc: "Path to file containing extra configuration options for rails command"
+
+      method_option :no_rc,
+        type: :boolean,
+        default: false,
+        desc: "Skip loading of extra configuration options from .railsrc file"
+
+      method_option :api,
+        type: :boolean,
+        desc: "Preconfigure smaller stack for API only apps"
+
+      method_option :skip_bundle,
+        type: :boolean,
+        aliases: "-B",
+        default: false,
+        desc: "Don't run bundle install"
+
+      method_option :webpack,
+        type: :string,
+        default: nil,
+        desc: "Preconfigure for app-like JavaScript with Webpack (options: #{WEBPACKS.join('/')})"
+
+      desc "new APP_PATH [options]", "generate a gnarly rails app"
+      long_desc <<-LONGDESC
+        `gnarails new NAME` will create a new rails application called NAME,
+        pre-built with the same helpful default configuration you can expect from
+        any rails project built by The Gnar Company.
+
+        By default, we pass arguments to `rails new` that skip test unit
+        generation and use postgres instead of sqlite as the default database.
+
+        You should also be able to pass any other arguments you would expect to
+        be able to when generating a new rails app.
+      LONGDESC
+      def new(name)
+        Kernel.system "rails new #{name} #{cli_options(options)}"
+      end
+
+      no_tasks do
+        def cli_options(options)
+          options_string = "-m #{Gnarails.template_file} --skip-test-unit --database=postgresql"
+          options.each_with_object(options_string) do |(k, v), str|
+            str << cli_option(k, v)
+          end
+        end
+
+        def cli_option(key, value)
+          if value == false
+            ""
+          elsif value == true
+            " --#{key}"
+          else
+            " --#{key}=#{value}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gnarails/version.rb

@@ -0,0 +1,3 @@
+module Gnarails
+  VERSION = "0.9.0"
+end

data/lib/gnarails.rb

@@ -0,0 +1,8 @@
+require "gnarails/cli/application"
+require "gnarails/version"
+
+module Gnarails
+  def self.template_file
+    File.join(File.dirname(__FILE__), "..", "gnarly.rb")
+  end
+end

data/templates/.circleci/config.yml

@@ -0,0 +1,66 @@
+version: 2.0
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:__ruby_version__-stretch-node-browsers
+        environment:
+          RAILS_ENV: test
+      - image: circleci/postgres:9.6.5
+    steps:
+      - checkout
+
+      # Restore bundle cache
+      - restore_cache:
+          key: __application_name__-{{ checksum "Gemfile.lock" }}
+
+      # cmake is required by Rugged, a dependency of Pronto
+      - run:
+          name: Install cmake
+          command: sudo apt-get -y -qq update && sudo apt-get -y -qq install cmake
+
+      # Bundle install dependencies
+      - run:
+          name: Install dependencies
+          command: bundle install --path vendor/bundle
+
+      # Store bundle cache
+      - save_cache:
+          key: __application_name__-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      # Database setup
+      - run:
+          name: Create database
+          command: bundle exec rake db:create
+      - run:
+          name: Load database schema
+          command: bundle exec rake db:schema:load
+
+      # Tests
+      - run:
+          name: RSpec
+          command: bundle exec rspec
+
+      # Security analysis
+      - run:
+          name: Bundler Audit
+          command: bundle exec bundle-audit update && bundle exec bundle-audit check
+      - run:
+          name: Brakeman
+          command: ./script/brakeman
+
+      # Pronto
+      - run:
+          name: Pronto
+          command: ./script/ci_pronto
+
+      # Save Brakeman
+      - store_artifacts:
+          path: tmp/brakeman.html
+          destination: security/brakeman.html
+
+      # Save Coverage Analysis
+      - store_artifacts:
+          path: coverage
+          destination: coverage

data/templates/.env.development

@@ -0,0 +1,5 @@
+DATABASE_NAME=__application_name___development
+DATABASE_USERNAME=postgres
+DATABASE_PASSWORD=""
+DATABASE_HOST=localhost
+DATABASE_PORT=5432

data/templates/.env.docker/.env.docker-standard

@@ -0,0 +1 @@
+DATABASE_HOST=db

data/templates/.env.docker/.env.docker-webpack

@@ -0,0 +1,2 @@
+DATABASE_HOST=db
+WEBPACKER_DEV_SERVER_HOST=assets

data/templates/.env.docker-assets

@@ -0,0 +1 @@
+WEBPACKER_DEV_SERVER_HOST=0.0.0.0

data/templates/.env.test

@@ -0,0 +1,5 @@
+DATABASE_NAME=__application_name___test
+DATABASE_USERNAME=postgres
+DATABASE_PASSWORD=""
+DATABASE_HOST=localhost
+DATABASE_PORT=5432

data/templates/.gitignore

@@ -0,0 +1,20 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore output of simplecov
+coverage

data/templates/.pronto.yml

@@ -0,0 +1,2 @@
+github_pr:
+  format: "%{runner}: %{msg}"

data/templates/.rspec

@@ -0,0 +1,3 @@
+--order rand
+--color
+--require spec_helper

data/templates/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  gnar-style:
+    - "rubocop/rubocop_rails.yml"

data/templates/.ruby-version

@@ -0,0 +1 @@
+__ruby_version__

data/templates/.scss-lint.yml

@@ -0,0 +1,33 @@
+scss_files: 'app/assets/stylesheets/**/*.scss'
+exclude: 'app/assets/stylesheets/plugins/**'
+
+linters:
+  StringQuotes:
+    enabled: false
+
+  LeadingZero:
+    enabled: false
+
+  BorderZero:
+    enabled: false
+
+  ColorVariable:
+    enabled: false
+
+  Comment:
+    enabled: false
+
+  FinalNewline:
+    enabled: false
+
+  IdSelector:
+    enabled: false
+
+  NestingDepth:
+    enabled: true
+    max_depth: 6
+    ignore_parent_selectors: false
+
+  SelectorDepth:
+    enabled: true
+    max_depth: 6

data/templates/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:__ruby_version__
+
+# use a newer version of Node to use Yarn
+RUN curl -sL https://deb.nodesource.com/setup_8.x | bash -
+
+# nodejs: Rails needs a JS runtime
+# cmake: required by Rugged, dependency of Pronto
+RUN apt-get update -qq \
+    && apt-get install -y -qq nodejs cmake
+
+RUN npm install -g yarn
+
+RUN mkdir /app
+WORKDIR /app
+
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+RUN bundle install
+
+ADD . /app

data/templates/Dockerfile-assets

@@ -0,0 +1,24 @@
+FROM ruby:__ruby_version__
+
+# use a newer version of Node to use Yarn
+RUN curl -sL https://deb.nodesource.com/setup_8.x | bash -
+
+# nodejs: Rails needs a JS runtime
+# cmake: required by Rugged, dependency of Pronto
+RUN apt-get update -qq \
+    && apt-get install -y -qq nodejs cmake
+
+RUN npm install -g yarn
+
+RUN mkdir /app
+WORKDIR /app
+
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+RUN bundle install
+
+ADD package.json /app/package.json
+ADD yarn.lock /app/yarn.lock
+RUN yarn install
+
+ADD . /app

data/templates/README.md

@@ -0,0 +1,83 @@
+# __application_name__
+
+## Setup
+
+ ```sh
+$ bundle install
+$ bundle exec rake db:create
+$ bundle exec rake db:migrate
+$ bundle exec rake db:seed
+$ bundle exec rails s
+$ open http://localhost:3000
+```
+
+## Testing
+
+### Testing Dependency:
+
+To run acceptance tests chromedriver is required.
+
+If using macOS and homebrew, you can install chromedriver with the following
+command:
+```sh
+$ brew install chromedriver
+```
+
+To run the full test suite:
+
+```sh
+$ bundle exec rake
+```
+
+### 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
+```
+
+## Dependencies
+
+[Ruby Version](.ruby-version)
+
+## Docker
+
+The application may be run via [docker](https://docs.docker.com/) and [docker-compose](https://docs.docker.com/compose/). Once installed run:
+
+```sh
+$ docker-compose build
+```
+
+To run the application for the first time:
+
+```sh
+# Create the database
+$ docker-compose run web rake db:setup
+
+# Start the application
+$ docker-compose up
+```
+
+To run rspec:
+```sh
+$ docker-compose run web bundle exec rspec
+```
+
+### Using pry with Docker
+
+Once docker is running, type `docker ps` in the terminal and copy the ID of the `__application_name___web` image.
+
+Then, in a new terminal window, use the container ID you copied to open an image specific terminal...
+
+```sh
+$ docker attach COPIED_CONTAINER_ID
+```
+
+Lastly, set `binding.pry` in the usual fashion, and use the new image specific terminal to interact with your breakpoint.
+
+## Updating gnar-style
+
+After updating the gnar-style gem, you must take care to ensure that your local rubocop file does not stray from the update made to the gem in an unintended manner. Any changes in the local rubocop file will take precedence over what is in the gnar-style gem. See the gnar-style [docs](https://github.com/TheGnarCo/gnar-style#overriding-styles) for more details.

data/templates/database.yml

@@ -0,0 +1,20 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: <%= ENV.fetch("DATABASE_POOL_SIZE") { 5 } %>
+  database: <%= ENV['DATABASE_NAME'] %>
+  username: <%= ENV['DATABASE_USERNAME'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+  host: <%= ENV['DATABASE_HOST'] %>
+  port: <%= ENV['DATABASE_PORT'] %>
+
+development:
+  <<: *default
+  database: __application_name___development
+
+test:
+  <<: *default
+  database: __application_name___test
+
+production:
+  <<: *default

data/templates/docker-compose.yml/docker-compose-standard.yml

@@ -0,0 +1,15 @@
+version: '3'
+services:
+  db:
+    image: postgres
+  web:
+    build: .
+    command: bash -c 'rm -f tmp/pids/server.pid && bundle exec rails s --port 3000 --binding 0.0.0.0'
+    volumes:
+      - .:/app
+    ports:
+      - 3000:3000
+    depends_on:
+      - db
+    env_file:
+      - .env.docker

data/templates/docker-compose.yml/docker-compose-webpack.yml

@@ -0,0 +1,26 @@
+version: '3'
+services:
+  db:
+    image: postgres
+  assets:
+    build:
+      context: .
+      dockerfile: Dockerfile-assets
+    command: yarn start
+    volumes:
+      - .:/app
+      - /app/node_modules
+    env_file:
+      - .env.docker-assets
+  web:
+    build: .
+    command: bash -c 'rm -f tmp/pids/server.pid && bundle exec rails s --port 3000 --binding 0.0.0.0'
+    volumes:
+      - .:/app
+    ports:
+      - 3000:3000
+    depends_on:
+      - db
+      - assets
+    env_file:
+      - .env.docker

data/templates/react/.babelrc

@@ -0,0 +1,18 @@
+{
+  "presets": [
+    [
+      "env",
+      {
+        "modules": false,
+        "targets": {
+          "browsers": "> 1%",
+          "uglify": true
+        },
+        "useBuiltIns": true
+      }
+    ],
+    "react",
+    "es2015",
+    "stage-3"
+  ],
+}

data/templates/react/.eslintrc.js

@@ -0,0 +1,45 @@
+var path = require('path');
+
+module.exports = {
+  extends: 'airbnb',
+  parser: 'babel-eslint',
+  env: {
+    'node': true,
+    'mocha': true
+  },
+  globals: {
+    'expect': false,
+    'describe': false
+  },
+  rules: {
+    'consistent-return': 1,
+    'arrow-body-style': 0,
+    'max-len': 0,
+    'jsx-a11y/img-has-alt': 0,
+    'no-use-before-define': [2, 'nofunc'],
+    'no-unused-expressions': 0,
+    'no-console': 0,
+    'space-before-function-paren': 0,
+    'react/prefer-stateless-function': 0,
+    'react/no-multi-comp': 0,
+    'react/no-unused-prop-types': [1, { 'customValidators': [], skipShapeProps: true }],
+    'no-param-reassign': 0,
+    'new-cap': 0,
+    'import/no-unresolved': 'error',
+    'import/no-extraneous-dependencies': ['error', { 'devDependencies': true }],
+    'linebreak-style': 0,
+    'import/no-named-as-default': 'off',
+    'import/no-named-as-default-member': 'off',
+    'no-underscore-dangle': 0
+  },
+  settings: {
+    'import/resolver': {
+      webpack: {
+        config: path.join(__dirname, 'webpack.config.js')
+      },
+      node: {
+        paths: 'app/javascript'
+      }
+    }
+  }
+}

data/templates/react/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def default
+  end
+end

data/templates/react/js/Router/Router.jsx

@@ -0,0 +1,22 @@
+import React, { Component } from 'react';
+import { Provider } from 'react-redux';
+import { ConnectedRouter } from 'react-router-redux'
+import { Route } from 'react-router';
+
+import App from 'components/App';
+import history from 'redux/history';
+import store from 'redux/store';
+
+export default class Router extends Component {
+  render () {
+    return (
+      <Provider store={store}>
+        <ConnectedRouter history={history}>
+          <App>
+            <h1>Welcome to Gnarails</h1>
+          </App>
+        </ConnectedRouter>
+      </Provider>
+    )
+  }
+}

data/templates/react/js/Router/index.js

@@ -0,0 +1,3 @@
+import Router from './Router';
+
+export default Router;

data/templates/react/js/api/index.js

@@ -0,0 +1,17 @@
+import Schlepp from 'schlepp';
+
+import appConstants from 'app_constants';
+import sessionMethods from 'api/sessions';
+
+class Api extends Schlepp {
+  constructor(options) {
+    super(options);
+
+    this.sessions = sessionMethods(this);
+  }
+}
+
+export default new Api({
+  host: appConstants.API_HOST,
+  bearerTokenKeyInLocalStorage: `${appConstants.APP_NAME}:auth_token`,
+});