yalphabetize 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 702ef0ac265097aa95ae58399f9bd221336ebba2f29ee51b07ff03beb7c471bd
-  data.tar.gz: d2da1541ac411f12ba6b3a70534df739cfca69620b07d067dfa75bd18c4d7da7
+  metadata.gz: 7233124faca7d704c5fc49708d03df7bf821863a7ef1470d2525b00dadc13c80
+  data.tar.gz: 904ee4fb5f329b2b9be7fb33a1e7d4bebb3e15dddfee3b6928756e47aab4cf61
 SHA512:
-  metadata.gz: 43205417abde2761326cd34006fa49cbd574d1ec98e5d47a01f9a5769fad51883de9bc7822e206cbabf66c56f91ea54ce3c3d986bae3639550d5e3899a9759ff
-  data.tar.gz: 543936dea7ac58dc5857419cd27330214759109fa3bdb8bdf50524964bb4b1f1d6e30ce9a60fce156c70cb5fdc2694b60fc139f80085678d2841d864dd3e070c
+  metadata.gz: 1021062eedb1e2f0a7ceefd6fa7783f55079d415097476b94cea6c399223a8af5a0e8311d560e423744ad35292707280641c81c3c8ebc0ff97baad2b1ec3f9fd
+  data.tar.gz: e633c877d5350bc007c0beb931c5eb7a322603b7cd0e4742c48ddc964b44d8da185cb444294c7d7e27e1ece707854948d94e9a534d03c5579eab770a1a6f97ef

data/lib/yalphabetize/alphabetizer.rb

@@ -2,8 +2,9 @@
 
 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
@@ -14,7 +15,7 @@ module Yalphabetize
 
     private
 
-    attr_reader :stream_node
+    attr_reader :stream_node, :order_checker_class
 
     def alphabetize(node)
       if node.mapping?
@@ -26,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)

data/lib/yalphabetize/file_yalphabetizer.rb

@@ -10,6 +10,7 @@ module Yalphabetize
       @autocorrect = options[:autocorrect]
       @alphabetizer_class = options[:alphabetizer_class]
       @writer_class = options[:writer_class]
+      @order_checker_class = options[:order_checker_class]
     end
 
     def call
@@ -19,14 +20,12 @@ module Yalphabetize
       else
         logger.log_no_offence
       end
-
-      replace_interpolations
     end
 
     private
 
-    attr_reader :file_path, :reader_class, :offence_detector_class,
-                :logger, :autocorrect, :alphabetizer_class, :writer_class
+    attr_reader :file_path, :reader_class, :offence_detector_class, :logger, :autocorrect,
+                :alphabetizer_class, :writer_class, :order_checker_class
 
     def autocorrect_file
       alphabetize
@@ -36,21 +35,11 @@ module Yalphabetize
     end
 
     def offences?
-      offence_detector_class.new(stream_node).offences?
-    end
-
-    def replace_interpolations
-      interpolations_mapping.each do |uuid, interpolation|
-        file_content = File.read(file_path)
-        file_content.sub!(uuid, interpolation)
-        File.open(file_path, 'w') do |file|
-          file.write file_content
-        end
-      end
+      offence_detector_class.new(stream_node, order_checker_class: order_checker_class).offences?
     end
 
     def alphabetize
-      alphabetizer_class.new(stream_node).call
+      alphabetizer_class.new(stream_node, order_checker_class: order_checker_class).call
     end
 
     def handle_aliases
@@ -58,7 +47,7 @@ module Yalphabetize
     end
 
     def rewrite_yml_file
-      writer_class.new(stream_node, file_path).call
+      writer_class.new(stream_node, file_path, interpolations_mapping).call
     end
 
     def print_to_log

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_slice(2).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/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/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.each do |node|
+        next if node.document?
+
+        block_sequence_nodes(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|
+        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

@@ -2,6 +2,6 @@
 
 module Yalphabetize
   class Version
-    STRING = '0.3.0'
+    STRING = '0.4.0'
   end
 end

data/lib/yalphabetize/writer.rb

@@ -4,12 +4,16 @@ module Yalphabetize
   class Writer
     MAX_LINE_WIDTH = -1
 
-    def initialize(stream_node, path)
+    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 new_file_content
       end
@@ -17,10 +21,20 @@ module Yalphabetize
 
     private
 
-    attr_reader :stream_node, :path
+    attr_reader :stream_node, :path, :interpolations_mapping
 
     def new_file_content
-      stream_node.to_yaml nil, line_width: MAX_LINE_WIDTH
+      @_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

@@ -37,38 +37,23 @@ module Yalphabetize
         logger: logger,
         autocorrect: options[:autocorrect],
         alphabetizer_class: alphabetizer_class,
-        writer_class: writer_class
+        writer_class: writer_class,
+        order_checker_class: order_checker_class
       ).call
     end
 
     def file_paths
-      @_file_paths ||= finder.paths(only: only_paths, exclude: excluded_paths)
+      @_file_paths ||= finder.paths(only: only_paths, exclude: Yalphabetize.config['exclude'])
     end
 
     def only_paths
       if args.any?
         args
-      elsif config
-        config['only'] || []
       else
-        []
+        Yalphabetize.config['only']
       end
     end
 
-    def excluded_paths
-      if config
-        config['exclude'] || []
-      else
-        []
-      end
-    end
-
-    def config
-      return unless File.exist?('.yalphabetize.yml')
-
-      @_config ||= Psych.load_file('.yalphabetize.yml') || {}
-    end
-
     def final_log
       logger.final_summary
       logger.offences? ? 1 : 0
@@ -101,5 +86,9 @@ module Yalphabetize
     def file_yalphabetizer_class
       Yalphabetize::FileYalphabetizer
     end
+
+    def order_checker_class
+      OrderCheckers::TOKEN_MAPPING[Yalphabetize.config['sort_by']]
+    end
   end
 end

data/lib/yalphabetize.rb

@@ -8,9 +8,39 @@ 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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Jenkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+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: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -111,8 +111,15 @@ files:
 - 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