midwire_common 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcbd766fa404dee3f40d4d338117022cfa80fa0f
-  data.tar.gz: 18dcf1ba51b11d5ebadf7bd7f81d5d6e1261bdd8
+  metadata.gz: 610b3c6906cff1da83a54ea846a91053db886a99
+  data.tar.gz: cce85b69aa0979b7ba4d83099409a3cebf958ebc
 SHA512:
-  metadata.gz: c1dbf997be279cb4cc0756f500b05d6319a275871633f3d177aaa7520862f03ff6d64c2a17f70cc6b98588c93761597165999eaac9340a3081330a98547afeda
-  data.tar.gz: 94b5bf3534b408b44e791f3bad888cbded6af424f1c98ea4c26bb4676df24c733d092b6386c2a5d613b97bfd7de44811407d80e3c82657b901280f576451a004
+  metadata.gz: f01eb7ce5297c9c1b99569b9864a136bd58e1614036f007ecc8f5be9f69fd3cdc4f3ebe8592a13eba5385faac9bc5d51cc900d0cf2d5260416e91f01b82581ae
+  data.tar.gz: 12e6d698c9c448d03d94ec9f052ae0eb62389f7701c7093bd80668898bbbb04b140838c740cb9eb82908ece1f49a342051034372d8c75fe31904a72538a2a2c1

data/.gitignore

@@ -17,4 +17,3 @@ test/version_tmp
 tmp
 vendor/ruby
 /vendor/
-.rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,73 @@
+Style/Documentation:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/MethodLength:
+  CountComments: false # count full line comments?
+  Max: 16
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+# MethodLength:
+#   CountComments: false
+#   Max: 30
+
+#AlignHash:
+#  EnforcedColonStyle: table
+#  EnforcedHashRocketStyle: table
+
+HashSyntax:
+  Enabled: true
+
+Lambda:
+  Description: 'Use the new lambda literal syntax for single-line blocks.'
+  Enabled: true
+
+LambdaCall:
+  Description: 'Use lambda.call(...) instead of lambda.(...).'
+  Enabled: true
+
+LineLength:
+  Max: 80
+
+AlignParameters:
+  Description: >
+                 Align the parameters of a method call if they span more
+                 than one line.
+  Enabled: false
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'stubs/**/*'
+
+Lint/Eval:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.1.5

data/CHANGELOG

@@ -1,3 +1,8 @@
+*0.1.13* (January 07, 2015)
+
+* Upgrade to Ruby 2.x idiosyncracies, i.e., Fixnum already provides 'odd?', 'even?' methods, so I removed those, etc.
+* Fix lots of Rubocop issues.
+
 *0.1.12* (December 22, 2014)
 
 * Add diff, apply_diff and apply_diff! instance methods for Hash

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/Guardfile

@@ -1,11 +1,14 @@
-guard 'rspec', :cli => '--color --format doc', all_on_start: false, all_after_pass: false do
+CLI = 'bundle exec rspec --format doc --color'
+
+guard 'rspec', cmd: CLI, all_on_start: false, all_after_pass: false do
   watch(%r{^spec/.+_spec\.rb$})
   watch('spec/spec_helper.rb')  { 'spec' }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^lib/midwire_common/all.rb$})     { 'spec' }
 end
 
-guard :rubocop do
+guard :rubocop, cli: ['-D'] do
   watch(%r{.+\.rb$})
+  watch(%r{.+\.rake$})
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end

data/README.md

@@ -1,6 +1,6 @@
 # Midwire Common Gem
 
-**Version: 0.1.12**
+**Version: 0.1.13**
 
 A handy Ruby library for Midwire development
 

data/Rakefile

@@ -1,8 +1,8 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-Dir["lib/tasks/**/*.rake"].sort.each { |ext| load ext }
+require 'bundler/gem_tasks'
+Dir['lib/tasks/**/*.rake'].sort.each { |ext| load ext }
 
 # RSpec Tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
-task :default => :spec
+task default: :spec

data/lib/midwire_common.rb

@@ -1,5 +1,5 @@
 require 'pathname'
-require "midwire_common/version"
+require 'midwire_common/version'
 
 module Midwire
   autoload :RakeHelper, 'midwire_common/rake_helper'

data/lib/midwire_common/array.rb

@@ -14,23 +14,26 @@ class Array
   end
 
   def sort_case_insensitive
-    self.sort_by { |x| x.downcase }
+    sort_by(&:downcase)
   end
 
   def each_with_first_last(first_code, main_code, last_code)
     each_with_index do |item, i|
       case i
-        when 0 then first_code.call(item)
-        when size - 1 then last_code.call(item)
-        else main_code.call(item)
+      when 0 then first_code.call(item)
+      when size - 1 then last_code.call(item)
+      else main_code.call(item)
       end
     end
   end
 
   # Binary search returns index if found or nil
+  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Style/SpaceAfterComma, Style/SpaceAroundOperators, Style/SpaceAfterColon, Style/SpaceAfterSemicolon, Style/Semicolon
   def bsearch(e, l = 0, u = length - 1)
     return if l>u;m=(l+u)/2;e<self[m]?u=m-1:l=m+1;e==self[m]?m:bsearch(e,l,u)
   end
+  # rubocop:enable Style/SpaceAfterComma, Style/SpaceAroundOperators, Style/SpaceAfterColon, Style/SpaceAfterSemicolon, Style/Semicolon
 
   # Make a string from a multi-dimensional array :
   # 1 dimension :
@@ -45,4 +48,5 @@ class Array
       (a.respond_to?(:superjoin) && rest.length > 0) ? a.superjoin(*rest) : a.to_s
     end.join(d[1]) + d[2]
   end
+  # rubocop:enable Metrics/LineLength
 end

data/lib/midwire_common/data_file_cache.rb

@@ -25,7 +25,7 @@ module MidwireCommon
     private
 
     def ensure_cache_dir
-      FileUtils::mkdir_p(@cache_dir) unless File.exist?(@cache_dir)
+      FileUtils.mkdir_p(@cache_dir) unless File.exist?(@cache_dir)
     end
 
     def normalize_filename(filename)

data/lib/midwire_common/enumerable.rb

@@ -1,7 +1,12 @@
 module Enumerable
   # Sort by frequency of occurrence
+  # rubocop:disable Style/EachWithObject
   def sort_by_frequency
-    histogram = inject(Hash.new(0)) {|hash, x| hash[x] += 1; hash}
-    sort_by {|x| [histogram[x] * -1, x]}
+    histogram = inject(Hash.new(0)) do |hash, x|
+      hash[x] += 1
+      hash
+    end
+    sort_by { |x| [histogram[x] * -1, x] }
   end
+  # rubocop:enable Style/EachWithObject
 end

data/lib/midwire_common/file.rb

@@ -1,2 +1 @@
 require 'midwire_common/file/stat'
-

data/lib/midwire_common/file/stat.rb

@@ -1,9 +1,9 @@
 class File
   class Stat
     def self.device_name(file)
-      Dir['/dev/*'].inject({}) { |h, v|
+      Dir['/dev/*'].inject({}) do |h, v|
         h.update(File.stat(v).rdev => v)
-      }.values_at(File.stat(file).dev).first || nil
+      end.values_at(File.stat(file).dev).first || nil
     end
   end
 end

data/lib/midwire_common/fixnum.rb

@@ -1,18 +1,22 @@
 class Fixnum
   # Format a number with commas and a decimal point
+  # rubocop:disable Style/PerlBackrefs
   def commify
     to_s =~ /([^\.]*)(\..*)?/
-    int, dec = $1.reverse, $2 ? $2 : ""
+    int, dec = $1.reverse, $2 ? $2 : ''
     while int.gsub!(/(,|\.|^)(\d{3})(\d)/, '\1\2,\3')
     end
     int.reverse + dec
   end
+  # rubocop:enable Style/PerlBackrefs
 
-  def is_even?
-    self % 2 == 0
-  end
+  # Ruby 2 has its own methods for these
 
-  def is_odd?
-    !is_even?
-  end
+  # def is_even?
+  #   self % 2 == 0
+  # end
+
+  # def is_odd?
+  #   !is_even?
+  # end
 end

data/lib/midwire_common/float.rb

@@ -1,10 +1,12 @@
 class Float
   # Format a number with commas and a decimal point
+  # rubocop:disable Style/PerlBackrefs
   def commify
     to_s =~ /([^\.]*)(\..*)?/
-    int, dec = $1.reverse, $2 ? $2 : ""
+    int, dec = $1.reverse, $2 ? $2 : ''
     while int.gsub!(/(,|\.|^)(\d{3})(\d)/, '\1\2,\3')
     end
     int.reverse + dec
   end
+  # rubocop:enable Style/PerlBackrefs
 end

data/lib/midwire_common/hash.rb

@@ -1,15 +1,18 @@
 class Hash
+  # rubocop:disable Style/EachWithObject
   def grep(pattern)
-    inject([]) do |res, kv|
-      res << kv if kv[0] =~ pattern or kv[1] =~ pattern
+    reduce([]) do |res, kv|
+      res << kv if kv[0] =~ pattern || kv[1] =~ pattern
       res
     end
   end
+  # rubocop:enable Style/EachWithObject
 
+  # rubocop:disable Metrics/AbcSize, Style/EachWithObject
   def diff(other)
-    (self.keys + other.keys).uniq.inject({}) do |memo, key|
+    (keys + other.keys).uniq.inject({}) do |memo, key|
       unless self[key] == other[key]
-        if self[key].kind_of?(Hash) &&  other[key].kind_of?(Hash)
+        if self[key].is_a?(Hash) &&  other[key].is_a?(Hash)
           memo[key] = self[key].diff(other[key])
         else
           memo[key] = [self[key], other[key]]
@@ -18,92 +21,91 @@ class Hash
       memo
     end
   end
+  # rubocop:enable Metrics/AbcSize, Style/EachWithObject
 
+  # TODO: Spec/Test this method
   def apply_diff!(changes, direction = :right)
     path = [[self, changes]]
     pos, local_changes = path.pop
     while local_changes
-      local_changes.each_pair {|key, change|
-        if change.kind_of?(Array)
+      local_changes.each_pair do |key, change|
+        if change.is_a?(Array)
           pos[key] = (direction == :right) ? change[1] : change[0]
         else
           path.push([pos[key], change])
         end
-      }
+      end
       pos, local_changes = path.pop
     end
     self
   end
 
+  # TODO: Spec/Test this method
+  # rubocop:disable Metrics/AbcSize
   def apply_diff(changes, direction = :right)
-    cloned = self.clone
+    cloned = clone
     path = [[cloned, changes]]
     pos, local_changes = path.pop
     while local_changes
-      local_changes.each_pair {|key, change|
-        if change.kind_of?(Array)
+      local_changes.each_pair do |key, change|
+        if change.is_a?(Array)
           pos[key] = (direction == :right) ? change[1] : change[0]
         else
           pos[key] = pos[key].clone
           path.push([pos[key], change])
         end
-      }
+      end
       pos, local_changes = path.pop
     end
     cloned
   end
+  # rubocop:enable Metrics/AbcSize
 
   # Usage { :a => 1, :b => 2, :c => 3}.except(:a) -> { :b => 2, :c => 3}
   def except(*keys)
-    self.reject { |k,v|
-      keys.flatten.include? k.to_sym
-    }
+    reject { |k, _v| keys.flatten.include? k.to_sym }
   end
 
   # Usage { :a => 1, :b => 2, :c => 3}.only(:a) -> {:a => 1}
   def only(*keys)
-    self.dup.reject { |k,v|
-      !keys.flatten.include? k.to_sym
-    }
+    dup.reject { |k, _v| !keys.flatten.include? k.to_sym }
   end
 
   # Usage h = { :a => 1, :b => 2, :c => 3}.pop(:a) -> {:a => 1}
   # ... and now h == { :b => 2, :c => 3}
   def pop(*keys)
-    r = self.reject { |k,v|
-      !keys.flatten.include? k.to_sym
-    }
-    self.reject! { |k,v|
-      keys.flatten.include? k.to_sym
-    }
+    r = reject { |k, _v| !keys.flatten.include? k.to_sym }
+    self.reject! { |k, _v| keys.flatten.include? k.to_sym }
     r
   end
 
   # Usage { :a => 1, :b => 2, :c => 3}.to_query_string #= a=1&b=2&c=3
   def to_query_string
     require 'uri'
-    collect do |k, v|
+    map do |k, v|
       "#{URI.encode(k.to_s)}=#{URI.encode(v.to_s)}"
-    end.join("&")
+    end.join('&')
   end
 
+  # rubocop:disable Style/RescueModifier
   def symbolize_keys!
     keys.each do |key|
       self[(key.to_sym rescue key) || key] = delete(key)
     end
     self
   end
+  # rubocop:enable Style/RescueModifier
 
   def symbolize_keys
     dup.symbolize_keys!
   end
 
+  # Recursively change keys to symbols
+  # Modifies the hash keys in place.
   def recursively_symbolize_keys!
     self.symbolize_keys!
-    self.values.each do |v|
-      if v.is_a? Hash
-        v.recursively_symbolize_keys!
-      end
+    values.each do |v|
+      v.recursively_symbolize_keys! if v.is_a? Hash
     end
     self
   end

data/lib/midwire_common/rake_helper.rb

@@ -3,6 +3,7 @@ require 'midwire_common'
 
 module MidwireCommon
   # RakeHelper helps to automate gem release and versioning tasks
+  # rubocop:disable Metrics/ClassLength
   class RakeHelper
     include Rake::DSL if defined? Rake::DSL
 
@@ -118,7 +119,11 @@ module MidwireCommon
         |Running `#{cmd}' failed.
         | Run this command directly for more detailed output.
       string
-      code == 0 ? out : raise(out.empty? ? msg : out)
+      if code == 0
+        out
+      else
+        fail(out.empty? ? msg : out)
+      end
     end
 
     def sh_with_code(cmd, &block)
@@ -127,11 +132,10 @@ module MidwireCommon
       Bundler.ui.debug(cmd)
       Dir.chdir(base) do
         outbuf = `#{cmd}`
-        if $? == 0
-          block.call(outbuf) if block
-        end
+        block.call(outbuf) if block if $CHILD_STATUS == 0
       end
-      [outbuf, $?]
+      [outbuf, $CHILD_STATUS]
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end