yalphabetize 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f090c28c32a6a7248ee2c256ca9d2c166947c113025cf40701471df67de36b0
-  data.tar.gz: 42c03996392e0d810bbda8e2c2c49df5915d45ddf749d199722edc9d99105cde
+  metadata.gz: 702ef0ac265097aa95ae58399f9bd221336ebba2f29ee51b07ff03beb7c471bd
+  data.tar.gz: d2da1541ac411f12ba6b3a70534df739cfca69620b07d067dfa75bd18c4d7da7
 SHA512:
-  metadata.gz: bd41579935c1d015927274f68bdb525b0b4c9c713fcdc0aa68fa5b23c6c48c26cbf09f7d94d7343969324e78dedc0c2bd3cf8f9a0769a426ec871001f1478fe7
-  data.tar.gz: ed42eecc90264a3d79ac52e08e15b4f177bda3f1f765bff77a94e965f734c937608bc404f5e9123369ec02335d19cba100d6f109c0661cf79294dfb3e2a2b94e
+  metadata.gz: 43205417abde2761326cd34006fa49cbd574d1ec98e5d47a01f9a5769fad51883de9bc7822e206cbabf66c56f91ea54ce3c3d986bae3639550d5e3899a9759ff
+  data.tar.gz: 543936dea7ac58dc5857419cd27330214759109fa3bdb8bdf50524964bb4b1f1d6e30ce9a60fce156c70cb5fdc2694b60fc139f80085678d2841d864dd3e070c

data/bin/yalphabetize

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'yalphabetize/cli'
+require_relative '../lib/yalphabetize'
 
 exit Yalphabetize::CLI.call(ARGV)

data/lib/yalphabetize/aliaser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Aliaser
+    def initialize(stream_node)
+      @stream_node = stream_node
+      @aliases = {}
+    end
+
+    def call
+      nodes.each do |node|
+        next unless node.respond_to?(:anchor) && node.anchor
+
+        ensure_anchor_then_alias(node)
+      end
+      stream_node
+    end
+
+    private
+
+    attr_reader :stream_node, :aliases
+
+    def ensure_anchor_then_alias(node)
+      if node.alias?
+        aliases[node.anchor] ||= node
+      elsif aliases[node.anchor]
+        swap(node, aliases[node.anchor])
+      end
+    end
+
+    def swap(anchor_node, alias_node)
+      stream_node.each do |node|
+        node.children&.map! do |child_node|
+          convert_node(child_node, anchor_node, alias_node)
+        end
+      end
+    end
+
+    def nodes
+      stream_node.select do |node|
+        node.respond_to?(:anchor) && node.anchor
+      end
+    end
+
+    def convert_node(child_node, anchor_node, alias_node)
+      if child_node == anchor_node
+        alias_node
+      elsif child_node == alias_node
+        anchor_node
+      else
+        child_node
+      end
+    end
+  end
+end

data/lib/yalphabetize/alphabetizer.rb

@@ -7,6 +7,7 @@ module Yalphabetize
     end
 
     def call
+      transform(stream_node)
       alphabetize(stream_node)
       stream_node
     end
@@ -36,5 +37,23 @@ module Yalphabetize
         node.children.shift
       end
     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/cli.rb

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
 
-require 'yalphabetize/alphabetizer'
-require 'yalphabetize/file_yalphabetizer'
-require 'yalphabetize/logger'
-require 'yalphabetize/offence_detector'
-require 'yalphabetize/reader'
-require 'yalphabetize/writer'
-require 'yalphabetize/yaml_finder'
-require 'yalphabetizer'
-
 module Yalphabetize
   class CLI
     def self.call(argv)
@@ -20,20 +11,15 @@ module Yalphabetize
     end
 
     def call
-      Yalphabetizer.call(
-        argv,
-        reader_class: Yalphabetize::Reader,
-        finder: Yalphabetize::YamlFinder.new,
-        alphabetizer_class: Yalphabetize::Alphabetizer,
-        writer_class: Yalphabetize::Writer,
-        offence_detector_class: Yalphabetize::OffenceDetector,
-        logger: Yalphabetize::Logger.new($stdout),
-        file_yalphabetizer_class: Yalphabetize::FileYalphabetizer
-      )
+      Yalphabetizer.call argv, options
     end
 
     private
 
     attr_reader :argv
+
+    def options
+      OptionParser.parse!(argv)
+    end
   end
 end

data/lib/yalphabetize/erb_compiler.rb

@@ -41,7 +41,7 @@ module Yalphabetize
     end
 
     def compile(string)
-      scanner = Scanner.new(string.b)
+      scanner = Scanner.new(string)
       scanner.scan do |token|
         next if token.nil?
         next if token == ''

data/lib/yalphabetize/file_yalphabetizer.rb

@@ -29,13 +29,14 @@ module Yalphabetize
                 :logger, :autocorrect, :alphabetizer_class, :writer_class
 
     def autocorrect_file
-      sorted_stream_node = alphabetizer_class.new(unsorted_stream_node).call
-      writer_class.new(sorted_stream_node, file_path).call
-      logger.log_correction(file_path)
+      alphabetize
+      handle_aliases
+      rewrite_yml_file
+      print_to_log
     end
 
     def offences?
-      offence_detector_class.new(unsorted_stream_node).offences?
+      offence_detector_class.new(stream_node).offences?
     end
 
     def replace_interpolations
@@ -48,12 +49,28 @@ module Yalphabetize
       end
     end
 
+    def alphabetize
+      alphabetizer_class.new(stream_node).call
+    end
+
+    def handle_aliases
+      Aliaser.new(stream_node).call
+    end
+
+    def rewrite_yml_file
+      writer_class.new(stream_node, file_path).call
+    end
+
+    def print_to_log
+      logger.log_correction(file_path)
+    end
+
     def reader
       @_reader ||= reader_class.new(file_path)
     end
 
-    def unsorted_stream_node
-      @_unsorted_stream_node ||= reader.to_ast
+    def stream_node
+      @_stream_node ||= reader.to_ast
     end
 
     def interpolations_mapping

data/lib/yalphabetize/logger.rb

@@ -2,7 +2,9 @@
 
 module Yalphabetize
   class Logger
-    def initialize(output)
+    DEFAULT_OUTPUT = $stdout
+
+    def initialize(output = DEFAULT_OUTPUT)
       @output = output
       @inspected_count = 0
       @offences = {}
@@ -40,7 +42,7 @@ module Yalphabetize
 
     private
 
-    attr_reader :output, :offences, :inspected_count
+    attr_reader :offences, :inspected_count, :output
 
     def puts_offence(file_path, status)
       case status

data/lib/yalphabetize/offence_detector.rb

@@ -25,7 +25,7 @@ module Yalphabetize
     end
 
     def alphabetized_children?(node)
-      node.children.each_cons(2).all? { |a, b| (a.first.value <=> b.first.value) <= 0 }
+      node.children.each_slice(2).each_cons(2).all? { |a, b| (a.first.value <=> b.first.value) <= 0 }
     end
 
     def each_child_also_alphabetized?(children)

data/lib/yalphabetize/option_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Yalphabetize
+  class OptionParser
+    PARSER = ::OptionParser.new do |o|
+      o.banner = 'Usage: yalphabetize [options] [file1, file2, ...]'
+
+      o.on('-a', '--autocorrect', 'Automatically alphabetize inspected yaml files')
+      o.on('-h', '--help', 'Prints this help') do
+        puts o
+        Kernel.exit
+      end
+    end
+
+    def self.parse!(argv)
+      {}.tap { |options| PARSER.parse!(argv, into: options) }
+    end
+  end
+end

data/lib/yalphabetize/reader.rb

@@ -2,8 +2,6 @@
 
 require 'psych'
 require 'securerandom'
-require 'yalphabetize/erb_compiler'
-require 'yalphabetize/parsing_error'
 
 module Yalphabetize
   class Reader
@@ -14,7 +12,6 @@ module Yalphabetize
 
     def to_ast
       substitute_interpolations
-      transform(stream_node)
       stream_node
     end
 
@@ -51,23 +48,5 @@ module Yalphabetize
         e.context
       )
     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/version.rb

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

data/lib/yalphabetize/yalphabetizer.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Yalphabetizer
+    def self.call(args = [], options = {})
+      new(args, options).call
+    end
+
+    def initialize(args, options)
+      @args = args
+      @options = options
+    end
+
+    def call
+      initial_log
+      process_files
+      final_log
+    end
+
+    private
+
+    attr_reader :args, :options
+
+    def initial_log
+      logger.initial_summary(file_paths)
+    end
+
+    def process_files
+      file_paths.each(&method(:process_file))
+    end
+
+    def process_file(file_path)
+      file_yalphabetizer_class.new(
+        file_path,
+        reader_class: reader_class,
+        offence_detector_class: offence_detector_class,
+        logger: logger,
+        autocorrect: options[:autocorrect],
+        alphabetizer_class: alphabetizer_class,
+        writer_class: writer_class
+      ).call
+    end
+
+    def file_paths
+      @_file_paths ||= finder.paths(only: only_paths, exclude: excluded_paths)
+    end
+
+    def only_paths
+      if args.any?
+        args
+      elsif config
+        config['only'] || []
+      else
+        []
+      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
+    end
+
+    def reader_class
+      Yalphabetize::Reader
+    end
+
+    def finder
+      Yalphabetize::YamlFinder
+    end
+
+    def alphabetizer_class
+      Yalphabetize::Alphabetizer
+    end
+
+    def writer_class
+      Yalphabetize::Writer
+    end
+
+    def offence_detector_class
+      Yalphabetize::OffenceDetector
+    end
+
+    def logger
+      @_logger ||= Yalphabetize::Logger.new
+    end
+
+    def file_yalphabetizer_class
+      Yalphabetize::FileYalphabetizer
+    end
+  end
+end

data/lib/yalphabetize/yaml_finder.rb

@@ -6,6 +6,14 @@ module Yalphabetize
   class YamlFinder
     YAML_EXTENSIONS = %w[.yml .yaml].freeze
 
+    def self.paths(only:, exclude:)
+      if exclude.any?
+        new.paths(only) - new.paths(exclude)
+      else
+        new.paths(only)
+      end
+    end
+
     def initialize
       @files = []
     end
@@ -37,7 +45,7 @@ module Yalphabetize
     end
 
     def files_in_glob(glob)
-      files_in_dir([glob, glob.gsub('**', '')].uniq)
+      files_in_dir([glob, glob.gsub('**/', '').gsub('**', '')].uniq)
     end
 
     def files_in_dir(dir = Dir.pwd)

data/lib/yalphabetize.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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/parsing_error'
+require_relative 'yalphabetize/reader'
+require_relative 'yalphabetize/version'
+require_relative 'yalphabetize/writer'
+require_relative 'yalphabetize/yalphabetizer'
+require_relative 'yalphabetize/yaml_finder'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Jenkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 description:
 email:
 executables:
@@ -74,21 +102,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/yalphabetize
+- lib/yalphabetize.rb
+- 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/parsing_error.rb
 - lib/yalphabetize/reader.rb
 - lib/yalphabetize/version.rb
 - lib/yalphabetize/writer.rb
+- lib/yalphabetize/yalphabetizer.rb
 - lib/yalphabetize/yaml_finder.rb
-- lib/yalphabetizer.rb
 homepage:
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/yalphabetizer.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-class Yalphabetizer
-  def self.call(args = [], **options)
-    new(args, options).call
-  end
-
-  def initialize(args, options)
-    @args = args
-
-    @reader_class = options[:reader_class]
-    @finder = options[:finder]
-    @alphabetizer_class = options[:alphabetizer_class]
-    @writer_class = options[:writer_class]
-    @offence_detector_class = options[:offence_detector_class]
-    @logger = options[:logger]
-    @file_yalphabetizer_class = options[:file_yalphabetizer_class]
-  end
-
-  def call
-    initial_log
-    process_files
-    final_log
-  end
-
-  private
-
-  attr_reader :args, :reader_class, :finder, :alphabetizer_class, :writer_class,
-              :offence_detector_class, :logger, :file_yalphabetizer_class
-
-  def initial_log
-    logger.initial_summary(file_paths)
-  end
-
-  def process_files
-    file_paths.each(&method(:process_file))
-  end
-
-  def process_file(file_path)
-    file_yalphabetizer_class.new(
-      file_path,
-      reader_class: reader_class,
-      offence_detector_class: offence_detector_class,
-      logger: logger,
-      autocorrect: autocorrect?,
-      alphabetizer_class: alphabetizer_class,
-      writer_class: writer_class
-    ).call
-  end
-
-  def file_paths
-    explicit_paths = args.reject { |arg| arg[0] == '-' }
-    finder.paths(explicit_paths)
-  end
-
-  def autocorrect?
-    return true if args.include? '-a'
-    return true if args.include? '--autocorrect'
-
-    false
-  end
-
-  def final_log
-    logger.final_summary
-    logger.offences? ? 1 : 0
-  end
-end