marshal-parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54bc27a08a2e25692ac3b0ccf449b6db7df3af095eff14a2c94c91545502721f
+  data.tar.gz: 0b803be1bde2b3d51d5023c51db1042b9b41eebc341f1d9c29e9c7c2e39e9aa8
+SHA512:
+  metadata.gz: fca493db638e427e393d252b32e01a7be43bc4f9e2090d2b23492e5997c3b671d3734534054039dee19aeb8667b9291e74e098d4c85a3a1bbefaf79df7037fd4
+  data.tar.gz: cc2bcab736f4a53aec056e7d52dbe282100223641c8b57bff64e8fba3ea00995fddbdcfb3a8c5e1c848a148ebe784fb90937e8dff9b7bb3f9948d16e5b317528

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at andry.konchin@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Andrew Konchin
+
+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,202 @@
+# marshal-parser
+
+`marshal-parser` is a library that allows you to read and analyze data
+that has been serialized in Ruby's Marshal format. It is built for
+educational purposes, but can also be a handy tool for learning the
+Marshal format or even for investigating bugs in its implementation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'marshal-parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install marshal-parser
+
+## What is the Marshal format?
+
+The Marshal format is a binary format used in Ruby to serialize Ruby
+objects. The format can store arbitrary objects through three
+user-defined extension mechanisms. The serialized data can be stored in
+a file or transmitted over a network, and then deserialized back into a
+Ruby object.
+
+The Marshal format is described here <https://ruby-doc.org/core-3.1.0/doc/marshal_rdoc.html>.
+
+There are also a lot of useful articles, for instance:
+- <https://shopify.engineering/caching-without-marshal-part-one>
+- <https://iliabylich.github.io/2016/01/25/ruby-marshalling-from-a-to-z.html>
+- <http://jakegoulding.com/blog/categories/marshal/>
+
+## Features
+
+There are a couple of uniq features that makes it stand out from the
+croud:
+
+- comprehensive support of the Marshal format
+- CLI to parse existing dumps
+- several output formats with different detalization levels
+
+## Usage
+
+The primary way to use `marshal-parser` is to run the CLI script `marshal-cli`.
+
+### Tokens
+
+To print tokens separated by whitespaces, use the `tokens` command,
+followed by the `--evaluate` flag and a Ruby expression which value you
+want to dump and parse:
+
+    marshal-cli tokens --evaluate '[true, false, 0]'
+
+This will output:
+
+    "\x04\b" [ "\b" T F i "\x00"
+
+To print descriptions for each token, use the `--annotate` flag:
+
+    marshal-cli tokens --evaluate '[true, false, 0]' --annotate
+
+This will output:
+
+    "\x04\b"   - Version (4.8)
+    "["        - Array beginning
+    "\b"       - Integer encoded (3)
+    "T"        - true
+    "F"        - false
+    "i"        - Integer beginning
+    "\x00"     - Integer encoded (0)
+
+### AST
+
+To print the AST or structure of a Marshal dump, use the `ast` command,
+followed by the `--evaluate` flag:
+
+    marshal-cli ast --evaluate '[true, false, 0]'
+
+This will output:
+
+    (array
+      (length 3)
+      (true)
+      (false)
+      (integer
+        (value 0)))
+
+The AST is printed in a kind of S-expressions form. Both nodes (e.g. `array`,
+`integer`...) and attributes (`length`) are printed.
+
+To print only the nodes, use the `--compact` flag:
+
+    marshal-cli --evaluate '[true, false, 0]' --compact
+
+This will output:
+
+    (array
+      true
+      false
+      (integer 0))
+
+To print the AST as tokens, use the `--only-tokens` option:
+
+    marshal-cli ast --evaluate '[true, false, 0]' --only-tokens
+
+This will output:
+
+    [
+      "\b"
+      T
+      F
+      i "\x00"
+
+### Other flags
+
+To list all the available flags use the `--help` flag for each command:
+
+    marshal-cli tokens --help
+    marshal-cli ast --help
+    marshal-cli --help
+
+### Ruby library
+
+To use `marshal-parser` as a Ruby library the following examples will be
+useful:
+
+Use `MarshalParser::Lexer` class to get tokens:
+
+```ruby
+require 'marshal-parser'
+
+dump = Marshal.dump(1)
+lexer = MarshalParser::Lexer.new(dump)
+lexer.run
+
+pp lexer.tokens
+```
+
+This will output:
+
+    [#<struct MarshalParser::Lexer::Token id=0, index=0, length=2, value="4.8">,
+     #<struct MarshalParser::Lexer::Token id=14, index=2, length=1, value=nil>,
+     #<struct MarshalParser::Lexer::Token id=25, index=3, length=1, value=1>]
+
+Use `MarshalParser::Parser` class to get the AST:
+
+```ruby
+require 'marshal-parser'
+
+dump = Marshal.dump(1)
+lexer = MarshalParser::Lexer.new(dump)
+lexer.run
+
+parser = MarshalParser::Parser.new(lexer)
+ast = parser.parse
+
+puts ast
+```
+
+This will output:
+
+    #<MarshalParser::Parser::IntegerNode:0x000000010daba4d8
+     @prefix=#<struct MarshalParser::Lexer::Token id=14, index=2, length=1, value=nil>,
+     @value=#<struct MarshalParser::Lexer::Token id=25, index=3, length=1, value=1>>
+
+## Limitations
+
+- Only supports current format version 4.8
+- Does not support a deprecated node 'M' (that represents Class or Module)
+- Does not support a 'd' node (Data object, that represents wrapped pointers from Ruby extensions)
+- Doesn't print in annotations object indices (because Ruby is not consistent here and object indices assigning order may
+vary depending on dumped class)
+
+## Similar projects
+
+There are several projects that might be interesting as well:
+- <https://github.com/iliabylich/pure_ruby_marshal>
+- <https://github.com/drbrain/marshal-structure>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/andrykonchin/marshal-parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrykonchin/marshal-parser/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the marshal-parser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrykonchin/marshal-parser/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "marshal-parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/marshal-cli

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "marshal-parser"
+
+Dry::CLI.new(MarshalParser::CLI::Commands).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/marshal-parser/assertable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Assertable
+    def assert(boolean, message)
+      raise "Assert failed: #{message}" unless boolean
+    end
+  end
+end

data/lib/marshal-parser/cli/commands.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "dry/cli"
+
+module MarshalParser
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Tokens < Dry::CLI::Command
+        desc "Parse a dump and print tokens. By default reads dump from the stdin."
+        option :file,     type: :string,  aliases: ["-f"], desc: "Read a dump from file with provided name"
+        option :evaluate, type: :string,  aliases: ["-e"], desc: "Ruby expression to dump"
+        option :annotate, type: :boolean, aliases: ["-a"], desc: "Print a table with annonated tokens"
+
+        def call(**options)
+          dump = \
+            if options[:file]
+              File.read(options[:file])
+            elsif options[:evaluate]
+              Marshal.dump(eval(options[:evaluate]))
+            else
+              $stdin.read
+            end
+
+          lexer = MarshalParser::Lexer.new(dump)
+          lexer.run
+
+          formatter = \
+            if options[:annotate]
+              MarshalParser::Formatters::Tokens::WithDescription.new(lexer.tokens, dump)
+            else
+              MarshalParser::Formatters::Tokens::OneLine.new(lexer.tokens, dump)
+            end
+
+          puts formatter.string
+        end
+      end
+
+      class AST < Dry::CLI::Command
+        desc "Parse a dump and print AST. By default reads dump from the stdin and uses S-expressions format."
+        option :file,          type: :string,  aliases: ["-f"], desc: "Read a dump from file with provided name"
+        option :evaluate,      type: :string,  aliases: ["-e"], desc: "Ruby expression to dump"
+        option :"only-tokens", type: :boolean, aliases: ["-o"], desc: "Print only tokens"
+        option :annotate,      type: :boolean, aliases: ["-a"], desc: "Print annotations"
+        option :width,         type: :string,  aliases: ["-w"],
+                               desc: "Width of the column with AST, used with --annotate"
+        option :symbols,       type: :boolean, aliases: ["-s"], desc: "Print a table of symbols"
+        option :compact,       type: :boolean, aliases: ["-c"], desc: "Don't print node attributes"
+
+        def call(**options)
+          dump = \
+            if options[:file]
+              File.read(options[:file])
+            elsif options[:evaluate]
+              Marshal.dump(eval(options[:evaluate]))
+            else
+              $stdin.read
+            end
+
+          lexer = Lexer.new(dump)
+          lexer.run
+
+          parser = Parser.new(lexer)
+          ast = parser.parse
+
+          renderer = \
+            if options[:annotate]
+              width = options[:width] ? Integer(options[:width]) : 50
+              MarshalParser::Formatters::AST::Renderers::RendererWithAnnotations.new(indent_size: 2, width: width)
+            else
+              MarshalParser::Formatters::AST::Renderers::Renderer.new(indent_size: 2)
+            end
+
+          formatter = \
+            if options[:"only-tokens"]
+              MarshalParser::Formatters::AST::OnlyTokens.new(ast, dump, renderer)
+            elsif options[:compact]
+              MarshalParser::Formatters::AST::SExpressionCompact.new(ast, dump, renderer)
+            else
+              MarshalParser::Formatters::AST::SExpression.new(ast, dump, renderer)
+            end
+
+          puts formatter.string
+
+          if options[:symbols]
+            symbols = parser.symbols
+            puts ""
+            puts "Symbols table:"
+            puts MarshalParser::Formatters::Symbols::Table.new(symbols).string
+          end
+        end
+      end
+
+      class Version < Dry::CLI::Command
+        desc "Print version"
+
+        def call(**)
+          puts MarshalParser::VERSION
+        end
+      end
+
+      register "tokens",  Tokens,   aliases: ["t"]
+      register "ast",     AST,      aliases: ["a"]
+      register "version", Version,  aliases: ["v", "-v", "--version"]
+    end
+  end
+end

data/lib/marshal-parser/formatters/ast/only_tokens.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Formatters
+    module AST
+      class OnlyTokens
+        def initialize(node, source_string, renderer)
+          @node = node
+          @source_string = source_string
+          @renderer = renderer
+        end
+
+        def string
+          entries = node_to_entries(@node)
+          block = Renderers::EntriesBlock.new(entries)
+          @renderer.render(block)
+        end
+
+        private
+
+        def node_to_entries(node)
+          entries = node.child_entities.map do |child|
+            case child
+            when Lexer::Token
+              string = @source_string[child.index, child.length]
+              string = string.dump if string =~ /[^[:print:]]/ # TODO: How to detect \n, \r etc that may break formatting?
+
+              Renderers::Line.new(string)
+            when Parser::Node
+              node_to_entries(child)
+            else
+              raise "Unexpected node child entity #{child}"
+            end
+          end.flatten
+
+          # short oneline form, e.g. for Symbol - (: "\x06" E)
+          if node.children.empty?
+            # ignore "" as the last token and strip inserted whitespace
+            string = entries.map(&:string).join(" ").strip
+            entries = [Renderers::Line.new(string)]
+          end
+
+          raise "Expected 1st entry to be Line" unless entries[0].is_a?(Renderers::Line)
+
+          if node.is_a?(Parser::Annotatable)
+            string = entries[0].string
+            annotation = node.annotation
+            entries[0] = Renderers::LineAnnotated.new(string, annotation)
+          end
+
+          if entries.size > 1
+            [entries[0], Renderers::EntriesBlock.new(entries[1..])]
+          else
+            entries
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marshal-parser/formatters/ast/renderers/entries_block.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Formatters
+    module AST
+      module Renderers
+        class EntriesBlock
+          attr_reader :entries
+
+          def initialize(entries)
+            @entries = entries
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marshal-parser/formatters/ast/renderers/line.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Formatters
+    module AST
+      module Renderers
+        class Line
+          attr_reader :string
+
+          def initialize(string)
+            @string = string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marshal-parser/formatters/ast/renderers/line_with_annotation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Formatters
+    module AST
+      module Renderers
+        class LineAnnotated < Line
+          attr_reader :annotation
+
+          def initialize(string, annotation)
+            super(string)
+            @annotation = annotation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marshal-parser/formatters/ast/renderers/renderer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Formatters
+    module AST
+      module Renderers
+        class Renderer
+          def initialize(indent_size:)
+            @indent_size = indent_size
+          end
+
+          def render(block)
+            lines = apply_indentation(block, 0)
+            strings = lines.map(&:string)
+            strings.join("\n")
+          end
+
+          private
+
+          def apply_indentation(block, level)
+            indentation = " " * @indent_size * level
+
+            block.entries.map do |e|
+              case e
+              when Line
+                Line.new(indentation + e.string)
+              when EntriesBlock
+                apply_indentation(e.entries, level + 1)
+              else
+                raise "Unexpected entry #{e} (#{e.class}), expected Line or EntriesBlock"
+              end
+            end.flatten
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marshal-parser/formatters/ast/renderers/renderer_with_annotations.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MarshalParser
+  module Formatters
+    module AST
+      module Renderers
+        class RendererWithAnnotations
+          def initialize(indent_size:, width:)
+            @indent_size = indent_size
+            @width = width
+          end
+
+          def render(block)
+            # indent
+            lines = apply_indentation(block, 0)
+
+            # add annotations
+            strings = lines.map do |line|
+              case line
+              when LineAnnotated
+                "%-#{@width}s # %s" % [line.string, line.annotation]
+              when Line
+                line.string
+              else
+                raise "Unexpected line #{e} (#{e.class}), expected Line or LineAnnotated"
+              end
+            end
+
+            strings.join("\n")
+          end
+
+          private
+
+          def apply_indentation(block, level)
+            indentation = " " * @indent_size * level
+
+            block.entries.map do |e|
+              case e
+              when LineAnnotated
+                LineAnnotated.new(indentation + e.string, e.annotation)
+              when Line
+                Line.new(indentation + e.string)
+              when EntriesBlock
+                apply_indentation(e.entries, level + 1)
+              end
+            end.flatten
+          end
+        end
+      end
+    end
+  end
+end