yarp 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51ee2a88319b74a9937ab37fbaa9bb71586caf26a8f31282c2d2431735a484b6
+  data.tar.gz: efe7ac9662cd199e3ba0c8a00f913912a2830843bc0c87cdfc3b258d724eafd8
+SHA512:
+  metadata.gz: 535d2f88c7ff324dbbc0e94dce1e4356125e1b08367c247c48cb083a00dccd997bf3bb73f4534effd8c6797373a588c0e76f6782e60afc36933c21a50b8f9900
+  data.tar.gz: 1e9f92c56e9863d076b0ade0e82917a0e8df50063337d51cda1b9a8df1ea5bdc858b1b153179fd189eaabe313cff8e34213b68daad4488658316cd1dc077eedc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making 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 both within project spaces and in public spaces
+when an individual is representing the project or its community. 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 opensource@shopify.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/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Thank you for your interest in contributing to YARP! Below are a couple of ways that you can help out.
+
+## Discussions
+
+The discussions page on the GitHub repository are open. If you have a question or want to discuss the project, feel free to open a new discussion or comment on an existing one. This is the best place to ask questions about the project.
+
+## Code
+
+If you want to contribute code, please first open or contribute to a discussion. A lot of the project is in flux, and we want to make sure that you are contributing to the right place. Once you have a discussion going, you can open a pull request with your changes. We will review your code and get it merged in.
+
+## Tests
+
+We could always use more tests! One of the biggest challenges of this project is building up a big test suite. If you want to contribute tests, feel free to open a pull request. These will get merged in as soon as possible.
+
+The `test` Rake task will not compile libraries or the C extension, and this is intentional (to make testing against an installed version easier). If you want to test your changes, please make sure you're also running either the task:
+
+``` sh
+bundle exec rake
+```
+
+or explicitly running the `compile` task:
+
+``` sh
+bundle exec rake compile test
+# or to just compile the C extension ...
+bundle exec rake compile:yarp test
+```
+
+## Documentation
+
+We could always use more documentation! If you want to contribute documentation, feel free to open a pull request. These will get merged in as soon as possible. Documenting functions or methods is always useful, but we also need more guides and tutorials. If you have an idea for a guide or tutorial, feel free to open an issue and we can discuss it.
+
+## Developing
+
+To get `clangd` support in the editor for development, generate the compilation database. This command will
+create an ignored `compile_commands.json` file at the project root, which is used by clangd to provide functionality.
+
+You will need `bear` which can be installed on macOS with `brew install bear`.
+
+```sh
+bundle exec rake bear
+```
+
+## Debugging
+
+Some useful rake tasks:
+
+- `test:valgrind` runs the test suite under valgrind to look for illegal memory access or memory leaks
+- `test:gdb` and `test:lldb` run the test suite under those debuggers

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022-present, Shopify Inc.
+
+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.

data/Makefile.in

@@ -0,0 +1,79 @@
+
+# V=0 quiet, V=1 verbose.  other values don't work.
+V = 0
+V0 = $(V:0=)
+Q1 = $(V:1=)
+Q = $(Q1:0=@)
+ECHO1 = $(V:1=@ :)
+ECHO = $(ECHO1:0=@ echo)
+FUZZ_OUTPUT_DIR = $(shell pwd)/fuzz/output
+
+SOEXT := $(shell ruby -e 'puts RbConfig::CONFIG["SOEXT"]')
+
+DEFS := @DEFS@
+CPPFLAGS := @DEFS@ -Iinclude
+CFLAGS := @CFLAGS@ -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -fPIC -fvisibility=hidden
+CC := @CC@
+
+HEADERS := $(shell find include -name '*.h')
+SOURCES := $(shell find src -name '*.c')
+SHARED_OBJECTS := $(subst src/,build/shared/,$(SOURCES:.c=.o))
+STATIC_OBJECTS := $(subst src/,build/static/,$(SOURCES:.c=.o))
+
+all: shared static
+
+shared: build/librubyparser.$(SOEXT)
+static: build/librubyparser.a
+
+build/librubyparser.$(SOEXT): $(SHARED_OBJECTS)
+	$(ECHO) "linking $@"
+	$(Q) $(CC) $(DEBUG_FLAGS) $(CFLAGS) -shared -o $@ $(SHARED_OBJECTS)
+
+build/librubyparser.a: $(STATIC_OBJECTS)
+	$(ECHO) "building $@"
+	$(Q) $(AR) $(ARFLAGS) $@ $(STATIC_OBJECTS) $(Q1:0=>/dev/null)
+
+build/shared/%.o: src/%.c Makefile $(HEADERS)
+	$(ECHO) "compiling $@"
+	$(Q) mkdir -p $(@D)
+	$(Q) $(CC) $(DEBUG_FLAGS) -DYP_EXPORT_SYMBOLS $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
+
+build/static/%.o: src/%.c Makefile $(HEADERS)
+	$(ECHO) "compiling $@"
+	$(Q) mkdir -p $(@D)
+	$(Q) $(CC) $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
+
+build/fuzz.%: $(SOURCES) fuzz/%.c fuzz/fuzz.c
+	$(ECHO) "building $* fuzzer"
+	$(ECHO) "building main fuzz binary"
+	$(Q) AFL_HARDEN=1 afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize-ignorelist=fuzz/asan.ignore -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@ $^
+	$(ECHO) "building cmplog binary"
+	$(Q) AFL_HARDEN=1 AFL_LLVM_CMPLOG=1 afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize-ignorelist=fuzz/asan.ignore -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@.cmplog $^
+
+build/fuzz.heisenbug.%: $(SOURCES) fuzz/%.c fuzz/heisenbug.c
+	$(Q) AFL_HARDEN=1 afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize-ignorelist=fuzz/asan.ignore -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@ $^
+
+fuzz-debug:
+	$(ECHO) "entering debug shell"
+	$(Q) docker run -it --rm -e HISTFILE=/yarp/fuzz/output/.bash_history -v $(shell pwd):/yarp -v $(FUZZ_OUTPUT_DIR):/fuzz_output yarp/fuzz
+
+fuzz-docker-build: fuzz/docker/Dockerfile
+	$(ECHO) "building docker image"
+	$(Q) docker build -t yarp/fuzz fuzz/docker/
+
+fuzz-run-%: FORCE fuzz-docker-build
+	$(ECHO) "running $* fuzzer"
+	$(Q) docker run --rm -v $(shell pwd):/yarp yarp/fuzz /bin/bash -c "FUZZ_FLAGS=\"$(FUZZ_FLAGS)\" make build/fuzz.$*"
+	$(ECHO) "starting AFL++ run"
+	$(Q) mkdir -p $(FUZZ_OUTPUT_DIR)/$*
+	$(Q) docker run -it --rm -v $(shell pwd):/yarp -v $(FUZZ_OUTPUT_DIR):/fuzz_output yarp/fuzz /bin/bash -c "./fuzz/$*.sh /fuzz_output/$*"
+FORCE:
+
+clean:
+	$(Q) rm -f -r build
+
+.PHONY: clean
+
+all-no-debug: DEBUG_FLAGS := -DNDEBUG=1
+all-no-debug: OPTFLAGS := -O3
+all-no-debug: all

data/README.md

@@ -0,0 +1,86 @@
+# Yet Another Ruby Parser
+
+This is a parser for the Ruby programming language. It is designed to be portable, error tolerant, and maintainable. It is written in C99 and has no dependencies. It is currently being integrated into [CRuby](https://github.com/ruby/ruby), [JRuby](https://github.com/jruby/jruby), [TruffleRuby](https://github.com/oracle/truffleruby), [Sorbet](https://github.com/sorbet/sorbet), and [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree).
+
+## Overview
+
+The repository contains the infrastructure for both a shared library (librubyparser) and a native CRuby extension. The shared library has no bindings to CRuby itself, and so can be used by other projects. The native CRuby extension links against `ruby.h`, and so is suitable in the context of CRuby.
+
+```
+.
+├── Makefile.in           configuration to compile the shared library and native tests
+├── Rakefile              configuration to compile the native extension and run the Ruby tests
+├── bin
+│   ├── lex               runs the lexer on a file or string, prints the tokens, and compares to ripper
+│   └── parse             runs the parser on a file or string and prints the syntax tree
+├── config.yml            specification for tokens and nodes in the tree
+├── configure.ac          configuration to generate the Makefile
+├── docs                  documentation about the project
+├── ext
+│   └── yarp
+│       ├── extconf.rb    configuration to generate the Makefile for the native extension
+│       └── extension.c   the native extension that interacts with librubyparser
+├── fuzz                  files related to fuzz testing
+├── include
+│   ├── yarp              header files for the shared library
+│   └── yarp.h            main header file for the shared library
+├── java                  Java bindings for the shared library
+├── lib
+│   ├── yarp              Ruby library files
+│   └── yarp.rb           main entrypoint for the Ruby library
+├── rakelib               various Rake tasks for the project
+├── src
+│   ├── enc               various encoding files
+│   ├── util              various utility files
+│   └── yarp.c            main entrypoint for the shared library
+├── templates             contains ERB templates generated by templates/template.rb
+│   └── template.rb       generates code from the nodes and tokens configured by config.yml
+└── test
+    ├── fixtures          Ruby code used for testing
+    └── snapshots         snapshots of generated syntax trees corresponding to fixtures
+```
+
+## Getting started
+
+To compile the shared library, you will need:
+
+* A C99 compiler
+* autotools (autoconf, automake, libtool)
+* make
+* Ruby 3.3.0-preview1 or later
+
+Once you have these dependencies, run:
+
+```
+bundle install
+```
+
+to fetch the Ruby dependencies. Finally, run:
+
+```
+rake compile
+```
+
+to compile the shared library. It will be built in the `build` directory. To test that everything is working, run:
+
+```
+bin/parse -e "1 + 2"
+```
+
+to see the syntax tree for the expression `1 + 2`.
+
+## Contributing
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. We additionally have documentation about the overall design of the project as well as various subtopics.
+
+* [Building](docs/building.md)
+* [Configuration](docs/configuration.md)
+* [Design](docs/design.md)
+* [Encoding](docs/encoding.md)
+* [Extension](docs/extension.md)
+* [Fuzzing](docs/fuzzing.md)
+* [Heredocs](docs/heredocs.md)
+* [Mapping](docs/mapping.md)
+* [Ripper](docs/ripper.md)
+* [Serialization](docs/serialization.md)
+* [Testing](docs/testing.md)

data/config.h.in

@@ -0,0 +1,25 @@
+/* config.h.in.  Generated from configure.ac by autoheader.  */
+
+/* Define to 1 if you have the `mmap' function. */
+#undef HAVE_MMAP
+
+/* Define to 1 if you have the `snprintf' function. */
+#undef HAVE_SNPRINTF
+
+/* Define to the address where bug reports for this package should be sent. */
+#undef PACKAGE_BUGREPORT
+
+/* Define to the full name of this package. */
+#undef PACKAGE_NAME
+
+/* Define to the full name and version of this package. */
+#undef PACKAGE_STRING
+
+/* Define to the one symbol short name of this package. */
+#undef PACKAGE_TARNAME
+
+/* Define to the home page for this package. */
+#undef PACKAGE_URL
+
+/* Define to the version of this package. */
+#undef PACKAGE_VERSION