boring_generators 0.3.0 → 0.8.0

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

data/lib/generators/boring/favicon/build/build_generator.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Boring
+  module Favicon
+    class BuildGenerator < Rails::Generators::Base
+      desc "Build favicons for all platforms"
+      source_root File.expand_path("templates", __dir__)
+
+      ICO_SIZES = %w(16 32)
+      APPLE_SIZES = %w(57 60 72 76 114 120 129 144 152)
+      APPLE_PRECOMPOSED_SIZES = %w(120 129 152)
+      SMALL_BREAK = 50
+      LARGE_BREAK = 150
+      MS_TILE_SIZES = %w(144)
+      FAVICON_DIR = "favicons"
+      FILE_FAVICO_DIR = "app/assets/images/#{FAVICON_DIR}"
+      DEFAULT_PRIMARY_COLOR = "#082472"
+      DEFAULT_FAVICON_LETTER = "B" # B for boring_generators :)
+      DEFAULT_IMAGE_PATH = "#{FILE_FAVICO_DIR}/template.png"
+
+      class_option :primary_color,        type: :string, aliases: "-color",
+                                          desc: "Tell us the primary color to build favicon. Default to primary: #{DEFAULT_PRIMARY_COLOR}"
+      class_option :favico_letter,        type: :string, aliases: "-letter",
+                                          desc: "Tell us the favicon letter to build favicon. Default to primary: #{DEFAULT_FAVICON_LETTER}"
+      class_option :font_file_path,       type: :string, aliases: "-fp",
+                                          desc: "Tell us the font to be used generate favicon."
+      class_option :application_name,     type: :string, aliases: "-app_name",
+                                          desc: "Tell us the application name to be used in favicon partial."
+
+      def build_favicon
+        @application_name = options[:application_name]
+        @primary_color = options[:primary_color]
+
+        unless /Version/m =~ (`convert -version`)
+          say <<~WARNING, :red
+            ERROR: You do not have ImageMagick installed.
+          WARNING
+        end
+      end
+
+      def create_favicon_directory
+        unless File.exists?(FILE_FAVICO_DIR)
+          Dir.mkdir FILE_FAVICO_DIR
+        end
+      end
+
+      def build_favicon_for_existing_template_image
+        return unless File.exist?(DEFAULT_IMAGE_PATH)
+
+        say "Converting template image to favicons..."
+        template_name = "#{FILE_FAVICO_DIR}/template.png"
+        template_small_name = "#{FILE_FAVICO_DIR}/template-small.png"
+        template_large_name = "#{FILE_FAVICO_DIR}/template-large.png"
+        template_small_name = template_name unless File.file?(template_small_name)
+        template_large_name = template_name unless File.file?(template_large_name)
+        ICO_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/favicon-#{size}x#{size}.ico`)
+        end
+        APPLE_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}.png`)
+        end
+        APPLE_PRECOMPOSED_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}-precomposed.png`)
+        end
+        MS_TILE_SIZES.each do |size|
+          ico_template = template_name
+          ico_template = template_small_name if size.to_i <= SMALL_BREAK
+          ico_template = template_small_name if size.to_i >= LARGE_BREAK
+          (`convert #{ico_template} -resize #{size}x#{size} #{FILE_FAVICO_DIR}/mstile-#{size}x#{size}.png`)
+        end
+        ico_template = template_name
+        ico_template = template_small_name if 152 <= SMALL_BREAK
+        ico_template = template_small_name if 152 >= LARGE_BREAK
+        (`convert #{ico_template} -resize 152x152 #{FILE_FAVICO_DIR}/apple-touch-icon.png`)
+        (`convert #{ico_template} -resize 152x152 #{FILE_FAVICO_DIR}/apple-touch-icon-precomposed.png`)
+      end
+
+      def generate_new_favicon_using_favico_letter
+        return if File.exist?(DEFAULT_IMAGE_PATH)
+        say "Creating favicons from application...", :green
+
+        favico_letter = options[:favico_letter] || @application_name.try(:first) || DEFAULT_FAVICON_LETTER
+        font_file_path = options[:font_file_path]
+        favicon_color = options[:primary_color] || DEFAULT_PRIMARY_COLOR
+
+        ICO_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/favicon-#{size}x#{size}.ico`)
+        end
+        APPLE_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}.png`)
+        end
+        APPLE_PRECOMPOSED_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon-#{size}x#{size}-precomposed.png`)
+        end
+        MS_TILE_SIZES.each do |size|
+          (`convert -background "#{favicon_color}" -fill white -size #{size}x#{size} -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/mstile-#{size}x#{size}.png`)
+        end
+        (`convert -background "#{favicon_color}" -fill white -size 152x152 -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon.png`)
+        (`convert -background "#{favicon_color}" -fill white -size 152x152 -gravity center #{font_file_path ? "-font #{font_file_path}" : ""} label:#{favico_letter} #{FILE_FAVICO_DIR}/apple-touch-icon-precomposed.png`)
+      end
+
+      def add_favicon_partial
+        say "Copying favicon layout partial", :green
+        template("favicon.html.erb", "app/views/layouts/shared/_favicon.html.erb")
+        insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /head.*\n/
+          \t\t<%= render 'layouts/shared/favicon' %>
+        RUBY
+      end
+    end
+  end
+end