haml-rails 0.1 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c92791c4d02db70961e18508ae709bd86a9bae7325eb8afd6f7c8286c3d7824f
+  data.tar.gz: 0a4ad454a0c72f707159ee95c4a529cdf3c4194a64b13a690b475a1ff72687c1
+SHA512:
+  metadata.gz: e3232df46c3893fab9e0cec861ddb8d88bfd9fe3c40bc0e05a4c67915ef58bd4f54ff9e39a4cc040853cd42fe421942629a46f31294b1622098047e42d5a89a2
+  data.tar.gz: d25c5e7ff3ef9fb3e0879129ffe8689c9e06d2b945b404d2be3775573142645304189440deb9ca755b1d5684df1775ea707acd046d6c31f77abdb750bcd98677

data/.github/workflows/ruby.yml

@@ -0,0 +1,64 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - 3.1
+          - 3.0
+          - 2.7
+          - jruby
+        gemfile:
+          - rails_7_0
+          - rails_6_1
+          - rails_6_0
+
+        include:
+          - ruby-version: 2.7
+            gemfile: rails_5_2
+          - ruby-version: 2.7
+            gemfile: rails_5_1
+
+          - ruby-version: 2.6
+            gemfile: rails_6_1
+          - ruby-version: 2.6
+            gemfile: rails_6_0
+          - ruby-version: 2.6
+            gemfile: rails_5_2
+          - ruby-version: 2.6
+            gemfile: rails_5_1
+
+        exclude:
+          - ruby-version: jruby
+            gemfile: rails_7_0
+
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle/
+*.lock
+gemfiles/*.lock
+tmp/
+/vendor/bundle
+log

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "rails_5_1" do
+  gem "rails", "~> 5.1.0"
+end
+
+appraise "rails_5_2" do
+  gem "rails", "~> 5.2.0"
+end
+
+appraise "rails_6_0" do
+  gem "rails", "~> 6.0.0"
+end
+
+appraise "rails_6_1" do
+  gem "rails", "~> 6.1.0"
+end
+
+appraise "rails_7_0" do
+  gem "rails", "~> 7.0.0"
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in haml-rails.gemspec
+gemspec
+
+gem 'html2haml'

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010-2015 André Arko
+
+MIT Licence
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,3 +1,66 @@
 # Haml-rails
+[![Build Status](https://travis-ci.org/haml/haml-rails.svg)](https://travis-ci.org/haml/haml-rails)
 
-Haml-rails provides Haml generators for Rails 3. It also enables Haml as the templating engine for you, so you don't have to screw around in your own application.rb when your Gemfile already clearly indicated what templating engine you have installed. Hurrah.
+Haml-rails provides Haml generators for Rails 5. It also enables Haml as the templating engine for you, so you don't have to screw around in your own application.rb when your Gemfile already clearly indicated what templating engine you have installed. Hurrah.
+
+To use it, add this line to your Gemfile:
+
+    gem "haml-rails", "~> 2.0"
+
+This ensures that:
+
+  * Any time you generate a resource, view, or mailer, you'll get Haml templates (instead of ERB)
+  * When your Rails application loads, Haml will be loaded and initialized automatically
+  * Haml templates will be respected by the view template cache digestor
+
+Pretty fancy, eh? The modern world is just so amazing.
+
+### Converting Rails application layout file to haml format
+
+Once Haml-rails is installed on the Rails application,
+you can convert the erb layout file, `app/views/layouts/application.html.erb`
+to `app/views/layouts/application.html.haml` using this command:
+
+    $ rails generate haml:application_layout convert
+
+After the application layout file is converted successfully,
+make sure to delete `app/views/layouts/application.html.erb`, so Rails can
+start using `app/views/layouts/application.html.haml` instead.
+
+### Converting all .erb views to haml format
+
+If you want to convert all of your .erb views into .haml, you can do so using the following command:
+
+    $ rails haml:erb2haml
+
+If you already have .haml files for one or more of the .erb files, the rake task will give you the option of either
+replacing these .haml files or leaving them in place.
+
+Once the task is complete, you will have the option of deleting the original .erb files. Unless you are under
+version control, it is recommended that you decline this option.  If you are running in a script, you can use
+an environment variable to answer this question.
+
+    $ HAML_RAILS_DELETE_ERB=true rails haml:erb2haml
+
+Running the above will not prompt for the question and will delete the original .erb files.  Setting this value to
+false will also not prompt, however, will leave the .erb files intact.
+
+### Older versions of Rails
+
+The current version of Haml-rails requires Rails 5.1 or later.
+
+Haml-rails version 1.0.0 is the last version to support Rails 4. To use it, add this line to your Gemfile:
+
+    gem "haml-rails", "~> 1.0.0"
+
+For Rails 3, use haml-rails version 0.4 by adding this line to your Gemfile instead:
+
+    gem "haml-rails", "~> 0.4.0"
+
+### Contributors
+
+Haml generators originally from [rails3-generators](http://github.com/indirect/rails3-generators), and written by José Valim, André Arko, Paul Barry, Anuj Dutta, Louis T, and Chris Rhoden. Tests originally written by Louis T.
+
+### License
+
+Ruby license or MIT license, take your pick.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "html2haml"
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "html2haml"
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "html2haml"
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "html2haml"
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "html2haml"
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/haml-rails.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/haml-rails/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "haml-rails"
+  s.version     = Haml::Rails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["André Arko"]
+  s.email       = ["andre@arko.net"]
+  s.homepage    = "https://github.com/haml/haml-rails"
+  s.summary     = "let your Gemfile do the configuring"
+  s.description = "Haml-rails provides Haml generators for Rails 5. It also enables Haml as the templating engine for you, so you don't have to screw around in your own application.rb when your Gemfile already clearly indicated what templating engine you have installed. Hurrah."
+  s.licenses    = ["MIT"]
+
+  s.required_rubygems_version = ">= 2.0.0"
+  s.required_ruby_version     = ">= 2.3.0"
+
+  s.add_dependency "haml",          [">= 4.0.6"]
+  s.add_dependency "activesupport", [">= 5.1"]
+  s.add_dependency "actionpack",    [">= 5.1"]
+  s.add_dependency "railties",      [">= 5.1"]
+  
+  s.add_development_dependency "html2haml", [">= 1.0.1"]
+  s.add_development_dependency "rails",   [">= 5.1"]
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency 'appraisal'
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.require_path = 'lib'
+end

data/lib/generators/haml/controller/controller_generator.rb

@@ -1,16 +1,15 @@
-require 'generators/haml'
 require 'rails/generators/erb/controller/controller_generator'
 
 module Haml
   module Generators
     class ControllerGenerator < Erb::Generators::ControllerGenerator
-      extend TemplatePath
+      source_root File.expand_path("../templates", __FILE__)
 
-      protected
+      private
 
-        def handler
-          :haml
-        end
+      def handler
+        :haml
+      end
     end
   end
 end

data/lib/generators/haml/controller/templates/view.html.haml

@@ -1,2 +1,2 @@
 %h1 <%= class_name %>#<%= @action %>
-%p Find me in <%= @path %>
+%p Find me in <%= @path %>

data/lib/generators/haml/mailer/mailer_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/erb/mailer/mailer_generator'
+
+module Haml
+  module Generators
+    class MailerGenerator < Erb::Generators::MailerGenerator
+      source_root File.expand_path("../templates", __FILE__)
+
+      private
+
+      def handler
+        :haml
+      end
+    end
+  end
+end

data/lib/generators/haml/mailer/templates/layout.html.haml

@@ -0,0 +1,8 @@
+!!!
+%html
+  %head
+    %meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}/
+    :css
+      /* Email styles need to be inline */
+  %body
+    = yield

data/lib/generators/haml/mailer/templates/layout.text.haml

@@ -0,0 +1 @@
+= yield

data/lib/generators/haml/mailer/templates/view.html.haml

@@ -0,0 +1,4 @@
+%h1= class_name + "#" + @action
+
+%p
+  = @greeting + ", find me in <%= @path %>"

data/lib/generators/haml/mailer/templates/view.text.haml

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= @action %>
+
+= @greeting + ", find me in <%= @path %>"

data/lib/generators/haml/scaffold/scaffold_generator.rb

@@ -1,18 +1,14 @@
-require 'generators/haml'
 require 'rails/generators/erb/scaffold/scaffold_generator'
 
 module Haml
   module Generators
     class ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
-      extend TemplatePath
+      source_root File.expand_path("../templates", __FILE__)
 
       def copy_view_files
-        views = available_views
-        views.delete("index") if options[:singleton]
-
-        views.each do |view|
+        available_views.each do |view|
           filename = filename_with_extensions(view)
-          template template_filename_with_extensions(view), File.join("app/views", controller_file_path, filename)
+          template "#{view}.html.haml", File.join("app/views", controller_file_path, filename)
         end
       end
 
@@ -21,23 +17,19 @@ module Haml
       def copy_form_file
         if options[:form_builder].nil?
           filename = filename_with_extensions("_form")
-          template template_filename_with_extensions("_form"), File.join("app/views", controller_file_path, filename)
+          template "_form.html.haml", File.join("app/views", controller_file_path, filename)
         end
       end
 
-      protected
-
-        def available_views
-          %w(index edit show new)
-        end
+      private
 
-        def handler
-          :haml
-        end
+      def available_views
+        %w(index edit show new)
+      end
 
-        def template_filename_with_extensions(name)
-          [name, format, handler, :erb].compact.join(".")
-        end
+      def handler
+        :haml
+      end
     end
   end
 end

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

@@ -0,0 +1,15 @@
+= form_for @<%= singular_table_name %> do |f|
+  - if @<%= singular_table_name %>.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:"
+      %ul
+        - @<%= singular_table_name %>.errors.full_messages.each do |message|
+          %li= message
+
+<% for attribute in attributes -%>
+  .field
+    = f.label :<%= attribute.name %>
+    = f.<%= attribute.field_type %> :<%= attribute.name %>
+<% end -%>
+  .actions
+    = f.submit 'Save'

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

@@ -0,0 +1,7 @@
+%h1 Editing <%= singular_table_name %>
+
+= render 'form'
+
+= link_to 'Show', @<%= singular_table_name %>
+\|
+= link_to 'Back', <%= index_helper %>_path

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

@@ -0,0 +1,25 @@
+%h1 Listing <%= plural_table_name %>
+
+%table
+  %thead
+    %tr
+<% for attribute in attributes -%>
+      %th <%= attribute.human_name %>
+<% end -%>
+      %th
+      %th
+      %th
+
+  %tbody
+    - @<%= plural_table_name %>.each do |<%= singular_table_name %>|
+      %tr
+<% for attribute in attributes -%>
+        %td= <%= singular_table_name %>.<%= attribute.name %>
+<% end -%>
+        %td= link_to 'Show', <%= singular_table_name %>
+        %td= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>)
+        %td= link_to 'Destroy', <%= singular_table_name %>, method: :delete, data: { confirm: 'Are you sure?' }
+
+%br
+
+= link_to 'New <%= human_name %>', new_<%= singular_table_name %>_path

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

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

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

@@ -0,0 +1,11 @@
+%p#notice= notice
+
+<% for attribute in attributes -%>
+%p
+  %b <%= attribute.human_name %>:
+  = @<%= singular_table_name %>.<%= attribute.name %>
+<% end -%>
+
+= link_to 'Edit', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>)
+\|
+= link_to 'Back', <%= index_helper %>_path

data/lib/haml-rails/version.rb

@@ -0,0 +1,5 @@
+module Haml
+  module Rails
+    VERSION = "2.1.0"
+  end
+end

data/lib/haml-rails.rb

@@ -1,7 +1,64 @@
+require 'haml'
+require 'rails'
+require 'haml/railtie'
+
 module Haml
   module Rails
     class Railtie < ::Rails::Railtie
-      config.generators.template_engine :haml
+      config.app_generators.template_engine :haml
+
+      config.before_initialize do
+        Haml::Template.options[:format] = :html5
+      end
+
+      initializer 'haml_rails.configure_template_digestor' do
+        # Configure cache digests to parse haml view templates
+        # when calculating cache keys for view fragments
+
+        ActiveSupport.on_load(:action_view) do
+          ActiveSupport.on_load(:after_initialize) do
+            begin
+              if defined?(CacheDigests::DependencyTracker)
+                # 'cache_digests' gem being used (overrides Rails 4 implementation)
+                CacheDigests::DependencyTracker.register_tracker :haml, CacheDigests::DependencyTracker::ERBTracker
+
+                if ::Rails.env.development?
+                  # recalculate cache digest keys for each request
+                  CacheDigests::TemplateDigestor.cache = ActiveSupport::Cache::NullStore.new
+                end
+              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
+                ActionView::Base.cache_template_loading = false if ::Rails.env.development?
+              end
+            rescue
+              # likely this version of Rails doesn't support dependency tracking
+              # so, we can't parse haml templates without 'cache_digests' gem anyway :)
+            end
+          end
+        end
+      end
+
+      # Configure source annotation on haml files (support for HAML was
+      # provided directly by railties 3.2..4.1 but was dropped in 4.2.
+      if Gem::Requirement.new(">= 4.2").satisfied_by?(Gem::Version.new(::Rails.version))
+        initializer 'haml_rails.configure_source_annotation' do
+          annotation_class = if ::Rails::VERSION::STRING >= '6.0'
+            require 'rails/source_annotation_extractor'
+            ::Rails::SourceAnnotationExtractor::Annotation
+          else
+            ::SourceAnnotationExtractor::Annotation
+          end
+          annotation_class.register_extensions('haml') do |tag|
+            /\s*-#\s*(#{tag}):?\s*(.*)/
+          end
+        end
+      end
+
+      rake_tasks do
+        load 'tasks/erb2haml.rake'
+      end
     end
   end
 end

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

@@ -0,0 +1,32 @@
+require 'rails'
+require 'shellwords'
+
+module Haml
+  module Generators
+    class ApplicationLayoutGenerator < ::Rails::Generators::Base
+      HTML_LAYOUT_PATH = 'app/views/layouts/application.html.erb'
+      HAML_LAYOUT_PATH = 'app/views/layouts/application.html.haml'
+
+      # Converts existing application.html.erb to haml format,
+      # and creates app/views/layouts/application.html.haml
+      # with some error checking.
+      def convert
+        app_layout_from = ::Rails.root.join(HTML_LAYOUT_PATH).to_s
+        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"
+          else
+            puts "Error! There is a file named app/views/layouts/application.html.haml already."
+          end
+        else
+          puts "Error! There is no file named app/views/layouts/application.html.erb."
+        end
+      end
+    end
+  end
+end