code_lister 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 69fbd03709c968f2a211b04e2d898084771ba634
4
- data.tar.gz: 271e923a1e2015a46cb12ecd3dc8e7d13aaaade0
3
+ metadata.gz: 2bdff7bff041d0b4d759f83eee1c841b8df72a83
4
+ data.tar.gz: 6c49de38ba9129b15adb68941f220e604faccf17
5
5
  SHA512:
6
- metadata.gz: c6c9d6e184576b967e474c95726ca35fa41939a6cf1f19d263a97abb051b4c15407cf9b95150649b7cdf6862c3811a1a6f459346057b5fa9d69e71a3602495ee
7
- data.tar.gz: cef3c70b228a91969f011654af1566f63bca5f9a0e4cc9628d436275cb06a3a5f34a5352ca0ea840a3fd9916d3b3c51b1bd3fa87ec6b6d97a8b8165342a357e8
6
+ metadata.gz: 2e72b7065dfa0be584d26b8e72a424519508e41bbc937e8a20ee8dd0641e4a1af175da7131a17430fdb1935e02156da3380428f71279ed3ab22e535ebd092a6b
7
+ data.tar.gz: 186354e7fac1115b89bc0ab54c316b8639054ab40b2b138f101ad0e670f2c17c70cb82e51664181fd34705bca3392ea5dcb119255b38228d08f9ac468ab5172a
data/README.md CHANGED
@@ -29,20 +29,40 @@ List all pdf and epub files in the `/opts/downloads/` directory recursively
29
29
  ```sh
30
30
  $code_lister find --base-dir /opt/downloads/ --exts pdf epub --recursive
31
31
  ```
32
+
33
+ Usage:
34
+
35
+ ```
36
+ Usage:
37
+ code_lister find
38
+
39
+ Options:
40
+ -b, [--base-dir=BASE_DIR] # Base directory
41
+ # Default: /Users/agilecreativity/Dropbox/spikes/code_explorer
42
+ -e, [--exts=one two three] # List of extensions to search for
43
+ # Default: ["rb"]
44
+ -i, [--inc-words=one two three] # List of words to be included in the result if any
45
+ -x, [--exc-words=one two three] # List of words to be excluded from the result if any
46
+ -r, [--recursive], [--no-recursive] # Search for files recursively
47
+ -v, [--version], [--no-version] # Display version information
48
+
49
+ List files based on select multiple criteria
50
+ ```
51
+
32
52
  #### Using as ruby library
33
53
 
34
54
  ```ruby
35
55
  require 'code_lister'
36
56
  include CodeLister
37
57
  # To search for everything that ends in '*.java' and '*.rb" recursively
38
- list1 = CodeLister.files(base_dir: "spec/fixtures", extensions: %w(rb java), recursive: true)
58
+ list1 = CodeLister.files(base_dir: "spec/fixtures", exts: %w(rb java), recursive: true)
39
59
  puts list1
40
60
  ```
41
61
 
42
62
  ### Development/Testing
43
63
 
44
64
  ```sh
45
- git clone git@github.com/agilecreativity/code_lister.git
65
+ git clone https://github.com/agilecreativity/code_lister.git
46
66
  bundle
47
67
  rake -T
48
68
 
@@ -58,7 +78,7 @@ From inside `Pry` or `IRB`
58
78
  ```ruby
59
79
  #include CodeLister
60
80
  # To search for everything that ends in '*.java' and '*.rb" recursively
61
- list1 = CodeLister.files(base_dir: "spec/fixtures", extensions: %w(rb java), recursive: true)
81
+ list1 = CodeLister.files(base_dir: "spec/fixtures", exts: %w(rb java), recursive: true)
62
82
  puts list1
63
83
 
64
84
  # To filter out the result list
@@ -66,6 +86,10 @@ list2 = CodeLister.filter(list1, inc_words: %w(final complete), exc_words: %w(de
66
86
  ```
67
87
  ### Changelogs
68
88
 
89
+ #### 0.0.3
90
+
91
+ - Update README.md to include better sample usage, and misc cleanup.
92
+
69
93
  #### 0.0.2
70
94
 
71
95
  - initial release
data/code_lister.gemspec CHANGED
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
9
9
  spec.authors = ["Burin Choomnuan"]
10
10
  spec.email = ["agilecreativity@gmail.com"]
11
11
  spec.summary = %q{Search, filter files easily using the power of ruby}
12
- spec.description = %q{Use ruby library to search/filter files}
12
+ spec.description = %q{List/filter files similar to 'find' command in Linux/Unix based system}
13
13
  spec.homepage = "https://github.com/agilecreativity/code_lister"
14
14
  spec.license = "MIT"
15
15
  spec.files = `git ls-files -z`.split("\x0")
@@ -1,3 +1,3 @@
1
1
  module CodeLister
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.3"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: code_lister
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Burin Choomnuan
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-04-12 00:00:00.000000000 Z
11
+ date: 2014-04-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: thor
@@ -122,7 +122,7 @@ dependencies:
122
122
  - - "~>"
123
123
  - !ruby/object:Gem::Version
124
124
  version: '1.3'
125
- description: Use ruby library to search/filter files
125
+ description: List/filter files similar to 'find' command in Linux/Unix based system
126
126
  email:
127
127
  - agilecreativity@gmail.com
128
128
  executables: