code_lister 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bc886d3f4e601c170e30c41a311f61e37bfecac
-  data.tar.gz: e909544107643a2bf2b816edc3bf395f807bbc25
+  metadata.gz: 23c2c55f6c39b00ae60f077b1084bc9953b4f79a
+  data.tar.gz: 381925655a9501099259f6faddad7d97644fb180
 SHA512:
-  metadata.gz: 38ced4389d381c0826fefc77c3733db019f4c3a2a8a086d4602559e4f5d1de2124b9daad61c214cdf594a3d665826dafacb4612ab68ea5c34be43e7abb8255af
-  data.tar.gz: 3c2ae7129c7db2ebab95d10a40c1563041d9ed2e319f5fd0d04fc32b001352b742f54f540657e59f7d68fa5fbc963c5c3cb3c7a13564b512f23cf75fb6e2a7b7
+  metadata.gz: 0a216909fc91b708f6f400553275b24a46ab757a62c73959b337fdcba1c06709d5c51475a1d30a12561b6f92da118aff9c3cec0fc98f398288f451769f0271c4
+  data.tar.gz: c8c0b36b8c0331d7c2bf77b96306d2d803bf748e2dcb7df40a1d47f85dbf157f9d22c441fe69dfb2d442ab62bb015a86d0776526bc2144d6c6c134b0017411db

data/.rubocop.yml

@@ -52,7 +52,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,5 +1,10 @@
 ### Changelogs
 
+#### 0.1.2
+
+- Improve documentation
+- Update style for rubocop and update to rubocop 0.23.x
+
 #### 0.1.1
 
 - Simplify the CLI interface

data/README.md

@@ -40,19 +40,19 @@ Usage/Synopsis:
 
 ```
 Usage:
-  code_lister [OPTIONS]
+  code_lister
 
 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
+  -f, [--non-exts=one two three]           # List of files without extension to search for
+  -n, [--inc-words=one two three]          # List of words in the filename to be included with the result if any
+  -x, [--exc-words=one two three]          # List of words in the filename to be excluded from the result if any
+  -i, [--ignore-case], [--no-ignore-case]  # Ignore the case in the input filename
+                                           # Default: --ignore-case
   -r, [--recursive], [--no-recursive]      # Search for files recursively
-                                           # Default: true
+                                           # Default: --recursive
   -v, [--version], [--no-version]          # Display version information
 
 List files by extensions, patterns, and simple criteria

data/Rakefile

@@ -1,11 +1,9 @@
 require "bundler/gem_tasks"
 Bundler::GemHelper.install_tasks
-
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
-
 task :pry do
   require "pry"
   require "awesome_print"
@@ -14,3 +12,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/code_lister.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "awesome_print", "~> 1.2"
   spec.add_development_dependency "pry", "~> 0.9"
   spec.add_development_dependency "fuubar", "~> 1.3"
-  spec.add_development_dependency "rubocop", "~> 0.20"
+  spec.add_development_dependency "rubocop", "~> 0.23"
 end

data/lib/code_lister/cli.rb

@@ -33,13 +33,13 @@ 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
+  -f, [--non-exts=one two three]           # List of files without extension to search for
+  -n, [--inc-words=one two three]          # List of words in the filename to be included with the result if any
+  -x, [--exc-words=one two three]          # List of words in the filename to be excluded from the result if any
+  -i, [--ignore-case], [--no-ignore-case]  # Ignore the case in the input filename
+                                           # Default: --ignore_case
   -r, [--recursive], [--no-recursive]      # Search for files recursively
-                                           # Default: true
+                                           # Default: --recursive
   -v, [--version], [--no-version]          # Display version information
 
 List files by extensions, patterns, and simple criteria
@@ -50,3 +50,8 @@ List files by extensions, patterns, and simple criteria
     default_task :usage
   end
 end
+
+if __FILE__ == $PROGRAM_NAME
+  require_relative "../code_lister"
+  CodeLister::CLI.start(ARGV)
+end

data/lib/code_lister/code_lister.rb

@@ -1,18 +1,24 @@
 module CodeLister
   CustomError = Class.new(StandardError)
   class << self
-    # List files base on some extension
+    # List files base on multiple simple criteria
+    #
+    # @param [Hash<Symbol>,<Object>] args argument hash
+    # @option args [String]         :base_dir the starting directory
+    # @option args [Boolean]        :recursive flag to indicate if the search will be done recursively
+    # @option args [Array<String>]  :exts list of file extension to search for (without the dot)
+    # @option args [Array<String>]  :non_exts list of file without any extension to search for
+    # @return [Array<String>] the list of file based on the matching criteria
     def files(args = {})
       opts = {
-        base_dir: Dir.pwd,
+        base_dir:  Dir.pwd,
         recursive: false,
-        exts: [],
-        non_exts: []
+        exts:      [],
+        non_exts:  []
       }.merge(args)
 
       # always expand the path
       base_dir = File.expand_path(opts[:base_dir])
-      # base_dir = opts[:base_dir]
       fail CustomError, "The directory #{base_dir} is not valid or or not readable!" unless File.exist?(base_dir)
 
       wildcard = opts[:recursive] ? "**" : ""
@@ -28,7 +34,14 @@ module CodeLister
       (files_with_extension + files_without_extension).sort
     end
 
-    # Filter out the list based on given list of words
+    # Filter out the list based on simple criteria
+    #
+    # @param [Array<String>] file_list the input file list
+    # @param [Hash<Symbol, Object>] args the option hash
+    # @option args [Array<String>]  :inc_words list of words that must be match to be included in the result
+    # @option args [Array<String>]  :exc_words list of words that will be excluded fromt the result
+    # @option args [Boolean]        :ignore_case flag to indicate how the string comparision should be performed
+    # @return [Array<String>] the original list with the result filtered
     def filter(file_list, args = {})
       opts = {
         inc_words: [],

data/lib/code_lister/main.rb

@@ -3,13 +3,9 @@ module CodeLister
     class << self
       def run(options = {})
         args = default_options.merge(options)
-
         files = CodeLister.files(args)
-
-        # Now filter out the list if any
         inc_words = args.fetch(:inc_words, [])
         exc_words = args.fetch(:exc_words, [])
-
         files = CodeLister.filter(files, inc_words: inc_words,
                                          exc_words: exc_words)
         puts files
@@ -19,13 +15,13 @@ module CodeLister
     private
 
       def default_options
-        {base_dir: Dir.pwd,
-         recursive: true,
-         ignore_case: true,
-         inc_words: [],
-         exc_words: [],
-         exts: [],
-         non_exts: []}
+        { base_dir:    Dir.pwd,
+          recursive:   true,
+          ignore_case: true,
+          inc_words:   [],
+          exc_words:   [],
+          exts:        [],
+          non_exts:    [] }
       end
     end
   end

data/lib/code_lister/version.rb

@@ -1,3 +1,3 @@
 module CodeLister
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_lister
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-17 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.23'
 description: List/filter files similar to 'find then grep' command in Linux/Unix based
   system
 email: