yalphabetize 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b507c005e0407945299b4d297a443fe5f019f876e90bba19e930630c11be8881
-  data.tar.gz: 624a56393c2cf67a529ed4542f66a8308c409739c216052d62b4e75997b8b5eb
+  metadata.gz: 86d76847f2e23ff6fe3cd5a5e58304236f308cd0541a19bd3ab96f7db10bb601
+  data.tar.gz: 8c00fcc4c33db1396aeae8384d1fc62d12bb27dd5db2ef0e7115c6a1f4ccce09
 SHA512:
-  metadata.gz: b77dd2c3d7e92e97e7c7d16cdd9359c6bd5b7084fe7006651a03d3416de73429403f17fcbd0b45f2d09225b842cb4bfb83adb9f48519b3ceb32853339e356e48
-  data.tar.gz: 27495a87a0594f9c33751a7f48e67234b1d7e8067b2e095d5dd90d162237fb309243d0c3c0617795638f1f4b837cf478be1d3969b3ff245668bf45645bca5724
+  metadata.gz: 6e83b56bf3dafb17675575d038cb07fd69c66d7732846eb5ade8379a84d6ac2994471784b2ba6bbdfa306bcbecddcc5d7f175f31c95fd7eaf1b5b509a4d0ba91
+  data.tar.gz: 37c7d42a08c8a1ac39bfc7bdfb4ce65ec9a658884bbc433df5504f636a9797ad1695bffca1847d7a651331b9929f72bf3a2253f258be03383319e67857af0039

data/bin/yalphabetize

@@ -1,27 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'yalphabetize/reader'
-require 'yalphabetize/alphabetizer'
-require 'yalphabetize/writer'
-require 'yalphabetize/offence_detector'
-require 'yalphabetize/yaml_finder'
-require 'yalphabetize/logger'
-require 'yalphabetizer'
+require_relative '../lib/yalphabetize'
 
-reader = Yalphabetize::Reader
-finder = Yalphabetize::YamlFinder.new
-alphabetizer = Yalphabetize::Alphabetizer
-writer = Yalphabetize::Writer
-offence_detector = Yalphabetize::OffenceDetector
-logger = Yalphabetize::Logger.new
-
-exit Yalphabetizer.call(
-  ARGV,
-  reader: reader,
-  finder: finder,
-  alphabetizer: alphabetizer,
-  writer: writer,
-  offence_detector: offence_detector,
-  logger: logger
-)
+exit Yalphabetize::CLI.call(ARGV)

data/lib/yalphabetize/aliaser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Aliaser
+    def initialize(stream_node)
+      @stream_node = stream_node
+      @aliases = {}
+    end
+
+    def call
+      nodes.each do |node|
+        next unless node.respond_to?(:anchor) && node.anchor
+
+        ensure_anchor_then_alias(node)
+      end
+      stream_node
+    end
+
+    private
+
+    attr_reader :stream_node, :aliases
+
+    def ensure_anchor_then_alias(node)
+      if node.alias?
+        aliases[node.anchor] ||= node
+      elsif aliases[node.anchor]
+        swap(node, aliases[node.anchor])
+      end
+    end
+
+    def swap(anchor_node, alias_node)
+      stream_node.each do |node|
+        node.children&.map! do |child_node|
+          convert_node(child_node, anchor_node, alias_node)
+        end
+      end
+    end
+
+    def nodes
+      stream_node.select do |node|
+        node.respond_to?(:anchor) && node.anchor
+      end
+    end
+
+    def convert_node(child_node, anchor_node, alias_node)
+      if child_node == anchor_node
+        alias_node
+      elsif child_node == alias_node
+        anchor_node
+      else
+        child_node
+      end
+    end
+  end
+end

data/lib/yalphabetize/alphabetizer.rb

@@ -2,18 +2,20 @@
 
 module Yalphabetize
   class Alphabetizer
-    def initialize(stream_node)
+    def initialize(stream_node, order_checker_class:)
       @stream_node = stream_node
+      @order_checker_class = order_checker_class
     end
 
     def call
+      transform(stream_node)
       alphabetize(stream_node)
       stream_node
     end
 
     private
 
-    attr_reader :stream_node
+    attr_reader :stream_node, :order_checker_class
 
     def alphabetize(node)
       if node.mapping?
@@ -25,7 +27,9 @@ module Yalphabetize
     end
 
     def alphabetize_children(node)
-      node.children.sort_by! { |key, _value| key.value }
+      node.children.sort! do |a, b|
+        order_checker_class.compare(a.first.value, b.first.value)
+      end
     end
 
     def unpair_children(node)
@@ -36,5 +40,23 @@ module Yalphabetize
         node.children.shift
       end
     end
+
+    def transform(node)
+      node.children&.each(&method(:transform))
+
+      return unless node.mapping?
+
+      pair_up_children(node)
+    end
+
+    def pair_up_children(node)
+      children_clone = node.children.dup
+
+      children_clone.each_slice(2) do |slice|
+        node.children.push(slice)
+        node.children.shift
+        node.children.shift
+      end
+    end
   end
 end

data/lib/yalphabetize/cli.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class CLI
+    def self.call(argv)
+      new(argv).call
+    end
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def call
+      Yalphabetizer.call argv, options
+    end
+
+    private
+
+    attr_reader :argv
+
+    def options
+      OptionParser.parse!(argv)
+    end
+  end
+end

data/lib/yalphabetize/erb_compiler.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Inspired by ERB::Compiler (https://github.com/ruby/erb/blob/b58b188028fbb403f75d48d62717373fc0908f7a/lib/erb.rb)
+
+module Yalphabetize
+  class ErbCompiler
+    DEFAULT_STAGS = ['<%%', '<%=', '<%#', '<%', '%{', '{{'].freeze
+    DEFAULT_ETAGS = ['%%>', '%>', '}}', '}'].freeze
+
+    class Scanner
+      STAG_REG = /(.*?)(#{DEFAULT_STAGS.join('|')}|\z)/m.freeze
+      ETAG_REG = /(.*?)(#{DEFAULT_ETAGS.join('|')}|\z)/m.freeze
+
+      def initialize(src)
+        @src = src
+        @stag = nil
+      end
+
+      def scan
+        until scanner.eos?
+          scanner.scan(stag ? ETAG_REG : STAG_REG)
+          yield(scanner[1])
+          yield(scanner[2])
+        end
+      end
+
+      attr_accessor :stag
+
+      private
+
+      attr_reader :src
+
+      def scanner
+        @_scanner ||= StringScanner.new(src)
+      end
+    end
+
+    def initialize
+      @buffer = []
+      @content = []
+    end
+
+    def compile(string)
+      scanner = Scanner.new(string)
+      scanner.scan do |token|
+        next if token.nil?
+        next if token == ''
+
+        if scanner.stag.nil?
+          compile_stag(token, scanner)
+        else
+          compile_etag(token, scanner)
+        end
+      end
+    end
+
+    def compile_stag(stag, scanner)
+      case stag
+      when *DEFAULT_STAGS
+        scanner.stag = stag
+        buffer << stag
+      end
+    end
+
+    def compile_etag(etag, scanner)
+      buffer << etag
+
+      case etag
+      when *DEFAULT_ETAGS
+        content << buffer.join
+        self.buffer = []
+        scanner.stag = nil
+      end
+    end
+
+    attr_reader :content
+
+    private
+
+    attr_accessor :buffer
+  end
+end

data/lib/yalphabetize/file_yalphabetizer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class FileYalphabetizer
+    def initialize(file_path, **options)
+      @file_path = file_path
+      @reader_class = options[:reader_class]
+      @offence_detector_class = options[:offence_detector_class]
+      @logger = options[:logger]
+      @autocorrect = options[:autocorrect]
+      @alphabetizer_class = options[:alphabetizer_class]
+      @writer_class = options[:writer_class]
+      @order_checker_class = options[:order_checker_class]
+    end
+
+    def call
+      if offences?
+        logger.log_offence(file_path)
+        autocorrect_file if autocorrect
+      else
+        logger.log_no_offence
+      end
+    end
+
+    private
+
+    attr_reader :file_path, :reader_class, :offence_detector_class, :logger, :autocorrect,
+                :alphabetizer_class, :writer_class, :order_checker_class
+
+    def autocorrect_file
+      alphabetize
+      handle_aliases
+      rewrite_yml_file
+      print_to_log
+    end
+
+    def offences?
+      offence_detector_class.new(stream_node, order_checker_class: order_checker_class).offences?
+    end
+
+    def alphabetize
+      alphabetizer_class.new(stream_node, order_checker_class: order_checker_class).call
+    end
+
+    def handle_aliases
+      Aliaser.new(stream_node).call
+    end
+
+    def rewrite_yml_file
+      writer_class.new(stream_node, file_path, interpolations_mapping).call
+    end
+
+    def print_to_log
+      logger.log_correction(file_path)
+    end
+
+    def reader
+      @_reader ||= reader_class.new(file_path)
+    end
+
+    def stream_node
+      @_stream_node ||= reader.to_ast
+    end
+
+    def interpolations_mapping
+      reader.interpolations_mapping
+    end
+  end
+end

data/lib/yalphabetize/logger.rb

@@ -1,40 +1,35 @@
+# frozen_string_literal: true
+
 module Yalphabetize
   class Logger
-    def initialize
+    DEFAULT_OUTPUT = $stdout
+
+    def initialize(output = DEFAULT_OUTPUT)
+      @output = output
       @inspected_count = 0
       @offences = {}
     end
 
-    def task_summary(file_paths)
-      puts "Inspecting #{file_paths.size} YAML files"
+    def initial_summary(file_paths)
+      output.puts "Inspecting #{file_paths.size} YAML files"
     end
 
     def log_offence(file_path)
       @inspected_count += 1
       offences[file_path] = :detected
-      print red 'O'
+      output.print red 'O'
     end
 
     def log_no_offence
       @inspected_count += 1
-      print green '.'
-    end
-
-    def log_inspected_count
-      puts "\nInspected: #{inspected_count}"
+      output.print green '.'
     end
 
-    def list_offences
-      puts send(list_offences_color, "Offences: #{offences.size}")
+    def final_summary
+      output.puts "\nInspected: #{inspected_count}"
+      output.puts send(list_offences_color, "Offences: #{offences.size}")
 
-      @offences.each do |file_path, status|
-        case status
-        when :detected
-          puts yellow file_path
-        when :corrected
-          puts("#{yellow(file_path)} #{green("CORRECTED")}")
-        end
-      end
+      offences.each { |file_path, status| puts_offence(file_path, status) }
     end
 
     def offences?
@@ -47,7 +42,16 @@ module Yalphabetize
 
     private
 
-    attr_reader :offences, :inspected_count
+    attr_reader :offences, :inspected_count, :output
+
+    def puts_offence(file_path, status)
+      case status
+      when :detected
+        output.puts yellow file_path
+      when :corrected
+        output.puts("#{yellow(file_path)} #{green('CORRECTED')}")
+      end
+    end
 
     def list_offences_color
       if offences?

data/lib/yalphabetize/offence_detector.rb

@@ -2,8 +2,9 @@
 
 module Yalphabetize
   class OffenceDetector
-    def initialize(stream_node)
+    def initialize(stream_node, order_checker_class:)
       @stream_node = stream_node
+      @order_checker_class = order_checker_class
     end
 
     def offences?
@@ -12,7 +13,7 @@ module Yalphabetize
 
     private
 
-    attr_reader :stream_node
+    attr_reader :stream_node, :order_checker_class
 
     def alphabetized?(node)
       return false if node.mapping? && !alphabetized_children?(node)
@@ -25,7 +26,9 @@ module Yalphabetize
     end
 
     def alphabetized_children?(node)
-      node.children.each_cons(2).all? { |a, b| (a.first.value <=> b.first.value) <= 0 }
+      node.children.each_slice(2).each_cons(2).all? do |a, b|
+        order_checker_class.ordered?(a.first.value, b.first.value)
+      end
     end
 
     def each_child_also_alphabetized?(children)

data/lib/yalphabetize/option_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Yalphabetize
+  class OptionParser
+    PARSER = ::OptionParser.new do |o|
+      o.banner = 'Usage: yalphabetize [options] [file1, file2, ...]'
+
+      o.on('-a', '--autocorrect', 'Automatically alphabetize inspected yaml files')
+      o.on('-h', '--help', 'Prints this help') do
+        puts o
+        Kernel.exit
+      end
+    end
+
+    def self.parse!(argv)
+      {}.tap { |options| PARSER.parse!(argv, into: options) }
+    end
+  end
+end

data/lib/yalphabetize/order_checkers/alphabetical_then_capitalized_first.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# AaBb
+module Yalphabetize
+  module OrderCheckers
+    class AlphabeticalThenCapitalizedFirst < Base
+      def self.compare(string, other_string)
+        alphabetical_comparison(string, other_string).nonzero? || string <=> other_string
+      end
+    end
+  end
+end

data/lib/yalphabetize/order_checkers/alphabetical_then_capitalized_last.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# aAbB
+module Yalphabetize
+  module OrderCheckers
+    class AlphabeticalThenCapitalizedLast < Base
+      def self.compare(string, other_string)
+        alphabetical_comparison(string, other_string).nonzero? || string.swapcase <=> other_string.swapcase
+      end
+    end
+  end
+end

data/lib/yalphabetize/order_checkers/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  module OrderCheckers
+    class Base
+      def self.ordered?(string, other_string)
+        !compare(string, other_string).positive?
+      end
+
+      private_class_method def self.alphabetical_comparison(string, other_string)
+        string.downcase <=> other_string.downcase
+      end
+    end
+  end
+end

data/lib/yalphabetize/order_checkers/capitalized_first_then_alphabetical.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  module OrderCheckers
+    class CapitalizedFirstThenAlphabetical < Base
+      def self.compare(string, other_string)
+        (string <=> other_string)
+      end
+    end
+  end
+end

data/lib/yalphabetize/order_checkers/capitalized_last_then_alphabetical.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  module OrderCheckers
+    class CapitalizedLastThenAlphabetical < Base
+      def self.compare(string, other_string)
+        (string.swapcase <=> other_string.swapcase)
+      end
+    end
+  end
+end

data/lib/yalphabetize/order_checkers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  module OrderCheckers
+    DEFAULT = CapitalizedFirstThenAlphabetical
+
+    TOKEN_MAPPING = {
+      'abAB' => CapitalizedLastThenAlphabetical,
+      'aAbB' => AlphabeticalThenCapitalizedLast,
+      'AaBb' => AlphabeticalThenCapitalizedFirst,
+      'ABab' => CapitalizedFirstThenAlphabetical
+    }.freeze
+  end
+end

data/lib/yalphabetize/parsing_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Yalphabetize
+  class ParsingError < Psych::SyntaxError; end
+end

data/lib/yalphabetize/reader.rb

@@ -1,42 +1,52 @@
 # frozen_string_literal: true
 
 require 'psych'
+require 'securerandom'
 
 module Yalphabetize
   class Reader
     def initialize(path)
       @path = path
+      @interpolations_mapping = {}
     end
 
     def to_ast
-      transform(stream_node)
+      substitute_interpolations
       stream_node
     end
 
+    attr_reader :interpolations_mapping
+
     private
 
     attr_reader :path
 
-    def stream_node
-      @stream_node ||= Psych.parse_stream File.read(path)
-    end
-
-    def transform(node)
-      node.children&.each(&method(:transform))
-
-      return unless node.mapping?
+    def substitute_interpolations
+      erb_compiler = Yalphabetize::ErbCompiler.new
+      erb_compiler.compile(file)
 
-      pair_up_children(node)
+      erb_compiler.content.each do |interpolation|
+        uuid = SecureRandom.uuid
+        file.sub!(interpolation, uuid)
+        interpolations_mapping[uuid] = interpolation
+      end
     end
 
-    def pair_up_children(node)
-      children_clone = node.children.dup
+    def file
+      @_file ||= File.read(path)
+    end
 
-      children_clone.each_slice(2) do |slice|
-        node.children.push(slice)
-        node.children.shift
-        node.children.shift
-      end
+    def stream_node
+      @_stream_node ||= Psych.parse_stream file
+    rescue Psych::SyntaxError => e
+      raise Yalphabetize::ParsingError.new(
+        path,
+        e.line,
+        e.column,
+        e.offset,
+        e.problem,
+        e.context
+      )
     end
   end
 end

data/lib/yalphabetize/sequence_indenter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Yalphabetize
+  class SequenceIndenter
+    def self.call(content)
+      new(content).call
+    end
+
+    def initialize(content)
+      @content = content
+    end
+
+    def call
+      return unless Yalphabetize.config['indent_sequences']
+
+      find_lines_to_indent
+      indent!
+      file_lines.join
+    end
+
+    private
+
+    attr_reader :content
+
+    def find_lines_to_indent
+      @nodes_to_indent = []
+
+      stream_node.select(&:mapping?).each do |mapping_node|
+        block_sequence_nodes(mapping_node)&.each do |sequence_node|
+          @nodes_to_indent.push(*sequence_node.children)
+        end
+      end
+    end
+
+    def block_sequence_nodes(node)
+      node.children&.select { |child_node| child_node.sequence? && child_node.style == 1 }
+    end
+
+    def stream_node
+      Psych.parse_stream content
+    end
+
+    def indent!
+      @nodes_to_indent.each do |node|
+        node_end_line = node.start_line == node.end_line ? node.end_line : node.end_line - 1
+
+        file_lines[node.start_line..node_end_line].each do |line|
+          line.gsub!(line, "  #{line}")
+        end
+      end
+    end
+
+    def file_lines
+      @_file_lines ||= content.each_line.to_a
+    end
+  end
+end

data/lib/yalphabetize/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Version
+    STRING = '0.4.1'
+  end
+end

data/lib/yalphabetize/writer.rb

@@ -2,19 +2,39 @@
 
 module Yalphabetize
   class Writer
-    def initialize(stream_node, path)
+    MAX_LINE_WIDTH = -1
+
+    def initialize(stream_node, path, interpolations_mapping)
       @stream_node = stream_node
       @path = path
+      @interpolations_mapping = interpolations_mapping
     end
 
     def call
+      indent_sequences
+      replace_interpolations
+
       File.open(path, 'w') do |file|
-        file.write(stream_node.to_yaml)
+        file.write new_file_content
       end
     end
 
     private
 
-    attr_reader :stream_node, :path
+    attr_reader :stream_node, :path, :interpolations_mapping
+
+    def new_file_content
+      @_new_file_content ||= stream_node.to_yaml(nil, line_width: MAX_LINE_WIDTH)
+    end
+
+    def replace_interpolations
+      interpolations_mapping.each do |uuid, interpolation|
+        new_file_content.sub!(uuid, interpolation)
+      end
+    end
+
+    def indent_sequences
+      @_new_file_content = SequenceIndenter.call(new_file_content)
+    end
   end
 end

data/lib/yalphabetize/yalphabetizer.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Yalphabetizer
+    def self.call(args = [], options = {})
+      new(args, options).call
+    end
+
+    def initialize(args, options)
+      @args = args
+      @options = options
+    end
+
+    def call
+      initial_log
+      process_files
+      final_log
+    end
+
+    private
+
+    attr_reader :args, :options
+
+    def initial_log
+      logger.initial_summary(file_paths)
+    end
+
+    def process_files
+      file_paths.each(&method(:process_file))
+    end
+
+    def process_file(file_path)
+      file_yalphabetizer_class.new(
+        file_path,
+        reader_class: reader_class,
+        offence_detector_class: offence_detector_class,
+        logger: logger,
+        autocorrect: options[:autocorrect],
+        alphabetizer_class: alphabetizer_class,
+        writer_class: writer_class,
+        order_checker_class: order_checker_class
+      ).call
+    end
+
+    def file_paths
+      @_file_paths ||= finder.paths(only: only_paths, exclude: Yalphabetize.config['exclude'])
+    end
+
+    def only_paths
+      if args.any?
+        args
+      else
+        Yalphabetize.config['only']
+      end
+    end
+
+    def final_log
+      logger.final_summary
+      logger.offences? ? 1 : 0
+    end
+
+    def reader_class
+      Yalphabetize::Reader
+    end
+
+    def finder
+      Yalphabetize::YamlFinder
+    end
+
+    def alphabetizer_class
+      Yalphabetize::Alphabetizer
+    end
+
+    def writer_class
+      Yalphabetize::Writer
+    end
+
+    def offence_detector_class
+      Yalphabetize::OffenceDetector
+    end
+
+    def logger
+      @_logger ||= Yalphabetize::Logger.new
+    end
+
+    def file_yalphabetizer_class
+      Yalphabetize::FileYalphabetizer
+    end
+
+    def order_checker_class
+      OrderCheckers::TOKEN_MAPPING[Yalphabetize.config['sort_by']]
+    end
+  end
+end

data/lib/yalphabetize/yaml_finder.rb

@@ -1,20 +1,78 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module Yalphabetize
   class YamlFinder
-    def paths
-      @_paths ||= begin
-        return if `sh -c 'command -v git'`.empty?
+    YAML_EXTENSIONS = %w[.yml .yaml].freeze
+
+    def self.paths(only:, exclude:)
+      if exclude.any?
+        new.paths(only) - new.paths(exclude)
+      else
+        new.paths(only)
+      end
+    end
+
+    def initialize
+      @files = []
+    end
 
-        output, _error, status = Open3.capture3(
-          'git', 'ls-files', '-z', './**/*.yml',
-          '--exclude-standard', '--others', '--cached', '--modified'
-        )
+    def paths(paths)
+      if paths.empty?
+        files << files_in_dir
+      else
+        process_paths(paths)
+      end
+
+      files.flatten.select(&method(:valid?)).map { |f| File.expand_path(f) }.uniq
+    end
 
-        return unless status.success?
+    private
 
-        output.split("\0").uniq.map { |git_file| "#{Dir.pwd}/#{git_file}" }
+    attr_reader :files
+
+    def process_paths(paths)
+      paths.uniq.each do |path|
+        files << if glob?(path)
+                   files_in_glob(path)
+                 elsif File.directory?(path)
+                   files_in_dir(path)
+                 else
+                   path
+                 end
       end
     end
+
+    def files_in_glob(glob)
+      files_in_dir([glob, glob.gsub('**/', '').gsub('**', '')].uniq)
+    end
+
+    def files_in_dir(dir = Dir.pwd)
+      return if `sh -c 'command -v git'`.empty?
+
+      output, _error, status = Open3.capture3(
+        'git', 'ls-files', '-z', *Array(dir),
+        '--exclude-standard', '--others', '--cached', '--modified'
+      )
+
+      output.split("\0").uniq.map { |git_file| "#{Dir.pwd}/#{git_file}" } if status.success?
+    end
+
+    def valid?(path)
+      exists?(path) && yml?(path)
+    end
+
+    def exists?(path)
+      File.exist?(path)
+    end
+
+    def yml?(path)
+      YAML_EXTENSIONS.include? File.extname(path)
+    end
+
+    def glob?(path)
+      path.include?('*')
+    end
   end
 end

data/lib/yalphabetize.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'yalphabetize/aliaser'
+require_relative 'yalphabetize/alphabetizer'
+require_relative 'yalphabetize/cli'
+require_relative 'yalphabetize/erb_compiler'
+require_relative 'yalphabetize/file_yalphabetizer'
+require_relative 'yalphabetize/logger'
+require_relative 'yalphabetize/offence_detector'
+require_relative 'yalphabetize/option_parser'
+require_relative 'yalphabetize/order_checkers/base'
+require_relative 'yalphabetize/order_checkers/alphabetical_then_capitalized_first'
+require_relative 'yalphabetize/order_checkers/alphabetical_then_capitalized_last'
+require_relative 'yalphabetize/order_checkers/capitalized_last_then_alphabetical'
+require_relative 'yalphabetize/order_checkers/capitalized_first_then_alphabetical'
+require_relative 'yalphabetize/order_checkers'
+require_relative 'yalphabetize/parsing_error'
+require_relative 'yalphabetize/reader'
+require_relative 'yalphabetize/sequence_indenter'
+require_relative 'yalphabetize/version'
+require_relative 'yalphabetize/writer'
+require_relative 'yalphabetize/yalphabetizer'
+require_relative 'yalphabetize/yaml_finder'
+
+module Yalphabetize
+  class << self
+    DEFAULT_CONFIG = {
+      'indent_sequences' => true,
+      'exclude' => [],
+      'only' => [],
+      'sort_by' => 'ABab'
+    }.freeze
+
+    def config
+      @_config ||= begin
+        specified = if File.exist?('.yalphabetize.yml')
+                      Psych.load_file('.yalphabetize.yml') || {}
+                    else
+                      {}
+                    end
+
+        DEFAULT_CONFIG.merge(specified)
+      end
+    end
+  end
+end

metadata

@@ -1,34 +1,134 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sam Jenkins
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: 
+date: 2022-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
 executables:
 - yalphabetize
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/yalphabetize
+- lib/yalphabetize.rb
+- lib/yalphabetize/aliaser.rb
 - lib/yalphabetize/alphabetizer.rb
+- lib/yalphabetize/cli.rb
+- lib/yalphabetize/erb_compiler.rb
+- lib/yalphabetize/file_yalphabetizer.rb
 - lib/yalphabetize/logger.rb
 - lib/yalphabetize/offence_detector.rb
+- lib/yalphabetize/option_parser.rb
+- lib/yalphabetize/order_checkers.rb
+- lib/yalphabetize/order_checkers/alphabetical_then_capitalized_first.rb
+- lib/yalphabetize/order_checkers/alphabetical_then_capitalized_last.rb
+- lib/yalphabetize/order_checkers/base.rb
+- lib/yalphabetize/order_checkers/capitalized_first_then_alphabetical.rb
+- lib/yalphabetize/order_checkers/capitalized_last_then_alphabetical.rb
+- lib/yalphabetize/parsing_error.rb
 - lib/yalphabetize/reader.rb
+- lib/yalphabetize/sequence_indenter.rb
+- lib/yalphabetize/version.rb
 - lib/yalphabetize/writer.rb
+- lib/yalphabetize/yalphabetizer.rb
 - lib/yalphabetize/yaml_finder.rb
-- lib/yalphabetizer.rb
-homepage: 
+homepage:
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Alphabetize your YAML files
 test_files: []

data/lib/yalphabetizer.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-require 'pry'
-
-class Yalphabetizer
-  def self.call(args = [], **options)
-    new(args, options).call
-  end
-
-  def initialize(args, options)
-    @args = args
-
-    @reader = options[:reader]
-    @finder = options[:finder]
-    @alphabetizer = options[:alphabetizer]
-    @writer = options[:writer]
-    @offence_detector = options[:offence_detector]
-    @logger = options[:logger]
-  end
-
-  def call
-    logger.task_summary(file_paths)
-
-    file_paths.each do |file_path|
-      unsorted_stream_node = reader.new(file_path).to_ast
-
-      if offences?(unsorted_stream_node)
-        logger.log_offence(file_path)
-        autocorrect(unsorted_stream_node, file_path) if autocorrect?
-      else
-        logger.log_no_offence
-      end
-    end
-
-    logger.log_inspected_count
-    logger.list_offences
-
-    logger.offences? ? 1 : 0
-  end
-
-  private
-
-  attr_reader :args, :reader, :finder, :alphabetizer, :writer, :offence_detector, :logger
-
-  def file_paths
-    finder.paths
-  end
-
-  def autocorrect?
-    return true if args.include? '-a'
-    return true if args.include? '-autocorrect'
-
-    false
-  end
-
-  def autocorrect(unsorted_stream_node, file_path)
-    sorted_stream_node = alphabetizer.new(unsorted_stream_node).call
-    writer.new(sorted_stream_node, file_path).call
-    logger.log_correction(file_path)
-  end
-
-  def offences?(stream_node)
-    offence_detector.new(stream_node).offences?
-  end
-end