pragmater 6.3.1 → 6.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff5f7fc682388910458e8d573febe3bb60888264b0fcf83157b7ba6fe4e06c2d
-  data.tar.gz: 8b96e65b1565b4f62ff908795da0e8dcb073cb19cd92618d46c4d816e8e4a7be
+  metadata.gz: 3bbff78c69e65f1816000b849c2afc9221fe76abdc792c6fcfccb9b8ced75c36
+  data.tar.gz: 60dcd02d1968a0e09f36927057529872f5df5399514fd401c29fc95c3e348c60
 SHA512:
-  metadata.gz: 4fb6f16a51f42901537a4224c093c1ececdc9373f0b0d29bb43dbe9f91837a5af7d8c175193e4490eea93e5cb1f1b4bebad89e24e9bafc9892d2c0730125e395
-  data.tar.gz: 92cae9efd58fda6aeaa25e9f8c9ff293dca1c2d9810df3178cdbe8a53aa0a2e7c65fb206b9ce0d4efc24d9e023d9dc154b223d2947796040cedc2be9b1008f07
+  metadata.gz: 3fa916a2da9adacc71ee99edd4d8b4c8d1d5dbccecfa9c535a999699553e775f7e5e7153a82e25b90287b4e5b81b5731fdc28490974594d0b742cc1ff50d6aee
+  data.tar.gz: 1abfda2b22b89d5c4af0954d11aa48fa750a18c625089a125bdd42f6753a612b0f70a8ec5a357cdd8fa3732bae749f8f7a7712e4a3324a1f9a4c914c7e9b6188

data/README.md

@@ -9,17 +9,16 @@
 [![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/f0971ab6985309ce4db4/test_coverage)](https://codeclimate.com/github/bkuhlmann/pragmater/test_coverage)
 [![Circle CI Status](https://circleci.com/gh/bkuhlmann/pragmater.svg?style=svg)](https://circleci.com/gh/bkuhlmann/pragmater)
 
-A command line interface for managing/formatting source file
-[directive pragma](https://en.wikipedia.org/wiki/Directive_(programming)) comments
-(a.k.a. *magic comments*). Examples:
+A command line interface for managing/formatting source file [directive
+pragmas](https://en.wikipedia.org/wiki/Directive_(programming)) (a.k.a. *magic comments*). Examples:
 
     #! /usr/bin/env ruby
     # frozen_string_literal: true
     # encoding: UTF-8
 
 With [Ruby 2.3.0](https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released), frozen strings
-are supported via a pragma comment. This gem provides an easy way to add pragma comments to single
-or multiple Ruby source files in order to benefit from improved memory and concurrency performance.
+are supported via a pragma. This gem provides an easy way to add pragmas to single or multiple Ruby
+source files in order to benefit from improved memory and concurrency performance.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -32,8 +31,10 @@ or multiple Ruby source files in order to benefit from improved memory and concu
   - [Usage](#usage)
     - [Command Line Interface (CLI)](#command-line-interface-cli)
     - [Customization](#customization)
+    - [Available Pragmas](#available-pragmas)
+    - [Syntax](#syntax)
+    - [Precedence](#precedence)
     - [Frozen String Literals](#frozen-string-literals)
-    - [Available Comments](#available-comments)
   - [Tests](#tests)
   - [Versioning](#versioning)
   - [Code of Conduct](#code-of-conduct)
@@ -46,11 +47,11 @@ or multiple Ruby source files in order to benefit from improved memory and concu
 
 ## Features
 
-- Supports adding a pragma comment or multiple pragma comments to single or multiple source files.
-- Supports removing a pragma comment(s) from single or multiple source files.
+- Supports adding a pragma or multiple pragmas to single or multiple source files.
+- Supports removing pragma(s) from single or multiple source files.
 - Supports file list filtering. Defaults to any file.
-- Ensures duplicate pragma comments never exist.
-- Ensures pragma comments are consistently formatted.
+- Ensures duplicate pragmas never exist.
+- Ensures pragmas are consistently formatted.
 
 ## Screencasts
 
@@ -72,17 +73,17 @@ Type the following to install:
 
 From the command line, type: `pragmater help`
 
-    pragmater -a, [--add=PATH]      # Add pragma comments to source file(s).
+    pragmater -a, [--add=PATH]      # Add comments to source file(s).
     pragmater -c, [--config]        # Manage gem configuration.
     pragmater -h, [--help=COMMAND]  # Show this message or get help for a command.
-    pragmater -r, [--remove=PATH]   # Remove pragma comments from source file(s).
+    pragmater -r, [--remove=PATH]   # Remove comments from source file(s).
     pragmater -v, [--version]       # Show gem version.
 
-Both the `--add` and `--remove` commands support options for specifying pragma comments and/or
-included files (viewable by running `pragmater --help --add` or `pragmater --help --remove`):
+Both the `--add` and `--remove` commands support options for specifying pragmas and/or included
+files (viewable by running `pragmater --help --add` or `pragmater --help --remove`):
 
-    -c, [--comments=one two three]  # Pragma comments
-    -i, [--includes=one two three]  # File include list
+    -c, [--comments=one two three]  # Define desired comments
+    -i, [--includes=one two three]  # Include specific files and/or directories
 
 Example (same options could be used for the `--remove` command too):
 
@@ -114,10 +115,61 @@ Feel free to take this default configuration, modify, and save as your own custo
 
 The `configuration.yml` file can be configured as follows:
 
-- `add`: Defines global/local comments and/or file include lists when adding pragma comments. The
-  `comments` and `includes` options can be either a single string or an array of values.
-- `remove`: Defines global/local comments and/or file include lists when removing pragma comments.
-  The `comments` and `includes` options can be either a single string or an array of values.
+- `add`: Defines global/local comments and/or file include lists when adding pragmas. The
+  `comments` and `includes` options can be either a single string or an array.
+- `remove`: Defines global/local comments and/or file include lists when removing pragmas.
+  The `comments` and `includes` options can be either a single string or an array.
+
+### Available Pragmas
+
+With Ruby 2.3 and higher, the following pragmas are available:
+
+- `# encoding:` Defaults to `UTF-8` but any supported encoding can be used. For a list of values,
+  launch an IRB session and run `Encoding.name_list`.
+- `# coding:` The shorthand for `# encoding:`. Supports the same values as mentioned above.
+- `# frozen_string_literal:` Defaults to `false` but can take either `true` or `false` as a value.
+  When enabled, Ruby will throw errors when strings are used in a mutable fashion.
+- `# warn_indent:` Defaults to `false` but can take either `true` or `false` as a value. When
+  enabled, and running Ruby with the `-w` option, it'll throw warnings for code that isn't indented
+  by two spaces.
+
+### Syntax
+
+The pragma syntax allows for two kinds of styles. Example:
+
+    # encoding: UTF-8
+    # -*- encoding: UTF-8 -*-
+
+Only the former syntax is supported by this gem as the latter syntax is more verbose and requires
+additional typing.
+
+### Precedence
+
+When different multiple pragmas are defined, they all take precedence:
+
+    # encoding: binary
+    # frozen_string_literal: true
+
+In the above example, both *binary* encoding and *frozen string literals* behavior will be applied.
+
+When defining multiple pragmas that are similar, behavior can differ based on the *kind* of pragma
+used. The following walks through each use case so you know what to expect:
+
+    # encoding: binary
+    # encoding: UTF-8
+
+In the above example, only the *binary* encoding will be applied while the *UTF-8* encoding will be
+ignored (same principle applies for the `coding` pragma too).
+
+    # frozen_string_literal: false
+    # frozen_string_literal: true
+
+In the above example, frozen string literal support *will be enabled* instead of being disabled.
+
+    # warn_indent: false
+    # warn_indent: true
+
+In the above example, indentation warnings *will be enabled* instead of being disabled.
 
 ### Frozen String Literals
 
@@ -167,24 +219,11 @@ to hard to read code. Instead use the following:
     mutable = "test"
 
 While this requires extra typing, it expresses intent more clearly. There is a slight caveat to this
-rule in that the use of `String#-@` was [enhanced in Ruby 2.5.0](http://bit.ly/2DGAjgG) to
+rule in which the use of `String#-@` was [enhanced in Ruby 2.5.0](http://bit.ly/2DGAjgG) to
 *deduplicate* all instances of the same string thus reducing your memory footprint. This can be
 valuable in situations where you are not using the frozen string comment and need to selectively
 freeze strings.
 
-### Available Comments
-
-With Ruby 2.3 and higher, the following comments are available:
-
-- `# encoding:` Defaults to `UTF-8` but any supported encoding can be used. For a list of values,
-  launch an IRB session and run `Encoding.name_list`.
-- `# coding:` The shorthand for `# encoding:`. Supports the same values as mentioned above.
-- `# frozen_string_literal:` Defaults to `false` but can take either `true` or `false` as a value.
-  When enabled, Ruby will throw errors when strings are used in a mutable fashion.
-- `# warn_indent:` Defaults to `false` but can take either `true` or `false` as a value. When
-  enabled, and running Ruby with the `-w` option, it'll throw warnings for code that isn't indented
-  by two spaces.
-
 ## Tests
 
 To test, run:

data/lib/pragmater/cli.rb

@@ -35,16 +35,16 @@ module Pragmater
       abort error.message
     end
 
-    desc "-a, [--add=PATH]", "Add pragma comments to source file(s)."
+    desc "-a, [--add=PATH]", "Add comments to source file(s)."
     map %w[-a --add] => :add
     method_option :comments,
                   aliases: "-c",
-                  desc: "Pragma comments",
+                  desc: "Define desired comments",
                   type: :array,
                   default: configuration.to_h.dig(:add, :comments)
     method_option :includes,
                   aliases: "-i",
-                  desc: "File include list",
+                  desc: "Include specific files and/or directories",
                   type: :array,
                   default: configuration.to_h.dig(:add, :includes)
     def add path = "."
@@ -59,16 +59,16 @@ module Pragmater
       runner.run(action: :add) { |file| say_status :info, "Processed: #{file}.", :green }
     end
 
-    desc "-r, [--remove=PATH]", "Remove pragma comments from source file(s)."
+    desc "-r, [--remove=PATH]", "Remove comments from source file(s)."
     map %w[-r --remove] => :remove
     method_option :comments,
                   aliases: "-c",
-                  desc: "Pragma comments",
+                  desc: "Define desired comments",
                   type: :array,
                   default: configuration.to_h.dig(:remove, :comments)
     method_option :includes,
                   aliases: "-i",
-                  desc: "File include list",
+                  desc: "Include specific files and/or directories",
                   type: :array,
                   default: configuration.to_h.dig(:remove, :includes)
     def remove path = "."

data/lib/pragmater/identity.rb

@@ -12,7 +12,7 @@ module Pragmater
     end
 
     def self.version
-      "6.3.1"
+      "6.3.2"
     end
 
     def self.version_label

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.3.2
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runcom
@@ -246,14 +246,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.69'
+        version: '0.73'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.69'
+        version: '0.73'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -352,7 +352,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A command line interface for managing/formatting source file pragma comments.