develoz-rails 0.1.0

data/lib/generators/develoz/auth/auth_generator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "develoz"
+
+module Develoz
+  module Generators
+    class AuthGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def add_bcrypt_gem
+        add_gem "bcrypt"
+      end
+
+      def create_user_model
+        template "app/models/user.rb.tt", "app/models/user.rb"
+      end
+
+      def create_current_model
+        template "app/models/current.rb.tt", "app/models/current.rb"
+      end
+
+      def create_authentication_concern
+        template "app/controllers/concerns/authentication.rb.tt",
+                 "app/controllers/concerns/authentication.rb"
+      end
+
+      def create_sessions_controller
+        template "app/controllers/sessions_controller.rb.tt",
+                 "app/controllers/sessions_controller.rb"
+      end
+
+      def create_passwords_controller
+        template "app/controllers/passwords_controller.rb.tt",
+                 "app/controllers/passwords_controller.rb"
+      end
+
+      def create_passwords_mailer
+        template "app/mailers/passwords_mailer.rb.tt",
+                 "app/mailers/passwords_mailer.rb"
+      end
+
+      def create_sessions_views
+        template "app/views/sessions/new.html.erb.tt",
+                 "app/views/sessions/new.html.erb"
+      end
+
+      def create_passwords_views
+        template "app/views/passwords/edit.html.erb.tt",
+                 "app/views/passwords/edit.html.erb"
+      end
+
+      def create_passwords_mailer_views
+        template "app/views/passwords_mailer/reset.html.erb.tt",
+                 "app/views/passwords_mailer/reset.html.erb"
+      end
+
+      def create_users_migration
+        return if migration_exists?("create_users")
+
+        template "db/migrate/create_users.rb.tt",
+                 "db/migrate/#{next_migration_timestamp}_create_users.rb"
+      end
+
+      def insert_auth_routes
+        insert_route "resource :session, only: [:new, :create, :destroy]"
+        insert_route "resources :passwords, param: :token, only: [:new, :create, :edit, :update]"
+      end
+
+      def create_sessions_request_spec
+        template "spec/requests/sessions_spec.rb.tt",
+                 "spec/requests/sessions_spec.rb"
+      end
+
+      def create_passwords_request_spec
+        template "spec/requests/passwords_spec.rb.tt",
+                 "spec/requests/passwords_spec.rb"
+      end
+    end
+  end
+end

data/lib/generators/develoz/auth/templates/app/controllers/concerns/authentication.rb.tt

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Authentication
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :require_authentication
+    helper_method :authenticated?
+  end
+
+  class_methods do
+    def allow_authentication_as(**options)
+      skip_before_action :require_authentication, **options
+    end
+  end
+
+  private
+
+  def authenticated?
+    resume_session
+  end
+
+  def require_authentication
+    resume_session || request_authentication
+  end
+
+  def resume_session
+    Current.user ||= find_user_by_cookie
+  end
+
+  def find_user_by_cookie
+    User.find_by(id: cookies.signed[:user_id]) if cookies.signed[:user_id]
+  end
+
+  def request_authentication
+    session[:return_to_after_authenticating] = request.url
+    redirect_to new_session_path
+  end
+
+  def after_authentication_url
+    session.delete(:return_to_after_authenticating) || root_url
+  end
+
+  def start_new_session_for(user)
+    Current.user = user
+    cookies.signed.permanent[:user_id] = { value: user.id, httponly: true, same_site: :lax }
+  end
+
+  def terminate_session
+    Current.user = nil
+    cookies.delete(:user_id)
+  end
+end

data/lib/generators/develoz/auth/templates/app/controllers/passwords_controller.rb.tt

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class PasswordsController < ApplicationController
+  allow_authentication_as
+  before_action :set_user_by_token, only: %i[edit update]
+  rate_limit to: 10, within: 3.minutes, only: :create, with: -> { redirect_to new_password_path, alert: "Try again later." }
+
+  def new; end
+
+  def create
+    if (user = User.find_by(email: params[:email]))
+      PasswordsMailer.reset(user).deliver_later
+    end
+
+    redirect_to new_session_path, notice: "Password reset instructions sent (if user with that email address exists)."
+  end
+
+  def edit; end
+
+  def update
+    if @user.update(params.permit(:password, :password_confirmation))
+      redirect_to new_session_path, notice: "Password has been reset."
+    else
+      redirect_to edit_password_path(params[:token]), alert: "Passwords did not match."
+    end
+  end
+
+  private
+
+  def set_user_by_token
+    @user = User.find_by_password_reset_token!(params[:token])
+  rescue ActiveSupport::MessageVerifier::InvalidSignature
+    redirect_to new_password_path, alert: "Password reset link is invalid or has expired."
+  end
+end

data/lib/generators/develoz/auth/templates/app/controllers/sessions_controller.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class SessionsController < ApplicationController
+  allow_authentication_as only: %i[new create]
+  rate_limit to: 10, within: 3.minutes, only: :create, with: -> { redirect_to new_session_path, alert: "Try again later." }
+
+  def new; end
+
+  def create
+    if (user = User.authenticate_by(params.permit(:email, :password)))
+      start_new_session_for user
+      redirect_to after_authentication_url
+    else
+      redirect_to new_session_path, alert: "Try another email address or password."
+    end
+  end
+
+  def destroy
+    terminate_session
+    redirect_to new_session_path, status: :see_other
+  end
+end

data/lib/generators/develoz/auth/templates/app/mailers/passwords_mailer.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class PasswordsMailer < ApplicationMailer
+  def reset(user)
+    @user = user
+    mail subject: "Reset your password", to: user.email
+  end
+end

data/lib/generators/develoz/auth/templates/app/models/current.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Current < ActiveSupport::CurrentAttributes
+  attribute :user
+end

data/lib/generators/develoz/auth/templates/app/models/user.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class User < ApplicationRecord
+  has_secure_password
+  normalizes :email, with: ->(e) { e.strip.downcase }
+  validates :email, presence: true, uniqueness: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+end

data/lib/generators/develoz/auth/templates/app/views/passwords/edit.html.erb.tt

@@ -0,0 +1,9 @@
+<h1>Update your password</h1>
+
+<%%= tag.div(flash[:alert], style: "color:red") if flash[:alert] %>
+
+<%%= form_with url: password_path(params[:token]), method: :put do |form| %>
+  <%%= form.password_field :password, required: true, autocomplete: "new-password", placeholder: "Enter new password", maxlength: 72 %><br>
+  <%%= form.password_field :password_confirmation, required: true, autocomplete: "new-password", placeholder: "Repeat new password", maxlength: 72 %><br>
+  <%%= form.submit "Save" %>
+<%% end %>

data/lib/generators/develoz/auth/templates/app/views/passwords_mailer/reset.html.erb.tt

@@ -0,0 +1,6 @@
+<p>
+  You can reset your password on
+  <%%= link_to "this password reset page", edit_password_url(@user.password_reset_token) %>.
+
+  This link will expire in <%%= distance_of_time_in_words(0, @user.password_reset_token_expires_in) %>.
+</p>

data/lib/generators/develoz/auth/templates/app/views/sessions/new.html.erb.tt

@@ -0,0 +1,11 @@
+<%%= tag.div(flash[:alert], style: "color:red") if flash[:alert] %>
+<%%= tag.div(flash[:notice], style: "color:green") if flash[:notice] %>
+
+<%%= form_with url: session_path do |form| %>
+  <%%= form.email_field :email, required: true, autofocus: true, autocomplete: "username", placeholder: "Enter your email address", value: params[:email] %><br>
+  <%%= form.password_field :password, required: true, autocomplete: "current-password", placeholder: "Enter your password", maxlength: 72 %><br>
+  <%%= form.submit "Sign in" %>
+<%% end %>
+<br>
+
+<%%= link_to "Forgot password?", new_password_path %>

data/lib/generators/develoz/auth/templates/db/migrate/create_users.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateUsers < ActiveRecord::Migration[8.0]
+  def change
+    create_table :users do |t|
+      t.string :email, null: false
+      t.string :password_digest, null: false
+
+      t.timestamps
+    end
+    add_index :users, :email, unique: true
+  end
+end

data/lib/generators/develoz/auth/templates/spec/requests/passwords_spec.rb.tt

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Passwords", type: :request do
+  describe "GET /password/new" do
+    it "renders the forgot password form" do
+      get new_password_path
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  describe "POST /passwords" do
+    it "sends reset instructions when email exists" do
+      user = User.create!(email: "test@example.com", password: "password123")
+
+      expect { post passwords_path, params: { email: user.email } }
+        .to have_enqueued_mail(PasswordsMailer, :reset)
+    end
+
+    it "redirects to sign in with notice" do
+      post passwords_path, params: { email: "nonexistent@example.com" }
+      expect(response).to redirect_to(new_session_path)
+      expect(flash[:notice]).to be_present
+    end
+  end
+
+  describe "GET /password/:token/edit" do
+    it "renders the edit form for a valid token" do
+      user = User.create!(email: "test@example.com", password: "password123")
+
+      get edit_password_path(user.password_reset_token)
+      expect(response).to have_http_status(:ok)
+    end
+
+    it "redirects with alert for an invalid token" do
+      get edit_password_path("invalid-token")
+      expect(response).to redirect_to(new_password_path)
+      expect(flash[:alert]).to be_present
+    end
+  end
+
+  describe "PATCH /password/:token" do
+    it "resets the password with valid params" do
+      user = User.create!(email: "test@example.com", password: "password123")
+
+      patch password_path(user.password_reset_token), params: { password: "newpassword", password_confirmation: "newpassword" }
+      expect(response).to redirect_to(new_session_path)
+      expect(flash[:notice]).to be_present
+    end
+
+    it "redirects with alert when passwords do not match" do
+      user = User.create!(email: "test@example.com", password: "password123")
+
+      patch password_path(user.password_reset_token), params: { password: "newpassword", password_confirmation: "different" }
+      expect(response).to redirect_to(edit_password_path(user.password_reset_token))
+      expect(flash[:alert]).to be_present
+    end
+  end
+end

data/lib/generators/develoz/auth/templates/spec/requests/sessions_spec.rb.tt

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Sessions", type: :request do
+  describe "GET /session/new" do
+    it "renders the sign in form" do
+      get new_session_path
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  describe "POST /session" do
+    it "signs in a valid user" do
+      user = User.create!(email: "test@example.com", password: "password123")
+
+      post session_path, params: { email: user.email, password: "password123" }
+      expect(response).to redirect_to(root_url)
+    end
+
+    it "redirects with alert for invalid credentials" do
+      post session_path, params: { email: "wrong@example.com", password: "wrong" }
+      expect(response).to redirect_to(new_session_path)
+      expect(flash[:alert]).to be_present
+    end
+  end
+
+  describe "DELETE /session" do
+    it "signs out the current user" do
+      user = User.create!(email: "test@example.com", password: "password123")
+      post session_path, params: { email: user.email, password: "password123" }
+
+      delete session_path
+      expect(response).to redirect_to(new_session_path)
+    end
+  end
+end

data/lib/generators/develoz/ci/ci_generator.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "develoz"
+
+module Develoz
+  module Generators
+    class CiGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def add_ci_gems
+        add_gem "rubocop-rails-omakase", group: %i[development test]
+        add_gem "reek", group: %i[development test]
+        add_gem "flay", group: %i[development test]
+        add_gem "brakeman", group: %i[development test]
+        add_gem "bundler-audit", group: %i[development test]
+        add_gem "haml_lint", require: false, group: %i[development test]
+      end
+
+      def create_ci_entrypoint
+        template "bin/ci.tt", "bin/ci"
+      end
+
+      def create_ci_config
+        template "config/ci.rb.tt", "config/ci.rb"
+      end
+
+      def create_rakefile
+        template "Rakefile.tt", "Rakefile"
+      end
+
+      def create_rubocop_config
+        template ".rubocop.yml.tt", ".rubocop.yml"
+      end
+
+      def create_reek_config
+        template ".reek.yml.tt", ".reek.yml"
+      end
+
+      def create_biome_config
+        template "biome.json.tt", "biome.json"
+      end
+
+      def create_stylelint_config
+        template ".stylelintrc.json.tt", ".stylelintrc.json"
+      end
+
+      def create_haml_lint_config
+        template ".haml-lint.yml.tt", ".haml-lint.yml"
+      end
+
+      def create_markdownlint_config
+        template ".markdownlint.json.tt", ".markdownlint.json"
+      end
+
+      def create_yamllint_config
+        template ".yamllint.tt", ".yamllint"
+      end
+
+      def create_ci_workflow
+        template ".github/workflows/ci.yml.tt", ".github/workflows/ci.yml"
+      end
+    end
+  end
+end

data/lib/generators/develoz/ci/templates/.github/workflows/ci.yml.tt

@@ -0,0 +1,18 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Run CI pipeline
+        run: bin/ci

data/lib/generators/develoz/ci/templates/.haml-lint.yml.tt

@@ -0,0 +1,12 @@
+linters:
+  LineLength:
+    max: 120
+
+  ViewLength:
+    max: 120
+
+  InstanceVariables:
+    enabled: false
+
+  IdNames:
+    enabled: false

data/lib/generators/develoz/ci/templates/.markdownlint.json.tt

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD013": {
+    "line_length": 120,
+    "code_blocks": false,
+    "tables": false
+  },
+  "MD033": false,
+  "MD041": false
+}

data/lib/generators/develoz/ci/templates/.reek.yml.tt

@@ -0,0 +1,28 @@
+---
+exclude_paths:
+  - app/assets
+  - config
+  - db
+  - lib/tasks
+  - vendor
+  - spec
+  - node_modules
+
+detectors:
+  IrresponsibleModule:
+    enabled: false
+  UtilityFunction:
+    enabled: false
+  ControlParameter:
+    enabled: false
+  BooleanParameter:
+    enabled: false
+  FeatureEnvy:
+    enabled: false
+  TooManyStatements:
+    max_statements: 10
+  TooManyMethods:
+    max_methods: 25
+  UncommunicativeVariableName:
+    accept:
+      - e

data/lib/generators/develoz/ci/templates/.rubocop.yml.tt

@@ -0,0 +1,22 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.4
+  Exclude:
+    - "bin/*"
+    - "db/schema.rb"
+    - "vendor/bundle/**/*"
+    - "node_modules/**/*"
+
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns:
+    - !ruby/regexp /^ *# /
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/lib/generators/develoz/ci/templates/.stylelintrc.json.tt

@@ -0,0 +1,4 @@
+{
+  "extends": "stylelint-config-standard",
+  "ignoreFiles": ["app/assets/stylesheets/vendor/**/*"]
+}

data/lib/generators/develoz/ci/templates/.yamllint.tt

@@ -0,0 +1,14 @@
+---
+extends: default
+
+ignore: |
+  node_modules/
+  vendor/
+  tmp/
+  public/
+
+rules:
+  line-length: disable
+  document-start: disable
+  truthy:
+    check-keys: false

data/lib/generators/develoz/ci/templates/Rakefile.tt

@@ -0,0 +1,73 @@
+# 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.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks
+
+if Rails.env.development?
+  require 'rubocop/rake_task'
+  require 'haml_lint/rake_task'
+
+  namespace :lint do
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.fail_on_error = true
+      task.options = %w[--parallel]
+    end
+
+    HamlLint::RakeTask.new(:haml)
+
+    desc 'Lint JavaScript/TypeScript with Biome'
+    task :biome do # rubocop:disable Rails/RakeEnvironment
+      sh 'yarn lint'
+    end
+
+    desc 'Lint CSS/SCSS with Stylelint'
+    task :stylelint do # rubocop:disable Rails/RakeEnvironment
+      sh 'yarn lint:css'
+    end
+
+    desc 'Lint Markdown with markdownlint'
+    task :markdownlint do # rubocop:disable Rails/RakeEnvironment
+      sh 'yarn lint:md'
+    end
+
+    desc 'Run Brakeman static security analysis'
+    task :brakeman do # rubocop:disable Rails/RakeEnvironment
+      sh 'bundle exec brakeman --quiet --no-pager --exit-on-warn'
+    end
+
+    desc 'Lint YAML with yamllint'
+    task :yamllint do # rubocop:disable Rails/RakeEnvironment
+      sh 'yamllint .'
+    end
+
+    desc 'Detect code smells with Reek'
+    task :reek do # rubocop:disable Rails/RakeEnvironment
+      sh 'bundle exec reek app lib'
+    end
+
+    desc 'Detect structural duplication with Flay'
+    task :flay do # rubocop:disable Rails/RakeEnvironment
+      # Mass 300 clears the existing by-design Filters:: DSL similarity (max ~272)
+      # while still catching new egregious duplication. Lower it as that debt is paid down.
+      output = `bundle exec flay --mass 300 app lib`
+      puts output
+      abort 'Flay detected structural duplication' unless output.include?('Total score (lower is better) = 0')
+    end
+  end
+
+  desc 'Run all linters (RuboCop, haml-lint, Biome, Stylelint, markdownlint, yamllint, Brakeman, Reek, Flay)'
+  task lint: %w[lint:rubocop lint:haml lint:biome lint:stylelint lint:markdownlint lint:yamllint
+                lint:brakeman lint:reek lint:flay]
+
+  namespace :docs do
+    desc 'Check platform-guide docs are in sync with their documented system specs'
+    task :check do # rubocop:disable Rails/RakeEnvironment
+      ruby 'bin/generate-docs --check'
+    end
+  end
+
+  Rake::Task[:default].clear if Rake::Task.task_defined?(:default)
+  task default: %w[lint spec:parallel docs:check]
+end

data/lib/generators/develoz/ci/templates/bin/ci.tt

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "active_support/continuous_integration"
+
+CI = ActiveSupport::ContinuousIntegration
+require_relative "../config/ci.rb"

data/lib/generators/develoz/ci/templates/biome.json.tt

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "includes": ["**", "!**/vendor/**", "!**/node_modules/**", "!public/**", "!**/coverage/**"]
+  },
+  "formatter": {
+    "enabled": true,
+    "useEditorconfig": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 120
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedVariables": "error"
+      },
+      "security": {
+        "noDangerouslySetInnerHtmlWithChildren": "error",
+        "noGlobalEval": "warn"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded",
+      "trailingCommas": "es5"
+    }
+  }
+}