agile_utils 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c144b001bf9c9544bcae669d12f2fdbaf7da43d6
-  data.tar.gz: 95f42c351ccda135f8ee51c2b8c3f7ea118a22db
+  metadata.gz: f859098d2725f7d1a7e5266f444962509b4628cf
+  data.tar.gz: 60b292342f8eab2409285a9c27d5bfbb7c7be1c4
 SHA512:
-  metadata.gz: 78a6d98c3941bfe41c1081486e0a3706e95b5295ff79960535f85008e7723e3f19c66a7c2a6537f306633c457d0b0933db2e14368869f1ef85f727f3b21cb83e
-  data.tar.gz: 4eed7fb17a589e4e6ed412a50bb448b44ef819425f1167ae70a6fcfc139ac1d3b174ea89f7e74a2e245f900484ddd04c7a1c6bbe25f37173dddbb37be8d8a053
+  metadata.gz: d309c40b193b8b47a57bcd6867215f21ce3b31855269dbf7f807b0c34bb3d6144435f862fd5dac6b366717f4ee3382bd2f6464c7fd311babf8263e438b70c0eb
+  data.tar.gz: 4e1b069c620904bac94df517aa89ae54fa4c46c5e43826b32c176b8c33201dde57556b984b60a52ab6aef8b1bedd85b265fec32682c850f262827681a3007aea

data/.rubocop.yml

@@ -51,7 +51,7 @@ HashSyntax:
 
 # No spaces inside hash literals
 SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
+  EnforcedStyle: space
 
 # Allow dots at the end of lines
 DotPosition:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### 0.1.3
+
+- Improve the code detection for OS type
+- Remove unused method
+- Update style for rubocop
+
 #### 0.1.2
 
 - Style cleanup with rubocop

data/README.md

@@ -39,8 +39,8 @@ include AgileUtils
 
 # Then call the right method to use.
 AgileUtils::Helper.capture
-AgileUtils::Helper.is_linux?
-AgileUtils::Helper.is_osx?
+AgileUtils::Helper.linux?
+AgileUtils::Helper.osx?
 AgileUtils::Helper.make_list
 AgileUtils::Helper.shell
 AgileUtils::Helper.time

data/bin/agile_utils

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 # Add the code for binary if we need one
 require_relative "../lib/agile_utils"
-puts "Welcome to #{AgileUtils::PROJECT_NAME} version #{AgileUtils::VERSION}"
 include AgileUtils
 if ARGV.empty?
   AgileUtils::CLI.start(%w[usage])

data/lib/agile_utils.rb

@@ -1,6 +1,5 @@
 require_relative "./agile_utils/core_ext/hash/hash"
 require_relative "./agile_utils/core_ext/kernel/reporting"
-require_relative "./agile_utils/constant"
 require_relative "./agile_utils/version"
 require_relative "./agile_utils/logger"
 require_relative "./agile_utils/cli"

data/lib/agile_utils/base_option.rb

@@ -2,66 +2,68 @@ module AgileUtils
   module Options
     BASE_DIR = [
       :base_dir,
-      {type: :string,
-       aliases: "-b",
-       desc: "Base directory",
-       default: Dir.pwd}
+      { type:    :string,
+        aliases: "-b",
+        desc:    "Base directory",
+        default: Dir.pwd
+       }
     ]
 
     EXTS = [
       :exts,
-      {type: :array,
-       aliases: "-e",
-       desc: "List of extensions to search for",
-       default: []}
+      { type: :array,
+        aliases: "-e",
+        desc: "List of extensions to search for",
+        default: []
+      }
     ]
 
     NON_EXTS = [
       :non_exts,
-      {type: :array,
-       aliases: "-f",
-       desc: "List of files without extension to search for",
-       default: []}
+      { type: :array,
+        aliases: "-f",
+        desc: "List of files without extension to search for",
+        default: [] }
     ]
 
     INC_WORDS = [
       :inc_words,
-      {type: :array,
-       aliases: "-n",
-       desc: "List of words to be included in the result if any",
-       default: []}
+      { type: :array,
+        aliases: "-n",
+        desc: "List of words in the filename to be included with the result if any",
+        default: [] }
     ]
 
     EXC_WORDS = [
       :exc_words,
-      {type: :array,
-       aliases: "-x",
-       desc: "List of words to be excluded from the result if any",
-       default: []}
+      { type: :array,
+        aliases: "-x",
+        desc: "List of words in the filename to be excluded from the result if any",
+        default: [] }
     ]
 
     IGNORE_CASE = [
       :ignore_case,
-      {type: :boolean,
-       aliases: "-i",
-       desc: "Match case insensitively",
-       default: true}
+      { type: :boolean,
+        aliases: "-i",
+        desc: "Ignore the case in the input filename",
+        default: true }
     ]
 
     RECURSIVE = [
       :recursive,
-      {type: :boolean,
-       aliases: "-r",
-       desc: "Search for files recursively",
-       default: true}
+      { type: :boolean,
+        aliases: "-r",
+        desc: "Search for files recursively",
+        default: true }
     ]
 
     VERSION = [
       :version,
-      {type: :boolean,
-       aliases: "-v",
-       desc: "Display version information",
-       default: false}
+      { type: :boolean,
+        aliases: "-v",
+        desc: "Display version information",
+        default: false }
     ]
   end
 end

data/lib/agile_utils/cli.rb

@@ -6,7 +6,7 @@ module AgileUtils
     def main
       opts = options.symbolize_keys
       if opts[:version]
-        puts "You are using #{AgileUtils::PROJECT_NAME} version #{AgileUtils::VERSION}"
+        puts "You are using AgileUtils version #{AgileUtils::VERSION}"
         exit
       end
     end
@@ -19,14 +19,12 @@ include AgileUtils
 
 # General methods
 AgileUtils::Helper.capture
-AgileUtils::Helper.is_linux?
-AgileUtils::Helper.is_osx?
 AgileUtils::Helper.make_list
 AgileUtils::Helper.shell
+AgileUtils::Helper.linux?
+AgileUtils::Helper.osx?
 AgileUtils::Helper.time
 AgileUtils::Helper.uname
-
-# File and related methods
 AgileUtils::FileUtil.find()
 AgileUtils::FileUtils.delete()
 AgileUtils::FileUtils.gunzip()

data/lib/agile_utils/file_util.rb

@@ -15,6 +15,7 @@ module AgileUtils
       # @param [String] extension the file extension to search for
       #
       # @return [Array<String>] list of matching files or empty list
+      # rubocop:disable CollectionMethods
       def find(base_dir, extension = "xhtml")
         file_paths = []
         Find.find(base_dir) do |path|
@@ -22,6 +23,7 @@ module AgileUtils
         end
         file_paths
       end
+      # rubocop:enable All
 
       # Tar and gzip list of files
       #
@@ -35,7 +37,6 @@ module AgileUtils
           Archive::Tar::Minitar.pack_file(file, tar)
         end
       ensure
-        # Closes both tar and sgz.
         tar.close unless tar.nil?
         tar = nil
       end
@@ -53,23 +54,12 @@ module AgileUtils
       # 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)
         files.each do |file|
           FileUtils.rm_rf(file)
         end
       end
 
-      # Add suffix to each extensions
-      #
-      # @param [Array<String>] extensions list of extension
-      # @param [String] suffix the suffix string
-      #
-      # @return [Array<String>] new list with the suffix added to each element
-      def add_suffix(extensions = [], suffix)
-        extensions.map { |e| "#{e}.#{suffix}" }
-      end
-
       # Time the operation before and after the operation for tuning purpose
       def time
         beg_time = Time.now

data/lib/agile_utils/helper.rb

@@ -5,8 +5,9 @@ module AgileUtils
     class << self
       # Wrapper function to call the 'popen3' and return the result
       #
-      # @param [Array<String>] commands list of command
+      # @param [Array<String>] commands list of command and arguments to be executed
       # @return [String] result of the command as the string
+      # @raise [RuntimeError] an exception to raise when the command result in error
       def shell(commands = [])
         begin
           command = commands.join(" ")
@@ -17,47 +18,19 @@ module AgileUtils
         stdin
       end
 
-      def is_osx?
-        uname && uname.strip.downcase == "darwin"
+      def osx?
+        RbConfig::CONFIG["host_os"] =~ /darwin/
       end
 
-      def is_linux?
-        uname && uname.strip.downcase == "linux"
+      def linux?
+        RbConfig::CONFIG["host_os"] =~ /linux/
       end
 
+      # Wrap the call to `uname` command
       def uname
         shell(%w[uname])
       end
 
-      # Extract "key1: value1\nkey2: value 2" to
-      # hash of { "key1" => "value1", "key2" => "value 2" }
-      #
-      # @param [String] input the input string from the unix command
-      # @return [Hash<Symbol,String>] result hash extracted from the command
-      # @todo re-implement the code and look for specific list of keys and quit
-      #       as fast as we get the specific list of keys
-      def string_to_hash(input)
-        hash = {}
-        input.split('\n').each do |i|
-          # TODO: code smell?
-          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
-        hash
-      end
-
-      # Add suffix to each item in the list
-      #
-      # @param [Array<String>] list the input list
-      # @param [String] suffix the suffix string
-      # @return [Array<String.] list of input where each element is append with
-      #  suffix string
-      def add_suffix(list = [], suffix)
-        list.map { |e| "#{e}.#{suffix}" }
-      end
-
       # For tuning the operation
       def time
         beg_time = Time.now
@@ -95,7 +68,7 @@ module AgileUtils
 
       # Cross-platform way of finding an executable in the $PATH.
       #
-      # @param command [String] the command to look up
+      # @param [String] command 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:

data/lib/agile_utils/version.rb

@@ -1,3 +1,3 @@
 module AgileUtils
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agile_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor