Expand slim version support to latest (v3.0.1 at present). #602

cwest · 2015-01-04T04:54:14Z

Tests passed locally. Run against a Rails 4.2 and Rails 4.1 projects; Got expected results.

I'm not claiming a perfect understanding but things seem to be in good working order. Please let me know what I missed. 😄

Fixes #601.

cwest · 2015-01-04T04:54:49Z

Please review @ramaboo, @presidentbeef.

cwest · 2015-01-04T04:59:43Z

I see one of the things I missed. The removal of Ruby 1.8.7 support from slim 3.0.0.

The specific failure in the Travis build on Ruby 1.8.7.

cwest · 2015-01-04T05:09:14Z

Updated to consider our RUBY_VERSION to maintain consistent slim support.

presidentbeef · 2015-01-04T05:21:03Z

Should probably be RUBY_VERSION < "1.9.0" or something similar just for safety.

presidentbeef · 2015-01-04T05:24:39Z

Also I'm not sure it needs to be quite so cautious on the Slim version, or else this will need to change again at the next Slim release.

cwest · 2015-01-04T05:26:56Z

I agree. I also think the ternary operator doesn't convey the reason for the check, so I've made it a little more clear.

cwest · 2015-01-04T05:35:53Z

I kept it cautious based on #353 (comment).

If you're cool with being more forgiving so am I. Update forthcoming. 😄

presidentbeef · 2015-01-05T23:42:13Z

Sadly, I don't think this will work because the RUBY_VERSION is checked at gem creation time, not at install.

cwest · 2015-01-06T00:12:07Z

Heh. That'd be a problem indeed. :-)

bf4 · 2015-01-06T01:14:22Z

That's true. The best you could do is in to add a post_install message to the gemspec like

  if File.exist?('UPGRADING.md')
    gem.post_install_message = File.read('UPGRADING.md')
  end

and in the lib/brakeman.rb do something like:

# Slim 3.0.0 dropped support for Ruby 
if RUBY_VERSION < "1.9.0"
  gem "slim", ">=1.3.6", "<3.0"
else
  gem "slim", ">=1.3.6"
end
require 'slim'

Why is the dependency so open-ended?

cwest · 2015-01-06T21:20:08Z

So we have an issue here and @bf4 is right. I wanted to change the versions during install time but that seems to be a thing rubygems doesn't provide. I'm going to give his suggestion a whirl.

presidentbeef · 2015-01-06T22:25:13Z

Tempting to just leave slim out of dependencies and let bundler or users handle it themselves.

cwest · 2015-01-06T22:33:10Z

@presidentbeef I hear you. The difficulty is that we want to support 1.8.7 but they don't. I think I have a way to do that, but bundler doesn't honor it during tests.

We could also go with the optional dependency and the raise if someone wants to use it but doesn't install it (along with an UPGRADING.md warning).

cwest · 2015-01-06T22:36:34Z

I got install working but broke Travis. Will think on it more.

presidentbeef · 2015-01-06T22:37:53Z

Right. As you probably saw, Brakeman already runs fine with optional dependencies (changes were made a while ago to support brakeman-min).

cwest · 2015-01-06T22:39:26Z

I'll go in that direction after all. And after my commute home. (If you beat me to it with your own PR I won't be hurt. Promise.) 😄

bf4 · 2015-01-06T23:07:16Z

Did you try tilt?

cwest · 2015-01-06T23:43:52Z

I haven't.

cwest · 2015-01-07T01:21:14Z

And we're back. I think I like this solution. The project Gemfile specifies slim, and can do so on a per-ruby basis, but the gemspec no longer does.

Tested this on a Rails 4.2 app (Ruby 2.2.0) using slim 3.0.1 after installing it and upgrading my Gemfile.lock. Worked as expected!

presidentbeef · 2015-01-07T01:58:47Z

Essentially this is the same as removing Slim from from the gem dependencies, which is fine I suppose.

cwest · 2015-01-07T02:05:20Z

Right, but keeps it available for testing and development (within bundler contexts).

cwest · 2015-01-07T02:15:33Z

This is very much how tilt deals with things, as @bf4 was trying to point out, I think. 😄

BTW, my apologies for exposing you to some of the more exotic attempts I made. It was pretty rough there for a bit.

cwest · 2015-01-09T00:18:47Z

Let me know if there's anything I missed on this PR? I'd be nice for Slim and Rails 4.2 users to have the latest Brakeman. 😄

presidentbeef · 2015-01-09T06:38:06Z

README.md

+
+    $ gem install slim --version '~> 2.0.0'
+
+If you're on a more recent Ruby this step is _not_ required.


This is a little misleading...you need to install slim manually if you want to process slim templates, either way.

At the time of this commit that's slim v3.0.1. That is, except for Ruby 1.8.7 installations. Slim dropped support[^0] for Ruby 1.8.7 in their 3.0.0 release. This commit allows Brakeman to move forward with slim support on all supported later Ruby versions. To do this accurately we must install an appropriate version of Slim by inspecting `RUBY_VERSION` at install time. We do that by using the native extensions hooks available as part of gem installs. Ours is modeled after an example on GitHub[^1]. [^0]: https://github.com/slim-template/slim/blob/master/CHANGES#L12 [^1]: https://github.com/mmzyk/gem_dependency_example/tree/master/gem_dep_example

cwest · 2015-01-11T13:25:18Z

Docs update to look like this:

For Slim Users

Slim v3.0.0 dropped support for Ruby 1.8.7. Install a version of slim compatible with your Ruby.

Ruby Version	`Gemfile`	Command Line
Ruby 1.8.7	`gem 'slim', '< 3.0'`	`$ gem install slim --version '< 3.0'`
Ruby 1.9+	`gem 'slim'`	`$ gem install slim`

Expand slim version support to latest (v3.0.1 at present).

presidentbeef · 2015-01-12T01:10:47Z

Thanks for your patience!

cwest · 2015-01-12T07:48:43Z

@presidentbeef++ 😄

Lordnibbler · 2015-01-13T02:04:00Z

@presidentbeef When can we expect a new release on rubygems for this?

presidentbeef · 2015-01-13T03:03:21Z

@Lordnibbler I don't like to be too specific about release dates, but I do expect another release relatively soon.

cwest force-pushed the t-upgrade-slim branch from acc9bc3 to 8de1dbb Compare January 4, 2015 05:08

cwest force-pushed the t-upgrade-slim branch from 8de1dbb to 409d220 Compare January 4, 2015 05:12

cwest force-pushed the t-upgrade-slim branch from 409d220 to cf0a526 Compare January 4, 2015 05:26

cwest force-pushed the t-upgrade-slim branch 2 times, most recently from e12cba2 to eabeaeb Compare January 4, 2015 05:38

cwest changed the title ~~Expand slim support to 3.0.0 and 3.0.1 explicitly~~ Expand slim version support to latest (v3.0.1 at present). Jan 4, 2015

cwest force-pushed the t-upgrade-slim branch 2 times, most recently from 0533dfd to fbe87cd Compare January 6, 2015 22:14

cwest force-pushed the t-upgrade-slim branch 4 times, most recently from 7b4af67 to efa24aa Compare January 7, 2015 01:14

cwest force-pushed the t-upgrade-slim branch from efa24aa to 24a9654 Compare January 7, 2015 01:17

presidentbeef reviewed Jan 9, 2015
View reviewed changes

cwest force-pushed the t-upgrade-slim branch from 24a9654 to 2e44182 Compare January 11, 2015 13:21

presidentbeef added a commit that referenced this pull request Jan 12, 2015

Merge pull request #602 from cwest/t-upgrade-slim

13bc8db

Expand slim version support to latest (v3.0.1 at present).

presidentbeef merged commit 13bc8db into presidentbeef:master Jan 12, 2015

presidentbeef mentioned this pull request Feb 6, 2015

Relax dependency for ruby_parser #618

Closed

Repository owner locked and limited conversation to collaborators Feb 16, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expand slim version support to latest (v3.0.1 at present). #602

Expand slim version support to latest (v3.0.1 at present). #602

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

presidentbeef commented Jan 4, 2015

presidentbeef commented Jan 4, 2015

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

presidentbeef commented Jan 5, 2015

cwest commented Jan 6, 2015

bf4 commented Jan 6, 2015

cwest commented Jan 6, 2015

presidentbeef commented Jan 6, 2015

cwest commented Jan 6, 2015

cwest commented Jan 6, 2015

presidentbeef commented Jan 6, 2015

cwest commented Jan 6, 2015

bf4 commented Jan 6, 2015

cwest commented Jan 6, 2015

cwest commented Jan 7, 2015

presidentbeef commented Jan 7, 2015

cwest commented Jan 7, 2015

cwest commented Jan 7, 2015

cwest commented Jan 9, 2015

presidentbeef Jan 9, 2015

cwest commented Jan 11, 2015

presidentbeef commented Jan 12, 2015

cwest commented Jan 12, 2015

Lordnibbler commented Jan 13, 2015

presidentbeef commented Jan 13, 2015


		$ gem install slim --version '~> 2.0.0'

		If you're on a more recent Ruby this step is _not_ required.

Expand slim version support to latest (v3.0.1 at present). #602

Expand slim version support to latest (v3.0.1 at present). #602

Conversation

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

presidentbeef commented Jan 4, 2015

presidentbeef commented Jan 4, 2015

cwest commented Jan 4, 2015

cwest commented Jan 4, 2015

presidentbeef commented Jan 5, 2015

cwest commented Jan 6, 2015

bf4 commented Jan 6, 2015

cwest commented Jan 6, 2015

presidentbeef commented Jan 6, 2015

cwest commented Jan 6, 2015

cwest commented Jan 6, 2015

presidentbeef commented Jan 6, 2015

cwest commented Jan 6, 2015

bf4 commented Jan 6, 2015

cwest commented Jan 6, 2015

cwest commented Jan 7, 2015

presidentbeef commented Jan 7, 2015

cwest commented Jan 7, 2015

cwest commented Jan 7, 2015

cwest commented Jan 9, 2015

presidentbeef Jan 9, 2015

Choose a reason for hiding this comment

cwest commented Jan 11, 2015

For Slim Users

presidentbeef commented Jan 12, 2015

cwest commented Jan 12, 2015

Lordnibbler commented Jan 13, 2015

presidentbeef commented Jan 13, 2015