onigmo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60ce173c124c6d7750e87ccd1d834128600923d9abb9b375d42ae21e1da3aa11
+  data.tar.gz: f0cebe1ed576df5fc0a360f313fd1d34108e3ce613d7489e57daed87ceed48a1
+SHA512:
+  metadata.gz: 7b8fbdd6c0e2c5b751f4e11b5e5f5887596b1ebefe76485b3ae7eafaf8363cacaa960fc8f8cf6667d0fb76072aaa76bd46854938beef61eeba130d0c58be9340
+  data.tar.gz: 40a6843a44559aeaa03d074835f4f21d6e57100a777e712fce96753f845446e909815d7ff0bb663982a63b9569da93c120df15a613b24a141092f7eb1893249f

data/.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: Main
+
+on:
+- push
+- pull_request
+
+jobs:
+  ci:
+    name: CI
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - "head"
+        os:
+          - "ubuntu-latest"
+          - "macos-latest"
+          - "windows-latest"
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Test
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/lib/onigmo/onigmo.bundle

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "bundler"
+gem "rake-compiler"
+gem "rake"
+gem "simplecov"
+gem "test-unit"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.4.0)
+    power_assert (2.0.3)
+    rake (13.0.6)
+    rake-compiler (1.2.5)
+      rake
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    test-unit (3.6.2)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rake-compiler
+  simplecov
+  test-unit
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024-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/README.md

@@ -0,0 +1,101 @@
+# Onigmo
+
+A Ruby wrapper around the onigmo regular expression library.
+
+> [!WARNING]  
+> This library purposefully accesses internal headers of the onigmo library, and as such no compatibility is guaranteed. This library should be used only for debugging, testing, and educational purposes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add onigmo
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install onigmo
+
+## Usage
+
+The `Onigmo` module provides two methods: `parse` and `compile`.
+
+### parse
+
+`Onigmo.parse(source)` gives you back the abstract syntax tree (AST) of the regular expression.
+
+```
+irb(main):001> Onigmo.parse("aaa|bbb*")
+=> 
+alternation(
+  string("aaa"),
+  list(
+    string("bb"),
+    quantifier(
+      lower: 0,
+      upper: nil,
+      greedy: true,
+      string("b")
+    )
+  )
+)
+```
+
+These nodes each have their own APIs for their respective fields. They also share the following common APIs:
+
+* `deconstruct_keys(keys)` - an implementation of pattern matching
+* `pretty_print(q)` - an implementation of pretty printing
+* `as_json` - returns a hash suitable for serialization
+* `to_json` - returns a JSON string suitable for serialization
+
+### compile
+
+`Onigmo.compile(source)` gives you back the list of bytecode instructions that onigmo will use to execute the regular expression.
+
+```
+irb(main):001> Onigmo.compile("aaa|bbb*")
+# =>
+[[:push, 9],
+ [:exact3, "aaa"],
+ [:jump, 15],
+ [:exact2, "bb"],
+ [:push, 7],
+ [:exact1, "b"],
+ [:jump, -12],
+ [:end]]
+```
+
+Every instruction in the list will be an array. The operands to the instructions will be simple values (i.e., strings, symbols, integers, or arrays).
+
+### visit
+
+With the abstract syntax tree, the `Onigmo` module also provides some ability to visit the nodes in the tree. This is done through visitors. A visitor is an object that responds to one or more `visit_*` methods corresponding to the names of the nodes in the tree. For example, if you wanted to visit only the strings in the tree, you could write:
+
+```ruby
+class StringVisitor < Visitor
+  attr_reader :strings
+
+  def initialize(strings)
+    @strings = strings
+  end
+
+  def visit_string_node(node)
+    strings << node.value
+  end
+end
+```
+
+By implementing more `visit_*` methods, you can have access to more nodes in the tree. The default behavior is to walk every node in the tree. You can modify this behavior depending on how you implement the visitor node. If you want to stop visiting (like in the example above) you do nothing. If you want to visit specific child nodes, you would call `visit(child_node)`. If you want to visit all nodes (the default behavior) then you can simply call `super`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/onigmo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rake/testtask"
+
+desc("Create tmp directory")
+directory("tmp")
+
+desc("Clone onigmo repository")
+directory("tmp/onigmo" => "tmp") do
+  sh("git clone --depth 1 https://github.com/k-takata/Onigmo.git tmp/onigmo")
+end
+
+onigmo_headers = ["regenc.h", "regint.h", "regparse.h"]
+onigmo_headers.each do |filepath|
+  desc("Download #{filepath} from onigmo repository")
+  file("tmp/onigmo/#{filepath}" => "tmp/onigmo")
+
+  desc("Copy #{filepath} from onigmo repository")
+  file("ext/onigmo/#{filepath}" => "tmp/onigmo/#{filepath}") do
+    cp("tmp/onigmo/#{filepath}", "ext/onigmo/#{filepath}")
+  end
+end
+
+Rake::ExtensionTask.new(:compile) do |ext|
+  ext.name = "onigmo"
+  ext.ext_dir = "ext/onigmo"
+  ext.lib_dir = "lib/onigmo"
+  ext.gem_spec = Gem::Specification.load("onigmo.gemspec")
+end
+
+Rake::Task[:compile].prerequisites.prepend(
+  *onigmo_headers.map { |filepath| "ext/onigmo/#{filepath}" }
+)
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+Rake::Task[:test].enhance([:compile])
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "onigmo"
+
+require "irb"
+IRB.start(__FILE__)

data/ext/onigmo/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+append_cflags("-Wno-missing-noreturn")
+
+create_makefile("onigmo/onigmo")