tinygql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bb94d776ff356520312d76baadfe817ca813c617165479b3ed49887566fc4ff
+  data.tar.gz: e5c1b0e354a07108d1e237b8e10c378b58df57cc093c4c75d7a96e6a64982c3a
+SHA512:
+  metadata.gz: 7e96c6748835b72e3d2a38c312d7eb0b67ba0ddf77cc11aab8ac5d43a1bf83025b23526beb3409602a23a78d91a10f4d3d4f9d2ec94d3951c0035620de401426
+  data.tar.gz: df88fd036d265ba22c28cba79f7b76df502e20d30387f6d76a6838ddc743d0dd4d9a9373ce73282a67d6cbfdf00f55e6383865d2e28e9a338ad1fdee72183661

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [ head, 3.2 ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test
+
+  gem-test:
+    runs-on: ${{ matrix.os }}-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [ head, 3.2 ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake gem:test

data/.gitignore

@@ -0,0 +1,4 @@
+lib/tinygql/nodes.rb
+lib/tinygql/visitors.rb
+Gemfile.lock
+pkg

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aaron.patterson at gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Aaron Patterson
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,71 @@
+# 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"]
+```
+
+## 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.

data/Rakefile

@@ -0,0 +1,132 @@
+require "rake/testtask"
+require "bundler/gem_tasks"
+require_relative "lib/tinygql/version"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+FILES = [ "lib/tinygql/nodes.rb", "lib/tinygql/visitors.rb" ]
+
+task :test => FILES
+
+task default: :test
+
+def extract_nodes source
+  require "psych"
+  require "erb"
+
+  info = Psych.load_file source
+  node = Struct.new(:name, :parent, :fields) do
+    def has_children?; fields.length > 0; end
+
+    def human_name
+      name.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def children
+      buf = ["ary = []"]
+
+      fields.each do |field|
+        case field.type
+        when "list"
+          x = "ary.concat(#{field.name})"
+          if field.nullable?
+            x << " if #{field.name}"
+          end
+          buf << x
+        when "node"
+          x = "ary << #{field.name}"
+          if field.nullable?
+            x << " if #{field.name}"
+          end
+          buf << x
+        end
+      end
+
+      buf << "ary"
+      buf.join("; ")
+    end
+  end
+
+  field = Struct.new :_name, :type do
+    def name
+      _name.sub(/\?$/, '')
+    end
+
+    def list?; type == "list"; end
+    def node?; type == "node"; end
+    def visitable?; list? || node?; end
+
+    def nullable?
+      _name.end_with?("?")
+    end
+  end
+  info["nodes"].map { |n|
+    node.new(n["name"], n["parent"] || "Node", (n["fields"] || []).map { |f|
+      name = f
+      type = "node"
+      if Hash === f
+        (name, type) = *f.to_a.first
+      end
+      field.new name, type
+    })
+  }
+end
+
+file "lib/tinygql/nodes.rb" => "lib/tinygql/nodes.yml" do |t|
+  nodes = extract_nodes t.source
+  erb = ERB.new File.read("lib/tinygql/nodes.rb.erb"), trim_mode: "-"
+  File.binwrite t.name, erb.result(binding)
+end
+
+file "lib/tinygql/visitors.rb" => "lib/tinygql/nodes.yml" do |t|
+  nodes = extract_nodes t.source
+  erb = ERB.new File.read("lib/tinygql/visitors.rb.erb"), trim_mode: "-"
+  File.binwrite t.name, erb.result(binding)
+end
+
+require "rake/clean"
+CLOBBER.append(FILES)
+
+task :build => FILES
+
+namespace :gem do
+  task :push => [:test, :build] do
+    # check for a clean worktree
+    sh "git update-index --really-refresh"
+    sh "git diff-index --quiet HEAD"
+
+    # tag it
+    sh "git tag -m'tagging release' v#{TinyGQL::VERSION}"
+
+    # push it
+    ENV['GEM_HOST_OTP_CODE'] = `ykman oath accounts code -s rubygems.org`.chomp
+    sh "gem push pkg/tinygql-#{TinyGQL::VERSION}.gem"
+  end
+
+  Rake::TestTask.new(:test) do |t|
+    t.libs = ["test"]
+    t.warning = true
+    t.verbose = true
+    t.test_files = FileList["test/**/*_test.rb"]
+  end
+
+  task :install => :build do
+    require 'tmpdir'
+
+    Dir.mktmpdir do |d|
+      ENV["GEM_HOME"] = d
+      ENV["GEM_PATH"] = ([d] + Gem.path).join(":")
+    end
+    sh "gem install -l pkg/tinygql-#{TinyGQL::VERSION}.gem"
+  end
+
+  task :test => :install
+end

data/bin/bench.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "tinygql"
+require "benchmark"
+
+source = File.read(File.expand_path("../test/kitchen-sink.graphql", __dir__))
+
+Benchmark.bm do |x|
+  x.report { 10_000.times { TinyGQL::Parser.new(source).parse } }
+end