pragmater 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eae89a8953fc22340f54ee5a0ebbaa4b461f1df0
-  data.tar.gz: 78b918e61f371a29654240b8b37c5484138dae5f
+  metadata.gz: e86d124630ff11d3a04bed3059baa0875a36dbee
+  data.tar.gz: f5961efc8428ed964111a6f5437b5b095e9a9857
 SHA512:
-  metadata.gz: a6e3b06955499cc80949af96846a7c1a735840af0a13a24a151b680693c7c06d40bf52aed0bcc244ee869ababe86df9cd349de468c0cd3f1c67a69de31281cb5
-  data.tar.gz: f3da09ed2bca12a708f5d698c22a4f4c5ff35a0e94c60cdbb769963574917d42d79ca3513b128ef5defe5d793b2be7df366dc76976bbb84ac99719b913062946
+  metadata.gz: 99fc8efe9b5f937cc2ad5f0c6e85ff8aab88a5e881da0d7f7a5c105c926b06489c1c0a4052c6f5ce8783ed509815ba762b5d0f01943813cf8166eb213f90e1c9
+  data.tar.gz: add8946a9e598585554ca4d01fba1797722692e26b92bd5a393f7c54264a10988cf2e16023965e26bea1e506a87a2da4f74e0922c29380f360dcad59473e59ec

data/README.md

@@ -14,9 +14,9 @@ pragma](https://en.wikipedia.org/wiki/Directive_(programming)) comments (a.k.a.
     # frozen_string_literal: true
     # encoding: UTF-8
 
-With the release of [Ruby 2.3.0](https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released), support for frozen
-strings are now supported via a pragma comment. This gems 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.
+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.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -30,6 +30,7 @@ multiple Ruby source files in order to benefit from improved memory and concurre
   - [Command Line Interface (CLI)](#command-line-interface-cli)
   - [Customization](#customization)
   - [Frozen String Literals](#frozen-string-literals)
+  - [Available Comments](#available-comments)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -46,7 +47,7 @@ multiple Ruby source files in order to benefit from improved memory and concurre
 - Supports removing a pragma comment or multiple pragma comments from single or multiple source files.
 - Supports whitelist filtering. Defaults to any file.
 - Ensures duplicate pragma comments never exist.
-- Ensures pragma comments are always properly formatted.
+- Ensures pragma comments are consistently formatted.
 
 # Screencasts
 
@@ -76,13 +77,14 @@ For an insecure install, type the following (not recommended):
 
 From the command line, type: `pragmater help`
 
-    pragmater -a, [--add=ADD]        # Add pragma comments to source file(s).
-    pragmater -e, [--edit]           # Edit gem settings in default editor.
-    pragmater -h, [--help=HELP]      # Show this message or get help for a command.
-    pragmater -r, [--remove=REMOVE]  # Remove pragma comments from source file(s).
-    pragmater -v, [--version]        # Show gem version.
+    pragmater -a, [--add=PATH]      # Add pragma comments to source file(s).
+    pragmater -e, [--edit]          # Edit gem settings in default editor.
+    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 -v, [--version]       # Show gem version.
 
-Both the `--add` and `--remove` options provide the ability to supply specific pragma comments and/or whitelisted files:
+Both the `--add` and `--remove` commands support options for specifying pragma comments and/or whitelisted files
+(viewable by running `pragmater --help --add` or `pragmater --help --remove`):
 
     -c, [--comments=one two three]   # Pragma comments
     -w, [--whitelist=one two three]  # File extension whitelist
@@ -124,8 +126,8 @@ Each `.pragmaterrc` setting can be configured as follows:
 
 ## Frozen String Literals
 
-With Ruby 2.3.0, support of frozen string literals are now supported. These comments are meant to be placed at the top
-of each source file. Example:
+With Ruby 2.3.0, support for frozen strings was added. These comments are meant to be placed at the top of each source
+file. Example:
 
     # frozen_string_literal: true
 
@@ -134,13 +136,25 @@ aid of this gem). As an alternative, frozen string literals can be enabled via t
 
     --enable=frozen-string-literal
 
-It is important to note that once enabled, it freezes strings program-wide -- It's an all or nothing option.
+It is important to note that, once enabled, it 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
 
+## 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

@@ -19,7 +19,7 @@ module Pragmater
       @configuration = Configuration.new Identity.file_name
     end
 
-    desc "-a, [--add=ADD]", "Add pragma comments to source file(s)."
+    desc "-a, [--add=PATH]", "Add pragma comments to source file(s)."
     map %w[-a --add] => :add
     method_option :comments, aliases: "-c", desc: "Pragma comments", type: :array, default: []
     method_option :whitelist, aliases: "-w", desc: "File extension whitelist", type: :array, default: []
@@ -28,7 +28,7 @@ module Pragmater
       write path, settings, :add
     end
 
-    desc "-r, [--remove=REMOVE]", "Remove pragma comments from source file(s)."
+    desc "-r, [--remove=PATH]", "Remove pragma comments from source file(s)."
     map %w[-r --remove] => :remove
     method_option :comments, aliases: "-c", desc: "Pragma comments", type: :array, default: []
     method_option :whitelist, aliases: "-w", desc: "File extension whitelist", type: :array, default: []
@@ -51,7 +51,7 @@ module Pragmater
       say Pragmater::Identity.version_label
     end
 
-    desc "-h, [--help=HELP]", "Show this message or get help for a command."
+    desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
     map %w[-h --help] => :help
     def help task = nil
       say and super
@@ -76,13 +76,12 @@ module Pragmater
     end
 
     def update_files path, comments, whitelist, action
-      case
-        when path.file?
-          update_file path, comments, action
-        when path.directory?
-          whitelisted_files(path, whitelist).each { |file_path| update_file file_path, comments, action }
-        else
-          error "Invalid path: #{path}."
+      if path.file?
+        update_file path, comments, action
+      elsif path.directory?
+        whitelisted_files(path, whitelist).each { |file_path| update_file file_path, comments, action }
+      else
+        error %(Invalid source path: "#{path}".)
       end
     end
 

data/lib/pragmater/identity.rb

@@ -12,7 +12,7 @@ module Pragmater
     end
 
     def self.version
-      "1.2.0"
+      "1.3.0"
     end
 
     def self.version_label

data.tar.gz.sig

@@ -1,3 +1,2 @@
-���g�F�iJsch¬�������v�3A�dg8'Vs2�>jG���u��A��nu}Vdc�k�A$J��<5y)b�Pɚ\�d���B�ø6��䊛��K�e�_��u��O�l`
71��w�{ؙ����2�ˇ��™H���UYk��ǥ(�T�IY��c��˨�-�����L����D�@ʚ�p��_���?0�rs
-���gC��B���?mp�ۣ��^
-�j����3ZC+XF�ܺ�����D�
+H)��X)}�.�ۦ������[��l����t�w$��o��C� 3���%I�;Ȍ:��$�<�o؞h����[�=K�bSrx�*�V����F��Y�-ßؾ&�e�1p~��#�ڰI��^�X�$���(��<�����-�|H��)��E5�%'L,����~~
+:0� c�(��lq������~��(�wpTG�)!F�q"�x[�o���
����Lo}ƛL�����7	��/GK�~���

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,14 +52,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
@@ -78,30 +78,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: gemsmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -130,20 +130,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-remote
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-state
   requirement: !ruby/object:Gem::Requirement
@@ -158,34 +144,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-rescue
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bond
   requirement: !ruby/object:Gem::Requirement
@@ -246,16 +204,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -330,16 +288,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.40'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -397,7 +355,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A command line interface for managing/formatting source file pragma comments.