ragel-bitmap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aceb3e68e482270337fa3a13a01c176df168731cbb129f7dca0d42a7a999fcb8
-  data.tar.gz: 9891faf2710a410ba99a2a9f40ed8aa7fd06f239a77312b1a76199d03236d653
+  metadata.gz: '092e46dd50337f51b96bc571bcabb3cb157c903a65469256f923df24006dcca4'
+  data.tar.gz: 965528c96ccd950bbd515dd57cf7213debeacb1a1f2531b22fc503e4c991401d
 SHA512:
-  metadata.gz: 2f92c6dee162edfeb0a2e5c09745e08c03797ced2f704fefbd1b89d1aaa5fd1ee8f8252cc8dbc4cfb5c8a4f5d38dbfa00be7579f87e704a71c765637422065ba
-  data.tar.gz: 5e4f050c199ae16bd4008bfb4ff06fb0a515109a8ceb8832195b3117c6737cd9d90b7b14912fc2bc223630ae53503f5608162cb10262d472a7053adfd85a1f84
+  metadata.gz: 0b27d046b012d2305cf884abc5c012724b40aaec5095c41aed8f19cd3ed2536cb23c5e878d79cdcd8c55f51d137adc5a481014e139cb76b2dcca3fb5535d6a49
+  data.tar.gz: e693f71d64e87a3c7cf25d30c554afc059ca288911feb7e3c3ad0835dc641f800c19d50df24eec78b8a4aa996a9d4e076981f7ec64adc589fd84a82ba07ed1e0

data/.rubocop.yml

@@ -5,3 +5,6 @@ AllCops:
   Exclude:
   - 'test/ragel/fixtures/*'
   - 'vendor/**/*'
+
+Style/Documentation:
+  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.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    ragel-bitmap (0.1.0)
+    ragel-bitmap (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    jaro_winkler (1.5.2)
+    jaro_winkler (1.5.3)
     minitest (5.11.3)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (12.3.2)
-    rubocop (0.70.0)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -32,7 +32,7 @@ DEPENDENCIES
   minitest (~> 5.11)
   ragel-bitmap!
   rake (~> 12.3)
-  rubocop (~> 0.70)
+  rubocop (~> 0.72)
 
 BUNDLED WITH
    2.0.1

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Kevin Deisz
+Copyright (c) 2019-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

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.com/kddeisz/ragel-bitmap.svg?branch=master)](https://travis-ci.com/kddeisz/ragel-bitmap)
 
-Use bitmaps for ragel-generated code instead of arrays.
+[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 packed strings.
 
 ## Installation
 
@@ -22,7 +22,17 @@ Or install it yourself as:
 
 ## Usage
 
-Use `Ragel::Bitmap.replace(filepath)` where `filepath` is a path to a ragel-generated file. Require `ragel/bitmap` in your code. Profit!
+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::Bitmap` 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/bitmap'
+  Ragel::Bitmap.replace(t.name)
+end
+```
+
+Then, in your application, add `require 'ragel/bitmap'` before you require your parser. Now you should be off and running!
 
 ## Development
 

data/lib/ragel/bitmap/replace.rb

@@ -3,10 +3,36 @@
 require 'ripper'
 
 module Ragel
-  class Bitmap
+  module Bitmap
     # A ruby parser that finds instances of table declarations in a
     # ragel-outputted file.
     class Replace < Ripper::SexpBuilderPP
+      class << self
+        # Get the required args for a bitmap from a set of numbers
+        def bitmap_args_from(numbers)
+          size = (Math.log2(numbers.max) / 8).ceil
+          strings =
+            size.downto(1).map do |index|
+              shift = (index - 1) * 8
+              numbers.map { |number| (number >> shift) & 0xff }.pack('C*')
+            end
+
+          [class_from(size), strings]
+        end
+
+        private
+
+        def class_from(size)
+          case size
+          when 1 then :Array8
+          when 2 then :Array16
+          when 3 then :Array24
+          else
+            :ArrayGeneric
+          end
+        end
+      end
+
       # Represents a table declaration in the source
       class Table
         attr_reader :source, :start_line, :end_line
@@ -17,14 +43,13 @@ module Ragel
           @end_line = lineno
         end
 
+        private
+
         def source_from(name, numbers)
-          width = Math.log2(numbers.max).ceil
-          bitmap =
-            numbers.each_with_index.inject(0) do |accum, (number, index)|
-              accum | (number << (width * index))
-            end
+          clazz, strings = Replace.bitmap_args_from(numbers)
+          arguments = strings.map(&:inspect).join(', ')
 
-          "self.#{name} = ::Ragel::Bitmap.new(#{width}, #{bitmap})"
+          "self.#{name} = ::Ragel::Bitmap::#{clazz}.new(#{arguments})"
         end
       end
 
@@ -56,26 +81,21 @@ module Ragel
         @tables = []
       end
 
-      class << self
-        def replace(source)
-          buffer = Buffer.new(source)
-          tables_from(source).reverse_each { |table| buffer.replace(table) }
-          buffer.to_source
-        end
+      def each_table(&block)
+        parse
 
-        private
-
-        def tables_from(source)
-          replace = new(source)
-          replace.parse
+        if error?
+          warn 'Invalid ruby'
+          exit 1
+        end
 
-          if replace.error?
-            warn 'Invalid ruby'
-            exit 1
-          end
+        tables.reverse_each(&block)
+      end
 
-          replace.tables
-        end
+      def self.replace(source)
+        buffer = Buffer.new(source)
+        new(source).each_table { |table| buffer.replace(table) }
+        buffer.to_source
       end
 
       private

data/lib/ragel/bitmap/version.rb

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

data/lib/ragel/bitmap.rb

@@ -3,19 +3,54 @@
 require 'ragel/bitmap/version'
 
 module Ragel
-  # An integer bitmap that contains a width (the number of bytes that the
-  # largest integer requires) and a bitmap (an integer that is the combination
-  # of the element integers)
-  class Bitmap
-    attr_reader :width, :bitmap
-
-    def initialize(width, bitmap)
-      @width = width
-      @bitmap = bitmap
+  module Bitmap
+    class Array8
+      def initialize(string)
+        @string = string
+      end
+
+      def [](idx)
+        @string.getbyte(idx)
+      end
+    end
+
+    class Array16
+      def initialize(highstring, lowstring)
+        @highstring = highstring
+        @lowstring = lowstring
+      end
+
+      def [](idx)
+        (@highstring.getbyte(idx) << 8) | @lowstring.getbyte(idx)
+      end
     end
 
-    def [](index)
-      (bitmap >> (width * index)) & (2**width - 1)
+    class Array24
+      def initialize(highstring, middlestring, lowstring)
+        @highstring = highstring
+        @middlestring = middlestring
+        @lowstring = lowstring
+      end
+
+      def [](idx)
+        (@highstring.getbyte(idx) << 16) |
+          (@middlestring.getbyte(idx) << 8) |
+          @lowstring.getbyte(idx)
+      end
+    end
+
+    class ArrayGeneric
+      def initialize(*strings)
+        @strings = strings
+      end
+
+      def [](idx)
+        shift = @strings.length * 8
+        @strings.inject(0) do |product, bitmap|
+          shift -= 8
+          product | (bitmap.getbyte(idx) << shift)
+        end
+      end
     end
 
     def self.replace(filepath)

data/ragel-bitmap.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.11'
   spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rubocop', '~> 0.70'
+  spec.add_development_dependency 'rubocop', '~> 0.72'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ragel-bitmap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.70'
+        version: '0.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.70'
+        version: '0.72'
 description: 
 email:
 - kevin.deisz@gmail.com
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE