source_notes 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2004 David Heinemeier Hansson
+
+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.textile

@@ -0,0 +1,35 @@
+h1. Source Notes
+
+A modified version of "Rails":https://github.com/rails/rails SourceAnnotationExtractor.
+Hopefully to be a bit more generic and reusable.
+
+h2. Installation
+
+Add this line to your application's Gemfile:
+
+  @gem 'source_notes'@
+
+And then execute:
+
+  @bundle@
+
+Or install it yourself as:
+
+  @gem install source_notes@
+
+h2. Usage
+
+h2. Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+h2. TODOs
+
+- Add some instructions
+- Add tests
+- Rake-ify
+- Gemify

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/source_notes.rb

@@ -0,0 +1,108 @@
+require "source_notes/version"
+
+module SourceNotes
+  class Extractor
+    # 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 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 PWD
+    # Only filenames with extension +.builder+, +.rb+, +.erb+, +.haml+, +.slim+,
+    # +.css+, +.scss+, +.js+, and +.coffee+ 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(options)
+    end
+
+    attr_reader :tag
+
+    def initialize(tag, options = {})
+      @tag = tag
+      @dirs = options[:dirs] || [Dir::pwd]
+    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(options={})
+      options[:indent] = find.map { |f, a| a.map(&:line) }.flatten.max.to_s.size
+      find.keys.sort.each do |file|
+        puts "#{file}:"
+        find[file].each do |note|
+          puts "  * #{note.to_s(options)}"
+        end
+        puts
+      end
+    end
+
+    private
+
+    # Returns a hash that maps filenames under +dirs+ (recursively) to arrays
+    # with their annotations.
+    def find
+      @dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
+    end
+
+    # Returns a hash that maps filenames under +dir+ (recursively) to arrays
+    # with their annotations. Only files with annotations are included, and only
+    # those with extension +.builder+, +.rb+, +.erb+, +.haml+, +.slim+, +.css+,
+    # +.scss+, +.js+, and +.coffee+
+    # 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)$/
+          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
+  end
+end

data/lib/source_notes/version.rb

@@ -0,0 +1,3 @@
+module SourceNotes
+  VERSION = "0.0.1"
+end

data/source_notes.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/source_notes/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["asmega"]
+  gem.email         = ["asmega@ph-lee.com"]
+  gem.description   = "Extract source notes aka annotations. Based on Rails SourceAnnotationExtractor."
+  gem.summary       = "Extract source notes aka annotations. Based on Rails SourceAnnotationExtractor."
+  gem.homepage      = "https://github.com/asmega/source_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.name          = "source_notes"
+  gem.require_paths = ["lib"]
+  gem.version       = SourceNotes::VERSION
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: source_notes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- asmega
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-20 00:00:00.000000000 Z
+dependencies: []
+description: Extract source notes aka annotations. Based on Rails SourceAnnotationExtractor.
+email:
+- asmega@ph-lee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.textile
+- Rakefile
+- lib/source_notes.rb
+- lib/source_notes/version.rb
+- source_notes.gemspec
+homepage: https://github.com/asmega/source_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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Extract source notes aka annotations. Based on Rails SourceAnnotationExtractor.
+test_files: []