pragmater 7.0.0 → 8.1.0

data/lib/pragmater/formatters/shebang.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Formatters
+    # Formats shebang pragmas in a consistent manner.
+    class Shebang
+      PATTERN = %r(\A\#!\s?/.*ruby\Z).freeze
+
+      def initialize string, pattern: PATTERN
+        @string = string
+        @pattern = pattern
+      end
+
+      def call
+        return string unless string.match? pattern
+
+        string.split("!").then { |octothorpe, path| "#{octothorpe}! #{path.strip}" }
+      end
+
+      private
+
+      attr_reader :string, :pattern
+    end
+  end
+end

data/lib/pragmater/identity.rb

@@ -3,20 +3,10 @@
 module Pragmater
   # Gem identity information.
   module Identity
-    def self.name
-      "pragmater"
-    end
-
-    def self.label
-      "Pragmater"
-    end
-
-    def self.version
-      "7.0.0"
-    end
-
-    def self.version_label
-      "#{label} #{version}"
-    end
+    NAME = "pragmater"
+    LABEL = "Pragmater"
+    VERSION = "8.1.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    SUMMARY = "A command line interface for managing/formatting source file pragma comments."
   end
 end

data/lib/pragmater/parsers/comments.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Parsers
+    # Manages pragma comments.
+    class Comments
+      def initialize older, newer, formatter: Formatters::Main
+        @formatter = formatter
+        @older = format older
+        @newer = format newer
+      end
+
+      def insert
+        older.union newer
+      end
+
+      def remove
+        older - older.intersection(newer)
+      end
+
+      private
+
+      attr_reader :formatter, :older, :newer
+
+      def format pragmas
+        Array(pragmas).map { |pragma| formatter.new(pragma).call }
+      end
+    end
+  end
+end

data/lib/pragmater/parsers/file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Parsers
+    # Parses a file into pragma comment and body lines.
+    class File
+      def initialize pattern: Formatters::Main::PATTERN,
+                     comments: Comments,
+                     processor: Processors::Handler.new
+        @pattern = pattern
+        @comments = comments
+        @processor = processor
+      end
+
+      def call path, new_comments, action:
+        path.each_line
+            .partition { |line| line.match? pattern }
+            .then do |old_comments, body|
+              processor.call action, wrap_in_new_line(old_comments, new_comments, action), body
+            end
+      end
+
+      private
+
+      attr_reader :pattern, :comments, :processor
+
+      def wrap_in_new_line old_comments, new_comments, action
+        comments.new(old_comments, new_comments).public_send(action).map { |line| "#{line}\n" }
+      end
+    end
+  end
+end

data/lib/pragmater/processors/handler.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Processors
+    # Handles the insertion or removal of pragma comments.
+    class Handler
+      DEFAULTS = {
+        insert: Inserter,
+        remove: Remover
+      }.freeze
+
+      def initialize processors: DEFAULTS
+        @processors = processors
+      end
+
+      def call action, comments, body
+        processors.fetch(action).new(comments, body).call
+      end
+
+      private
+
+      attr_reader :processors
+    end
+  end
+end

data/lib/pragmater/processors/inserter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Processors
+    # Inserts new pragma comments.
+    class Inserter
+      def initialize comments, body
+        @comments = comments
+        @body = body
+      end
+
+      def call
+        body.first.then do |first|
+          comments.append "\n" unless first == "\n" || body.empty?
+          comments + body
+        end
+      end
+
+      private
+
+      attr_reader :comments, :body
+    end
+  end
+end

data/lib/pragmater/processors/remover.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Processors
+    # Removes existing pragma comments.
+    class Remover
+      def initialize comments, body
+        @comments = comments
+        @body = body
+      end
+
+      def call
+        body.first.then do |first_line|
+          body.delete_at 0 if first_line == "\n" && comments.empty?
+          comments + body
+        end
+      end
+
+      private
+
+      attr_reader :comments, :body
+    end
+  end
+end

data/lib/pragmater/runner.rb

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
 
+require "refinements/pathnames"
+
 module Pragmater
   # Adds/removes pragma comments for files in given path.
   class Runner
-    # rubocop:disable Metrics/ParameterLists
-    def initialize path = ".", comments: [], includes: [], writer: Writer
-      @path = Pathname path
-      @comments = Array comments
-      @includes = Array includes
-      @writer = writer
-    end
-    # rubocop:enable Metrics/ParameterLists
+    using Refinements::Pathnames
 
-    def files
-      return [] unless path.exist? && path.directory? && !includes.empty?
+    def self.for **attributes
+      new Context[attributes]
+    end
 
-      Pathname.glob(%(#{path}/{#{includes.join ","}})).select(&:file?)
+    def initialize context, parser: Parsers::File.new
+      @context = context
+      @parser = parser
     end
 
-    def run action:
-      files.each do |file|
-        writer.new(file, comments).public_send action
-        yield file if block_given?
-      end
+    def call
+      Pathname(context.root_dir).files("{#{context.includes.join ","}}").map(&method(:write))
     end
 
     private
 
-    attr_reader :path, :comments, :includes, :writer
+    attr_reader :context, :parser
+
+    def write path
+      path.tap do |a_path|
+        a_path.write parser.call(a_path, context.comments, action: context.action).join
+      end
+    end
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xOTAyMTcxNjAxMTFaFw0yMDAyMTcx
-  NjAxMTFaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
+  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,60 +20,60 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBANgfX7kPZkJvsbdWMvbe
-  DUUYxRTqTUzCDpLd2p3sQvgLMKjTNSKt6CFq/kh+98b6RCgO6DqiVfxvOEq02dvf
-  ebMN/ylQqan2FgiAs1rpP0/D4C0MlBjoDktsT+2IyLol1KmkDB20ExJ4Sf1GRNdA
-  hpWOtcgqHtmrc7xzgB6BuyoYufrKKUlCO3ewTM4C375D2qO7hIdKuMOO3CdPMtSk
-  OrWpbzCL+nbbXqeoqiHgZaUvcyyQrGj5sQRxMTzuMXzzQxtHnuTuKrcz16HMTX/O
-  dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
-  y84=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
+  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
+  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
+  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
+  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
+  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
+  QWc=
   -----END CERTIFICATE-----
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: runcom
+  name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.14'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: climate_control
+  name: bundler-leak
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -106,28 +106,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -148,56 +148,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.78'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.78'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -218,56 +218,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: 
+        version: '0.19'
+description:
 email:
 - brooke@alchemists.io
 executables:
 - pragmater
 extensions: []
 extra_rdoc_files:
-- README.md
-- LICENSE.md
+- README.adoc
+- LICENSE.adoc
 files:
-- LICENSE.md
-- README.md
+- LICENSE.adoc
+- README.adoc
 - bin/pragmater
 - lib/pragmater.rb
-- lib/pragmater/cli.rb
-- lib/pragmater/commenter.rb
-- lib/pragmater/formatter.rb
+- lib/pragmater/cli/helper.rb
+- lib/pragmater/cli/options/assembler.rb
+- lib/pragmater/cli/options/configuration.rb
+- lib/pragmater/cli/options/core.rb
+- lib/pragmater/cli/options/defaults.yml
+- lib/pragmater/cli/options/insert_remove.rb
+- lib/pragmater/cli/options/merger.rb
+- lib/pragmater/cli/shell.rb
+- lib/pragmater/context.rb
+- lib/pragmater/formatters/general.rb
+- lib/pragmater/formatters/main.rb
+- lib/pragmater/formatters/shebang.rb
 - lib/pragmater/identity.rb
+- lib/pragmater/parsers/comments.rb
+- lib/pragmater/parsers/file.rb
+- lib/pragmater/processors/handler.rb
+- lib/pragmater/processors/inserter.rb
+- lib/pragmater/processors/remover.rb
 - lib/pragmater/runner.rb
-- lib/pragmater/writer.rb
-homepage: https://github.com/bkuhlmann/pragmater
+homepage: https://www.alchemists.io/projects/pragmater
 licenses:
 - Apache-2.0
 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: 
+  changelog_uri: https://www.alchemists.io/projects/pragmater/changes.html
+  documentation_uri: https://www.alchemists.io/projects/pragmater
+  source_code_uri: https://github.com/bkuhlmann/pragmater
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -282,8 +296,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A command line interface for managing/formatting source file pragma comments.
 test_files: []