midwire_common 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 094765d867a56ed5ab9989cad74e09cc5ced384a
-  data.tar.gz: 9b46b2070c519ee053a00ef15b48d17c47f6f6b9
+  metadata.gz: d307d5ad84f9e843f0b140b76cc4d1caa9c199ed
+  data.tar.gz: 9caa3bff2e935878df2542260cb6215b19c03aaf
 SHA512:
-  metadata.gz: fafcb84d6359ed4a7398e3d9f697f44bce5252d35f1e0bec98941425c2bf8c2b7fad19e6733790cb847214126b3d41601cd9ed7615b32f327da3cc76465842ca
-  data.tar.gz: b42e948a59bda1dbf7198f10ebd312c11ad9bd5b1049414375488c0d08380d0bdff344abcb7005a6bb2d80f99a9de31cdd35a1ec694a66a0de6f4116ba799af3
+  metadata.gz: f1d18c918e5f6a8911883b96ee018925abfa5a0c2796ba14c1f3b0af896a173b792370b4d1170d3554b922a0afedbfa711039ee66d49b2da6432ce3b04d2a432
+  data.tar.gz: 1d094b78ea0d0d8e525e1490422b1a8540ac912f9cfd498988559b2aef721b8702d8e156ea2d4b37ea4c76a8a3ce2a2409280c28ac565b9d5d9dbad153608800

data/CHANGELOG

@@ -1,3 +1,8 @@
+*0.3.0* (March 10, 2016)
+
+* Cleanup the code
+* Refactor version.rake
+
 *0.2.0* (March 10, 2016)
 
 * Call `load` before returning data in YamlSetting
@@ -14,7 +19,7 @@
 * Add 'snakerirze' and 'camelize' methods in string.rb
 * Fix `version:bump` rake task to use single-quote string for VERSION.
 * Remove 'pry' dependency for 'version.rake'
-* Upgrade rubocop version 
+* Upgrade rubocop version
 * Update the README.
 * Add some specs to cover changes.
 

data/README.md

@@ -1,6 +1,6 @@
 # Midwire Common Gem
 
-**Version: 0.1.18**
+**Version: 0.3.0**
 
 A handy, light-weight Ruby library for Midwire development
 

data/lib/midwire_common/all.rb

@@ -6,7 +6,6 @@ require 'midwire_common/fixnum'
 require 'midwire_common/float'
 require 'midwire_common/hash'
 require 'midwire_common/string'
-# require 'midwire_common/system_command'
 require 'midwire_common/time'
 require 'midwire_common/time_tool'
 require 'midwire_common/yaml_setting'

data/lib/midwire_common/array.rb

@@ -43,7 +43,8 @@ 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, rest = ldescr[0], ldescr[1..-1]
+    d = 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]

data/lib/midwire_common/enumerable.rb

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

data/lib/midwire_common/hash.rb

@@ -1,6 +1,6 @@
 class BottomlessHash < Hash
   def initialize
-    super &-> h, k { h[k] = self.class.new }
+    super(&-> (h, k) { h[k] = self.class.new })
   end
 
   def self.from_hash(hash)
@@ -20,18 +20,20 @@ class Hash
     end
   end
 
+  # rubocop:disable Metrics/AbcSize
   def diff(other)
     (keys + other.keys).uniq.each_with_object({}) do |key, memo|
       unless self[key] == other[key]
-        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]]
-        end
+        memo[key] = if self[key].is_a?(Hash) && other[key].is_a?(Hash)
+                      self[key].diff(other[key])
+                    else
+                      [self[key], other[key]]
+                    end
       end
       memo
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
   # TODO: Spec/Test this method
   def apply_diff!(changes, direction = :right)
@@ -85,7 +87,7 @@ class Hash
   # ... and now h == { :b => 2, :c => 3}
   def pop(*keys)
     r = reject { |k, _v| !keys.flatten.include? k.to_sym }
-    self.reject! { |k, _v| keys.flatten.include? k.to_sym }
+    reject! { |k, _v| keys.flatten.include? k.to_sym }
     r
   end
 
@@ -113,7 +115,7 @@ class Hash
   # Recursively change keys to symbols
   # Modifies the hash keys in place.
   def recursively_symbolize_keys!
-    self.symbolize_keys!
+    symbolize_keys!
     values.each do |v|
       v.recursively_symbolize_keys! if v.is_a? Hash
     end

data/lib/midwire_common/rake_helper.rb

@@ -3,7 +3,6 @@ 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
 
@@ -12,130 +11,15 @@ module MidwireCommon
       new(dir).install
     end
 
-    attr_reader :base
+    attr_reader :basedir
 
-    def initialize(base)
-      @base = base
+    def initialize(basedir)
+      @basedir = basedir
     end
 
     def install
       task_dir = File.expand_path('../tasks', File.dirname(__FILE__))
       Dir["#{task_dir}/*.rake"].sort.each { |ext| load ext }
     end
-
-    # def build_gem
-    #   file_name = nil
-    #   sh("gem build -V '#{spec_path}'") { |out, code|
-    #     file_name = File.basename(built_gem_path)
-    #     FileUtils.mkdir_p(File.join(base, 'pkg'))
-    #     FileUtils.mv(built_gem_path, 'pkg')
-    #     Bundler.ui.confirm "#{name} #{version} built to pkg/#{file_name}"
-    #   }
-    #   File.join(base, 'pkg', file_name)
-    # end
-
-    def install_gem
-      built_gem_path = build_gem
-      out, _ = sh_with_code("gem install '#{built_gem_path}'")
-      msg = <<-string.here_with_pipe
-        |Couldn't install gem, run `gem install #{built_gem_path}'
-        | for more detailed output
-      string
-      fail msg unless out[/Successfully installed/]
-      Bundler.ui.confirm "#{name} (#{version}) installed"
-    end
-
-    def release_gem
-      guard_clean
-      guard_already_tagged
-      built_gem_path = build_gem
-      tag_version do
-        git_push
-        rubygem_push(built_gem_path)
-      end
-    end
-
-    protected
-
-    def rubygem_push(path)
-      if Pathname.new('~/.gem/credentials').expand_path.exist?
-        sh("gem push '#{path}'")
-        Bundler.ui.confirm "Pushed #{name} #{version} to rubygems.org"
-      else
-        fail <<-string.here_with_pipe
-          |Your rubygems.org credentials aren't set.
-          | Run `gem push` to set them.
-        string
-      end
-    end
-
-    def built_gem_path
-      Dir[File.join(base, "#{name}-*.gem")].sort_by { |f| File.mtime(f) }.last
-    end
-
-    def git_push
-      perform_git_push
-      perform_git_push ' --tags'
-      Bundler.ui.confirm 'Pushed git commits and tags'
-    end
-
-    def perform_git_push(options = '')
-      cmd = "git push #{options}"
-      out, code = sh_with_code(cmd)
-      msg = <<-string.here_with_pipe
-        |Couldn't git push. `#{cmd}' failed with the following output:\n\n
-        |#{out}\n
-      string
-      fail msg unless code == 0
-    end
-
-    def guard_already_tagged
-      already_included = sh('git tag').split(/\n/).include?(version_tag)
-      msg = 'This tag has already been committed to the repo.'
-      fail(msg) if already_included
-    end
-
-    def guard_clean
-      clean? || fail('There are files that need to be committed first.')
-    end
-
-    def clean?
-      sh_with_code('git diff --exit-code')[1] == 0
-    end
-
-    def tag_version
-      sh "git tag -a -m \"Version #{version}\" #{version_tag}"
-      Bundler.ui.confirm "Tagged #{version_tag}"
-      yield if block_given?
-    rescue
-      Bundler.ui.error "Untagged #{version_tag} due to error"
-      sh_with_code "git tag -d #{version_tag}"
-      raise
-    end
-
-    def sh(cmd, &block)
-      out, code = sh_with_code(cmd, &block)
-      msg = <<-string.here_with_pipe
-        |Running `#{cmd}' failed.
-        | Run this command directly for more detailed output.
-      string
-      if code == 0
-        out
-      else
-        fail(out.empty? ? msg : out)
-      end
-    end
-
-    def sh_with_code(cmd, &block)
-      cmd << ' 2>&1'
-      outbuf = ''
-      Bundler.ui.debug(cmd)
-      Dir.chdir(base) do
-        outbuf = `#{cmd}`
-        block.call(outbuf) if block if $CHILD_STATUS == 0
-      end
-      [outbuf, $CHILD_STATUS]
-    end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/midwire_common/string.rb

@@ -121,6 +121,7 @@ class String
       .downcase
   end
 
+  # rubocop:disable Style/PerlBackrefs
   def camelize
     gsub(/\/(.?)/) { '::' + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
   end

data/lib/midwire_common/time.rb

@@ -1,7 +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/version.rb

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

data/lib/midwire_common.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 require 'midwire_common/version'
 
-module Midwire
+module MidwireCommon
   class << self
     def root
       Pathname.new(File.dirname(__FILE__)).parent

data/lib/tasks/version.rake

@@ -4,18 +4,8 @@ require 'readline'
 require 'fileutils'
 require 'midwire_common/string'
 
-module Bundler
-  class GemHelper
-    # Push the gem to your own internal gem inabox server
-    # def rubygem_push(path)
-    #   sh("gem inabox '#{path}'")
-    #   Bundler.ui.confirm "Pushed #{name} #{version} to #{path}"
-    # end
-  end
-end
-
 namespace :version do
-  PROJECT_ROOT = File.expand_path(FileUtils.pwd)
+  PROJECT_ROOT = File.expand_path(FileUtils.pwd).freeze
   PROJECT_NAME = ENV['PROJECT_NAME'] || File.basename(PROJECT_ROOT)
 
   desc 'Write changes to the CHANGELOG'
@@ -27,46 +17,42 @@ namespace :version do
     )
     text << "\n"
     prepend_changelog(text)
-    system("#{ENV['EDITOR']} CHANGELOG")
+    launch_editor(changelog)
   end
 
   desc 'Increment the patch version and write changes to the changelog'
   task :bump_patch do
-    exit unless check_branch
+    exit unless check_branch_and_warn
     major, minor, patch = read_version
     patch = patch.to_i + 1
-    write_version([major, minor, patch])
-    version_string = read_version.join('.')
-    readme = open('README.md').read
-    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
+    write_version_file([major, minor, patch])
+    update_readme_version_string
     Rake::Task['version:changes'].invoke
   end
 
   desc 'Alias for :bump_patch'
-  task bump: :bump_patch do; end
+  task bump: :bump_patch
 
   desc 'Increment the minor version and write changes to the changelog'
   task :bump_minor do
-    exit unless check_branch
+    exit unless check_branch_and_warn
     major, minor, _patch = read_version
     minor = minor.to_i + 1
     patch = 0
-    write_version([major, minor, patch])
+    write_version_file([major, minor, patch])
+    update_readme_version_string
     Rake::Task['version:changes'].invoke
   end
 
   desc 'Increment the major version and write changes to the changelog'
   task :bump_major do
-    exit unless check_branch
+    exit unless check_branch_and_warn
     major, _minor, _patch = read_version
     major = major.to_i + 1
     minor = 0
     patch = 0
-    write_version([major, minor, patch])
+    write_version_file([major, minor, patch])
+    update_readme_version_string
     Rake::Task['version:changes'].invoke
   end
 
@@ -88,14 +74,16 @@ namespace :version do
   end
 
   def read_version
-    load version_file_path
+    silence_warnings do
+      load version_file_path
+    end
     text = eval("#{module_name}::VERSION")
     text.split('.')
   end
 
-  def write_version(version_array)
+  def write_version_file(version_array)
     version = version_array.join('.')
-    new_version = %(  VERSION = '#{version}')
+    new_version = %(  VERSION = '#{version}'.freeze)
     lines = File.readlines(version_file_path)
     File.open(version_file_path, 'w') do |f|
       lines.each do |line|
@@ -108,11 +96,27 @@ namespace :version do
     end
   end
 
+  def update_readme_version_string
+    version_string = read_version.join('.')
+    readme = open('README.md').read
+    regex = /^\*\*Version: [0-9\.]+\*\*$/i
+    return nil unless readme =~ regex
+    File.open('README.md', 'w') do |f|
+      f.write(readme.gsub(regex, "**Version: #{version_string}**"))
+    end
+  end
+
+  def changelog
+    return @changelog_path if @changelog_path
+    @changelog_path = File.join(PROJECT_ROOT, 'CHANGELOG')
+    FileUtils.touch(@changelog_path)
+    @changelog_path
+  end
+
   def prepend_changelog(text_array)
-    # read current changelog
-    old = File.read("#{PROJECT_ROOT}/CHANGELOG").to_s.chomp
+    old = File.read(changelog).to_s.chomp
     text_array.push(old)
-    File.open("#{PROJECT_ROOT}/CHANGELOG", 'w') do |f|
+    File.open(changelog, 'w') do |f|
       text_array.flatten.each do |line|
         f.puts(line)
       end
@@ -132,13 +136,13 @@ namespace :version do
   # rubocop:enable Lint/AssignmentInCondition
 
   def current_branch
-    `git rev-parse --abbrev-ref HEAD`.chomp
+    `git symbolic-ref --short HEAD`.chomp
   end
 
   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'.
+      |unless you plan to rebase or back-merge into 'develop'.
       |
       |If you don't care or don't know what I'm talking about just enter 'y'
       |and continue.
@@ -151,7 +155,7 @@ namespace :version do
     string
   end
 
-  def check_branch
+  def check_branch_and_warn
     return true unless current_branch == 'master'
     puts(branch_warning_message)
     while (line = $stdin.gets.chomp)
@@ -160,4 +164,16 @@ namespace :version do
       return false
     end
   end
+
+  def launch_editor(file)
+    system("#{ENV['EDITOR']} #{file}") if ENV['EDITOR']
+  end
+
+  def silence_warnings
+    original_verbosity = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = original_verbosity
+  end
 end

data/midwire_common.gemspec

@@ -5,14 +5,15 @@ Gem::Specification.new do |spec|
   spec.name          = 'midwire_common'
   spec.version       = MidwireCommon::VERSION
   spec.authors       = ['Chris Blackburn']
-  spec.email         = ['chris@midwiretech.com']
-  spec.description   = 'A useful Ruby library'
+  spec.email         = ['87a1779b@opayq.com']
   spec.summary       = 'Midwire Tech Ruby Library'
-  spec.homepage      = 'https://github.com/midwire/midwire_common'
+  spec.description   = 'A useful Ruby library'
+  spec.homepage      = 'https://bitbucket.org/midwiretech/midwire_common'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'rspec', '~> 2.14'

data/spec/lib/midwire_common/array_spec.rb

@@ -49,7 +49,6 @@ describe Array do
     a.bsearch('c').should eq(2)
   end
 
-  # rubocop:disable Metrics/LineLength
   it 'can superjoin elements' do
     [1, 2, 3].superjoin(['->', '+', '<-']).should eq('->1+2+3<-')
     [[1, 2], [2, 3]].superjoin(
@@ -58,5 +57,4 @@ describe Array do
       '<table><tr><td>1</td><td>2</td></tr><tr><td>2</td><td>3</td></tr></table>'
     )
   end
-  # rubocop:enable Metrics/LineLength
 end

data/spec/lib/midwire_common/enumerable_spec.rb

@@ -4,6 +4,6 @@ describe Enumerable do
   it 'can sort by frequency of occurrences' do
     [1, 2, 3, 3, 3, 3, 2].sort_by_frequency.should eq([3, 3, 3, 3, 2, 2, 1])
     %w(a b c d e f a f f b f a).sort_by_frequency
-      .should eq(%w(f f f f a a a b b c d e))
+                               .should eq(%w(f f f f a a a b b c d e))
   end
 end

data/spec/lib/midwire_common/hash_spec.rb

@@ -118,7 +118,7 @@ describe Hash do
       end
 
       it 'reports different values' do
-        expect(h1_values.diff(h2_values)).to eq('c' => [3, nil], 'c' => [3, 4])
+        expect(h1_values.diff(h2_values)).to eq('c' => [3, 4])
       end
 
       it 'reports different keys even with nested hashes' do

data/spec/lib/midwire_common/rake_helper_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module MidwireCommon
+  RSpec.describe RakeHelper do
+    let(:rake_helper) { described_class.new(Dir.pwd) }
+
+    context '#new' do
+      it 'returns an instance' do
+        expect(rake_helper).to be_a(described_class)
+      end
+
+      it 'sets @basedir' do
+        expect(rake_helper.basedir).to eq(Dir.pwd)
+      end
+    end
+
+    context '.install' do
+      it 'returns version.rake' do
+        file = rake_helper.install.first
+        expect(File.basename(file)).to eq('version.rake')
+      end
+
+      it 'loads version.rake' do
+        file = File.join(MidwireCommon.root, 'lib/tasks/version.rake')
+        expect(rake_helper).to receive(:load).with(file)
+        rake_helper.install
+      end
+    end
+  end
+end

data/spec/lib/midwire_common/yaml_setting_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe MidwireCommon::YamlSetting do
-  let(:root) { Midwire.root }
+  let(:root) { MidwireCommon.root }
   let(:tmpdir) { File.join(root, 'tmp') }
   let(:file) { File.join(tmpdir, 'bogus.yml') }
   let(:setting) { YamlSetting.new(file) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: midwire_common
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Blackburn
@@ -152,14 +152,13 @@ dependencies:
         version: '0.19'
 description: A useful Ruby library
 email:
-- chris@midwiretech.com
+- 87a1779b@opayq.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG
 - Gemfile
@@ -193,13 +192,15 @@ files:
 - spec/lib/midwire_common/fixnum_spec.rb
 - spec/lib/midwire_common/float_spec.rb
 - spec/lib/midwire_common/hash_spec.rb
+- spec/lib/midwire_common/rake_helper_spec.rb
 - spec/lib/midwire_common/string_spec.rb
 - spec/lib/midwire_common/time_spec.rb
 - spec/lib/midwire_common/time_tool_spec.rb
 - spec/lib/midwire_common/yaml_setting_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/midwire/midwire_common
-licenses: []
+homepage: https://bitbucket.org/midwiretech/midwire_common
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -229,6 +230,7 @@ test_files:
 - spec/lib/midwire_common/fixnum_spec.rb
 - spec/lib/midwire_common/float_spec.rb
 - spec/lib/midwire_common/hash_spec.rb
+- spec/lib/midwire_common/rake_helper_spec.rb
 - spec/lib/midwire_common/string_spec.rb
 - spec/lib/midwire_common/time_spec.rb
 - spec/lib/midwire_common/time_tool_spec.rb

data/.rubocop.yml

@@ -1,73 +0,0 @@
-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