annotations 0.1.1 → 0.1.2

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in annotations.gemspec
-gemspec
-
-# TODO: Test me
+gemspec

data/README.md

@@ -2,18 +2,20 @@
 
 Extracts and displays annotations from source code comments like these:
 
-  class MyModel
-    def find(id)
-      # TODO: Find the thing
-    end
+```ruby
+class MyModel
+  def find(id)
+    # TODO: Find the thing
   end
+end
+```
 
 The output looks like this:
 
-  ./lib/my_model.rb:
-    * [ 17] [TODO] Find the thing
+    ./lib/my_model.rb:
+      * [ 17] [TODO] Find the thing
 
-If this looks familiar from Rails, it's because Annotations is derived/forked from the annotations code in Rails 3.2.1, now extracted into its own gem so it can be used in non-Rails (or even non-Ruby) projects.
+Annotations is a standalone library derived from the notes tasks in Rails 3.2.1, extracted into its own gem so it can be used in non-Rails (or even non-Ruby) projects.
 
 Annotations looks for TODO, FIXME, and OPTIMIZE comments in the following kinds of source code files:
 
@@ -70,12 +72,12 @@ Annotations::RakeTask.new
 
 This will add the following tasks:
 
-  $ bundle exec rake -T notes
-  rake notes                     # Enumerate all annotations
-  rake notes:custom[annotation]  # Enumerate a custom annotation
-  rake notes:fixme               # Enumerate all FIXME annotations
-  rake notes:optimize            # Enumerate all OPTIMIZE annotations
-  rake notes:todo                # Enumerate all TODO annotations
+    $ bundle exec rake -T notes
+    rake notes                     # Enumerate all annotations
+    rake notes:custom[annotation]  # Enumerate a custom annotation
+    rake notes:fixme               # Enumerate all FIXME annotations
+    rake notes:optimize            # Enumerate all OPTIMIZE annotations
+    rake notes:todo                # Enumerate all TODO annotations
 
 If you want to name the tasks something other than "notes", just pass the name you want to use into `RakeTask.new`:
 
@@ -87,12 +89,22 @@ You can also set the default tag list when defining the task, using this block s
 
 ```ruby
 Annotations::RakeTask.new do |t|
-  # This will add an additional 'WTF' annotation; it will be included in 
+  # This will add an additional 'WTF' annotation; it will be included in
   # `rake notes`, and a `rake notes:wtf` task will be added
   t.tags = [:fixme, :optimize, :todo, :wtf]
 end
 ```
 
+Once your `Rakefile` is set up, run the tasks to view your notes:
+
+    rake notes
+
+### Runtime options
+
+**Filter by file extension:** Only display annotations for certain kinds of files. (Thanks for Gabriel Schammah for contributing this feature.)
+
+    rake notes:todo ext=js,rb,coffee
+
 ## Roadmap
 
 * Ability to set/limit the search path(s) for annotations (currently set to '.')

data/lib/annotations/extractor.rb

@@ -14,7 +14,6 @@ module Annotations
   # start with the tag optionally followed by a colon. Everything up to the end
   # of the line (or closing ERB comment tag) is considered to be their text.
   class Extractor
-    # TODO: Test me
     class Annotation < Struct.new(:line, :tag, :text)
 
       # Returns a representation of the annotation that looks like this:
@@ -25,7 +24,7 @@ module Annotations
       # Otherwise the string contains just line and text.
       def to_s(options={})
         s = "[%3d] " % line
-        s << "[#{tag}] " if options[:tag]
+        s << "[#{tag}] " if options[:show_tag]
         s << text
       end
     end
@@ -37,14 +36,15 @@ module Annotations
     #
     # This class method is the single entry point for the rake tasks.
     def self.enumerate(tag, options={})
-      extractor = new(tag)
+      extractor = new(tag, options)
       extractor.display(extractor.find, options)
     end
 
     attr_reader :tag
 
-    def initialize(tag)
+    def initialize(tag, options)
       @tag = tag
+      @extensions = options[:extensions]
     end
 
     # Returns a hash that maps filenames under +dirs+ (recursively) to arrays
@@ -63,13 +63,13 @@ module Annotations
     def find_in(dir)
       results = {}
 
-      Dir.glob("#{dir}/*") do |item|
-        next if File.basename(item)[0] == ?.
+      pattern = "#{dir}/**/*"
+      pattern += ".{#{@extensions}}" if @extensions
 
-        if File.directory?(item)
-          results.update(find_in(item))
-        # Ruby source code
-        elsif item =~ /\.(ru|builder|coffee|(r(?:b|xml|js)))$/
+      Dir.glob(pattern) do |item|
+        next if File.basename(item)[0] == ?. or File.directory?(item)
+
+        if item =~ /\.(ru|builder|coffee|(r(?:b|xml|js)))$/
           results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
         # Other Ruby source files (Rake, Bundler)
         elsif item =~ /(Rakefile|Gemfile|Guardfile)$/
@@ -111,4 +111,4 @@ module Annotations
       end
     end
   end
-end
+end

data/lib/annotations/rake_task.rb

@@ -10,7 +10,8 @@ module Annotations
     def initialize(name = :notes)
       @name = name
       @tags = [:optimize, :fixme, :todo]
-      yield self
+      @extensions = ENV["ext"]
+      yield self if block_given?
       define
     end
 
@@ -22,24 +23,24 @@ module Annotations
     def define
       desc "Enumerate all annotations"
       task name do
-        Annotations::Extractor.enumerate(tags_to_pattern, :tag => true)
+        Annotations::Extractor.enumerate(tags_to_pattern, :show_tag => true, :extensions => @extensions)
       end
 
       namespace name do
         tags.each do |tagname|
           desc "Enumerate all #{tagname.to_s.upcase} annotations"
           task tagname.to_sym do
-            Annotations::Extractor.enumerate(tagname.to_s.upcase, :tag => true)
+            Annotations::Extractor.enumerate(tagname.to_s.upcase, :show_tag => true, :extensions => @extensions)
           end
         end
 
         desc "Enumerate a custom annotation, specify with ANNOTATION=CUSTOM"
         task :custom, :annotation do |annotation|
           puts annotation
-          SourceAnnotationExtractor.enumerate ENV['ANNOTATION']
+          Annotations::Extractor.enumerate(ENV['ANNOTATION'], :extensions => @extensions)
         end
       end
     end
 
   end
-end
+end

data/lib/annotations/version.rb

@@ -1,3 +1,3 @@
 module Annotations
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotations
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000 Z
+date: 2012-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70138368469980 !ruby/object:Gem::Requirement
+  requirement: &70222080962560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70138368469980
+  version_requirements: *70222080962560
 description: Source code annotations, extracted from Rails.
 email:
 - ddemaree@gmail.com
@@ -51,12 +51,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2817081159239259207
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2817081159239259207
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11