pragmater 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62c44182adee2b8134834df3d99e82d38d23050f
-  data.tar.gz: c48a368afcbe24dc37cc856e6b592142c34de8e6
+  metadata.gz: 96c9a16d8a432e8001bf05e2fadba1b2bde5caee
+  data.tar.gz: 262b53eb16d75ce63efe509ab4266b9877c5ba57
 SHA512:
-  metadata.gz: 5d76f35dde56bd129ae3b77d02298ed4aa62f7fee367f5b0def0646c5ed46a23e2bfc21e17d4b835f2c8d37206d09f9eb96d1dc9a9a46904b978a8624e07179a
-  data.tar.gz: ec4e072e9334c86f0cf7aa5784a4f7c4c667f5926e955d9f30911bcf4e4b3f147022c1c6d417a040fa1b3ce35d8e20543dcdb2fc121103af60f6dd195ff90b2e
+  metadata.gz: d9327285f4442217347e21d59a22bcb27100b5241280c3786a28d05a9798f788cfe5fa1d91cb7e5d4e730206944e5e8249320406c8fe07c7ecef5322664c3100
+  data.tar.gz: 8e8a51a1a209e9bba75121cbb2154e0eba4f28fb27f47728a94081697dbc28e65a6a45f588e2f6890ae4594691d9773b8829e5db16435f2b2d93de9cc340ebb2

data/README.md

@@ -4,7 +4,7 @@
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/pragmater.svg)](https://codeclimate.com/github/bkuhlmann/pragmater)
 [![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/pragmater/coverage.svg)](https://codeclimate.com/github/bkuhlmann/pragmater)
 [![Gemnasium Status](https://gemnasium.com/bkuhlmann/pragmater.svg)](https://gemnasium.com/bkuhlmann/pragmater)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/pragmater.svg)](https://travis-ci.org/bkuhlmann/pragmater)
+[![Circle CI Status](https://circleci.com/gh/bkuhlmann/pragmater.svg?style=svg)](https://circleci.com/gh/bkuhlmann/pragmater)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 A command line interface for managing/formatting source file
@@ -89,29 +89,18 @@ Both the `--add` and `--remove` commands support options for specifying pragma c
 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
+    -w, [--whitelist=one two three]  # File 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:
+This gem can be configured via a global configuration:
 
-- Global: `~/.pragmaterrc`
-- Local: `<project repository root>/.pragmaterrc`
+    ~/.config/pragmater/configuration.yml
 
-Order of precedence for any setting is resolved as follows (with the last taking top priority):
+It can also be configured via [XDG environment variables](https://github.com/bkuhlmann/runcom#xdg)
+as provided by the [Runcom](https://github.com/bkuhlmann/runcom) gem.
 
-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:
+The default configuration is as follows:
 
     :add:
       :comments: []
@@ -120,7 +109,10 @@ The `.pragmaterrc` uses the following default settings:
       :comments: []
       :whitelist: []
 
-Each `.pragmaterrc` setting can be configured as follows:
+Feel free to take this default configuration, modify, and save as your own custom
+`configuration.yml`.
+
+The `configuration.yml` file 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.

data/lib/pragmater/cli.rb

@@ -8,7 +8,6 @@ require "runcom"
 
 module Pragmater
   # The Command Line Interface (CLI) for the gem.
-  # rubocop:disable Metrics/ClassLength
   class CLI < Thor
     include Thor::Actions
     include ThorPlus::Actions
@@ -16,7 +15,7 @@ module Pragmater
     package_name Identity.version_label
 
     def self.configuration
-      Runcom::Configuration.new file_name: Identity.file_name, defaults: {
+      Runcom::Configuration.new project_name: Identity.name, defaults: {
         add: {
           comments: "",
           whitelist: []
@@ -41,16 +40,20 @@ module Pragmater
                   default: []
     method_option :whitelist,
                   aliases: "-w",
-                  desc: "File extension whitelist",
+                  desc: "File whitelist",
                   type: :array,
                   default: []
-    def add path
+    def add path = "."
       settings = self.class.configuration.merge add: {
         comments: options[:comments],
         whitelist: options[:whitelist]
       }
 
-      write path, settings, :add
+      runner = Runner.new path,
+                          comments: settings.dig(:add, :comments),
+                          whitelist: settings.dig(:add, :whitelist)
+
+      runner.run(action: :add) { |file| info "Processed: #{file}." }
     end
 
     desc "-r, [--remove=PATH]", "Remove pragma comments from source file(s)."
@@ -62,19 +65,23 @@ module Pragmater
                   default: []
     method_option :whitelist,
                   aliases: "-w",
-                  desc: "File extension whitelist",
+                  desc: "File whitelist",
                   type: :array,
                   default: []
-    def remove path
+    def remove path = "."
       settings = self.class.configuration.merge remove: {
         comments: options[:comments],
         whitelist: options[:whitelist]
       }
 
-      write path, settings, :remove
+      runner = Runner.new path,
+                          comments: settings.dig(:remove, :comments),
+                          whitelist: settings.dig(:remove, :whitelist)
+
+      runner.run(action: :remove) { |file| info "Processed: #{file}." }
     end
 
-    desc "-c, [--config]", %(Manage gem configuration ("#{configuration.computed_path}").)
+    desc "-c, [--config]", "Manage gem configuration."
     map %w[-c --config] => :config
     method_option :edit,
                   aliases: "-e",
@@ -85,10 +92,11 @@ module Pragmater
                   desc: "Print gem configuration.",
                   type: :boolean, default: false
     def config
-      path = self.class.configuration.computed_path
+      path = self.class.configuration.path
 
       if options.edit? then `#{editor} #{path}`
-      elsif options.info? then say(path)
+      elsif options.info?
+        path ? say(path) : say("Configuration doesn't exist.")
       else help(:config)
       end
     end
@@ -104,42 +112,5 @@ module Pragmater
     def help task = nil
       say and super
     end
-
-    private
-
-    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
-      info "Processed: #{path}."
-    rescue ArgumentError => error
-      formatted_message = error.message
-      formatted_message[0] = formatted_message[0].capitalize
-      error "#{formatted_message}: #{path}."
-    end
-
-    # rubocop:disable Metrics/ParameterLists
-    def update_files path, comments, whitelist, action
-      if path.file?
-        update_file path, comments, action
-      elsif path.directory?
-        whitelisted_files(path, whitelist).each do |file_path|
-          update_file file_path, comments, action
-        end
-      else
-        error %(Invalid source 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/formatter.rb

@@ -43,9 +43,11 @@ module Pragmater
     end
 
     def format
+      klass = self.class
+
       case string
-        when self.class.shebang_format then format_shebang
-        when self.class.pragma_format then format_pragma
+        when klass.shebang_format then format_shebang
+        when klass.pragma_format then format_pragma
         else string
       end
     end

data/lib/pragmater/identity.rb

@@ -12,15 +12,11 @@ module Pragmater
     end
 
     def self.version
-      "3.1.0"
+      "4.0.0"
     end
 
     def self.version_label
       "#{label} #{version}"
     end
-
-    def self.file_name
-      ".#{name}rc"
-    end
   end
 end

data/lib/pragmater/runner.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pragmater
+  # Adds/removes pragma comments for files in given path.
+  class Runner
+    # rubocop:disable Metrics/ParameterLists
+    def initialize path = ".", comments: [], whitelist: [], writer: Writer
+      @path = Pathname path
+      @comments = Array comments
+      @whitelist = Array whitelist
+      @writer = writer
+    end
+
+    def files
+      return [] unless path.exist? && path.directory? && !whitelist.empty?
+      Pathname.glob(%(#{path}/{#{whitelist.join ","}})).select(&:file?)
+    end
+
+    def run action:
+      files.each do |file|
+        writer.new(file, comments).public_send action
+        yield file if block_given?
+      end
+    end
+
+    private
+
+    attr_reader :path, :comments, :whitelist, :writer
+  end
+end

data/lib/pragmater/writer.rb

@@ -2,11 +2,13 @@
 
 module Pragmater
   # Writes formatted pragma comments to source file.
+  # :reek:TooManyInstanceVariables
+  # :reek:PrimaDonnaMethod
   class Writer
     # rubocop:disable Metrics/ParameterLists
     def initialize file_path, new_comments, formatter: Formatter, commenter: Commenter
       @file_path = file_path
-      @file_lines = File.open(file_path, &:to_a)
+      @file_lines = File.readlines file_path
       @formatter = formatter
       @commenter = commenter
       @old_comments = file_comments
@@ -38,17 +40,23 @@ module Pragmater
       file_lines.reject { |line| old_comments.include? line }
     end
 
+    # :reek:UtilityFunction
     def format lines
       lines.map { |line| "#{line}\n" }
     end
 
+    # :reek:UtilityFunction
     def insert_spacing! lines, comments
+      comment_count = comments.size
+
       return if comments.empty?
       return if lines.size == 1
-      return if lines[comments.size] == "\n"
-      lines.insert comments.size, "\n"
+      return if lines[comment_count] == "\n"
+
+      lines.insert comment_count, "\n"
     end
 
+    # :reek:UtilityFunction
     def remove_spacing! lines
       lines.delete_at(0) if lines.first == "\n"
     end

data/lib/pragmater.rb

@@ -4,4 +4,5 @@ require "pragmater/identity"
 require "pragmater/formatter"
 require "pragmater/commenter"
 require "pragmater/writer"
+require "pragmater/runner"
 require "pragmater/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2017-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -212,28 +198,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -266,6 +252,7 @@ files:
 - lib/pragmater/commenter.rb
 - lib/pragmater/formatter.rb
 - lib/pragmater/identity.rb
+- lib/pragmater/runner.rb
 - lib/pragmater/writer.rb
 homepage: https://github.com/bkuhlmann/pragmater
 licenses: