boring_generators 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f53cde2e0fe1d3ac3886bda90938684dfb8a042b3a4af31029db3b4fbf1ff6c9
-  data.tar.gz: 6742553d35e0db7f76de45b7c72b26a5816019e53dae5337535b127598b956be
+  metadata.gz: 5b67dbb666f39abf0bec2904c68065fa65c33cf0456b5a16d8a26fdc8b0e962c
+  data.tar.gz: 4862c8a53fd09686720f71adffeba1cecdb778034d1cdb5a69629f7a61fec625
 SHA512:
-  metadata.gz: baa6c23aad5cafcb0d73df98d0169312503f6e603b51daf70e40fe11bba24c2a22d96867f127f075dfff6ebcf5d218485ba9e05c73f04e9d6f4b92c138c2bb5e
-  data.tar.gz: 44a4df93e880cdeb55f2de27a1442348403616f0238309999223a336ced1de9908b54e14a81519b395b379dc55c89fcdb0d4bce50b849ffe4cd0667255e5bd9d
+  metadata.gz: 1025146551a477fdabd33a6e722fee8bbb4e65fdef5b35075b6cedbc55af53f142620ecdc837e33849703a33ae783e4ed131e7a459489d5be83407618cbcfa61
+  data.tar.gz: 81363bcb6e92b1f815d7757a2adf4a3a6f7d7f646cef62df472159189384b03c624499efa309102ec9312b9fd65aadc0c9caaf6cb37cf3c454ec5b6b491150d0

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push]
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.1
+      - name: Install gems
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.4.0 (October 23rd, 2020)
+* Adds CircleCI install generator. ([@abhaynikam][])
+* Adds GitHub Actions install generator. ([@abhaynikam][])
+* Adds Travis CI install generator. ([@abhaynikam][])
+* Adds Rubocop install generator. ([@abhaynikam][])
+
 ## 0.3.0 (September 19th, 2020)
 * Adds Bullet install generator. ([@abhaynikam][])
 * Adds Audit gems(bundler-audit, ruby_audit) install generator. ([@abhaynikam][])

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    boring_generators (0.4.0)
+      railties
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    erubi (1.9.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boring_generators!
+  byebug
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,8 +1,20 @@
-# BoringGenerators
+<h3 align="center">
+  Boring Generators
+</h3>
 
-Have you ever started a new adventure/hobby project of your and instead of spending time in solving the actual problem statement with the website ended up configuring the application and put a lot of effort into it. Yeah, We felt that too. Boring generator tries to resolve the painful same redundant configuration you do in every application by adding generators to easily configure it.
+<p align="center">
+  <a href="https://rubygems.org/gems/boring_generators"><img alt="Gem" src="https://img.shields.io/gem/dt/boring_generators?style=flat-square"></a>
+  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/abhaynikam/boring_generators/CI?style=flat-square">
+</p>
+
+<p>
+  Have you ever started a new adventure/hobby project of your and instead of spending time in solving the actual problem statement with the website ended up configuring the application and put a lot of effort into it. Yeah, We felt that too. Boring generator tries to resolve the painful same redundant configuration you do in every application by adding generators to easily configure it.
+</p>
+
+<p>
+  Check out the generator we support right now. We are planning to add support to most of the mostly used and required gems. We are open to any idea of yours, feel free to raise a discussion by opening up an issue or try contributing.
+</p>
 
-Check out the generator we support right now. We are planning to add support to most of the mostly used and required gems. We are open to any idea of yours, feel free to raise a discussion by opening up an issue or try contributing.
 
 ## Installation
 
@@ -34,6 +46,10 @@ The boring generator introduces following generators:
 - Install Active Storage for Google Cloud Service: `rails generate boring:active_storage:google:install`
 - Install Active Storage for AWS: `rails generate boring:active_storage:aws:install`
 - Install Active Storage for Azure: `rails generate boring:active_storage:azure:install`
+- Install CircleCI: `rails generate boring:ci:circleci:install --repository_name=<name> --ruby_version=<version>`
+- Install GitHub Actions: `rails generate boring:ci:github_action:install --repository_name=<name> --ruby_version=<version>`
+- Install Travis CI: `rails generate boring:ci:travisci:install --ruby_version=<version>`
+- Install Rubocop: `rails generate boring:rubocop:install --ruby_version=<version>`
 
 ## Development
 
@@ -45,6 +61,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/abhaynikam/boring_generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/abhaynikam/boring_generators/blob/master/CODE_OF_CONDUCT.md).
 
+## Changelog
+
+Boring Generators changelog is available [here](https://github.com/abhaynikam/boring_generators/blob/master/CHANGELOG.md).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/boring_generators.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties'
 end

data/lib/boring_generators/version.rb

@@ -1,3 +1,3 @@
 module BoringGenerators
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 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,31 @@
+# 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__)
+
+        DEFAULT_RUBY_VERSION = "2.7.1"
+        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}"
+        class_option :node_version,     type: :string, aliases: "-v",
+                                                       desc: "Tell us the node version which you use for the application. Default to Ruby #{DEFAULT_NODE_VERSION}"
+        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_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")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+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 %>
+      - name: Ruby gem cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - 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