Merge pull request #180 from derSascha/add-rails-6-support

Add rails 6.0+6.1 and sprockets 4 support

Author: mathieujobin

.travis.yml

@@ -1,35 +1,60 @@
 language: ruby
 rvm:
-  - 2.2.9
-  - 2.3.8
-  - 2.4.9
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
   - ruby-head
-  - jruby-9.1.17.0
-  - jruby-9.2.14.0
+  - jruby-9.2.17.0
   - jruby-head
 gemfile:
-  - gemfiles/Gemfile-4-2-stable
-  - gemfiles/Gemfile-5-0-stable
-  - gemfiles/Gemfile-5-1-stable
-  - gemfiles/Gemfile-5-2-stable
+  - gemfiles/Gemfile-5-1-sprockets-3
+  - gemfiles/Gemfile-5-1-sprockets-4
+  - gemfiles/Gemfile-5-2-sprockets-3
+  - gemfiles/Gemfile-5-2-sprockets-4
+  - gemfiles/Gemfile-6-0-sprockets-3
+  - gemfiles/Gemfile-6-0-sprockets-4
+  - gemfiles/Gemfile-6-1-sprockets-3
+  - gemfiles/Gemfile-6-1-sprockets-4
 matrix:
   exclude:
-    - rvm: 2.2.9
-      gemfile: gemfiles/Gemfile-5-2-stable
-    - rvm: jruby-9.1.17.0
-      gemfile: gemfiles/Gemfile-4-2-stable
-    - rvm: jruby-9.2.14.0
-      gemfile: gemfiles/Gemfile-4-2-stable
+    - rvm: 3.0.1
+      gemfile: gemfiles/Gemfile-5-1-sprockets-4
+    - rvm: 3.0.1
+      gemfile: gemfiles/Gemfile-5-1-sprockets-3
+    - rvm: 3.0.1
+      gemfile: gemfiles/Gemfile-5-2-sprockets-4
+    - rvm: 3.0.1
+      gemfile: gemfiles/Gemfile-5-2-sprockets-3
+
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-5-1-sprockets-4
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-5-1-sprockets-3
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-5-2-sprockets-4
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-5-2-sprockets-3
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-6-0-sprockets-4
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-6-0-sprockets-3
+
+    - rvm: jruby-head
+      gemfile: gemfiles/Gemfile-5-1-sprockets-4
+    - rvm: jruby-head
+      gemfile: gemfiles/Gemfile-5-1-sprockets-3
+    - rvm: jruby-head
+      gemfile: gemfiles/Gemfile-5-2-sprockets-4
+    - rvm: jruby-head
+      gemfile: gemfiles/Gemfile-5-2-sprockets-3
+    - rvm: jruby-head
+      gemfile: gemfiles/Gemfile-6-0-sprockets-4
+    - rvm: jruby-head
+      gemfile: gemfiles/Gemfile-6-0-sprockets-3
+
   allow_failures:
-    - rvm: 2.5.8
-    - rvm: 2.6.6
-    - rvm: 2.7.2
-    - rvm: 3.0.0
     - rvm: ruby-head
-    - rvm: jruby-9.2.14.0
     - rvm: jruby-head
 notifications:
   email: false

Rakefile

@@ -27,6 +27,7 @@ namespace(:spec) do
       config.eager_load = false
       config.logger = Logger.new('/dev/null')
       config.assets.enabled = true
+      config.root = File.expand_path("../spec/fixtures", __FILE__)
     end.initialize!
 
     Rake::Task['jasmine:ci'].invoke

config.ru

@@ -14,6 +14,7 @@ class HamlCoffeeAssetsJasmineTest < Rails::Application
   config.assets.enabled = true
   config.assets.version = '1.0'
   config.secret_token = '9696be98e32a5f213730cb7ed6161c79'
+  config.root = File.expand_path("../spec/fixtures", __FILE__)
 end
 
 HamlCoffeeAssetsJasmineTest.initialize!

gemfiles/Gemfile-5-1-sprockets-3

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.1.4'
+gem 'sprockets', '~> 3.7.2'
+
+platform :ruby do
+  gem 'therubyracer'
+  gem 'redcarpet'
+end
+
+platform :jruby do
+  gem 'therubyrhino'
+  gem 'kramdown'
+end

gemfiles/Gemfile-5-1-stable renamed to gemfiles/Gemfile-5-1-sprockets-4

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec path: '..'
 
 gem 'rails', '~> 5.1.4'
+gem 'sprockets', '~> 4.0'
 
 platform :ruby do
   gem 'therubyracer'

gemfiles/Gemfile-5-2-sprockets-3

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.2.4'
+gem 'sprockets', '~> 3.7.2'
+
+platform :ruby do
+  gem 'therubyracer'
+  gem 'redcarpet'
+end
+
+platform :jruby do
+  gem 'therubyrhino'
+  gem 'kramdown'
+end

gemfiles/Gemfile-5-2-stable renamed to gemfiles/Gemfile-5-2-sprockets-4

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec path: '..'
 
 gem 'rails', '~> 5.2.4'
+gem 'sprockets', '~> 4.0'
 
 platform :ruby do
   gem 'therubyracer'

gemfiles/Gemfile-6-0-sprockets-3

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.0.0'
+gem 'sprockets', '~> 3.7.2'
+
+platform :ruby do
+  gem 'therubyracer'
+  gem 'redcarpet'
+end
+
+platform :jruby do
+  gem 'therubyrhino'
+  gem 'kramdown'
+end

gemfiles/Gemfile-4-2-stable renamed to gemfiles/Gemfile-6-0-sprockets-4

@@ -2,7 +2,8 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'rails', '~> 4.2.2'
+gem 'rails', '~> 6.0.0'
+gem 'sprockets', '~> 4.0'
 
 platform :ruby do
   gem 'therubyracer'

gemfiles/Gemfile-6-1-sprockets-3

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.1.0'
+gem 'sprockets', '~> 3.7.2'
+
+platform :ruby do
+  gem 'therubyracer'
+  gem 'redcarpet'
+end
+
+platform :jruby do
+  gem 'therubyrhino'
+  gem 'kramdown'
+end

gemfiles/Gemfile-5-0-stable renamed to gemfiles/Gemfile-6-1-sprockets-4

@@ -2,7 +2,8 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'rails', '~> 5.0.7'
+gem 'rails', '~> 6.1.0'
+gem 'sprockets', '~> 4.0'
 
 platform :ruby do
   gem 'therubyracer'

haml_coffee_assets.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.2.4'
   s.required_rubygems_version = '>= 1.3.6'
-  s.rubyforge_project         = 'haml_coffee_assets'
 
   s.files = Dir.glob('{app,lib,vendor}/**/*') + %w[LICENSE README.md]
 
@@ -33,4 +32,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'yard'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rb-readline'
+  s.add_development_dependency 'puma'
 end

lib/haml_coffee_assets/action_view/template_handler.rb

@@ -3,7 +3,7 @@ module ActionView
     class TemplateHandler
       DEPENDENCY_PATTERN = /(?:window\.)?JST(?:\[["']([\w\/]+)["']\]|\.(\w+))/
 
-      def self.call(template)
+      def self.call(template, _body = nil)
         new(template).render
       end
 
@@ -80,7 +80,8 @@ def include_dependencies(compiled)
             partial_source(path),
             path,
             self.class,
-            virtual_path: partial_path(path)
+            virtual_path: partial_path(path),
+            locals: []
           )
 
           compiled << self.class.new(

lib/haml_coffee_assets/configuration.rb

@@ -38,7 +38,7 @@ def initialize
       self.selfCloseTags          = 'meta,img,link,br,hr,input,area,param,col,base'
       self.context                = 'window.HAML.context'
       self.templates_path         = 'app/assets/javascripts/templates'
-      self.global_context_asset   = 'templates/context'
+      self.global_context_asset   = 'templates/context.js'
       self.name_filter            = lambda { |n|
         parts = n.sub(/^templates\//, '').split('/')
         parts.last.sub!(/^_/, '')

lib/haml_coffee_assets/rails/engine.rb

@@ -33,50 +33,6 @@ class Engine < ::Rails::Engine
           end
         end
 
-        if ::Rails.env == "development"
-          # Monkey patch rails so it busts the server cache for templates
-          # depending on the global_context_asset.
-          #
-          # Currently, the only way to force rails to recompile a server template is to
-          # touch it. This is problematic because when the global_context_asset
-          # changes we need to manually touch every template that uses the congtext
-          # in some way.
-          #
-          # To ease development, make rails 'touch' and recompile hamlc templates
-          # when the global context has changed.
-          #
-          # Do this ONLY in development.
-          #
-          # TODO: Don't monkey patch rails.
-          module ::ActionView
-            class Template
-              def stale?
-                return false unless ::Rails.env == "development"
-                return false unless handler.respond_to?(:stale?)
-                handler.stale?(updated_at)
-              end
-
-              alias_method :old_render, :render
-
-              # by default, rails will only compile a template once
-              # path render so it recompiles the template if 'stale'
-              def render(view, locals, buffer=nil, &block)
-                if @compiled and stale?
-                  now = Time.now
-                  File.utime(now, now, identifier) # touch file
-                  ::Rails.logger.info "Busted cache for #{identifier} by touching it"
-
-                  view = refresh(view)
-                  @source = view.source
-                  @compiled = false
-                end
-                old_render(view, locals, buffer, &block)
-              end
-
-            end
-          end
-        end
-
         config.assets.configure do |env|
           if env.respond_to?(:register_transformer)
             env.register_mime_type 'text/hamlc', extensions: ['.hamlc']

spec/fixtures/app/assets/config/manifest.js

@@ -0,0 +1,6 @@
+//
+// Manifest file required by sprockets 4
+//
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

spec/haml_coffee_assets/action_view/template_handler_spec.rb

@@ -8,12 +8,21 @@ def new_template(body)
       body,
       "template",
       described_class,
-      virtual_path: "path/to/_template"
+      virtual_path: "path/to/_template",
+      locals: []
     )
   end
 
-  let(:context) { Object.new }
-  let(:locals) { Hash.new }
+  let(:context) do
+    if ActionView.gem_version >= Gem::Version.new('6')
+      lookup_context = ActionView::LookupContext.new([])
+      assigns = {}
+      controller = nil
+      ActionView::Base.with_empty_template_cache.new(lookup_context, assigns, controller)
+    else
+      Object.new
+    end
+  end
 
   let(:global_context) do
     path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'support', 'hamlcoffee_baseline.js'))
@@ -25,17 +34,17 @@ def new_template(body)
   end
 
   it "renders basic templates" do
-    output = new_template("Foo").render(context, locals)
+    output = new_template("Foo").render(context, {})
     expect(output).to eq "Foo"
   end
 
   it "renders Haml" do
-    output = new_template("%h1 Foo").render(context, locals)
+    output = new_template("%h1 Foo").render(context, {})
     expect(output).to eq "<h1>Foo</h1>"
   end
 
   it "renders CoffeeScript" do
-    output = new_template("= @foo").render(context, foo: "Foo")
+    output = new_template("= @foo").render(context, { foo: "Foo" })
     expect(output).to eq "Foo"
   end
 
@@ -55,25 +64,25 @@ def stub_partial_source
 
     it "renders partials with bracket notation" do
       template = new_template("!= window.JST['basic/partial'](foo: 'Foo')")
-      output = template.render(context, foo: "Foo")
+      output = template.render(context, { foo: "Foo" })
       expect(output).to eq "Foo"
     end
 
     it "renders partials with dot notation" do
       template = new_template("!= window.JST.basic_partial_01(foo: 'Foo')")
-      output = template.render(context, foo: "Foo")
+      output = template.render(context, { foo: "Foo" })
       expect(output).to eq "Foo"
     end
 
     it "doesn't require JST to be called on window" do
       template = new_template("!= JST['basic/partial'](foo: 'Foo')")
-      output = template.render(context, foo: "Foo")
+      output = template.render(context, { foo: "Foo" })
       expect(output).to eq "Foo"
     end
 
     it "renders nested templates" do
       template = new_template("!= JST['nested/partial'](foo: 'Foo')")
-      output = template.render(context, foo: "Foo")
+      output = template.render(context, { foo: "Foo" })
       expect(output).to eq "Foo"
     end
 
@@ -85,7 +94,7 @@ def stub_partial_source
       compiled = described_class.new(template).send(:compilation_string)
       expect(compiled.scan(/JST\['basic\/partial'\] =/).size).to eq 1
 
-      output = template.render(context, foo: "Foo")
+      output = template.render(context, { foo: "Foo" })
       expect(output).to eq "Foo\nFoo"
     end
   end