Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgrove/crass
A Ruby CSS parser that's fully compliant with the CSS Syntax Level 3 specification.
https://github.com/rgrove/crass
css parser ruby
Last synced: 4 days ago
JSON representation
A Ruby CSS parser that's fully compliant with the CSS Syntax Level 3 specification.
- Host: GitHub
- URL: https://github.com/rgrove/crass
- Owner: rgrove
- License: mit
- Created: 2013-09-28T04:05:19.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T20:22:52.000Z (5 months ago)
- Last Synced: 2024-10-18T15:45:01.242Z (16 days ago)
- Topics: css, parser, ruby
- Language: Ruby
- Homepage:
- Size: 188 KB
- Stars: 140
- Watchers: 12
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# Crass
Crass is a Ruby CSS parser that's fully compliant with the [CSS Syntax Level 3](http://dev.w3.org/csswg/css-syntax/) specification.
[](http://badge.fury.io/rb/crass)
[](https://github.com/rgrove/crass/actions/workflows/tests.yml)
## Links
- [Home](https://github.com/rgrove/crass/)
- [API Docs](https://rubydoc.info/github/rgrove/crass/Crass)
## 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 14 November 2014 editor's draft of the [CSS Syntax Level 3](http://dev.w3.org/csswg/css-syntax/) 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.
- Crass only supports UTF-8 input and doesn't respect `@charset` rules. Input in any other encoding will be converted to UTF-8.
## Installing
```
gem install crass
```
## Examples
Say you have a string containing some CSS:
```css
/* Comment! */
a:hover {
color: #0d8bfa;
text-decoration: underline;
}
```
Parsing it is simple:
```ruby
tree = Crass.parse(css, :preserve_comments => true)
```
This returns a big beautiful parse tree, which looks like this:
```ruby
[{:node=>:comment, :pos=>0, :raw=>"/* Comment! */", :value=>" Comment! "},
{:node=>:whitespace, :pos=>14, :raw=>"\n"},
{:node=>:style_rule,
:selector=>
{:node=>:selector,
:value=>"a:hover",
: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=>" "}]},
:children=>
[{:node=>:whitespace, :pos=>24, :raw=>"\n "},
{:node=>:property,
:name=>"color",
:value=>"#0d8bfa",
:children=>
[{:node=>:whitespace, :pos=>33, :raw=>" "},
{:node=>:hash,
:pos=>34,
:raw=>"#0d8bfa",
:type=>:unrestricted,
:value=>"0d8bfa"}],
:important=>false,
:tokens=>
[{: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:
```ruby
css = Crass::Parser.stringify(tree)
```
...which gives you back exactly what you put in!
```css
/* Comment! */
a:hover {
color: #0d8bfa;
text-decoration: underline;
}
```
Wasn't that exciting?
## Versioning
As of version 1.0.0, Crass adheres strictly to [SemVer 2.0](http://semver.org/spec/v2.0.0.html).
## Contributing
The best way to contribute is to use Crass and [create issues](https://github.com/rgrove/crass/issues/new) 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 grateful to [Simon Sapin](http://exyr.org/about/) for his wonderfully comprehensive [CSS parsing tests](https://github.com/SimonSapin/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-Bittner](https://www.xanthir.com/contact/) and Simon Sapin (again!) for their work on the [CSS Syntax Level 3](http://www.w3.org/TR/css-syntax-3/) specification, which defines the tokenizing and parsing rules that Crass implements.