code_lister 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7730af28692faa190358541a214fddd204ee3b02
-  data.tar.gz: 11cdf45d4c2e7cbdef17fa58615e87c35d65530b
+  metadata.gz: 936444628fc21d7dd4d8b9e4210282c5cf8af848
+  data.tar.gz: 46675cb934ccf424498be589b995405be7a4b5c2
 SHA512:
-  metadata.gz: ee0b6456754105423da9c3d3be83b2dfb4123404c718842c532ff9a243fbd82cf5930910fd0539864c30c4c35ee962c584ffe04c0d0340ad86725d870e1f9c07
-  data.tar.gz: 712d3aaf85c96bea23d3656105e0e9f9839a08e4042411915a0b2ab7ab49dcb36981b4a8cebfa4e22c251824dbd8ba7b32c6a98de50eac9a1023070f3d98eb02
+  metadata.gz: c39417058af18792eb70cfd8084343a6bd7ae31697dad866d7fa7f14226f397f6a1e9dd06c9bd17970d35d421a8ca42c46a7e499858f04137f3e97b35912f8ee
+  data.tar.gz: 65da264d9b5a06848190890df95d9bb2925057e28aac3427d96bbcbef6651c84cbfe318d70047b4ca30bfbe9a8b68b3d0cfc0642631ecb7b2cc6a6cb61216d23

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This is the configuration used to check the rubocop source code.
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - lib/**/*
+    - bin/*
+  Exclude:
+    - .rubocop.yml
+inherit_from: rubocop-todo.yml

data/CHANGELOGS.md

@@ -0,0 +1,40 @@
+### Changelogs
+
+#### 0.0.9
+
+- Consistencely replace the `base_dir` with `.` in the result:w
+- Move changelogs section from README.md to CHANGELOGS.md
+- Minor code refactoring
+- Fix style with rubocop
+- Add rubocop gem and simple rules
+
+#### 0.0.8
+
+- Update dependencies
+
+#### 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

data/README.md

@@ -66,30 +66,32 @@ Example Usage:
 #
 # ./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
+```
+./demo1.xxx.rb
+./demo1.yyy.rb
+./demo2.xxx.rb
+./demo2.yyy.rb
+./java/demo3.xxx.java
+./java/demo3.yyy.java
+./java/demo4.xxx.java
+./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
+
+./demo1.xxx.rb
+./demo2.xxx.rb
+./java/demo3.xxx.java
+./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
+./demo1.xxx.rb
+./demo2.xxx.rb
 ```
 #### Using as ruby library
 
@@ -138,39 +140,6 @@ puts list1
 list2 = CodeLister.filter(list1, inc_words: %w(final complete), exc_words: %w(demo test))
 ```
 
-### Changelogs
-
-#### 0.0.8
-
-- Update dependencies
-
-#### 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
 
 1. Fork it ( http://github.com/<my-github-username>/code_lister/fork )

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :pry do
   require 'pry'

data/code_lister.gemspec

@@ -12,7 +12,18 @@ Gem::Specification.new do |spec|
   spec.description   = %q{List/filter files similar to 'find then 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.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.files         = Dir.glob("{bin,lib}/**/*") + %w(Gemfile
+                                                       Rakefile
+                                                       code_lister.gemspec
+                                                       README.md
+                                                       CHANGELOGS.md
+                                                       LICENSE
+                                                       .rubocop.yml
+                                                       .gitignore
+                                                       rubocop-todo.yml)
   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']
@@ -25,4 +36,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.1'
 end

data/lib/code_lister/cli.rb

@@ -2,7 +2,7 @@ require 'thor'
 require 'agile_utils'
 module CodeLister
   class CLI < Thor
-    desc "find", "List files by extensions, patterns, and simple criteria"
+    desc 'find', 'List files by extensions, patterns, and simple criteria'
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::EXTS
     method_option *AgileUtils::Options::NON_EXTS
@@ -22,7 +22,7 @@ module CodeLister
 
     # Note: we don't use help so that we can run :r !./bin/code_lister help find
     # to see the update help if we have to without commenting out
-    desc "usage", "Display help screen"
+    desc 'usage', 'Display help screen'
     def usage
       puts <<-EOS
 Usage:

data/lib/code_lister/code_lister.rb

@@ -10,18 +10,22 @@ module CodeLister
         non_exts: []
       }.merge(args)
 
-      base_dir = opts[:base_dir]
-      raise CustomError, "The directory #{base_dir} is not valid or or not readable!" unless File.exists?(base_dir)
+      # 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] ? '**' : ''
       exts     = opts[:exts]
       non_exts = opts[:non_exts]
 
-      file_with_extension    = Dir.glob(File.join(base_dir, wildcard, "*.{#{exts.join(",")}}"))
-      file_with_no_extension = no_extension_files(base_dir, wildcard, non_exts)
-
+      files_with_extension    = Dir.glob(File.join(base_dir, wildcard, "*.{#{exts.join(',')}}"))
+      files_without_extension = no_extension_files(base_dir, wildcard, non_exts)
+      # remove the 'base_dir' with .
+      files_with_extension.each { |f| f.gsub!(base_dir, '.') }
+      files_without_extension.each { |f| f.gsub!(base_dir, '.') }
       # combine the result
-      (file_with_extension + file_with_no_extension).sort
+      (files_with_extension + files_without_extension).sort
     end
 
     # Filter out the list based on given list of words
@@ -56,14 +60,8 @@ module CodeLister
       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
+        file_list.select! do |file|
+          matched_any?(words, file, ignore_case)
         end
       end
 
@@ -73,20 +71,24 @@ module CodeLister
     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
+        file_list.delete_if do |file|
+          matched_any?(words, file, ignore_case)
         end
       end
-
       file_list
     end
+
+    def matched_any?(words, file, ignore_case)
+      words.any? { |word| matched?(ignore_case, word, file) }
+    end
+
+    def matched?(ignore_case, word, file)
+      if ignore_case
+        /#{word}/i =~ File.basename(file)
+      else
+        /#{word}/  =~ File.basename(file)
+      end
+    end
   end
 end

data/lib/code_lister/version.rb

@@ -1,3 +1,3 @@
 module CodeLister
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/rubocop-todo.yml

@@ -0,0 +1,67 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-05-09 23:31:10 +1000 using RuboCop version 0.21.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+AmbiguousOperator:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Blocks:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+DeprecatedClassMethods:
+  Enabled: true
+
+# Offense count: 5
+Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+HashSyntax:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+LeadingCommentSpace:
+  Enabled: true
+
+# Offense count: 22
+LineLength:
+  Max: 124
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 20
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+SignalException:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+SpaceInsideBlockBraces:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+SpaceInsideBrackets:
+  Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_lister
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.1
 description: List/filter files similar to 'find then grep' command in Linux/Unix based
   system
 email:
@@ -146,11 +160,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
-- ".ruby-version"
+- ".rubocop.yml"
+- CHANGELOGS.md
 - Gemfile
-- Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/code_lister
@@ -161,19 +174,7 @@ files:
 - lib/code_lister/logger.rb
 - lib/code_lister/main.rb
 - lib/code_lister/version.rb
-- spec/code_lister/code_lister_spec.rb
-- spec/code_lister/main_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/fixtures/noexts1_zzz
-- spec/fixtures/noexts2_zzz
-- spec/spec_helper.rb
+- rubocop-todo.yml
 homepage: https://github.com/agilecreativity/code_lister
 licenses:
 - MIT
@@ -198,18 +199,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: List/filter files like 'find then grep' command in Linux/Unix based system
-test_files:
-- spec/code_lister/code_lister_spec.rb
-- spec/code_lister/main_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/fixtures/noexts1_zzz
-- spec/fixtures/noexts2_zzz
-- spec/spec_helper.rb
+test_files: []
 has_rdoc: 

data/.rspec

@@ -1,3 +0,0 @@
---color
---format progress
-#--format Fuubar

data/.ruby-version

@@ -1 +0,0 @@
-2.1.1

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-guard :rspec do
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/spec/code_lister/code_lister_spec.rb

@@ -1,55 +0,0 @@
-require_relative '../spec_helper'
-describe CodeLister do
-  let(:file_list) {
-    CodeLister.files(base_dir: 'spec/fixtures', exts: %w(xxx.rb), recursive: true)
-  }
-
-  context "#files" do
-    it 'works with invalid input' do
-      expect{ CodeLister.files('bad-args')}.to raise_error
-    end
-
-    it 'works with valid input' do
-      expect(CodeLister.files(base_dir: 'spec/fixtures', exts: %w(xxx.rb))).to eq ['spec/fixtures/demo1.xxx.rb',
-                                                                                   'spec/fixtures/demo2.xxx.rb']
-    end
-
-    it 'returns empty result if no match found' do
-      expect(CodeLister.files(base_dir: 'spec/fixtures', exts: %w(invalid-extension))).to eq []
-    end
-  end
-
-  context "#filter" do
-    it "works with empty filter inputs" do
-      expect(CodeLister.filter(file_list, inc_words: [], exc_words: [])).to eq file_list
-    end
-
-    it "works with unique match" do
-      expect(CodeLister.filter(file_list, inc_words: %w(demo1))).to eq ["spec/fixtures/demo1.xxx.rb"]
-    end
-
-    it "works with multiples matches" do
-      expect(CodeLister.filter(file_list, inc_words: %w(demo))).to eq ["spec/fixtures/demo1.xxx.rb",
-                                                                       "spec/fixtures/demo2.xxx.rb"]
-
-      expect(CodeLister.filter(file_list, inc_words: %w(xxx))).to eq ["spec/fixtures/demo1.xxx.rb",
-                                                                      "spec/fixtures/demo2.xxx.rb"]
-    end
-
-    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/code_lister/main_spec.rb

@@ -1,12 +0,0 @@
-require_relative '../spec_helper'
-describe CodeLister 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']
-    end
-  end
-end

data/spec/fixtures/demo1.xxx.rb

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

data/spec/fixtures/demo1.yyy.rb

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

data/spec/fixtures/demo2.xxx.rb

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

data/spec/fixtures/demo2.yyy.rb

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

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

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

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

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

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

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

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

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

data/spec/fixtures/noexts1_zzz

@@ -1 +0,0 @@
-# file: spec/fixtures/noexts1_zzz

data/spec/fixtures/noexts2_zzz

@@ -1 +0,0 @@
-# file: spec/fixtures/noexts2_zzz

data/spec/spec_helper.rb

@@ -1,20 +0,0 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-end
-
-require_relative '../lib/code_lister'
-include CodeLister