what_now 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bda060f1e69ee13c7863be908c04c2989b9953f
-  data.tar.gz: 684fab111d73886ed178aaf1a0f28d84d9854250
+  metadata.gz: 7a13ab4077826fea72978ebdc4df7590224becb4
+  data.tar.gz: 4cbc448fe9fed549a45158f1e958490783b42827
 SHA512:
-  metadata.gz: f969b650b7a3b9fe07e207d731cefc7182122b67a165b09e4385bf7e56701588d92455aec1fb4009f958cbc38d699fb81c90a29566d3527011ab223b81b6152f
-  data.tar.gz: 18818e1895703b3274cc474751149245bc557d00ffed62626360342320fecac3f78da537aaf3c1a336221c6de75aa349c11cc02d8ab68ffdd8e3669e71cbb300
+  metadata.gz: 7f845892a4cae2342b01ff3e31b8ae8efba71b57551b396c8c88bb2aea35a7529a3db13eebc17436210f471f10f9956d0701a2db902a5a15905e80dae81f1be2
+  data.tar.gz: c5dccc5be39cade9d1f0ae61af352ed70a8da55fea24d29c030c39d60100d5afcda1f5ba5448a1ea7e6e70b0c31c273acef6c89f0b8f11fe3611840e8ddc34d1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Edgar Cabrera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+what_now
+========
+
+Executable (packed as a ruby gem) for finding TODO comments inside code
+Requires Ruby 1.9.* and above
+
+
+Installation
+---------
+If you use rbenv or RVM:
+```
+gem install what_now
+```
+Otherwise you might need
+```
+sudo gem install what_now
+```
+
+
+Usage
+-----
+```
+$ wnow
+```
+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*).

data/lib/what_now.rb

@@ -7,7 +7,7 @@ Todo = Struct.new :text, :path, :line
 module WhatNow
   class << self
     def search_line(line, line_number, path)
-      text = /TODO[:\s]*\s(.+)$/.match(line)
+      text = /TODO:?\s*(.+)$/i.match(line)
       Todo.new(text[1], line_number, path) if text
     end
 

data/spec/example_file.txt

@@ -0,0 +1,5 @@
+This is a normal line
+TODO this is a todo
+this is another line
+and this is another
+TODO: but this is also a todo

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/reporters'
+
+Minitest::Reporters.use!
+
+Dir[File.dirname(__FILE__) + '/../lib/**/*.rb'].each do |rb_file|
+  require rb_file
+end

data/spec/what_now_spec.rb

@@ -0,0 +1,57 @@
+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
+    subject do
+      WhatNow.search_line('TODO this is a todo', 1, '.')
+    end
+
+    it 'correctly extracts text from todo' do
+      subject.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, '.')
+        .must_be_nil 
+    end
+  end
+
+  describe '#search_file' do
+    subject do
+      path = File.dirname(__FILE__) + '/example_file.txt'
+      WhatNow.search_file(path)
+    end
+
+    it 'found 2 todos' do
+      subject.length.must_equal 2
+    end
+
+    it 'found the correct todos' do
+      subject[0].text.must_match 'this is a todo'
+      subject[0].line.must_equal 2
+      subject[1].text.must_match 'but this is also a todo'
+      subject[1].line.must_equal 5
+    end
+  end
+
+  describe '#search_directory' do
+    it 'considers only specified pattern' do
+      results = WhatNow.search_directory(File.dirname(__FILE__)+'/**/*.txt')
+      results.length.must_equal 2
+    end
+
+    it 'returns empty array if nothing was found' do
+      results = WhatNow.search_directory(File.dirname(__FILE__)+'/**/*.mooo')
+      results.must_equal []
+    end
+  end
+end

data/what_now.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'what_now'
+  s.version     = '0.0.3'
+  s.date        = '2014-02-27'
+  s.summary     = 'Find todo comments in your code'
+  s.description = 'Executable for finding todo comments on directories'
+  s.authors     = ['Edgar Cabrera']
+  s.email       = 'edgar@cafeinacode.com'
+  s.license			= 'MIT'
+  s.homepage    = 'https://github.com/aleandros/what_now'
+  s.files       = %w(what_now.gemspec LICENSE README.md)
+  s.files       += Dir['lib/*.rb'] + Dir['bin/*']
+  s.test_files  = Dir['spec/*']
+  s.executables << 'wnow'
+
+  s.add_dependency 'thor'
+  s.add_dependency 'colorize'
+  s.add_dependency 'ptools'
+
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'rake'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: what_now
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Edgar Cabrera
@@ -9,7 +9,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-02-27 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
@@ -17,8 +87,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/what_now.rb
+- LICENSE
+- README.md
 - bin/wnow
+- lib/what_now.rb
+- spec/example_file.txt
+- spec/spec_helper.rb
+- spec/what_now_spec.rb
+- what_now.gemspec
 homepage: https://github.com/aleandros/what_now
 licenses:
 - MIT
@@ -29,19 +105,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Find todo comments in your code
-test_files: []
-has_rdoc: 
+test_files:
+- spec/spec_helper.rb
+- spec/what_now_spec.rb
+- spec/example_file.txt