yalphabetize 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b507c005e0407945299b4d297a443fe5f019f876e90bba19e930630c11be8881
-  data.tar.gz: 624a56393c2cf67a529ed4542f66a8308c409739c216052d62b4e75997b8b5eb
+  metadata.gz: 1f090c28c32a6a7248ee2c256ca9d2c166947c113025cf40701471df67de36b0
+  data.tar.gz: 42c03996392e0d810bbda8e2c2c49df5915d45ddf749d199722edc9d99105cde
 SHA512:
-  metadata.gz: b77dd2c3d7e92e97e7c7d16cdd9359c6bd5b7084fe7006651a03d3416de73429403f17fcbd0b45f2d09225b842cb4bfb83adb9f48519b3ceb32853339e356e48
-  data.tar.gz: 27495a87a0594f9c33751a7f48e67234b1d7e8067b2e095d5dd90d162237fb309243d0c3c0617795638f1f4b837cf478be1d3969b3ff245668bf45645bca5724
+  metadata.gz: bd41579935c1d015927274f68bdb525b0b4c9c713fcdc0aa68fa5b23c6c48c26cbf09f7d94d7343969324e78dedc0c2bd3cf8f9a0769a426ec871001f1478fe7
+  data.tar.gz: ed42eecc90264a3d79ac52e08e15b4f177bda3f1f765bff77a94e965f734c937608bc404f5e9123369ec02335d19cba100d6f109c0661cf79294dfb3e2a2b94e

data/bin/yalphabetize

@@ -1,27 +1,6 @@
 #!/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'
+require 'yalphabetize/cli'
 
-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
-)
+exit Yalphabetize::CLI.call(ARGV)

data/lib/yalphabetize/cli.rb

@@ -0,0 +1,39 @@
+# 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)
+      new(argv).call
+    end
+
+    def initialize(argv)
+      @argv = argv
+    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
+      )
+    end
+
+    private
+
+    attr_reader :argv
+  end
+end

data/lib/yalphabetize/erb_compiler.rb

@@ -0,0 +1,82 @@
+# 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.b)
+      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

data/lib/yalphabetize/file_yalphabetizer.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class FileYalphabetizer
+    def initialize(file_path, **options)
+      @file_path = file_path
+      @reader_class = options[:reader_class]
+      @offence_detector_class = options[:offence_detector_class]
+      @logger = options[:logger]
+      @autocorrect = options[:autocorrect]
+      @alphabetizer_class = options[:alphabetizer_class]
+      @writer_class = options[:writer_class]
+    end
+
+    def call
+      if offences?
+        logger.log_offence(file_path)
+        autocorrect_file if autocorrect
+      else
+        logger.log_no_offence
+      end
+
+      replace_interpolations
+    end
+
+    private
+
+    attr_reader :file_path, :reader_class, :offence_detector_class,
+                :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)
+    end
+
+    def offences?
+      offence_detector_class.new(unsorted_stream_node).offences?
+    end
+
+    def replace_interpolations
+      interpolations_mapping.each do |uuid, interpolation|
+        file_content = File.read(file_path)
+        file_content.sub!(uuid, interpolation)
+        File.open(file_path, 'w') do |file|
+          file.write file_content
+        end
+      end
+    end
+
+    def reader
+      @_reader ||= reader_class.new(file_path)
+    end
+
+    def unsorted_stream_node
+      @_unsorted_stream_node ||= reader.to_ast
+    end
+
+    def interpolations_mapping
+      reader.interpolations_mapping
+    end
+  end
+end

data/lib/yalphabetize/logger.rb

@@ -1,40 +1,33 @@
+# frozen_string_literal: true
+
 module Yalphabetize
   class Logger
-    def initialize
+    def initialize(output)
+      @output = output
       @inspected_count = 0
       @offences = {}
     end
 
-    def task_summary(file_paths)
-      puts "Inspecting #{file_paths.size} YAML files"
+    def initial_summary(file_paths)
+      output.puts "Inspecting #{file_paths.size} YAML files"
     end
 
     def log_offence(file_path)
       @inspected_count += 1
       offences[file_path] = :detected
-      print red 'O'
+      output.print red 'O'
     end
 
     def log_no_offence
       @inspected_count += 1
-      print green '.'
-    end
-
-    def log_inspected_count
-      puts "\nInspected: #{inspected_count}"
+      output.print green '.'
     end
 
-    def list_offences
-      puts send(list_offences_color, "Offences: #{offences.size}")
+    def final_summary
+      output.puts "\nInspected: #{inspected_count}"
+      output.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
+      offences.each { |file_path, status| puts_offence(file_path, status) }
     end
 
     def offences?
@@ -47,7 +40,16 @@ module Yalphabetize
 
     private
 
-    attr_reader :offences, :inspected_count
+    attr_reader :output, :offences, :inspected_count
+
+    def puts_offence(file_path, status)
+      case status
+      when :detected
+        output.puts yellow file_path
+      when :corrected
+        output.puts("#{yellow(file_path)} #{green('CORRECTED')}")
+      end
+    end
 
     def list_offences_color
       if offences?

data/lib/yalphabetize/parsing_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Yalphabetize
+  class ParsingError < Psych::SyntaxError; end
+end

data/lib/yalphabetize/reader.rb

@@ -1,24 +1,55 @@
 # frozen_string_literal: true
 
 require 'psych'
+require 'securerandom'
+require 'yalphabetize/erb_compiler'
+require 'yalphabetize/parsing_error'
 
 module Yalphabetize
   class Reader
     def initialize(path)
       @path = path
+      @interpolations_mapping = {}
     end
 
     def to_ast
+      substitute_interpolations
       transform(stream_node)
       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
+
     def stream_node
-      @stream_node ||= Psych.parse_stream File.read(path)
+      @_stream_node ||= Psych.parse_stream file
+    rescue Psych::SyntaxError => e
+      raise Yalphabetize::ParsingError.new(
+        path,
+        e.line,
+        e.column,
+        e.offset,
+        e.problem,
+        e.context
+      )
     end
 
     def transform(node)

data/lib/yalphabetize/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yalphabetize
+  class Version
+    STRING = '0.2.1'
+  end
+end

data/lib/yalphabetize/writer.rb

@@ -2,6 +2,8 @@
 
 module Yalphabetize
   class Writer
+    MAX_LINE_WIDTH = -1
+
     def initialize(stream_node, path)
       @stream_node = stream_node
       @path = path
@@ -9,12 +11,16 @@ module Yalphabetize
 
     def call
       File.open(path, 'w') do |file|
-        file.write(stream_node.to_yaml)
+        file.write new_file_content
       end
     end
 
     private
 
     attr_reader :stream_node, :path
+
+    def new_file_content
+      stream_node.to_yaml nil, line_width: MAX_LINE_WIDTH
+    end
   end
 end

data/lib/yalphabetize/yaml_finder.rb

@@ -1,20 +1,70 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module Yalphabetize
   class YamlFinder
-    def paths
-      @_paths ||= begin
-        return if `sh -c 'command -v git'`.empty?
+    YAML_EXTENSIONS = %w[.yml .yaml].freeze
+
+    def initialize
+      @files = []
+    end
 
-        output, _error, status = Open3.capture3(
-          'git', 'ls-files', '-z', './**/*.yml',
-          '--exclude-standard', '--others', '--cached', '--modified'
-        )
+    def paths(paths)
+      if paths.empty?
+        files << files_in_dir
+      else
+        process_paths(paths)
+      end
+
+      files.flatten.select(&method(:valid?)).map { |f| File.expand_path(f) }.uniq
+    end
 
-        return unless status.success?
+    private
 
-        output.split("\0").uniq.map { |git_file| "#{Dir.pwd}/#{git_file}" }
+    attr_reader :files
+
+    def process_paths(paths)
+      paths.uniq.each do |path|
+        files << if glob?(path)
+                   files_in_glob(path)
+                 elsif File.directory?(path)
+                   files_in_dir(path)
+                 else
+                   path
+                 end
       end
     end
+
+    def files_in_glob(glob)
+      files_in_dir([glob, glob.gsub('**', '')].uniq)
+    end
+
+    def files_in_dir(dir = Dir.pwd)
+      return if `sh -c 'command -v git'`.empty?
+
+      output, _error, status = Open3.capture3(
+        'git', 'ls-files', '-z', *Array(dir),
+        '--exclude-standard', '--others', '--cached', '--modified'
+      )
+
+      output.split("\0").uniq.map { |git_file| "#{Dir.pwd}/#{git_file}" } if status.success?
+    end
+
+    def valid?(path)
+      exists?(path) && yml?(path)
+    end
+
+    def exists?(path)
+      File.exist?(path)
+    end
+
+    def yml?(path)
+      YAML_EXTENSIONS.include? File.extname(path)
+    end
+
+    def glob?(path)
+      path.include?('*')
+    end
   end
 end

data/lib/yalphabetizer.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'open3'
-require 'pry'
 
 class Yalphabetizer
   def self.call(args = [], **options)
@@ -11,56 +10,60 @@ class Yalphabetizer
   def initialize(args, options)
     @args = args
 
-    @reader = options[:reader]
+    @reader_class = options[:reader_class]
     @finder = options[:finder]
-    @alphabetizer = options[:alphabetizer]
-    @writer = options[:writer]
-    @offence_detector = options[:offence_detector]
+    @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
-    logger.task_summary(file_paths)
-
-    file_paths.each do |file_path|
-      unsorted_stream_node = reader.new(file_path).to_ast
+    initial_log
+    process_files
+    final_log
+  end
 
-      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
+  private
 
-    logger.log_inspected_count
-    logger.list_offences
+  attr_reader :args, :reader_class, :finder, :alphabetizer_class, :writer_class,
+              :offence_detector_class, :logger, :file_yalphabetizer_class
 
-    logger.offences? ? 1 : 0
+  def initial_log
+    logger.initial_summary(file_paths)
   end
 
-  private
+  def process_files
+    file_paths.each(&method(:process_file))
+  end
 
-  attr_reader :args, :reader, :finder, :alphabetizer, :writer, :offence_detector, :logger
+  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
-    finder.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'
+    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?
+  def final_log
+    logger.final_summary
+    logger.offences? ? 1 : 0
   end
 end

metadata

@@ -1,17 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: yalphabetize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sam Jenkins
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: 
+date: 2021-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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
+    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
+  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:
 - yalphabetize
 extensions: []
@@ -19,16 +75,21 @@ extra_rdoc_files: []
 files:
 - bin/yalphabetize
 - 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/parsing_error.rb
 - lib/yalphabetize/reader.rb
+- lib/yalphabetize/version.rb
 - lib/yalphabetize/writer.rb
 - lib/yalphabetize/yaml_finder.rb
 - lib/yalphabetizer.rb
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,8 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Alphabetize your YAML files
 test_files: []