midwire_common 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d307d5ad84f9e843f0b140b76cc4d1caa9c199ed
-  data.tar.gz: 9caa3bff2e935878df2542260cb6215b19c03aaf
+  metadata.gz: 3e7d213c8109f31ef945f647152122b7f8520363
+  data.tar.gz: 71c130a18c5ca6ab637572a5c48bbb9f0598b54b
 SHA512:
-  metadata.gz: f1d18c918e5f6a8911883b96ee018925abfa5a0c2796ba14c1f3b0af896a173b792370b4d1170d3554b922a0afedbfa711039ee66d49b2da6432ce3b04d2a432
-  data.tar.gz: 1d094b78ea0d0d8e525e1490422b1a8540ac912f9cfd498988559b2aef721b8702d8e156ea2d4b37ea4c76a8a3ce2a2409280c28ac565b9d5d9dbad153608800
+  metadata.gz: ed228a57311853ac1af82e122cd25b5d77f95280d9108355ab8164f6a6a1a8e6e42241578d58799ce1d1282f7269ab0112a2eddac2b7a4093b187760428f1c94
+  data.tar.gz: 5650ead282aa147f27e5830ef02022b25d297395a0df6e20346def21b8fc8474e483329a180da5a411e62d100eb4aeceee2039363d1a247bf89aca3d3485ea32

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.2.4

data/CHANGELOG

@@ -1,3 +1,14 @@
+*1.1.0* (March 10, 2016)
+
+* Fix many code smells
+* Remove some duplicate methods that were provided by Ruby 2.x and stdlib
+
+*1.0.0* (March 10, 2016)
+
+* Remove thor dependency
+* Add Ruby 2.x as the required_ruby_version
+* Add version badge to README.md
+
 *0.3.0* (March 10, 2016)
 
 * Cleanup the code

data/README.md

@@ -1,6 +1,8 @@
 # Midwire Common Gem
 
-**Version: 0.3.0**
+[![Gem Version](https://badge.fury.io/rb/midwire_common.png)](https://badge.fury.io/rb/midwire_common)
+
+**Version: 1.1.0**
 
 A handy, light-weight Ruby library for Midwire development
 

data/lib/midwire_common/array.rb

@@ -1,8 +1,9 @@
+# A light-weight super Array class
 class Array
   def count_occurrences
-    k = Hash.new(0)
-    each { |x| k[x] += 1 }
-    k
+    hash = Hash.new(0)
+    each { |elem| hash[elem] += 1 }
+    hash
   end
 
   def randomize
@@ -18,8 +19,8 @@ class Array
   end
 
   def each_with_first_last(first_code, main_code, last_code)
-    each_with_index do |item, i|
-      case i
+    each_with_index do |item, ndx|
+      case ndx
       when 0 then first_code.call(item)
       when size - 1 then last_code.call(item)
       else main_code.call(item)
@@ -30,8 +31,8 @@ class Array
   # 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)
+  def binsearch(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:binsearch(e,l,u)
   end
   # rubocop:enable Style/SpaceAfterComma, Style/SpaceAroundOperators, Style/SpaceAfterColon, Style/SpaceAfterSemicolon, Style/Semicolon
 
@@ -43,11 +44,11 @@ class Array
   # [[1,2],[2,3]].superjoin( %w{<table><tr> </tr><tr> </tr></table>}, %w{<td> </td><td> </td>} )
   # => <table><tr><td>1</td><td>2</td></tr><tr><td>2</td><td>3</td></tr></table>
   def superjoin(*ldescr)
-    d = ldescr[0]
+    dim = ldescr[0]
     rest = ldescr[1..-1]
-    d[0] + map do |a|
-      (a.respond_to?(:superjoin) && rest.length > 0) ? a.superjoin(*rest) : a.to_s
-    end.join(d[1]) + d[2]
+    dim[0] + map do |arr|
+      (arr.respond_to?(:superjoin) && !rest.empty?) ? arr.superjoin(*rest) : arr.to_s
+    end.join(dim[1]) + dim[2]
   end
   # rubocop:enable Metrics/LineLength
 end

data/lib/midwire_common/data_file_cache.rb

@@ -8,9 +8,9 @@ module MidwireCommon
     end
 
     def put(data)
-      x = data.dup
-      x = x.join("\n") if x.is_a? Array
-      File.open(@cache_file, 'w') { |file| file.write(x) }
+      newdata = data.dup
+      newdata = newdata.join("\n") if newdata.is_a? Array
+      File.open(@cache_file, 'w') { |file| file.write(newdata) }
     end
 
     def get

data/lib/midwire_common/enumerable.rb

@@ -1,10 +1,11 @@
+# A more useful Enumerable module
 module Enumerable
   # Sort by frequency of occurrence
   def sort_by_frequency
-    histogram = each_with_object(Hash.new(0)) do |x, hash|
-      hash[x] += 1
+    histogram = each_with_object(Hash.new(0)) do |elem, hash|
+      hash[elem] += 1
       hash
     end
-    sort_by { |x| [histogram[x] * -1, x] }
+    sort_by { |elem| [histogram[elem] * -1, elem] }
   end
 end

data/lib/midwire_common/file/stat.rb

@@ -1,8 +1,10 @@
 class File
+  # A more useful File::Stat class
   class Stat
+    # Return device name for a given file
     def self.device_name(file)
-      Dir['/dev/*'].inject({}) do |h, v|
-        h.update(File.stat(v).rdev => v)
+      Dir['/dev/*'].inject({}) do |hash, node|
+        hash.update(File.stat(node).rdev => node)
       end.values_at(File.stat(file).dev).first || nil
     end
   end

data/lib/midwire_common/fixnum.rb

@@ -1,22 +1,4 @@
+# A more useful Fixnum class
 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 : ''
-    while int.gsub!(/(,|\.|^)(\d{3})(\d)/, '\1\2,\3')
-    end
-    int.reverse + dec
-  end
-  # rubocop:enable Style/PerlBackrefs
-
-  # Ruby 2 has its own methods for these
-
-  # def is_even?
-  #   self % 2 == 0
-  # end
-
-  # def is_odd?
-  #   !is_even?
-  # end
+  include MidwireCommon::NumberBehavior
 end

data/lib/midwire_common/float.rb

@@ -1,12 +1,4 @@
+# A more useful Float class
 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 : ''
-    while int.gsub!(/(,|\.|^)(\d{3})(\d)/, '\1\2,\3')
-    end
-    int.reverse + dec
-  end
-  # rubocop:enable Style/PerlBackrefs
+  include MidwireCommon::NumberBehavior
 end

data/lib/midwire_common/hash.rb

@@ -1,6 +1,8 @@
+# By Nick Ostrovsky
+# http://firedev.com/posts/2015/bottomless-ruby-hash/
 class BottomlessHash < Hash
   def initialize
-    super(&-> (h, k) { h[k] = self.class.new })
+    super(&-> (hash, key) { hash[key] = self.class.new })
   end
 
   def self.from_hash(hash)
@@ -8,11 +10,13 @@ class BottomlessHash < Hash
   end
 end
 
+# A more useful Hash class
 class Hash
   def bottomless
     BottomlessHash.from_hash(self)
   end
 
+  # A better grep
   def grep(pattern)
     each_with_object([]) do |kv, res|
       res << kv if kv[0] =~ pattern || kv[1] =~ pattern
@@ -75,27 +79,27 @@ class Hash
 
   # Usage { :a => 1, :b => 2, :c => 3}.except(:a) -> { :b => 2, :c => 3}
   def except(*keys)
-    reject { |k, _v| keys.flatten.include? k.to_sym }
+    reject { |key, _v| keys.flatten.include?(key.to_sym) }
   end
 
   # Usage { :a => 1, :b => 2, :c => 3}.only(:a) -> {:a => 1}
   def only(*keys)
-    dup.reject { |k, _v| !keys.flatten.include? k.to_sym }
+    dup.reject { |key, _v| !keys.flatten.include?(key.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 = reject { |k, _v| !keys.flatten.include? k.to_sym }
-    reject! { |k, _v| keys.flatten.include? k.to_sym }
-    r
+    ret = reject { |key, _v| !keys.flatten.include?(key.to_sym) }
+    reject! { |key, _v| keys.flatten.include?(key.to_sym) }
+    ret
   end
 
   # Usage { :a => 1, :b => 2, :c => 3}.to_query_string #= a=1&b=2&c=3
   def to_query_string
     require 'uri'
-    map do |k, v|
-      "#{URI.encode(k.to_s)}=#{URI.encode(v.to_s)}"
+    map do |key, value|
+      "#{URI.encode(key.to_s)}=#{URI.encode(value.to_s)}"
     end.join('&')
   end
 
@@ -116,8 +120,8 @@ class Hash
   # Modifies the hash keys in place.
   def recursively_symbolize_keys!
     symbolize_keys!
-    values.each do |v|
-      v.recursively_symbolize_keys! if v.is_a? Hash
+    values.each do |value|
+      value.recursively_symbolize_keys! if value.is_a?(Hash)
     end
     self
   end

data/lib/midwire_common/number_behavior.rb

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

data/lib/midwire_common/rake_helper.rb

@@ -1,4 +1,3 @@
-require 'thor'
 require 'midwire_common'
 
 module MidwireCommon

data/lib/midwire_common/string.rb

@@ -2,8 +2,8 @@
 class String
   class << self
     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
+      coll = ranges.map(&:to_a).flatten
+      (0..(count - 1)).map { coll[rand(coll.length)] }.join
     end
   end
 

data/lib/midwire_common/time.rb

@@ -1,7 +1,9 @@
+# A more useful Time class
 class Time
   class << self
-    def timestamp
-      Time.now.strftime('%Y%m%d%H%M%S')
+    def timestamp(resolution = 3)
+      return Time.now.strftime('%Y%m%d%H%M%S') if resolution < 1
+      Time.now.strftime("%Y%m%d%H%M%S.%#{resolution}N")
     end
   end
 end

data/lib/midwire_common/time_tool.rb

@@ -1,34 +1,42 @@
 module MidwireCommon
+  # A useful mixing for Time behavior
   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? || time.strip.empty?
-      times = time.split(/:/).reverse
-      seconds = 0
-      (0...times.length).each_with_index do |i|
-        seconds += times[i].to_i * (60**i)
+    class << self
+      # converts the given time (HH:MM:SS) to seconds
+      #
+      # +time+ the time-string
+      def time_to_seconds(time)
+        return -1 if time.nil? || time.strip.empty?
+        times = time.split(/:/).reverse
+        seconds = 0
+        (0...times.length).each_with_index do |int|
+          seconds += times[int].to_i * (60**int)
+        end
+        seconds
       end
-      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?
-      t = seconds
-      time = ''
-      2.downto(0) do |i|
-        tmp = t / (60**i)
-        t -= tmp * 60**i
-        time += ':' unless time.empty?
-        # rubocop:disable Style/FormatString
-        time += ('%02d' % tmp)
-        # rubocop:enable Style/FormatString
+      # converts the given seconds into a time string (HH:MM:SS)
+      #
+      # +seconds+ the seconds to convert
+      def seconds_to_time(seconds)
+        return 'unknown' if seconds.nil?
+        tsec = seconds
+        time = ''
+        2.downto(0) do |int|
+          power = to_the_power(60, int)
+          tmp = tsec / power
+          tsec -= tmp * power
+          time += ':' unless time.empty?
+          time += format('%02d', tmp)
+        end
+        time
+      end
+
+      private
+
+      def to_the_power(base, expon)
+        base**expon
       end
-      time
     end
   end
 end

data/lib/midwire_common/version.rb

@@ -1,6 +1,6 @@
 original_verbosity = $VERBOSE
 $VERBOSE = nil
 module MidwireCommon
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.1.0'.freeze
 end
 $VERBOSE = original_verbosity

data/lib/midwire_common/yaml_setting.rb

@@ -1,8 +1,9 @@
 require 'yaml'
 
 module MidwireCommon
+  # Simple class for YAML settings
   class YamlSetting
-    attr_accessor :file
+    attr_reader :file
     attr_reader :config
 
     def initialize(file)
@@ -15,7 +16,7 @@ module MidwireCommon
     end
 
     def save
-      File.open(file, 'w') { |f| f.write(YAML.dump(config)) }
+      File.open(file, 'w') { |thefile| thefile.write(YAML.dump(config)) }
       self
     end
 

data/lib/midwire_common.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'midwire_common/version'
 
+# Main module namespace
 module MidwireCommon
   class << self
     def root
@@ -8,5 +9,6 @@ module MidwireCommon
     end
   end
 
-  autoload :RakeHelper, 'midwire_common/rake_helper'
+  autoload :NumberBehavior, 'midwire_common/number_behavior'
+  autoload :RakeHelper,     'midwire_common/rake_helper'
 end

data/midwire_common.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2'
+
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'simplecov', '~> 0.7'
   spec.add_development_dependency 'guard', '~> 2.11'
@@ -25,6 +27,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-nav', '~> 0.2'
   spec.add_development_dependency 'rake', '~> 10.1'
   spec.add_development_dependency 'rubocop', '~> 0.36'
-
-  spec.add_dependency 'thor', '~> 0.19'
 end

data/spec/lib/midwire_common/array_spec.rb

@@ -44,9 +44,9 @@ describe Array do
 
   it 'can binary search for elements' do
     a = %w(a b c)
-    a.bsearch('a').should eq(0)
-    a.bsearch('b').should eq(1)
-    a.bsearch('c').should eq(2)
+    a.binsearch('a').should eq(0)
+    a.binsearch('b').should eq(1)
+    a.binsearch('c').should eq(2)
   end
 
   it 'can superjoin elements' do

data/spec/lib/midwire_common/file/stat_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe File::Stat do
   it 'knows on which devise it resides' do
-    s = File::Stat.device_name('/tmp')
-    s.should_not be_nil
+    dev = File::Stat.device_name('/tmp')
+    dev.should_not be_nil
   end
 end

data/spec/lib/midwire_common/time_spec.rb

@@ -1,10 +1,47 @@
 require 'spec_helper'
 
 describe Time do
-  it 'generates a timestamp, appropriate for a filename' do
-    ts = Time.timestamp
-    expect(ts.length).to eq(14)
-    expect(ts.alpha_numeric?).to eq(true)
-    expect(ts.numeric?).to eq(true)
+  context 'generates a timestamp' do
+    it 'appropriate for a filename' do
+      ts = Time.timestamp
+      expect(ts.length).to eq(18)
+      expect(ts.numeric?).to eq(true)
+    end
+
+    it 'with the only seconds' do
+      ts = Time.timestamp(0)
+      expect(ts.length).to eq(14)
+      expect(ts.numeric?).to eq(true)
+    end
+
+    it 'defaults to nanosecond resolution' do
+      ts = Time.timestamp
+      expect(ts.length).to eq(18)
+      expect(ts.numeric?).to eq(true)
+    end
+
+    it 'with the millisecond resolution' do
+      ts = Time.timestamp(3)
+      expect(ts.length).to eq(18)
+      expect(ts.numeric?).to eq(true)
+    end
+
+    it 'with the microsecond resolution' do
+      ts = Time.timestamp(6)
+      expect(ts.length).to eq(21)
+      expect(ts.numeric?).to eq(true)
+    end
+
+    it 'with the nanosecond resolution' do
+      ts = Time.timestamp(9)
+      expect(ts.length).to eq(24)
+      expect(ts.numeric?).to eq(true)
+    end
+
+    it 'with the picosecond resolution' do
+      ts = Time.timestamp(12)
+      expect(ts.length).to eq(27)
+      expect(ts.numeric?).to eq(true)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: midwire_common
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Blackburn
@@ -136,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.36'
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
 description: A useful Ruby library
 email:
 - 87a1779b@opayq.com
@@ -176,6 +162,7 @@ files:
 - lib/midwire_common/fixnum.rb
 - lib/midwire_common/float.rb
 - lib/midwire_common/hash.rb
+- lib/midwire_common/number_behavior.rb
 - lib/midwire_common/rake_helper.rb
 - lib/midwire_common/rake_tasks.rb
 - lib/midwire_common/string.rb
@@ -208,9 +195,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -218,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Midwire Tech Ruby Library