pragmater 7.2.0 → 9.0.0

metadata.gz.sig

@@ -1,3 +1,2 @@
-\K���u��ȥfg�Z5V����b�E67	s��c��Sf��3�#*F�4�\���i�j�]�@�Ǵ
-����oD���	�07�q����_H}f$���T�?&{���߈�fE:������5[���
-�c��a�h�9o�M���U��"�,��
#
+��U�,2�.��u6&0��}�ǒZM*q"4�����Y�֧����U����8�<Ě璳�c����1��Zwב��Df#p����4{I�yP���i�S�)������I��V����A�gG^P�W����(�qy�v�{����3YSÄp������{��J�x5��}T2"�ʩX�7��p}?�]K"�fW��c�qP���w������Yl>��u@��;14�%��v8
+x\{�`K�ۭ��k ȸl�I

data/lib/pragmater/cli.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "thor"
-require "thor/actions"
-require "runcom"
-
-module Pragmater
-  # The Command Line Interface (CLI) for the gem.
-  class CLI < Thor
-    include Thor::Actions
-
-    package_name Identity::VERSION_LABEL
-
-    # rubocop:disable Metrics/MethodLength
-    def self.configuration
-      Runcom::Config.new "#{Identity::NAME}/configuration.yml",
-                         defaults: {
-                           add: {
-                             comments: "",
-                             includes: []
-                           },
-                           remove: {
-                             comments: "",
-                             includes: []
-                           }
-                         }
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def initialize args = [], options = {}, config = {}
-      super args, options, config
-      @configuration = self.class.configuration
-    rescue Runcom::Errors::Base => error
-      abort error.message
-    end
-
-    desc "-a, [--add=PATH]", "Add comments to source file(s)."
-    map %w[-a --add] => :add
-    method_option :comments,
-                  aliases: "-c",
-                  desc: "Define desired comments",
-                  type: :array,
-                  default: configuration.to_h.dig(:add, :comments)
-    method_option :includes,
-                  aliases: "-i",
-                  desc: "Include specific files and/or directories",
-                  type: :array,
-                  default: configuration.to_h.dig(:add, :includes)
-    def add path = "."
-      settings = configuration.merge(
-        add: {comments: options.comments, includes: options.includes}
-      ).to_h
-
-      runner = Runner.new path,
-                          comments: settings.dig(:add, :comments),
-                          includes: settings.dig(:add, :includes)
-
-      runner.run(action: :add) { |file| say_status :info, "Processed: #{file}.", :green }
-    end
-
-    desc "-r, [--remove=PATH]", "Remove comments from source file(s)."
-    map %w[-r --remove] => :remove
-    method_option :comments,
-                  aliases: "-c",
-                  desc: "Define desired comments",
-                  type: :array,
-                  default: configuration.to_h.dig(:remove, :comments)
-    method_option :includes,
-                  aliases: "-i",
-                  desc: "Include specific files and/or directories",
-                  type: :array,
-                  default: configuration.to_h.dig(:remove, :includes)
-    def remove path = "."
-      settings = configuration.merge(
-        remove: {comments: options.comments, includes: options.includes}
-      ).to_h
-
-      runner = Runner.new path,
-                          comments: settings.dig(:remove, :comments),
-                          includes: settings.dig(:remove, :includes)
-
-      runner.run(action: :remove) { |file| say_status :info, "Processed: #{file}.", :green }
-    end
-
-    desc "-c, [--config]", "Manage gem configuration."
-    map %w[-c --config] => :config
-    method_option :edit,
-                  aliases: "-e",
-                  desc: "Edit gem configuration.",
-                  type: :boolean,
-                  default: false
-    method_option :info,
-                  aliases: "-i",
-                  desc: "Print gem configuration.",
-                  type: :boolean,
-                  default: false
-    def config
-      path = configuration.current
-
-      if options.edit? then `#{ENV["EDITOR"]} #{path}`
-      elsif options.info?
-        path ? say(path) : say("Configuration doesn't exist.")
-      else help :config
-      end
-    end
-
-    desc "-v, [--version]", "Show gem version."
-    map %w[-v --version] => :version
-    def version
-      say Identity::VERSION_LABEL
-    end
-
-    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
-    end
-
-    private
-
-    attr_reader :configuration
-  end
-end

data/lib/pragmater/commenter.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Pragmater
-  # Handles pragma comments.
-  class Commenter
-    def initialize older, newer, formatter: Formatter
-      @formatter = formatter
-      @older = format older
-      @newer = format newer
-    end
-
-    def add
-      older | newer
-    end
-
-    def remove
-      older - (older & newer)
-    end
-
-    private
-
-    attr_reader :older, :newer, :formatter
-
-    def filter comments
-      Array(comments).select { |comment| comment =~ formatter.valid_formats }
-    end
-
-    def format comments
-      filter(comments).map { |comment| formatter.new(comment).format }
-    end
-  end
-end

data/lib/pragmater/formatter.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Pragmater
-  # Formats pragma comments in a consistent manner.
-  class Formatter
-    def self.shebang_format
-      %r(\A\#!\s?/.*ruby\Z)
-    end
-
-    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.
-        [\w-]+   # Value - 1 or more word or dash characters.
-        \Z       # End of line.
-      /x
-    end
-
-    def self.valid_formats
-      Regexp.union shebang_format, pragma_format
-    end
-
-    def initialize string
-      @string = string
-    end
-
-    def format_shebang
-      return string unless string.match? self.class.shebang_format
-
-      _, path = string.split "!"
-      "#! #{path.strip}"
-    end
-
-    def format_pragma
-      return string unless string.match? self.class.pragma_format
-
-      key, value = string.split ":"
-      "# #{key.gsub(/\#\s?/, "")}: #{value.strip}"
-    end
-
-    def format
-      klass = self.class
-
-      case string
-        when klass.shebang_format then format_shebang
-        when klass.pragma_format then format_pragma
-        else string
-      end
-    end
-
-    private
-
-    attr_reader :string
-  end
-end

data/lib/pragmater/writer.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Pragmater
-  # Writes formatted pragma comments to source file.
-  # :reek:TooManyInstanceVariables
-  # :reek:MissingSafeMethod
-  class Writer
-    # rubocop:disable Metrics/ParameterLists
-    def initialize file_path, new_comments, formatter: Formatter, commenter: Commenter
-      @file_path = file_path
-      @file_lines = File.readlines file_path
-      @formatter = formatter
-      @commenter = commenter
-      @old_comments = file_comments
-      @new_comments = new_comments
-    end
-    # rubocop:enable Metrics/ParameterLists
-
-    def add
-      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
-      lines = format(commenter.new(old_comments, new_comments).remove) + file_lines_without_comments
-      remove_spacing! lines
-      write { lines.join }
-    end
-
-    private
-
-    attr_reader :file_path, :file_lines, :new_comments, :old_comments, :formatter, :commenter
-
-    def file_comments
-      file_lines.select { |line| line =~ formatter.valid_formats }
-    end
-
-    def file_lines_without_comments
-      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[comment_count] == "\n"
-
-      lines.insert comment_count, "\n"
-    end
-
-    # :reek:UtilityFunction
-    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
-  end
-end