boring_generators 0.2.0 → 0.7.0

data/lib/generators/boring/active_storage/google/install/install_generator.rb

@@ -0,0 +1,48 @@
+module Boring
+  module ActiveStorage
+    module Google
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds ActiveStorage google cloud service the application"
+
+        class_option :skip_active_storage, type: :boolean, aliases: "-s",
+                                           desc: "Skips running ActiveStorage installer"
+
+        def add_active_storage
+          unless options[:skip_active_storage]
+            say "Adding ActiveStorage", :green
+            run "bin/rails active_storage:install"
+          end
+        end
+
+        def add_google_cloud_storage_to_the_application
+          say "Adding google cloud storage gem", :green
+          google_cloud_storage_gem_content = <<~RUBY
+            \n
+            # for Google Cloud Storage Service
+            gem "google-cloud-storage", require: false
+          RUBY
+          append_to_file "Gemfile", google_cloud_storage_gem_content
+          run "bundle install"
+        end
+
+        def add_configuration_to_production
+          gsub_file "config/environments/production.rb",
+                    "config.active_storage.service = :local",
+                    "config.active_storage.service = :google"
+        end
+
+        def add_google_storage_configuration
+          google_storage_config_content = <<~RUBY
+            google:
+              service: GCS
+              project: your_project
+              credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+              bucket: your_own_bucket
+          RUBY
+
+          append_to_file "config/storage.yml", google_storage_config_content
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/audit/install/install_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Boring
+  module Audit
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Audit gems to the application"
+
+      def add_bullet_gem
+        say "Adding audit gems", :green
+        audit_gems_content = <<~RUBY
+          \n
+          \t# Patch-level verification for Bundler. https://github.com/rubysec/bundler-audit
+          \tgem "bundler-audit", require: false
+          \t# vulnerabity checker for Ruby itself. https://github.com/civisanalytics/ruby_audit
+          \tgem "ruby_audit", require: false
+        RUBY
+        insert_into_file "Gemfile", audit_gems_content, after: /group :development do/
+        run "bundle install"
+      end
+    end
+  end
+end

data/lib/generators/boring/bootstrap/install/install_generator.rb

@@ -12,7 +12,7 @@ module Boring
       end
 
       def add_jquery_plugin_provider_to_webpack_environment
-        say "Initailizing tailwind configuration", :green
+        say "Adding jQuery and popper JS plugin in the webpack", :green
         if File.exist?("config/webpack/environment.js")
           insert_into_file "config/webpack/environment.js", <<~RUBY, after: /@rails\/webpacker.*\n/
             const webpack = require("webpack")
@@ -37,7 +37,7 @@ module Boring
             '@import "~bootstrap/scss/bootstrap";'
           end
         else
-          say "Copying application.scss with tailwind imports", :green
+          say "Copying application.scss with bootstrap imports", :green
           template("application.scss", "app/javascript/stylesheets/application.scss")
         end
       end

data/lib/generators/boring/bullet/install/install_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Boring
+  module Bullet
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Bullet gem to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :skip_configuration, type: :boolean, aliases: "-s",
+                                        desc: "Skips adding bullet development configuration"
+
+      def add_bullet_gem
+        say "Adding Bullet gem", :green
+        bullet_gem_content = <<~RUBY
+          \n
+          \t# reports N+1 queries
+          \tgem "bullet"
+        RUBY
+        insert_into_file "Gemfile", bullet_gem_content, after: /group :development do/
+        run "bundle install"
+      end
+
+      def add_bullet_gem_configuration
+        return if options[:skip_configuration]
+
+        say "Copying bullet.rb configuration to the initializer", :green
+        template("bullet.rb", "config/initializers/bullet.rb")
+      end
+    end
+  end
+end

data/lib/generators/boring/bullet/install/templates/bullet.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+if Rails.env.development? && defined?(Bullet)
+  Bullet.enable = true
+  Bullet.bullet_logger = true
+  Bullet.rails_logger = true
+  Bullet.unused_eager_loading_enable = true
+end

data/lib/generators/boring/ci/circleci/install/install_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Boring
+  module Ci
+    module Circleci
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds Circle CI to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        DEFAULT_RUBY_VERSION = "2.7.1"
+        DEFAULT_REPOSITORY_NAME = "boring_generators"
+
+        class_option :ruby_version,     type: :string, aliases: "-v",
+                                                       desc: "Tell us the ruby version to which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}"
+        class_option :skip_node,        type: :boolean, aliases: "-sn",
+                                                        desc: "Skips the node configuration required for webpacker based Rails application."
+        class_option :repository_name,  type: :string, aliases: "-rn",
+                                                       desc: "Tell us the repository name to be used as database name on circleci. Defaults to #{DEFAULT_REPOSITORY_NAME}"
+
+        def add_circle_ci_configuration
+          @skip_node = options[:skip_node]
+          @ruby_version = options[:ruby_version] ? options[:ruby_version] : DEFAULT_RUBY_VERSION
+          @repository_name = options[:repository_name] ? options[:repository_name] : DEFAULT_REPOSITORY_NAME
+
+          template("config.psql.yml", ".circleci/config.yml")
+          template("database.yml.ci", "config/database.yml.ci")
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/ci/circleci/install/templates/config.psql.yml.tt

@@ -0,0 +1,48 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@1.1.1
+  <%- unless @skip_node -%>
+  node: circleci/node@2
+  <%- end -%>
+
+jobs:
+  test:
+    parallelism: 1
+    docker:
+      - image: cimg/ruby:<%= @ruby_version %>-node
+      - image: circleci/postgres:11.2
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: <%= "#{@repository_name}_test" %>
+    environment:
+      BUNDLE_JOBS: "3"
+      BUNDLE_RETRY: "3"
+      PGHOST: 127.0.0.1
+      PGUSER: postgres
+      RAILS_ENV: test
+    steps:
+      - checkout
+      - ruby/install-deps
+      <%- unless @skip_node -%>
+      # Store bundle cache
+      - node/install-packages:
+          pkg-manager: yarn
+          cache-key: "yarn.lock"
+      <%- end -%>
+      - run: cp config/database.yml.ci config/database.yml
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+      - run:
+          name: Database setup
+          command: bundle exec rails db:schema:load --trace
+      - run:
+          name: Run test
+          command: bundle exec rails test
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

data/lib/generators/boring/ci/circleci/install/templates/config.sql.yml.tt

@@ -0,0 +1,48 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@1.1.1
+  node: circleci/node@2
+
+jobs:
+  test:
+    parallelism: 1
+    docker:
+      - image: cimg/ruby:<%= @ruby_version %>-node
+        environment:
+          MYSQL_DATABASE: <%= @test_database_name %>
+    environment:
+      BUNDLE_JOBS: "3"
+      BUNDLE_RETRY: "3"
+      RAILS_ENV: test
+    steps:
+      - checkout
+      - run:
+          name: Waiting for MySQL to be ready
+          command: |
+            for i in `seq 1 10`;
+            do
+              nc -z 127.0.0.1 3306 && echo Success && exit 0
+              echo -n .
+              sleep 1
+            done
+            echo Failed waiting for MySQL && exit 1
+      - ruby/install-deps
+      <%- unless @skip_node -%>
+      # Store bundle cache
+      - node/install-packages:
+          pkg-manager: yarn
+          cache-key: "yarn.lock"
+      <%- end -%>
+      - run:
+          name: Database setup
+          command: bundle exec rails db:schema:load --trace
+      - run:
+          name: Run test
+          command: bundle exec rails test
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

data/lib/generators/boring/ci/circleci/install/templates/database.yml.ci.tt

@@ -0,0 +1,14 @@
+default: &default
+  adapter: postgresql
+  host: 127.0.0.1
+  encoding: unicode
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 10 } %>
+
+development:
+  <<: *default
+  database: <%= "#{@repository_name}_development" %>
+
+test:
+  <<: *default
+  user: postgres
+  database: <%= "#{@repository_name}_test" %>

data/lib/generators/boring/ci/github_action/install/install_generator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Boring
+  module Ci
+    module GithubAction
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds Github Action to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        RUBY_VERSION_FILE = ".ruby-version"
+
+        DEFAULT_RUBY_VERSION = ".ruby-version"
+        DEFAULT_NODE_VERSION = "10.13.0"
+        DEFAULT_REPOSITORY_NAME = "boring_generators"
+
+        class_option :ruby_version,     type: :string, aliases: "-v",
+                                                       desc: "Tell us the ruby version which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}, which will cause the action to use the version specified in the #{RUBY_VERSION_FILE} file."
+        class_option :node_version,     type: :string, aliases: "-v",
+                                                       desc: "Tell us the node version which you use for the application. Default to Node #{DEFAULT_NODE_VERSION}"
+        class_option :repository_name,  type: :string, aliases: "-rn",
+                                                       desc: "Tell us the repository name to be used as database name on GitHub Actions. Defaults to #{DEFAULT_REPOSITORY_NAME}"
+
+        def add_github_actions_configuration
+          @ruby_version = options[:ruby_version] ? options[:ruby_version] : DEFAULT_RUBY_VERSION
+          @node_version = options[:node_version] ? options[:node_version] : DEFAULT_NODE_VERSION
+          @repository_name = options[:repository_name] ? options[:repository_name] : DEFAULT_REPOSITORY_NAME
+
+          template("ci.yml", ".github/workflows/ci.yml")
+
+          if @ruby_version == DEFAULT_RUBY_VERSION && !ruby_version_file_exists?
+            say <<~WARNING, :red
+              WARNING: The action was configured to use the ruby version specified in the .ruby-version
+              file, but no such file was present. Either create an appropriate .ruby-version file, or
+              update .github/workflows/ci.yml to use an explicit ruby version.
+            WARNING
+          end
+        end
+
+        def ruby_version_file_exists?
+          Pathname.new(destination_root).join(RUBY_VERSION_FILE).exist?
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/ci/github_action/install/templates/ci.yml.tt

@@ -0,0 +1,49 @@
+name: CI
+on: [push]
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:11
+        env:
+          POSTGRES_USER: <%= @repository_name %>
+          POSTGRES_DB: <%= "#{@repository_name}_test" %>
+          POSTGRES_PASSWORD: ""
+        ports: ["5432:5432"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: <%= "Set up Ruby #{@ruby_version}" %>
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: <%= @ruby_version %>
+          bundler-cache: true
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: <%= @node_version %>
+      - name: Find yarn cache location
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: JS package cache
+        uses: actions/cache@v1
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install packages
+        run: |
+          yarn install --pure-lockfile
+      - name: Setup test database
+        env:
+          RAILS_ENV: test
+          PGHOST: localhost
+          PGUSER: <%= @repository_name %>
+        run: |
+          bin/rails db:setup
+      - name: Run tests
+        run: bundle exec rails test # TODO: Update the test runner command as per your requirement.

data/lib/generators/boring/ci/travisci/install/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Boring
+  module Ci
+    module Travisci
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds Github Action to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        DEFAULT_RUBY_VERSION = "2.7.1"
+
+        class_option :ruby_version, type: :string, aliases: "-v",
+                                    desc: "Tell us the ruby version which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}"
+
+        def add_github_actions_configuration
+          @ruby_version = options[:ruby_version] ? options[:ruby_version] : DEFAULT_RUBY_VERSION
+
+          template(".travis.yml", ".travis.yml")
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/ci/travisci/install/templates/.travis.yml.tt

@@ -0,0 +1,35 @@
+language: ruby
+
+rvm:
+  - <%= @ruby_version %>
+
+services:
+  - postgresql
+
+cache:
+  bundler: true
+  directories:
+    - node_modules
+  yarn: true
+
+env:
+  global:
+    - RAILS_ENV=test
+    - NODE_ENV=test
+
+before_install:
+  - nvm install --lts
+
+install:
+  - node -v
+  - yarn
+  - bundle
+
+before_script:
+  - bundle install --jobs=3 --retry=3
+  - bundle exec rails db:create
+  - bundle exec rails db:schema:load
+
+script:
+  - bundle exec rails db:schema:load
+  - bundle exec rails test

data/lib/generators/boring/devise/install/install_generator.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Boring
+  module Devise
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds devise to the application"
+
+      DEFAULT_DEVISE_MODEL_NAME = "User"
+
+      class_option :model_name, type: :string, aliases: "-m",
+                   desc: "Tell us the user model name which will be used for authentication. Defaults to #{DEFAULT_DEVISE_MODEL_NAME}"
+      class_option :skip_devise_view, type: :boolean, aliases: "-sv",
+                   desc: "Skip generating devise views"
+      class_option :skip_devise_model, type: :boolean, aliases: "-sm",
+                   desc: "Skip generating devise model"
+
+      def add_devise_gem
+        say "Adding devise gem", :green
+        devise_gem = <<~RUBY
+          \n
+          # for authentication
+          gem 'devise', '~> 4.7'
+        RUBY
+        append_to_file "Gemfile", devise_gem
+        Bundler.with_unbundled_env do
+          run "bundle install"
+        end
+      end
+
+      def generating_devise_defaults
+        say "Generating devise defaults", :green
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise:install"
+        end
+      end
+
+      def add_devise_action_mailer_development_config
+        say "Adding devise Action Mailer development configuration", :green
+        insert_into_file "config/environments/development.rb", <<~RUBY, after: /Rails.application.configure do/
+          \n
+          \tconfig.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+        RUBY
+      end
+
+      def add_devise_user_model
+        return if options[:skip_devise_model]
+
+        say "Adding devise user model", :green
+        model_name = options[:model_name] || DEFAULT_DEVISE_MODEL_NAME
+
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise #{model_name}"
+        end
+      end
+
+      def add_devise_authentication_filter_to_application_controller
+        insert_into_file "app/controllers/application_controller.rb", <<~RUBY, after: /class ApplicationController < ActionController::Base/
+          \n
+          \tbefore_action :authenticate_user!
+        RUBY
+      end
+
+      def add_devise_views
+        return if options[:skip_devise_view]
+
+        say "Adding devise views", :green
+        model_name = options[:model_name] || DEFAULT_DEVISE_MODEL_NAME
+
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate devise:views #{model_name.pluralize}"
+        end
+      end
+    end
+  end
+end