what_now 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c129b4ea1aed4491608b1aa54462eb469f06f69b
-  data.tar.gz: 25a68c0f5b0fd9048c495cdb18447050f846a43f
+  metadata.gz: 544af77f51167e74302cbd4bf98ca400d2b9a695
+  data.tar.gz: d89bba664223614756de397c960463218e483f36
 SHA512:
-  metadata.gz: 16dec7d805e9ba4759b3b2835b597e7e31f57bed8828b74dbd3d00d8a8116db1e0d1425e881e12a1027c06aa962ea51c73ad3386abdf8fb3b5748107cab4652a
-  data.tar.gz: 73ef733a215b66af92f7d3fadbc9b9deaed33be14f273480a4601273d2650a289ae05a29f17969e510e9e4a6855e08afb9c61203466ee2706fb8846cb1acb739
+  metadata.gz: 5f584e61ff6da4c4d6fcd99da6740086bff4cf0e3ffd10ef490b0268d6aed26d2bce98eee9a9586b0bf87874eaa23a552d5fa2a347c23e637c87944c02734c3c
+  data.tar.gz: 51ccf2fb7e922057fe0fdd0d2cce6c35228bcace881fef56572c87d0ccdbdfe967fbbc1c716ebb1288a58151e5709828211e93d8e55a6e9c39da1fdce85a2695

data/README.md

@@ -26,10 +26,18 @@ Will return all the todos in the following format inside files:
 
 * TODO this is the text
 
-Where 'this is the text' will be returned, together with the path and line number
-
-You can also use the options *--dir, -d*, in order to specify the directory in which
-todos are going to be looked for, and *--ext -e* for checking only certain file extension
-(without prepending the '.', this means, call *--ext rb* instead of *--ext .rb*).
-You can optionally ignore casing for your *TODO* comments, in which case you may
-pass the option *--ignorecase, -i*.
+Where 'this is the text' will be returned, together with the relative path and line number
+
+The output is colored, but if redirected to a non TTY device, a simpler, colorless format
+will be used.
+
+Options
+-------
+* *--dir, -d*: Specify the directory in which to search the TODO's. It can be an absolute
+  path of anyhwere in the system, or a relative path to the current directory.
+* *--ext, -e*: Specify the extension of the files to consider. You can pass it with or without
+  the dot (.rb or rb are both valid).
+* *--regex, -r*: Specify the regular expression (Perl-like) that the file names
+  must match.
+* *--ignorecase, -i*: When passed, this options matches both the strings *TODO* and *todo*.
+  By default, this options is deactivated.

data/bin/wnow

@@ -2,21 +2,37 @@
 require 'thor'
 require 'colorize'
 require 'what_now'
+require 'file_filter'
+require 'pathname'
 
 class Wnow < Thor
+  include Filtering
   default_task :find
 
   desc 'find', 'search files in directory for todo elements (default command)'
   option :dir, aliases: '-d'
   option :ext, aliases: '-e'
+  option :regex, aliases: '-r'
   option :ignorecase, aliases: '-i'
   def find
+    # Directory handling
+    current_dir = Pathname.getwd
     dir = options[:dir] || Dir.pwd
-    ext = options[:ext] ? "/**/*.#{options[:ext]}" : '/**/*.*'
-    creator = TodoCreator.new(
-      ignorecase: options[:ignorecase],
-      pretty: STDOUT.tty?)
-    TodoFinder.new(dir + ext, creator).find.each do |todo|
+    absolute_dir = Pathname.new(dir).expand_path.to_s
+
+    filter = NoDirectories
+            .chain(NoBinaries)
+            .chain(OnlyDirectory.new absolute_dir)
+    filter.chain(OnlyExtension.new options[:ext]) if options[:ext]
+    filter.chain(MatchRegex.new options[:regex]) if options[:regex]
+
+    relative_paths = Dir[absolute_dir + '/**/*'].map do |p|
+      Pathname.new(p).relative_path_from(current_dir).to_s
+    end
+    targets = filter.filter relative_paths
+
+    creator = TodoCreator.new(ignorecase: options[:ignorecase], pretty: STDOUT.tty?)
+    TodoFinder.new(targets, creator).find.each do |todo|
       puts todo
       puts if STDOUT.tty?
     end

data/lib/file_filter.rb

@@ -0,0 +1,73 @@
+# Module for handling filtering of
+# files
+
+require 'ptools'
+require 'pathname'
+
+module Filtering
+  class Filter
+    attr_reader :predicates
+
+    def initialize &predicate
+      @predicates = [predicate]
+    end
+
+    def apply file
+      @predicates.reduce(true) do |result, p|
+        result && p.call(file)
+      end
+    end
+
+    def chain other=nil
+      raise ArgumentError if (not other and not block_given?)
+      @predicates += other.predicates if other
+      @predicates << Proc.new if block_given?
+      self
+    end
+
+    def filter files
+      files.keep_if do |f|
+        self.apply f
+      end
+    end
+  end
+
+  NoDirectories = Filter.new do |path|
+    not File.directory? path
+  end
+
+  NoBinaries = Filter.new do |path|
+    not File.binary? path
+  end
+
+  class OnlyDirectory <  Filter
+    def initialize subdirectory
+      base = Pathname.new(subdirectory).expand_path.to_s
+      @predicates = []
+      @predicates << proc do |path|
+        file = Pathname.new(path).expand_path.to_s
+        file.start_with? base
+      end
+    end
+  end
+
+  class OnlyExtension < Filter
+    def initialize ext
+      extension = ext.start_with?('.') ? ext[1..-1] : ext
+      @predicates = []
+      @predicates << proc do |path|
+        path.match(/\.#{extension}$/i) ? true : false
+      end
+    end
+  end
+
+  class MatchRegex < Filter
+    def initialize regex
+      @predicates = []
+      @predicates << proc do |path|
+        path.match(regex) ? true : false
+      end
+    end
+  end
+end
+

data/lib/what_now.rb

@@ -13,22 +13,15 @@ class TodoCreator
   def match(line, path, line_number)
     regex = @ignorecase ? /TODO:?\s*(.+)$/i : /TODO:?\s*(.+)$/
     text = regex.match(line)
-    @todo_class.new(text[1], shortened_path(path), line_number) if text
+    @todo_class.new(text[1], path, line_number) if text
   rescue ArgumentError
     nil
   end
-
-  private
-  def shortened_path(path)
-    path[Dir.pwd.length+1..path.length]
-  end
 end
 
 class TodoFinder
-  def initialize(pattern, creator)
-    @paths = Dir[pattern].delete_if do |path|
-      File.directory?(path) || File.binary?(path)
-    end
+  def initialize(paths, creator)
+    @paths = paths
     @creator = creator
   end
 

data/spec/file_filter_spec.rb

@@ -0,0 +1,188 @@
+require_relative 'spec_helper'
+require 'pathname'
+require 'fileutils'
+require 'fakefs/safe'
+
+module FakeFS
+  class File
+    def self.binary? file
+      file == '/sample/d2/f3'
+    end
+  end
+end
+
+FileFilter = Filtering::Filter
+
+describe FileFilter do
+  subject do
+    FileFilter.new do |file|
+      true
+    end
+  end
+
+  describe 'public interface' do
+    it 'must respond to apply' do
+      subject.must_respond_to :apply
+    end
+
+    it 'must respond to chain' do
+      subject.must_respond_to :chain
+    end
+
+    it 'must respond to filter' do
+      subject.must_respond_to :filter
+    end
+  end
+
+  describe '#apply' do
+    it 'is expected to return result of predicate' do
+      subject.apply(nil).must_equal true
+    end
+  end
+
+  describe '#chain' do
+    subject do
+      FileFilter.new do |x|
+        x > 0
+      end.chain do |x|
+        x % 2 == 0
+      end
+    end
+
+    it 'returns an instance of FileFilter' do
+      subject.must_be_instance_of FileFilter
+    end
+
+    it 'applies all filters when called' do
+      subject.filter([-2, -1, 0, 1, 2, 3, 4]).must_equal [2, 4]
+    end
+
+    describe 'with no arguments' do
+      it 'raises an exception' do
+        proc do
+          FileFilter.new do
+            true
+          end.chain
+        end.must_raise ArgumentError
+      end
+    end
+
+    describe 'with instance of filter' do
+      subject  do
+        f1 = FileFilter.new do |f|
+          f % 2 == 0
+        end
+        FileFilter.new do |f|
+          f > 0
+        end.chain f1
+      end
+
+      it 'returns an instance of Filter' do
+        subject.chain(FileFilter.new { |x| x > 0 }).must_be_instance_of FileFilter
+      end
+
+      it 'applies all filters when called' do
+        [-2, -1, 0, 1, 2, 3, 4].keep_if do |n|
+          subject.apply(n)
+        end.must_equal [2, 4]
+      end
+    end
+  end
+
+  describe '#filter' do
+    subject do
+      FileFilter.new do |x|
+        x > 2
+      end
+    end
+
+    it 'correctly filters the elements' do
+      subject.filter([-2, -1, 0, 1, 2, 3, 4]).must_equal [3, 4]
+    end
+  end
+end
+
+describe 'specific filters' do
+  before do
+    FakeFS.activate!
+    FileUtils.mkdir_p 'sample/d1'
+    FileUtils.mkdir_p 'sample/d2'
+    FileUtils.touch 'sample/d1/f1.rb'
+    FileUtils.touch 'sample/d1/f2_rb'
+    FileUtils.touch 'sample/d2/f3'
+  end
+
+  after do
+    FakeFS.deactivate!
+  end
+
+  let :paths do
+    Dir['sample/**/*']
+  end
+
+  describe 'directory filter' do
+    subject do
+      Filtering::NoDirectories
+    end
+
+    it 'only returns files' do
+      subject.filter(paths).sort!.must_equal ['/sample/d1/f1.rb', '/sample/d1/f2_rb', '/sample/d2/f3'].sort!
+    end
+  end
+
+  describe 'binary filter' do
+    subject do
+      Filtering::NoBinaries
+    end
+
+    it 'only returns non-binaries' do
+      subject.filter(paths).wont_include '/sample/d2/f3'
+    end
+  end
+
+  describe 'directory filter' do
+    subject do
+      Filtering::OnlyDirectory.new '/sample/d1'
+    end
+
+    it 'only returns elements in given subdirectory' do
+      subject.filter(paths).sort!.must_equal ['/sample/d1', '/sample/d1/f1.rb', '/sample/d1/f2_rb'].sort!
+    end
+  end
+
+  describe 'extension filter' do
+    subject do
+      Filtering::OnlyExtension.new 'rb'
+    end
+
+    it 'only returns elements with the given extension' do
+      subject.filter(paths).sort!.must_equal ['/sample/d1/f1.rb']
+    end
+
+    it 'still returns extension when extension specified with dot' do
+      Filtering::OnlyExtension.new('.rb').filter(paths).must_equal ['/sample/d1/f1.rb']
+    end
+
+    it 'does not match a file that ends with same letter as extension' do
+      subject.filter(paths).wont_include '/sample/d1/f2_rb'
+    end
+
+    it 'treats the extension case insensitively' do
+      Filtering::OnlyExtension.new('RB').filter(paths).must_equal ['/sample/d1/f1.rb']
+    end
+  end
+
+  describe 'regex filter' do
+    subject do
+      Filtering::MatchRegex.new(/f[0-9]/)
+    end
+
+    it 'only returns elements that match regular expression' do
+      subject.filter(paths).sort!.must_equal ['/sample/d1/f1.rb', '/sample/d1/f2_rb', '/sample/d2/f3'].sort!
+    end
+
+    it 'accepts a string as a regular expression' do
+      Filtering::MatchRegex.new('f[0-9]').filter(paths).sort!.must_equal ['/sample/d1/f1.rb', '/sample/d1/f2_rb', '/sample/d2/f3'].sort!
+    end
+  end
+end

data/spec/what_now_spec.rb

@@ -56,8 +56,8 @@ end
 describe TodoFinder do
   describe 'search single file' do
     subject do
-      path = File.dirname(__FILE__) + '/example_file.txt'
-      TodoFinder.new(path, TodoCreator.new).find
+      paths = Dir[File.dirname(__FILE__) + '/example_file.txt']
+      TodoFinder.new(paths, TodoCreator.new).find
     end
 
     it 'found 2 todos' do
@@ -74,15 +74,17 @@ describe TodoFinder do
 
   describe 'search with a pattern' do
     it 'considers only specified pattern' do
+      paths = Dir[File.dirname(__FILE__)+'/**/*.txt']
       results = TodoFinder.new(
-        File.dirname(__FILE__)+'/**/*.txt',
+        paths,
         TodoCreator.new).find
       results.length.must_equal 2
     end
 
     it 'returns empty array if nothing was found' do
+      paths = Dir[File.dirname(__FILE__)+'/**/*.mooo']
       results = TodoFinder.new(
-        File.dirname(__FILE__)+'/**/*.mooo',
+        paths,
         TodoCreator.new).find
       results.must_equal []
     end

data/what_now.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'what_now'
-  s.version     = '0.0.5'
+  s.version     = '0.0.6'
   s.date        = '2014-02-27'
   s.summary     = 'Find todo comments in your code'
   s.description = 'Executable for finding todo comments on directories'
@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'minitest-reporters'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'fakefs'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: what_now
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Edgar Cabrera
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Executable for finding todo comments on directories
 email: edgar@cafeinacode.com
 executables:
@@ -90,9 +104,11 @@ files:
 - LICENSE
 - README.md
 - bin/wnow
+- lib/file_filter.rb
 - lib/todo.rb
 - lib/what_now.rb
 - spec/example_file.txt
+- spec/file_filter_spec.rb
 - spec/spec_helper.rb
 - spec/todo_spec.rb
 - spec/what_now_spec.rb
@@ -126,3 +142,4 @@ test_files:
 - spec/example_file.txt
 - spec/spec_helper.rb
 - spec/todo_spec.rb
+- spec/file_filter_spec.rb