code_caser 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0fdaa2d4caf807b396c917cc218140c5c875099
-  data.tar.gz: e70ac1a05cca5972956a60a2021f5c7cbca4daaf
+  metadata.gz: dff1ea58bc087c06e16db95c43a0ea694919d88e
+  data.tar.gz: 1d538e2ec7a88d444f52fa6760927ce11cfec071
 SHA512:
-  metadata.gz: a26d48db5e215512f28a8e9233ed95a3cf9e8cfd5cacd2595a9d092fe5006ed4ef9336e3432a5888b6ff8e5f575f066a2f4b55cec2212f05292e65c6d98f9545
-  data.tar.gz: b3a6c6469d3f98af007ca5449ace3a0050d9b42c80dc2973363631bab47d9152e38a523fc4dcf6002c4d9cc5711ce95d10df955cf30e4f2b4a091c8a16aa93bd
+  metadata.gz: 8c3af265ff4d2e4bb8b03af507ed976b48da522b361a637965a2bc2530d61cba00d063b7cdcd77b86c9163d528841fb3646951f218981e529053c27dadc8755b
+  data.tar.gz: 2eeefc372f4022f8fbcd612a93cda2cf236273b5924542de0284138f3bc17fb96838ff446b8548b39a7da9904e2e14fc7e54e7d0e32828f3f8d0b32bcb6a5775

data/README.md

@@ -1,9 +1,7 @@
 # CodeCaser
-
 A simple Ruby command line utility that converts files from camelCase to snake_case and vice-versa.
 
 ## Installation
-
 To install:
 ```
 $ gem install code_caser
@@ -34,3 +32,6 @@ $ code_caser to_camel --path=/folder/subfolder/*.js
 Use the ```--verbose``` flag to print any changes made to each file to the terminal.
 
 By default, backup copies of each file converted will be saved to a timestamped backup folder in the ```--path``` directory. You can prevent backups from being created by passing in the ```--no-save``` flag.
+
+## License
+code_caser is available under the MIT License.

data/bin/code_caser

@@ -3,24 +3,65 @@ require "rubygems"
 require "thor"
 require_relative "../lib/code_caser"
 
-class CaserCLI < Thor
-
-  desc "to_camel", "converts files in PATH from snake_case to camelCase."
-  option :path, type: :string, required: true
-  option :save, type: :boolean, default: true
-  option :verbose, type: :boolean, default: false
-  def to_camel
-    CodeCaser::to_camel(options)
+module CodeCaser
+
+  module FileArgs
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    module ClassMethods
+      def annotate(method_name, desc, save_option=true)
+        class_eval do # help keep things DRY:
+          desc method_name, desc
+          option :path, type: :string, required: true
+          option :ignore_after, type: :string, required: false,
+            desc: "ignore all text  in each line after the string IGNORE_AFTER"
+          option :verbose, type: :boolean, default: false
+          option :save, type: :boolean, default: true if save_option
+        end
+      end
+    end
+  end
+
+  class AnalyzerCLI < Thor
+    include FileArgs
+    annotate "to_camel", "checks if any existing identifiers would be overridden by converting to camelCase", false
+    def to_camel
+      CodeCaser::Analyze::to_camel(options)
+    end
+    annotate "to_snake", "checks if any existing identifiers would be overridden by converting to snake_case", false
+    def to_snake
+      CodeCaser::Analyze::to_snake(options)
+    end
   end
 
-  desc "to_snake", "converts files in PATH from camelCase to snake_case."
-  option :path, type: :string, required: true
-  option :save, type: :boolean, default: true
-  option :verbose, type: :boolean, default: false
-  def to_snake
-    CodeCaser::to_snake(options)
+  class CaserCLI < Thor
+    include FileArgs
+    annotate "to_camel", "converts files in PATH from snake_case to camelCase"
+    def to_camel
+      CodeCaser::to_camel(options)
+    end
+
+    annotate "to_snake", "converts files in PATH from camelCase to snake_case"
+    def to_snake
+      CodeCaser::to_snake(options)
+    end
+
+    # TODO: add methods to convert a single string
+
+    register CodeCaser::AnalyzerCLI, "analyze", "analyze to_camel",
+      "checks if any existing identifiers would be overridden by converting to camelCase" #, options
+
+    register CodeCaser::AnalyzerCLI, "analyze", "analyze to_snake",
+      "checks if any existing identifiers would be overridden by converting to snake_case" #, options
+
+    desc "--version, -v", "print the version number"
+    def __print_version
+      puts CodeCaser::VERSION
+    end
+    map %w(--version -v) => :__print_version
   end
 
 end
 
-CaserCLI.start
+CodeCaser::CaserCLI.start

data/lib/code_caser/analyzer.rb

@@ -0,0 +1,74 @@
+module CodeCaser
+
+  # This class scans the provided files to determine if any converted identifiers
+  # overlap with existing identifiers.
+  class Analyzer
+    def initialize(opts)
+      @converter               = opts.fetch(:converter)
+      @files                   = PathConverter.new(opts.fetch(:path)).get_files
+      @verbose                 = opts.fetch(:verbose, false)
+      @existing_identifiers    = {}
+      @new_identifiers         = {}
+      @overlapping_identifiers = []
+    end
+
+    def analyze
+      load_existing_identifiers
+      @files.each { |f| analyze_file(f) if File.file?(f) }
+      puts @existing_identifiers.keys.sort.inspect
+      print_new_identifiers if @verbose
+      @overlapping_identifiers = @new_identifiers.select {|k,v| @existing_identifiers.key?(k) }.keys
+      print_overlap
+    end
+
+    def load_existing_identifiers
+      @files.each { |f| load_existing_identifiers_from_file(f) if File.file?(f) }
+    end
+
+    def load_existing_identifiers_from_file(file_path)
+      puts "loading file: #{file_path}" if @verbose
+      IO.foreach(file_path) { |line| load_existing_identifiers_from_line(line) }
+    end
+
+    def load_existing_identifiers_from_line(line)
+      split_line(line).each { |l| @existing_identifiers[l] = true }
+    end
+
+    def analyze_file(file_path)
+      puts "loading file: #{file_path}" if @verbose
+      IO.foreach(file_path) { |line| analyze_line(line) }
+    end
+
+    def print_overlap
+      if @overlapping_identifiers.empty?
+        puts "\nNo overlapping identifiers found.".colorize(:green)
+      else
+        puts "\nThe following identifiers would overlap with existing names:".colorize(:yellow)
+        puts @overlapping_identifiers.join(",").colorize(:yellow)
+      end
+    end
+
+    def print_new_identifiers
+      puts "\nThe following identifiers would be replaced:".colorize(:yellow)
+      @new_identifiers.sort.to_h.each {|k,v| puts "#{v} -> #{k.colorize(:green)}" }
+    end
+
+    private
+
+    def analyze_line(original_line)
+      # discard anything after the ignore_after identifier
+      original_identifiers = @converter.chop(original_line).split(/\W+/)
+      original_identifiers.each do |identifier|
+        if identifier != (new_identifier = @converter.convert_line(identifier))
+          @new_identifiers[new_identifier] = identifier
+        end
+      end
+    end
+
+    def split_line(line)
+      @converter.chop(line).split(/\W+/)
+    end
+
+  end
+
+end

data/lib/code_caser/caser.rb

@@ -2,17 +2,16 @@ require 'fileutils'
 require 'colorize'
 
 module CodeCaser
-
   class Caser
     def initialize(opts = {})
-      @converter         = opts[:converter]
-      @path              = File.directory?(opts[:path]) ? File.join(opts[:path], "*") : opts[:path]
-      @save              = opts[:save] || true
-      @verbose           = opts[:verbose] || false
+      @converter      = opts.fetch(:converter)
+      @path_converter = PathConverter.new(opts.fetch(:path))
+      @save           = opts.fetch(:save, true)
+      @verbose        = opts.fetch(:verbose, false)
     end
 
     def start
-      files = get_files
+      files = @path_converter.get_files
       if files.empty?
         puts "File or folder not found.\n"
         return
@@ -30,12 +29,8 @@ module CodeCaser
 
     private
 
-    def get_files
-      Dir.glob(File.expand_path(@path))
-    end
-
     def backup_folder
-      @backup_folder ||= File.dirname(@path) + "_backup_#{Time.new.to_i}"
+      @backup_folder ||= @path_converter.join("_backup_#{Time.new.to_i}")
     end
 
     def convert_files(files)
@@ -53,16 +48,12 @@ module CodeCaser
       FileUtils.rm(file_path)
       f = File.new(file_path, "w+")
       IO.foreach(backup_file_path) do |line|
-        f.puts(convert_line(line))
+        f.puts(convert_line(line.chomp))
       end
     end
 
     def convert_line(line)
-      if (converted_line = @converter.convert_line(line)) != line && @verbose
-        puts "   " + line.strip
-        puts "   " + converted_line.strip.colorize(:green)
-      end
-      converted_line
+      @converter.convert_line(line, @verbose)
     end
 
     def user_aborted?(files)

data/lib/code_caser/converters.rb

@@ -1,6 +1,44 @@
+require 'colorize'
+
 module CodeCaser
-  class CamelConverter
-    def convert_line(str)
+  class Converter
+    def initialize(opts={})
+      if opts[:ignore_after]
+        @ignore_after = Regexp.new('(^.*?)(' + Regexp.escape(opts[:ignore_after]) + '.*)')
+      end
+    end
+
+    def convert_line(line, verbose=false)
+      converted_line = if @ignore_after && (data = match_data(line))
+        convert_string(data[1]) + data[2]
+      else
+        convert_string(line)
+      end
+      if verbose && converted_line != line
+        puts "\n   " + line.strip
+        puts "   " + converted_line.strip.colorize(:green)
+      end
+
+      converted_line
+    end
+
+    def chop(line)
+      @ignore_after && (data = match_data(line)) ? data[1] : line
+    end
+
+    def convert_string # concrete Converter implementations must supply this method
+      raise NotImplementedError
+    end
+
+    private
+
+    def match_data(line)
+      line.match(@ignore_after)
+    end
+  end
+
+  class CamelConverter < Converter
+    def convert_string(str)
       match = false
       output = str.reverse.gsub(/([a-z]+[A-Z]\B)(.)(?!\w*[A-Z]\b)/) { |s|
         match = true
@@ -17,8 +55,8 @@ module CodeCaser
     end
   end
 
-  class SnakeConverter
-    def convert_line(str)
+  class SnakeConverter < Converter
+    def convert_string(str)
       str.gsub(/([a-z0-9])_([a-z0-9])/) { |s| $1 + $2.upcase }
     end
 

data/lib/code_caser/path_converter.rb

@@ -0,0 +1,20 @@
+module CodeCaser
+  class PathConverter
+
+    def initialize(path)
+      @path = File.directory?(path) ? File.join(path, "*") : path
+    end
+
+    def dirname
+      File.expand_path(File.dirname(@path))
+    end
+
+    def join(name)
+      File.join(dirname + name)
+    end
+
+    def get_files
+      Dir.glob(File.expand_path(@path))
+    end
+  end
+end

data/lib/code_caser/version.rb

@@ -1,3 +1,3 @@
 module CodeCaser
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/code_caser.rb

@@ -1,11 +1,22 @@
+
 Dir[File.dirname(__FILE__) + '/code_caser/*.rb'].each {|file| require file }
 
 module CodeCaser
-  def self.to_camel(opts)
-    Caser.new(opts.merge({ converter: SnakeConverter.new })).start
-  end
+    def self.to_camel(opts)
+      Caser.new(opts.merge({ converter: SnakeConverter.new(opts) })).start
+    end
+
+    def self.to_snake(opts)
+      Caser.new(opts.merge({ converter: CamelConverter.new(opts) })).start
+    end
+
+    module Analyze
+      def self.to_camel(opts)
+        Analyzer.new(opts.merge(converter: SnakeConverter.new(opts))).analyze
+      end
 
-  def self.to_snake(opts)
-    Caser.new(opts.merge({ converter: CamelConverter.new })).start
-  end
+      def self.to_snake(opts)
+        Analyzer.new(opts.merge(converter: CamelConverter.new(opts))).analyze
+      end
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_caser
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Steve Lovell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -71,8 +71,10 @@ files:
 - Rakefile
 - bin/code_caser
 - lib/code_caser.rb
+- lib/code_caser/analyzer.rb
 - lib/code_caser/caser.rb
 - lib/code_caser/converters.rb
+- lib/code_caser/path_converter.rb
 - lib/code_caser/version.rb
 homepage: https://github.com/stephenjlovell/code_caser
 licenses: