pragmater 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d207f1d3b63fba912f2f781c3e2f7b9175b05761940d692b3234dea30c06a9e
-  data.tar.gz: db2f6c630023f76b4163679cccf8c447b5ea341f41e534f79505389103377aca
+  metadata.gz: 43d44e1947b60d7b411a16fe44c69806b76e30ddb7088d31342f79774164d8ff
+  data.tar.gz: 6489dc53d3557222ed545a280622b806ca781006d699d40dec3611486f3c5486
 SHA512:
-  metadata.gz: 37b22ae14a11750281782cf0c540364f0a149326885ca93e24b4110b2a0f8b4436db53871c8784758361daefb67975ce6cdf496d4b9c8183f9c70d9636edf36e
-  data.tar.gz: e929ba3fce0169fa21716d1791744b49b4c4c42deca2b0c049376746dc33ff4c3b59a5600ef94b2e6ea4a700e9105fe60f07da522e26e5853517300a371ffecc
+  metadata.gz: a7b2206f9a09f74bc8bd60f7da523ab908f6d3e1709e311a117c28699ff67985d76e6c9b12e775aeccf4bebfd772029c9eb6be88139cc2ff21e47efba9220eb2
+  data.tar.gz: 32ce7f987dccfe5f0de528dd7354b24b40b24d7945186d9a54b9714f2d99d31c204d854a1162b8a7660b3bd46473e35e8abfe169e19dc3869afbd777c2ff25b4

data/README.md

@@ -3,7 +3,6 @@
 [![Gem Version](https://badge.fury.io/rb/pragmater.svg)](http://badge.fury.io/rb/pragmater)
 [![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/f0971ab6985309ce4db4/maintainability)](https://codeclimate.com/github/bkuhlmann/pragmater/maintainability)
 [![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/f0971ab6985309ce4db4/test_coverage)](https://codeclimate.com/github/bkuhlmann/pragmater/test_coverage)
-[![Gemnasium Status](https://gemnasium.com/bkuhlmann/pragmater.svg)](https://gemnasium.com/bkuhlmann/pragmater)
 [![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
@@ -81,6 +80,14 @@ included files (viewable by running `pragmater --help --add` or `pragmater --hel
     -c, [--comments=one two three]  # Pragma comments
     -i, [--includes=one two three]  # File include list
 
+Example (same options could be used for the `--remove` command too):
+
+    pragmater --add --comments "# frozen_string_literal: true" --includes "Gemfile" "Guardfile" "Rakefile" ".gemspec" "config.ru" "bin/**/*" "**/*.rake" "**/*.rb"
+
+The `--add` and `--remove` commands default to the current working directory so a path isn't
+necessary unless you want to run Pragmater on a directory structure *other than* your current
+working directory.
+
 ### Customization
 
 This gem can be configured via a global configuration:
@@ -111,8 +118,8 @@ The `configuration.yml` file can be configured as follows:
 
 ### Frozen String Literals
 
-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:
+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:
 
     # frozen_string_literal: true
 
@@ -122,7 +129,7 @@ the following Ruby command line option:
 
     --enable=frozen-string-literal
 
-It is important to note that, once enabled, it freezes strings program-wide -- It's an all or
+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
@@ -131,6 +138,37 @@ 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:
+
+        immutable = "test".freeze
+        mutable = +immutable
+        mutable.capitalize! # => "Test"
+
+- `String#-@`: Answers a immutable string if not already frozen. Example:
+
+        mutable = "test"
+        immutable = -mutable
+        immutable.capitalize! # => FrozenError
+
+You can also use the methods, shown above, for variable initialization. Example:
+
+    immutable = -"test"
+    mutable = +"test"
+
+Despite Ruby allowing you to do this, it is *not recommended* to use the above examples as it leads
+to hard to read code. Instead use the following:
+
+    immutable = "test".freeze
+    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
+*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:

data/lib/pragmater/cli.rb

@@ -13,7 +13,7 @@ module Pragmater
     package_name Identity.version_label
 
     def self.configuration
-      Runcom::Configuration.new project_name: Identity.name, defaults: {
+      Runcom::Configuration.new Identity.name, defaults: {
         add: {
           comments: "",
           includes: []
@@ -45,7 +45,9 @@ module Pragmater
                   type: :array,
                   default: configuration.to_h.dig(:add, :includes)
     def add path = "."
-      settings = configuration.merge add: {comments: options.comments, includes: options.includes}
+      settings = configuration.merge(
+        add: {comments: options.comments, includes: options.includes}
+      ).to_h
 
       runner = Runner.new path,
                           comments: settings.dig(:add, :comments),
@@ -67,10 +69,9 @@ module Pragmater
                   type: :array,
                   default: configuration.to_h.dig(:remove, :includes)
     def remove path = "."
-      settings = configuration.merge remove: {
-        comments: options.comments,
-        includes: options.includes
-      }
+      settings = configuration.merge(
+        remove: {comments: options.comments, includes: options.includes}
+      ).to_h
 
       runner = Runner.new path,
                           comments: settings.dig(:remove, :comments),

data/lib/pragmater/identity.rb

@@ -12,7 +12,7 @@ module Pragmater
     end
 
     def self.version
-      "5.0.2"
+      "5.1.0"
     end
 
     def self.version_label

metadata

@@ -1,14 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2018-01-06 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xODAyMTQxNTA4NDVaFw0xOTAyMTQx
+  NTA4NDVaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
+  xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
+  brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
+  9z0A8KcGhz67SdcoQiD7qiCjL/2NTeWHOzkpPrdGlt088+VerEEGf5I13QCvaftP
+  D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
+  3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
+  AQABo3sweTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
+  2CdikiiE3fJhP/gY4ggwHwYDVR0RBBgwFoEUYnJvb2tlQGFsY2hlbWlzdHMuaW8w
+  HwYDVR0SBBgwFoEUYnJvb2tlQGFsY2hlbWlzdHMuaW8wDQYJKoZIhvcNAQELBQAD
+  ggEBAImQPNpkb90nkDUCJ4ivQNKK1LCebOjqZnOWGC4HxndvBQBqj78MTZifoODl
+  uPBY4fSnnpVGph+Y1OTWw/xhk3HE2AH0GDGC9xbM75qrg3/+a4D81pM94B6zuBdA
+  7hxUy4kByawrii833IidV0zkI4lCombTNicc8JWXXSlL2G/sWPLndNvn5rzoyyRT
+  pPOLYGdB4hqUam3hBgLOsYIOVp+yXMvj0gvk/Djq8IR2P1RS4NZU7HHD485xkBfL
+  4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
+  b4jw5t40FKyNUvLPPXYAvQALBtk=
+  -----END CERTIFICATE-----
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runcom
@@ -16,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -81,47 +102,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-- !ruby/object:Gem::Dependency
-  name: git-cop
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +205,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +233,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.54'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.54'
 - !ruby/object:Gem::Dependency
   name: wirb
   requirement: !ruby/object:Gem::Requirement
@@ -271,7 +278,10 @@ files:
 homepage: https://github.com/bkuhlmann/pragmater
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/bkuhlmann/pragmater
+  changelog_uri: https://github.com/bkuhlmann/pragmater/blob/master/CHANGES.md
+  bug_tracker_uri: https://github.com/bkuhlmann/pragmater/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -288,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A command line interface for managing/formatting source file pragma comments.

metadata.gz.sig

@@ -0,0 +1,2 @@
+ȷq�|U��.��Z��}�Rߧ�#��G�NEX��k>��
�%	
+4�Z��˸|/m��uP�T[`�Ff�i���Ur!W��NA7�=��4��N����)&�$�@���=������6=Rf�eC�ںq}SD]�r*�Lf�W���N�_+���Ϡ^[[TQ�J�1%�k��ڮ�������p���%w