Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Fixed assets precompile regex #2876

Merged
merged 1 commit into from

5 participants

@ay
ay commented

The original regex was matching things like jquery.min.js and putting a lot of junk (like jquery-#{digest}.min.js) in public/assets/ that shouldn't be there. The new regex matches everything except files ending with .js or .css (as was intended).

@guilleiguaran

@alex3 can you provide a test case for this?

@spastorino
Owner

/cc @josh

@rhulse

This pull request is related to bug #1913

The orignal regex appears to want to include files that are not .js or .css files, but as you say is too broad.

@ay
ay commented

@guilleiguaran I just wrote and pushed a test case for this. The commits are squashed into one.

@rhulse

Can I suggest that you add sanity tests for images and the other file types (including with multiple dots) that this is supposed to capture?

@ay
ay commented

@rhulse I think the other tests test for images. Maybe an image named something like happy.face.png?

Also, should I push a new commit or squash it into one again?

@rhulse

I would expect so.

I suggested the extra tests because I spent some time (unsuccessfully) trying to fix that regex! I wonder if it's worth covering off underscores and dashes too. If this breaks there will be a lot of head-scratching and gnashing of teeth. :-)

@spastorino
Owner

@alex3 +1 to rhulse suggestion, please add those tests and I will merge the pull request

@rhulse

suggestions:

  • happy-face.png
  • happy_face.png
  • happy.happy_face.png
  • happy_happy.face.png
  • happy.happy.face.png

And NOT match:

  • .happy.face
  • .anything-with-a-dot-start

:-) !

@ay
ay commented

@rhulse @spastorino All that in one test or a couple of them?

@spastorino
Owner

@alex3 as you find it better, perhaps you can iterate over a bunch of valid / invalid file names checking if they have been precompiled or not

@rhulse

Would it be a appropriate to extract the creation of this array into its own method, which can then include more comprehensive documentation on the intent? It may avoid future issues if there is refactoring.

@ay
ay commented

@spastorino I just pushed a new (squashed) commit with the updated regex and a pretty comprehensive test. I've included all of @rhulse's suggestions in the test.

@rhulse That would probably be better but I think that should be a separate pull request.

railties/lib/rails/application/configuration.rb
@@ -37,7 +37,7 @@ module Rails
@assets = ActiveSupport::OrderedOptions.new
@assets.enabled = false
@assets.paths = []
- @assets.precompile = [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ]
+ @assets.precompile = [ /^[^.].*(\.(?!js$|css$)[^.]+)+\.*$|^[^.](?:(?!\.).)*\.*$/, /application.(css|js)$/ ]
@josh Collaborator
josh added a note

Gnarly!

Good luck maintaing that regexp, rails core :)

@spastorino Owner

lol, good luck to you too since you're part of the core :P

@rhulse
rhulse added a note

Yeah, use a regex and now you have two problems. ;-)

@ay
ay added a note

Perhaps I should split that regexp into two, and put each regexp on its own line with a comment explaining what it does?

@rhulse
rhulse added a note

I think putting this in a method on its own would 'minimize' the issue. If maintenance is a concern it could be more verbose in compiling the array.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@josh
Collaborator

Protip: This logic is now apart of rails itself. You can hack it.

https://github.com/rails/rails/blob/master/actionpack/lib/sprockets/assets.rake#L27-31

Maybe allow precompile to accept a Proc or something so you can do File.extname(path) != '.js'.

@ay
ay commented

@josh See most recent commits.

@ay
ay commented

@guilleiguaran Thanks, just pushed a new commit with your suggestion.

railties/lib/rails/application/configuration.rb
@@ -37,7 +37,8 @@ module Rails
@assets = ActiveSupport::OrderedOptions.new
@assets.enabled = false
@assets.paths = []
- @assets.precompile = [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ]
+ @assets.precompile = [ Proc.new{ |path| !File.extname(path).in?(['.js', '.css']) && path[0] != '.' },
@josh Collaborator
josh added a note

Curious why != '.' is needed?

@ay
ay added a note

To ignore dot files like .gitkeep or something

@josh Collaborator
josh added a note

Dot files should already be ignored by sprockets.

@ay
ay added a note

Oh, didn't know that... should I remove the path[0] != '.'?

@guilleiguaran Owner

Yes, please :)

@ay
ay added a note

All right, I'll have to change the test too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@ay
ay commented

Let me know if this is ready for merge and you want me to squash the commits.

@spastorino
Owner

I think this is ready to go, please rebase and squash the commits

@ay
ay commented

@spastorino squashed

@spastorino
Owner

@alex3 the pull request cannot be merged, can you rebase it on top of the current master?

@spastorino spastorino merged commit be24be6 into rails:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Sep 8, 2011
  1. @ay
This page is out of date. Refresh to see the latest.
View
2  actionpack/lib/sprockets/assets.rake
@@ -26,6 +26,8 @@ namespace :assets do
env.each_logical_path do |logical_path|
if path.is_a?(Regexp)
next unless path.match(logical_path)
+ elsif path.is_a?(Proc)
+ next unless path.call(logical_path)
else
next unless File.fnmatch(path.to_s, logical_path)
end
View
3  railties/lib/rails/application/configuration.rb
@@ -37,7 +37,8 @@ def initialize(*)
@assets = ActiveSupport::OrderedOptions.new
@assets.enabled = false
@assets.paths = []
- @assets.precompile = [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ]
+ @assets.precompile = [ Proc.new{ |path| !File.extname(path).in?(['.js', '.css']) },
+ /application.(css|js)$/ ]
@assets.prefix = "/assets"
@assets.version = ''
@assets.debug = false
View
28 railties/test/application/assets_test.rb
@@ -64,6 +64,34 @@ def app
end
end
+ test "precompile application.js and application.css and all other files not ending with .js or .css by default" do
+ app_file "app/assets/javascripts/application.js", "alert();"
+ app_file "app/assets/stylesheets/application.css", "body{}"
+ app_file "app/assets/javascripts/something.min.js", "alert();"
+ app_file "app/assets/stylesheets/something.min.css", "body{}"
+
+ images_should_compile = ["a.png", "happyface.png", "happy_face.png", "happy.face.png",
+ "happy-face.png", "happy.happy_face.png", "happy_happy.face.png",
+ "happy.happy.face.png", "happy", "happy.face", "-happyface",
+ "-happy.png", "-happy.face.png", "_happyface", "_happy.face.png",
+ "_happy.png"]
+ images_should_compile.each do |filename|
+ app_file "app/assets/images/#{filename}", "happy"
+ end
+
+ capture(:stdout) do
+ Dir.chdir(app_path){ `bundle exec rake assets:precompile` }
+ end
+
+ images_should_compile.each do |filename|
+ assert File.exists?("#{app_path}/public/assets/#{filename}")
+ end
+ assert File.exists?("#{app_path}/public/assets/application.js")
+ assert File.exists?("#{app_path}/public/assets/application.css")
+ assert !File.exists?("#{app_path}/public/assets/something.min.js")
+ assert !File.exists?("#{app_path}/public/assets/something.min.css")
+ end
+
test "asset pipeline should use a Sprockets::Index when config.assets.digest is true" do
add_to_config "config.assets.digest = true"
add_to_config "config.action_controller.perform_caching = false"
Something went wrong with that request. Please try again.