rake-notes 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rake-notes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fabio Rehm
+
+MIT License
+
+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,36 @@
+# rake-notes
+
+`rake notes` task for non-Rails' projects (heavily based on Rails' one ;)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rake-notes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake-notes
+
+And add this line to your project's Rakefile:
+
+    require 'rake/notes/rake_task'
+
+
+## Acknowledgement
+
+Special thanks to everyone that contributed to the original
+[Rails' code](https://github.com/rails/rails/blob/master/railties/lib/rails/source_annotation_extractor.rb)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:test)
+
+task :default => [:test]

data/lib/rake/notes.rb

@@ -0,0 +1,3 @@
+require 'rake/notes/version'
+
+# Nothing to see here, see rake_task.rb

data/lib/rake/notes/rake_task.rb

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/tasklib'
+
+require 'rake/notes/source_annotation_extractor'
+
+module Rake
+  module Notes
+    class RakeTask < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      def initialize(*args)
+        yield self if block_given?
+
+        desc "Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)"
+        task :notes do
+          SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+        end
+
+        namespace :notes do
+          ["OPTIMIZE", "FIXME", "TODO"].each do |annotation|
+            desc "Enumerate all #{annotation} annotations"
+            task annotation.downcase.intern do
+              SourceAnnotationExtractor.enumerate annotation
+            end
+          end
+
+          desc "Enumerate a custom annotation, specify with ANNOTATION=CUSTOM"
+          task :custom do
+            SourceAnnotationExtractor.enumerate ENV['ANNOTATION']
+          end
+        end
+      end
+    end
+  end
+end
+
+Rake::Notes::RakeTask.new

data/lib/rake/notes/source_annotation_extractor.rb

@@ -0,0 +1,113 @@
+module Rake
+  module Notes
+    # From:
+    # https://github.com/rails/rails/blob/master/railties/lib/rails/source_annotation_extractor.rb
+    #
+    # Implements the logic behind the rake tasks for annotations like
+    #
+    #   rake notes
+    #   rake notes:optimize
+    #
+    # and friends. See <tt>rake -T notes</tt>.
+    #
+    # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
+    # represent the line where the annotation lives, its tag, and its text. Note
+    # the filename is not stored.
+    #
+    # Annotations are looked for in comments and modulus whitespace they have to
+    # 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 SourceAnnotationExtractor
+      RUBYFILES = %w( Vagrantfile Rakefile Puppetfile Gemfile )
+
+      class Annotation < Struct.new(:line, :tag, :text)
+        # Returns a representation of the annotation that looks like this:
+        #
+        #   [126] [TODO] This algorithm is simple and clearly correct, make it faster.
+        #
+        # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above.
+        # Otherwise the string contains just line and text.
+        def to_s(options={})
+          s = "[#{line.to_s.rjust(options[:indent])}] "
+          s << "[#{tag}] " if options[:tag]
+          s << text
+        end
+      end
+
+      # Prints all annotations with tag +tag+ under the current directory. Only
+      # known file types are taken into account. The +options+ hash is passed
+      # to each annotation's +to_s+.
+      #
+      # This class method is the single entry point for the rake tasks.
+      def self.enumerate(tag, options={})
+        extractor = new(tag)
+        extractor.display(extractor.find, options)
+      end
+
+      attr_reader :tag
+
+      def initialize(tag)
+        @tag = tag
+      end
+
+      # Returns a hash that maps filenames to arrays with their annotations.
+      def find
+        find_in('.')
+      end
+
+      # Returns a hash that maps filenames under +dir+ (recursively) to arrays
+      # with their annotations. Only files with annotations are included, and only
+      # known file types are taken into account.
+      def find_in(dir)
+        results = {}
+
+        Dir.glob("#{dir}/*") do |item|
+          next if File.basename(item)[0] == ?.
+
+          if File.directory?(item)
+            results.update(find_in(item))
+          elsif item =~ /\.(builder|rb|coffee|rake|pp|ya?ml|gemspec)$/ || RUBYFILES.include?(File.basename(item))
+            results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
+          elsif item =~ /\.(css|scss|js)$/
+            results.update(extract_annotations_from(item, /\/\/\s*(#{tag}):?\s*(.*)$/))
+          elsif item =~ /\.erb$/
+            results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/))
+          elsif item =~ /\.haml$/
+            results.update(extract_annotations_from(item, /-\s*#\s*(#{tag}):?\s*(.*)$/))
+          elsif item =~ /\.slim$/
+            results.update(extract_annotations_from(item, /\/\s*\s*(#{tag}):?\s*(.*)$/))
+          end
+        end
+
+        results
+      end
+
+      # If +file+ is the filename of a file that contains annotations this method returns
+      # a hash with a single entry that maps +file+ to an array of its annotations.
+      # Otherwise it returns an empty hash.
+      def extract_annotations_from(file, pattern)
+        lineno = 0
+        result = File.readlines(file).inject([]) do |list, line|
+          lineno += 1
+          next list unless line =~ pattern
+          list << Annotation.new(lineno, $1, $2)
+        end
+        result.empty? ? {} : { file => result }
+      end
+
+      # Prints the mapping from filenames to annotations in +results+ ordered by filename.
+      # The +options+ hash is passed to each annotation's +to_s+.
+      def display(results, options={})
+        options[:indent] = results.map { |f, a| a.map(&:line) }.flatten.max.to_s.size
+        out = options.delete(:out) || $stdout
+        results.keys.sort.each do |file|
+          out.puts "#{file[2..-1]}:"
+          results[file].each do |note|
+            out.puts "  * #{note.to_s(options)}"
+          end
+          out.puts
+        end
+      end
+    end
+  end
+end

data/lib/rake/notes/version.rb

@@ -0,0 +1,5 @@
+module Rake
+  module Notes
+    VERSION = "0.0.1"
+  end
+end

data/rake-notes.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake/notes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rake-notes"
+  gem.version       = Rake::Notes::VERSION
+  gem.authors       = ["Fabio Rehm"]
+  gem.email         = ["fgrehm@gmail.com"]
+  gem.description   = "rake notes task for non-Rails' projects"
+  gem.summary       = "rake notes task for non-Rails' projects"
+  gem.homepage      = "https://github.com/fgrehm/rake-notes"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rake'
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/rake/notes/source_annotation_extractor_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+require 'rake/notes/source_annotation_extractor'
+
+describe Rake::Notes::SourceAnnotationExtractor do
+  let(:fixture_path) { "#{Dir.pwd}/.tmp" }
+
+  before do
+    @current_path = Dir.pwd
+    Dir.mkdir(fixture_path) unless Dir.exist?(fixture_path)
+    Dir.chdir(fixture_path)
+  end
+
+  after do
+    Dir.chdir(@current_path)
+  end
+
+  context 'extracting notes based on file type' do
+    subject do
+      subj = StringIO.new
+      described_class.enumerate('TODO', :out => subj)
+      subj.string
+    end
+
+    before(:all) do
+      fixture_file "index.html.erb", "<% # TODO: note in erb %>"
+      fixture_file "index.html.haml", "- # TODO: note in haml"
+      fixture_file "index.html.slim", "/ TODO: note in slim"
+      fixture_file "application.js.coffee", "# TODO: note in coffee"
+      fixture_file "application.js", "// TODO: note in js"
+      fixture_file "application.css", "// TODO: note in css"
+      fixture_file "application.css.scss", "// TODO: note in scss"
+      fixture_file "application_controller.rb", 1000.times.map { "" }.join("\n") << "# TODO: note in ruby"
+      fixture_file "task.rake", "# TODO: note in rake"
+      fixture_file "init.pp", "# TODO: note in puppet"
+      fixture_file "config.yml", "# TODO: note in yml"
+      fixture_file "config.yaml", "# TODO: note in yaml"
+      fixture_file "gem.gemspec", "# TODO: note in gemspec"
+      fixture_file "Vagrantfile", "# TODO: note in vagrantfile"
+      fixture_file "Rakefile", "# TODO: note in rakefile"
+      fixture_file "Puppetfile", "# TODO: note in puppetfile"
+      fixture_file "Gemfile", "# TODO: note in gemfile"
+    end
+
+    it { should match(/note in erb/) }
+    it { should match(/note in haml/) }
+    it { should match(/note in slim/) }
+    it { should match(/note in ruby/) }
+    it { should match(/note in coffee/) }
+    it { should match(/note in js/) }
+    it { should match(/note in css/) }
+    it { should match(/note in scss/) }
+    it { should match(/note in rake/) }
+    it { should match(/note in puppet/) }
+    it { should match(/note in yml/) }
+    it { should match(/note in yaml/) }
+    it { should match(/note in gemspec/) }
+    it { should match(/note in vagrantfile/) }
+    it { should match(/note in rakefile/) }
+    it { should match(/note in puppetfile/) }
+    it { should match(/note in gemfile/) }
+  end
+
+  def fixture_file(path, contents)
+    FileUtils.mkdir_p File.dirname("#{fixture_path}/#{path}")
+    File.open("#{fixture_path}/#{path}", 'w') do |f|
+      f.puts contents
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+Bundler.require(:default)
+
+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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rake-notes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fabio Rehm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: rake notes task for non-Rails' projects
+email:
+- fgrehm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rake/notes.rb
+- lib/rake/notes/rake_task.rb
+- lib/rake/notes/source_annotation_extractor.rb
+- lib/rake/notes/version.rb
+- rake-notes.gemspec
+- spec/rake/notes/source_annotation_extractor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fgrehm/rake-notes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2814637587116714080
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2814637587116714080
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: rake notes task for non-Rails' projects
+test_files:
+- spec/rake/notes/source_annotation_extractor_spec.rb
+- spec/spec_helper.rb