frozen_rails 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dbddd002441102ad2a74ae55e1b633f623e83a0abb322143b456152d79de316
-  data.tar.gz: ab870d518d1c2f15eec2c9e572599e19121c1f1b9e4c7aa5fbe389d180d15d35
+  metadata.gz: 58772e38e8d884d37dadb93b5d17f1dfb1f1cdbbcfa61091bb933b5538229dd2
+  data.tar.gz: fd9c6d0fd9650da0e61b1aaf9271e49d67cb32017f3491dbe8fd5be5a41e8f73
 SHA512:
-  metadata.gz: 27f832636f1bd87883ba1dec5ede4fb76c7de52f7304cb60177d55fd293bf6e4ded40a3edeefeb4368556cf8f6a07e0118a8a88eea658747335c9f888f0bb6c9
-  data.tar.gz: bcc50684ee328cea03c251874882c1f80efe5e8b74fc377d1b8749371e6980b0bea344f22f62955b4ce0f0b55d6ec4d6a6073db3239af379705ed956a9be98c3
+  metadata.gz: e6341d4b1aa394418050513f9e91d770cebdf6943151b5f53c5a37256e55717e859f4eb5e3d674ba91a3f28811bedc5cefbea27c3fafaed1d1b01eaed4dd8e2b
+  data.tar.gz: 0b9481810c49f22d69b15aafc93f510a5d8341c25e9b9f7e11f0e6333b67868d363b453aa61b3b0b2c997c2a1f8b81c9097a63533509bd633198cf38526e386a

data/README.md

@@ -16,7 +16,7 @@ bundle add frozen_rails
 ## Prerequisites
 
 - Ruby with `bundler` installed
-- nvm
+- nvm (`node` and `yarn` must be on your `PATH`)
 
 ## Usage
 

data/lib/frozen_rails/generator.rb

@@ -2,6 +2,7 @@ require "rails/generators"
 require "frozen_rails/appendable"
 require "frozen_rails/bundleable"
 require "frozen_rails/copyable"
+require "frozen_rails/nodeable"
 require "frozen_rails/taggable"
 
 module FrozenRails
@@ -9,6 +10,7 @@ module FrozenRails
     include Appendable
     include Bundleable
     include Copyable
+    include Nodeable
     include Taggable
   end
 end

data/lib/frozen_rails/nodeable.rb

@@ -0,0 +1,41 @@
+module Nodeable
+  extend ActiveSupport::Concern
+
+  REQUIRED_EXECUTABLES = %w[ node yarn ].freeze
+
+  private
+
+  def require_js_toolchain!
+    missing = REQUIRED_EXECUTABLES.reject { |executable| available?(executable) }
+    return if missing.empty?
+
+    raise Thor::Error, <<~MSG
+      frozen_rails could not run #{missing.to_sentence}.
+
+      node and yarn are provided by nvm, which is only active in a shell that has
+      sourced it. Activate it, then run this generator again:
+
+      #{activation_hint(missing).indent(4)}
+    MSG
+  end
+
+  # `system` returns nil when the command does not exist and false when it exits non-zero
+  def available?(executable)
+    system(executable, "--version", out: File::NULL, err: File::NULL)
+  end
+
+  def activation_hint(missing)
+    commands = [ nvm_use_command ]
+    commands << "npm install -g yarn" if missing.include?("yarn")
+    commands << "bin/rails generate #{self.class.namespace}"
+    commands.join("\n")
+  end
+
+  def nvm_use_command
+    # nvm picks the version out of .nvmrc by itself
+    return "nvm use" if File.exist?(".nvmrc")
+
+    version = File.read(".node-version").strip if File.exist?(".node-version")
+    "nvm use #{version || '--lts'}"
+  end
+end

data/lib/frozen_rails/version.rb

@@ -1,3 +1,3 @@
 module FrozenRails # :nodoc:
-  VERSION = "0.0.9"
+  VERSION = "0.0.11"
 end

data/lib/generators/frozen/db_generator.rb

@@ -15,9 +15,9 @@ module Frozen
           gem "friendly_id"
         RUBY
 
-        add_frozen_gems <<~RUBY, env: "development"
+        add_frozen_gems <<~RUBY, env: "local"
           # frozen:db
-          gem "avo", ">= 3.2"
+          gem "avo", ">= 3.2", "< 4"
         RUBY
       end
 
@@ -28,7 +28,7 @@ module Frozen
       def add_routes
         append_to_routes <<~RUBY
           # frozen:db
-          if Rails.env.development?
+          if defined?(Avo)
             mount_avo at: "/avo"
           end
         RUBY
@@ -38,6 +38,7 @@ module Frozen
         copy_file "database.yml", "config/database.yml", force: true
         copy_directory "initializers", "config/initializers"
         copy_directory "lib", "lib"
+        copy_file "avo_resource_test.rb", "test/models/avo_resource_test.rb"
       end
 
       def configure_application
@@ -96,7 +97,7 @@ module Frozen
         rails_command "g avo:install"
 
         prepend_to_file "config/initializers/avo.rb", <<~RUBY + "\n"
-          if Rails.env.development?
+          if defined?(Avo)
             # Allow moving Avo controllers into `app/avo/controllers/`
             Rails.autoloaders.main.collapse(
               Rails.root.join("app/avo/controllers")

data/lib/generators/frozen/md_generator.rb

@@ -5,9 +5,6 @@ module Frozen
     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
@@ -59,28 +56,7 @@ module Frozen
       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/rouge/rouge.css"
+        run "rougify style gruvbox.dark > app/assets/rouge/rouge.css"
       end
     end
   end

data/lib/generators/frozen/rails_generator.rb

@@ -4,10 +4,17 @@ require "frozen_rails/taggable"
 module Frozen
   module Generators
     class RailsGenerator < Rails::Generators::Base
+      include Nodeable
       include Taggable
 
       desc "Run all frozen setup generators (md, ssg, db, ui, seo)"
 
+      def check_prerequisites
+        in_root do
+          require_js_toolchain!
+        end
+      end
+
       def run_all
         say_status :info, "invoking frozen:md"
         invoke "frozen:md", [], cleanup_frozen_tags: false

data/lib/generators/frozen/rouge_generator.rb

@@ -0,0 +1,39 @@
+require "frozen_rails/generator"
+
+module Frozen
+  module Generators
+    class RougeGenerator < FrozenRails::Generator
+      source_root File.expand_path("templates/rouge", __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 "Generate the chosen rouge theme in the correct location"
+
+      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/rouge/rouge.css"
+      end
+    end
+  end
+end

data/lib/generators/frozen/ssg_generator.rb

@@ -21,6 +21,12 @@ module Frozen
       def run_parklife_init
         run "bundle exec parklife init --rails --github-pages"
         append_to_file ".gitignore", "# frozen:ssg\n/build\n"
+
+        insert_into_file ".github/workflows/parklife.yml", <<YAML, before: "\n    - uses: actions/checkout@v4"
+
+    - name: Install packages
+      run: sudo apt-get update && sudo apt-get install --no-install-recommends -y libvips
+YAML
       end
 
       def setup_gitlab_pages

data/lib/generators/frozen/templates/db/avo_resource_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+
+class AvoResourcesTest < ActiveSupport::TestCase
+  test "all fields exist" do
+    Rails.application.eager_load!
+
+    Avo::BaseResource.descendants.each do |resource|
+      model = resource.model_class
+      resource_instance = resource.new(view: :index).detect_fields
+
+      resource_instance.get_field_definitions.each do |field|
+        attr = field.id
+
+        assert(model.attribute_names.include?(attr.to_s) || model.method_defined?(attr), "Invalid field #{attr} on #{resource}")
+      end
+    end
+  end
+end

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

@@ -1,3 +1,7 @@
 StaticDb.configure do |config|
-  config.fixture_path = Rails.root.join("content", "data")
+  config.static_db_path = Rails.root.join("content", "data")
+
+  # Selectively activate loading and dumping. Active by default. Set to any other value to disable.
+  config.load = ENV["STATIC_DB"].in? [ "load", nil, "on", "true", "1" ]
+  config.dump = ENV["STATIC_DB"].in? [ "dump", nil, "on", "true", "1" ]
 end

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

@@ -2,7 +2,7 @@
 
 <h1><%= human_name.pluralize %></h1>
 
-<%% if Rails.env.development? %>
+<%% if defined?(Avo) %>
   <p>
     <%%= link_to "✏️", avo.resources_<%= index_helper(type: :path) %>, "up-follow": false %>
   </p>

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

@@ -2,7 +2,7 @@
 
 <%%= render @<%= singular_table_name %> %>
 
-<%% if Rails.env.development? %>
+<%% if defined?(Avo) %>
   <p>
     <%%= link_to "✏️", avo.resources_<%= show_helper(type: :path) %>, "up-follow": false %>
   </p>

data/lib/generators/frozen/templates/ssg/.gitlab-ci.yml

@@ -12,7 +12,7 @@ build:
   stage: build
   script:
     - apt-get update -yqqq
-    - apt-get install -y nodejs
+    - apt-get install -y nodejs npm libvips
     - bundle config set path 'vendor'
     - bundle install
     - bin/static-build

data/lib/generators/frozen/templates/ui/application.html.erb

@@ -17,12 +17,8 @@
     <link rel="icon" href="/icon.png" type="image/png">
     <link rel="icon" href="/icon.svg" type="image/svg+xml">
     <link rel="apple-touch-icon" href="/icon.png">
-    <%# Use propshaft in development and precompiled_assets in production. Very brittle. %>
-    <% if Rails.env.development? %>
-      <%= stylesheet_link_tag :app %>
-    <% else %>
-      <%= stylesheet_link_tag "application" %>
-    <% end %>
+
+    <%= stylesheet_link_tag "application" %>
     <%= javascript_include_tag "application", type: "module", defer: true %>
   </head>
 

data/lib/generators/frozen/templates/ui/esbuild.config.js

@@ -24,14 +24,18 @@ async function handleErrors(errors) {
   }
 }
 
+let entryPoints
+
+if (railsEnv === 'production') {
+  entryPoints = ['application.js', 'static.js']
+} else {
+  entryPoints = ['application.js', 'static.js', 'jasmine.js']
+}
+
 const config = {
-  entryPoints: [
-    'application.js',
-    'jasmine.js',
-    'static.js'
-  ],
+  entryPoints,
   bundle: true,
-  sourcemap: true,
+  sourcemap: railsEnv !== 'production',
   format: 'esm',
   outdir,
   absWorkingDir: path.join(process.cwd(), 'app/assets'),

data/lib/generators/frozen/templates/ui/jasmine/views/layouts/jasmine.html.erb

@@ -4,14 +4,14 @@
     <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0">
     <meta http-equiv="Pragma" content="no-cache">
     <meta http-equiv="Expires" content="0">
-    <%= stylesheet_link_tag 'jasmine' %>
 
-    <!-- Referencing npm assets from HTML is currently broken. -->
-    <!-- <link href="<%#= asset_path('jasmine_favicon.png') %>" rel="icon" type="image/png"> -->
+    <link href="<%= asset_path("jasmine-core/images/jasmine_favicon.png") %>" rel="icon" type="image/png">
+
+    <%= stylesheet_link_tag "jasmine" %>
+    <%= javascript_include_tag "jasmine", defer: true %>
   </head>
 
   <body>
     <%= yield %>
-    <%= javascript_include_tag 'jasmine' %>
   </body>
 </html>

data/lib/generators/frozen/templates/ui/lib/generators/component/component_generator.rb

@@ -47,10 +47,10 @@ class ComponentGenerator < Rails::Generators::NamedBase
   end
 
   def bem_selectors
-    base = file_path.gsub("/", "---").dasherize
+    base = file_path.gsub("/", "---").dasherize.prepend(".")
     [
       base,
-      *css_attributes.map { |attr| ".#{base}--#{attr}" }
+      *css_attributes.map { |attr| "#{base}--#{attr}" }
     ]
   end
 

data/lib/generators/frozen/templates/ui/lookbook/component_preview.html.erb

@@ -4,12 +4,7 @@
     <title>Component Preview</title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
 
-    <%# Use propshaft in development and precompiled_assets in production. Very brittle. %>
-    <% if Rails.env.development? %>
-      <%= stylesheet_link_tag :app, media: 'all' %>
-    <% else %>
-      <%= stylesheet_link_tag "application", media: 'all' %>
-    <% end %>
+    <%= stylesheet_link_tag "application" %>
     <%= javascript_include_tag 'application' %>
   </head>
 

data/lib/generators/frozen/ui_generator.rb

@@ -7,6 +7,12 @@ module Frozen
 
       desc "Wire up UI helpers: classless CSS, importmap example, Hotwire Spark, Stimulus controller, and related configuration"
 
+      def check_prerequisites
+        in_root do
+          require_js_toolchain!
+        end
+      end
+
       def add_gems
         add_frozen_gems <<~RUBY
           # frozen:ui
@@ -19,7 +25,6 @@ module Frozen
         add_frozen_gems <<~RUBY, env: "development"
           # frozen:ui
           gem "listen"
-          gem "propshaft"
         RUBY
 
         add_frozen_gems <<~RUBY, env: "local"
@@ -32,28 +37,25 @@ module Frozen
         bundle!
       end
 
-      def prepare_js_environment
+      def symlink_node_version
         in_root do
-          run "mv .node-version .nvmrc"
-          run "nvm use"
-          run "nvm install"
-          run "npm install -g yarn"
+          create_link ".nvmrc", ".node-version" if File.exist?(".node-version")
         end
       end
 
       def configure_esbuild
         in_root do
-          run "yarn add --dev esbuild-plugin-import-glob esbuild-plugin-text-replace esbuild-manifest-plugin"
+          run "yarn add --dev esbuild-plugin-import-glob esbuild-plugin-text-replace esbuild-manifest-plugin", abort_on_failure: true
           copy_file "esbuild.config.js"
-          run 'npm pkg set type="module"'
-          run 'npm pkg set scripts.build="node esbuild.config.js"'
+          run 'npm pkg set type="module"', abort_on_failure: true
+          run 'npm pkg set scripts.build="node esbuild.config.js"', abort_on_failure: true
         end
       end
 
       def add_js_dependencies
         in_root do
-          run "yarn add unpoly"
-          run "yarn add --dev jasmine jasmine_dom_matchers"
+          run "yarn add unpoly", abort_on_failure: true
+          run "yarn add --dev jasmine jasmine_dom_matchers", abort_on_failure: true
         end
       end
 
@@ -80,7 +82,8 @@ module Frozen
           FileUtils.move("content/pages/rails-static", "app/assets/images/pages/rails-static")
         end
         comment_lines "config/application.rb", /config\.assets\.paths/
-        prepend_to_file "config/initializers/assets.rb", "return unless Rails.env.development?\n"
+        comment_lines "config/environments/development.rb", /config\.assets\.quiet/
+        remove_file "config/initializers/assets.rb"
 
         insert_into_file ".github/workflows/ci.yml", <<YAML1, before: "\n      - name: Run tests", force: true
 
@@ -132,8 +135,6 @@ YAML4
           config.view_component.generate.locale = true
           config.view_component.previews.default_layout = "component_preview"
           config.asset_path = "/assets"
-          # Use propshaft in development and precompiled_assets in production. Very brittle.
-          config.assets.paths << Rails.root.join("app/assets") if Rails.env.development?
         RUBY
       end
 
@@ -172,8 +173,7 @@ YAML4
 
       def copy_demo_component
         copy_directory "demo_component", "app/components"
-        empty_directory "test/components"
-        copy_directory "demo_component_test", "test/components"
+        copy_directory "demo_component_tests", "test/components"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frozen_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Klaus Weidinger
@@ -39,13 +39,16 @@ files:
 - lib/frozen_rails/bundleable.rb
 - lib/frozen_rails/copyable.rb
 - lib/frozen_rails/generator.rb
+- lib/frozen_rails/nodeable.rb
 - lib/frozen_rails/taggable.rb
 - lib/frozen_rails/version.rb
 - lib/generators/frozen/db_generator.rb
 - lib/generators/frozen/md_generator.rb
 - lib/generators/frozen/rails_generator.rb
+- lib/generators/frozen/rouge_generator.rb
 - lib/generators/frozen/seo_generator.rb
 - lib/generators/frozen/ssg_generator.rb
+- lib/generators/frozen/templates/db/avo_resource_test.rb
 - lib/generators/frozen/templates/db/database.yml
 - lib/generators/frozen/templates/db/initializers/friendly_id.rb
 - lib/generators/frozen/templates/db/initializers/skip_controller_tests_and_helpers.rb