frozen_rails 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e185eb3c340edef2f4261d427c7f89af260850823fd580424605617747da9737
-  data.tar.gz: fd604198415fdede3bf2e27565c96550d747d14a92c1faf04308c0fa99c764b0
+  metadata.gz: 0d1e4038850bfbf0972c64d50c2de0ef854c1165cbef4f6fba5c63cc963d5e39
+  data.tar.gz: 47a78650b8de3d17aa463157c78c1242789389e4b0df03b56eeef9057efe9fbd
 SHA512:
-  metadata.gz: d618e3625585a1b41fa98665773113f9d12826881054dbcc38d9287829ad5b2fc1f4efabef3a4485542342280083845e4fbaaf0e786bbbfdb778479c00a6dcd0
-  data.tar.gz: c8b5371939545258ea853ed909f6acbe046874c914dfea7b2fd6d03e0aca75ca08c4bd879778ccaced3f25568347531175cdbab2b052ace3e2fb178181340716
+  metadata.gz: d33940e9f7a07bc38a4dcdcdb867396b137e5a2bb265207fb46e45c1b65a3593f30127bd63f23ed12c5aa5d01dde3aa924a83049178f3be71d34108b5aca67c7
+  data.tar.gz: 3a7a176184cf0b5d87b0a4727187e5ee89ee46e11fbf7a2a13d66a05efcb9a759f72f973c243bab36b962514e94303f1ecc00b3058fcde5a1dbdbf4893faa25d

data/README.md

@@ -4,7 +4,12 @@
 
 # Frozen Rails
 
-TBD
+DISCLAIMER: I generated this repo with AI and haven't tested it yet.
+I will verify manually verify the functionality and use AI to generate a test suite as soon as I get to it. Until then, use at your own risk.
+
+This repo automates the instructions from [rails-static.com](https://rails-static.com) and some additional setup which was created by me.
+
+Running the full setup `bin/rails g frozen:rails` should turn a fresh Rails application into a full static-site generator that supports Markdown AND structured data (SQLite). The SSG is very developer-focused and might be cumbersome to use for non-devs.
 
 ## Installation
 
@@ -33,7 +38,79 @@ gem "frozen_rails"
 
 ## Usage
 
-TBD
+The gem ships with Rails generators under the `frozen` namespace. After including `frozen_rails` in your Rails application the following generators will be available:
+
+```bash
+# ✅ passes, ✅ works correctly, ❌ has test suite
+
+# - Adds `decant` with a custom extension.
+# - Adds `kramdown`, `rouge` and ERB interpolation for `.md` files.
+# - Adds application scaffold.
+
+bin/rails g frozen:md
+# - Prompts for a rouge theme. Pass `--rouge_theme=name` to run non-interactive.
+```
+
+```bash
+# ✅ passes, ✅ works correctly, ❌ has test suite
+
+# - Adds `parklife`
+# - Adds `.gitlab-ci.yml` and tweaks parklife config.
+
+bin/rails g frozen:ssg
+```
+
+```bash
+# ✅ passes, ✅ works correctly, ❌ has test suite
+
+# - Adds `sqlite_extensions-uuid`
+# - Adds `static_db`
+# - Adds `friendly_id`
+# - Adds `avo`
+# - Adjusts Rails scaffold generator and migration generator to be more helpful
+
+bin/rails g frozen:db
+```
+
+```bash
+# ✅ passes, ❓ works correctly, ❌ has test suite
+
+# - SEO helpers
+# - sitemap/robots skeleton
+
+bin/rails g frozen:seo
+```
+
+```bash
+# FUTURE: frozen:erb
+
+# - view_component
+# - herb
+# - lookbook
+```
+
+```bash
+# ✅ passes, ❓ works correctly, ❌ has test suite
+
+# - water.css
+# - sample importmap pin
+# - Hotwire Spark & Action Cable configuration
+# - Stimulus hotkey controller
+
+bin/rails g frozen:ui
+```
+
+```bash
+# ✅ passes, ❓ works correctly, ❌ has test suite
+
+# Full Rails setup (runs all frozen generators in order)
+
+bin/rails g frozen:rails
+```
+
+```bash
+# FUTURE: frozen:meetup
+```
 
 ## Contributing
 

data/lib/frozen_rails/appendable.rb

@@ -0,0 +1,13 @@
+module Appendable
+  extend ActiveSupport::Concern
+
+  private
+
+  def append_to_application_config(content)
+    inject_into_file "config/application.rb", optimize_indentation("\n#{content}", 4), before: /  end\nend(?:\n)\z/, verbose: false
+  end
+
+  def append_to_routes(content)
+    inject_into_file "config/routes.rb", optimize_indentation("\n#{content}", 2), before: /end(?:\n)\z/, verbose: false
+  end
+end

data/lib/frozen_rails/bundleable.rb

@@ -0,0 +1,11 @@
+module Bundleable
+  extend ActiveSupport::Concern
+
+  private
+
+  def bundle!
+    Bundler.with_unbundled_env do
+      system "bundle install"
+    end
+  end
+end

data/lib/frozen_rails/copyable.rb

@@ -0,0 +1,14 @@
+module Copyable
+  extend ActiveSupport::Concern
+
+  private
+
+  def copy_directory(source, target, **options)
+    base = File.join(self.class.source_root, source)
+    Dir.glob("#{base}/**/*").each do |path|
+      next if File.directory?(path)
+      rel = path.delete_prefix("#{base}/")
+      copy_file "#{source}/#{rel}", "#{target}/#{rel}", **options
+    end
+  end
+end

data/lib/frozen_rails/generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "frozen_rails/appendable"
+require "frozen_rails/bundleable"
+require "frozen_rails/copyable"
+require "frozen_rails/taggable"
+
+module FrozenRails
+  class Generator < Rails::Generators::Base
+    include Appendable
+    include Bundleable
+    include Copyable
+    include Taggable
+  end
+end

data/lib/frozen_rails/taggable.rb

@@ -0,0 +1,58 @@
+module Taggable
+  extend ActiveSupport::Concern
+
+  included do
+    class_option :cleanup_frozen_tags, type: :boolean, default: true, hide: true
+  end
+
+  private
+
+  def add_frozen_gems(content, env: nil)
+    add_frozen_gemfile_tags(env:)
+    insert_into_file "Gemfile", optimize_indentation("#{content}\n", env ? 2 : 0), before: frozen_end_tag(env:)
+    cleanup_frozen_tags!(env:)
+  end
+
+  def frozen_start_tag(env: nil)
+    env_attribute = env ? " env=\"#{env}\"" : ""
+    "# <frozen_rails#{env_attribute}>"
+  end
+
+  def frozen_end_tag(env: nil)
+    frozen_start_tag(env:).gsub("# <", "# </")
+  end
+
+  def add_frozen_gemfile_tags(env: nil)
+    unless File.read("Gemfile").include?(frozen_start_tag(env:))
+      newlines = env ? "\n" : "\n\n"
+      tags = "#{frozen_start_tag(env:)}#{newlines}#{frozen_end_tag(env:)}"
+      insert_into_file "Gemfile", tags, after: frozen_tags_after(env:)
+    end
+  end
+
+  def frozen_tags_after(env: nil)
+    case env
+    when nil
+      /frozen_rails[^\n]*\n/
+    when "local"
+      "group :development, :test do\n"
+    when "development"
+      "group :development do\n"
+    else
+      raise "Unsupported env!"
+    end
+  end
+
+  def cleanup_frozen_tags!(env: nil)
+    if options[:cleanup_frozen_tags]
+      gsub_file! "Gemfile", /[^\n]*#{frozen_start_tag(env:)}[^\n]*\n/, ""
+      gsub_file! "Gemfile", /[^\n]*#{frozen_end_tag(env:)}[^\n]*\n/, ""
+    end
+  end
+
+  def cleanup_all_frozen_tags!
+    cleanup_frozen_tags!
+    cleanup_frozen_tags!(env: "local")
+    cleanup_frozen_tags!(env: "development")
+  end
+end

data/lib/frozen_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FrozenRails # :nodoc:
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/frozen_rails.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
 require "frozen_rails/version"
-require "frozen_rails/railtie" if defined?(Rails::Railtie)

data/lib/generators/frozen/db_generator.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "frozen_rails/generator"
+
+module Frozen
+  module Generators
+    class DbGenerator < FrozenRails::Generator
+      source_root File.expand_path("templates/db", __dir__)
+
+      desc "Prepare a Rails app for static_db with SQLite UUIDs, Avo and FriendlyId"
+
+      def add_gems
+        add_frozen_gems <<~RUBY
+          # frozen:db
+          gem "static_db"
+          gem "sqlite_extensions-uuid"
+          gem "friendly_id"
+        RUBY
+
+        add_frozen_gems <<~RUBY, env: "development"
+          # frozen:db
+          gem "avo", ">= 3.2"
+        RUBY
+      end
+
+      def bundle_gems
+        bundle!
+      end
+
+      def add_routes
+        append_to_routes <<~RUBY
+          # frozen:db
+          if Rails.env.development?
+            mount_avo at: "/avo"
+          end
+        RUBY
+      end
+
+      def copy_files
+        copy_file "database.yml", "config/database.yml", force: true
+        copy_directory "initializers", "config/initializers"
+        copy_directory "lib", "lib"
+      end
+
+      def configure_application
+        gsub_file "config/application.rb", /(config\.autoload_lib\(ignore: %w\[).*(\]\))/, '\1assets generators tasks templates\2'
+
+        append_to_application_config <<~RUBY
+          # frozen:db
+          config.generators do |g|
+            g.orm :active_record, primary_key_type: :uuid
+            g.test_framework nil
+            g.helper nil
+          end
+          config.active_storage.draw_routes = true
+        RUBY
+      end
+
+      def prepare_db
+        rails_command "db:create"
+        rails_command "db:schema:load"
+      end
+
+      def setup_active_storage
+        rails_command "active_storage:install"
+
+        active_storage_migration = in_root { Dir.glob("db/migrate/*.active_storage.rb").first }
+
+        gsub_file active_storage_migration, /# Use.*\n.*primary_and_foreign_key_types/, <<~RUBY.chomp.lines.map(&:chomp).join("\n    ")
+          # Use custom primary and foreign key types to support SQLite UUIDs.
+          primary_key_type = { id: :string, default: -> { "uuid()" }, limit: 36 }
+          foreign_key_type = { type: :string, limit: 36 }
+        RUBY
+        gsub_file active_storage_migration, "id: primary_key_type", "**primary_key_type"
+        gsub_file active_storage_migration, "type: foreign_key_type", "**foreign_key_type"
+        gsub_file active_storage_migration, /\n\s*private.*end(?=\nend)/m, ""
+      end
+
+      def setup_friendly_id
+        rails_command "g migration create_friendly_id_slugs"
+
+        friendly_id_migration = in_root { Dir.glob("db/migrate/*create_friendly_id_slugs.rb").first }
+
+        gsub_file friendly_id_migration, /create_table.*?end(?=\n)/m, <<~RUBY.chomp.lines.map(&:chomp).join("\n    ")
+          create_table :friendly_id_slugs, id: :string, default: -> { "uuid()" }, limit: 36 do |t|
+            t.string :slug, null: false
+            t.string :sluggable_id, limit: 36, null: false
+            t.string :sluggable_type, limit: 50
+            t.string :scope
+            t.datetime :created_at
+          end
+          add_index :friendly_id_slugs, [ :sluggable_type, :sluggable_id ]
+          add_index :friendly_id_slugs, [ :slug, :sluggable_type ], length: { slug: 140, sluggable_type: 50 }
+          add_index :friendly_id_slugs, [ :slug, :sluggable_type, :scope ], length: { slug: 70, sluggable_type: 50, scope: 70 }, unique: true
+        RUBY
+      end
+
+      def setup_avo
+        rails_command "g avo:install"
+
+        prepend_to_file "config/initializers/avo.rb", <<~RUBY + "\n"
+          if Rails.env.development?
+            # Allow moving Avo controllers into `app/avo/controllers/`
+            Rails.autoloaders.main.collapse(
+              Rails.root.join("app/avo/controllers")
+            )
+          else
+            # Don't load Avo
+            Rails.autoloaders.main.ignore(
+              Rails.root.join("app/avo"),
+              Rails.root.join("app/controllers/avo")
+            )
+
+            # Don't configure Avo
+            return
+          end
+        RUBY
+
+        run "b rubocop -a config/initializers/avo.rb"
+      end
+
+      def migrate_and_cleanup_db
+        rails_command "db:migrate"
+        rails_command "db:drop"
+      end
+    end
+  end
+end

data/lib/generators/frozen/md_generator.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "frozen_rails/generator"
+
+module Frozen
+  module Generators
+    class MdGenerator < FrozenRails::Generator
+      source_root File.expand_path("templates/md", __dir__)
+
+      # When absent, the generator will prompt interactively (unless running non-interactively).
+      class_option :rouge_theme, type: :string, desc: "Rouge theme to install (runs non-interactive if provided)"
+
+      desc "Set up markdown-powered content with Decant, kramdown, ERB processing and Rouge highlighting"
+
+      def add_gems
+        add_frozen_gems <<~RUBY
+          # frozen:md
+          gem "decant"
+          gem "kramdown"
+          gem "kramdown-parser-gfm"
+          gem "rouge"
+        RUBY
+      end
+
+      def bundle_gems
+        bundle!
+      end
+
+      def copy_files
+        copy_directory "controllers", "app/controllers"
+        copy_directory "helpers", "app/helpers"
+        copy_directory "models", "app/models"
+        copy_directory "views", "app/views"
+        copy_directory "initializers", "config/initializers"
+        copy_directory "pages", "content/pages"
+      end
+
+      def add_config
+        append_to_application_config <<~RUBY
+          # frozen:md
+          config.assets.paths << Rails.root.join("content")
+          config.action_dispatch.rescue_responses["Decant::FileNotFound"] = :not_found
+        RUBY
+      end
+
+      def add_routes
+        append_to_routes <<~RUBY
+          root "categories#index"
+
+          # frozen:md
+          constraints slug: Regexp.union(Category.all.map(&:slug)) do
+            resources :categories, param: :slug, only: [ :index, :show ]
+          end
+          resources :pages, param: :slug, only: [ :show ]
+        RUBY
+      end
+
+      def generate_rouge_css_stylesheet
+        theme = options[:rouge_theme]
+
+        if theme.blank? && behavior == :invoke && $stdin.tty?
+          # Run in subshell so we pick up newly installed gem without needing to require it in the current process.
+          themes = `bundle exec ruby -e "require 'rouge'; puts Rouge::Theme.registry.keys.sort"`.split("\n")
+
+          say_status :info, "Available Rouge themes (#{themes.size}):", :blue
+          themes.each_with_index { |t, i| say "  #{i + 1}. #{t}" }
+
+          answer = ask("Choose a theme (name or number) [github]")
+
+          theme = if /^\d+$/.match?(answer)
+            themes[answer.to_i - 1]
+          else
+            answer.presence
+          end
+        end
+
+        theme ||= "github"
+
+        say_status :info, "Generating Rouge CSS for theme #{theme}", :blue
+        run "rougify style #{theme} > app/assets/stylesheets/rouge.css"
+      end
+    end
+  end
+end

data/lib/generators/frozen/rails_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "frozen_rails/taggable"
+
+module Frozen
+  module Generators
+    # A meta-generator that runs the other frozen generators in a sensible order.
+    class RailsGenerator < Rails::Generators::Base
+      include Taggable
+
+      desc "Run all frozen setup generators (md, db, seo, ui, dx, ssg)"
+
+      # The method name doesn't matter much; Thor runs all public methods in
+      # order defined by source.
+      def run_all
+        say_status :info, "invoking frozen:md"
+        invoke "frozen:md", [], cleanup_frozen_tags: false
+
+        say_status :info, "invoking frozen:db"
+        invoke "frozen:db", [], cleanup_frozen_tags: false
+
+        say_status :info, "invoking frozen:seo"
+        invoke "frozen:seo", [], cleanup_frozen_tags: false
+
+        say_status :info, "invoking frozen:ui"
+        invoke "frozen:ui", [], cleanup_frozen_tags: false
+
+        say_status :info, "invoking frozen:dx"
+        invoke "frozen:dx", [], cleanup_frozen_tags: false
+
+        say_status :info, "invoking frozen:ssg"
+        invoke "frozen:ssg", [], cleanup_frozen_tags: false
+
+        cleanup_all_frozen_tags!
+      end
+    end
+  end
+end

data/lib/generators/frozen/seo_generator.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "frozen_rails/generator"
+
+module Frozen
+  module Generators
+    class SeoGenerator < FrozenRails::Generator
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Add SEO helpers, metadata partials and sitemap/robots models"
+
+      # add meta partial and update layout
+      def create_og_partial
+        template "seo/_og_meta_tags.html.erb", "app/views/layouts/_og_meta_tags.html.erb"
+      end
+
+      def inject_layout_tags
+        return unless File.exist?("app/views/layouts/application.html.erb")
+
+        inject_into_file "app/views/layouts/application.html.erb",
+          after: "<head>\n" do
+          <<~ERB
+            <%= render 'layouts/og_meta_tags', tags: {
+              title: title,
+              description: description,
+              image: image_url('og-image.jpg'),
+              author: author,
+              type: "website",
+              site_name: site_name,
+              url: canonical_url,
+            } %>
+
+            <%= tag :link, rel: "canonical", href: canonical_url %>
+
+            <%= favicon_link_tag 'favicon.ico', sizes: '32x32' %>
+            <%= favicon_link_tag 'icon.svg', type: 'image/svg+xml' %>
+            <%= favicon_link_tag 'apple-touch-icon.png', rel: 'apple-touch-icon' %>
+
+            <%= tag :meta, name: "robots", content: robots_content %>
+
+          ERB
+        end
+      end
+
+      # helpers for meta tags
+      def add_application_helpers
+        unless File.exist?("app/helpers/application_helper.rb")
+          create_file "app/helpers/application_helper.rb", "module ApplicationHelper\nend\n"
+        end
+
+        inject_into_file "app/helpers/application_helper.rb",
+          after: "module ApplicationHelper\n" do
+          <<~RUBY
+            def site_name
+              "Rails Static"
+            end
+
+            def title
+              [ @page&.title.presence, site_name ].uniq.compact.join(" · ")
+            end
+
+            def description
+              @page.frontmatter&.dig(:description)
+            end
+
+            def author
+              "François Catuhe"
+            end
+
+            def canonical_url
+              url_for(only_path: false)
+            end
+
+            def robots_content
+              Rails.env.production? ? "index, follow" : "noindex, nofollow"
+            end
+
+            def og_meta_tag(key, content)
+              case key
+              when :title, :description, :image
+                tag(:meta, name: key, property: "og:\#{key}", content: content)
+              when :author
+                tag(:meta, name: key, content: content)
+              else
+                tag(:meta, property: "og:\#{key}", content: content)
+              end
+            end
+
+          RUBY
+        end
+      end
+
+      def add_favicon_notice
+        say_status :info, "Add favicons (favicon.ico, icon.svg, apple-touch-icon.png) to app/assets/images and create og-image.jpg"
+      end
+
+      # sitemap models
+      def create_sitemap_models
+        template "seo/sitemap.rb", "app/models/sitemap.rb"
+        template "seo/sitemap_entry.rb", "app/models/sitemap/entry.rb"
+        template "seo/robots_generatable.rb", "app/models/sitemap/robots_generatable.rb"
+      end
+
+      def remove_default_robots
+        remove_file "public/robots.txt" if File.exist?("public/robots.txt")
+      end
+    end
+  end
+end

data/lib/generators/frozen/ssg_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "frozen_rails/generator"
+
+module Frozen
+  module Generators
+    class SsgGenerator < FrozenRails::Generator
+      source_root File.expand_path("templates/ssg", __dir__)
+
+      desc "Set up Parklife static site generation with CI workflows and helper scripts"
+
+      def add_gems
+        add_frozen_gems <<~RUBY
+          # frozen:ssg
+          gem "parklife-rails"
+        RUBY
+      end
+
+      def bundle_gems
+        bundle!
+      end
+
+      def run_parklife_init
+        run "bundle exec parklife init --rails --github-pages"
+        append_to_file ".gitignore", "# frozen:ssg\n/build\n"
+      end
+
+      def setup_gitlab_pages
+        copy_file ".gitlab-ci.yml"
+        comment_lines "Parkfile", /config\.nested_index = false/
+      end
+
+      def configure_parklife_active_storage_integration
+        copy_file "storage.yml", "config/storage.yml", force: true
+
+        uncomment_lines "config/environments/production.rb", /config\.assume_ssl = true/
+        gsub_file "config/environments/production.rb", /config\.active_storage\.service = :\w+/, "config.active_storage.service = :parklife"
+
+        insert_into_file "config/application.rb", "\n" + <<~RUBY, before: /(\n#.*)?\n#.*\nBundler\.require/
+          # frozen:ssg
+          if ARGV.first == "build"
+            require "parklife-rails/activestorage"
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/frozen/templates/db/database.yml

@@ -0,0 +1,18 @@
+default: &default
+  adapter: sqlite3
+  extensions:
+    - <%= SqliteExtensions::UUID.to_path %>
+  max_connections: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: storage/development.sqlite3
+
+test:
+  <<: *default
+  database: storage/test.sqlite3
+
+production:
+  <<: *default
+  database: storage/production.sqlite3

data/lib/generators/frozen/templates/db/initializers/friendly_id.rb

@@ -0,0 +1,13 @@
+FriendlyId.defaults do |config|
+  config.use :slugged
+  config.use :finders
+  config.use :history
+  config.use :reserved
+
+  config.reserved_words = %w[
+    new edit index
+    session login logout users admin
+    stylesheets assets javascripts images
+    avo pages
+  ]
+end