c_lexer 2.5.1.0.pre2 → 2.5.1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d69239c3a8e5a8d86fab7c3063f55851e09e5f6e2833f3e1ffb6d16e26fea0b6
-  data.tar.gz: dd48e4a13c3c5a680d66ff07c216c4da3cfa25cc87045c0ff2e28cc91776bb22
+  metadata.gz: 2aa70c7302bb2c3d91d446772112620e4a3a0c40050efc61f518d979fd5359ff
+  data.tar.gz: 80b00518e752b299c9ad61431eba14b0152f915181b715f2791a4955f46ccac0
 SHA512:
-  metadata.gz: 34621afed4269fc3085add014b888c6a73638e3892cf3ce450c7320f1547fc6478b1fec80d7d490d90510c5d480b481c14d31fa53c69bb90b1257f170c1abc1e
-  data.tar.gz: 966eb6204c101554301a60a36105fc3413226a2332a233d694fd0f340b40fa5d0bc137782ca97312046ae15911570c15e5b800d685642e75cfaa3df63748f574
+  metadata.gz: 83be810697851a7a3713d31680a4258972843c01cc572e18504d4108b3a638ade3600c8a0162fd27c4f5f1cc2abfdf56253bafc7f8ec1e0c833ee71109979627
+  data.tar.gz: 42dc3a52977f2ea9d880846a5ee75e8f854b4b9555d89a59eb3244d864de33d5d2b47baa66dd2dd8a17e91f1df2d7e5262b33b4661e0c565c2bcb447fbde4b5d

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    c_lexer (2.5.1.0.pre2)
+    c_lexer (2.5.1.2.0)
       ast (~> 2.4.0)
-      parser (= 2.5.1.0)
+      parser (= 2.5.1.2)
 
 PATH
   remote: vendor/parser
   specs:
-    parser (2.5.1.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
 
 GEM

data/README.md

@@ -7,21 +7,57 @@ A C port of the whitequark/parser's lexer.
 
 Initially based on [whitequark/parser#248](https://github.com/whitequark/parser/pull/248) (thanks [@alexdowad](https://github.com/alexdowad)).
 
-This project is still under development.
+Can be use on Linux/Mac/Windows, requires MRI.
 
 ## Installation
 
 ```
-$ git submodule update --init
-$ bundle install
-$ rake
+$ gem install c_lexer
 ```
 
 ## Usage
 
-Simply require `c_lexer` after `parser` in your code.
-It should print `Using C lexer`.
+`c_lexer` doesn't change any parser classes.
+
+It provides 2 classes:
++ `Parser::CLexer` (C version of the lexer)
++ `Parser::Ruby25WithCLexer` (a subclass of `parser/ruby25` that uses `Parser::CLexer` for lexing)
+
+If you want `CLexer` to be a default lexer you can use the following patch:
+
+``` ruby
+require 'parser'
+require 'c_lexer'
+
+module Parser
+  dedenter = Lexer::Dedenter
+
+  remove_const(:Lexer)
+  Lexer = CLexer
+  Lexer::Dedenter = dedenter
+end
+```
+
+## Versioning
+
+`c_lexer` follows versioning of the `parser` gem to avoid confusions like
+"which version of `c_lexer` should be used with the `parser vX.Y.Z`". For `parser 2.5.1.0` you should use `c_lexer 2.5.1.0`.
+
+`c_lexer` supports all versions of `parser` starting from `2.5.1.0`
+
+## Development
+
+1. Make sure that you have `ragel` installed.
+2. Clone the repo and fetch submodules with `git submodule update --init`.
+3. The parser gem is located under `vendor/parser`.
+4. `rake ruby_parser:generate` generates `lexer.rb` and parsers for the `parser` gem.
+5. `rake c_lexer:generate` generates `lexer.c`.
+6. `rake compile` compiles `lexer.c` to `lexer.so` (or `lexer.bundle` depending on your platform).
+7. `rake test` runs `parser` tests using `c_lexer` as a default lexer.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/opal/c_lexer.
+
+Before submitting a bug report, please, make sure that `parser` is not affected by the same issue.
+If it's a parser bug please report it to the parser repo and we will backport it afterwards.

data/c_lexer.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.extensions    = ['ext/lexer/extconf.rb']
 
   spec.add_dependency             'ast',           '~> 2.4.0'
-  spec.add_dependency             'parser',        '= 2.5.1.0'
+  spec.add_dependency             'parser',        '= 2.5.1.2'
 
   spec.add_development_dependency 'bundler',       '~> 1.16'
   spec.add_development_dependency 'rake',          '~> 10.0'