Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tenderlove/tinygql
A tiny and experimental GraphQL parser in Ruby
https://github.com/tenderlove/tinygql
graphql ruby
Last synced: about 2 months ago
JSON representation
A tiny and experimental GraphQL parser in Ruby
- Host: GitHub
- URL: https://github.com/tenderlove/tinygql
- Owner: tenderlove
- License: apache-2.0
- Created: 2023-08-08T23:39:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-29T22:16:28.000Z (12 months ago)
- Last Synced: 2024-07-11T09:51:10.708Z (2 months ago)
- Topics: graphql, ruby
- Language: Ruby
- Homepage:
- Size: 156 KB
- Stars: 82
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TinyGQL
Very experimental GraphQL parser. It's mostly reusing the lexer from
[GraphQL-Ruby](https://github.com/rmosolgo/graphql-ruby), but the parser is a
hand-written recursive descent parser.
I want to target this at server side applications, so the parser eliminates some nice stuff for humans (namely line / column information, and it throws away comments).
Right now this code:
1. Doesn't know how to execute anything. It just gives you an AST
2. Isn't used anywhere (except in your heart, *but hopefully in production someday!)
## Usage
You can get an AST like this:
```ruby
ast = TinyGQL.parse "{ cool }"
```
The AST is iterable, so you can use the each method:
```ruby
ast = TinyGQL.parse "{ cool }"
ast.each do |node|
p node.class
end
```
Nodes have predicate methods, so if you want to find particular nodes just use a predicate:
```ruby
ast = TinyGQL.parse "{ cool }"
p ast.find_all(&:field?).map(&:name) # => ["cool"]
```
If you need a more advanced way to iterate nodes, you can use a visitor:
```ruby
class Viz
include TinyGQL::Visitors::Visitor
def handle_field obj
p obj.name # => cool
super
end
end
ast = TinyGQL.parse "{ cool }"
ast.accept(Viz.new)
```
If you would like a functional way to collect data from the tree, use the `Fold` module:
```ruby
module Fold
extend TinyGQL::Visitors::Fold
def self.handle_field obj, seed
super(obj, seed + [obj.name])
end
end
ast = TinyGQL.parse "{ neat { cool } }"
p ast.fold(Fold, []) # => ["neat", "cool"]
```
Nodes store their position in the source GraphQL document.
If you'd like to extract the line number of the node, you'll need to keep a reference to the document and pass it to the `line` method on the node:
```ruby
doc = <<-eod
mutation {
likeStory(sturyID: 12345) {
story {
likeCount
}
}
}
eod
parser = TinyGQL::Parser.new doc
ast = parser.parse
ast.find_all(&:field?).each { |node|
p node.name => node.line(doc)
}
```
## LICENSE:
I've licensed this code as Apache 2.0, but the lexer is from [GraphQL-Ruby](https://github.com/rmosolgo/graphql-ruby/blob/772734dfcc7aa0513c867259912474ef0ba799c3/lib/graphql/language/lexer.rb) and is under the MIT license.