pragmater 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e3cd60cb96e801aa4fd3cc4e1c6598d2298eb8b
-  data.tar.gz: f518b806aafe3e671c97651d739b59c81312fce5
+  metadata.gz: 019b606499c4c1acfa9567af9fb95091e3d6394e
+  data.tar.gz: 6565699d00d5b211e42b34af9370f9bdcbe99685
 SHA512:
-  metadata.gz: 714d74c9f14f6a301325e61e662388a2a780f98589f858b73f6a4080ca9afe77a5f8f5db6d56e86e92b7d75aca48efaa9a710b94d83d6ab5218b6529c03b15bf
-  data.tar.gz: fe04dadb9f1324af93dcaacf37bfdb50c9c8d8945f3f183170c1db3974f86c5b9d42b99d205383b331a55f95bd7d468180003e3d3ab6acc9d872d4c239b3f320
+  metadata.gz: f42b618a2a92e9e7740e0a969ed795bd86adcedf6a78f0e85170398e22e8c51d185f08299a0c22fb49cf4d35a6c9f82e83ab253ee2b6176f6a2933fbfb111293
+  data.tar.gz: 3b518cebc1e4835dee5e85f61d3810cd19296c5fbbf5bb2697058beddf27b622cb2beb86796dcacab9742cd57cd1e866499aac145b091bbae2814c7a8d291a1c

data/README.md

@@ -15,7 +15,7 @@ A command line interface for adding [directive pragma](https://en.wikipedia.org/
     # 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 a easy way to add pragma comments to single or
+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.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
@@ -27,6 +27,8 @@ multiple Ruby source files in order to benefit from improved memory and concurre
 - [Setup](#setup)
 - [Usage](#usage)
   - [Command Line Interface (CLI)](#command-line-interface-cli)
+  - [Customization](#customization)
+  - [Frozen String Literals](#frozen-string-literals)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -41,10 +43,12 @@ multiple Ruby source files in order to benefit from improved memory and concurre
 
 - Supports adding a pragma comment or multiple pragma comments to single or multiple source files.
 - Supports removing a pragma comment or multiple pragma comments from single or multiple source files.
-- Supports whitelist filtering. Defaults to `*.rb` and `*.rake` files.
+- Supports whitelist filtering. Defaults to any file.
 - Ensures duplicate pragma comments never exist.
 - Ensures pragma commments are always properly formatted.
 
+[![asciicast](https://asciinema.org/a/34038.png)](https://asciinema.org/a/34038)
+
 # Requirements
 
 0. [MRI 2.3.x](https://www.ruby-lang.org)
@@ -53,7 +57,7 @@ multiple Ruby source files in order to benefit from improved memory and concurre
 
 For a secure install, type the following (recommended):
 
-    gem cert --add <(curl -Ls https://www.my-website.com/gem-public.pem)
+    gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem)
     gem install pragmater --trust-policy MediumSecurity
 
 NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
@@ -75,12 +79,64 @@ From the command line, type: `pragmater help`
     pragmater -r, [--remove=REMOVE]  # Remove pragma comments from source file(s).
     pragmater -v, [--version]        # Show Pragmater version.
 
-Both the `--add` and `--remove` options provide the ability to supply specific pragma comments and/or whitelisted file
-extensions:
+Both the `--add` and `--remove` options provide the ability to supply specific pragma comments and/or whitelisted files:
+
+    -c, [--comments=one two three]   # Pragma comments
+    -w, [--whitelist=one two three]  # File extension whitelist
+
+## Customization
+
+Should the default settings not be desired, customization is allowed via the `.pragmaterrc` file. The `.pragmaterrc`
+can be created at a global and/or local level. Example:
+
+- Global: `~/.pragmaterrc`
+- Local: `<project repository root>/.pragmaterrc`
+
+Order of precedence for any setting is resolved as follows (with the last taking top priority):
+
+0. Global `~/.pragmaterrc`.
+0. Local project repository `.pragmaterrc`.
+0. CLI option (i.e. `--add` or `--remove` command options).
+
+Any setting provided to the CLI during runtime would trump a local/global setting and a local setting would trump a
+global setting. The global setting is the weakest of all but great for situations where custom settings should be
+applied to *all* projects. It is important to note that local settings completely trump any global settings -- there is
+no inheritance when local *and* global settings exist at the same time.
+
+The `.pragmaterrc` uses the following default settings:
+
+    :add:
+      :comments: []
+      :whitelist: []
+    :remove:
+      :comments: []
+      :whitelist: []
+
+Each `.pragmaterrc` setting can be configured as follows:
+
+- `add`: Defines global/local comments and/or whitelists when adding pragma comments. The `comments` and `whitelist`
+  options can be either a single string or an array of values.
+- `remove`: Defines global/local comments and/or whitelists when removing pragma comments. The `comments` and
+  `whitelist` options can be either a single string or an array of values.
+
+## 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:
+
+    # 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, 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:
 
-    -c, [--comments=one two three]    # Pragma comments
-    -e, [--extensions=one two three]  # File extension whitelist
-                                      # Default: [".rb", ".rake"]
+    --debug=frozen-string-literal
 
 # Tests
 

data/bin/pragmater

@@ -1,5 +1,4 @@
-#!/usr/bin/ruby
-# frozen_string_literal: true
+#! /usr/bin/ruby
 
 require "pragmater"
 require "pragmater/cli"

data/lib/pragmater.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "pragmater/commenter"
+require "pragmater/configuration"
 require "pragmater/formatter"
 require "pragmater/identity"
 require "pragmater/writer"

data/lib/pragmater/cli.rb

@@ -16,22 +16,25 @@ module Pragmater
 
     def initialize args = [], options = {}, config = {}
       super args, options, config
+      @configuration = Configuration.new Identity.file_name
     end
 
     desc "-a, [--add=ADD]", "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 :extensions, aliases: "-e", desc: "File extension whitelist", type: :array, default: [".rb", ".rake"]
+    method_option :whitelist, aliases: "-w", desc: "File extension whitelist", type: :array, default: []
     def add path
-      write path, options[:comments], options[:extensions], :add
+      settings = configuration.merge add: {comments: options[:comments], whitelist: options[:whitelist]}
+      write path, settings, :add
     end
 
     desc "-r, [--remove=REMOVE]", "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 :extensions, aliases: "-e", desc: "File extension whitelist", type: :array, default: [".rb", ".rake"]
+    method_option :whitelist, aliases: "-w", desc: "File extension whitelist", type: :array, default: []
     def remove path
-      write path, options[:comments], options[:extensions], :remove
+      settings = configuration.merge remove: {comments: options[:comments], whitelist: options[:whitelist]}
+      write path, settings, :remove
     end
 
     desc "-e, [--edit]", "Edit #{Pragmater::Identity.label} settings in default editor."
@@ -56,23 +59,39 @@ module Pragmater
 
     private
 
+    attr_reader :configuration
+
+    def whitelisted_files path, whitelist
+      file_filter = whitelist.empty? ? %(#{path}/**/*) : %(#{path}/**/*{#{whitelist.join ","}})
+      Pathname.glob(file_filter).select(&:file?)
+    end
+
     def update_file path, comments, action
       Writer.new(path, comments).public_send action
-      say "Updated: #{path}."
+      info "Processed: #{path}."
+    rescue ArgumentError => error
+      formatted_message = error.message
+      formatted_message[0] = formatted_message[0].capitalize
+      error "#{formatted_message}: #{path}."
     end
 
-    def write path, comments, extensions, action
-      pathname = Pathname path
-
+    def update_files path, comments, whitelist, action
       case
-        when pathname.file?
-          update_file pathname, comments, action
-        when pathname.directory?
-          files = Pathname.glob %(#{pathname}/**/*{#{extensions.join ","}})
-          files.each { |file_path| update_file file_path, comments, action }
+        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}."
       end
     end
+
+    def write path, settings, action
+      pathname = Pathname path
+      comments = Array settings.dig(action).dig(:comments)
+      whitelist = Array settings.dig(action).dig(:whitelist)
+
+      update_files pathname, comments, whitelist, action
+    end
   end
 end

data/lib/pragmater/commenter.rb

@@ -21,8 +21,12 @@ module Pragmater
 
     attr_reader :older, :newer, :formatter
 
+    def filter comments
+      Array(comments).select { |comment| comment =~ formatter.valid_formats }
+    end
+
     def format comments
-      Array(comments).map { |comment| formatter.new(comment).format }
+      filter(comments).map { |comment| formatter.new(comment).format }
     end
   end
 end

data/lib/pragmater/configuration.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "refinements/hash_extensions"
+
+module Pragmater
+  # Default gem configuration with support for custom settings.
+  class Configuration
+    using Refinements::HashExtensions
+    attr_reader :settings
+
+    def self.defaults
+      {
+        add: {
+          comments: "",
+          whitelist: []
+        },
+        remove: {
+          comments: "",
+          whitelist: []
+        }
+      }
+    end
+
+    def initialize file_name = Identity.file_name, defaults: self.class.defaults
+      @file_name = file_name
+      @defaults = defaults
+      @settings = defaults.deep_merge load_settings
+    end
+
+    def local_file_path
+      File.join Dir.pwd, file_name
+    end
+
+    def global_file_path
+      File.join ENV["HOME"], file_name
+    end
+
+    def computed_file_path
+      File.exist?(local_file_path) ? local_file_path : global_file_path
+    end
+
+    def merge custom_settings
+      custom_settings[:add].delete_if { |_, value| value.empty? } if custom_settings.key?(:add)
+      custom_settings[:remove].delete_if { |_, value| value.empty? } if custom_settings.key?(:remove)
+      settings.deep_merge custom_settings
+    end
+
+    private
+
+    attr_reader :file_name, :defaults
+
+    def load_settings
+      yaml = YAML.load_file computed_file_path
+      yaml.is_a?(Hash) ? yaml : {}
+    rescue
+      defaults
+    end
+  end
+end

data/lib/pragmater/formatter.rb

@@ -16,45 +16,49 @@ module Pragmater
 
     def self.pragma_format
       /
-        \A  # Start of line.
-        \#  # Start of comment.
-        \s? # Space - optional.
-        \w+ # Key - 1 or more word characters only.
-        \:  # Key and value delimiter.
-        \s? # Space - optional.
-        .+  # Value - 1 or more characters.
-        \Z  # End of line.
+        \A       # Start of line.
+        \#       # Start of comment.
+        \s?      # Space - optional.
+        \w+      # Key - 1 or more word characters only.
+        \:       # Key and value delimiter.
+        \s?      # Space - optional.
+        [\w\-]+  # Value - 1 or more word or dash characters.
+        \Z       # End of line.
       /x
     end
 
-    def initialize comment
-      @comment = comment
+    def self.valid_formats
+      Regexp.union shebang_format, pragma_format
+    end
+
+    def initialize string
+      @string = string
     end
 
     def format_shebang
-      return comment unless comment =~ self.class.shebang_format
+      return string unless string =~ self.class.shebang_format
 
-      _, path = comment.split "!"
+      _, path = string.split "!"
       "#! #{path.strip}"
     end
 
     def format_pragma
-      return comment unless comment =~ self.class.pragma_format
+      return string unless string =~ self.class.pragma_format
 
-      key, value = comment.split ":"
+      key, value = string.split ":"
       "# #{key.gsub(/\#\s?/, "")}: #{value.strip}"
     end
 
     def format
-      case comment
+      case string
         when self.class.shebang_format then format_shebang
         when self.class.pragma_format then format_pragma
-        else comment
+        else string
       end
     end
 
     private
 
-    attr_reader :comment
+    attr_reader :string
   end
 end

data/lib/pragmater/identity.rb

@@ -12,7 +12,7 @@ module Pragmater
     end
 
     def self.version
-      "0.1.0"
+      "1.0.0"
     end
 
     def self.version_label

data/lib/pragmater/writer.rb

@@ -13,11 +13,16 @@ module Pragmater
     end
 
     def add
-      write { (format(commenter.new(old_comments, new_comments).add) + file_lines_without_comments).join }
+      comments = format commenter.new(old_comments, new_comments).add
+      lines = comments + file_lines_without_comments
+      insert_spacing! lines, comments
+      write { lines.join }
     end
 
     def remove
-      write { (format(commenter.new(old_comments, new_comments).remove) + file_lines_without_comments).join }
+      lines = format(commenter.new(old_comments, new_comments).remove) + file_lines_without_comments
+      remove_spacing! lines
+      write { lines.join }
     end
 
     private
@@ -25,7 +30,7 @@ module Pragmater
     attr_reader :file_path, :file_lines, :new_comments, :old_comments, :formatter, :commenter
 
     def file_comments
-      file_lines.select { |line| line =~ formatter.shebang_format || line =~ formatter.pragma_format }
+      file_lines.select { |line| line =~ formatter.valid_formats }
     end
 
     def file_lines_without_comments
@@ -36,6 +41,17 @@ module Pragmater
       lines.map { |line| "#{line}\n" }
     end
 
+    def insert_spacing! lines, comments
+      return if comments.empty?
+      return if lines.size == 1
+      return if lines[comments.size] == "\n"
+      lines.insert comments.size, "\n"
+    end
+
+    def remove_spacing! lines
+      lines.delete_at(0) if lines.first == "\n"
+    end
+
     def write
       File.open(file_path, "w") { |file| file.write yield }
     end

data/lib/tasks/console.rake

@@ -0,0 +1,7 @@
+desc "Open IRB console for gem development environment"
+task :console do
+  require "irb"
+  require "pragmater"
+  ARGV.clear
+  IRB.start
+end

data/lib/tasks/rspec.rake

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 begin
   require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)

data/lib/tasks/rubocop.rake

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 begin
   require "rubocop/rake_task"
   RuboCop::RakeTask.new

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: thor_plus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +70,16 @@ dependencies:
   name: gemsmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -278,9 +292,11 @@ files:
 - lib/pragmater.rb
 - lib/pragmater/cli.rb
 - lib/pragmater/commenter.rb
+- lib/pragmater/configuration.rb
 - lib/pragmater/formatter.rb
 - lib/pragmater/identity.rb
 - lib/pragmater/writer.rb
+- lib/tasks/console.rake
 - lib/tasks/rspec.rake
 - lib/tasks/rubocop.rake
 homepage: https://github.com/bkuhlmann/pragmater