yalphabetize 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e77cd0148a5d6e1d6c31b90a12d9d7cf85fbccea7e5efa6f4240c6f60759e69e
-  data.tar.gz: d1c1b0c394f0c35a23b41fb05d1ebd39cfcf53f1bbc8c316a7dac4ee3d6fc046
+  metadata.gz: b507c005e0407945299b4d297a443fe5f019f876e90bba19e930630c11be8881
+  data.tar.gz: 624a56393c2cf67a529ed4542f66a8308c409739c216052d62b4e75997b8b5eb
 SHA512:
-  metadata.gz: 3478dcee26fe4f22d25bc81cc6f9bc874c8af9599c76971ae6c51b619c5ee6215600c161d34b36714f27e5a1b579c643f8679a770ce5e2470bf89d17203be085
-  data.tar.gz: a1bdafe93d32883ebbd8ed601a83f5521ec7519597a02e8f0f6f325c17bb502b291350529c94dfd5b709e6eb83d8ace98a48c12a88a3c2e327e92b5b62341078
+  metadata.gz: b77dd2c3d7e92e97e7c7d16cdd9359c6bd5b7084fe7006651a03d3416de73429403f17fcbd0b45f2d09225b842cb4bfb83adb9f48519b3ceb32853339e356e48
+  data.tar.gz: 27495a87a0594f9c33751a7f48e67234b1d7e8067b2e095d5dd90d162237fb309243d0c3c0617795638f1f4b837cf478be1d3969b3ff245668bf45645bca5724

data/bin/yalphabetize

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yalphabetize/reader'
+require 'yalphabetize/alphabetizer'
+require 'yalphabetize/writer'
+require 'yalphabetize/offence_detector'
+require 'yalphabetize/yaml_finder'
+require 'yalphabetize/logger'
+require 'yalphabetizer'
+
+reader = Yalphabetize::Reader
+finder = Yalphabetize::YamlFinder.new
+alphabetizer = Yalphabetize::Alphabetizer
+writer = Yalphabetize::Writer
+offence_detector = Yalphabetize::OffenceDetector
+logger = Yalphabetize::Logger.new
+
+exit Yalphabetizer.call(
+  ARGV,
+  reader: reader,
+  finder: finder,
+  alphabetizer: alphabetizer,
+  writer: writer,
+  offence_detector: offence_detector,
+  logger: logger
+)

data/lib/yalphabetize/alphabetizer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Alphabetizer
+    def initialize(stream_node)
+      @stream_node = stream_node
+    end
+
+    def call
+      alphabetize(stream_node)
+      stream_node
+    end
+
+    private
+
+    attr_reader :stream_node
+
+    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)
+      node.children.sort_by! { |key, _value| key.value }
+    end
+
+    def unpair_children(node)
+      children_clone = node.children.dup
+
+      children_clone.each do |slice|
+        node.children.push(*slice)
+        node.children.shift
+      end
+    end
+  end
+end

data/lib/yalphabetize/logger.rb

@@ -0,0 +1,76 @@
+module Yalphabetize
+  class Logger
+    def initialize
+      @inspected_count = 0
+      @offences = {}
+    end
+
+    def task_summary(file_paths)
+      puts "Inspecting #{file_paths.size} YAML files"
+    end
+
+    def log_offence(file_path)
+      @inspected_count += 1
+      offences[file_path] = :detected
+      print red 'O'
+    end
+
+    def log_no_offence
+      @inspected_count += 1
+      print green '.'
+    end
+
+    def log_inspected_count
+      puts "\nInspected: #{inspected_count}"
+    end
+
+    def list_offences
+      puts send(list_offences_color, "Offences: #{offences.size}")
+
+      @offences.each do |file_path, status|
+        case status
+        when :detected
+          puts yellow file_path
+        when :corrected
+          puts("#{yellow(file_path)} #{green("CORRECTED")}")
+        end
+      end
+    end
+
+    def offences?
+      @offences.any?
+    end
+
+    def log_correction(file_path)
+      offences[file_path] = :corrected
+    end
+
+    private
+
+    attr_reader :offences, :inspected_count
+
+    def list_offences_color
+      if offences?
+        :red
+      else
+        :green
+      end
+    end
+
+    def red(string)
+      with_color(31, string)
+    end
+
+    def yellow(string)
+      with_color(33, string)
+    end
+
+    def green(string)
+      with_color(32, string)
+    end
+
+    def with_color(color, string)
+      "\e[#{color}m#{string}\e[0m"
+    end
+  end
+end

data/lib/yalphabetize/offence_detector.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class OffenceDetector
+    def initialize(stream_node)
+      @stream_node = stream_node
+    end
+
+    def offences?
+      !alphabetized?(stream_node)
+    end
+
+    private
+
+    attr_reader :stream_node
+
+    def alphabetized?(node)
+      return false if node.mapping? && !alphabetized_children?(node)
+
+      if node.children
+        each_child_also_alphabetized?(node.children)
+      else
+        true
+      end
+    end
+
+    def alphabetized_children?(node)
+      node.children.each_cons(2).all? { |a, b| (a.first.value <=> b.first.value) <= 0 }
+    end
+
+    def each_child_also_alphabetized?(children)
+      children.flatten&.inject(true) { |bool, child_node| bool && alphabetized?(child_node) }
+    end
+  end
+end

data/lib/yalphabetize/reader.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Yalphabetize
+  class Reader
+    def initialize(path)
+      @path = path
+    end
+
+    def to_ast
+      transform(stream_node)
+      stream_node
+    end
+
+    private
+
+    attr_reader :path
+
+    def stream_node
+      @stream_node ||= Psych.parse_stream File.read(path)
+    end
+
+    def transform(node)
+      node.children&.each(&method(:transform))
+
+      return unless node.mapping?
+
+      pair_up_children(node)
+    end
+
+    def pair_up_children(node)
+      children_clone = node.children.dup
+
+      children_clone.each_slice(2) do |slice|
+        node.children.push(slice)
+        node.children.shift
+        node.children.shift
+      end
+    end
+  end
+end

data/lib/yalphabetize/writer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Writer
+    def initialize(stream_node, path)
+      @stream_node = stream_node
+      @path = path
+    end
+
+    def call
+      File.open(path, 'w') do |file|
+        file.write(stream_node.to_yaml)
+      end
+    end
+
+    private
+
+    attr_reader :stream_node, :path
+  end
+end

data/lib/yalphabetize/yaml_finder.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class YamlFinder
+    def paths
+      @_paths ||= begin
+        return if `sh -c 'command -v git'`.empty?
+
+        output, _error, status = Open3.capture3(
+          'git', 'ls-files', '-z', './**/*.yml',
+          '--exclude-standard', '--others', '--cached', '--modified'
+        )
+
+        return unless status.success?
+
+        output.split("\0").uniq.map { |git_file| "#{Dir.pwd}/#{git_file}" }
+      end
+    end
+  end
+end

data/lib/yalphabetizer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'pry'
+
+class Yalphabetizer
+  def self.call(args = [], **options)
+    new(args, options).call
+  end
+
+  def initialize(args, options)
+    @args = args
+
+    @reader = options[:reader]
+    @finder = options[:finder]
+    @alphabetizer = options[:alphabetizer]
+    @writer = options[:writer]
+    @offence_detector = options[:offence_detector]
+    @logger = options[:logger]
+  end
+
+  def call
+    logger.task_summary(file_paths)
+
+    file_paths.each do |file_path|
+      unsorted_stream_node = reader.new(file_path).to_ast
+
+      if offences?(unsorted_stream_node)
+        logger.log_offence(file_path)
+        autocorrect(unsorted_stream_node, file_path) if autocorrect?
+      else
+        logger.log_no_offence
+      end
+    end
+
+    logger.log_inspected_count
+    logger.list_offences
+
+    logger.offences? ? 1 : 0
+  end
+
+  private
+
+  attr_reader :args, :reader, :finder, :alphabetizer, :writer, :offence_detector, :logger
+
+  def file_paths
+    finder.paths
+  end
+
+  def autocorrect?
+    return true if args.include? '-a'
+    return true if args.include? '-autocorrect'
+
+    false
+  end
+
+  def autocorrect(unsorted_stream_node, file_path)
+    sorted_stream_node = alphabetizer.new(unsorted_stream_node).call
+    writer.new(sorted_stream_node, file_path).call
+    logger.log_correction(file_path)
+  end
+
+  def offences?(stream_node)
+    offence_detector.new(stream_node).offences?
+  end
+end

metadata

@@ -1,22 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Sam Jenkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
-executables: []
+executables:
+- yalphabetize
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/yalphabetize.rb
+- bin/yalphabetize
+- lib/yalphabetize/alphabetizer.rb
+- lib/yalphabetize/logger.rb
+- lib/yalphabetize/offence_detector.rb
+- lib/yalphabetize/reader.rb
+- lib/yalphabetize/writer.rb
+- lib/yalphabetize/yaml_finder.rb
+- lib/yalphabetizer.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -35,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Alphabetize your YAML files

data/lib/yalphabetize.rb

@@ -1,8 +0,0 @@
-class Yalphabetize
-  def self.call
-    {
-      a: :b,
-      c: :d
-    }
-  end
-end