frozen_rails 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d1e4038850bfbf0972c64d50c2de0ef854c1165cbef4f6fba5c63cc963d5e39
-  data.tar.gz: 47a78650b8de3d17aa463157c78c1242789389e4b0df03b56eeef9057efe9fbd
+  metadata.gz: abfb64658cf3eb104b953a8d190c82634ee962c5a8544e0584165252faf5cd3e
+  data.tar.gz: aa118f15dc15ffac611e4fd2e71c871812d483a23b40ee58e74e4fd3ea4f07cd
 SHA512:
-  metadata.gz: d33940e9f7a07bc38a4dcdcdb867396b137e5a2bb265207fb46e45c1b65a3593f30127bd63f23ed12c5aa5d01dde3aa924a83049178f3be71d34108b5aca67c7
-  data.tar.gz: 3a7a176184cf0b5d87b0a4727187e5ee89ee46e11fbf7a2a13d66a05efcb9a759f72f973c243bab36b962514e94303f1ecc00b3058fcde5a1dbdbf4893faa25d
+  metadata.gz: db3cd433980b66bc6b213baf6c9eee08e4ce3753c3a325b91b333b7a0d7a962f1a7fcbae5913578b8a5eb9e16bc03536c9b4fe01759a45dfc38a18176904418a
+  data.tar.gz: 443cfd39ae00fa7d3814a1f7ea88403321bcb521c085e188b0ad6d87788af0a71d79fa2c4057c4481273a95dad29f93600233309d968ee28b225ebf21c7bb4b2

data/CHANGELOG.md

@@ -1,3 +1,14 @@
-# Change log
+# Changelog
+
+> :warning: This project is not inteded for public usage yet.
+
+I will start keeping a changelog as soon as that happens.
+
+This project adheres to [Break Versioning](https://www.taoensso.com/break-versioning).
+
+## [Unreleased]
+
+### Breaking
+
+### Non-breaking
 
-## master

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Klaus Weidinger
+Copyright (c) 2025 Klaus Weidinger
 
 MIT License
 

data/README.md

@@ -1,124 +1,88 @@
-[![Gem Version](https://badge.fury.io/rb/dunkelziffer.svg)](https://rubygems.org/gems/dunkelziffer)
+[![Gem Version](https://badge.fury.io/rb/frozen_rails.svg)](https://rubygems.org/gems/frozen_rails)
 [![Build](https://github.com/dunkelziffer/frozen_rails/workflows/Build/badge.svg)](https://github.com/dunkelziffer/frozen_rails/actions)
-[![JRuby Build](https://github.com/dunkelziffer/frozen_rails/workflows/JRuby%20Build/badge.svg)](https://github.com/dunkelziffer/frozen_rails/actions)
 
 # Frozen Rails
 
-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 a lot of additional setup which was created by me.
 
-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.
+Running the full setup `bin/rails g frozen:rails` turns 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
 
-Adding to a gem:
-
-```ruby
-# my-cool-gem.gemspec
-Gem::Specification.new do |spec|
-  # ...
-  spec.add_dependency "frozen_rails"
-  # ...
-end
-```
-
-Or adding to your project:
-
-```ruby
-# Gemfile
-gem "frozen_rails"
+```bash
+bundle add frozen_rails
 ```
 
-### Supported Ruby versions
+## Prerequisites
 
-- Ruby (MRI) >= 2.7.0
-- JRuby >= 9.3.0
+- Ruby with `bundler` installed
+- nvm
 
 ## Usage
 
-The gem ships with Rails generators under the `frozen` namespace. After including `frozen_rails` in your Rails application the following generators will be available:
-
+The gem ships with Rails generators under the `frozen` namespace. You can run them with:
 ```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.
+bin/rails g frozen:GENERATOR_NAME
 ```
 
-```bash
-# ✅ passes, ✅ works correctly, ❌ has test suite
+The following generators are available:
 
-# - Adds `parklife`
-# - Adds `.gitlab-ci.yml` and tweaks parklife config.
+| Generator | Functionality |
+| --- | --- |
+| `frozen:rails` | Runs `frozen:md`, `frozen:ssg`, `frozen:db` and `frozen:ui` |
+| `frozen:md` | Sets up Markdown processing similar to `rails-static.com` |
+| `frozen:ssg` | Sets up deploying to GitHub & GitLab pages, similar to `rails-static.com` |
+| `frozen:db` | Sets up `static_db`, `avo`, `friendly_id` and fully customizes `bin/rails g scaffold` |
+| `frozen:ui` | Sets up `view_component`, `lookbook`, `esbuild`, `unpoly`, `jasmine` and fully customizes `bin/rails g component` |
 
-bin/rails g frozen:ssg
-```
+## More details
 
 ```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
+bin/rails g frozen:md
 ```
+- `decant` (picks up Markdown files and provides a nice interface)
+- `kramdown` (Markdown processing) with ERB interpolation
+- `rouge` (syntax highlighting for Markdown code blocks)
+- Routes for pages and categories.
 
-```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
+bin/rails g frozen:ssg
 ```
+- `parklife` with ActiveStorage config (crawls rack apps and emits a static site)
+- GitHub pages deployment
+- GitLab pages deployment
 
-```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
+bin/rails g frozen:db
+```
+- `static_db` (SQLite <-> YAML converter)
+- `sqlite_extensions-uuid` (SQLite UUID support to avoid YAML merge conflicts)
+- `friendly_id` (for prettier URLs)
+- `avo` (a full admin panel)
+- Adjusts `bin/rails g scaffold`
 
-# Full Rails setup (runs all frozen generators in order)
+---
 
-bin/rails g frozen:rails
-```
 
 ```bash
-# FUTURE: frozen:meetup
+bin/rails g frozen:ui
 ```
+- `esbuild` and `precompiled_assets` (Rails asset pipeline alternative)
+- `Unpoly` (Hotwire alternative)
+- `water.css` (CSS base theme)
+- `Jasmine` (JS test runner)
+- `view_component`
+- `lookbook`
+- Adjusts `bin/rails g component`
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/dunkelziffer/frozen_rails](https://github.com/dunkelziffer/frozen_rails).
 
-## Credits
-
-This gem is generated via [`newgem` template](https://github.com/palkan/newgem) by [@palkan](https://github.com/palkan).
 
 ## License
 

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+
+  RuboCop::RakeTask.new("rubocop:md") do |task|
+    task.options << %w[-c .rubocop-md.yml]
+  end
+rescue LoadError
+  task(:rubocop) { }
+  task("rubocop:md") { }
+end
+
+task default: %w[rubocop rubocop:md spec]

data/lib/frozen_rails/appendable.rb

@@ -3,8 +3,15 @@ module Appendable
 
   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
+  def append_to_application_config(content, env: nil)
+    case env
+    when nil
+      inject_into_file "config/application.rb", optimize_indentation("\n#{content}", 4), before: /  end\nend(?:\n)\z/, verbose: false
+    when "development", "production", "test"
+      inject_into_file "config/environments/#{env}.rb", optimize_indentation("\n#{content}", 2), before: /end(?:\n)\z/, verbose: false
+    else
+      raise "Unknown env: #{env}"
+    end
   end
 
   def append_to_routes(content)

data/lib/frozen_rails/copyable.rb

@@ -3,10 +3,15 @@ module Copyable
 
   private
 
-  def copy_directory(source, target, **options)
+  def copy_directory(source, target, hidden: true, **options)
     base = File.join(self.class.source_root, source)
-    Dir.glob("#{base}/**/*").each do |path|
+
+    glob_options = hidden ? [ File::FNM_DOTMATCH ] : []
+
+    Dir.glob("#{base}/**/*", *glob_options).each do |path|
       next if File.directory?(path)
+      next if hidden && (File.basename(path) == "." || File.basename(path) == "..")
+
       rel = path.delete_prefix("#{base}/")
       copy_file "#{source}/#{rel}", "#{target}/#{rel}", **options
     end

data/lib/frozen_rails/generator.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "rails/generators"
 require "frozen_rails/appendable"
 require "frozen_rails/bundleable"

data/lib/frozen_rails/taggable.rb

@@ -24,8 +24,9 @@ module Taggable
 
   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:)}"
+      space_between = env ? "\n" : "\n\n"
+      space_after = env ? "\n" : ""
+      tags = "#{frozen_start_tag(env:)}#{space_between}#{frozen_end_tag(env:)}#{space_after}"
       insert_into_file "Gemfile", tags, after: frozen_tags_after(env:)
     end
   end

data/lib/frozen_rails/version.rb

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

data/lib/frozen_rails.rb

@@ -1,3 +1 @@
-# frozen_string_literal: true
-
 require "frozen_rails/version"

data/lib/generators/frozen/db_generator.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "frozen_rails/generator"
 
 module Frozen
@@ -48,8 +46,7 @@ module Frozen
         append_to_application_config <<~RUBY
           # frozen:db
           config.generators do |g|
-            g.orm :active_record, primary_key_type: :uuid
-            g.test_framework nil
+            g.orm :active_record, primary_key_type: :string
             g.helper nil
           end
           config.active_storage.draw_routes = true
@@ -116,7 +113,7 @@ module Frozen
           end
         RUBY
 
-        run "b rubocop -a config/initializers/avo.rb"
+        run "bin/rubocop -a config/initializers/avo.rb"
       end
 
       def migrate_and_cleanup_db

data/lib/generators/frozen/md_generator.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "frozen_rails/generator"
 
 module Frozen
@@ -55,6 +53,11 @@ module Frozen
         RUBY
       end
 
+      def prepare_rouge
+        copy_directory "assets/rouge", "app/assets/rouge"
+        copy_file "assets/application.css", "app/assets/application.css", force: true
+      end
+
       def generate_rouge_css_stylesheet
         theme = options[:rouge_theme]
 
@@ -77,7 +80,7 @@ module Frozen
         theme ||= "github"
 
         say_status :info, "Generating Rouge CSS for theme #{theme}", :blue
-        run "rougify style #{theme} > app/assets/stylesheets/rouge.css"
+        run "rougify style #{theme} > app/assets/rouge/rouge.css"
       end
     end
   end

data/lib/generators/frozen/rails_generator.rb

@@ -1,36 +1,28 @@
-# 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)"
+      desc "Run all frozen setup generators (md, ssg, db, ui, seo)"
 
-      # 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:ssg"
+        invoke "frozen:ssg", [], 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
+        # say_status :info, "invoking frozen:seo"
+        # invoke "frozen:seo", [], cleanup_frozen_tags: false
 
         cleanup_all_frozen_tags!
       end

data/lib/generators/frozen/seo_generator.rb

@@ -1,17 +1,15 @@
-# frozen_string_literal: true
-
 require "frozen_rails/generator"
 
 module Frozen
   module Generators
     class SeoGenerator < FrozenRails::Generator
-      source_root File.expand_path("templates", __dir__)
+      source_root File.expand_path("templates/seo", __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"
+        template "_og_meta_tags.html.erb", "app/views/layouts/_og_meta_tags.html.erb"
       end
 
       def inject_layout_tags
@@ -96,9 +94,9 @@ module Frozen
 
       # 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"
+        template "sitemap.rb", "app/models/sitemap.rb"
+        template "sitemap_entry.rb", "app/models/sitemap/entry.rb"
+        template "robots_generatable.rb", "app/models/sitemap/robots_generatable.rb"
       end
 
       def remove_default_robots

data/lib/generators/frozen/ssg_generator.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "frozen_rails/generator"
 
 module Frozen

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

@@ -14,5 +14,18 @@ test:
   database: storage/test.sqlite3
 
 production:
-  <<: *default
-  database: storage/production.sqlite3
+  primary:
+    <<: *default
+    database: storage/production.sqlite3
+  cache:
+    <<: *default
+    database: storage/production_cache.sqlite3
+    migrations_paths: db/cache_migrate
+  queue:
+    <<: *default
+    database: storage/production_queue.sqlite3
+    migrations_paths: db/queue_migrate
+  cable:
+    <<: *default
+    database: storage/production_cable.sqlite3
+    migrations_paths: db/cable_migrate

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

@@ -0,0 +1,9 @@
+ActiveSupport.on_load(:active_record) do
+  require "rails/generators"
+  require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
+
+  Rails::Generators::ScaffoldControllerGenerator.class_eval do
+    remove_hook_for :test_framework
+    remove_hook_for :helper
+  end
+end

data/lib/generators/frozen/templates/db/lib/generators/avo/resource/resource_generator.rb

@@ -5,7 +5,7 @@ module Generators
     class ResourceGenerator
       no_tasks do
         def field_string(name, type, options)
-          return "field :slug, as: :id, format_using: -> { link_to value, main_app.polymorphic_path(record) }" if name.to_sym == :slug
+          return "field :slug, as: :id, format_using: -> { link_to value, main_app.polymorphic_path(record), \"data-turbo\": false }" if name.to_sym == :slug
           "field :#{name}, as: :#{type}#{options}"
         end
 

data/lib/generators/frozen/templates/db/lib/templates/active_record/model/model.rb.tt

@@ -2,7 +2,18 @@
 class <%= class_name %> < <%= parent_class_name.classify %>
 <% if attributes.any? { |a| a.name.to_s == "slug" } -%>
   include FriendlyId
-  friendly_id :<%= attributes.reject { |a| a.name.to_s == "slug" }.select { |a| a.type.to_s == "string" }.first.name  %>
+<% if (derived_from = attributes.reject { |a| a.name.to_s == "slug" }.select { |a| a.type.to_s == "string" }.first) -%>
+  friendly_id :<%= derived_from.name %>
+<% else -%>
+  friendly_id :slug_candidates
+
+  # TODO: implement
+  def slug_candidates
+    [
+      "TODO"
+    ]
+  end
+<% end -%>
 <% end -%>
 <% attributes.select(&:reference?).each do |attribute| -%>
   belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>

data/lib/generators/frozen/templates/db/lib/templates/erb/scaffold/index.html.erb.tt

@@ -1,14 +1,20 @@
-<p style="color: green"><%%= notice %></p>
-
 <%% content_for :title, "<%= human_name.pluralize %>" %>
 
 <h1><%= human_name.pluralize %></h1>
 
-<div id="<%= plural_table_name %>">
+<%% if Rails.env.development? %>
+  <p>
+    <%%= link_to "✏️", avo.resources_<%= index_helper(type: :path) %>, "up-follow": false %>
+  </p>
+<%% end %>
+
+<ul id="<%= plural_table_name %>">
   <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
-    <%%= render <%= singular_table_name %> %>
-    <p>
-      <%%= link_to "Show this <%= human_name.downcase %>", <%= model_resource_name(singular_table_name) %> %>
-    </p>
+    <li>
+      <%%= render <%= singular_table_name %> %>
+      <p>
+        <%%= link_to "Show this <%= human_name.downcase %>", <%= model_resource_name(singular_table_name) %> %>
+      </p>
+    </li>
   <%% end %>
-</div>
+</ul>

data/lib/generators/frozen/templates/db/lib/templates/erb/scaffold/partial.html.erb.tt

@@ -1,4 +1,4 @@
-<div id="<%%= dom_id <%= singular_name %> %>">
+<article id="<%%= dom_id <%= singular_name %> %>">
 <% attributes.reject(&:password_digest?).each do |attribute| -%>
   <p>
     <strong><%= attribute.human_name %>:</strong>
@@ -14,4 +14,4 @@
   </p>
 
 <% end -%>
-</div>
+</article>

data/lib/generators/frozen/templates/db/lib/templates/erb/scaffold/show.html.erb.tt

@@ -1,10 +1,11 @@
-<p style="color: green"><%%= notice %></p>
+<%% content_for :title, "<%= human_name %>: #{@<%= singular_table_name %>.slug}" %>
 
 <%%= render @<%= singular_table_name %> %>
 
-<div>
-  <%%= link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %> %>
-  <%% if Rails.env.development? %>
-    <%%= link_to "Edit", avo.resources_<%= show_helper(type: :path) %> %>
-  <%% end %>
-</div>
+<%% if Rails.env.development? %>
+  <p>
+    <%%= link_to "✏️", avo.resources_<%= show_helper(type: :path) %>, "up-follow": false %>
+  </p>
+<%% end %>
+
+<%%= link_to "Back to all <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %> %>

data/lib/generators/frozen/templates/md/assets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css.
+ *
+ * With Propshaft, assets are served efficiently without preprocessing steps. You can still include
+ * application-wide styles in this file, but keep in mind that CSS precedence will follow the standard
+ * cascading order, meaning styles declared later in the document or manifest will override earlier ones,
+ * depending on specificity.
+ *
+ * Consider organizing styles into separate files for maintainability.
+ *
+ *= require rouge/revert
+ *= require rouge/rouge
+ */

data/lib/generators/frozen/templates/md/assets/rouge/README.md

@@ -0,0 +1,7 @@
+# rouge syntax highlighting
+
+Put your `rouge.css` stylesheet into this directory.
+
+```bash
+rougify style THEME > app/assets/rouge/rouge.css
+```

data/lib/generators/frozen/templates/md/assets/rouge/revert.css

@@ -0,0 +1,11 @@
+/*
+  Revert all previous styles and reset to the user agent defaults.
+  The rouge "module" needs to be last in the CSS bundle or later
+  styles will mess up the syntax highlighting again.
+  This intentionally removes our base theme so the rouge styles win.
+*/
+.highlight,
+.highlight * {
+  all: revert;
+}
+/* Manually re-apply spacing rules below, if desired. */

data/lib/generators/frozen/templates/md/views/categories/index.html.erb

@@ -1,5 +1,7 @@
-<nav>
+<h1>All categories</h1>
+
+<ul>
   <% @categories.each do |category| %>
-    <%= link_to category %>
+    <li><%= link_to category %></li>
   <% end %>
-</nav>
+</ul>

data/lib/generators/frozen/templates/md/views/categories/show.html.erb

@@ -1,13 +1,9 @@
-<nav>
-  <%= link_to "Back to all categories", categories_path %>
-</nav>
+<%= link_to "Back to all categories", categories_path %>
 
-<h1><%= @category.title %></h1>
+<h1><%= @category.title %> - Articles</h1>
 
 <ul>
-<% @category.pages.each do |page| %>
-  <li>
-    <%= link_to page %>
-  </li>
-<% end %>
+  <% @category.pages.each do |page| %>
+    <li><%= link_to page %></li>
+  <% end %>
 </ul>

data/lib/generators/frozen/templates/md/views/pages/show.html.erb

@@ -1,5 +1,8 @@
-<% @page.categories.each do |category| %>
-  <%= link_to category %>
-<% end %>
+<span>
+  Categories:
+  <% @page.categories.each do |category| %>
+    <%= link_to category %>
+  <% end %>
+</span>
 
 <%= render_content_from @page %>