yalphabetize 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 702ef0ac265097aa95ae58399f9bd221336ebba2f29ee51b07ff03beb7c471bd
-  data.tar.gz: d2da1541ac411f12ba6b3a70534df739cfca69620b07d067dfa75bd18c4d7da7
+  metadata.gz: b8a46ac2b83620bfb782115c3619f6db45dc085ac588bf3911a9c5c0380ac27e
+  data.tar.gz: 76a8548aee15525a38afa21d1f21958184f8b77346778626a06c0323dd62fee5
 SHA512:
-  metadata.gz: 43205417abde2761326cd34006fa49cbd574d1ec98e5d47a01f9a5769fad51883de9bc7822e206cbabf66c56f91ea54ce3c3d986bae3639550d5e3899a9759ff
-  data.tar.gz: 543936dea7ac58dc5857419cd27330214759109fa3bdb8bdf50524964bb4b1f1d6e30ce9a60fce156c70cb5fdc2694b60fc139f80085678d2841d864dd3e070c
+  metadata.gz: 24727bad57547da439e2c63d17be8469c8f605bcfd1dcee96685e274b89933e716a07f3cbd84ff9e8f1c88c37561efe82ec11a477758614e7e75351cd5ffd61d
+  data.tar.gz: f841fe74158715af2a2836b8637d9363e9b7371cb77ddd0ac43d109712a9832dd04b5bb81b741218e30f76bbb56b77b6c90b1a6560913ad8d5e5114cfaabb2ea

data/lib/yalphabetize/alphabetizer.rb

@@ -2,48 +2,32 @@
 
 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
-
-    def alphabetize(node)
-      if node.mapping?
-        alphabetize_children(node)
+      stream_node.select(&:mapping?).each do |node|
+        order_checker = order_checker_class.new_for(node)
+        pair_up_children(node)
+        alphabetize_children(node, order_checker)
         unpair_children(node)
       end
-
-      node.children&.each { |child_node| alphabetize(child_node) }
     end
 
-    def alphabetize_children(node)
-      node.children.sort_by! { |key, _value| key.value }
-    end
+    private
 
-    def unpair_children(node)
-      children_clone = node.children.dup
+    attr_reader :stream_node, :order_checker_class
 
-      children_clone.each do |slice|
-        node.children.push(*slice)
-        node.children.shift
+    def alphabetize_children(node, order_checker)
+      node.children.sort! do |a, b|
+        order_checker.compare(a.first.value, b.first.value)
       end
     end
 
-    def transform(node)
-      node.children&.each(&method(:transform))
-
-      return unless node.mapping?
-
-      pair_up_children(node)
+    def unpair_children(node)
+      node.children.flatten!
     end
 
     def pair_up_children(node)
@@ -51,8 +35,7 @@ module Yalphabetize
 
       children_clone.each_slice(2) do |slice|
         node.children.push(slice)
-        node.children.shift
-        node.children.shift
+        2.times { node.children.shift }
       end
     end
   end

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
@@ -72,9 +61,5 @@ module Yalphabetize
     def stream_node
       @_stream_node ||= reader.to_ast
     end
-
-    def interpolations_mapping
-      reader.interpolations_mapping
-    end
   end
 end

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,11 @@ 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 }
+      order_checker = order_checker_class.new_for(node)
+
+      node.children.each_slice(2).each_cons(2).all? do |a, b|
+        order_checker.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 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 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,29 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  module OrderCheckers
+    class Base
+      def self.new_for(node)
+        node_keys = node.children.select.each_with_index do |_, i|
+          i.even?
+        end.map(&:value)
+
+        matched_allowed_order = Yalphabetize.config['allowed_orders']&.find do |allowed_order|
+          (node_keys - allowed_order).empty?
+        end
+
+        matched_allowed_order ? Custom.new(matched_allowed_order) : new
+      end
+
+      def ordered?(string, other_string)
+        !compare(string, other_string).positive?
+      end
+
+      private
+
+      def 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,12 @@
+# frozen_string_literal: true
+
+# ABab
+module Yalphabetize
+  module OrderCheckers
+    class CapitalizedFirstThenAlphabetical < Base
+      def compare(string, other_string)
+        string <=> other_string
+      end
+    end
+  end
+end

data/lib/yalphabetize/order_checkers/capitalized_last_then_alphabetical.rb

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

data/lib/yalphabetize/order_checkers/custom.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  module OrderCheckers
+    class Custom < Base
+      def initialize(allowed_order)
+        super()
+        @allowed_order = allowed_order
+      end
+
+      def compare(string, other_string)
+        allowed_order.index(string) <=> allowed_order.index(other_string)
+      end
+
+      private
+
+      attr_reader :allowed_order
+    end
+  end
+end

data/lib/yalphabetize/order_checkers.rb

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

data/lib/yalphabetize/reader.rb

@@ -1,37 +1,21 @@
 # frozen_string_literal: true
 
 require 'psych'
-require 'securerandom'
 
 module Yalphabetize
   class Reader
     def initialize(path)
       @path = path
-      @interpolations_mapping = {}
     end
 
     def to_ast
-      substitute_interpolations
       stream_node
     end
 
-    attr_reader :interpolations_mapping
-
     private
 
     attr_reader :path
 
-    def substitute_interpolations
-      erb_compiler = Yalphabetize::ErbCompiler.new
-      erb_compiler.compile(file)
-
-      erb_compiler.content.each do |interpolation|
-        uuid = SecureRandom.uuid
-        file.sub!(interpolation, uuid)
-        interpolations_mapping[uuid] = interpolation
-      end
-    end
-
     def file
       @_file ||= File.read(path)
     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

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

data/lib/yalphabetize/writer.rb

@@ -10,9 +10,9 @@ module Yalphabetize
     end
 
     def call
-      File.open(path, 'w') do |file|
-        file.write new_file_content
-      end
+      indent_sequences
+
+      File.write(path, new_file_content)
     end
 
     private
@@ -20,7 +20,11 @@ module Yalphabetize
     attr_reader :stream_node, :path
 
     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 indent_sequences
+      @_new_file_content = SequenceIndenter.call(new_file_content)
     end
   end
 end

data/lib/yalphabetize/yalphabetizer.rb

@@ -26,7 +26,7 @@ module Yalphabetize
     end
 
     def process_files
-      file_paths.each(&method(:process_file))
+      file_paths.each { |file_path| process_file(file_path) }
     end
 
     def process_file(file_path)
@@ -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/yaml_finder.rb

@@ -25,7 +25,7 @@ module Yalphabetize
         process_paths(paths)
       end
 
-      files.flatten.select(&method(:valid?)).map { |f| File.expand_path(f) }.uniq
+      files.flatten.select { |file| valid?(file) }.map { |f| File.expand_path(f) }.uniq
     end
 
     private

data/lib/yalphabetize.rb

@@ -3,14 +3,44 @@
 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/custom'
+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,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sam Jenkins
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
+  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-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,8 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
+description: 
+email: 
 executables:
 - yalphabetize
 extensions: []
@@ -106,22 +120,29 @@ files:
 - 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/order_checkers/custom.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
-homepage:
+homepage: 
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -137,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Alphabetize your YAML files
 test_files: []

data/lib/yalphabetize/erb_compiler.rb

@@ -1,82 +0,0 @@
-# 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