code_tools 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbaf6f2122fa3302144ef27d0c5484c82a8bec52
-  data.tar.gz: 2b3eb698101465ed00e6b367cf55e357a1aede36
+  metadata.gz: da904aa42c144ba90f9479facf968c63f6c9502f
+  data.tar.gz: 090ca4a1c671a2fc91c8259801af3b6c128c21e6
 SHA512:
-  metadata.gz: a24bfc3ab574bfbc0fbc38b0568919cf1cf3fabf340c270810ff4cdd8b90b9d825b55cd2f719891c6b78e3bd8a83c59723a72d7225a49cfa9148d6b93ea71dd4
-  data.tar.gz: ceadd6e3b9b004033420b90e6e4f0bf4d63764765b3e9a2f74efd39060ed42be21309ce6773ad49346a962baba94bd71fb94ba4eb05256296beb1564e6ec65bc
+  metadata.gz: 16ad5be70ccf2e1b792f5f8745cd6c88d39c5520366ba3d4ced52104e59262478c73675b281600b5adf29a09cfe08cfaecc24107828aaa5aaad7dfe09720886b
+  data.tar.gz: 40d615576784fd90c4c3580e52e96d91c55913ca650622c3610db08802443b72f0bd988820e64a14a7854b71127d89366528c9e483a2b26c84d5724928578ac8

data/bin/code_tools

@@ -1 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env ruby
+puts "vamper - Version stamper"
+puts "ender - CR/LF line ending fixer"
+puts "spacer - Space/tab line fixer"

data/bin/ender

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'ender'
+Ender.new.execute

data/bin/spacer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'spacer'
+Spacer.new.execute

data/lib/ender.rb

@@ -0,0 +1,167 @@
+require 'ostruct'
+require 'optparse'
+require 'colorize'
+
+$VERSION='4.2.0-20151225.0'
+
+class Ender
+
+  def parse(args)
+    options = OpenStruct.new
+    options.output_filename = ''
+    options.input_filename = ''
+    options.convert_mode = nil
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = %Q(Ender Line Ending Fixer. Version #{$VERSION}
+Copyright (c) John Lyon-Smith, 2015.
+Usage:            #{File.basename(__FILE__)} [options]
+)
+      opts.separator %Q(Options:
+)
+
+      opts.on("-o", "--output FILE", String, "The output file.  Default is the same as the input file.") do |file|
+        options.output_filename = File.expand_path(file)
+      end
+
+      opts.on("-m", "--mode MODE", [:auto, :lf, :cr, :crlf], "The convert mode (auto, cr, lf, crlf)",
+              "(auto) will use the most commonly occurring ending.",
+              "Updates will only be done when this argument is given.") do |mode|
+        options.convert_mode = mode
+      end
+
+      opts.on_tail("-?", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(args)
+    options.input_filename = ARGV.pop
+    raise 'Need to specify a file to process' unless options.input_filename
+    options.input_filename = File.expand_path(options.input_filename)
+    options
+  end
+
+  def execute
+    options = self.parse(ARGV)
+
+    if !File.exist?(options.input_filename)
+      error "File #{options.input_filename} does not exist"
+      exit
+    end
+
+    if options.output_filename.length == 0
+      options.output_filename = options.input_filename
+    end
+
+    # Read the entire file and determine all the different line endings
+    file_contents = IO.read(options.input_filename)
+    num_cr = 0
+    num_lf = 0
+    num_crlf = 0
+    num_lines = 1
+
+    i = 0
+    while i < file_contents.length do
+      c = file_contents[i]
+
+      if c == "\r"
+        if i < file_contents.length - 1 and file_contents[i + 1] == "\n"
+          num_crlf += 1
+          i += 1
+        else
+          num_cr += 1
+        end
+
+        num_lines += 1
+      elsif c == "\n"
+        num_lf += 1
+        num_lines += 1
+      end
+      i += 1
+    end
+
+    num_endings = (num_cr > 0 ? 1 : 0) + (num_lf > 0 ? 1 : 0) + (num_crlf > 0 ? 1 : 0)
+    le = num_endings > 1 ? :mixed : num_cr > 0 ? :cr : num_lf > 0 ? :lf : :crlf
+    msg = "\"#{options.input_filename}\", #{le.to_s}, #{num_lines} lines"
+
+    if options.convert_mode == nil
+      puts msg
+      exit
+    end
+
+    if options.convert_mode == :auto
+      # Find the most common line ending and make that the automatic line ending
+      auto_line_ending = :lf
+      n = num_lf
+
+      if num_crlf > n
+        auto_line_ending = :crlf
+        n = num_crlf
+      end
+
+      if num_cr > n
+        auto_line_ending = :cr
+      end
+
+      options.convert_mode = auto_line_ending
+    end
+
+    new_num_lines = 1
+
+    if (options.convert_mode == :cr and num_cr + 1 == num_lines) or
+        (options.convert_mode == :lf and num_lf + 1 == num_lines) or
+        (options.convert_mode == :crlf and num_crlf + 1 == num_lines)
+      # We're not changing the line endings; nothing to do
+      new_num_lines = num_lines
+    else
+      newline_chars =
+        options.convert_mode == :cr ? "\r" :
+        options.convert_mode == :lf ? "\n" :
+        "\r\n"
+
+      file = nil
+
+      begin
+        file = File.new(options.output_filename, 'w')
+
+        i = 0
+        while i < file_contents.length
+          c = file_contents[i]
+
+          if c == "\r"
+            if i < file_contents.length - 1 && file_contents[i + 1] == "\n"
+              i += 1
+            end
+
+            new_num_lines += 1
+            file.write(newline_chars)
+          elsif c == "\n"
+            new_num_lines += 1
+            file.write(newline_chars)
+          else
+            file.write(c)
+          end
+
+          i += 1
+        end
+      rescue Exception => e
+        error "unable to write #{options.output_filename}. #{e.to_s}"
+        exit
+      ensure
+        file.close() unless !file
+      end
+
+      msg += " -> \"#{options.output_filename}\", #{options.convert_mode.to_s}, #{new_num_lines} lines"
+    end
+
+    puts msg
+  end
+
+
+  def error(msg)
+    STDERR.puts "error: #{msg}".colorize(:red)
+  end
+
+end

data/lib/spacer.rb

@@ -0,0 +1,405 @@
+require 'ostruct'
+require 'optparse'
+require 'colorize'
+
+$VERSION='4.2.0-20151225.0'
+
+class Spacer
+
+  def parse(args)
+    options = OpenStruct.new
+    options.output_filename = ''
+    options.input_filename = nil
+    options.convert_mode = nil
+    options.tabsize = 4
+    options.round_down_spaces = false
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = %Q(Spacer Text File Space/Tab Fixer Tool. Version #{$VERSION}
+Copyright (c) John Lyon-Smith, 2015.
+Usage:            #{File.basename(__FILE__)} [options]
+)
+      opts.separator %Q(Description:
+When reporting the tool indicates beginning-of-line \(BOL\) tabs and spaces.
+When replacing, all tabs not at the beginning of a line are replaced with spaces.
+Spaces and tabs inside multi-line C# strings (@"...") and inside Ruby \%Q\(...\) strings
+are ignored.
+Note that conversion to tabs may still leave the file as mixed as some lines may have
+spaces that are not a whole number multiple of the tabstop size.  In that case use the
+-round option to remove smooth out the spurious spaces.
+
+)
+      opts.separator %Q(Options:
+)
+
+      opts.on("-o", "--output FILE", String, "The output file.  Default is the same as the input file.") do |file|
+        options.output_filename = File.expand_path(file)
+      end
+
+      opts.on("-m", "--mode MODE", [:mixed, :tabs, :spaces], "The convert mode (mixed, tabs or spaces)",
+              "Default is to just display the files current state.",
+              "Updates will only be done when this argument is given.") do |mode|
+        options.convert_mode = mode
+      end
+
+      opts.on("-t", "--tabsize SIZE", Integer, "Tab size. Default is 4 spaces.",
+              "Default is to just display the files current state.",
+              "Updates will only be done when this argument is given.") do |size|
+        options.tabsize = size
+      end
+
+      opts.on("-r", "--round", "When tabifying, round BOL spaces down to an exact number of tabs.") do |round|
+        options.round_down_spaces = round
+      end
+
+      opts.on_tail("-?", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(args)
+    options.input_filename = ARGV.pop
+    if options.input_filename == nil
+      error 'Need to specify a file to process'
+      exit
+    end
+    options.input_filename = File.expand_path(options.input_filename)
+    options
+  end
+
+  def execute
+    options = self.parse(ARGV)
+
+    if !File.exist?(options.input_filename)
+      error "File #{options.input_filename} does not exist"
+      exit
+    end
+
+    if options.output_filename.length == 0
+      options.output_filename = options.input_filename
+    end
+
+    if File.extname(options.input_filename) == '.cs'
+      file_type = :csharp
+    else
+      file_type = :other
+    end
+
+    lines = read_file_lines(options.input_filename)
+
+    if file_type == :csharp
+      before = count_csharp_bol_spaces_and_tabs(lines)
+    else
+      before = count_bol_spaces_and_tabs(lines)
+    end
+
+    if options.convert_mode != nil
+     if file_type == :other
+       untabify(lines, options)
+     else
+       csharp_untabify(lines, options)
+     end
+
+     if options.convert_mode == :tabs
+       if file_type == :other
+         tabify(lines, options)
+       else
+         csharp_tabify(lines, options)
+       end
+     end
+   end
+
+   ws = get_whitespace_type(before)
+
+   msg = "\"#{options.input_filename}\", #{file_type.to_s}, #{ws.to_s}"
+
+   if options.convert_mode != nil
+      if file_type == :csharp
+        after = count_csharp_bol_spaces_and_tabs(lines)
+      else
+        after = count_bol_spaces_and_tabs(lines)
+      end
+
+      ws = get_whitespace_type(after)
+      file = nil
+
+      begin
+        file = File.new(options.output_filename, 'w')
+
+        for line in lines do
+          file.write(line)
+        end
+      ensure
+        file.close() unless file == nil
+      end
+
+      msg += " -> \"#{options.output_filename}\", #{ws.to_s}"
+    end
+
+    puts msg
+  end
+
+  def get_whitespace_type(bol)
+    (bol.tabs > 0) ? (bol.spaces > 0 ? :mixed : :tabs) : :spaces
+  end
+
+  def read_file_lines(filename)
+    # Read the entire file
+    file_contents = File.read(filename)
+
+    # Convert to a list of lines, preserving the end-of-lines
+    lines = []
+    s = 0
+    i = 0
+
+    while i < file_contents.length do
+      c = file_contents[i]
+      c1 = i < file_contents.length - 1 ? file_contents[i + 1] : "\0"
+
+      if c == "\r"
+        i += 1
+
+        if c1 == "\n"
+          i += 1
+        end
+      elsif c == "\n"
+        i += 1
+      else
+        i += 1
+        next
+      end
+
+      lines.push(file_contents[s, i - s])
+      s = i
+    end
+
+    if s != i
+      lines.push(file_contents[s, i - s])
+    end
+
+    lines
+  end
+
+  def count_csharp_bol_spaces_and_tabs(lines)
+    bol = OpenStruct.new
+    bol.tabs = 0
+    bol.spaces = 0
+    in_multi_line_string = false
+
+    for line in lines do
+      in_bol = true
+      i = 0
+      while i < line.length do
+        c = line[i]
+        c1 = i < line.length - 1 ? line[i + 1] : "\0"
+
+        if in_multi_line_string and c == "\"" and c1 != "\""
+          in_multi_line_string = false
+        elsif c == "@" and c1 == "\""
+          in_multi_line_string = true
+          i += 1
+        elsif in_bol and !in_multi_line_string and c == " "
+          bol.spaces += 1
+        elsif in_bol and !in_multi_line_string and c == "\t"
+          bol.tabs += 1
+        else
+          in_bol = false
+        end
+        i += 1
+      end
+    end
+
+    bol
+  end
+
+  def count_bol_spaces_and_tabs(lines)
+    bol = OpenStruct.new
+    bol.spaces = 0
+    bol.tabs = 0
+
+    for line in lines do
+      for i in 0...line.length do
+        c = line[i]
+
+        if c == " "
+          bol.spaces += 1
+        elsif c == "\t"
+          bol.tabs += 1
+        else
+          break
+        end
+      end
+    end
+
+    bol
+  end
+
+  def untabify(lines, options)
+    i = 0
+    while i < lines.length do
+      line = lines[i]
+      j = 0
+      new_line = ""
+
+      while j < line.length do
+        c = line[j]
+
+        if c == "\t"
+          num_spaces = options.tabsize - (new_line.length % options.tabsize)
+          new_line += " " * num_spaces
+        else
+          new_line += c
+        end
+        j += 1
+      end
+
+      lines[i] = new_line
+      i += 1
+    end
+  end
+
+  def tabify(lines, options)
+    i = 0
+    while i < lines.length do
+      line = lines[i]
+      j = 0
+      bol = true
+      num_bol_spaces = 0
+      new_line = ""
+
+      while j < line.length do
+        c = line[j]
+
+        if bol and c == " "
+          num_bol_spaces += 1
+        elsif bol and c != " "
+          bol = false
+          new_line += "\t" * (num_bol_spaces / options.tabsize)
+
+          if !options.round_down_spaces
+            new_line += " " * (num_bol_spaces % options.tabsize)
+          end
+
+          new_line += c
+        else
+          new_line += c
+        end
+
+        j += 1
+      end
+
+      lines[i] = new_line
+      i += 1
+    end
+  end
+
+  def csharp_untabify(lines, options)
+    # Expand tabs anywhere on a line, but not inside @"..." strings
+    in_multi_line_string = false
+
+    i = 0
+    while i < lines.length do
+      line = lines[i]
+      in_string = false
+      new_line = ""
+      j = 0
+
+      while j < line.length do
+        c_1 = j > 0 ? line[j - 1] : '\0'
+        c = line[j]
+        c1 = j < line.length - 1 ? line[j + 1] : '\0'
+
+        raise "line #{i + 1} has overlapping regular and multiline strings" if (in_string and in_multi_line_string)
+
+        if !in_multi_line_string and c == "\t"
+          # Add spaces to next tabstop
+          num_spaces = options.tabsize - (new_line.length % options.tabsize)
+
+          new_line += " " * num_spaces
+        elsif !in_multi_line_string and !in_string and c == "\""
+          in_string = true
+          new_line += c
+        elsif !in_multi_line_string and !in_string and c == "@" and c1 == "\""
+          in_multi_line_string = true
+          new_line += c
+          j += 1
+          new_line += c1
+        elsif in_string and c == "\"" and c_1 != "\\"
+          in_string = false
+          new_line += c
+        elsif in_multi_line_string and c == "\"" and c1 != "\""
+          in_multi_line_string = false
+          new_line += c
+        else
+          new_line += c
+        end
+
+        lines[i] = new_line
+        j += 1
+      end
+      i += 1
+    end
+  end
+
+  def csharp_tabify(lines, options)
+    # Insert tabs for spaces, but only at the beginning of lines and not inside @"..." or "..." strings
+    in_multi_line_string = false
+    i = 0
+
+    while i < lines.length do
+      line = lines[i]
+      in_string = false
+      bol = true
+      num_bol_spaces = 0
+      new_line = ""
+      j = 0
+
+      while j < line.length do
+        c_1 = j > 0 ? line[j - 1] : "\0"
+        c = line[j]
+        c1 = j < line.length - 1 ? line[j + 1] : "\0"
+
+        if !in_string and !in_multi_line_string and bol and c == " "
+          # Just count the spaces
+          num_bol_spaces += 1
+        elsif !in_string and !in_multi_line_string and bol and c != " "
+          bol = false
+
+          new_line += "\t" * (num_bol_spaces / options.tabsize)
+
+          if !options.round_down_spaces
+            new_line += " " * (num_bol_spaces % options.tabsize)
+          end
+          # Process this character again as not BOL
+          j -= 1
+        elsif !in_multi_line_string and !in_string and c == '"'
+          in_string = true
+          new_line += c
+        elsif !in_multi_line_string and !in_string and c == "@" and c1 == "\""
+          in_multi_line_string = true
+          new_line += c
+          j += 1
+          new_line += c1
+        elsif in_string and c == "\"" and c_1 != "\\"
+          in_string = false
+          new_line += c
+        elsif in_multi_line_string and c == "\"" and c1 != "\""
+          in_multi_line_string = false
+          new_line += c
+        else
+          new_line += c
+        end
+
+        lines[i] = new_line
+        j += 1
+      end
+      i += 1
+    end
+  end
+
+  def error(msg)
+    STDERR.puts "error: #{msg}".colorize(:red)
+  end
+
+end

data/lib/vamper.rb

@@ -2,11 +2,12 @@ require 'tzinfo'
 require 'nokogiri'
 require 'ostruct'
 require 'optparse'
+require 'colorize'
 require_relative './vamper/version_file.rb'
 require_relative './vamper/version_config_file.rb'
 require_relative './core_ext.rb'
 
-$VERSION='4.1.0-20151225.0'
+$VERSION='4.2.0-20151225.0'
 
 class Vamper
 
@@ -16,15 +17,15 @@ class Vamper
     options.version_file_name = ''
 
     opt_parser = OptionParser.new do |opts|
-      opts.banner = %Q(Version Stamper. Version #{$VERSION}
+      opts.banner = %Q(Vamper Version Stamper. Version #{$VERSION}
 Copyright (c) John Lyon-Smith, 2016.
 Usage:            #{File.basename(__FILE__)} [options]
 )
       opts.separator %Q(Options:
 )
 
-      opts.on("-u", "--update", "Increment the build number and update all files") do |dir|
-        options.do_update = true
+      opts.on("-u", "--update", "Increment the build number and update all files") do |update|
+        options.do_update = update
       end
 
       opts.on_tail("-?", "--help", "Show this message") do
@@ -189,7 +190,7 @@ Usage:            #{File.basename(__FILE__)} [options]
   end
 
   def error(msg)
-    puts "error: ".red + "#{msg}"
+    puts "error: #{msg}".colorize(:red)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_tools
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - John Lyon-smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-25 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -38,18 +38,38 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
 description: Tools for source code maintenance, including version stamping, line endings
   and tab/space conversion.
 email: john@jamoki.com
 executables:
-- vamper
 - code_tools
+- ender
+- spacer
+- vamper
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/code_tools
+- bin/ender
+- bin/spacer
 - bin/vamper
 - lib/core_ext.rb
+- lib/ender.rb
+- lib/spacer.rb
 - lib/vamper.rb
 - lib/vamper/default.version.config
 - lib/vamper/version_config_file.rb