syntax_tree 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4410889ecf31d320edb7e45b5491c97ec1af42f782e486cf946cad4672ee5cd
-  data.tar.gz: c81d09784f746b0b115af55409196a640d17d972a91e7d116a45b9b69bcb7c14
+  metadata.gz: 1fc4a522e982024b0361f9635ac6f5c7e60cfbb614aab5e58861649143c1353c
+  data.tar.gz: f42f88445e6ef91e134fcc22441c17e372028db17a2d85be9ebc6eafd227bba0
 SHA512:
-  metadata.gz: 1c6badd15f529d426d771679f3e8ebbd690a705f66027caa6510bf01c2788b3968fd1c3523bfa3534d3dd048604b968c8c01059e5a2c6d2148130aebd77d8530
-  data.tar.gz: e4567e0f5259ceb1b840f4c10c50fac526e972932e22340a5456fc1f394872c04b5f5651b63859bff40fc4e40da19e9040db6c51a70b6beb27559fcbe1597987
+  metadata.gz: 965a5878ac38cb5c44b867fb92a67913f505b655d25ececc73970ad6a24a1b73f13a0885a2943db5d7950acc4194355f113e4c8a680fdf00e43f024dd3cdab59
+  data.tar.gz: 11ffd4beaec88f4b5c2af085cce12dea49368ab39b389fb16197c37d9570b25c45614881eed89dde0e8d195f64d1d284ff3713fc41a9dff0440ebea631df3afd

data/.github/workflows/gh-pages.yml

@@ -1,26 +1,54 @@
-name: Github Pages (rdoc)
-on: [push]
+name: Deploy rdoc to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
 jobs:
-  build-and-deploy:
+  # Build job
+  build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@master
-
-      - name: Set up Ruby 💎
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
           ruby-version: '3.1'
-
-      - name: Install rdoc and generate docs 🔧
+      - name: Generate docs
         run: |
           gem install rdoc
-          rdoc --main README.md --op rdocs --exclude={Gemfile,Rakefile,"coverage/*","vendor/*","bin/*","test/*","tmp/*"}
-          cp -r doc rdocs/doc
+          rdoc --main README.md --op _site --exclude={Gemfile,Rakefile,"coverage/*","vendor/*","bin/*","test/*","tmp/*"}
+          cp -r doc _site/doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
 
-      - name: Deploy 🚀
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./rdocs
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.6.0] - 2022-09-19
+
+### Added
+
+- [#158](https://github.com/ruby-syntax-tree/syntax_tree/pull/158) - Support the ability to pass `--ignore-files` to the CLI and the Rake tasks to ignore a certain pattern of files.
+
 ## [3.5.0] - 2022-08-26
 
 ### Added
@@ -344,7 +350,8 @@ 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/syntax_tree/compare/v3.5.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.6.0...HEAD
+[3.6.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.5.0...v3.6.0
 [3.5.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.4.0...v3.5.0
 [3.4.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.2.1...v3.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (3.5.0)
+    syntax_tree (3.6.0)
       prettier_print
 
 GEM
@@ -19,7 +19,7 @@ GEM
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.35.1)
+    rubocop (1.36.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)

data/README.md

@@ -40,7 +40,7 @@ It is built with only standard library dependencies. It additionally ships with
   - [textDocument/inlayHint](#textdocumentinlayhint)
   - [syntaxTree/visualizing](#syntaxtreevisualizing)
 - [Plugins](#plugins)
-  - [Configuration](#configuration)
+  - [Customization](#customization)
   - [Languages](#languages)
 - [Integration](#integration)
   - [Rake](#rake)
@@ -83,7 +83,9 @@ bundle exec stree version
 
 ## CLI
 
-Syntax Tree ships with the `stree` CLI, which can be used to inspect and manipulate Ruby code. Below are listed all of the commands built into the CLI that you can use. Note that for all commands that operate on files, you can also pass in content through STDIN.
+Syntax Tree ships with the `stree` CLI, which can be used to inspect and manipulate Ruby code. Below are listed all of the commands built into the CLI that you can use.
+
+For many commands, file paths are accepted after the configuration options. For all of these commands, you can alternatively pass in content through STDIN or through the `-e` option to specify an inline script.
 
 ### ast
 
@@ -233,6 +235,12 @@ To change the print width that you are writing with, specify the `--print-width`
 stree write --print-width=100 path/to/file.rb
 ```
 
+To ignore certain files from a glob (in order to make it easier to specify the filepaths), you can pass the `--ignore-files` option as an additional glob, as in:
+
+```sh
+stree write --ignore-files='db/**/*.rb' '**/*.rb'
+```
+
 ### Configuration
 
 Any of the above CLI commands can also read configuration options from a `.streerc` file in the directory where the commands are executed.
@@ -473,11 +481,11 @@ The language server additionally includes this custom request to return a textua
 
 ## Plugins
 
-You can register additional configuration and additional languages that can flow through the same CLI with Syntax Tree's plugin system. When invoking the CLI, you pass through the list of plugins with the `--plugins` options to the commands that accept them. They should be a comma-delimited list. When the CLI first starts, it will require the files corresponding to those names.
+You can register additional customization and additional languages that can flow through the same CLI with Syntax Tree's plugin system. When invoking the CLI, you pass through the list of plugins with the `--plugins` options to the commands that accept them. They should be a comma-delimited list. When the CLI first starts, it will require the files corresponding to those names.
 
-### Configuration
+### Customization
 
-To register additional configuration, define a file somewhere in your load path named `syntax_tree/my_plugin`. Then when invoking the CLI, you will pass `--plugins=my_plugin`. To require multiple, separate them by a comma. In this way, you can modify Syntax Tree however you would like. Some plugins ship with Syntax Tree itself. They are:
+To register additional customization, define a file somewhere in your load path named `syntax_tree/my_plugin`. Then when invoking the CLI, you will pass `--plugins=my_plugin`. To require multiple, separate them by a comma. In this way, you can modify Syntax Tree however you would like. Some plugins ship with Syntax Tree itself. They are:
 
 * `plugin/single_quotes` - This will change all of your string literals to use single quotes instead of the default double quotes.
 * `plugin/trailing_comma` - This will put trailing commas into multiline array literals, hash literals, and method calls that can support trailing commas.
@@ -500,9 +508,12 @@ In this case, whenever the CLI encounters a filepath that ends with the given ex
 
 Below are listed all of the "official" language plugins hosted under the same GitHub organization, which can be used as references for how to implement other plugins.
 
+* [bf](https://github.com/ruby-syntax-tree/syntax_tree-bf) for the [brainf*** language](https://esolangs.org/wiki/Brainfuck).
+* [css](https://github.com/ruby-syntax-tree/syntax_tree-css) for the [CSS stylesheet language](https://www.w3.org/Style/CSS/).
 * [haml](https://github.com/ruby-syntax-tree/syntax_tree-haml) for the [Haml template language](https://haml.info/).
-* [json](https://github.com/ruby-syntax-tree/syntax_tree-json) for JSON.
+* [json](https://github.com/ruby-syntax-tree/syntax_tree-json) for the [JSON notation language](https://www.json.org/).
 * [rbs](https://github.com/ruby-syntax-tree/syntax_tree-rbs) for the [RBS type language](https://github.com/ruby/rbs).
+* [xml](https://github.com/ruby-syntax-tree/syntax_tree-xml) for the [XML markup language](https://www.w3.org/XML/).
 
 ## Integration
 
@@ -538,6 +549,17 @@ SyntaxTree::Rake::WriteTask.new do |t|
 end
 ```
 
+#### `ignore_files`
+
+If you want to ignore certain file patterns when running the command, you can pass the `ignore_files` option. This will be checked with `File.fnmatch?` against each filepath that the command would be run against. For example:
+
+```ruby
+SyntaxTree::Rake::WriteTask.new do |t|
+  t.source_files = "**/*.rb"
+  t.ignore_files = "db/**/*.rb"
+end
+```
+
 #### `print_width`
 
 If you want to use a different print width from the default (80), you can pass that to the `print_width` field, as in:

data/lib/syntax_tree/basic_visitor.rb

@@ -35,7 +35,7 @@ module SyntaxTree
 
       # In some setups with Ruby you can turn off DidYouMean, so we're going to
       # respect that setting here.
-      if defined?(DidYouMean) && DidYouMean.method_defined?(:correct_error)
+      if defined?(DidYouMean.correct_error)
         DidYouMean.correct_error(VisitMethodError, self)
       end
     end

data/lib/syntax_tree/cli.rb

@@ -51,13 +51,15 @@ module SyntaxTree
       def source
         handler.read(filepath)
       end
+
+      def writable?
+        File.writable?(filepath)
+      end
     end
 
     # An item of work that corresponds to a script content passed via the
     # command line.
     class ScriptItem
-      FILEPATH = :script
-
       attr_reader :source
 
       def initialize(source)
@@ -69,7 +71,30 @@ module SyntaxTree
       end
 
       def filepath
-        FILEPATH
+        :script
+      end
+
+      def writable?
+        false
+      end
+    end
+
+    # An item of work that correspond to the content passed in via stdin.
+    class STDINItem
+      def handler
+        HANDLERS[".rb"]
+      end
+
+      def filepath
+        :stdin
+      end
+
+      def source
+        $stdin.read
+      end
+
+      def writable?
+        false
       end
     end
 
@@ -196,7 +221,7 @@ module SyntaxTree
 
         source = item.source
         formatted = item.handler.format(source, options.print_width)
-        File.write(filepath, formatted) if item.filepath != :script
+        File.write(filepath, formatted) if item.writable?
 
         color = source == formatted ? Color.gray(filepath) : filepath
         delta = ((Time.now - start) * 1000).round
@@ -258,9 +283,14 @@ module SyntaxTree
     # responsible for parsing the list and then returning the file paths at the
     # end.
     class Options
-      attr_reader :plugins, :print_width, :scripts, :target_ruby_version
+      attr_reader :ignore_files,
+                  :plugins,
+                  :print_width,
+                  :scripts,
+                  :target_ruby_version
 
       def initialize(print_width: DEFAULT_PRINT_WIDTH)
+        @ignore_files = ""
         @plugins = []
         @print_width = print_width
         @scripts = []
@@ -279,6 +309,13 @@ module SyntaxTree
 
       def parser
         OptionParser.new do |opts|
+          # If there is a glob specified to ignore, then we'll track that here.
+          # Any of the CLI commands that operate on filenames will then ignore
+          # this set of files.
+          opts.on("--ignore-files=GLOB") do |glob|
+            @ignore_files = glob.match(/\A'(.*)'\z/) ? $1 : glob
+          end
+
           # If there are any plugins specified on the command line, then load
           # them by requiring them here. We do this by transforming something
           # like
@@ -386,7 +423,7 @@ module SyntaxTree
             return 1
           end
 
-        # If we're not reading from stdin and the user didn't supply and
+        # If we're not reading from stdin and the user didn't supply any
         # filepaths to be read, then we exit with the usage message.
         if $stdin.tty? && arguments.empty? && options.scripts.empty?
           warn(HELP)
@@ -403,12 +440,16 @@ module SyntaxTree
             Dir
               .glob(pattern)
               .each do |filepath|
-                queue << FileItem.new(filepath) if File.file?(filepath)
+                if File.readable?(filepath) &&
+                     !File.fnmatch?(options.ignore_files, filepath)
+                  queue << FileItem.new(filepath)
+                end
               end
           end
+
           options.scripts.each { |script| queue << ScriptItem.new(script) }
         else
-          queue << ScriptItem.new($stdin.read)
+          queue << STDINItem.new
         end
 
         # At the end, we're going to return whether or not this worker ever

data/lib/syntax_tree/rake/check_task.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
-require "rake"
-require "rake/tasklib"
-
-require "syntax_tree"
-require "syntax_tree/cli"
+require_relative "task"
 
 module SyntaxTree
   module Rake
@@ -12,74 +8,21 @@ module SyntaxTree
     #
     # Example:
     #
-    #   require 'syntax_tree/rake/check_task'
+    #   require "syntax_tree/rake/check_task"
     #
     #   SyntaxTree::Rake::CheckTask.new do |t|
-    #     t.source_files = '{app,config,lib}/**/*.rb'
+    #     t.source_files = "{app,config,lib}/**/*.rb"
     #   end
     #
     # This will create task that can be run with:
     #
-    #   rake stree_check
+    #   rake stree:check
     #
-    class CheckTask < ::Rake::TaskLib
-      # Name of the task.
-      # Defaults to :"stree:check".
-      attr_accessor :name
-
-      # Glob pattern to match source files.
-      # Defaults to 'lib/**/*.rb'.
-      attr_accessor :source_files
-
-      # The set of plugins to require.
-      # Defaults to [].
-      attr_accessor :plugins
-
-      # Max line length.
-      # Defaults to 80.
-      attr_accessor :print_width
-
-      # The target Ruby version to use for formatting.
-      # Defaults to Gem::Version.new(RUBY_VERSION).
-      attr_accessor :target_ruby_version
-
-      def initialize(
-        name = :"stree:check",
-        source_files = ::Rake::FileList["lib/**/*.rb"],
-        plugins = [],
-        print_width = DEFAULT_PRINT_WIDTH,
-        target_ruby_version = Gem::Version.new(RUBY_VERSION)
-      )
-        @name = name
-        @source_files = source_files
-        @plugins = plugins
-        @print_width = print_width
-        @target_ruby_version = target_ruby_version
-
-        yield self if block_given?
-        define_task
-      end
-
+    class CheckTask < Task
       private
 
-      def define_task
-        desc "Runs `stree check` over source files"
-        task(name) { run_task }
-      end
-
-      def run_task
-        arguments = ["check"]
-        arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
-
-        if print_width != DEFAULT_PRINT_WIDTH
-          arguments << "--print-width=#{print_width}"
-        end
-
-        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
-          arguments << "--target-ruby-version=#{target_ruby_version}"
-        end
-
-        SyntaxTree::CLI.run(arguments + Array(source_files))
+      def command
+        "check"
       end
     end
   end

data/lib/syntax_tree/rake/task.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+require "syntax_tree"
+require "syntax_tree/cli"
+
+module SyntaxTree
+  module Rake
+    # A parent Rake task that runs a command on a set of source files.
+    class Task < ::Rake::TaskLib
+      # Name of the task.
+      attr_accessor :name
+
+      # Glob pattern to match source files.
+      # Defaults to 'lib/**/*.rb'.
+      attr_accessor :source_files
+
+      # The set of plugins to require.
+      # Defaults to [].
+      attr_accessor :plugins
+
+      # Max line length.
+      # Defaults to 80.
+      attr_accessor :print_width
+
+      # The target Ruby version to use for formatting.
+      # Defaults to Gem::Version.new(RUBY_VERSION).
+      attr_accessor :target_ruby_version
+
+      # Glob pattern to ignore source files.
+      # Defaults to ''.
+      attr_accessor :ignore_files
+
+      def initialize(
+        name = :"stree:#{command}",
+        source_files = ::Rake::FileList["lib/**/*.rb"],
+        plugins = [],
+        print_width = DEFAULT_PRINT_WIDTH,
+        target_ruby_version = Gem::Version.new(RUBY_VERSION),
+        ignore_files = ""
+      )
+        @name = name
+        @source_files = source_files
+        @plugins = plugins
+        @print_width = print_width
+        @target_ruby_version = target_ruby_version
+        @ignore_files = ignore_files
+
+        yield self if block_given?
+        define_task
+      end
+
+      private
+
+      # This method needs to be overridden in the child tasks.
+      def command
+        raise NotImplementedError
+      end
+
+      def define_task
+        desc "Runs `stree #{command}` over source files"
+        task(name) { run_task }
+      end
+
+      def run_task
+        arguments = [command]
+        arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
+
+        if print_width != DEFAULT_PRINT_WIDTH
+          arguments << "--print-width=#{print_width}"
+        end
+
+        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
+          arguments << "--target-ruby-version=#{target_ruby_version}"
+        end
+
+        arguments << "--ignore-files=#{ignore_files}" if ignore_files != ""
+
+        SyntaxTree::CLI.run(arguments + Array(source_files))
+      end
+    end
+  end
+end

data/lib/syntax_tree/rake/write_task.rb

@@ -1,85 +1,28 @@
 # frozen_string_literal: true
 
-require "rake"
-require "rake/tasklib"
-
-require "syntax_tree"
-require "syntax_tree/cli"
+require_relative "task"
 
 module SyntaxTree
   module Rake
-    # A Rake task that runs format on a set of source files.
+    # A Rake task that runs write on a set of source files.
     #
     # Example:
     #
-    #   require 'syntax_tree/rake/write_task'
+    #   require "syntax_tree/rake/write_task"
     #
     #   SyntaxTree::Rake::WriteTask.new do |t|
-    #     t.source_files = '{app,config,lib}/**/*.rb'
+    #     t.source_files = "{app,config,lib}/**/*.rb"
     #   end
     #
     # This will create task that can be run with:
     #
-    #   rake stree_write
+    #   rake stree:write
     #
-    class WriteTask < ::Rake::TaskLib
-      # Name of the task.
-      # Defaults to :"stree:write".
-      attr_accessor :name
-
-      # Glob pattern to match source files.
-      # Defaults to 'lib/**/*.rb'.
-      attr_accessor :source_files
-
-      # The set of plugins to require.
-      # Defaults to [].
-      attr_accessor :plugins
-
-      # Max line length.
-      # Defaults to 80.
-      attr_accessor :print_width
-
-      # The target Ruby version to use for formatting.
-      # Defaults to Gem::Version.new(RUBY_VERSION).
-      attr_accessor :target_ruby_version
-
-      def initialize(
-        name = :"stree:write",
-        source_files = ::Rake::FileList["lib/**/*.rb"],
-        plugins = [],
-        print_width = DEFAULT_PRINT_WIDTH,
-        target_ruby_version = Gem::Version.new(RUBY_VERSION)
-      )
-        @name = name
-        @source_files = source_files
-        @plugins = plugins
-        @print_width = print_width
-        @target_ruby_version = target_ruby_version
-
-        yield self if block_given?
-        define_task
-      end
-
+    class WriteTask < Task
       private
 
-      def define_task
-        desc "Runs `stree write` over source files"
-        task(name) { run_task }
-      end
-
-      def run_task
-        arguments = ["write"]
-        arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
-
-        if print_width != DEFAULT_PRINT_WIDTH
-          arguments << "--print-width=#{print_width}"
-        end
-
-        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
-          arguments << "--target-ruby-version=#{target_ruby_version}"
-        end
-
-        SyntaxTree::CLI.run(arguments + Array(source_files))
+      def command
+        "write"
       end
     end
   end

data/lib/syntax_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxTree
-  VERSION = "3.5.0"
+  VERSION = "3.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print
@@ -132,6 +132,7 @@ files:
 - lib/syntax_tree/plugin/single_quotes.rb
 - lib/syntax_tree/plugin/trailing_comma.rb
 - lib/syntax_tree/rake/check_task.rb
+- lib/syntax_tree/rake/task.rb
 - lib/syntax_tree/rake/write_task.rb
 - lib/syntax_tree/rake_tasks.rb
 - lib/syntax_tree/version.rb
@@ -161,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.21
 signing_key:
 specification_version: 4
 summary: A parser based on ripper