string_hound 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65019ba6e170312635d84647e62cb746d21bc71f
+  data.tar.gz: 01c92226b9db34dd5d91dba33b4868a1d69d686b
+SHA512:
+  metadata.gz: 5e3deb11986693e16b4a22e2a548cda6d6f5b52a3a369988336e82961e18c29d7e04933cfb248ffee6ce327ababae73ce444c7f329da7b499971d109a4f8275d
+  data.tar.gz: dd17a9d6d37ad87e4f329f73fffa1fd43b507c7d55b51f7a35391fc6c9a78f0a261b2fae6bd001720a8263080668420216b0102400e29849a32fdb1d8a821390

data/lib/regex_utils.rb

@@ -0,0 +1,37 @@
+module RegexUtils
+
+  def self.included(base)
+    base.class_eval do
+
+      def parse_for_strings(line)
+        line.scan(/["'][\w\s#\{\}]*["']/)
+      end
+
+      def is_erb_txt(line)
+        !!line.match(/<%=/).nil? && line.match(/(<%|%>)/)
+      end
+
+      def is_javascript(line)
+        !!line.match(/(\$j|\$z|function)/)
+      end
+
+      def find_printed_erb(line)
+        line.match(/<%=.*?(\n|%>)/)
+      end
+
+      def inline_strings(line)
+        if @inline && line.match(/^[\s]*(TEXT|CONTENT)/)
+          @inline = nil
+        elsif @inline || match = line.match(/(<<-TEXT|<<-CONTENT)[\s]*/)
+          @inline = true
+          match.nil? ? line : match.post_match
+        end
+      end
+
+      def find_variables(content)
+        content.scan(/#\{(\w*)\}/)
+      end
+
+    end
+  end
+end

data/lib/string_hound.rb

@@ -0,0 +1,261 @@
+require 'tempfile'
+require 'find'
+require 'nokogiri'
+require 'fileutils'
+require 'regex_utils'
+
+##
+#
+#
+# Given a directory, StringHound recursively searches the directory
+# heirarchy looking for any hardcoded strings.  When found, it prints them
+# to standard out in the form:
+#   <filename>: <line>    <string value>
+#
+# In speak mode, Stringhound will also insert a suggested i18n conversion of
+# all strings it finds into the file it finds them in, as well as
+# insert the same key and translation into the default yml file
+##
+
+class StringHound
+
+  include RegexUtils
+
+  attr_reader :view_file
+  attr_accessor :file, :command_speak, :interactive
+
+  class << self; attr_accessor  :default_yml end
+  @default_yml = "config/locales/translations/admin.yml"
+
+
+  def initialize(dir, opts = nil)
+    @directory = dir
+    @prize = []
+    @command_speak = false
+    @interactive = opts && opts[:interactive] ? opts[:interactive] : false
+  end
+
+
+  #
+  # Iterates through directory and sets up
+  # current file to hunt through.
+  # Close yml_file if speak was enabled
+  #
+  def hunt
+    Find.find(@directory) do |f|
+      unless FileTest.directory?(f)
+        @file = File.open(f, "r")
+        @view_file = ['.html', '.erb'].include?(File.extname(f))
+        sniff
+        @file.close if !@file.closed?
+      end
+    end
+    @yml_file.close if @yml_file
+  end
+
+
+  #
+  # Grabs content line by line from file and
+  # parses it.
+  # If speak is enabled, cleanup associated files
+  # after it runs
+  #
+  def sniff
+    @file.each_line do |l|
+      taste(l)
+      @content_arry.each { |m| @prize << {:filename => @file.path, :line_number => @file.lineno, :value => m } }
+      speak(l)
+    end
+
+    file_cleanup
+  end
+
+  #
+  # Parse engine
+  #
+  def taste(line)
+    @content_arry = out = []
+    #Note: this is temporary, will create a new class for 'line' to handle this all more cleanly
+    @html_text = false
+
+    if view_file
+      return if is_erb_txt(line)
+      return if is_javascript(line)
+
+      if m = find_printed_erb(line)
+        out = parse_for_strings(m[0])
+      else
+        result = Nokogiri::HTML(line)
+        @html_text = true
+        out = result.text().empty? ? out : result.text()
+      end
+    elsif result = inline_strings(line)
+      out = result
+    else
+      out = parse_for_strings(line)
+    end
+
+    @content_arry = chew(out)
+  end
+
+
+
+ #
+ # Get rid of strings that are only whitespace, only digits, or are variable names
+ # e.g. wombat_love_id, 55, ''
+ #
+  def chew(prsd_arry)
+    prsd_arry.select do |parsed_string|
+      parsed_string.match(/[\S]/) &&
+        parsed_string.match(/[\D]/)  &&
+        !parsed_string.match(/txt\.[\w]*\.[\w]*/) &&
+        !(parsed_string.match(/[\s]/).nil? && parsed_string.match(/[_-]/))
+    end
+  end
+
+
+
+  #
+  # Take each piece of found content, search
+  # it for embedded variables, construct a new key
+  # for the content line and an i18n call for the new content.
+  # Key's mainword is longest word of the string
+  #
+  # Returns:
+  #   localized_string = I18n.t('txt.admin.file_path.success', :organization => organization)
+  #   key              = txt.admin.file_path.success
+  #
+  def digest(content)
+    vars = find_variables(content)
+
+    cur_path = @file.path.split('/',2).last
+    cur_path = cur_path.split('.').first
+    cur_path.gsub!('/','.')
+
+    words = content.scan(/\w+/)
+    identifier = words[0,5].join('_')
+
+    key_name = "txt.admin." + cur_path + '.' + identifier
+    localized_string = "I18n.t('#{key_name}'"
+
+    if vars
+      vars.each { |v| localized_string << ", :#{v} => #{v}" }
+    end
+    localized_string << ")"
+
+    return localized_string, key_name
+  end
+
+
+  #
+  # If content is present, generate 18n for it and add it to tmp
+  # source file and yml file.
+  # Othewise pass through original txt
+  # to tmp file.
+  #
+  def speak(line)
+    return unless @command_speak
+
+    f_name = File.basename(@file.path)
+    @tmp_file ||= Tempfile.new(f_name)
+    @yml_file ||= File.open(self.class.default_yml, "a+")
+
+
+    if !@content_arry.empty?
+      replacement_arry=[]
+      @content_arry.each do |content|
+        i18n_string, key_name = digest(content)
+        replacement_arry << [i18n_string, content, key_name]
+      end
+
+      speak_source_file(line, replacement_arry)
+      if !@interactive || @localize_now
+        speak_yml(replacement_arry)
+      end
+    else
+      @tmp_file.write(line)
+    end
+  end
+
+
+
+  #
+  # Construct a diff like format in tmp file
+  # for i18n string
+  #
+  def speak_source_file(line, replacement_arry)
+
+    localized_line = line.dup
+    replacement_arry.each do |i18n_string, content|
+      replacement_string = @html_text ? "<%= "+ i18n_string + " %>" : i18n_string
+      localized_line.gsub!(content, replacement_string)
+    end
+
+    if @interactive
+      write_diffs(STDOUT, line, localized_line)
+      speak_to_me
+      @localize_now ? @tmp_file.write(localized_line) : @tmp_file.write(line)
+    else
+      write_diffs(@tmp_file, line, localized_line)
+    end
+  end
+
+
+ #
+ # Ask whether to localize the string now or not
+ #
+  def speak_to_me
+    begin
+      puts "Localize string now? (y/n)"
+      answer = STDIN.gets
+    end while !answer.match(/^(y|n)/)
+    @localize_now =  answer.include?("y")? true : false
+  end
+
+
+  def write_diffs(output_via, line, localized_line)
+    output_via.write("<<<<<<<<<<\n")
+    output_via.write("#{localized_line}\n")
+    output_via.write("==========\n")
+    output_via.write(line)
+    output_via.write(">>>>>>>>>>\n")
+  end
+
+  #
+  # Add translation key to yml file
+  #
+  def speak_yml(replacement_arry)
+    replacement_arry.each do |i8n_string, content, key_name|
+      quoteless_content = content.gsub(/["']/,'')
+      yml_string  = "\n  - translation:\n"
+      yml_string << "      key: \"#{key_name}\"\n"
+      yml_string << "      title: \"#{quoteless_content} label\"\n"
+      yml_string << "      value: \"#{quoteless_content}\"\n"
+
+      @yml_file.write("\n<<<<<<<<<<\n") unless @localize_now
+      @yml_file.write(yml_string)
+      @yml_file.write(">>>>>>>>>>\n") unless @localize_now
+    end
+  end
+
+
+  #
+  # Print matches to STDOUT
+  #
+  def howl
+    @prize.each { |p| puts "#{p[:filename]} : #{p[:line_number]}\t\t #{p[:value]}" }
+  end
+
+
+  #
+  # Close all files and rename tmp file to real source file
+  #
+  def file_cleanup
+    if @tmp_file
+      @tmp_file.close
+      FileUtils.mv(@tmp_file.path, @file.path)
+      @tmp_file = nil
+    end
+  end
+
+end

data/lib/string_hound/tasks.rb

@@ -0,0 +1,42 @@
+require 'string_hound'
+
+desc "Given a directory, traverse through it and output all strings in all files to STDOUT."
+namespace :hound do
+  task :hunt do
+    if ARGV.count < 2
+      puts "Incorrect number of arguments.  Please give a directory name"
+      return
+    end
+    dir = ARGV.pop
+    hound = StringHound.new(dir)
+    hound.hunt
+    hound.howl
+  end
+
+  desc "Same as hunt, except instead of outputting to STDOUT, 'speak' inserts i18 strings into source files and adds keys to default yml file"
+  task :speak do
+    if ARGV.count < 2
+      puts "Incorrect number of arguments.  Please give a directory name"
+      return
+    end
+
+    dir = ARGV.pop
+    hound = StringHound.new(dir)
+    hound.command_speak = true
+    hound.hunt
+  end
+
+  desc "Same as speak, except instead of inserting diffs directly into file, it asks permission to accept or deny the generated new string"
+  task :play do
+    if ARGV.count < 2
+      puts "Incorrect number of arguments.  Please give a directory name"
+      return
+    end
+
+    dir = ARGV.pop
+    hound = StringHound.new(dir,{:interactive => true})
+    hound.command_speak = true
+    hound.hunt
+  end
+
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: string_hound
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Noel Dellofano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies: []
+description: Bark! hunts for strings.
+email: noel@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/regex_utils.rb
+- lib/string_hound.rb
+- lib/string_hound/tasks.rb
+homepage: https://github.com/pinkvelociraptor/string_hound
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: string_hound
+test_files: []