syntax_tree-json 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e254feef0c7698c445f1f926957850da544b82e3d708a4dced11fad5df81de94
-  data.tar.gz: 868de6d426b3a22e66f8ddf8e09df6756ca020cf808bd30d909f8994acfd0bef
+  metadata.gz: c676b951d917802a8fde6f1f143a31f1709c32567cb8e9863012366da44ce4d5
+  data.tar.gz: f6341a94367cb2e1d071683a522cf2458fa37f3e56a9bc7fc9abfc38efa6c476
 SHA512:
-  metadata.gz: fc062e3bba849e2948de7219e075b4c06c05b49465b2acfbe0237227989a3847f58031424631fb8954ea31e91e100856d66ede53984fb51033438af13f63e95f
-  data.tar.gz: 5fa6ffe9d9bc18f560e160556369e7717cacd5cf8a0eb172b9f6e33d0d812b51a78e24466ae2ef80bb03c2952cca71a864dab9033d74112ba68adbc87f6e1480
+  metadata.gz: 3c70f7298f8292e2b3759d33afb2028f3d550207cba7de7ac02b1fa6ab1f03f1a2914a8258e84f94710bd3ee6dbc4fa6ade42e67fda6e13476b1cbc1a9f527a0
+  data.tar.gz: d390116edbbdf9169be5d6734b7532e467eaaf684031fa74e8b5f7ad16dba03a438763fa1924e73fd9f4cd1202f6b7ec951607f79069ee1b3b96d7b13bb67e87

data/.github/dependabot.yml

@@ -4,3 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/main.yml

@@ -1,7 +1,8 @@
 name: Main
 on:
 - push
-- pull_request_target
+- pull_request
+
 jobs:
   ci:
     name: CI
@@ -10,23 +11,15 @@ jobs:
       CI: true
     steps:
     - uses: actions/checkout@master
+      with:
+          submodules: recursive
+
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
         ruby-version: '3.1'
+
     - name: Test
-      run: bundle exec rake test
-  automerge:
-    name: AutoMerge
-    needs: ci
-    runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
-    steps:
-    - uses: actions/github-script@v3
-      with:
-        script: |
-          github.pulls.merge({
-            owner: context.payload.repository.owner.login,
-            repo: context.payload.repository.name,
-            pull_number: context.payload.pull_request.number
-          })
+      run: |
+        bundle exec rake test
+        bundle exec rake stree:check

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/JSONTestSuite"]
+	path = test/JSONTestSuite
+	url = git@github.com:nst/JSONTestSuite.git

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.3.0] - 2022-08-09
+
+### Changed
+
+- Dropped `json` as a dependency, doing all parsing in-gem.
+
 ## [0.2.0] - 2022-05-13
 
 ### Changed

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree-json (0.2.0)
-      json
+    syntax_tree-json (0.3.0)
       prettier_print
       syntax_tree (>= 2.0.1)
 
@@ -10,8 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    json (2.6.1)
-    minitest (5.15.0)
+    minitest (5.16.2)
     prettier_print (0.1.0)
     rake (13.0.6)
     simplecov (0.21.2)
@@ -20,10 +18,11 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    syntax_tree (2.5.0)
+    syntax_tree (3.3.0)
       prettier_print
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-21
   x86_64-linux
 

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "syntax_tree/rake_tasks"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+SOURCE_FILES =
+  FileList[%w[Gemfile Rakefile syntax_tree-json.gemspec lib/**/*.rb test/*.rb]]
+
+SyntaxTree::Rake::CheckTask.new { |t| t.source_files = SOURCE_FILES }
+SyntaxTree::Rake::WriteTask.new { |t| t.source_files = SOURCE_FILES }
+
 task default: :test

data/lib/syntax_tree/json/ast.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module JSON
+    module AST
+      # This is the parent node of all of the nodes in the AST.
+      class Node
+        def format(q)
+          accept(Format.new(q))
+        end
+
+        def pretty_print(q)
+          accept(PrettyPrint.new(q))
+        end
+      end
+
+      # This represents an array in the tree.
+      class Array < Node
+        attr_reader :values
+
+        def initialize(values:)
+          @values = values
+        end
+
+        def accept(visitor)
+          visitor.visit_array(self)
+        end
+
+        def child_nodes
+          values
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          { values: values }
+        end
+      end
+
+      # This represents a false in the tree.
+      class False < Node
+        def accept(visitor)
+          visitor.visit_false(self)
+        end
+
+        def child_nodes
+          []
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          {}
+        end
+      end
+
+      # This represents a null in the tree.
+      class Null < Node
+        def accept(visitor)
+          visitor.visit_null(self)
+        end
+
+        def child_nodes
+          []
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          {}
+        end
+      end
+
+      # This represents a number in the tree.
+      class Number < Node
+        attr_reader :value
+
+        def initialize(value:)
+          @value = value
+        end
+
+        def accept(visitor)
+          visitor.visit_number(self)
+        end
+
+        def child_nodes
+          []
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          { value: value }
+        end
+      end
+
+      # This represents an object in the tree.
+      class Object < Node
+        attr_reader :values
+
+        def initialize(values:)
+          @values = values
+        end
+
+        def accept(visitor)
+          visitor.visit_object(self)
+        end
+
+        def child_nodes
+          values.values
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          { values: values }
+        end
+      end
+
+      # This is the top of the JSON syntax tree.
+      class Root < Node
+        attr_reader :value
+
+        def initialize(value:)
+          @value = value
+        end
+
+        def accept(visitor)
+          visitor.visit_root(self)
+        end
+
+        def child_nodes
+          [value]
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          { value: value }
+        end
+      end
+
+      # This represents a string in the tree.
+      class String < Node
+        attr_reader :value
+
+        def initialize(value:)
+          @value = value
+        end
+
+        def accept(visitor)
+          visitor.visit_string(self)
+        end
+
+        def child_nodes
+          []
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          { value: value }
+        end
+      end
+
+      # This represents a true in the tree.
+      class True < Node
+        def accept(visitor)
+          visitor.visit_true(self)
+        end
+
+        def child_nodes
+          []
+        end
+
+        alias deconstruct child_nodes
+
+        def deconstruct_keys(keys)
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/syntax_tree/json/format.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module JSON
+    # This class is a visitor responsible for formatting the AST.
+    class Format < Visitor
+      attr_reader :q
+
+      def initialize(q)
+        @q = q
+      end
+
+      # Visit an AST::Array node.
+      def visit_array(node)
+        q.group do
+          q.text("[")
+
+          q.indent do
+            q.breakable("")
+            q.seplist(node.values) { |value| visit(value) }
+          end
+
+          q.breakable("")
+          q.text("]")
+        end
+      end
+
+      # Visit an AST::False node.
+      def visit_false(node)
+        q.text("false")
+      end
+
+      # Visit an AST::Null node.
+      def visit_null(node)
+        q.text("null")
+      end
+
+      # Visit an AST::Number node.
+      def visit_number(node)
+        q.text(node.value)
+      end
+
+      # Visit an AST::Object node.
+      def visit_object(node)
+        q.group do
+          q.text("{")
+
+          q.indent do
+            q.breakable
+            q.seplist(node.values, nil, :each_pair) do |key, value|
+              q.group do
+                q.text(key)
+                q.text(": ")
+                visit(value)
+              end
+            end
+          end
+
+          q.breakable
+          q.text("}")
+        end
+      end
+
+      # Visit an AST::Root node.
+      def visit_root(node)
+        visit(node.value)
+        q.breakable(force: true)
+      end
+
+      # Visit an AST::String node.
+      def visit_string(node)
+        q.text(node.value)
+      end
+
+      # Visit an AST::True node.
+      def visit_true(node)
+        q.text("true")
+      end
+    end
+  end
+end

data/lib/syntax_tree/json/parser.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module JSON
+    # This class is responsible for converting from a plain string input into
+    # an AST.
+    class Parser
+      class ParseError < StandardError
+      end
+
+      attr_reader :source
+
+      def initialize(source)
+        @source = source
+      end
+
+      def parse
+        if parse_item(make_tokens) in [value, []]
+          AST::Root.new(value: value)
+        else
+          raise ParseError, "unexpected tokens after value"
+        end
+      end
+
+      private
+
+      # This represents a parsed token from the source.
+      class Token
+        attr_reader :type, :value
+
+        def initialize(type:, value: nil)
+          @type = type
+          @value = value
+        end
+
+        def deconstruct_keys(keys)
+          { type: type, value: value }
+        end
+      end
+
+      def make_tokens
+        buffer = source.dup.force_encoding("UTF-8")
+        raise ParseError, "invalid UTF-8" unless buffer.valid_encoding?
+
+        tokens = []
+        buffer.gsub!(/\A\s+/, "")
+
+        until buffer.empty?
+          tokens << case buffer
+          in /\A[\{\}\[\],:]/
+            Token.new(type: $&.to_sym)
+          in /\A-?(0|[1-9]\d*)(\.\d+)?([Ee][-+]?\d+)?/
+            Token.new(type: :number, value: $&)
+          in %r{\A"[^"\\\t\n\x00]*(?:\\[bfnrtu\\/"][^"\\]*)*"}
+            Token.new(type: :string, value: $&)
+          in /\Atrue/
+            Token.new(type: :true)
+          in /\Afalse/
+            Token.new(type: :false)
+          in /\Anull/
+            Token.new(type: :null)
+          else
+            raise ParseError, "unexpected token: #{buffer[0]}"
+          end
+
+          buffer = $'.gsub(/\A\s+/, "")
+        end
+
+        tokens
+      end
+
+      def parse_array(tokens)
+        values = []
+
+        loop do
+          value, tokens = parse_item(tokens)
+          values << value
+
+          case tokens
+          in [Token[type: :"]"], *rest]
+            return AST::Array.new(values: values), rest
+          in [Token[type: :","], *rest]
+            tokens = rest
+          else
+            raise ParseError, "expected ',' or ']' after array value"
+          end
+        end
+      end
+
+      def parse_object(tokens)
+        values = {}
+
+        loop do
+          if tokens in [{ type: :string, value: key }, { type: :":" }, *tokens]
+            value, tokens = parse_item(tokens)
+            values[key] = value
+
+            case tokens
+            in [{ type: :"}" }, *rest]
+              return AST::Object.new(values: values), rest
+            in [{ type: :"," }, *rest]
+              tokens = rest
+            else
+              raise ParseError, "expected ',' or '}' after object value"
+            end
+          else
+            raise ParseError, "expected key and ':' after opening '{'"
+          end
+        end
+      end
+
+      def parse_item(tokens)
+        case tokens
+        in [{ type: :"[" }, { type: :"]" }, *rest]
+          [AST::Array.new(values: []), rest]
+        in [{ type: :"[" }, *rest]
+          parse_array(rest)
+        in [{ type: :"{" }, { type: :"}" }, *rest]
+          [AST::Object.new(values: {}), rest]
+        in [{ type: :"{" }, *rest]
+          parse_object(rest)
+        in [{ type: :false }, *rest]
+          [AST::False.new, rest]
+        in [{ type: :true }, *rest]
+          [AST::True.new, rest]
+        in [{ type: :null }, *rest]
+          [AST::Null.new, rest]
+        in [{ type: :string, value: value }, *rest]
+          [AST::String.new(value: value), rest]
+        in [{ type: :number, value: }, *rest]
+          [AST::Number.new(value: value), rest]
+        else
+          raise ParseError, "unexpected token: #{tokens.first&.type}"
+        end
+      end
+    end
+  end
+end

data/lib/syntax_tree/json/pretty_print.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module JSON
+    # This class is a visitor responsible for pretty-printing the AST.
+    class PrettyPrint < Visitor
+      attr_reader :q
+
+      def initialize(q)
+        @q = q
+      end
+
+      # Visit an AST::Array node.
+      def visit_array(node)
+        group("array") { field("values", node.values) }
+      end
+
+      # Visit an AST::False node.
+      def visit_false(node)
+        q.text("false")
+      end
+
+      # Visit an AST::Null node.
+      def visit_null(node)
+        q.text("null")
+      end
+
+      # Visit an AST::Number node.
+      def visit_number(node)
+        group("number") { field("value", node.value) }
+      end
+
+      # Visit an AST::Object node.
+      def visit_object(node)
+        group("object") { field("values", node.values) }
+      end
+
+      # Visit an AST::Root node.
+      def visit_root(node)
+        group("root") { field("value", node.value) }
+      end
+
+      # Visit an AST::String node.
+      def visit_string(node)
+        group("string") { field("value", node.value) }
+      end
+
+      # Visit an AST::True node.
+      def visit_true(node)
+        q.text("true")
+      end
+
+      private
+
+      def field(name, value)
+        q.breakable
+        q.text("#{name}=")
+        q.pp(value)
+      end
+
+      def group(name)
+        q.group do
+          q.text("(#{name}")
+          q.nest(2) { yield }
+          q.breakable("")
+          q.text(")")
+        end
+      end
+    end
+  end
+end

data/lib/syntax_tree/json/version.rb

@@ -2,6 +2,6 @@
 
 module SyntaxTree
   module JSON
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/syntax_tree/json/visitor.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module JSON
+    # This is the parent class of any visitors for this AST.
+    class Visitor
+      def visit(node)
+        node&.accept(self)
+      end
+
+      def visit_all(nodes)
+        nodes.map { |node| visit(node) }
+      end
+
+      def visit_child_nodes(node)
+        visit_all(node.child_nodes)
+      end
+
+      # Visit an AST::Array node.
+      alias visit_array visit_child_nodes
+
+      # Visit an AST::False node.
+      alias visit_false visit_child_nodes
+
+      # Visit an AST::Null node.
+      alias visit_null visit_child_nodes
+
+      # Visit an AST::Number node.
+      alias visit_number visit_child_nodes
+
+      # Visit an AST::Object node.
+      alias visit_object visit_child_nodes
+
+      # Visit an AST::Root node.
+      alias visit_root visit_child_nodes
+
+      # Visit an AST::String node.
+      alias visit_string visit_child_nodes
+
+      # Visit an AST::True node.
+      alias visit_true visit_child_nodes
+    end
+  end
+end

data/lib/syntax_tree/json.rb

@@ -1,131 +1,32 @@
 # frozen_string_literal: true
 
-require "json"
 require "prettier_print"
 require "syntax_tree"
 
+require_relative "json/ast"
+require_relative "json/parser"
 require_relative "json/version"
+require_relative "json/visitor"
+
+require_relative "json/format"
+require_relative "json/pretty_print"
 
 module SyntaxTree
   module JSON
-    # This is always the root of the syntax tree.
-    class RootNode < Struct.new(:object)
-      def format(q)
-        object.format(q)
-        q.breakable(force: true)
-      end
-
-      def pretty_print(q)
-        q.group(2, "(root", ")") do
-          q.breakable
-          q.text("object=")
-          q.pp(object)
-        end
-      end
-    end
-
-    # This contains an object node. The values argument to the struct is a hash.
-    class ObjectNode < Struct.new(:values)
-      def format(q)
-        q.group do
-          q.text("{")
-
-          q.indent do
-            q.breakable
-            q.seplist(values, nil, :each_pair) do |key, value|
-              q.group do
-                q.text(key.to_json)
-                q.text(": ")
-                value.format(q)
-              end
-            end
-          end
-
-          q.breakable
-          q.text("}")
-        end
-      end
-
-      def pretty_print(q)
-        q.group(2, "(object", ")") do
-          q.breakable
-          q.text("values=")
-          q.pp(values)
-        end
-      end
-    end
-
-    # This contains an array node. The values argument to the struct is an
-    # array.
-    class ArrayNode < Struct.new(:values)
-      def format(q)
-        q.group do
-          q.text("[")
-
-          q.indent do
-            q.breakable("")
-            q.seplist(values) { |value| value.format(q) }
-          end
-
-          q.breakable("")
-          q.text("]")
-        end
-      end
-
-      def pretty_print(q)
-        q.group(2, "(array", ")") do
-          q.breakable
-          q.text("values=")
-          q.pp(values)
-        end
-      end
-    end
-
-    # This contains a literal node. The value argument to the struct is a
-    # literal value like a string, number, or boolean.
-    class LiteralNode < Struct.new(:value)
-      def format(q)
-        q.text(value.to_json)
-      end
-
-      def pretty_print(q)
-        q.group(2, "(literal", ")") do
-          q.breakable
-          q.text("value=")
-          q.text(value.inspect)
-        end
-      end
-    end
-
     class << self
       def format(source, maxwidth = 80)
-        formatter = PrettierPrint.new([], maxwidth)
-        parse(source).format(formatter)
-
-        formatter.flush
-        formatter.output.join
+        PrettierPrint.format(+"", maxwidth) do |q|
+          parse(source).accept(Format.new(q))
+        end
       end
 
       def parse(source)
-        RootNode.new(translate(::JSON.parse(source)))
+        Parser.new(source).parse
       end
 
       def read(filepath)
         File.read(filepath)
       end
-
-      private
-
-      def translate(object)
-        case object
-        when Hash
-          ObjectNode.new(object.to_h { |key, value| [key, translate(value)] })
-        when Array
-          ArrayNode.new(object.map { |value| translate(value) })
-        else
-          LiteralNode.new(object)
-        end
-      end
     end
   end
 

data/syntax_tree-json.gemspec

@@ -3,27 +3,26 @@
 require_relative "lib/syntax_tree/json/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "syntax_tree-json"
-  spec.version       = SyntaxTree::JSON::VERSION
-  spec.authors       = ["Kevin Newton"]
-  spec.email         = ["kddnewton@gmail.com"]
+  spec.name = "syntax_tree-json"
+  spec.version = SyntaxTree::JSON::VERSION
+  spec.authors = ["Kevin Newton"]
+  spec.email = ["kddnewton@gmail.com"]
 
-  spec.summary       = "Syntax Tree support for JSON"
-  spec.homepage      = "https://github.com/ruby-syntax-tree/syntax_tree-json"
-  spec.license       = "MIT"
-  spec.metadata      = { "rubygems_mfa_required" => "true" }
+  spec.summary = "Syntax Tree support for JSON"
+  spec.homepage = "https://github.com/ruby-syntax-tree/syntax_tree-json"
+  spec.license = "MIT"
+  spec.metadata = { "rubygems_mfa_required" => "true" }
 
-  spec.files         = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
+  spec.files =
+    Dir.chdir(__dir__) do
+      `git ls-files -z`.split("\x0")
+        .reject { |f| f.match(%r{^(test|spec|features)/}) }
     end
-  end
 
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency "json"
   spec.add_dependency "prettier_print"
   spec.add_dependency "syntax_tree", ">= 2.0.1"
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree-json
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-14 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: prettier_print
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +102,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".gitmodules"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -127,7 +115,12 @@ files:
 - bin/console
 - bin/setup
 - lib/syntax_tree/json.rb
+- lib/syntax_tree/json/ast.rb
+- lib/syntax_tree/json/format.rb
+- lib/syntax_tree/json/parser.rb
+- lib/syntax_tree/json/pretty_print.rb
 - lib/syntax_tree/json/version.rb
+- lib/syntax_tree/json/visitor.rb
 - syntax_tree-json.gemspec
 homepage: https://github.com/ruby-syntax-tree/syntax_tree-json
 licenses: