v0.1.0

.github/workflows/ci.yml

@@ -6,8 +6,41 @@ on:
     branches: [ main ]
 
 jobs:
+  scan_ruby:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3.3.1
+          bundler-cache: true
+
+      - name: Scan for security vulnerabilities in Ruby dependencies
+        run: bin/brakeman --no-pager
+
+  scan_js:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3.3.1
+          bundler-cache: true
+
+      - name: Scan for security vulnerabilities in JavaScript dependencies
+        run: bin/importmap audit
+
   lint:
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -21,4 +54,18 @@ jobs:
       - name: Lint code for consistent style
         run: bin/rubocop -f github
 
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3.3.1
+          bundler-cache: true
 
+      - name: Run tests
+        run: bundle exec rspec --format RSpec::Github::Formatter

.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--tty

.rubocop.yml

@@ -1,8 +1,43 @@
-# Omakase Ruby styling for Rails
-inherit_gem: { rubocop-rails-omakase: rubocop.yml }
-
-# Overwrite or add rules to create your own house style
-#
-# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
-# Layout/SpaceInsideArrayLiteralBrackets:
-#   Enabled: false
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rails
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  SuggestExtensions: false
+  Exclude:
+    - '**/bin/*'
+
+Style/Documentation:
+  Enabled: false
+
+Lint/MissingSuper:
+  Exclude:
+    - 'app/components/**/*'
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'app/components/**/*'
+    - 'site/app/previews/**/*'
+    - 'spec/components/previews/**/*'

.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-10-07 13:14:46 UTC using RuboCop version 1.66.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+Rails/OutputSafety:
+  Exclude:
+    - 'spec/components/**/*'
+    - 'site/app/previews/**/*'
+
+# Offense count: 12
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'spec/components/**/*'
+    - 'site/app/previews/**/*'
+    - 'spec/support/**/*'

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing to Essence
+
+We love pull requests from everyone. Here are some ways you can contribute:
+
+* By using alpha, beta, and prerelease versions
+* By reporting bugs
+* By suggesting new features
+* By writing or editing documentation
+* By writing specifications
+* By writing code (**no patch is too small**: fix typos, add comments, etc.)
+* By refactoring code
+* By closing [issues][]
+* By reviewing patches
+
+## Submitting an Issue
+
+* We use the [GitHub issue tracker][issues] to track bugs and features.
+* Before submitting a bug report or feature request, check to ensure it hasn't
+  already been submitted.
+* When submitting a bug report, please include a [Gist][gist] with a stack trace
+  and any details necessary to reproduce the bug, including your gem version,
+  Ruby version, and operating system. Ideally, a bug report should include a
+  pull request with failing specs.
+
+## Cleaning up issues
+
+* Issues with no response from the submitter will be closed after 30 days.
+* Issues will be closed once they're assumed to be fixed or answered. If the
+  maintainer is wrong, it can be opened again.
+* If your issue is closed by mistake, please understand and explain the issue.
+  We will happily reopen the issue.
+
+## Submitting a Pull Request
+
+1. [Fork][fork] the [official repository][repo].
+1. [Create a topic branch][branch].
+1. Implement your feature or bug fix.
+1. Add, commit, and push your changes.
+1. [Submit a pull request][pr].
+
+### Notes
+
+* Please add tests if you changed code. Contributions without tests won't be
+  accepted.
+* If you're unsure how to add tests, submit a PR and leave a comment asking for
+  help. We love to assist!
+* Please don't update the Gem version.
+
+Inspired by https://github.com/thoughtbot/factory_bot/blob/main/CONTRIBUTING.md
+
+[issues]: https://github.com/ePages-de/essence/issues
+[gist]: https://gist.github.com/
+[repo]: https://github.com/ePages-de/essence/tree/main
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/

Gemfile

@@ -1,16 +1,33 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in beyond_essence.gemspec.
-gemspec
+source 'https://rubygems.org'
 
-gem "puma"
+# Specify your gem's dependencies in essence.gemspec.
+gemspec
 
-gem "sqlite3"
+gem 'puma'
 
-gem "sprockets-rails"
+gem 'sqlite3'
 
-# Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
-gem "rubocop-rails-omakase", require: false
+gem 'sprockets-rails'
 
 # Start debugger with binding.b [https://github.com/ruby/debug]
 # gem "debug", ">= 1.0.0"
+
+gem 'lookbook'
+
+gem 'rubocop',       require: false
+gem 'rubocop-rails', require: false
+
+group :development, :test do
+  gem 'rspec-rails'
+end
+
+group :test do
+  gem 'brakeman'
+
+  gem 'capybara'
+  gem 'selenium-webdriver'
+
+  gem 'rspec-github', require: false
+end