yalphabetize 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7233124faca7d704c5fc49708d03df7bf821863a7ef1470d2525b00dadc13c80
-  data.tar.gz: 904ee4fb5f329b2b9be7fb33a1e7d4bebb3e15dddfee3b6928756e47aab4cf61
+  metadata.gz: 4e19b4e6cc39bf8354bab85e0238605f9d45b0ae4fb8c01436cf73a5ed1ab4c8
+  data.tar.gz: 8e960a7474e6f6cd0a5510bd9414b2518277c874f9c2d68f436b80d1a1d0b123
 SHA512:
-  metadata.gz: 1021062eedb1e2f0a7ceefd6fa7783f55079d415097476b94cea6c399223a8af5a0e8311d560e423744ad35292707280641c81c3c8ebc0ff97baad2b1ec3f9fd
-  data.tar.gz: e633c877d5350bc007c0beb931c5eb7a322603b7cd0e4742c48ddc964b44d8da185cb444294c7d7e27e1ece707854948d94e9a534d03c5579eab770a1a6f97ef
+  metadata.gz: eeb6ea0a70e67277733cb2c7c75a404506e784a32c93802129b72c64d8370231c2caed23f91a149f515d536cc0b0f63f2e10df02b0e5c3c58c6ed0d9844c14a7
+  data.tar.gz: 8adaab2c141d5f6d74d41836678b8797d20a70bb39fa55f2bd0875f6361291a927e92e1df503edf8f2fe60f26a2c86df1d08b2a3444c563bfc01f982b95b07b3

data/lib/yalphabetize/alphabetizer.rb

@@ -8,45 +8,26 @@ module Yalphabetize
     end
 
     def call
-      transform(stream_node)
-      alphabetize(stream_node)
-      stream_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
     end
 
     private
 
     attr_reader :stream_node, :order_checker_class
 
-    def alphabetize(node)
-      if node.mapping?
-        alphabetize_children(node)
-        unpair_children(node)
-      end
-
-      node.children&.each { |child_node| alphabetize(child_node) }
-    end
-
-    def alphabetize_children(node)
+    def alphabetize_children(node, order_checker)
       node.children.sort! do |a, b|
-        order_checker_class.compare(a.first.value, b.first.value)
+        order_checker.compare(a.first.value, b.first.value)
       end
     end
 
     def unpair_children(node)
-      children_clone = node.children.dup
-
-      children_clone.each do |slice|
-        node.children.push(*slice)
-        node.children.shift
-      end
-    end
-
-    def transform(node)
-      node.children&.each(&method(:transform))
-
-      return unless node.mapping?
-
-      pair_up_children(node)
+      node.children.flatten!
     end
 
     def pair_up_children(node)
@@ -54,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

@@ -47,7 +47,7 @@ module Yalphabetize
     end
 
     def rewrite_yml_file
-      writer_class.new(stream_node, file_path, interpolations_mapping).call
+      writer_class.new(stream_node, file_path).call
     end
 
     def print_to_log
@@ -61,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

@@ -26,8 +26,10 @@ module Yalphabetize
     end
 
     def alphabetized_children?(node)
+      order_checker = order_checker_class.new_for(node)
+
       node.children.each_slice(2).each_cons(2).all? do |a, b|
-        order_checker_class.ordered?(a.first.value, b.first.value)
+        order_checker.ordered?(a.first.value, b.first.value)
       end
     end
 

data/lib/yalphabetize/order_checkers/alphabetical_then_capitalized_first.rb

@@ -4,7 +4,7 @@
 module Yalphabetize
   module OrderCheckers
     class AlphabeticalThenCapitalizedFirst < Base
-      def self.compare(string, other_string)
+      def compare(string, other_string)
         alphabetical_comparison(string, other_string).nonzero? || string <=> other_string
       end
     end

data/lib/yalphabetize/order_checkers/alphabetical_then_capitalized_last.rb

@@ -4,7 +4,7 @@
 module Yalphabetize
   module OrderCheckers
     class AlphabeticalThenCapitalizedLast < Base
-      def self.compare(string, other_string)
+      def compare(string, other_string)
         alphabetical_comparison(string, other_string).nonzero? || string.swapcase <=> other_string.swapcase
       end
     end

data/lib/yalphabetize/order_checkers/base.rb

@@ -3,11 +3,25 @@
 module Yalphabetize
   module OrderCheckers
     class Base
-      def self.ordered?(string, other_string)
+      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_class_method def self.alphabetical_comparison(string, other_string)
+      private
+
+      def alphabetical_comparison(string, other_string)
         string.downcase <=> other_string.downcase
       end
     end

data/lib/yalphabetize/order_checkers/capitalized_first_then_alphabetical.rb

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

data/lib/yalphabetize/order_checkers/capitalized_last_then_alphabetical.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+# abAB
 module Yalphabetize
   module OrderCheckers
     class CapitalizedLastThenAlphabetical < Base
-      def self.compare(string, other_string)
-        (string.swapcase <=> other_string.swapcase)
+      def compare(string, other_string)
+        string.swapcase <=> other_string.swapcase
       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

@@ -2,8 +2,6 @@
 
 module Yalphabetize
   module OrderCheckers
-    DEFAULT = CapitalizedFirstThenAlphabetical
-
     TOKEN_MAPPING = {
       'abAB' => CapitalizedLastThenAlphabetical,
       'aAbB' => AlphabeticalThenCapitalizedLast,

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

@@ -27,10 +27,8 @@ module Yalphabetize
     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|
+      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
@@ -46,8 +44,10 @@ module Yalphabetize
 
     def indent!
       @nodes_to_indent.each do |node|
-        file_lines[node.start_line..node.end_line].each do |line|
-          line.gsub!(line, "  #{line}")
+        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.prepend('  ')
         end
       end
     end

data/lib/yalphabetize/version.rb

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

data/lib/yalphabetize/writer.rb

@@ -4,35 +4,25 @@ module Yalphabetize
   class Writer
     MAX_LINE_WIDTH = -1
 
-    def initialize(stream_node, path, interpolations_mapping)
+    def initialize(stream_node, path)
       @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
+      File.write(path, new_file_content)
     end
 
     private
 
-    attr_reader :stream_node, :path, :interpolations_mapping
+    attr_reader :stream_node, :path
 
     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

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)

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,7 +3,6 @@
 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'
@@ -13,6 +12,7 @@ require_relative 'yalphabetize/order_checkers/alphabetical_then_capitalized_firs
 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'

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Sam Jenkins
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-02-10 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: '3'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        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,7 +120,6 @@ 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
@@ -117,6 +130,7 @@ files:
 - 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
@@ -124,11 +138,11 @@ files:
 - 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
@@ -144,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