yalphabetize 0.4.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86d76847f2e23ff6fe3cd5a5e58304236f308cd0541a19bd3ab96f7db10bb601
-  data.tar.gz: 8c00fcc4c33db1396aeae8384d1fc62d12bb27dd5db2ef0e7115c6a1f4ccce09
+  metadata.gz: 6988242d325c39c0c114fce1300814c74456806bed554987a30b5ad5f2d6ca9b
+  data.tar.gz: 7db44e443592581729084a86b16a58248223e324f935be63af5786624edfe4da
 SHA512:
-  metadata.gz: 6e83b56bf3dafb17675575d038cb07fd69c66d7732846eb5ade8379a84d6ac2994471784b2ba6bbdfa306bcbecddcc5d7f175f31c95fd7eaf1b5b509a4d0ba91
-  data.tar.gz: 37c7d42a08c8a1ac39bfc7bdfb4ce65ec9a658884bbc433df5504f636a9797ad1695bffca1847d7a651331b9929f72bf3a2253f258be03383319e67857af0039
+  metadata.gz: de2c63f96b4d3b182f79c0c57256a94f0f9f357cc49378b76b37c2dac21156256c8193d7dd45f8471992a3e9e83847db324dd0c216668da492ed72206606ed9a
+  data.tar.gz: acf1e2c0c0ae38053c6b5e705768c06dc4ea15e52746d6361133ccbe7b2f6be475777e0ab7af92c92d867f28fd3ffc2ce3501c2908b279906ed2213116e8ae76

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

@@ -47,7 +47,7 @@ module Yalphabetize
         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}")
+          line.prepend('  ')
         end
       end
     end

data/lib/yalphabetize/version.rb

@@ -2,6 +2,6 @@
 
 module Yalphabetize
   class Version
-    STRING = '0.4.1'
+    STRING = '0.6.2'
   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.1
+  version: 0.6.2
 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