haml-rails 2.1.0 → 3.1.0

data/lib/generators/haml/scaffold/templates/6_1/index.html.haml

@@ -0,0 +1,25 @@
+%p{id: "notice"}= notice
+
+%h1 <%= plural_table_name.titleize %>
+
+%table
+  %thead
+    %tr
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+      %th <%= attribute.human_name %>
+<% end -%>
+      %th{colspan: "3"}
+
+  %tbody
+    - @<%= plural_table_name %>.each do |<%= singular_table_name %>|
+      %tr
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+        %td= <%= singular_table_name %>.<%= attribute.column_name %>
+<% end -%>
+        %td= link_to 'Show', <%= model_resource_name %>
+        %td= link_to 'Edit', edit_<%= singular_route_name %>_path(<%= singular_table_name %>)
+        %td= link_to 'Destroy', <%= model_resource_name %>, method: :delete, data: { confirm: 'Are you sure?' }
+
+%br
+
+= link_to 'New <%= singular_table_name.titleize %>', new_<%= singular_route_name %>_path

data/lib/generators/haml/scaffold/templates/6_1/new.html.haml

@@ -0,0 +1,5 @@
+%h1 New <%= singular_table_name.titleize %>
+
+= render 'form', <%= singular_table_name %>: @<%= singular_table_name %>
+
+= link_to 'Back', <%= index_helper %>_path

data/lib/generators/haml/scaffold/templates/6_1/show.html.haml

@@ -0,0 +1,18 @@
+%p{id: "notice"}= notice
+
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+%p
+  %strong <%= attribute.human_name %>:
+<% if attribute.attachment? -%>
+  = link_to @<%= singular_table_name %>.<%= attribute.column_name %>.filename, @<%= singular_table_name %>.<%= attribute.column_name %> if @<%= singular_table_name %>.<%= attribute.column_name %>.attached?
+<% elsif attribute.attachments? -%>
+  - @<%= singular_table_name %>.<%= attribute.column_name %>.each do |<%= attribute.singular_name %>|
+    %div= link_to <%= attribute.singular_name %>.filename, <%= attribute.singular_name %>
+<% else -%>
+  = @<%= singular_table_name %>.<%= attribute.column_name %>
+<% end -%>
+
+<% end -%>
+= link_to 'Edit', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>)
+|
+= link_to 'Back', <%= index_helper %>_path

data/lib/generators/haml/scaffold/templates/7_0/_form.html.haml

@@ -0,0 +1,29 @@
+= form_with(model: <%= model_resource_name %>) do |form|
+  - if <%= singular_table_name %>.errors.any?
+    %div{style: "color: red"}
+      %h2= "#{pluralize(<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:"
+
+      %ul
+        - <%= singular_table_name %>.errors.each do |error|
+          %li= error.full_message
+
+<% attributes.each do |attribute| -%>
+  %div
+<% if attribute.password_digest? -%>
+    = form.label :password, style: "display: block"
+    = form.password_field :password
+
+  %div
+    = form.label :password_confirmation, style: "display: block"
+    = form.password_field :password_confirmation
+<% elsif attribute.attachments? -%>
+    = form.label :<%= attribute.column_name %>, style: "display: block"
+    = form.<%= attribute.field_type %> :<%= attribute.column_name %>, multiple: true
+<% else -%>
+    = form.label :<%= attribute.column_name %>, style: "display: block"
+    = form.<%= attribute.field_type %> :<%= attribute.column_name %>
+<% end -%>
+
+<% end -%>
+  %div
+    = form.submit

data/lib/generators/haml/scaffold/templates/7_0/edit.html.haml

@@ -0,0 +1,10 @@
+%h1 Editing <%= human_name.downcase %>
+
+= render "form", <%= singular_table_name %>: @<%= singular_table_name %>
+
+%br
+
+%div
+  = link_to "Show this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %>
+  |
+  = link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %>

data/lib/generators/haml/scaffold/templates/7_0/index.html.haml

@@ -0,0 +1,11 @@
+%p{style: "color: green"}= notice
+
+%h1 <%= human_name.pluralize %>
+
+%div{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) %>
+
+= link_to "New <%= human_name.downcase %>", <%= new_helper(type: :path) %>

data/lib/generators/haml/scaffold/templates/7_0/new.html.haml

@@ -0,0 +1,8 @@
+%h1 New <%= human_name.downcase %>
+
+= render "form", <%= singular_table_name %>: @<%= singular_table_name %>
+
+%br
+
+%div
+  = link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %>

data/lib/generators/haml/scaffold/templates/7_0/partial.html.haml

@@ -0,0 +1,14 @@
+%div{id: dom_id(<%= singular_name %>)}
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+  %p
+    %strong <%= attribute.human_name %>:
+<% if attribute.attachment? -%>
+    = link_to <%= singular_name %>.<%= attribute.column_name %>.filename, <%= singular_name %>.<%= attribute.column_name %> if <%= singular_name %>.<%= attribute.column_name %>.attached?
+<% elsif attribute.attachments? -%>
+    - <%= singular_name %>.<%= attribute.column_name %>.each do |<%= attribute.singular_name %>|
+      %div= link_to <%= attribute.singular_name %>.filename, <%= attribute.singular_name %>
+<% else -%>
+    = <%= singular_name %>.<%= attribute.column_name %>
+<% end -%>
+
+<% end -%>

data/lib/generators/haml/scaffold/templates/7_0/show.html.haml

@@ -0,0 +1,10 @@
+%p{style: "color: green"}= notice
+
+= render @<%= singular_table_name %>
+
+%div
+  = link_to "Edit this <%= human_name.downcase %>", <%= edit_helper(type: :path) %>
+  |
+  = link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %>
+
+  = button_to "Destroy this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %>, method: :delete

data/lib/generators/haml/scaffold/templates/7_1

@@ -0,0 +1 @@
+7_0

data/lib/generators/haml/scaffold/templates/7_2/_form.html.haml

@@ -0,0 +1,29 @@
+= form_with(model: <%= model_resource_name %>) do |form|
+  - if <%= singular_table_name %>.errors.any?
+    %div{style: "color: red"}
+      %h2= "#{pluralize(<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:"
+
+      %ul
+        - <%= singular_table_name %>.errors.each do |error|
+          %li= error.full_message
+
+<% attributes.each do |attribute| -%>
+  %div
+<% if attribute.password_digest? -%>
+    = form.label :password, style: "display: block"
+    = form.password_field :password
+
+  %div
+    = form.label :password_confirmation, style: "display: block"
+    = form.password_field :password_confirmation
+<% elsif attribute.attachments? -%>
+    = form.label :<%= attribute.column_name %>, style: "display: block"
+    = form.<%= attribute.field_type %> :<%= attribute.column_name %>, multiple: true
+<% else -%>
+    = form.label :<%= attribute.column_name %>, style: "display: block"
+    = form.<%= attribute.field_type %> :<%= attribute.column_name %>
+<% end -%>
+
+<% end -%>
+  %div
+    = form.submit

data/lib/generators/haml/scaffold/templates/7_2/edit.html.haml

@@ -0,0 +1,12 @@
+- content_for :title, "Editing <%= human_name.downcase %>"
+
+%h1 Editing <%= human_name.downcase %>
+
+= render "form", <%= singular_table_name %>: @<%= singular_table_name %>
+
+%br
+
+%div
+  = link_to "Show this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %>
+  |
+  = link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %>

data/lib/generators/haml/scaffold/templates/7_2/index.html.haml

@@ -0,0 +1,13 @@
+%p{style: "color: green"}= notice
+
+- content_for :title, "<%= human_name.pluralize %>"
+
+%h1 <%= human_name.pluralize %>
+
+%div{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) %>
+
+= link_to "New <%= human_name.downcase %>", <%= new_helper(type: :path) %>

data/lib/generators/haml/scaffold/templates/7_2/new.html.haml

@@ -0,0 +1,10 @@
+- content_for :title, "New <%= human_name.downcase %>"
+
+%h1 New <%= human_name.downcase %>
+
+= render "form", <%= singular_table_name %>: @<%= singular_table_name %>
+
+%br
+
+%div
+  = link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %>

data/lib/generators/haml/scaffold/templates/7_2/partial.html.haml

@@ -0,0 +1,14 @@
+%div{id: dom_id(<%= singular_name %>)}
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+  %p
+    %strong <%= attribute.human_name %>:
+<% if attribute.attachment? -%>
+    = link_to <%= singular_name %>.<%= attribute.column_name %>.filename, <%= singular_name %>.<%= attribute.column_name %> if <%= singular_name %>.<%= attribute.column_name %>.attached?
+<% elsif attribute.attachments? -%>
+    - <%= singular_name %>.<%= attribute.column_name %>.each do |<%= attribute.singular_name %>|
+      %div= link_to <%= attribute.singular_name %>.filename, <%= attribute.singular_name %>
+<% else -%>
+    = <%= singular_name %>.<%= attribute.column_name %>
+<% end -%>
+
+<% end -%>

data/lib/generators/haml/scaffold/templates/7_2/show.html.haml

@@ -0,0 +1,10 @@
+%p{style: "color: green"}= notice
+
+= render @<%= singular_table_name %>
+
+%div
+  = link_to "Edit this <%= human_name.downcase %>", <%= edit_helper(type: :path) %>
+  |
+  = link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper(type: :path) %>
+
+  = button_to "Destroy this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %>, method: :delete

data/lib/generators/haml/scaffold/templates/8_0

@@ -0,0 +1 @@
+7_2

data/lib/generators/haml/scaffold/templates/8_1/_form.html.haml

@@ -0,0 +1 @@
+../7_2/_form.html.haml

data/lib/generators/haml/scaffold/templates/8_1/edit.html.haml

@@ -0,0 +1 @@
+../7_2/edit.html.haml

data/lib/generators/haml/scaffold/templates/8_1/index.html.haml

@@ -0,0 +1 @@
+../7_2/index.html.haml

data/lib/generators/haml/scaffold/templates/8_1/new.html.haml

@@ -0,0 +1 @@
+../7_2/new.html.haml

data/lib/generators/haml/scaffold/templates/8_1/partial.html.haml

@@ -0,0 +1,14 @@
+%div{id: dom_id(<%= singular_name %>)}
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+  %div
+    %strong <%= attribute.human_name %>:
+<% if attribute.attachment? -%>
+    = link_to <%= singular_name %>.<%= attribute.column_name %>.filename, <%= singular_name %>.<%= attribute.column_name %> if <%= singular_name %>.<%= attribute.column_name %>.attached?
+<% elsif attribute.attachments? -%>
+    - <%= singular_name %>.<%= attribute.column_name %>.each do |<%= attribute.singular_name %>|
+      %div= link_to <%= attribute.singular_name %>.filename, <%= attribute.singular_name %>
+<% else -%>
+    = <%= singular_name %>.<%= attribute.column_name %>
+<% end -%>
+
+<% end -%>

data/lib/generators/haml/scaffold/templates/8_1/show.html.haml

@@ -0,0 +1 @@
+../7_2/show.html.haml

data/lib/generators/haml/scaffold/templates/_form.html.haml

@@ -0,0 +1 @@
+8_1/_form.html.haml

data/lib/generators/haml/scaffold/templates/edit.html.haml

@@ -0,0 +1 @@
+8_1/edit.html.haml

data/lib/generators/haml/scaffold/templates/index.html.haml

@@ -0,0 +1 @@
+8_1/index.html.haml

data/lib/generators/haml/scaffold/templates/new.html.haml

@@ -0,0 +1 @@
+8_1/new.html.haml

data/lib/generators/haml/scaffold/templates/partial.html.haml

@@ -0,0 +1 @@
+8_1/partial.html.haml

data/lib/generators/haml/scaffold/templates/show.html.haml

@@ -0,0 +1 @@
+8_1/show.html.haml

data/lib/haml-rails/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Haml
   module Rails
-    VERSION = "2.1.0"
+    VERSION = '3.1.0'
   end
 end

data/lib/haml-rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'haml'
 require 'rails'
 require 'haml/railtie'
@@ -29,7 +31,16 @@ module Haml
               else
                 # will only apply if Rails 4, which includes 'action_view/dependency_tracker'
                 require 'action_view/dependency_tracker'
-                ActionView::DependencyTracker.register_tracker :haml, ActionView::DependencyTracker::ERBTracker
+                # RubyTracker (available since Rails 7.2) compiles the template
+                # to Ruby via its handler and parses that, so it detects render
+                # calls in Haml. Rails 8.1's ERBTracker only scans ERB `<% %>`
+                # tags and no longer sees Haml's `= render`.
+                tracker = if defined?(ActionView::DependencyTracker::RubyTracker)
+                            ActionView::DependencyTracker::RubyTracker
+                          else
+                            ActionView::DependencyTracker::ERBTracker
+                          end
+                ActionView::DependencyTracker.register_tracker :haml, tracker
                 ActionView::Base.cache_template_loading = false if ::Rails.env.development?
               end
             rescue

data/lib/rails/generators/haml/application_layout/application_layout_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'shellwords'
 
@@ -15,11 +17,14 @@ module Haml
         app_layout_to   = ::Rails.root.join(HAML_LAYOUT_PATH).to_s
 
         if File.exist?(app_layout_from)
-
           if !File.exist?(app_layout_to)
             `html2haml #{app_layout_from.shellescape} #{app_layout_to.shellescape}`
-            puts "Success! app/views/layouts/application.html.haml is created.\n" \
-                 "Please remove the erb file: app/views/layouts/application.html.erb"
+            if $?.success?
+              puts "Success! app/views/layouts/application.html.haml is created.\n" \
+                   "Please remove the erb file: app/views/layouts/application.html.erb"
+            else
+              puts "Error! Failed to execute html2haml command."
+            end
           else
             puts "Error! There is a file named app/views/layouts/application.html.haml already."
           end

data/test/fixtures/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 TestApp.routes.draw do |map|
   # The priority is based upon order of creation:
   # first created -> highest priority.

data/test/lib/generators/haml/controller_generator_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'rails/generators/rails/controller/controller_generator'
 require 'generators/haml/controller/controller_generator'

data/test/lib/generators/haml/mailer_generator_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'rails/generators/mailer/mailer_generator'
 require 'generators/haml/mailer/mailer_generator'

data/test/lib/generators/haml/scaffold_generator_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'rails/generators/rails/scaffold/scaffold_generator'
 require 'generators/haml/scaffold/scaffold_generator'

data/test/lib/generators/haml/scaffold_template_contents_test.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'rails/generators/rails/scaffold/scaffold_generator'
+require 'generators/haml/scaffold/scaffold_generator'
+require 'action_controller/test_case'
+
+class Haml::Generators::ScaffoldTemplateContentsTest < Rails::Generators::TestCase
+  destination File.join(Rails.root)
+  tests Rails::Generators::ScaffoldGenerator
+  arguments %w(person name)
+
+  setup :prepare_destination
+  setup :copy_routes
+
+  def view_context
+    @view_context ||= begin
+      require Rails.root.join('app/controllers/people_controller')
+
+      controller = PeopleController.new
+      controller.set_request!(ActionDispatch::Request.empty)
+      controller.request.session = ActionController::TestSession.new
+
+      if controller.lookup_context.respond_to? :append_view_paths
+        controller.lookup_context.append_view_paths([Rails.root.join('app/views')])
+      else
+        controller.lookup_context.view_paths << Rails.root.join('app/views')
+      end
+      controller.instance_variable_set :@people, []
+      controller.instance_variable_set :@person, Person.new(1, 'Person 1')
+
+      controller.view_context
+    end
+  end
+
+  def assert_html_content_with_erb_version(view, html)
+    view_context.lookup_context.handlers = [:erb]
+    erb_html = view_context.render(template: "people/#{view}")
+
+    assert_equal scrub(erb_html), scrub(html), "#{view} template result differs from the ERB version"
+  end
+
+  def scrub(html)
+    html = strip_whitespace html
+    strip_authenticity_token! html
+    html
+  end
+
+  def strip_whitespace(html)
+    html_doc = Nokogiri::HTML(html)
+    html_doc.xpath('//text()').each do |text_node|
+      text_node.remove if text_node.text.strip.empty?
+      text_node.content = text_node.text.strip
+    end
+    html_doc.to_html
+  end
+
+  def strip_authenticity_token!(html)
+    html.sub!(/(<input type="hidden" name="authenticity_token" value=").*?"/, '\1"')
+    html.sub!(/(<input autocomplete="off" name="authenticity_token" type="hidden" value=").*?"/, '\1"')
+  end
+
+  test 'should generate a set of templates that are 100% compatible with the original ERB templates' do
+    run_generator
+    run_generator default_arguments + %w(--template-engine haml)
+
+    %w(index edit new show).each do |view|
+      assert_file "app/views/people/#{view}.html.haml"
+
+      view_context.lookup_context.handlers = [:haml]
+      haml_html = view_context.render(template: "people/#{view}")
+
+      assert_html_content_with_erb_version view, haml_html
+    end
+  end
+end

data/test/lib/haml-rails/dependency_tracker_test.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'action_view/dependency_tracker'
+
+# Touch ActionView::Base so haml-rails' `on_load(:action_view)` hook fires and
+# registers the :haml tracker. In a real app this happens the first time a view
+# renders; a bare tracker test never renders one, so we force the load here.
+ActionView::Base
+
+# Regression test for cache dependency detection on Haml templates.
+#
+# Rails 8.1 tightened ERBTracker to only match render calls inside ERB
+# `<% %>` tags, which stopped it from seeing Haml's `= render` and silently
+# broke fragment cache busting. haml-rails now registers RubyTracker (which
+# compiles the template to Ruby before scanning) where it is available.
+#
+# This test asserts the behavior that actually matters: given a Haml template
+# that renders partials, the registered tracker reports those partials as
+# dependencies.
+class DependencyTrackerTest < Minitest::Test
+  # Minimal stand-in for an ActionView::Template that exposes just what the
+  # dependency trackers touch: the Haml handler and the source.
+  class FakeTemplate
+    attr_reader :source, :handler
+
+    def initialize(source)
+      @source = source
+      @handler = ActionView::Template.handler_for_extension(:haml)
+    end
+
+    def identifier
+      'fake/template'
+    end
+
+    def type
+      'text/html'
+    end
+
+    def format
+      :html
+    end
+  end
+
+  def find_dependencies(source)
+    ActionView::DependencyTracker.find_dependencies('things/index', FakeTemplate.new(source), nil)
+  end
+
+  def test_detects_a_rendered_partial
+    assert_includes find_dependencies(%(= render "shared/menu")), 'shared/menu'
+  end
+
+  def test_detects_a_partial_rendered_with_explicit_option
+    assert_includes find_dependencies(%(= render partial: "posts/post")), 'posts/post'
+  end
+
+  def test_detects_an_explicit_dependency_comment
+    assert_includes find_dependencies(%(-# Template Dependency: shared/menu)), 'shared/menu'
+  end
+end

data/test/test_helper.rb

@@ -1,26 +1,32 @@
+# frozen_string_literal: true
+
 require 'rubygems'
+require 'bundler/setup'
+require 'logger'
 require 'minitest/autorun'
 require 'action_pack'
 require 'action_controller'
 require 'action_view'
+require 'active_model'
 require 'rails'
 require 'rails/generators'
 require 'rails/generators/test_case'
 Bundler.require(:default)
 
 class TestApp < Rails::Application
-  config.root = File.dirname(__FILE__)
+  config.root = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'rails')))
   config.eager_load = false
 end
 
-module Rails
-  def self.root
-    @root ||= Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'rails')))
-  end
-end
+require 'action_controller/railtie'
+require 'action_view/railtie'
 
 TestApp.initialize!
 
+Rails.application.routes.draw do
+  resources :people
+end
+
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 module Haml
@@ -40,8 +46,25 @@ end
 
 ::Rails::Generators::TestCase.include Haml::Rails::GeneratorTestHelpers
 
+class Person
+  include ActiveModel::Model
+
+  attr_accessor :id, :name
+
+  def initialize(id, name)
+    @id, @name = id, name
+  end
+
+  def to_param
+    {id: @id}
+  end
+end
+
+class ApplicationController < ActionController::Base
+end
+
 # Remove tmp directory when test suite is completed
-MiniTest.after_run do
+Minitest.after_run do
   tmp_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp'))
   FileUtils.rm_r(tmp_dir)
 end