Merge pull request #1 from Platoniq/chore/configure-ci

Configure linters and specs

.erb-lint.yml

@@ -0,0 +1,30 @@
+---
+
+linters:
+  ExtraNewline:
+    enabled: true
+
+  FinalNewline:
+    enabled: true
+
+  SpaceAroundErbTag:
+    enabled: true
+
+  AllowedScriptType:
+    enabled: true
+    allowed_types:
+      - text/javascript
+      - text/template
+
+  Rubocop:
+    enabled: true
+
+    rubocop_config:
+      AllCops:
+        DisabledByDefault: true
+
+      Style/StringLiterals:
+        EnforcedStyle: double_quotes
+
+      Layout/SpaceInsideHashLiteralBraces:
+        Enabled: true

.eslintignore

@@ -0,0 +1,13 @@
+**/*{.,-}min.js
+decidim-*/vendor/**/*.js
+**/node_modules/**
+bundle.js
+karma.conf.js
+webpack.config.js
+webpack.config.babel.js
+entry.test.js
+entry.js
+*_manifest.js
+coverage
+vendor/bundle
+**/vendor/**/*.js

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@decidim"
+}

.github/workflows/lint.yml

@@ -0,0 +1,47 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  RUBY_VERSION: 3.1.1
+  NODE_VERSION: 18.17.1
+
+jobs:
+  lint:
+    name: Lint code
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.0.0
+        with:
+          fetch-depth: 1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+          bundler-cache: true
+
+      - uses: actions/setup-node@master
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - run: npm ci
+        name: Install JS deps
+
+      - run: bundle exec rubocop -P
+        name: Lint Ruby files
+
+      - run: bundle exec mdl *.md
+        name: Lint Markdown files
+
+      - run: bundle exec erblint app/views/**/*.erb
+        name: Lint ERB files
+
+      - run: npm run stylelint
+        name: Lint SCSS files
+
+      - run: npm run lint
+        name: Lint JS files

.github/workflows/test.yml

@@ -0,0 +1,58 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  RUBY_VERSION: 3.1.1
+  NODE_VERSION: 18.17.1
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:11
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+          bundler-cache: true
+      - uses: actions/setup-node@master
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - uses: nanasess/setup-chromedriver@v2
+      - name: Setup & create Database
+        run: bundle exec rake db:test:prepare
+        env:
+          RAILS_ENV: test
+          DATABASE_USERNAME: postgres
+          DATABASE_PASSWORD: postgres
+      - name: Precompile assets
+        run: |
+          npm install
+          bundle exec rake assets:precompile
+        env:
+          RAILS_ENV: test
+          DATABASE_USERNAME: postgres
+          DATABASE_PASSWORD: postgres
+      - name: Run RSpec
+        run: SIMPLECOV=1 bundle exec rspec
+        env:
+          RAILS_ENV: test
+          DATABASE_USERNAME: postgres
+          DATABASE_PASSWORD: postgres

.gitignore

@@ -48,4 +48,7 @@
 
 
 # Ignore Tailwind configuration
-tailwind.config.js
+tailwind.config.js
+
+# Ignore rspec failures
+.rspec-failures

.mdl_style.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+all
+
+exclude_rule "first-line-h1"
+
+exclude_rule "line-length"
+
+exclude_rule "no-bare-urls"
+
+exclude_rule "no-inline-html"
+
+exclude_rule "ol-prefix"
+
+exclude_rule "ul-indent"
+
+rule "no-trailing-punctuation", punctuation: ".,;:!"

.mdlrc

@@ -0,0 +1 @@
+style ".mdl_style.rb"

.rubocop.yml

@@ -1,2 +1,26 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   decidim-dev: rubocop-decidim.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  Include:
+    - "**/*.rb"
+    - "**/*.rake"
+    - "**/*.ru"
+    - "**/Gemfile"
+    - "**/Rakefile"
+  Exclude:
+    - "spec/decidim_dummy_app/**/*"
+    - "**/spec/decidim_dummy_app/**/*"
+    - "bin/**/*"
+    - "node_modules/**/*"
+    - "**/node_modules/**/*"
+    - "db/schema.rb"
+    - "db/migrate/*"
+    - "vendor/**/*"
+    - "**/vendor/**/*"

Gemfile

@@ -22,6 +22,7 @@ group :development, :test do
 
   gem "brakeman", "~> 5.4"
   gem "decidim-dev", "0.28.1"
+  gem "mdl"
   gem "net-imap", "~> 0.2.3"
   gem "net-pop", "~> 0.1.1"
   gem "net-smtp", "~> 0.3.1"

Gemfile.lock

@@ -157,6 +157,8 @@ GEM
       actionpack (>= 5.0)
       cells (>= 4.1.6, < 5.0.0)
     charlock_holmes (0.7.7)
+    chef-utils (18.4.12)
+      concurrent-ruby
     commonmarker (0.23.10)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
@@ -480,6 +482,10 @@ GEM
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     launchy (2.5.2)
       addressable (~> 2.8)
     letter_opener (1.8.1)
@@ -502,6 +508,12 @@ GEM
       net-smtp
     marcel (1.0.2)
     matrix (0.4.2)
+    mdl (0.13.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+      mixlib-shellout
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
@@ -510,6 +522,11 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
     minitest (5.20.0)
+    mixlib-cli (2.1.8)
+    mixlib-config (3.0.27)
+      tomlrb
+    mixlib-shellout (3.2.8)
+      chef-utils
     msgpack (1.4.5)
     multi_json (1.15.0)
     multi_xml (0.6.0)
@@ -782,6 +799,7 @@ GEM
     thor (1.3.0)
     tilt (2.1.0)
     timeout (0.4.0)
+    tomlrb (2.0.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uber (0.1.0)
@@ -846,6 +864,7 @@ DEPENDENCIES
   figaro (~> 1.2)
   letter_opener_web (~> 2.0)
   listen (~> 3.1)
+  mdl
   net-imap (~> 0.2.3)
   net-pop (~> 0.1.1)
   net-smtp (~> 0.3.1)

README.md

@@ -1,5 +1,8 @@
 # decidim_b4m
 
+[![[CI] Lint](https://github.com/Platoniq/decidim-b4m/actions/workflows/lint.yml/badge.svg)](https://github.com/Platoniq/decidim-b4m/actions/workflows/lint.yml)
+[![[CI] Test](https://github.com/Platoniq/decidim-b4m/actions/workflows/test.yml/badge.svg)](https://github.com/Platoniq/decidim-b4m/actions/workflows/test.yml)
+
 Free Open-Source participatory democracy, citizen participation and open government for cities and organizations
 
 This is the open-source repository for decidim_b4m, based on [Decidim](https://github.com/decidim/decidim).

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 

app/channels/application_cable/channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApplicationCable
   class Channel < ActionCable::Channel::Base
   end

app/channels/application_cable/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApplicationCable
   class Connection < ActionCable::Connection::Base
   end

app/controllers/application_controller.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
 end

app/controllers/decidim_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Entry point for Decidim. It will use the `DecidimController` as
 # entry point, but you can change what controller it inherits from
 # so you can customize some methods.

app/helpers/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
 end

app/jobs/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationJob < ActiveJob::Base
   # Automatically retry jobs that encountered a deadlock
   # retry_on ActiveRecord::Deadlocked

app/mailers/application_mailer.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 class ApplicationMailer < ActionMailer::Base
-  default from: 'from@example.com'
-  layout 'mailer'
+  default from: "from@example.com"
+  layout "mailer"
 end

app/models/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

app/views/layouts/mailer.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <style>
       /* Email styles need to be inline */
     </style>

config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
 require_relative "config/environment"

config/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "boot"
 
 require "decidim/rails"

config/boot.rb

@@ -1,4 +1,6 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+# frozen_string_literal: true
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 
 require "bundler/setup" # Set up gems listed in the Gemfile.
 require "bootsnap"

config/database.yml

@@ -29,7 +29,7 @@ default: &default
 
 development:
   <<: *default
-  database: decidim_b4m_development
+  database: <%= ENV.fetch("DATABASE_NAME") { "decidim_b4m_development" } %>
 
   # The specified database role being used to connect to postgres.
   # To create additional roles in postgres see `$ createuser --help`.

config/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Load the Rails application.
 require_relative "application"