code_lister 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fde9576db239d5b1600c135b1e50e98d37f92312
-  data.tar.gz: 7bab4d02375dadea47e1d5eeae5f98df730e5fcf
+  metadata.gz: 29c1f57613e53602f8a8a101828cac54b05af619
+  data.tar.gz: f7268d21369628be9089d7a2becb88ece7bccaaa
 SHA512:
-  metadata.gz: 1c0bae4f7989747ce15cff9164364d3ae99e232b1b8fd42de026e6c7a2d41015931f135e2f346236bd23358e22b24d5d76c17d847ab588ab99f13a3cbc203b97
-  data.tar.gz: 7d93e8b9eb2aa048ed821368effe50f33cc232e2e91db7f2fc6a11012c0dc58d4ecd0e5df089c3944fb2abcc99322bdbf5bb6185b0201e55bf450aeef5e0e32b
+  metadata.gz: c969f80d68ff5a2d844faced9f2c9127a1319c1be362b2a2b4fcef79f7a22c10d5e1c037c9f691c8d71360598f678d30351fd4f8747aee262de434a372b02dad
+  data.tar.gz: dcb3aa77c8b80de464d5925c28d92c686315dd4f9330743fb202d90e0d34a7a0bc0b04efd884983f0d77d8e60c1df94ad75f6aebd9d4bb799ee226c4a37c0237

data/README.md

@@ -2,11 +2,11 @@
 
 [![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 subset of `find` command in Linux/Unix system.
+Find/filter files based on simple criteria like `extension`, include/exclude some words in the name.
+It provides the functionality similar to subset of `find | grep` 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.
+Initially this was part of my internal project. I extracted this out as a gem so
+that I can re-use it in other project.
 
 ### Installation
 
@@ -36,14 +36,15 @@ Usage/Synopsis:
 
 ```
 Usage:
-  code_lister find
+  code_lister find [OPTIONS]
 
 Options:
   -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
+  -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
@@ -57,8 +58,6 @@ 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
@@ -83,7 +82,6 @@ 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`
@@ -130,11 +128,7 @@ rake -T
 # Play around with it using Pry
 rake pry
 
-# Or play around with it using IRB
-rake irb
-```
-
-From inside `Pry` or `IRB`
+From inside `Pry`
 
 ```ruby
 include CodeLister
@@ -155,27 +149,25 @@ always welcome.
 
 ### Changelogs
 
-#### 0.0.6
+#### 0.0.7
+- Make use of the 'agile_utils' gem for better code re-use
 
+#### 0.0.6
 - Add `--non-exts` option that make it possible to include files without extension.
 
 #### 0.0.5
-
 - Refactoring the CLI options to make it easy for re-use in other library.
 
 #### 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.
 
 #### 0.0.2
-
 - initial release
 
 ## Contributing

data/Rakefile

@@ -3,17 +3,8 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
 
-task :irb do
-  require 'irb'
-  require 'awesome_print'
-  require 'irb/completion'
-  require 'code_lister'
-  include CodeLister
-  ARGV.clear
-  IRB.start
-end
+task :default => :spec
 
 task :pry do
   require 'pry'

data/code_lister.gemspec

@@ -4,24 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'code_lister/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "code_lister"
+  spec.name          = 'code_lister'
   spec.version       = CodeLister::VERSION
-  spec.authors       = ["Burin Choomnuan"]
-  spec.email         = ["agilecreativity@gmail.com"]
-  spec.summary       = %q{Search, filter files easily using the power of ruby}
-  spec.description   = %q{List/filter files similar to 'find' command in Linux/Unix based system}
-  spec.homepage      = "https://github.com/agilecreativity/code_lister"
-  spec.license       = "MIT"
+  spec.authors       = ['Burin Choomnuan']
+  spec.email         = ['agilecreativity@gmail.com']
+  spec.summary       = %q{List/filter files like 'find | grep' command in Linux/Unix based system}
+  spec.description   = %q{List/filter files similar to 'find | grep' command in Linux/Unix based system}
+  spec.homepage      = 'https://github.com/agilecreativity/code_lister'
+  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.add_runtime_dependency "thor"
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.1"
-  spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "guard-rspec", "~> 4.2"
-  spec.add_development_dependency "awesome_print", "~> 1.2"
-  spec.add_development_dependency "pry", "~> 0.9"
-  spec.add_development_dependency "fuubar", "~> 1.3"
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+  spec.add_runtime_dependency 'agile_utils', '~> 0.0.5'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'awesome_print', '~> 1.2'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'fuubar', '~> 1.3'
 end

data/lib/code_lister/cli.rb

@@ -1,74 +1,24 @@
 require 'thor'
+require 'agile_utils'
 require_relative 'core_ext/hash'
-
-module CodeLister
-  class BaseCLI < Thor
-
-    def self.shared_options
-
-      method_option :base_dir,
-                    aliases: "-b",
-                    desc: "Base directory",
-                    default: Dir.pwd
-
-      method_option :exts,
-                    aliases: "-e",
-                    desc: "List of extensions to search for",
-                    type: :array,
-                    default: []
-
-      method_option :non_exts,
-                    aliases: "-f",
-                    desc: "List of files without extension to search for",
-                    type: :array,
-                    default: []
-
-      method_option :inc_words,
-                    aliases: "-n",
-                    desc: "List of words to be included in the result if any",
-                    type: :array,
-                    default: []
-
-      method_option :exc_words,
-                    aliases: "-x",
-                    desc: "List of words to be excluded from the result if any",
-                    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: true
-
-      method_option :version,
-                    aliases: "-v",
-                    desc: "Display version information",
-                    type: :boolean,
-                    default: false
-    end
-  end
-end
-
 module CodeLister
-  class CLI < CodeLister::BaseCLI
-
+  class CLI < Thor
     desc "find", "List files by extensions, patterns, and simple criteria"
-
-    shared_options
-
+    method_option *AgileUtils::Options::BASE_DIR
+    method_option *AgileUtils::Options::EXTS
+    method_option *AgileUtils::Options::NON_EXTS
+    method_option *AgileUtils::Options::INC_WORDS
+    method_option *AgileUtils::Options::EXC_WORDS
+    method_option *AgileUtils::Options::IGNORE_CASE
+    method_option *AgileUtils::Options::RECURSIVE
+    method_option *AgileUtils::Options::VERSION
     def find
-      if options[:version]
+      opts = options.symbolize_keys
+      if opts[:version]
         puts "You are using CodeLister Version #{CodeLister::VERSION}"
         exit
       end
-      CodeLister::Main.run(options.symbolize_keys)
+      CodeLister::Main.run(opts)
     end
 
     # Note: we don't use help so that we can run :r !./bin/code_lister help find
@@ -81,11 +31,11 @@ Usage:
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
-                                           # Default: /home/bchoomnuan/Dropbox/spikes/code_lister
+                                           # Default: . (current directory)
   -e, [--exts=one two three]               # List of extensions to search for
-  -f, [--non-exts=one two three]           # List of files without extension 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
+  -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

data/lib/code_lister/code_lister.rb

@@ -35,10 +35,6 @@ module CodeLister
         ignore_case: true
       }.merge(args)
 
-      inc_words   = opts[:inc_words]
-      exc_words   = opts[:exc_words]
-      ignore_case = opts[:ignore_case]
-
       take_any!(file_list, opts)
       drop_any!(file_list, opts)
 

data/lib/code_lister/main.rb

@@ -1,7 +1,6 @@
 module CodeLister
   class Main
     class << self
-
       def run(options = {})
         args = default_options.merge(options)
 
@@ -13,25 +12,20 @@ module CodeLister
 
         files = CodeLister.filter(files, inc_words: inc_words,
                                          exc_words: exc_words)
-
-        # Note: for now just print out the list of files
         puts files
-
         files
       end
 
       private
 
       def default_options
-        options = {
-          base_dir: Dir.pwd,
-          recursive: false,
+        { base_dir: Dir.pwd,
+          recursive: true,
           ignore_case: true,
           inc_words: [],
           exc_words: [],
           exts: [],
-          non_exts: []
-        }
+          non_exts: [] }
       end
     end
   end

data/lib/code_lister/version.rb

@@ -1,3 +1,3 @@
 module CodeLister
-  VERSION = "0.0.6"
+  VERSION = '0.0.7'
 end

data/spec/code_lister/code_lister_spec.rb

@@ -52,6 +52,5 @@ describe CodeLister do
                                                                                               "spec/fixtures/demo2.xxx.rb" ]
       end
     end
-
   end
 end

data/spec/code_lister/main_spec.rb

@@ -1,12 +1,12 @@
 require_relative '../spec_helper'
 describe CodeLister do
-  context "#files" do
+  context '#files' do
     it 'works with non_exts option' do
       list = CodeLister::Main.run base_dir: 'spec/fixtures/',
                                   recursive: true,
                                   non_exts: %w(noexts1_zzz noexts2_zzz)
-      expect(list).to eq [ "spec/fixtures/noexts1_zzz",
-                           "spec/fixtures/noexts2_zzz" ]
+      expect(list).to eq ['spec/fixtures/noexts1_zzz',
+                          'spec/fixtures/noexts2_zzz']
     end
   end
 end

data/spec/spec_helper.rb

@@ -16,5 +16,5 @@ RSpec.configure do |config|
   config.order = 'random'
 end
 
-require_relative "../lib/code_lister"
+require_relative '../lib/code_lister'
 include CodeLister

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: code_lister
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: agile_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: List/filter files similar to 'find' command in Linux/Unix based system
+description: List/filter files similar to 'find | grep' command in Linux/Unix based
+  system
 email:
 - agilecreativity@gmail.com
 executables:
@@ -183,7 +198,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Search, filter files easily using the power of ruby
+summary: List/filter files like 'find | grep' command in Linux/Unix based system
 test_files:
 - spec/code_lister/code_lister_spec.rb
 - spec/code_lister/main_spec.rb