Merge pull request #1 from bibendi/feature/packwerk

Packwerk

Author: bibendi

.circleci/config.yml

@@ -90,7 +90,7 @@ commands:
 executors:
   ruby:
     docker:
-      - image: circleci/ruby:2.7.2-node
+      - image: circleci/ruby:2.7.4
     environment:
       BUNDLE_PATH: /home/circleci/project/vendor/bundle
       BUNDLER_VERSION: 2.2.31
@@ -99,7 +99,7 @@ executors:
 
   rails:
     docker:
-      - image: circleci/ruby:2.7.2-node-browsers
+      - image: circleci/ruby:2.7.4
       - image: timescale/timescaledb:2.1.0-pg13
         environment:
           POSTGRES_PASSWORD: password
@@ -239,6 +239,12 @@ jobs:
       - prepare_ruby_test_env
       - prepare_databases
       # run after tests to make sure that schema is up-to-date
+      - run:
+          name: Packwerk validate
+          command: bundle exec packwerk validate
+      - run:
+          name: Packwerk check
+          command: bundle exec packwerk check
       - run:
           name: Database Integrity check
           command: bundle exec rails db:validate_integrity
@@ -299,6 +305,9 @@ jobs:
       - engem:
           target: auth_by
           brakeman: true
+      - engem:
+          target: interests
+          brakeman: true
       - save_cache:
           key: vic-bootsnap-v1-{{ .Branch }}-{{ .Revision }}
           paths:

.database_consistency.yml

@@ -19,3 +19,7 @@ CoreBy::User:
     enabled: false
   index_users_on_unlock_token:
     enabled: false
+
+# Basically, this model should be separate and don't use shared table with CoreBy::User model.
+AuthBy::User:
+  enabled: false

.rubocop.yml

@@ -10,6 +10,8 @@ require:
 
 AllCops:
   Exclude:
+    - '**/tmp/**/*'
+    - '**/log/**/*'
     - 'db/schema.rb'
     - 'db/statistics_schema.rb'
 
@@ -42,4 +44,4 @@ Lint/Env:
     - '**/testing/*.rb'
     - '**/spec/**/support/**/*'
     - 'lib/generators/**/*'
-    - 'engines/core_by/app/models/core_by/direct_db.rb'
+    - 'engines/core_by/public/models/core_by/sdk/application_direct_record.rb'

.ruby-version

@@ -1 +1 @@
-2.7.2
+2.7.4

Gemfile

@@ -85,6 +85,9 @@ group :development, :test do
   # == Security/Audit
   # Check for known CVE in gems
   gem "bundler-audit", require: false
+
+  # Linter to enforce boundaries
+  gem "packwerk", require: false
 end
 
 group :development do
@@ -134,12 +137,13 @@ def engine(name)
       end
 
       # Add development deps to development and test groups
-      gem "#{name}-dev", path: "engines/#{name}", group: [:development, :test]
+      gem "#{name}-dev", path: "engines/#{name}"
     end
   end
 end
 
 path "engines" do
   engine "core_by"
   engine "auth_by"
+  engine "interests"
 end

Gemfile.lock

@@ -46,6 +46,7 @@ PATH
       rails (= 6.1.4.1)
       rails-i18n (~> 6.0)
       redis-mutex (~> 4.0)
+      resonad (~> 1.4)
       schked (~> 0.3)
     core_by-dev (1.0.0)
       bootsnap (~> 1.4)
@@ -56,6 +57,21 @@ PATH
       common-testing
       rake (~> 13.0)
 
+PATH
+  remote: engines/interests
+  specs:
+    interests (1.0.0)
+      core_by
+      pg (~> 1.0)
+      rails (= 6.1.4.1)
+    interests-dev (1.0.0)
+      bootsnap (~> 1.4)
+      brakeman (~> 5.0)
+      bundler (>= 2.0)
+      common-rubocop
+      common-testing
+      rake (~> 13.0)
+
 PATH
   remote: engines
   specs:
@@ -190,6 +206,14 @@ GEM
       ruby-next-core (>= 0.11.0)
     ast (2.4.2)
     bcrypt (3.1.16)
+    better_html (1.0.16)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
     bootsnap (1.9.1)
       msgpack (~> 1.0)
     brakeman (5.1.2)
@@ -203,6 +227,7 @@ GEM
       thor (>= 0.14.6)
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
+    constant_resolver (0.1.5)
     crass (1.0.6)
     database_consistency (1.1.6)
       activerecord (>= 3.2)
@@ -320,6 +345,7 @@ GEM
       google-protobuf (~> 3.17)
       googleapis-common-protos-types (~> 1.0)
     hiredis (0.6.3)
+    html_tokenizer (0.0.7)
     httpclient (2.8.3)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
@@ -372,6 +398,14 @@ GEM
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
     os (1.1.4)
+    packwerk (1.3.2)
+      activesupport (>= 5.2)
+      ast
+      better_html
+      constant_resolver
+      parallel
+      parser
+      sorbet-runtime
     paper_trail (12.1.0)
       activerecord (>= 5.2)
       request_store (~> 1.1)
@@ -446,6 +480,7 @@ GEM
       uber (< 0.2.0)
     request_store (1.5.0)
       rack (>= 1.4)
+    resonad (1.4.0)
     retriable (3.1.2)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -531,9 +566,11 @@ GEM
       actionpack (>= 3.1)
       railties (>= 3.1)
       slim (>= 3.0, < 5.0)
+    smart_properties (1.16.3)
     sniffer (0.4.0)
       active_attr (>= 0.10.2)
       anyway_config (>= 1.0)
+    sorbet-runtime (0.5.9327)
     sorcery (0.16.1)
       bcrypt (~> 3.1)
       oauth (~> 0.5, >= 0.5.5)
@@ -615,10 +652,13 @@ DEPENDENCIES
   debug (~> 1.1)
   google-cloud-storage
   graphql-schema_comparator
+  interests!
+  interests-dev!
   jwt
   listen
   lograge
   newrelic_rpm
+  packwerk
   pg
   puma (~> 5.2, >= 5.2.2)
   rack-attack
@@ -643,7 +683,7 @@ DEPENDENCIES
   yabeda-sidekiq
 
 RUBY VERSION
-   ruby 2.7.2p137
+   ruby 2.7.4p191
 
 BUNDLED WITH
    2.2.31

app/controllers/application_controller.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class ApplicationController < CoreBy::BaseController
+class ApplicationController < CoreBy::SDK::ApplicationController
   layout "application"
 end

config/inflections.yml

@@ -0,0 +1,14 @@
+# List your inflections in this file instead of `inflections.rb`
+# See steps to set up custom inflections:
+# https://github.com/Shopify/packwerk/blob/main/USAGE.md#Inflections
+
+acronym:
+  - GraphQL
+  - JWT
+  - JSON
+  - URL
+  - SDK
+  - API
+
+uncountable:
+  - auth

config/initializers/lograge.rb

@@ -13,8 +13,8 @@ def append_info_to_payload(payload)
   end
 end
 
-ActiveSupport.on_load("core_by/base_controller") { include LogrageContext }
-ActiveSupport.on_load("core_by/api/base_controller") { include LogrageContext }
+ActiveSupport.on_load("core_by/sdk/application_controller") { include LogrageContext }
+ActiveSupport.on_load("core_by/sdk/api_controller") { include LogrageContext }
 
 Rails.application.configure do
   lograge_ignore_params = (%w[controller action format id graphql] + config.filter_parameters.map(&:to_s)).uniq

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2021_02_24_091411) do
+ActiveRecord::Schema.define(version: 2021_11_22_064326) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -56,6 +56,22 @@
     t.index ["blob_id", "variation_digest"], name: "index_active_storage_variant_records_uniqueness", unique: true
   end
 
+  create_table "interests", force: :cascade do |t|
+    t.text "name", null: false
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.index ["name"], name: "index_interests_on_name", unique: true
+  end
+
+  create_table "user_interests", force: :cascade do |t|
+    t.bigint "user_id", null: false
+    t.bigint "interest_id", null: false
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.index ["interest_id"], name: "index_user_interests_on_interest_id"
+    t.index ["user_id", "interest_id"], name: "index_user_interests_on_user_id_and_interest_id", unique: true
+  end
+
   create_table "users", force: :cascade do |t|
     t.string "login"
     t.string "first_name"
@@ -102,4 +118,6 @@
 
   add_foreign_key "active_storage_attachments", "active_storage_blobs", column: "blob_id"
   add_foreign_key "active_storage_variant_records", "active_storage_blobs", column: "blob_id"
+  add_foreign_key "user_interests", "interests", on_delete: :cascade
+  add_foreign_key "user_interests", "users", on_delete: :cascade
 end