yalphabetize 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db5c206b439820c318f76ccbe2d619b5447cc845da80d3dfa19b35fb9a056591
-  data.tar.gz: 7071afd335644554083b00b0bc5e76391e015642fb8b2070496a0bc8a05d4b60
+  metadata.gz: 620d06de0e383ed3e49a6878958f5fceef74ce7ed12d50e179110ebddb5c9fb3
+  data.tar.gz: 85e47f431754b89bfe3ac0b67d46f77f4f1467b351607e8289e9a1b142772ad5
 SHA512:
-  metadata.gz: 2bc9f38dde46a29af96fd2fe8e1c1411ced5eb56eec823456ab408f3d4e972354606e1493b23d99154a4931a302619d2f7c03c8b3eea2eae9f2aa9ce174c017d
-  data.tar.gz: 7d3126ce78da54e013f77710f2f0613f13848eb52914ca1b75b02c21665b696c0f615328657a3da85220167fb5b8a2f1e899b4071f964cc5255218780ed03f91
+  metadata.gz: c388188a52fec11ef2a15c547845ddc213d3a8a2d7b8db0cd972d5e9aa22b8ac78216e812ade4006b77c1e49de7300c84f767f6f4ed5fb951acd602c73859cca
+  data.tar.gz: a8ed2b327a0542514b9bc419b07daa0a7c982fb0ad0f62da9a2292d45243661eb66149b379eb925984ed54bc97b11a2296d1a86f4527781f42ba0707d77984d4

data/bin/performance_local

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+#                                Key length | File length | No of files | Iterations | Benchmark (s)
+bundle exec bin/performance_test 1            1             1             250          0.06   &&
+bundle exec bin/performance_test 1            1             10000         50           0.41   &&
+bundle exec bin/performance_test 1            100000        1             60           0.41   &&
+bundle exec bin/performance_test 1            1000          1000          12           2.6    &&
+bundle exec bin/performance_test 1024         1             1             250          0.06   &&
+bundle exec bin/performance_test 1024         1             40000         12           1.9    &&
+bundle exec bin/performance_test 1024         100000        1             30           1.1    &&
+bundle exec bin/performance_test 1024         800           340           12           2.3

data/bin/performance_test

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'fileutils'
+require 'securerandom'
+require 'yalphabetize'
+
+key_length = ARGV[0].to_i
+file_length = ARGV[1].to_i
+number_of_files = ARGV[2].to_i
+iterations = ARGV[3].to_i
+expected = ARGV[4].to_f
+
+def suppress_output
+  original_stdout = $stdout.clone
+  $stdout.reopen(File.new(File::NULL, 'w'))
+  yield
+ensure
+  $stdout.reopen(original_stdout)
+end
+
+puts "Running performance test:\n\n"
+puts "key_length: #{key_length}"
+puts "file_length: #{file_length}"
+puts "number_of_files: #{number_of_files}"
+puts "iterations: #{iterations}"
+puts "expected: #{expected}\n\n"
+
+fixtures_dir = "performance/fixtures/#{key_length}_#{file_length}_#{number_of_files}"
+
+if !Dir.exist?(fixtures_dir) && !ENV['CI']
+  FileUtils.makedirs(fixtures_dir)
+
+  number_of_files.times do |i|
+    yaml = ''
+    file_length.times do
+      yaml += "#{SecureRandom.alphanumeric(key_length)}: VALUE\n"
+    end
+
+    puts "#{i.fdiv(number_of_files) * 100}% of files written"
+
+    File.write("#{fixtures_dir}/#{i + 1}.yml", yaml)
+  end
+end
+
+if !Dir.exist?(fixtures_dir) && ENV['CI']
+  puts "Could not find fixtures directory #{fixtures_dir}"
+  exit 1
+end
+
+times = []
+
+suppress_output do
+  iterations.times do
+    times << Benchmark.measure do
+      Yalphabetize::CLI.call([fixtures_dir])
+    end.real
+  end
+end
+
+sorted_times = times.sort
+duration = times.sum
+p50 = sorted_times[iterations / 2]
+
+if p50 > expected
+  puts 'FAILED'
+  puts "Duration: #{duration}"
+  puts "P50: #{p50}"
+  exit 1
+else
+  puts "Duration: #{duration}"
+  puts "p50: #{p50}\n\n\n"
+end

data/lib/yalphabetize/logger.rb

@@ -2,41 +2,40 @@
 
 module Yalphabetize
   class Logger
-    DEFAULT_OUTPUT = $stdout
+    DEFAULT_OUTPUT = Kernel
 
-    def initialize(output = DEFAULT_OUTPUT)
-      @output = output
+    def initialize
       @inspected_count = 0
       @offences = {}
     end
 
     def initial_summary(file_paths)
-      output.puts "Inspecting #{file_paths.size} YAML files"
+      DEFAULT_OUTPUT.puts "Inspecting #{file_paths.size} YAML files"
     end
 
     def log_offence(file_path)
       self.inspected_count += 1
       offences[file_path] = :detected
-      output.print red 'O'
+      DEFAULT_OUTPUT.print red 'O'
     end
 
     def log_no_offence
       self.inspected_count += 1
-      output.print green '.'
+      DEFAULT_OUTPUT.print green '.'
     end
 
     def final_summary
-      output.puts "\nInspected: #{inspected_count}"
-      output.puts send(list_offences_color, "Offences: #{offences.size}")
+      DEFAULT_OUTPUT.puts "\nInspected: #{inspected_count}"
+      DEFAULT_OUTPUT.puts send(list_offences_color, "Offences: #{offences.size}")
 
       offences.each { |file_path, status| puts_offence(file_path, status) }
-      return unless offences?
+      return unless uncorrected_offences?
 
-      output.puts 'Offences can be automatically fixed with `-a` or `--autocorrect`'
+      DEFAULT_OUTPUT.puts 'Offences can be automatically fixed with `-a` or `--autocorrect`'
     end
 
-    def offences?
-      @offences.any?
+    def uncorrected_offences?
+      offences.value?(:detected)
     end
 
     def log_correction(file_path)
@@ -45,20 +44,20 @@ module Yalphabetize
 
     private
 
-    attr_reader :offences, :output
+    attr_reader :offences
     attr_accessor :inspected_count
 
     def puts_offence(file_path, status)
       case status
       when :detected
-        output.puts yellow file_path
+        DEFAULT_OUTPUT.puts yellow file_path
       when :corrected
-        output.puts("#{yellow(file_path)} #{green('CORRECTED')}")
+        DEFAULT_OUTPUT.puts("#{yellow(file_path)} #{green('CORRECTED')}")
       end
     end
 
     def list_offences_color
-      offences? ? :red : :green
+      offences.any? ? :red : :green
     end
 
     def red(string)

data/lib/yalphabetize/reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'psych'
+require 'psych/comments'
 
 module Yalphabetize
   class Reader
@@ -21,7 +22,7 @@ module Yalphabetize
     end
 
     def stream_node
-      @_stream_node ||= Psych.parse_stream file
+      @_stream_node ||= parser_class.parse_stream file
     rescue Psych::SyntaxError => e
       raise Yalphabetize::ParsingError.new(
         path,
@@ -32,5 +33,13 @@ module Yalphabetize
         e.context
       )
     end
+
+    def parser_class
+      if Yalphabetize.config['preserve_comments']
+        Psych::Comments
+      else
+        Psych
+      end
+    end
   end
 end

data/lib/yalphabetize/version.rb

@@ -2,6 +2,6 @@
 
 module Yalphabetize
   class Version
-    STRING = '0.9.0'
+    STRING = '0.11.0'
   end
 end

data/lib/yalphabetize/writer.rb

@@ -20,7 +20,11 @@ module Yalphabetize
     attr_reader :stream_node, :path
 
     def new_file_content
-      @_new_file_content ||= stream_node.to_yaml(nil, line_width: MAX_LINE_WIDTH)
+      @_new_file_content ||= if Yalphabetize.config['preserve_comments']
+                               Psych::Comments.emit_yaml stream_node
+                             else
+                               stream_node.to_yaml(nil, line_width: MAX_LINE_WIDTH)
+                             end
     end
 
     def indent_sequences

data/lib/yalphabetize/yalphabetizer.rb

@@ -56,7 +56,7 @@ module Yalphabetize
 
     def final_log
       logger.final_summary
-      logger.offences? ? 1 : 0
+      logger.uncorrected_offences? ? 1 : 0
     end
 
     def reader_class

data/lib/yalphabetize/yaml_finder.rb

@@ -25,7 +25,7 @@ module Yalphabetize
         process_paths(paths)
       end
 
-      files.flatten.select { |file| valid?(file) }.map { |f| File.expand_path(f) }.uniq
+      files.flatten.select { |file| valid?(file) }.uniq
     end
 
     private
@@ -56,7 +56,7 @@ module Yalphabetize
         '--exclude-standard', '--others', '--cached', '--modified'
       )
 
-      output.split("\0").uniq.map { |git_file| "#{Dir.pwd}/#{git_file}" } if status.success?
+      output.split("\0").uniq if status.success?
     end
 
     def valid?(path)

data/lib/yalphabetize.rb

@@ -28,7 +28,8 @@ module Yalphabetize
       'indent_sequences' => true,
       'exclude' => [],
       'only' => [],
-      'sort_by' => 'ABab'
+      'sort_by' => 'ABab',
+      'preserve_comments' => true
     }.freeze
 
     def config

metadata

@@ -1,22 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Sam Jenkins
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: 
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych-comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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/performance_local
+- bin/performance_test
 - bin/yalphabetize
 - lib/yalphabetize.rb
 - lib/yalphabetize/aliaser.rb
@@ -40,11 +56,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
@@ -59,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Alphabetize your YAML files
 test_files: []