code_lister 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bdff7bff041d0b4d759f83eee1c841b8df72a83
-  data.tar.gz: 6c49de38ba9129b15adb68941f220e604faccf17
+  metadata.gz: ab05b837c5a1c82a86f45b2a732e1c94b5aa9f4c
+  data.tar.gz: 7c511a1e1297223d9f96671045be7da41449e8d9
 SHA512:
-  metadata.gz: 2e72b7065dfa0be584d26b8e72a424519508e41bbc937e8a20ee8dd0641e4a1af175da7131a17430fdb1935e02156da3380428f71279ed3ab22e535ebd092a6b
-  data.tar.gz: 186354e7fac1115b89bc0ab54c316b8639054ab40b2b138f101ad0e670f2c17c70cb82e51664181fd34705bca3392ea5dcb119255b38228d08f9ac468ab5172a
+  metadata.gz: c58b793ebff0bd9e64f588983f4950c2f83b8ebfae3d2b3b5df0303c199be31d2409682b5198389db3c70416a6904d3f860ff892261039e5cca13545967f95a4
+  data.tar.gz: c55a500f6437006295cb9dc1322a799d0420395ef6d761a970cc94a2cbba6533005c9ed763838da93c9478bcef2f2c88d9580d17acdb2c220b909d13614e527e

data/README.md

@@ -1,7 +1,9 @@
 ## code_lister
 
+[![Gem Version](https://badge.fury.io/rb/code_lister.svg)](http://badge.fury.io/rb/code_lister)
+
 This is the simple gem to search/filter the files based on simple criteria.
-It provides the functionality similar to `find` command in Linux/Unix system.
+It provides the functionality similar to subset of `find` command in Linux/Unix system.
 
 Initially it was part of my internal project. I extracted this out as a gem so
 that I can re-use it in other project. I hope you will find it useful.
@@ -30,33 +32,91 @@ List all pdf and epub files in the `/opts/downloads/` directory recursively
 $code_lister find --base-dir /opt/downloads/ --exts pdf epub --recursive
 ```
 
-Usage:
+Usage/Synopsis:
 
 ```
 Usage:
   code_lister find
 
 Options:
-  -b, [--base-dir=BASE_DIR]            # Base directory
-                                       # Default: /Users/agilecreativity/Dropbox/spikes/code_explorer
-  -e, [--exts=one two three]           # List of extensions to search for
-                                       # Default: ["rb"]
-  -i, [--inc-words=one two three]      # List of words to be included in the result if any
-  -x, [--exc-words=one two three]      # List of words to be excluded from the result if any
-  -r, [--recursive], [--no-recursive]  # Search for files recursively
-  -v, [--version], [--no-version]      # Display version information
-
-List files based on select multiple criteria
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # Default: . (current directory)
+  -e, [--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 if any
+  -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
+  -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
+
+List files by extensions, patterns, and simple criteria
+```
+
+Example Usage:
+
+- Find all java and ruby files in a given directory
+
+e.g.
+
+```ruby
+
+# find all files that ends with '*.java' or '*.rb' in a given directory
+#
+# ./bin/code_lister find -b spec/fixtures/ -e rb java
+
+spec/fixtures/demo1.xxx.rb
+spec/fixtures/demo1.yyy.rb
+spec/fixtures/demo2.xxx.rb
+spec/fixtures/demo2.yyy.rb
+spec/fixtures/java/demo3.xxx.java
+spec/fixtures/java/demo3.yyy.java
+spec/fixtures/java/demo4.xxx.java
+spec/fixtures/java/demo4.yyy.java
+```
+
+- Find all java java and ruby files but include only the files that contain the word `xxx`
+
+```ruby
+# ./bin/code_lister find -b spec/fixtures/ -e rb java -n xxx
+spec/fixtures/demo1.xxx.rb
+spec/fixtures/demo2.xxx.rb
+spec/fixtures/java/demo3.xxx.java
+spec/fixtures/java/demo4.xxx.java
+
+```
+
+- Same as previous step, but filter out result that contain the word `demo3` or `demo4`
+
+```ruby
+# ./bin/code_lister find -b spec/fixtures/ -e rb java -n xxx -x demo3 demo4
+spec/fixtures/demo1.xxx.rb
+spec/fixtures/demo2.xxx.rb
 ```
 
 #### Using as ruby library
 
+This is probably the proper way to utilize the library as the CLI only serve to
+demonstrate purpose only.
+
+Example of how you might use the library in your own project.
+
 ```ruby
 require 'code_lister'
 include CodeLister
+
 # To search for everything that ends in '*.java' and '*.rb" recursively
-list1 = CodeLister.files(base_dir: "spec/fixtures", exts: %w(rb java), recursive: true)
-puts list1
+file_list = CodeLister.files base_dir: "spec/fixtures",
+                             exts: %w(rb java),
+                             recursive: true
+puts file_list
+
+# To filter out the result you may do so with the `CodeLister.filter` method
+
+new_list = CodeLister.filter(file_list, inc_words: %w(some list of word),
+                                        exc_words: %w(other text to excluded),
+                                        ignore_case: false)
+
 ```
 
 ### Development/Testing
@@ -76,7 +136,8 @@ rake irb
 From inside `Pry` or `IRB`
 
 ```ruby
-#include CodeLister
+include CodeLister
+
 # To search for everything that ends in '*.java' and '*.rb" recursively
 list1 = CodeLister.files(base_dir: "spec/fixtures", exts: %w(rb java), recursive: true)
 puts list1
@@ -84,8 +145,22 @@ puts list1
 # To filter out the result list
 list2 = CodeLister.filter(list1, inc_words: %w(final complete), exc_words: %w(demo test))
 ```
+
+### Disclaimers
+
+This is still work in progress. I may make several adjustment to the API and thus I might break
+the compatibility as the result. Please let me know if you find any problem. Pull request is
+always welcome.
+
 ### Changelogs
 
+#### 0.0.4
+
+- Add `ignore-case` option
+- Use `-n' for `--include-words` and use `-i` for `--ignore-case`.
+- Make the `--recursive` the default option
+- Make the `--ignore-case` the default option
+
 #### 0.0.3
 
 - Update README.md to include better sample usage, and misc cleanup.

data/lib/code_lister/cli.rb

@@ -1,9 +1,10 @@
 require 'thor'
 require_relative 'core_ext/hash'
+
 module CodeLister
   class CLI < Thor
 
-    desc "find", "List files by extension, patterns, and other criteria"
+    desc "find", "List files by extensions, patterns, and simple criteria"
 
     method_option :base_dir,
                   aliases: "-b",
@@ -14,10 +15,10 @@ module CodeLister
                   aliases: "-e",
                   desc: "List of extensions to search for",
                   type: :array,
-                  default: %w(rb)
+                  default: []
 
     method_option :inc_words,
-                  aliases: "-i",
+                  aliases: "-n",
                   desc: "List of words to be included in the result if any",
                   type: :array,
                   default: []
@@ -28,11 +29,17 @@ module CodeLister
                   type: :array,
                   default: []
 
+    method_option :ignore_case,
+                  aliases: "-i",
+                  desc: "Match case insensitively",
+                  type: :boolean,
+                  default: true
+
     method_option :recursive,
                   aliases: "-r",
                   desc: "Search for files recursively",
                   type: :boolean,
-                  default: false
+                  default: true
 
     method_option :version,
                   aliases: "-v",
@@ -58,16 +65,18 @@ Usage:
   code_lister find
 
 Options:
-  -b, [--base-dir=BASE_DIR]            # Base directory
-                                       # Default: /Users/agilecreativity/Dropbox/spikes/code_explorer
-  -e, [--exts=one two three]           # List of extensions to search for
-                                       # Default: ["rb"]
-  -i, [--inc-words=one two three]      # List of words to be included in the result if any
-  -x, [--exc-words=one two three]      # List of words to be excluded from the result if any
-  -r, [--recursive], [--no-recursive]  # Search for files recursively
-  -v, [--version], [--no-version]      # Display version information
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # Default: . (current directory)
+  -e, [--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 if any
+  -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
+  -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
 
-List files based on select multiple criteria
+List files by extensions, patterns, and simple criteria
       EOS
     end
 

data/lib/code_lister/code_lister.rb

@@ -25,28 +25,57 @@ module CodeLister
     def filter(file_list, args = {})
       opts = {
         inc_words: [],
-        exc_words: []
+        exc_words: [],
+        ignore_case: true
       }.merge(args)
 
-      inc_words = opts[:inc_words]
-      exc_words = opts[:exc_words]
+      inc_words   = opts[:inc_words]
+      exc_words   = opts[:exc_words]
+      ignore_case = opts[:ignore_case]
 
-      take_any!(file_list, inc_words)
-      drop_any!(file_list, exc_words)
+      take_any!(file_list, opts)
+      drop_any!(file_list, opts)
 
       file_list
     end
 
-    private
+    protected
+
+    def take_any!(file_list, args = {})
+      words = args[:inc_words]
+      ignore_case = args[:ignore_case]
+
+      unless words.empty?
+        file_list.select! do |f|
+          words.any? do |w|
+            if ignore_case
+              /#{w}/i =~ File.basename(f)
+            else
+              /#{w}/  =~ File.basename(f)
+            end
+          end
+        end
+      end
 
-    def take_any!(file_list, words)
-      # need to take only the filename
-      file_list.select! { |f| words.any? { |w| /#{w}/ =~ File.basename(f) } } unless words.empty?
       file_list
     end
 
-    def drop_any!(file_list, words)
-      file_list.delete_if { |f| words.any? { |w| /#{w}/ =~ File.basename(f) } } unless words.empty?
+    def drop_any!(file_list, args = {})
+      words = args[:exc_words]
+      ignore_case = args[:ignore_case]
+
+      unless words.empty?
+        file_list.delete_if do |f|
+          words.any? do |w|
+            if ignore_case
+              /#{w}/i =~ File.basename(f)
+            else
+              /#{w}/  =~ File.basename(f)
+            end
+          end
+        end
+      end
+
       file_list
     end
 

data/lib/code_lister/main.rb

@@ -13,7 +13,8 @@ module CodeLister
 
         files = CodeLister.filter(files, inc_words: inc_words,
                                          exc_words: exc_words)
-        # TODO: remove when done!
+
+        # Note: for now just print out the list of files
         puts files
 
         files
@@ -25,6 +26,7 @@ module CodeLister
         options = {
           base_dir: Dir.pwd,
           recursive: false,
+          ignore_case: true,
           inc_words: [],
           exc_words: [],
           exts: []

data/lib/code_lister/version.rb

@@ -1,3 +1,3 @@
 module CodeLister
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/code_lister/code_lister_spec.rb

@@ -39,9 +39,19 @@ describe CodeLister do
 
     it "filters out the words that we don't want" do
       expect(CodeLister.filter(file_list, exc_words: %w(demo1))).to eq ["spec/fixtures/demo2.xxx.rb"]
-
       expect(CodeLister.filter(file_list, exc_words: %w(xxx))).to eq []
     end
+
+    context 'with ignore_case' do
+      it 'ignores case by default' do
+        expect(CodeLister.filter(file_list, exc_words: %w(DeMo1))).to eq CodeLister.filter(file_list, exc_words: %w(demo1))
+        expect(CodeLister.filter(file_list, exc_words: %w(DeMo1))).to eq ["spec/fixtures/demo2.xxx.rb"]
+      end
+      it 'does not ignore case if specified' do
+        expect(CodeLister.filter(file_list, exc_words: %w(DeMo1), ignore_case: false)).to eq ["spec/fixtures/demo1.xxx.rb",
+                                                                                              "spec/fixtures/demo2.xxx.rb" ]
+      end
+    end
   end
 
 end

data/spec/fixtures/demo1.yyy.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo1.yyy.rb

data/spec/fixtures/demo2.yyy.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo2.yyy.rb

data/spec/fixtures/java/demo3.xxx.java

@@ -1 +1 @@
-// file: test/fixtures/java/demo3.java
+// file: test/fixtures/java/demo3.xxx.java

data/spec/fixtures/java/demo3.yyy.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo3.yyy.java

data/spec/fixtures/java/demo4.xxx.java

@@ -1 +1 @@
-// file: test/fixtures/java/demo4.java
+// file: test/fixtures/java/demo4.xxx.java

data/spec/fixtures/java/demo4.yyy.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo4.yyy.java

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_lister
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -149,9 +149,13 @@ files:
 - lib/code_lister/version.rb
 - spec/code_lister/code_lister_spec.rb
 - spec/fixtures/demo1.xxx.rb
+- spec/fixtures/demo1.yyy.rb
 - spec/fixtures/demo2.xxx.rb
+- spec/fixtures/demo2.yyy.rb
 - spec/fixtures/java/demo3.xxx.java
+- spec/fixtures/java/demo3.yyy.java
 - spec/fixtures/java/demo4.xxx.java
+- spec/fixtures/java/demo4.yyy.java
 - spec/spec_helper.rb
 homepage: https://github.com/agilecreativity/code_lister
 licenses:
@@ -180,8 +184,12 @@ summary: Search, filter files easily using the power of ruby
 test_files:
 - spec/code_lister/code_lister_spec.rb
 - spec/fixtures/demo1.xxx.rb
+- spec/fixtures/demo1.yyy.rb
 - spec/fixtures/demo2.xxx.rb
+- spec/fixtures/demo2.yyy.rb
 - spec/fixtures/java/demo3.xxx.java
+- spec/fixtures/java/demo3.yyy.java
 - spec/fixtures/java/demo4.xxx.java
+- spec/fixtures/java/demo4.yyy.java
 - spec/spec_helper.rb
 has_rdoc: