pragmater 7.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39ff1bf7d56825c6ff55879809f65bb9452ba458835496116b5e0e331cfea2c7
-  data.tar.gz: a7e2869f307d28894d0647bbfb8a3bf654283690788d8e63c4f640fef853d700
+  metadata.gz: d09a7c2eff13a802e8faf5b48f7f6e3a4325c3a065dcd05522cbddeffda88111
+  data.tar.gz: ef70a555ebcce0db9bf3826a2312995f57ee56760648d094b70a7c06862b5b8b
 SHA512:
-  metadata.gz: dd31dc04fff4fbea52f93d711b8e4872982509412247f6658dd8f19142a100f435c44b02f6aff413dfc1167e7d9498fd9b390b9d568db54a61ce6a4fff7ceb68
-  data.tar.gz: 7544143fc6176e9d900c49568ad514d9b160787e045073e09bc74a6dc5b85c940cecccc0198805c696d1f61c52c161920e9031bd04a5de33cef33cefd361488c
+  metadata.gz: 0112f5097ef02cf51c3f24b5e04be96dbbbe18165f72c1733618880f7675cd4d5c495fd635883a8e80981b828e139115b2127b82c61cff4cf1ef7a91e98ec847
+  data.tar.gz: 6e6b2382eb480b6ec1a52d370b66b011ef471eb0066f9ba2dad3ad9365d028f7ece0fd67585f65aeb5dfac3e863937c282b572b79b45914254dca764717cfbd2

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2015 [Alchemists](https://www.alchemists.io).
+Copyright 2015 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
-compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is
 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

data/README.adoc

@@ -0,0 +1,323 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Pragmater
+
+[link=http://badge.fury.io/rb/pragmater]
+image::https://badge.fury.io/rb/pragmater.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
+[link=https://circleci.com/gh/bkuhlmann/pragmater]
+image::https://circleci.com/gh/bkuhlmann/pragmater.svg?style=svg[Circle CI Status]
+
+A command line interface for managing/formatting source file
+https://en.wikipedia.org/wiki/Directive_(programming)[directive pragmas] (a.k.a. _magic comments_).
+Examples:
+
+[source,ruby]
+----
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+# encoding: UTF-8
+----
+
+With https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released[Ruby 2.3.0], frozen strings
+are supported via a pragma. This gem provides an easy way to insert or remove pragmas to single or
+multiple Ruby source files in order to benefit from improved memory and concurrency performance.
+
+toc::[]
+
+== Features
+
+* Supports inserting 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 pragmas never exist.
+* Ensures pragmas are consistently formatted.
+
+== Screencasts
+
+[link=https://www.alchemists.io/screencasts/pragmater]
+image::https://www.alchemists.io/images/screencasts/pragmater/cover.svg[Screencast,600,240,role=focal_point]
+
+== Requirements
+
+. https://www.ruby-lang.org[Ruby]
+
+== Setup
+
+To install, run:
+
+[source,bash]
+----
+gem install pragmater
+----
+
+== Usage
+
+=== Command Line Interface (CLI)
+
+From the command line, type: `pragmater --help`
+
+....
+Pragmater - A command line interface for managing/formatting source file pragma comments.
+
+USAGE:
+  -v, --version                            Show gem version.
+  -h, --help                               Show this message.
+  -c, --config [options]                   Manage gem configuration.
+  -i, --insert [PATH]                      Insert pragam comments into files.
+  -r, --remove [options]                   Remove pragam comments from files.
+
+OPTIONS:
+
+Insert/Remove:
+      --comments a,b,c                     Add pragma comments.
+      --includes a,b,c                     Add console support.
+
+Configuration:
+      --edit                               Edit configuration.
+      --info                               Print configuration.
+....
+
+Both the `--insert` and `--remove` commands support the same options for specifying pragmas and/or
+included files. Example:
+
+[source,bash]
+----
+pragmater --insert --comments "# frozen_string_literal: true" --includes "Gemfile" "Guardfile" "Rakefile" ".gemspec" "config.ru" "bin/**/*" "**/*.rake" "**/*.rb"
+----
+
+The `--insert` and `--remove` commands default to the current working directory so a path isn’t
+necessary unless you want to run Pragmater in a directory structure other than your current working
+directory.
+
+=== Customization
+
+This gem can be configured via a global configuration: `$HOME/.config/pragmater/configuration.yml`
+
+It can also be configured via link:https://www.alchemists.io/projects/xdg[XDG] environment
+variables.
+
+The default configuration is as follows:
+
+[source,yaml]
+----
+:insert:
+  :comments: []
+  :includes: []
+:remove:
+  :comments: []
+  :includes: []
+----
+
+Feel free to take the above configuration, modify, and save as your own custom `configuration.yml`.
+
+The `configuration.yml` file can be configured as follows:
+
+* `insert`: Defines global/local comments and/or file include lists when inserting pragmas. The
+  `comments` and `includes` options can be either a single string or an array of strings.
+* `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 of strings.
+
+=== 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:
+
+[source,ruby]
+----
+# 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:
+
+[source,ruby]
+----
+# 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:
+
+[source,ruby]
+----
+# 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).
+
+[source,ruby]
+----
+# frozen_string_literal: false
+# frozen_string_literal: true
+----
+
+In the above example, frozen string literal support _will be enabled_ instead of being disabled.
+
+[source,ruby]
+----
+# warn_indent: false
+# warn_indent: true
+----
+
+In the above example, indentation warnings _will be enabled_ instead of being disabled.
+
+=== Frozen String Literals
+
+Support for frozen string literals was added in Ruby 2.3.0. The ability to freeze strings within a
+source can be done by placing a frozen string pragma at the top of each source file. Example:
+
+[source,ruby]
+----
+# frozen_string_literal: true
+----
+
+This is great for _selective_ enablement of frozen string literals but might be too much work for
+some (even with the aid of this gem). As an alternative, frozen string literals can be enabled via
+the following Ruby command line option:
+
+....
+--enable=frozen-string-literal
+....
+
+It is important to note that, once enabled, this freezes strings program-wide – It’s an all or
+nothing option.
+
+Regardless of whether you leverage the capabilities of this gem or the Ruby command line option
+mentioned above, the following Ruby command line option is available to aid debugging and tracking
+down frozen string literal issues:
+
+....
+--debug=frozen-string-literal
+....
+
+Ruby 2.3.0 also added the following methods to the `String` class:
+
+* `String#+@`: Answers a duplicated, mutable, string if not already frozen. Example:
++
+[source,ruby]
+----
+immutable = "test".freeze
+mutable = +immutable
+mutable.capitalize! # => "Test"
+----
+* `String#-@`: Answers a immutable string if not already frozen. Example:
++
+[source,ruby]
+----
+mutable = "test"
+immutable = -mutable
+immutable.capitalize! # => FrozenError
+----
+
+You can also use the methods, shown above, for variable initialization. Example:
+
+[source,ruby]
+----
+immutable = -"test"
+mutable = +"test"
+----
+
+💡 The use of `+String#-@+`, specifically, was http://bit.ly/2DGAjgG[enhanced in Ruby 2.5.0] 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.
+
+=== Consistency
+
+As an added bonus, this gem ensures pragmas for all analyzed files are formatted in a consistent
+style. This means there is always a space after the octothorpe (`#`). Here are multiple pragmas
+presented together for a visual comparison:
+
+[source,ruby]
+----
+#! /usr/bin/env ruby
+# encoding: UTF-8
+# coding: UTF-8
+# frozen_string_literal: true
+# warn_indent: true
+----
+
+One oddity to the above is the use of `# !/usr/bin/env ruby` is not allowed but `#! /usr/bin/env
+ruby` is which is why spacing is slightly different for shell pragmas.
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/pragmater.git
+cd pragmater
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].