what_now 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22e94ada9391a63cbcf79bb1d3a4ca9f6f6962e2
-  data.tar.gz: ad69ca1e8fac29ee9e76c27177e98c082a27b6b2
+  metadata.gz: c129b4ea1aed4491608b1aa54462eb469f06f69b
+  data.tar.gz: 25a68c0f5b0fd9048c495cdb18447050f846a43f
 SHA512:
-  metadata.gz: 48e5808a0a2fa8f506ebc1db6ea30db35d0061393aba017dcde97c21b8986326eb750edefcbcb8fbffae8310d042aa082db65fb882f99b7d4a2341db4d80af4d
-  data.tar.gz: 9bd24a4355ee83214fcc4a68c1a5e266844e2ed574f19678ae30c95b754de423b40aa2e5ab3a1ed75e948e5fd911614308155781912f0bb00f72abaf07417d3d
+  metadata.gz: 16dec7d805e9ba4759b3b2835b597e7e31f57bed8828b74dbd3d00d8a8116db1e0d1425e881e12a1027c06aa962ea51c73ad3386abdf8fb3b5748107cab4652a
+  data.tar.gz: 73ef733a215b66af92f7d3fadbc9b9deaed33be14f273480a4601273d2650a289ae05a29f17969e510e9e4a6855e08afb9c61203466ee2706fb8846cb1acb739

data/bin/wnow

@@ -13,13 +13,12 @@ class Wnow < Thor
   def find
     dir = options[:dir] || Dir.pwd
     ext = options[:ext] ? "/**/*.#{options[:ext]}" : '/**/*.*'
-    WhatNow.ignorecase if options[:ignorecase]
-    todos = WhatNow.search_directory(dir + ext)
-    todos.each do |t|
-      printable_path = options[:dir] ? t.path : t.path[Dir.pwd.length+1..t.path.length]
-      puts t.text.red.bold
-      puts "at line #{t.line.to_s.blue} in #{printable_path.blue.underline}"
-      puts
+    creator = TodoCreator.new(
+      ignorecase: options[:ignorecase],
+      pretty: STDOUT.tty?)
+    TodoFinder.new(dir + ext, creator).find.each do |todo|
+      puts todo
+      puts if STDOUT.tty?
     end
   end
 end

data/lib/todo.rb

@@ -0,0 +1,24 @@
+# Contains the abstractions related
+# to todo's objects
+require 'colorize'
+
+class Todo
+  attr_reader :text, :path, :line
+
+  def initialize text, path, line
+    @text = text
+    @path = path
+    @line = line
+  end
+
+  def to_s
+    "#{@text} at line #{@line} in #{@path}"
+  end
+end
+
+class PrettyTodo < Todo
+  def to_s
+    "#{@text.red.bold}\nat line #{@line.to_s.blue} in #{@path.blue.underline}"
+  end
+end
+

data/lib/what_now.rb

@@ -1,34 +1,45 @@
 # What_now definitions
 
 require 'ptools'
+require 'todo'
 
-# TODO this struct should know how to print itself
-Todo = Struct.new :text, :path, :line
+class TodoCreator
+  def initialize(opts={})
+    pretty = opts.fetch(:pretty, true)
+    @ignorecase = opts[:ignorecase]
+    @todo_class = pretty ? PrettyTodo : Todo
+  end
 
-module WhatNow
-  class << self
+  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
+  rescue ArgumentError
+    nil
+  end
 
-    def ignorecase
-      @ignorecase = true
-    end
+  private
+  def shortened_path(path)
+    path[Dir.pwd.length+1..path.length]
+  end
+end
 
-    def search_line(line, line_number, path)
-      regex = @ignorecase ? /TODO:?\s*(.+)$/i : /TODO:?\s*(.+)$/
-      text = regex.match(line)
-      Todo.new(text[1], line_number, path) if text
+class TodoFinder
+  def initialize(pattern, creator)
+    @paths = Dir[pattern].delete_if do |path|
+      File.directory?(path) || File.binary?(path)
     end
+    @creator = creator
+  end
 
-    def search_file(path)
-      return [] if File.binary? path
-      File.open(path).each_with_index.map do |line, i|
-        search_line(line, path, i+1)
-      end.delete_if { |l| l.nil? }
-    end
+  def find
+    @paths.flat_map { |file| search_file(file) }
+  end
 
-    def search_directory(pattern)
-      Dir[pattern].flat_map do |file|
-        search_file(file)
-      end
-    end
+  private
+  def search_file(path)
+    File.open(path).each_with_index.map do |line, i|
+      @creator.match(line, path, i+1)
+    end.delete_if { |l| l.nil? }
   end
 end

data/spec/todo_spec.rb

@@ -0,0 +1,33 @@
+require_relative 'spec_helper'
+require 'colorize'
+
+describe Todo do
+  subject { Todo.new('do stuff', './stuff', 10) }
+
+  describe 'public interface' do
+    it { subject.must_respond_to :text }
+    it { subject.must_respond_to :path }
+    it { subject.must_respond_to :line }
+  end
+
+  describe '#to_s' do
+    it 'should respond with a simple task description' do
+      subject.to_s.must_equal "do stuff at line 10 in ./stuff"
+    end
+  end
+end
+
+describe PrettyTodo do
+  subject { PrettyTodo.new('do stuff', './stuff', 10) }
+
+  it 'shoul be a Todo' do
+    subject.must_be_kind_of Todo
+  end
+
+  it 'correctly formats the output' do
+    output = subject.text.red.bold + "\n"
+    output += "at line #{subject.line.to_s.blue} in #{subject.path.blue.underline}"
+    subject.to_s.must_equal output
+  end
+end
+

data/spec/what_now_spec.rb

@@ -1,57 +1,63 @@
 require_relative 'spec_helper'
 
-describe Todo do
-  describe 'public interface' do
-    subject { Todo.new('do stuff', './stuff', 10) }
-    it { subject.must_respond_to :text }
-    it { subject.must_respond_to :path }
-    it { subject.must_respond_to :line }
-  end
-end
-
-describe WhatNow do
-  describe '#search_line' do
+describe TodoCreator do
+  describe '#match' do
     describe 'with case sensitivity' do
       subject do
-        WhatNow.search_line('TODO this is a todo', 1, '.')
+        TodoCreator.new
       end
 
       it 'correctly extracts text from todo' do
-        subject.text.must_match 'this is a todo'
+        subject.match('TODO this is a todo', '.', 1)
+          .text.must_match 'this is a todo'
       end
 
       it 'returns nil with a non todo line' do
-        WhatNow.search_line('this is not a todo', 1, '.')
+        subject.match('this is not a todo', '.', 1)
           .must_be_nil
       end
 
       it 'returns nil in a downcase todo' do
-        WhatNow.search_line('todo this is not a todo', 1, '.')
+        subject.match('todo this is not a todo', '.', 1)
           .must_be_nil
       end
     end
 
     describe 'with case insensitivity' do
-      before do
-        WhatNow.ignorecase
+      subject do
+        TodoCreator.new ignorecase: true
       end
 
       it 'extracts the text from the TODO in uppercase' do
-        WhatNow.search_line('TODO this is a todo', 1, '.')
+        subject.match('TODO this is a todo', '.', 1)
           .text.must_match 'this is a todo'
       end
 
       it 'extracts the text from the TODO in downcase' do
-        WhatNow.search_line('todo this is a todo', 1, '.')
+        subject.match('todo this is a todo', '.', 1)
           .text.must_match 'this is a todo'
       end
     end
+
+    describe 'object type returned' do
+      it 'default should be pretty' do
+        TodoCreator.new.match('TODO this is a todo', '.', 1)
+          .must_be_instance_of PrettyTodo
+      end
+
+      it 'non pretty can be specified' do
+        TodoCreator.new(pretty: false).match('TODO this is a todo', '.', 1)
+          .must_be_instance_of Todo
+      end
+    end
   end
+end
 
-  describe '#search_file' do
+describe TodoFinder do
+  describe 'search single file' do
     subject do
       path = File.dirname(__FILE__) + '/example_file.txt'
-      WhatNow.search_file(path)
+      TodoFinder.new(path, TodoCreator.new).find
     end
 
     it 'found 2 todos' do
@@ -66,14 +72,18 @@ describe WhatNow do
     end
   end
 
-  describe '#search_directory' do
+  describe 'search with a pattern' do
     it 'considers only specified pattern' do
-      results = WhatNow.search_directory(File.dirname(__FILE__)+'/**/*.txt')
+      results = TodoFinder.new(
+        File.dirname(__FILE__)+'/**/*.txt',
+        TodoCreator.new).find
       results.length.must_equal 2
     end
 
     it 'returns empty array if nothing was found' do
-      results = WhatNow.search_directory(File.dirname(__FILE__)+'/**/*.mooo')
+      results = TodoFinder.new(
+        File.dirname(__FILE__)+'/**/*.mooo',
+        TodoCreator.new).find
       results.must_equal []
     end
   end

data/what_now.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'what_now'
-  s.version     = '0.0.4'
+  s.version     = '0.0.5'
   s.date        = '2014-02-27'
   s.summary     = 'Find todo comments in your code'
   s.description = 'Executable for finding todo comments on directories'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: what_now
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Edgar Cabrera
@@ -90,9 +90,11 @@ files:
 - LICENSE
 - README.md
 - bin/wnow
+- lib/todo.rb
 - lib/what_now.rb
 - spec/example_file.txt
 - spec/spec_helper.rb
+- spec/todo_spec.rb
 - spec/what_now_spec.rb
 - what_now.gemspec
 homepage: https://github.com/aleandros/what_now
@@ -120,6 +122,7 @@ signing_key:
 specification_version: 4
 summary: Find todo comments in your code
 test_files:
-- spec/spec_helper.rb
 - spec/what_now_spec.rb
 - spec/example_file.txt
+- spec/spec_helper.rb
+- spec/todo_spec.rb