ragel-array 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe7ed3c97764104c7e645280b9df9f4457ae8a28ab1fd91a4aa3d3718187145f
+  data.tar.gz: 3605f316ddd0054784600675d9deb261c3b6c823a613c65e88dc260069d52afb
+SHA512:
+  metadata.gz: 2b60f7c6083538be741565396d7c00ff00724f03cb72dfd85f1f27dfe56693dbf88714873cb9d0eac3f3e6ce077853530e7ca4c8e83c6edabe4d0babaf48a183
+  data.tar.gz: 7244adf30c20bfb6a8e8a4efe2fe16826f22b95ef939eccf2db2c3527ac5ad9280ed2c4aa10bbbff419b8ef98fbc038d55210310d51998d0cfa608b18766bbb2

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Main
+on: push
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Lint and test
+      run: |
+        bundle exec rubocop --parallel
+        bundle exec rake test

data/.gitignore

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

data/.mergify.yml

@@ -0,0 +1,10 @@
+pull_request_rules:
+  - name: Automatically merge dependencies
+    conditions:
+      - base=master
+      - label=dependencies
+      - status-success=CI
+    actions:
+      merge:
+        strict: true
+      delete_head_branch: {}

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+  - '{tmp,vendor,yard}/**/*'
+  - 'test/ragel/fixtures/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 80
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: false

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 kevin.deisz@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,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    ragel-array (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rake-compiler (1.1.1)
+      rake
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2)
+  minitest (~> 5)
+  ragel-array!
+  rake (~> 13)
+  rake-compiler (~> 1)
+  rubocop (~> 0.90)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present Kevin Deisz
+
+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,52 @@
+# Ragel::array
+
+[![Build Status](https://github.com/kddeisz/ragel-array/workflows/Main/badge.svg)](https://github.com/kddeisz/ragel-array/actions)
+[![Gem Version](https://img.shields.io/gem/v/ragel-array.svg)](https://rubygems.org/gems/ragel-array)
+
+[Ragel](https://www.colm.net/open-source/ragel/) generates ruby code with very large arrays of integers that allocate a lot of memory when required. To reduce memory consumption, this gem replaces those arrays with strings that transform into native `uint32_t` arrays.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ragel-array'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ragel-array
+
+## Usage
+
+After you've run `ragel` to generate your parser, you should then run this gem over the resulting source file and it will replace the integer arrays inline. For example, the following code adds a rake rule to generate the ragel parser from the grammar file and then run `Ragel::Array` over it:
+
+```ruby
+rule %r|_parser\.rb\z| => '%X.rl' do |t|
+  sh "ragel -s -R -L -F1 -o #{t.name} #{t.source}"
+  require 'ragel/array'
+  Ragel::Array.replace(t.name)
+end
+```
+
+Then, in your application, add `require 'ragel/array'` before you require your parser. Now you should be off and running!
+
+We also provide a `ragel-array` command that you can execute once this gem is installed. Usage looks like `ragel-array [path]` where `path` is a path to a generated ragel parser.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/kddeisz/ragel-array.
+
+## 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,22 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new(:compile) do |ext|
+  ext.name = 'ragel_array'
+  ext.ext_dir = 'ext/ragel/array'
+  ext.lib_dir = 'lib/ragel/array'
+  ext.gem_spec = Gem::Specification.load('ragel-array.gemspec')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+Rake::Task[:test].prerequisites << :compile
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ragel/array'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/ragel-array

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ragel/array'
+
+Ragel::Array.replace(ARGV[0])

data/ext/ragel/array/extconf.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+create_makefile('ragel/array/ragel_array')

data/ext/ragel/array/ragel_array.c

@@ -0,0 +1,66 @@
+#include <ruby.h>
+
+typedef struct ragel_array {
+  uint32_t *data;
+  size_t size;
+} ragel_array_t;
+
+static void ragel_array_deallocate(ragel_array_t *array) {
+  free(array->data);
+  free(array);
+}
+
+static VALUE ragel_array_allocate(VALUE klass) {
+  ragel_array_t *array = malloc(sizeof(ragel_array_t));
+
+	return Data_Wrap_Struct(klass, NULL, ragel_array_deallocate, array);
+}
+
+static VALUE ragel_array_initialize(VALUE self, VALUE rb_string, VALUE rb_size) {
+  Check_Type(rb_string, T_STRING);
+  Check_Type(rb_size, T_FIXNUM);
+
+  ragel_array_t *array;
+  Data_Get_Struct(self, ragel_array_t, array);
+
+  long size = FIX2LONG(rb_size);
+  array->data = calloc(size, sizeof(uint32_t));
+  array->size = size;
+
+  char *string = StringValueCStr(rb_string);
+  long length = RSTRING_LEN(rb_string);
+  char buffer[5];
+
+  for (long data_index = 0, num_start = 0, num_end = 0; data_index < size; data_index += 1) {
+    while (string[num_end++] != ' ' && num_end < length);
+    strncpy(buffer, string + num_start, num_end - num_start);
+
+    array->data[data_index] = (uint32_t) atoi(buffer);
+    num_start = num_end;
+  }
+
+  return self;
+}
+
+static VALUE ragel_array_get(VALUE self, VALUE rb_index) {
+  Check_Type(rb_index, T_FIXNUM);
+
+  ragel_array_t *array;
+  Data_Get_Struct(self, ragel_array_t, array);
+
+  long index = FIX2LONG(rb_index);
+  if (index < 0 || (unsigned) index >= array->size) {
+    return Qnil;
+  }
+
+  return LONG2FIX(array->data[index]);
+}
+
+void Init_ragel_array(void) {
+  VALUE rb_cRagel = rb_define_module("Ragel");
+  VALUE rb_cRagelArray = rb_define_class_under(rb_cRagel, "Array", rb_cObject);
+
+  rb_define_alloc_func(rb_cRagelArray, ragel_array_allocate);
+  rb_define_method(rb_cRagelArray, "initialize", ragel_array_initialize, 2);
+  rb_define_method(rb_cRagelArray, "[]", ragel_array_get, 1);
+}

data/lib/ragel/array.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'ragel/array/version'
+require 'ragel/array/ragel_array'
+
+module Ragel
+  class Array
+    def self.replace(filepath)
+      require 'ragel/array/replace'
+
+      File.write(filepath, Replace.replace(File.read(filepath)))
+    end
+  end
+end

data/lib/ragel/array/replace.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'ripper'
+
+module Ragel
+  class Array
+    class Replace < Ripper::SexpBuilderPP
+      class Table
+        attr_reader :source, :start_line, :end_line
+
+        def initialize(left, right, lineno)
+          @source = source_from(left[3][1], right[1].map { |int| int[1].to_i })
+          @start_line = left[1][1][2][0] - 1
+          @end_line = lineno
+        end
+
+        private
+
+        def source_from(name, numbers)
+          "self.#{name} = " \
+            "::Ragel::Array.new(\"#{numbers.join(' ')}\", #{numbers.length})"
+        end
+      end
+
+      class Buffer
+        attr_reader :lines
+
+        def initialize(source)
+          @lines = source.split("\n")
+        end
+
+        def replace(table)
+          buffer = lines[table.start_line][/\A\s+/]
+          source = ["#{buffer}#{table.source}"]
+          @lines =
+            lines[0...table.start_line] + source + lines[table.end_line..-1]
+        end
+
+        def to_source
+          "#{lines.join("\n")}\n"
+        end
+      end
+
+      attr_reader :tables
+
+      def initialize(*)
+        super
+        @tables = []
+      end
+
+      def each_table(&block)
+        parse
+
+        if error?
+          warn 'Invalid ruby'
+          exit 1
+        end
+
+        tables.reverse_each(&block)
+      end
+
+      def self.replace(source)
+        buffer = Buffer.new(source)
+        new(source).each_table { |table| buffer.replace(table) }
+        buffer.to_source
+      end
+
+      private
+
+      def on_assign(left, right)
+        super.tap do
+          next if left[0] != :field || right[0] != :array
+
+          tables << Table.new(left, right, lineno)
+        end
+      end
+    end
+  end
+end

data/lib/ragel/array/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ragel
+  class Array
+    VERSION = '0.1.0'
+  end
+end

data/ragel-array.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ragel/array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ragel-array'
+  spec.version       = Ragel::Array::VERSION
+  spec.authors       = ['Kevin Deisz']
+  spec.email         = ['kevin.deisz@gmail.com']
+
+  spec.summary       = 'Provides an efficient uint8_t array'
+  spec.homepage      = 'https://github.com/kddeisz/ragel-array'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/ragel/array/extconf.rb']
+
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rake-compiler', '~> 1'
+  spec.add_development_dependency 'rubocop', '~> 0.90'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ragel-array
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+description:
+email:
+- kevin.deisz@gmail.com
+executables:
+- ragel-array
+extensions:
+- ext/ragel/array/extconf.rb
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".mergify.yml"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ragel-array
+- ext/ragel/array/extconf.rb
+- ext/ragel/array/ragel_array.c
+- lib/ragel/array.rb
+- lib/ragel/array/replace.rb
+- lib/ragel/array/version.rb
+- ragel-array.gemspec
+homepage: https://github.com/kddeisz/ragel-array
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Provides an efficient uint8_t array
+test_files: []