agile_utils 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf388b8e883700bf5974b7ddbd6778b4f055ec1e
-  data.tar.gz: 2ab8b168134d360684bfacb8c38a715a5ef26bbb
+  metadata.gz: e87d35331d8d47cc81cd1ccefe40a3a1f85c86e8
+  data.tar.gz: fefebe76847ae28a14519104628dc4c31ea13a1c
 SHA512:
-  metadata.gz: 4c28c494ec95aa339592ef7ba630149dd2d96ff83c91e3ad4b190f0cc5836ad8bd7c91b20cfe48836d7945c8e6ecbd73e80b2d467d801b53b6f827348230755b
-  data.tar.gz: fd4bbfbbc93a73a57c9a2a2e3be53f93a104282feafc80248f7f90f4ff89b45e9c92fa0df3270a99d1ed4c54bab67d0d78013c41df1113564d8e9dad8c35b6a6
+  metadata.gz: 25b035349ca9fc754232257d86bf760005ece819531f4a9c5aa3bc225ca1910e7e66da28a33a8ae9f947f02757ce667f12884ba8542d079ec27d0926f22bbba6
+  data.tar.gz: 82a46e6dc6b53ed2505bc994055f8dd2e3aa5f699a050ed760391d16ca4d3f6840026a38d3c3ad74268e9384d2e3792ed5e896531cbdce5dcd2ef5096faccee8

data/.gitignore

@@ -17,5 +17,5 @@ test/version_tmp
 tmp
 
 # Custom ignore files
-TODOs.md
-output.tar.gz
+.ruby-version
+

data/CHANGELOGS.md

@@ -0,0 +1,41 @@
+### Changelogs
+
+#### 0.1.0
+
+- Use [Semantic Versioning][] from this point.
+- Improve README.md
+- Add link to 'code_climate' and 'gemnasium'
+- Fix style with rubocop
+- Update gemspec file
+
+#### 0.0.8
+
+- Move '--theme' option out as it is not a shared option
+
+#### 0.0.7
+
+- Remove the `default_options` from `base_option.rb`
+
+- Update the description for `base_option.rb`
+
+#### 0.0.6
+
+- Fix the `-f` options description
+
+#### 0.0.5
+
+- Correct the short option for '--exc-words'
+
+- Show list of apis for default usage
+
+#### 0.0.3 - 0.0.4
+
+- Add more functions
+
+- Code refactoring and cleanup
+
+#### 0.0.2
+
+- First initial release
+
+[Semantec Versioning]: http://semver.org

data/README.md

@@ -1,11 +1,16 @@
 ## agile_utils
 
-[![Gem Version](https://badge.fury.io/rb/agile_utils.svg)](http://badge.fury.io/rb/agile_utils)
-[![Dependency Status](https://gemnasium.com/agilecreativity/agile_utils.png)](https://gemnasium.com/agilecreativity/agile_utils)
-[![Code Climate](https://codeclimate.com/github/agilecreativity/agile_utils.png)](https://codeclimate.com/github/agilecreativity/agile_utils)
+[![Gem Version](https://badge.fury.io/rb/agile_utils.svg)][gem]
+[![Dependency Status](https://gemnasium.com/agilecreativity/agile_utils.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/agilecreativity/agile_utils.png)][codeclimate]
 
-My collection of ruby library that I have used in more than one project.
-To promote the code re-use I move them all to this gem.
+[gem]: http://badge.fury.io/rb/agile_utils
+[gemnasium]: https://gemnasium.com/agilecreativity/agile_utils
+[codeclimate]: https://codeclimate.com/github/agilecreativity/agile_utils
+
+My collection of ruby libraries that I have used in more than one projects.
+To promote the code re-use I move them all to this gem. Most of them are from a
+well known gems, but some are written from scratch.
 I hope you will find some of them useful for your interesting project.
 
 ### Installation
@@ -37,49 +42,12 @@ AgileUtils::Helper.make_list
 AgileUtils::Helper.shell
 AgileUtils::Helper.time
 AgileUtils::Helper.uname
-
-AgileUtils::FileUtil.find()
-AgileUtils::FileUtils.delete()
-AgileUtils::FileUtils.gunzip()
-AgileUtils::FileUtils.tar_gzip_files()
+AgileUtils::FileUtil.find
+AgileUtils::FileUtils.delete
+AgileUtils::FileUtils.gunzip
+AgileUtils::FileUtils.tar_gzip_files
 ```
 
-### Changelogs
-
-#### 0.0.9
-
-- Update minitest to latest version
-
-#### 0.0.8
-
-- Move '--theme' option out as it is not a shared option
-
-#### 0.0.7
-
-- Remove the `default_options` from `base_option.rb`
-
-- Update the description for `base_option.rb`
-
-#### 0.0.6
-
-- Fix the `-f` options description
-
-#### 0.0.5
-
-- Correct the short option for '--exc-words'
-
-- Show list of apis for default usage
-
-#### 0.0.3 - 0.0.4
-
-- Add more functions
-
-- Code refactoring and cleanup
-
-#### 0.0.2
-
-- First initial release
-
 ### Contributing
 
 1. Fork it ( http://github.com/agilecreativity/agile_utils/fork )

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 project_name = 'agile_utils'
 
@@ -9,7 +9,7 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
+task default: :test
 
 task :pry do
   require 'pry'

data/agile_utils.gemspec

@@ -2,25 +2,29 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'agile_utils/version'
-
 Gem::Specification.new do |spec|
   spec.name          = 'agile_utils'
   spec.version       = AgileUtils::VERSION
   spec.authors       = ['Burin Choomnuan']
   spec.email         = ['agilecreativity@gmail.com']
-  spec.summary       = %q{Collection of my library that can be re-used across project}
-  spec.description   = %q{My collection of library that I have used that can be shared across multiple project.}
+  spec.summary       = %q(Collection of my ruby library that can be re-used across projects)
+  spec.description   = %q(My collection of library that I have used that can be shared across multiple projects)
   spec.homepage      = 'https://github.com/agilecreativity/agile_utils'
   spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = Dir.glob('{bin,lib}/**/*') + %w(Gemfile
+                                                       Rakefile
+                                                       agile_utils.gemspec
+                                                       README.md
+                                                       CHANGELOGS.md
+                                                       LICENSE
+                                                       .rubocop.yml
+                                                       .gitignore
+                                                       rubocop-todo.yml)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = Dir.glob('{test}/**/*')
   spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'thor', '~> 0.18'
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
   spec.add_runtime_dependency 'minitar', '~> 0.5.4'
-
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.1'
   spec.add_development_dependency 'awesome_print', '~> 1.2'
@@ -32,5 +36,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'gem-ctags', '~> 1.0'
   spec.add_development_dependency 'yard', '~> 0.8'
   spec.add_development_dependency 'rubocop', '~> 0.20'
-
 end

data/lib/agile_utils/base_option.rb

@@ -1,8 +1,6 @@
-# General library that can be re-use by multiple projects.
 module AgileUtils
   # Store the options that will be shared by many CLI classes
   module Options
-
     BASE_DIR = [
       :base_dir,
       { type: :string,
@@ -66,6 +64,5 @@ module AgileUtils
         desc: 'Display version information',
         default: false }
     ]
-
   end
 end

data/lib/agile_utils/cli.rb

@@ -12,7 +12,7 @@ module AgileUtils
       execute(opts)
     end
 
-    desc "usage", "Display help screen"
+    desc 'usage', 'Display help screen'
     def usage
       puts <<-EOS
 # List of available APIs
@@ -43,6 +43,5 @@ AgileUtils::FileUtils.tar_gzip_files()
     def execute(options = {})
       puts "FYI: execute with options: #{options}"
     end
-
   end
 end

data/lib/agile_utils/core_ext/hash/hash.rb

@@ -1,5 +1,4 @@
 class Hash
-
   # File activesupport/lib/active_support/core_ext/hash/keys.rb
   #
   # hash = { name: 'Rob', age: '28' }
@@ -25,12 +24,12 @@ class Hash
   # hash.symbolize_keys
   # => { name: "Rob", age: "28" }
   def symbolize_keys
-    transform_keys{ |key| key.to_sym rescue key }
+    transform_keys { |key| key.to_sym rescue key }
   end
 
   # File activesupport/lib/active_support/core_ext/hash/keys.rb, line 135
   def symbolize_keys!
-    transform_keys!{ |key| key.to_sym rescue key }
+    transform_keys! { |key| key.to_sym rescue key }
   end
 
   # Merges the caller into +other_hash+. For example,
@@ -50,7 +49,6 @@ class Hash
   # Destructive +reverse_merge+.
   def reverse_merge!(other_hash)
     # right wins if there is no left
-    merge!(other_hash) { |key,left,right| left }
+    merge!(other_hash) { |key, left, right| left }
   end
-
 end

data/lib/agile_utils/file_util.rb

@@ -9,7 +9,6 @@ module AgileUtils
   include Archive::Tar::Minitar
 
   module FileUtil
-
     class << self
       # @todo use me when you have to!
       CustomError = Class.new(StandardError)

data/lib/agile_utils/helper.rb

@@ -1,10 +1,8 @@
 require 'open3'
 require 'stringio'
-
 module AgileUtils
   module Helper
     class << self
-
       # Wrapper function to call the 'popen3' and return the result
       #
       # @param [Array<String>] commands list of command
@@ -41,7 +39,7 @@ module AgileUtils
       def string_to_hash(input)
         hash = {}
         input.split('\n').each do |i|
-          #TODO: code smell?
+          # TODO: code smell?
           item = i.split(':') if is_linux?
           item = i.split('=') if is_osx?
           next if item.empty? || item.size != 2
@@ -89,8 +87,8 @@ module AgileUtils
       # @return [Array<String>] the list of options for use with Thor
       def make_list(options)
         list = []
-        to_switches(options).split(" ").each do |a|
-          list << a.gsub('"', "")
+        to_switches(options).split(' ').each do |a|
+          list << a.gsub('"', '')
         end
         list
       end
@@ -112,7 +110,7 @@ module AgileUtils
             return exe if File.executable? exe
           end
         end
-        return nil
+        nil
       end
 
       private
@@ -130,11 +128,11 @@ module AgileUtils
           when Hash
             "--#{key} #{value.map { |k, v| "#{k}:#{v}" }.join(' ')}" unless value.empty?
           when nil, false
-            ""
+            ''
           else
             "--#{key} #{value.inspect}"
           end
-        end.join(" ")
+        end.join(' ')
       end
     end
   end

data/lib/agile_utils/version.rb

@@ -1,3 +1,3 @@
 module AgileUtils
-  VERSION = "0.0.9"
+  VERSION = '0.1.0'
 end

data/rubocop-todo.yml

@@ -1,10 +1,14 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-04-23 16:41:01 +1000 using RuboCop version 0.19.1.
+# on 2014-05-12 17:20:22 +1000 using RuboCop version 0.21.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+CyclomaticComplexity:
+  Max: 7
+
 # Offense count: 2
 # Cop supports --auto-correct.
 DeprecatedClassMethods:
@@ -14,38 +18,40 @@ DeprecatedClassMethods:
 Documentation:
   Enabled: false
 
-# Offense count: 6
+# Offense count: 7
 # Cop supports --auto-correct.
 EmptyLinesAroundBody:
-  Enabled: false
+  Enabled: true
 
-# Offense count: 1
+# Offense count: 4
 Eval:
   Enabled: false
 
-# Offense count: 2
-# Configuration parameters: Exclude.
-FileName:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
-IndentationConsistency:
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+HashSyntax:
   Enabled: true
 
 # Offense count: 2
 # Cop supports --auto-correct.
 LeadingCommentSpace:
-  Enabled: false
+  Enabled: true
 
-# Offense count: 5
+# Offense count: 10
 LineLength:
-  Max: 89
+  Max: 112
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: CountComments.
 MethodLength:
-  Max: 12
+  Max: 15
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+PercentLiteralDelimiters:
+  Enabled: true
 
 # Offense count: 2
 # Configuration parameters: NamePrefixBlacklist.
@@ -53,10 +59,17 @@ PredicateName:
   Enabled: false
 
 # Offense count: 1
-RedundantBegin:
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+RedundantReturn:
   Enabled: true
 
+# Offense count: 2
+RegexpLiteral:
+  MaxSlashes: 0
+
 # Offense count: 1
+# Cop supports --auto-correct.
 RescueException:
   Enabled: false
 
@@ -67,26 +80,20 @@ RescueModifier:
 # Offense count: 2
 # Cop supports --auto-correct.
 SpaceAfterComma:
-  Enabled: false
+  Enabled: true
 
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 SpaceBeforeBlockBraces:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-SpaceInsideBlockBraces:
   Enabled: true
 
-# Offense count: 16
+# Offense count: 17
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 StringLiterals:
-  Enabled: false
+  Enabled: true
 
 # Offense count: 2
-UselessAssignment:
-  Enabled: true
+UnusedBlockArgument:
+  Enabled: false

data/test/lib/agile_utils/test_file_util.rb

@@ -5,18 +5,18 @@ describe AgileUtils do
 
   context '#tar_gzip_files' do
     before do
-      FileUtils.rm_rf("test/fixtures/output.tar.gz")
-      @files = AgileUtils::FileUtil.find("test/fixtures/outputs", 'xhtml')
+      FileUtils.rm_rf('test/fixtures/output.tar.gz')
+      @files = AgileUtils::FileUtil.find('test/fixtures/outputs', 'xhtml')
     end
 
     after do
-      FileUtils.rm_rf("test/fixtures/output.tar.gz")
+      FileUtils.rm_rf('test/fixtures/output.tar.gz')
     end
 
     it 'compresses list of files' do
-      refute File.exists?("test/fixtures/output.tar.gz"), "Output file must not exist"
-      AgileUtils::FileUtil.tar_gzip_files(@files, "test/fixtures/output.tar.gz")
-      assert File.exists?("test/fixtures/output.tar.gz"), "Output file must be generated"
+      refute File.exists?('test/fixtures/output.tar.gz'), 'Output file must not exist'
+      AgileUtils::FileUtil.tar_gzip_files(@files, 'test/fixtures/output.tar.gz')
+      assert File.exists?('test/fixtures/output.tar.gz'), 'Output file must be generated'
     end
   end
 end

data/test/lib/agile_utils/test_helper.rb

@@ -2,25 +2,14 @@ require_relative '../../test_helper'
 describe AgileUtils::Helper do
   context '#shell' do
     it 'returns result for valid command' do
+      # TODO: very system specific, please mock/stub this out!
+      # or use something like FakeFS?
       result = AgileUtils::Helper.shell(%w(ls))
       result.wont_be_nil
     end
+
     it 'raises error on invalid command' do
       assert_raises(RuntimeError) { AgileUtils::Helper.shell(%w(bad-command)) }
     end
   end
-
-  context '#which' do
-    it 'works with valid executable' do
-      # TODO: mock or stub the call
-      AgileUtils::Helper.which('ruby').wont_be_nil
-    end
-    it 'works with invalid executable' do
-      AgileUtils::Helper.which('bad-or-invalid-executable!').must_be_nil
-    end
-    it 'works with the binary name only' do
-      # TODO: mock or stub the call
-      AgileUtils::Helper.which('/bin/bash').must_be_nil
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agile_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.20'
 description: My collection of library that I have used that can be shared across multiple
-  project.
+  projects
 email:
 - agilecreativity@gmail.com
 executables:
@@ -203,11 +203,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
+- CHANGELOGS.md
 - Gemfile
-- Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - agile_utils.gemspec
@@ -253,13 +251,13 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Collection of my library that can be re-used across project
+summary: Collection of my ruby library that can be re-used across projects
 test_files:
-- test/fixtures/inputs/demo1.xxx.rb
-- test/fixtures/inputs/demo2.xxx.rb
-- test/fixtures/outputs/demo1.xhtml
-- test/fixtures/outputs/demo2.xhtml
-- test/lib/agile_utils/test_file_util.rb
 - test/lib/agile_utils/test_helper.rb
+- test/lib/agile_utils/test_file_util.rb
 - test/test_helper.rb
+- test/fixtures/outputs/demo1.xhtml
+- test/fixtures/outputs/demo2.xhtml
+- test/fixtures/inputs/demo2.xxx.rb
+- test/fixtures/inputs/demo1.xxx.rb
 has_rdoc: 

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-    - 1.9.3
-    - 2.0.0
-    - 2.1.1

data/.yardopts

@@ -1,2 +0,0 @@
-# see: http://rubydoc.info/gems/yard/file/README.md
---no-private --protected lib/**/*.rb - README.md LICENSE.txt

data/Guardfile

@@ -1,15 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-guard 'minitest' do
-
-  # with Minitest::Unit
-  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
-  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r|^test/test_helper\.rb|)    { "test" }
-
-  # with Minitest::Spec
-  # watch(%r|^spec/(.*)_spec\.rb|)
-  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
-
-end