midwire_common 0.1.12 → 0.1.13

data/lib/midwire_common/string.rb

@@ -1,23 +1,22 @@
 class String
-
   class << self
-    def random(count = 6, ranges = [('a'..'z'),('A'..'Z'),('0'..'9')])
-      o =  ranges.map{|i| i.to_a}.flatten;
-      string  =  (0..(count-1)).map{ o[rand(o.length)]  }.join;
+    def random(count = 6, ranges = [('a'..'z'), ('A'..'Z'), ('0'..'9')])
+      o = ranges.map(&:to_a).flatten
+      (0..(count - 1)).map { o[rand(o.length)] }.join
     end
   end
 
   def left(count)
-    self.slice(0,count)
+    slice(0, count)
   end
 
   def right(count)
-    self.slice(-count,count)
+    slice(-count, count)
   end
 
   def left_trim
     # remove leading whitespace
-    self.gsub(/^[\t\s]+/, '')
+    gsub(/^[\t\s]+/, '')
   end
 
   def left_trim!
@@ -26,7 +25,7 @@ class String
 
   def right_trim
     # remove trailing whitespace
-    self.gsub(/[\t\s]+$/, '')
+    gsub(/[\t\s]+$/, '')
   end
 
   def right_trim!
@@ -35,7 +34,7 @@ class String
 
   def trim
     # remove leading and trailing whitespace
-    self.left_trim.right_trim
+    left_trim.right_trim
   end
 
   def trim!
@@ -48,18 +47,19 @@ class String
   #   |<script type="text/javascript">
   # stop
   def here_with_pipe(delimeter = ' ')
-    lines = self.split("\n")
-    lines.map! {|c| c.sub!(/\s*\|/, '')}
+    lines = split("\n")
+    lines.map! { |c| c.sub!(/\s*\|/, '') }
     new_string = lines.join(delimeter)
-    self.replace(new_string)
+    replace(new_string)
   end
 
-  def is_alpha_numeric?
+  def alpha_numeric?
     regex = /^[a-zA-Z0-9]+$/
-    return (self =~ regex) == 0 ? true : false
+    (self =~ regex) == 0 ? true : false
   end
 
-  def is_email_address?
+  # rubocop:disable Metrics/LineLength
+  def email_address?
     # //Email address
     # //Use this version to seek out email addresses in random documents and texts.
     # //Does not match email addresses using an IP address instead of a domain name.
@@ -100,30 +100,29 @@ class String
 
     email_regex = %r{^[A-Z0-9._%-]+@[A-Z0-9.-]+\.(?:[A-Z]{2}|com|org|net|biz|info|name|aero|jobs|museum|edu|pro)$}xi # Case insensitive
 
-    return (self =~ email_regex) == 0 ? true : false
+    (self =~ email_regex) == 0 ? true : false
   end
+  # rubocop:enable Metrics/LineLength
 
-  def is_zipcode?
+  def zipcode?
     self =~ %r{^(\d{5})(-\d{4})?$}x ? true : false
   end
 
-  def is_numeric?
-    begin
-      Float(self)
-    rescue
-      false # not numeric
-    else
-      true # numeric
-    end
+  def numeric?
+    Float(self)
+  rescue
+    false # not numeric
+  else
+    true # numeric
   end
 
   def format_phone
-    self.gsub!(/[a-z,! \-\(\)\:\;\.\&\$]+/i, '')
-    '(' << slice(0..2) << ')' << slice(3..5) << '-' << slice(-4,4)
+    gsub!(/[a-z,! \-\(\)\:\;\.\&\$]+/i, '')
+    '(' << slice(0..2) << ')' << slice(3..5) << '-' << slice(-4, 4)
   end
 
   def sanitize
-    self.gsub(/[^a-z0-9,! \-\(\)\:\;\.\&\$]+/i, '')
+    gsub(/[^a-z0-9,! \-\(\)\:\;\.\&\$]+/i, '')
   end
 
   def sanitize!
@@ -131,12 +130,12 @@ class String
   end
 
   def shorten(maxcount = 30)
-    if self.length >= maxcount
+    if length >= maxcount
       shortened = self[0, maxcount]
       splitted = shortened.split(/\s/)
       if splitted.length > 1
         words = splitted.length
-        splitted[0, words-1].join(" ") + '...'
+        splitted[0, words - 1].join(' ') + '...'
       else
         shortened[0, maxcount - 3] + '...'
       end
@@ -146,10 +145,10 @@ class String
   end
 
   def escape_single_quotes
-    self.gsub(/[']/, '\\\\\'')
+    gsub(/[']/, '\\\\\'')
   end
 
   def escape_double_quotes
-    self.gsub(/["]/, '\\\\\"')
+    gsub(/["]/, '\\\\\"')
   end
 end

data/lib/midwire_common/time.rb

@@ -1,9 +1,7 @@
 class Time
-
   class << self
     def timestamp
-      "#{Time.now.strftime("%Y%m%d%H%M%S")}"
+      "#{Time.now.strftime('%Y%m%d%H%M%S')}"
     end
   end
-
 end

data/lib/midwire_common/time_tool.rb

@@ -1,35 +1,34 @@
 module MidwireCommon
-
   class TimeTool
-
     # converts the given time (HH:MM:SS) to seconds
     #
     # +time+ the time-string
     def self.time_to_seconds(time)
-      return -1 if time.nil? or time.strip.empty?
+      return -1 if time.nil? || time.strip.empty?
       times = time.split(/:/).reverse
       seconds = 0
-      for i in (0...times.length)
+      (0...times.length).each_with_index do |i|
         seconds += times[i].to_i * (60**i)
       end
-      return seconds
+      seconds
     end
 
     # converts the given seconds into a time string (HH:MM:SS)
     #
     # +seconds+ the seconds to convert
     def self.seconds_to_time(seconds)
-      return "unknown" if seconds.nil?
+      return 'unknown' if seconds.nil?
       t = seconds
-      time = ""
-      2.downto(0) { |i|
+      time = ''
+      2.downto(0) do |i|
         tmp = t / (60**i)
-        t = t - tmp * 60**i
-        time = time + ":" if not time.empty?
-        time = time + ("%02d" % tmp)
-      }
-      return time
+        t -= tmp * 60**i
+        time += ':' unless time.empty?
+        # rubocop:disable Style/FormatString
+        time += ('%02d' % tmp)
+        # rubocop:enable Style/FormatString
+      end
+      time
     end
   end
-
 end

data/lib/midwire_common/version.rb

@@ -1,6 +1,6 @@
 original_verbosity = $VERBOSE
 $VERBOSE = nil
 module MidwireCommon
-  VERSION = "0.1.12"
+VERSION = "0.1.13"
 end
 $VERBOSE = original_verbosity

data/lib/tasks/version.rake

@@ -6,9 +6,6 @@ require 'pry'
 
 module Bundler
   class GemHelper
-
-    protected
-
     # Push the gem to your own internal gem inabox server
     # def rubygem_push(path)
     #   sh("gem inabox '#{path}'")
@@ -21,16 +18,19 @@ namespace :version do
   PROJECT_ROOT = File.expand_path(FileUtils.pwd)
   PROJECT_NAME = ENV['PROJECT_NAME'] || File.basename(PROJECT_ROOT)
 
-  desc "Write changes to the CHANGELOG"
+  desc 'Write changes to the CHANGELOG'
   task :changes do
-    text = ask("CHANGELOG Entry:")
-    text.insert(0, "*#{read_version.join('.')}* (#{Time.now.strftime("%B %d, %Y")})\n\n")
+    text = ask('CHANGELOG Entry:')
+    text.insert(
+      0,
+      "*#{read_version.join('.')}* (#{Time.now.strftime('%B %d, %Y')})\n\n"
+    )
     text << "\n"
     prepend_changelog(text)
     system("#{ENV['EDITOR']} CHANGELOG")
   end
 
-  desc "Increment the patch version and write changes to the changelog"
+  desc 'Increment the patch version and write changes to the changelog'
   task :bump_patch do
     exit unless check_branch
     major, minor, patch = read_version
@@ -38,116 +38,128 @@ namespace :version do
     write_version([major, minor, patch])
     version_string = read_version.join('.')
     readme = open('README.md').read
-    File.open('README.md', 'w') {|f| f.write(readme.gsub(/^\*\*Version: [0-9\.]+\*\*$/, "**Version: #{version_string}**")) }
-    Rake::Task["version:changes"].invoke
+    File.open('README.md', 'w') do |f|
+      # rubocop:disable Metrics/LineLength
+      f.write(readme.gsub(/^\*\*Version: [0-9\.]+\*\*$/, "**Version: #{version_string}**"))
+      # rubocop:enable Metrics/LineLength
+    end
+    Rake::Task['version:changes'].invoke
   end
-  desc "Alias for :bump_patch"
-  task :bump => :bump_patch do; end
 
-  desc "Increment the minor version and write changes to the changelog"
+  # rubocop:disable Style/Blocks
+  desc 'Alias for :bump_patch'
+  task bump: :bump_patch do; end
+  # rubocop:enable Style/Blocks
+
+  desc 'Increment the minor version and write changes to the changelog'
   task :bump_minor do
     exit unless check_branch
-    major, minor, patch = read_version
+    major, minor, _patch = read_version
     minor = minor.to_i + 1
     patch = 0
     write_version([major, minor, patch])
-    Rake::Task["version:changes"].invoke
+    Rake::Task['version:changes'].invoke
   end
 
-  desc "Increment the major version and write changes to the changelog"
+  desc 'Increment the major version and write changes to the changelog'
   task :bump_major do
     exit unless check_branch
-    major, minor, patch = read_version
+    major, _minor, _patch = read_version
     major = major.to_i + 1
     minor = 0
     patch = 0
     write_version([major, minor, patch])
-    Rake::Task["version:changes"].invoke
+    Rake::Task['version:changes'].invoke
   end
 
-  ##################################################
   private
 
-    def version_file_path
-      split = PROJECT_NAME.split('-')
-      "#{PROJECT_ROOT}/lib/#{split.join('/')}/version.rb"
-    end
+  def version_file_path
+    split = PROJECT_NAME.split('-')
+    "#{PROJECT_ROOT}/lib/#{split.join('/')}/version.rb"
+  end
 
-    def module_name
-      if PROJECT_NAME.match(/-/)
-        PROJECT_NAME.split('-').map {|e| e.capitalize}.join('::')
-      elsif PROJECT_NAME.match(/_/)
-        PROJECT_NAME.split('_').map {|e| e.capitalize}.join
-      else
-        PROJECT_NAME.capitalize
-      end
+  def module_name
+    if PROJECT_NAME.match(/-/)
+      PROJECT_NAME.split('-').map(&:capitalize).join('::')
+    elsif PROJECT_NAME.match(/_/)
+      PROJECT_NAME.split('_').map(&:capitalize).join
+    else
+      PROJECT_NAME.capitalize
     end
+  end
 
-    def read_version
-      load version_file_path
-      text = eval("#{module_name}::VERSION")
-      major, minor, patch = text.split('.')
-    end
+  def read_version
+    load version_file_path
+    text = eval("#{module_name}::VERSION")
+    text.split('.')
+  end
 
-    def write_version(version_array)
-      version = version_array.join('.')
-      new_version = %Q(  VERSION = "#{version}")
-      lines = File.readlines(version_file_path)
-      File.open(version_file_path, 'w') do |f|
-        lines.each do |line|
-          if line =~ /VERSION/
-            f.write("#{new_version.to_s}\n")
-          else
-            f.write(line)
-          end
+  def write_version(version_array)
+    version = version_array.join('.')
+    new_version = %(VERSION = "#{version}")
+    lines = File.readlines(version_file_path)
+    File.open(version_file_path, 'w') do |f|
+      lines.each do |line|
+        if line =~ /VERSION/
+          f.write("#{new_version}\n")
+        else
+          f.write(line)
         end
       end
     end
+  end
 
-    def prepend_changelog(text_array)
-      # read current changelog
-      old = File.read("#{PROJECT_ROOT}/CHANGELOG").to_s.chomp
-      text_array.push(old)
-      File.open("#{PROJECT_ROOT}/CHANGELOG", 'w')  do |f|
-        text_array.flatten.each do |line|
-          f.puts(line)
-        end
+  def prepend_changelog(text_array)
+    # read current changelog
+    old = File.read("#{PROJECT_ROOT}/CHANGELOG").to_s.chomp
+    text_array.push(old)
+    File.open("#{PROJECT_ROOT}/CHANGELOG", 'w')  do |f|
+      text_array.flatten.each do |line|
+        f.puts(line)
       end
     end
+  end
 
-    def ask(message)
-      response = []
-      puts message
-      puts "Hit <Control>-D when finished:"
-      while line = Readline.readline('* ', false)
-        response << "* #{line.chomp}" unless line.nil?
-      end
-      response
+  # rubocop:disable Lint/AssignmentInCondition
+  def ask(message)
+    response = []
+    puts message
+    puts 'Hit <Control>-D when finished:'
+    while line = Readline.readline('* ', false)
+      response << "* #{line.chomp}" unless line.nil?
     end
+    response
+  end
+  # rubocop:enable Lint/AssignmentInCondition
 
-    def current_branch
-      `git rev-parse --abbrev-ref HEAD`.chomp
-    end
+  def current_branch
+    `git rev-parse --abbrev-ref HEAD`.chomp
+  end
 
-    def check_branch
-      if current_branch == 'master'
-        puts "You typically do not want to bump versions on the 'master' branch"
-        puts "unless you plan to rebase or back-merge into the 'develop'."
-        puts ""
-        puts "If you don't care or don't know what I'm talking about just enter 'y'"
-        puts "and continue."
-        puts ""
-        puts "Optionally, you can hit 'n' to abort and switch your branch to 'develop'"
-        puts "or whatever branch you use for development, bump the version, merge to"
-        puts "'master' then 'rake release'."
-        puts ""
-        puts "Do you really want to bump the version on your 'master' branch? (y/n)"
-        while (line = $stdin.gets.chomp)
-          return true if line.match /[yY]/
-          puts "Aborting version bump."
-          return false
-        end
-      end
-      return true
+  def branch_warning_message
+    <<-string.here_with_pipe("\n")
+      |You typically do not want to bump versions on the 'master' branch
+      |unless you plan to rebase or back-merge into the 'develop'.
+      |
+      |If you don't care or don't know what I'm talking about just enter 'y'
+      |and continue.
+      |
+      |Optionally, you can hit 'n' to abort and switch your branch to 'develop'
+      |or whatever branch you use for development, bump the version, merge to
+      |'master' then 'rake release'.
+      |
+      |Do you really want to bump the version on your 'master' branch? (y/n)
+    string
+  end
+
+  def check_branch
+    return true unless current_branch == 'master'
+    puts(branch_warning_message)
+    while (line = $stdin.gets.chomp)
+      return true if line.match(/[yY]/)
+      puts 'Aborting version bump.'
+      return false
     end
+  end
 end