prettier_print 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a51b0f4acf29f5f26a1eb71aa7f682c48a1a4cde776eb27140304a0b2e970f
-  data.tar.gz: 7b72b908730bcff4c4c71205e2c3ee8f3ea77d791873543195c55efb07a78320
+  metadata.gz: cd1acc23437a5cf57c8f770a8f6ae6273d14c4716a64566f7966c19fe0f63276
+  data.tar.gz: bee4b7fcdd680e7a3747ad025054830426638f166bd14229e1a3386350fd542e
 SHA512:
-  metadata.gz: c5f85439e98bb48f9357b7ef1fbb98f5f85153d921e220ffd77c6e0f4d9aad76975374f8ba4f056770622d807232e5dbb5cdf43938e609f5d22d02a64a67e4fb
-  data.tar.gz: f4de2a0f56adb16425bc26861e1a20c05b29db8f8e47fce164e5c1695e731f878e048ab6e042f94f7774fab9b55a6e32c0eb4ac058d82e56c7f640ef57124a6a
+  metadata.gz: e59fb5d9131f40d75e458b45ad069329da4ae83df63f3111f7ffba01347d1ddf1a214f636a4bf5afa08502458c171ed7d17a8e358294ef101c9f1db68a924e20
+  data.tar.gz: ae31224da56d3983e6c3fa4329dbaa1bb86a4cf8b500852cfc105cfb01d69b11d61b285860e924768664f652964e300c72dbca141441e3f31222dad7be1545e7

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

@@ -24,19 +24,3 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
     - 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
-          })

data/CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.2.0] - 2022-12-23
+
+### Added
+
+- You can now supply the base indentation level for the output buffer.
+
+## [1.1.0] - 2022-11-08
+
+### Added
+
+- `prettier_print` now works with Ractors.
+
 ## [1.0.2] - 2022-10-19
 
 ### Changed
@@ -43,7 +55,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.0.2...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.0.2...v1.1.0
 [1.0.2]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/ruby-syntax-tree/prettier_print/compare/v0.1.0...v1.0.0

data/Gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "simplecov"
 gem "rake"
 gem "test-unit"

data/Gemfile.lock

@@ -1,14 +1,21 @@
 PATH
   remote: .
   specs:
-    prettier_print (1.0.2)
+    prettier_print (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    power_assert (2.0.1)
+    docile (1.4.0)
+    power_assert (2.0.2)
     rake (13.0.6)
-    test-unit (3.5.5)
+    simplecov (0.21.2)
+      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.5.7)
       power_assert
 
 PLATFORMS
@@ -19,6 +26,7 @@ PLATFORMS
 DEPENDENCIES
   prettier_print!
   rake
+  simplecov
   test-unit
 
 BUNDLED WITH

data/lib/prettier_print/single_line.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+class PrettierPrint
+  # PrettierPrint::SingleLine is used by PrettierPrint.singleline_format
+  #
+  # It is passed to be similar to a PrettierPrint object itself, by responding to
+  # all of the same print tree node builder methods, as well as the #flush
+  # method.
+  #
+  # The significant difference here is that there are no line breaks in the
+  # output. If an IfBreak node is used, only the flat contents are printed.
+  # LineSuffix nodes are printed at the end of the buffer when #flush is called.
+  class SingleLine
+    # The output object. It stores rendered text and should respond to <<.
+    attr_reader :output
+
+    # The current array of contents that the print tree builder methods should
+    # append to.
+    attr_reader :target
+
+    # A buffer output that wraps any calls to line_suffix that will be flushed
+    # at the end of printing.
+    attr_reader :line_suffixes
+
+    # Create a PrettierPrint::SingleLine object
+    #
+    # Arguments:
+    # * +output+ - String (or similar) to store rendered text. Needs to respond
+    #              to '<<'.
+    # * +maxwidth+ - Argument position expected to be here for compatibility.
+    #                This argument is a noop.
+    # * +newline+ - Argument position expected to be here for compatibility.
+    #               This argument is a noop.
+    def initialize(output, _maxwidth = nil, _newline = nil)
+      @output = Buffer.for(output)
+      @target = @output
+      @line_suffixes = Buffer::ArrayBuffer.new
+    end
+
+    # Flushes the line suffixes onto the output buffer.
+    def flush
+      line_suffixes.output.each { |doc| output << doc }
+    end
+
+    # --------------------------------------------------------------------------
+    # Markers node builders
+    # --------------------------------------------------------------------------
+
+    # Appends +separator+ to the text to be output. By default +separator+ is
+    # ' '
+    #
+    # The +width+, +indent+, and +force+ arguments are here for compatibility.
+    # They are all noop arguments.
+    def breakable(
+      separator = " ",
+      _width = separator.length,
+      indent: nil,
+      force: nil
+    )
+      target << separator
+    end
+
+    # Here for compatibility, does nothing.
+    def break_parent
+    end
+
+    # Appends +separator+ to the output buffer. +width+ is a noop here for
+    # compatibility.
+    def fill_breakable(separator = " ", _width = separator.length)
+      target << separator
+    end
+
+    # Immediately trims the output buffer.
+    def trim
+      target.trim!
+    end
+
+    # --------------------------------------------------------------------------
+    # Container node builders
+    # --------------------------------------------------------------------------
+
+    # Opens a block for grouping objects to be pretty printed.
+    #
+    # Arguments:
+    # * +indent+ - noop argument. Present for compatibility.
+    # * +open_obj+ - text appended before the &block. Default is ''
+    # * +close_obj+ - text appended after the &block. Default is ''
+    # * +open_width+ - noop argument. Present for compatibility.
+    # * +close_width+ - noop argument. Present for compatibility.
+    def group(
+      _indent = nil,
+      open_object = "",
+      close_object = "",
+      _open_width = nil,
+      _close_width = nil
+    )
+      target << open_object
+      yield
+      target << close_object
+    end
+
+    # A class that wraps the ability to call #if_flat. The contents of the
+    # #if_flat block are executed immediately, so effectively this class and the
+    # #if_break method that triggers it are unnecessary, but they're here to
+    # maintain compatibility.
+    class IfBreakBuilder
+      def if_flat
+        yield
+      end
+    end
+
+    # Effectively unnecessary, but here for compatibility.
+    def if_break
+      IfBreakBuilder.new
+    end
+
+    # Also effectively unnecessary, but here for compatibility.
+    def if_flat
+    end
+
+    # A noop that immediately yields.
+    def indent
+      yield
+    end
+
+    # Changes the target output buffer to the line suffix output buffer which
+    # will get flushed at the end of printing.
+    def line_suffix
+      previous_target, @target = @target, line_suffixes
+      yield
+      @target = previous_target
+    end
+
+    # Takes +indent+ arg, but does nothing with it.
+    #
+    # Yields to a block.
+    def nest(_indent)
+      yield
+    end
+
+    # Add +object+ to the text to be output.
+    #
+    # +width+ argument is here for compatibility. It is a noop argument.
+    def text(object = "", _width = nil)
+      target << object
+    end
+  end
+
+  # This is similar to PrettierPrint::format but the result has no breaks.
+  #
+  # +maxwidth+, +newline+ and +genspace+ are ignored.
+  #
+  # The invocation of +breakable+ in the block doesn't break a line and is
+  # treated as just an invocation of +text+.
+  #
+  def self.singleline_format(
+    output = +"",
+    _maxwidth = nil,
+    _newline = nil,
+    _genspace = nil
+  )
+    q = SingleLine.new(output)
+    yield q
+    output
+  end
+end

data/lib/prettier_print/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PrettierPrint
-  VERSION = "1.0.2"
+  VERSION = "1.2.0"
 end

data/lib/prettier_print.rb

@@ -122,10 +122,10 @@ class PrettierPrint
 
   # Below here are the most common combination of options that are created when
   # creating new breakables. They are here to cut down on some allocations.
-  BREAKABLE_SPACE = Breakable.new(" ", 1, indent: true, force: false)
-  BREAKABLE_EMPTY = Breakable.new("", 0, indent: true, force: false)
-  BREAKABLE_FORCE = Breakable.new(" ", 1, indent: true, force: true)
-  BREAKABLE_RETURN = Breakable.new(" ", 1, indent: false, force: true)
+  BREAKABLE_SPACE = Breakable.new(" ", 1, indent: true, force: false).freeze
+  BREAKABLE_EMPTY = Breakable.new("", 0, indent: true, force: false).freeze
+  BREAKABLE_FORCE = Breakable.new(" ", 1, indent: true, force: true).freeze
+  BREAKABLE_RETURN = Breakable.new(" ", 1, indent: false, force: true).freeze
 
   # A node in the print tree that forces the surrounding group to print out in
   # the "break" mode as opposed to the "flat" mode. Useful for when you need to
@@ -138,7 +138,7 @@ class PrettierPrint
 
   # Since there's really no difference in these instances, just using the same
   # one saves on some allocations.
-  BREAK_PARENT = BreakParent.new
+  BREAK_PARENT = BreakParent.new.freeze
 
   # A node in the print tree that represents a group of items which the printer
   # should try to fit onto one line. This is the basic command to tell the
@@ -267,7 +267,7 @@ class PrettierPrint
 
   # Since all of the instances here are the same, we can reuse the same one to
   # cut down on allocations.
-  TRIM = Trim.new
+  TRIM = Trim.new.freeze
 
   # When building up the contents in the output buffer, it's convenient to be
   # able to trim trailing whitespace before newlines. If the output object is a
@@ -338,151 +338,6 @@ class PrettierPrint
     end
   end
 
-  # PrettierPrint::SingleLine is used by PrettierPrint.singleline_format
-  #
-  # It is passed to be similar to a PrettierPrint object itself, by responding to
-  # all of the same print tree node builder methods, as well as the #flush
-  # method.
-  #
-  # The significant difference here is that there are no line breaks in the
-  # output. If an IfBreak node is used, only the flat contents are printed.
-  # LineSuffix nodes are printed at the end of the buffer when #flush is called.
-  class SingleLine
-    # The output object. It stores rendered text and should respond to <<.
-    attr_reader :output
-
-    # The current array of contents that the print tree builder methods should
-    # append to.
-    attr_reader :target
-
-    # A buffer output that wraps any calls to line_suffix that will be flushed
-    # at the end of printing.
-    attr_reader :line_suffixes
-
-    # Create a PrettierPrint::SingleLine object
-    #
-    # Arguments:
-    # * +output+ - String (or similar) to store rendered text. Needs to respond
-    #              to '<<'.
-    # * +maxwidth+ - Argument position expected to be here for compatibility.
-    #                This argument is a noop.
-    # * +newline+ - Argument position expected to be here for compatibility.
-    #               This argument is a noop.
-    def initialize(output, _maxwidth = nil, _newline = nil)
-      @output = Buffer.for(output)
-      @target = @output
-      @line_suffixes = Buffer::ArrayBuffer.new
-    end
-
-    # Flushes the line suffixes onto the output buffer.
-    def flush
-      line_suffixes.output.each { |doc| output << doc }
-    end
-
-    # --------------------------------------------------------------------------
-    # Markers node builders
-    # --------------------------------------------------------------------------
-
-    # Appends +separator+ to the text to be output. By default +separator+ is
-    # ' '
-    #
-    # The +width+, +indent+, and +force+ arguments are here for compatibility.
-    # They are all noop arguments.
-    def breakable(
-      separator = " ",
-      _width = separator.length,
-      indent: nil,
-      force: nil
-    )
-      target << separator
-    end
-
-    # Here for compatibility, does nothing.
-    def break_parent
-    end
-
-    # Appends +separator+ to the output buffer. +width+ is a noop here for
-    # compatibility.
-    def fill_breakable(separator = " ", _width = separator.length)
-      target << separator
-    end
-
-    # Immediately trims the output buffer.
-    def trim
-      target.trim!
-    end
-
-    # --------------------------------------------------------------------------
-    # Container node builders
-    # --------------------------------------------------------------------------
-
-    # Opens a block for grouping objects to be pretty printed.
-    #
-    # Arguments:
-    # * +indent+ - noop argument. Present for compatibility.
-    # * +open_obj+ - text appended before the &block. Default is ''
-    # * +close_obj+ - text appended after the &block. Default is ''
-    # * +open_width+ - noop argument. Present for compatibility.
-    # * +close_width+ - noop argument. Present for compatibility.
-    def group(
-      _indent = nil,
-      open_object = "",
-      close_object = "",
-      _open_width = nil,
-      _close_width = nil
-    )
-      target << open_object
-      yield
-      target << close_object
-    end
-
-    # A class that wraps the ability to call #if_flat. The contents of the
-    # #if_flat block are executed immediately, so effectively this class and the
-    # #if_break method that triggers it are unnecessary, but they're here to
-    # maintain compatibility.
-    class IfBreakBuilder
-      def if_flat
-        yield
-      end
-    end
-
-    # Effectively unnecessary, but here for compatibility.
-    def if_break
-      IfBreakBuilder.new
-    end
-
-    # Also effectively unnecessary, but here for compatibility.
-    def if_flat
-    end
-
-    # A noop that immediately yields.
-    def indent
-      yield
-    end
-
-    # Changes the target output buffer to the line suffix output buffer which
-    # will get flushed at the end of printing.
-    def line_suffix
-      previous_target, @target = @target, line_suffixes
-      yield
-      @target = previous_target
-    end
-
-    # Takes +indent+ arg, but does nothing with it.
-    #
-    # Yields to a block.
-    def nest(_indent)
-      yield
-    end
-
-    # Add +object+ to the text to be output.
-    #
-    # +width+ argument is here for compatibility. It is a noop argument.
-    def text(object = "", _width = nil)
-      target << object
-    end
-  end
-
   # When printing, you can optionally specify the value that should be used
   # whenever a group needs to be broken onto multiple lines. In this case the
   # default is \n.
@@ -493,6 +348,7 @@ class PrettierPrint
   # behavior (for instance to use tabs) by passing a different genspace
   # procedure.
   DEFAULT_GENSPACE = ->(n) { " " * n }
+  Ractor.make_shareable(DEFAULT_GENSPACE) if defined?(Ractor)
 
   # There are two modes in printing, break and flat. When we're in break mode,
   # any lines will use their newline, any if-breaks will use their break
@@ -504,6 +360,11 @@ class PrettierPrint
   # a forced line, or the maximum width.
   MODE_FLAT = 2
 
+  # The default indentation for printing is zero, assuming that the code starts
+  # at the top level. That can be changed if desired to start from a different
+  # indentation level.
+  DEFAULT_INDENTATION = 0
+
   # This is a convenience method which is same as follows:
   #
   #   begin
@@ -517,29 +378,12 @@ class PrettierPrint
     output = "".dup,
     maxwidth = 80,
     newline = DEFAULT_NEWLINE,
-    genspace = DEFAULT_GENSPACE
+    genspace = DEFAULT_GENSPACE,
+    indentation = DEFAULT_INDENTATION
   )
     q = new(output, maxwidth, newline, &genspace)
     yield q
-    q.flush
-    output
-  end
-
-  # This is similar to PrettierPrint::format but the result has no breaks.
-  #
-  # +maxwidth+, +newline+ and +genspace+ are ignored.
-  #
-  # The invocation of +breakable+ in the block doesn't break a line and is
-  # treated as just an invocation of +text+.
-  #
-  def self.singleline_format(
-    output = +"",
-    _maxwidth = nil,
-    _newline = nil,
-    _genspace = nil
-  )
-    q = SingleLine.new(output)
-    yield q
+    q.flush(indentation)
     output
   end
 
@@ -643,17 +487,20 @@ class PrettierPrint
 
   # Flushes all of the generated print tree onto the output buffer, then clears
   # the generated tree from memory.
-  def flush
+  def flush(base_indentation = DEFAULT_INDENTATION)
     # First, get the root group, since we placed one at the top to begin with.
     doc = groups.first
 
     # This represents how far along the current line we are. It gets reset
     # back to 0 when we encounter a newline.
-    position = 0
+    position = base_indentation
+
+    # Start the buffer with the base indentation level.
+    buffer << genspace.call(base_indentation) if base_indentation > 0
 
     # This is our command stack. A command consists of a triplet of an
     # indentation level, the mode (break or flat), and a doc node.
-    commands = [[0, MODE_BREAK, doc]]
+    commands = [[base_indentation, MODE_BREAK, doc]]
 
     # This is a small optimization boolean. It keeps track of whether or not
     # when we hit a group node we should check if it fits on the same line.
@@ -1251,3 +1098,5 @@ class PrettierPrint
     end
   end
 end
+
+require_relative "prettier_print/single_line"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier_print
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -28,6 +29,7 @@ files:
 - Rakefile
 - bin/console
 - lib/prettier_print.rb
+- lib/prettier_print/single_line.rb
 - lib/prettier_print/version.rb
 - prettier_print.gemspec
 homepage: https://github.com/ruby-syntax-tree/prettier_print