prettier_print 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94274541967c7d4bb242bbbd4b141e8166d3239c27a03fb28fe606807fa2f302
-  data.tar.gz: c27c69952f928c0533121941c584bda279966d5b0c04d78671d067d4479c3fbe
+  metadata.gz: 5d7e2d82792d59bc2b9c28ef209091c7a258fa6e7729cccf7e182de3021c1533
+  data.tar.gz: 9a9d0b4689234dc396354279f07c13337ff8b423b974f43ba3f1bf411aa8d793
 SHA512:
-  metadata.gz: 4d79d0c356c618ba5c89070f708f44993f43efaec89bba478d52c9432b1295dce150555fd1f242d48060ba4cf3152207b8d02d5b3d8121722b71af60b133098c
-  data.tar.gz: ae5fcfb0885b70c3e1de247da94fedca3d0897a2345efca6f231c3bbdb9565d2ccb2b8b18796c1226d2ede30fdc54bd1baa1d6138d5c1c777e8c6a875574db46
+  metadata.gz: b0ccf56fb3f3887e6d2dd3f72b1ac5944e2ad9e754cd15cc41541e36e79b481cc50a429feaac41302bc9363415bdc2242a8bc0b1719f8e779794ec66a7ae0087
+  data.tar.gz: c7304db0e58c2898a26f92a698d633dbf8df419faa77aa3b82815db191bffeb26d37dacad8793964a6a87517ae5a78a990491607df03f270c98d7e540edf1956

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

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.3.3
+        uses: dependabot/fetch-metadata@v1.3.6
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for Dependabot PRs

data/.github/workflows/main.yml

@@ -1,16 +1,18 @@
 name: Main
+
 on:
 - push
-- pull_request_target
+- pull_request
+
 jobs:
   ci:
     strategy:
       fail-fast: false
       matrix:
         ruby:
-        - '2.7'
         - '3.0'
         - '3.1'
+        - '3.2'
         - head
     name: CI
     runs-on: ubuntu-latest

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.1] - 2023-03-09
+
+### Changed
+
+- Fixed a bug where having line suffixes on the final line without a breakable could cause an infinite loop.
+
+## [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
@@ -49,7 +61,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.1.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.2.1...HEAD
+[1.2.1]: https://github.com/ruby-syntax-tree/prettier_print/compare/v1.2.0...v1.2.1
+[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

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 kddnewton@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,25 +1,26 @@
 PATH
   remote: .
   specs:
-    prettier_print (1.1.0)
+    prettier_print (1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    power_assert (2.0.1)
+    power_assert (2.0.2)
     rake (13.0.6)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       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.5)
+    test-unit (3.5.7)
       power_assert
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-darwin-21
   x86_64-linux
 

data/README.md

@@ -1,5 +1,8 @@
 # PrettierPrint
 
+[![Build Status](https://github.com/ruby-syntax-tree/prettier_print/workflows/Main/badge.svg)](https://github.com/ruby-syntax-tree/prettier_print/actions)
+[![Gem Version](https://img.shields.io/gem/v/prettier_print.svg)](https://rubygems.org/gems/prettier_print)
+
 A drop-in replacement for the `prettyprint` gem with more functionality.
 
 ## Installation

data/lib/prettier_print/version.rb

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

data/lib/prettier_print.rb

@@ -360,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
@@ -373,11 +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
+    q.flush(indentation)
     output
   end
 
@@ -481,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.
@@ -607,8 +616,11 @@ class PrettierPrint
       end
 
       if commands.empty? && line_suffixes.any?
-        commands += line_suffixes.sort_by(&line_suffix_sort)
-        line_suffixes = []
+        line_suffixes.sort_by(&line_suffix_sort).each do |(indent, mode, doc)|
+          commands += doc.contents.reverse.map { |part| [indent, mode, part] }
+        end
+
+        line_suffixes.clear
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier_print
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -22,6 +22,7 @@ files:
 - ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A drop-in replacement for the prettyprint gem with more functionality.