agile_utils 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5de88d08a9fd5dd56b5f5d298f31dabde3d1b3e5
-  data.tar.gz: ca2dd47e768dd91e83d764c9184472c0595bcd7b
+  metadata.gz: fb264c2409c9d987dc4047e74a706b8af6fd51de
+  data.tar.gz: 45aa72279caed54a4e090d80ba97267946f7650c
 SHA512:
-  metadata.gz: 6579bd5fb55b4bdb34ab47ed1ed3314869c127c9e0841c6b9f3f580cc1838c06145ca3fe044e0d8963dd7c7b8ff32977410646bb0f9ef3251bcc63fd1be4f74c
-  data.tar.gz: 27ee5bc58fb421785aae755b382f6508a9457f10bc306dbf2a90b18d07124e32df761c530889d8d1230b7bf9fa6ce52a0161cd94dfaa5efbdb2d23f88e0d4804
+  metadata.gz: 03b74a8421a3ca5ba677e1d90ad5b0f9ee50f5416cf57c7446b0bad2c9f45ea2f38334b69de8fcd03b838a41aaa66ac006c0570b85cdf44d4a0f86d3f5e0d5bb
+  data.tar.gz: 0280f0d4a578fae6e76d7ba0b1c81c978a4d1d31b5143f49bbc8bbdab2616cda0feaddca283565b7849b548a3c28d2d01fa09b6ade7add51ade7cc553d1e3259

data/.rubocop.yml

@@ -0,0 +1,3 @@
+# This is the configuration used to check the rubocop source code.
+
+inherit_from: rubocop-todo.yml

data/README.md

@@ -2,10 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/agile_utils.svg)](http://badge.fury.io/rb/agile_utils)
 
-My collection of ruby library that I have implemented and plan to use them in more
-than one project. To promote the code re-use I move them all to this gem
-DRY (Don't repeat yourself). I hope you will find some of them useful for you
-interesting project.
+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.
+I hope you will find some of them useful for your interesting project.
 
 ### Installation
 
@@ -23,36 +22,32 @@ Or install it yourself as:
 
 ### Usage
 
-#### Use as CLI
-
-As this gem is intended to be used as a library in other application.
-I plan to show the available command/api when the command is executed.
-
-```sh
-# to show list of all available api
-agile_utils
-```
-
-#### Use as standard ruby library
-
-This is how the gem supposed to be used.
-
 ```rb
 # Require and include the library in your code
 require 'agile_utils'
 include AgileUtils
 
-# call appropriate methods you like to use
+# Then call the right method to use.
+AgileUtils::Helper.capture
+AgileUtils::Helper.is_linux?
+AgileUtils::Helper.is_osx?
+AgileUtils::Helper.make_list
+AgileUtils::Helper.shell
+AgileUtils::Helper.time
+AgileUtils::Helper.uname
+
 AgileUtils::FileUtil.find()
-AgileUtils::FileUtils.tar_gzip_files()
 AgileUtils::FileUtils.delete()
+AgileUtils::FileUtils.gunzip()
+AgileUtils::FileUtils.tar_gzip_files()
 ```
 
-### Limitation/Known Issues
+### Changelogs
 
- - Will be listed here if any
+#### 0.0.3 - 0.0.4
 
-### Changelogs
+- Add more functions
+- Code refactoring and cleanup
 
 #### 0.0.2
 

data/Rakefile

@@ -19,3 +19,13 @@ task :pry do
   ARGV.clear
   Pry.start
 end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on the lib directory'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['files']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/agile_utils.gemspec

@@ -4,32 +4,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'agile_utils/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "agile_utils"
+  spec.name          = 'agile_utils'
   spec.version       = AgileUtils::VERSION
-  spec.authors       = ["Burin Choomnuan"]
-  spec.email         = ["agilecreativity@gmail.com"]
+  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.homepage      = "https://github.com/agilecreativity/agile_utils"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/agilecreativity/agile_utils'
+  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.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "thor", "~> 0.18"
-  spec.add_runtime_dependency "minitar", "~> 0.5.4"
+  spec.add_runtime_dependency 'thor', '~> 0.18'
+  spec.add_runtime_dependency 'minitar', '~> 0.5.4'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "awesome_print", "~> 1.2"
-  spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
-  spec.add_development_dependency "guard-minitest", "~> 2.2"
-  spec.add_development_dependency "minitest", "~> 4.2"
-  spec.add_development_dependency "guard", "~> 2.6"
-  spec.add_development_dependency "pry", "~> 0.9"
-  spec.add_development_dependency "gem-ctags", "~> 1.0"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'awesome_print', '~> 1.2'
+  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
+  spec.add_development_dependency 'guard-minitest', '~> 2.2'
+  spec.add_development_dependency 'minitest', '~> 4.2'
+  spec.add_development_dependency 'guard', '~> 2.6'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  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

@@ -0,0 +1,99 @@
+# 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
+    # Common options {{{
+    BASE_DIR = [
+      :base_dir,
+      { type: :string,
+        aliases: '-b',
+        desc: 'Base directory',
+        default: Dir.pwd }
+    ]
+
+    EXTS = [
+      :exts,
+      { type: :array,
+        aliases: '-e',
+        desc: 'List of extensions to search for',
+        default: [] }
+    ]
+
+    NON_EXTS = [
+      :non_exts,
+      { type: :array,
+        aliases: '-f',
+        desc: 'List of extensions to search for',
+        default: [] }
+    ]
+
+    INC_WORDS = [
+      :inc_words,
+      { type: :array,
+        aliases: '-n',
+        desc: 'List of words to be included in the result',
+        default: [] }
+    ]
+
+    EXC_WORDS = [
+      :exc_words,
+      { type: :array,
+        aliases: '-n',
+        desc: 'List of words to be included in the result',
+        default: [] }
+    ]
+
+    IGNORE_CASE = [
+      :ignore_case,
+      { type: :boolean,
+        aliases: '-i',
+        desc: 'Match case insensitively',
+        default: true }
+    ]
+
+    RECURSIVE = [
+      :recursive,
+      { type: :boolean,
+        aliases: '-r',
+        desc: 'Search for files recursively',
+        default: true }
+    ]
+
+    VERSION = [
+      :version,
+      { type: :boolean,
+        aliases: '-v',
+        desc: 'Display version information',
+        default: false }
+    ]
+    # }}}
+
+    # Options related to 'VimPrinter' only {{{
+    THEME = [
+      :theme,
+      { type: :string,
+        aliases: '-t',
+        desc: 'Vim colorscheme to use',
+        default: 'default' }
+    ]
+    # }}}
+
+    # The default options text from the above options
+    def default_usage
+      <<-EOT
+Options:
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # Default: . (current directory)
+  -e, [--exts=one two three]               # List of extensions to search for
+  -f, [--non-exts=one two three]           # List of extensions to search for
+  -n, [--inc-words=one two three]          # List of words to be included in the result
+  -x, [--exc-words=one two three]          # List of words to be excluded from the result
+  -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
+                                           # Default: true
+  -r, [--recursive], [--no-recursive]      # Search for files recursively
+                                           # Default: true
+  -v, [--version], [--no-version]          # Display version information
+      EOT
+    end
+  end
+end

data/lib/agile_utils/cli.rb

@@ -3,26 +3,17 @@ require_relative '../agile_utils'
 module AgileUtils
   class CLI < Thor
     desc 'main', 'Main entry point'
-    # method_option :commit,
-    #               aliases: "-c",
-    #               desc: "commit your changes",
-    #               default: false
     def main
       opts = options.symbolize_keys
-
       if opts[:version]
         puts "You are using #{AgileUtils::PROJECT_NAME} version #{AgileUtils::VERSION}"
         exit
       end
-
-      puts "FYI: your options #{opts}"
       execute(opts)
     end
 
     desc "usage", "Display help screen"
     def usage
-      # Add your usage here (How to automate this task from Vim?)
-      # try running :r !./bin/agile_utils help run
       puts <<-EOS
       Add your usage here.
       EOS
@@ -34,7 +25,6 @@ module AgileUtils
 
     # @param [Hash<Symbol, Object>] options the options argument
     def execute(options = {})
-      # TODO: just a place holder for now!
       puts "FYI: execute with options: #{options}"
     end
 

data/lib/agile_utils/file_util.rb

@@ -32,26 +32,38 @@ module AgileUtils
       #
       # @param [Array<String>] files list of input files
       # @param [String] output the output file in .tar.gz format
+      # @todo rename to tar_gzip(..)
       def tar_gzip_files(files, output = 'output.tar.gz')
-        begin
-          sgz = Zlib::GzipWriter.new(File.open(output, 'wb'))
-          tar = Minitar::Output.new(sgz)
-          files.each do |file|
-            Minitar.pack_file(file, tar)
-          end
-        ensure
-          # Closes both tar and sgz.
-          tar.close unless tar.nil?
-          tar = nil
+        sgz = Zlib::GzipWriter.new(File.open(output, 'wb'))
+        tar = Archive::Tar::Minitar::Output.new(sgz)
+        files.each do |file|
+          Archive::Tar::Minitar.pack_file(file, tar)
         end
+      ensure
+        # Closes both tar and sgz.
+        tar.close unless tar.nil?
+        tar = nil
+      end
+
+      # Uncompress 'input.tar.gz' file
+      #
+      # @param [String] filename input file in the 'tar.gzip' format
+      # @param [String] output_dir the output directory
+      def gunzip(filename, output_dir)
+        input_file = File.open(filename, 'rb')
+        tgz = Zlib::GzipReader.new(input_file)
+        # Warning: tgz will be closed!
+        Archive::Tar::Minitar.unpack(tgz, output_dir)
+      # ensure
+        # input_file = nil unless input_file.nil?
       end
 
       # Delete the files from the given list
+      #
+      # @param files list of files to be deleted
+      # @todo add ! to flag it as destructive!
       def delete(files)
-        # Note: should we remove the files and be done with it?
         files.each do |file|
-          #puts "FYI: about to delete file #{file}"
-          # Note: name clash!!!
           FileUtils.rm_rf(file)
         end
       end
@@ -62,8 +74,8 @@ module AgileUtils
       # @param [String] suffix the suffix string
       #
       # @return [Array<String>] new list with the suffix added to each element
-      def add_suffix(extensions = %w(rb pdf), suffix)
-        extensions.map {|e| "#{e}.#{suffix}" }
+      def add_suffix(extensions = [], suffix)
+        extensions.map { |e| "#{e}.#{suffix}" }
       end
 
       # Time the operation before and after the operation for tuning purpose
@@ -76,13 +88,3 @@ module AgileUtils
     end
   end
 end
-
-if __FILE__ == $0
-  include AgileUtils
-  files = AgileUtils::FileUtil.find('test/fixtures/inputs', 'rb')
-  puts files
-  AgileUtils::FileUtil.tar_gzip_files files, 'test/fixtures/output.tar.gz'
-  puts "Your output is at #{File.absolute_path('test/fixtures/output.tar.gz')}"
-  puts "About to delete your file.."
-  #AgileUtils::FileUtil.delete ['test/fixtures/output.tar.gz']
-end

data/lib/agile_utils/helper.rb

@@ -1,4 +1,6 @@
 require 'open3'
+require 'stringio'
+
 module AgileUtils
   module Helper
     class << self
@@ -8,17 +10,21 @@ module AgileUtils
       # @param [Array<String>] commands list of command
       # @return [String] result of the command as the string
       def shell(commands = [])
-        stdin, stderr, status = Open3.capture3(commands.join(" "))
-        raise "Problem processing #{input_file}" unless status.success?
+        begin
+          command = commands.join(' ')
+          stdin, _stderr, _status = Open3.capture3(command)
+        rescue Exception => e
+          raise "Problem processing #{command}, #{e.message}"
+        end
         stdin
       end
 
       def is_osx?
-        uname && uname.strip.downcase == "darwin"
+        uname && uname.strip.downcase == 'darwin'
       end
 
       def is_linux?
-        uname && uname.strip.downcase == "linux"
+        uname && uname.strip.downcase == 'linux'
       end
 
       def uname
@@ -34,10 +40,10 @@ module AgileUtils
       #       as fast as we get the specific list of keys
       def string_to_hash(input)
         hash = {}
-        input.split("\n").each do |i|
+        input.split('\n').each do |i|
           #TODO: code smell?
-          item = i.split(":") if is_linux?
-          item = i.split("=") if is_osx?
+          item = i.split(':') if is_linux?
+          item = i.split('=') if is_osx?
           next if item.empty? || item.size != 2
           hash[item[0].strip] = item[1].strip
         end
@@ -62,6 +68,74 @@ module AgileUtils
         end_time - beg_time
       end
 
+      # Good for capturing output from the :stdout
+      # e.g. sample usage
+      # output = capture(:stdout) { puts "Hello" }
+      def capture(stream)
+        begin
+          stream = stream.to_s
+          eval "$#{stream} = StringIO.new"
+          yield
+          result = eval("$#{stream}").string
+        ensure
+          eval("$#{stream} = #{stream.upcase}")
+        end
+        result
+      end
+
+      # Convert the hash options to list for use with Thor
+      #
+      # @param [Hash<Objects, Object>] options the option hash
+      # @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('"', "")
+        end
+        list
+      end
+
+      # Cross-platform way of finding an executable in the $PATH.
+      #
+      # @param command [String] the command to look up
+      # @return [String, NilClass] full path to the executable file or nil if the
+      #  executable is not valid or available.
+      # Example:
+      #   which('ruby')           #=> /usr/bin/ruby
+      #   which('/usr/bin/ruby')  #=> nil
+      #   which('bad-executable') #=> nil
+      def which(command)
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{command}#{ext}")
+            return exe if File.executable? exe
+          end
+        end
+        return nil
+      end
+
+      private
+
+      # https://github.com/erikhuda/thor/blob/master/lib/thor/parser/options.rb
+      #
+      # Receives a hash and makes it switches.
+      def to_switches(options)
+        options.map do |key, value|
+          case value
+          when true
+            "--#{key}"
+          when Array
+            "--#{key} #{value.map { |v| v.inspect }.join(' ')}" unless value.empty?
+          when Hash
+            "--#{key} #{value.map { |k, v| "#{k}:#{v}" }.join(' ')}" unless value.empty?
+          when nil, false
+            ""
+          else
+            "--#{key} #{value.inspect}"
+          end
+        end.join(" ")
+      end
     end
   end
 end

data/lib/agile_utils/logger.rb

@@ -2,9 +2,9 @@ require 'logger'
 module AgileUtils
   class << self
     attr_writer :logger
-      # @return [Logger] the Logger for the project
-      def logger
-        @logger ||= Logger.new STDOUT
-      end
+    # @return [Logger] the Logger for the project
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
   end
 end

data/lib/agile_utils/version.rb

@@ -1,3 +1,3 @@
 module AgileUtils
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/agile_utils.rb

@@ -6,3 +6,4 @@ require_relative './agile_utils/logger'
 require_relative './agile_utils/cli'
 require_relative './agile_utils/helper'
 require_relative './agile_utils/file_util'
+require_relative './agile_utils/base_option'

data/rubocop-todo.yml

@@ -0,0 +1,92 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-04-23 16:41:01 +1000 using RuboCop version 0.19.1.
+# 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: 2
+# Cop supports --auto-correct.
+DeprecatedClassMethods:
+  Enabled: false
+
+# Offense count: 9
+Documentation:
+  Enabled: false
+
+# Offense count: 6
+# Cop supports --auto-correct.
+EmptyLinesAroundBody:
+  Enabled: false
+
+# Offense count: 1
+Eval:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: Exclude.
+FileName:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+IndentationConsistency:
+  Enabled: true
+
+# Offense count: 2
+# Cop supports --auto-correct.
+LeadingCommentSpace:
+  Enabled: false
+
+# Offense count: 5
+LineLength:
+  Max: 89
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 12
+
+# Offense count: 2
+# Configuration parameters: NamePrefixBlacklist.
+PredicateName:
+  Enabled: false
+
+# Offense count: 1
+RedundantBegin:
+  Enabled: true
+
+# Offense count: 1
+RescueException:
+  Enabled: false
+
+# Offense count: 2
+RescueModifier:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+SpaceAfterComma:
+  Enabled: false
+
+# 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
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+StringLiterals:
+  Enabled: false
+
+# Offense count: 2
+UselessAssignment:
+  Enabled: true

data/test/lib/agile_utils/test_helper.rb

@@ -1,8 +1,15 @@
 require_relative '../../test_helper'
 describe AgileUtils::Helper do
-  context '#simplest_test' do
-    it 'must pass the simple test' do
-      'string'.wont_be_nil
+  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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agile_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 description: My collection of library that I have used that can be shared across multiple
   project.
 email:
@@ -188,6 +202,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
@@ -198,6 +213,7 @@ files:
 - agile_utils.gemspec
 - bin/agile_utils
 - lib/agile_utils.rb
+- lib/agile_utils/base_option.rb
 - lib/agile_utils/cli.rb
 - lib/agile_utils/constant.rb
 - lib/agile_utils/core_ext/hash/hash.rb
@@ -206,6 +222,7 @@ files:
 - lib/agile_utils/helper.rb
 - lib/agile_utils/logger.rb
 - lib/agile_utils/version.rb
+- rubocop-todo.yml
 - test/fixtures/inputs/demo1.xxx.rb
 - test/fixtures/inputs/demo2.xxx.rb
 - test/fixtures/outputs/demo1.xhtml