Crass

Crass is a Ruby CSS parser based on the CSS Syntax Level 3 draft specification.

Build Status Gem Version

Features

  • Pure Ruby, with no runtime dependencies other than Ruby 1.9.x or higher.

  • Tokenizes and parses CSS according to the rules defined in the 2013 draft of the CSS Syntax Level 3 specification.

  • Extremely tolerant of broken or invalid CSS. If a browser can handle it, Crass should be able to handle it too.

  • Optionally includes comments in the token stream.

  • Optionally preserves certain CSS hacks, such as the IE "*" hack, which would otherwise be discarded according to CSS3 tokenizing rules.

  • Capable of serializing the parse tree back to CSS while maintaining all original whitespace, comments, and indentation.

Problems

  • Crass isn't terribly fast. I mean, it's Ruby, and it's not really slow by Ruby standards. But compared to the CSS parser in your average browser? Yeah, it's slow.

  • Crass only parses the CSS syntax; it doesn't understand what any of it means, doesn't coalesce selectors, etc. You can do this yourself by consuming the parse tree, though.

  • While any node in the parse tree (or the parse tree as a whole) can be serialized back to CSS with perfect fidelity, changes made to those nodes (except for wholesale removal of nodes) are not reflected in the serialized output.

  • At the moment, Crass only supports UTF-8 input and doesn't respect @charset rules. Input in any other encoding will be converted to UTF-8.

  • Probably other things. Did I mention Crass is pretty new?

Installing

gem install crass

Examples

Say you have a string containing the following simple CSS:

/* Comment! */
a:hover {
  color: #0d8bfa;
  text-decoration: underline;
}

Parsing it is simple:

tree = Crass.parse(css, :preserve_comments => true)

This returns a big fat ugly parse tree, which looks like this:

[{:node=>:comment, :pos=>0, :raw=>"/* Comment! */", :value=>" Comment! "},
 {:node=>:whitespace, :pos=>14, :raw=>"\n"},
 {:node=>:property,
  :name=>"a",
  :value=>"hover {\n  color: #0d8bfa",
  :children=>
   [{:node=>:ident, :pos=>17, :raw=>"hover", :value=>"hover"},
    {:node=>:whitespace, :pos=>22, :raw=>" "},
    {:node=>:{", :pos=>23, :raw=>"{"},
    {:node=>:whitespace, :pos=>24, :raw=>"\n  "},
    {:node=>:ident, :pos=>27, :raw=>"color", :value=>"color"},
    {:node=>:colon, :pos=>32, :raw=>":"},
    {:node=>:whitespace, :pos=>33, :raw=>" "},
    {:node=>:hash,
     :pos=>34,
     :raw=>"#0d8bfa",
     :type=>:unrestricted,
     :value=>"0d8bfa"}],
  :important=>false,
  :tokens=>
   [{:node=>:ident, :pos=>15, :raw=>"a", :value=>"a"},
    {:node=>:colon, :pos=>16, :raw=>":"},
    {:node=>:ident, :pos=>17, :raw=>"hover", :value=>"hover"},
    {:node=>:whitespace, :pos=>22, :raw=>" "},
    {:node=>:{", :pos=>23, :raw=>"{"},
    {:node=>:whitespace, :pos=>24, :raw=>"\n  "},
    {:node=>:ident, :pos=>27, :raw=>"color", :value=>"color"},
    {:node=>:colon, :pos=>32, :raw=>":"},
    {:node=>:whitespace, :pos=>33, :raw=>" "},
    {:node=>:hash,
     :pos=>34,
     :raw=>"#0d8bfa",
     :type=>:unrestricted,
     :value=>"0d8bfa"},
    {:node=>:semicolon, :pos=>41, :raw=>";"}]},
 {:node=>:whitespace, :pos=>42, :raw=>"\n  "},
 {:node=>:property,
  :name=>"text-decoration",
  :value=>"underline",
  :children=>
   [{:node=>:whitespace, :pos=>61, :raw=>" "},
    {:node=>:ident, :pos=>62, :raw=>"underline", :value=>"underline"}],
  :important=>false,
  :tokens=>
   [{:node=>:ident,
     :pos=>45,
     :raw=>"text-decoration",
     :value=>"text-decoration"},
    {:node=>:colon, :pos=>60, :raw=>":"},
    {:node=>:whitespace, :pos=>61, :raw=>" "},
    {:node=>:ident, :pos=>62, :raw=>"underline", :value=>"underline"},
    {:node=>:semicolon, :pos=>71, :raw=>";"}]},
 {:node=>:whitespace, :pos=>72, :raw=>"\n"}]

If you want, you can stringify the parse tree:

css = Crass::Parser.stringify(tree)

...which gives you back exactly what you put in!

/* Comment! */
a:hover {
  color: #0d8bfa;
  text-decoration: underline;
}

Wasn't that exciting?

A Note on Versioning

Crass's version number currently has a "0.x" prefix, indicating that it's a new project under heavy development. As long as the version number starts with "0.x", minor revisions may introduce breaking changes. You've been warned!

Once Crass reaches version 1.0.0, it will adhere strictly to SemVer 2.0.

Contributing

The best way to contribute right now is to use Crass and create issues when you run into problems.

Pull requests that fix bugs are more than welcome as long as they include tests. Please adhere to the style and format of the surrounding code, or I might ask you to change things.

If you want to add a feature or refactor something, please get in touch first to make sure I'm on board with your idea and approach; I'm pretty picky, and I'd hate to have to turn down a pull request you spent a lot of time on.

Acknowledgments

I'm deeply, deeply grateful to Simon Sapin for his wonderfully comprehensive CSS parsing tests, which I adapted to create many of Crass's tests. They've been invaluable in helping me fix bugs and handle weird edge cases, and Crass would be much crappier without them.

I'm also grateful to Tab Atkins Jr. and Simon Sapin (again!) for their work on the CSS Syntax Level 3 specification, which defines the tokenizing and parsing rules that Crass implements.

License

Copyright (c) 2013 Ryan Grove (ryan@wonko.com)

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.