lutra 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8280ec08022d92e00986f7ac57545b6d07a38f8
+  data.tar.gz: 83530ac917e962aa083b6d71886d4738d53b7cbc
+SHA512:
+  metadata.gz: 9e8003a4e8026dd896dab97c941220c1d07c540e1ae0b9e3e7c1f998624054b17ee938c17d4144c8e35553aa9fa589363ba26ecf806bde636b90751679e2ecb6
+  data.tar.gz: b0abd8259bccd4425c3c035caf2a469dd89753c799f16e9cd662f518e61332a3fe5c4e47389c83f8d252b016cbfa87fd9aa06cc18114d539863f41d8da176293

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Yuri Artemev
+
+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,38 @@
+### lutra [![Gem version](https://badge.fury.io/rb/lutra.png)](https://rubygems.org/gems/lutra) [![Build Status](https://secure.travis-ci.org/artemeff/lutra.png)](https://travis-ci.org/artemeff/lutra) [![Code Climate](https://codeclimate.com/github/artemeff/lutra.png)](https://codeclimate.com/github/artemeff/lutra)
+
+---
+
+In source annotations parser;
+
+---
+
+### Installation
+
+```bash
+$ gem install lutra
+```
+
+### Usage
+
+```bash
+$ lutra [OPTIONS] [PATH]
+```
+
+```
+Usage: lutra [OPTIONS] [PATH]
+    -t, --tags=TAG                   Search for custom tags
+    -c, --comments=COM               Specify comment lines
+    -f, --formatter=NAME             Use your own formatter
+    -v, --verbose                    Verbose output
+        --hide-tags                  Hide tags
+```
+
+---
+
+### 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/bin/lutra

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'find'
+require 'lutra'
+
+verbose  = false
+color    = STDOUT.tty?
+usage    = 'Usage: lutra [OPTIONS] [PATH]'
+tags     = Lutra::TAGS.dup
+comments = Lutra::COMM.dup
+display_tags = true
+formatter_name = :default
+
+ARGV.options do |o|
+  o.version = Lutra::VERSION
+  o.banner = usage
+  o.on('-t', '--tags=TAG', 'Search for custom tags') do |tag|
+    tags |= [tag]
+  end
+
+  o.on('-c', '--comments=COM', 'Specify comment lines') do |com|
+    comments |= [com]
+  end
+
+  o.on('-f', '--formatter=NAME', 'Use your own formatter') do |name|
+    formatter_name = name.to_sym
+  end
+
+  o.on('-v', '--verbose', 'Verbose output') do
+    verbose = true
+  end
+
+  o.on('--hide-tags', 'Hide tags') do
+    display_tags = false
+  end
+end
+
+begin
+  ARGV.options.parse!
+  if ARGV.empty?
+    paths = '.'
+  else
+    paths = ARGV.map { |p| File.exist? p or raise Errno::ENOENT, p ; p }
+  end
+rescue => e
+  STDERR.puts "lutra: #{e.message}"
+  STDERR.puts usage
+  STDERR.puts "Try 'lutra --help' for more information"
+  exit 1
+end
+
+scanner = Lutra::Scanner.new(tags: tags, comments: comments)
+
+Find.find(*paths) do |path|
+  unless paths.include?(path)
+    Find.prune if File.basename(path).start_with?('.')
+  end
+
+  next if File.directory?(path)
+
+  begin
+    scanner.scan_file(path)
+  rescue Errno::ENOENT => e
+    STDERR.puts "lutra: #{e.message} (broken symlink?)" if verbose
+  rescue => e
+    STDERR.puts "lutra: #{path}: #{e.message}" if verbose
+  end
+end
+
+formatter = Lutra::Formatter.new(display_tags: display_tags)
+formatter.set(formatter_name)
+formatter.display(scanner.notes)
+
+exit

data/lib/lutra/formatter.rb

@@ -0,0 +1,43 @@
+module Lutra
+  class Formatter
+    attr_reader :formatters, :current
+
+    def initialize(options = {})
+      @options = options
+      @current = :default
+      @formatters = [
+        { name: :default, short: :d, class: Lutra::Formatters::Default }
+      ]
+    end
+
+    def get(name)
+      @formatters.select do |f|
+        f[:name] == name || f[:short] == name
+      end.first
+    end
+
+    def set(name)
+      if get(name)
+        @current = name
+      else
+        raise FormatterNotFound
+      end
+    end
+
+    def add(name, short_name, class_name)
+      if formatter?(class_name)
+        @formatters << { name: name, short: short_name, class: class_name }
+      end
+    end
+
+    def display(notes)
+      get(@current)[:class].new(@options).display(notes)
+    end
+
+  private
+
+    def formatter?(class_name)
+      class_name.new.respond_to?(:prepare)
+    end
+  end
+end

data/lib/lutra/formatters/base.rb

@@ -0,0 +1,13 @@
+module Lutra
+  module Formatters
+    class Base
+      def initialize(options = {})
+        @options = options
+      end
+
+      def display(notes)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/lutra/formatters/default.rb

@@ -0,0 +1,23 @@
+module Lutra
+  module Formatters
+    class Default < Lutra::Formatters::Base
+      def display(notes)
+        indent = notes.map(&:line).flatten.max.to_s.size
+
+        notes.group_by { |n| n.file }.each do |file, notes|
+          puts "#{file[2..-1]}:"
+          notes.each do |note|
+            puts " * #{prepare(note, indent)}"
+          end
+          puts
+        end
+      end
+
+      def prepare(note, indent)
+        s =  "[#{note.line.to_s.rjust(indent)}] "
+        s << "[#{note.tag}] " if @options[:display_tags]
+        s << note.text
+      end
+    end
+  end
+end

data/lib/lutra/note.rb

@@ -0,0 +1,23 @@
+module Lutra
+  class Note
+    attr_reader :tag, :source, :line, :file
+
+    def initialize(data)
+      @tag    = data[:tag]
+      @line   = data[:line]
+      @file   = data[:file]
+      @source = data[:source]
+    end
+
+    def text
+      extract[:text]
+    end
+
+  private
+
+    def extract
+      @source =~ /(#{@tag})\s(.*)/
+      { tag: $1, text: $2 }
+    end
+  end
+end

data/lib/lutra/scanner.rb

@@ -0,0 +1,46 @@
+module Lutra
+  class Scanner
+    attr_accessor :tags, :comments
+    attr_reader :notes
+
+    def initialize(options = {})
+      @tags = options[:tags] || TAGS.dup
+      @comments = options[:comments] || COMM.dup
+      @notes = []
+    end
+
+    def scan(source)
+      check_tags and check_comments
+      extract(source.split("\n")) and self
+    end
+
+    def scan_file(path)
+      check_tags and check_comments
+      extract(File.open(path), path) and self
+    end
+
+  private
+
+    def extract(source, path = nil)
+      rxp = regexp
+      source.each_with_index do |line, i|
+        if rxp =~ line
+          raw = { tag: $1, source: line, line: i + 1, file: path }
+          @notes << Note.new(raw)
+        end
+      end
+    end
+
+    def check_tags
+      raise EmptyTagListError if @tags.empty?
+    end
+
+    def check_comments
+      raise EmptyCommentListError if @comments.empty?
+    end
+
+    def regexp
+      /(#{@comments.join('|')})\s*(?<tag>#{@tags.join('|')})\s*(?<text>.*)/
+    end
+  end
+end

data/lib/lutra/version.rb

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

data/lib/lutra.rb

@@ -0,0 +1,17 @@
+require 'lutra/note'
+require 'lutra/scanner'
+require 'lutra/formatter'
+require 'lutra/formatters/base'
+require 'lutra/formatters/default'
+require 'lutra/version'
+
+module Lutra
+  TAGS = %w[TODO FIXME OPTIMIZE]
+  COMM = %w[# % ; // --]
+
+  # errors
+  class NotImplementedError < Exception; end
+  class EmptyTagListError < Exception; end
+  class EmptyCommentListError < Exception; end
+  class FormatterNotFound < Exception; end
+end

data/lutra.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "lutra/version"
+
+Gem::Specification.new do |s|
+  s.name = "lutra"
+  s.version = Lutra::VERSION
+  s.authors = ["Yuri Artemev"]
+  s.email = ["i@artemeff.com"]
+  s.homepage = "http://github.com/artemeff/lutra"
+  s.summary = %q{In source annotaions parser}
+  s.description = %q{Parse tags (todo, fixme, optimize) in your source code}
+  s.licenses = ['MIT']
+
+  s.files = %w(README.md LICENSE lutra.gemspec)
+  s.files += Dir.glob("lib/**/*.rb")
+  s.files += Dir.glob("spec/**/*")
+  s.require_paths = ['lib']
+  s.test_files = Dir.glob("spec/**/*")
+
+  s.executables << 'lutra'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '>= 2.1'
+end

data/spec/example

@@ -0,0 +1,4 @@
+# TODO sample todo
+% FIXME sample fixme
+; OPTIMIZE sample optimize 
+TODO don't catch

data/spec/formatter_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Lutra::Formatter do
+  subject { described_class }
+
+  context ".new" do
+    it "have one formatter" do
+      expect(subject.new.formatters.size).to eq(1)
+    end
+
+    it "have default formatter" do
+      expect(subject.new.formatters.first[:name]).to eq(:default)
+    end
+  end
+
+  context "#add" do
+    it "adds new formatter" do
+      expect(subject.new.add(:new, :n, Lutra::Formatters::Default).size).to eq(2)
+    end
+  end
+
+  context "#get" do
+    subject { described_class.new }
+
+    it "finds formatter by name" do
+      expect(subject.get(:default)[:name]).to eq(:default)
+    end
+
+    it "finds formatter short name" do
+      expect(subject.get(:d)[:name]).to eq(:default)
+    end
+  end
+
+  context "#set" do
+    subject { described_class.new }
+
+    it "sets default formatter" do
+      subject.set(:default)
+      expect(subject.current).to eq(:default)
+    end
+
+    it "raise error when formatter dont exist" do
+      expect {
+        subject.set(:poke)
+      }.to raise_error(Lutra::FormatterNotFound)
+    end
+  end
+
+  it "#print"
+end

data/spec/formatters/base_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Lutra::Formatters::Base do
+  subject { described_class }
+
+  it ".new raise exception" do
+    expect {
+      subject.new.display([])
+    }.to raise_error(Lutra::NotImplementedError)
+  end
+end

data/spec/formatters/default_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Lutra::Formatters::Default do
+  subject { described_class }
+
+  it "#display"
+end

data/spec/lutra_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Lutra do
+end

data/spec/note_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Lutra::Note do
+  subject do
+    raw = { tag: 'X', source: 'X text', line: 1, file: 'ex.rb' }
+    described_class.new(raw)
+  end
+
+  it "#tag" do
+    expect(subject.tag).to eq 'X'
+  end
+
+  it "#source" do
+    expect(subject.source).to eq 'X text'
+  end
+
+  it "#line" do
+    expect(subject.line).to eq 1
+  end
+
+  it "#file" do
+    expect(subject.file).to eq 'ex.rb'
+  end
+
+  it "#text" do
+    expect(subject.text).to eq 'text'
+  end
+end

data/spec/scanner_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Lutra::Scanner do
+  subject { described_class }
+
+  context ".new" do
+    it "with default tags" do
+      expect(subject.new.tags).to eq ['TODO', 'FIXME', 'OPTIMIZE']
+    end
+
+    it "with custom tags" do
+      expect(subject.new(tags: ['X']).tags).to eq ['X']
+    end
+
+    it "with default comments" do
+      expect(subject.new.comments).to eq ["#", "%", ";", "//", "--"]
+    end
+
+    it "with custom comments" do
+      expect(subject.new(comments: ['#']).comments).to eq ["#"]
+    end
+  end
+
+  context "#scan_file" do
+    let(:notes) do
+      subject.new.scan_file("#{File.dirname(__FILE__)}/example").notes
+    end
+
+    it "have todo, fixme and optimize" do
+      expect(notes.map(&:tag)).to eq ['TODO', 'FIXME', 'OPTIMIZE']
+    end
+  end
+
+  context "#scan" do
+    let(:notes) { subject.new.scan(example_data).notes }
+
+    it "have todo, fixme and optimize" do
+      expect(notes.map(&:tag)).to eq ['TODO', 'FIXME', 'OPTIMIZE']
+    end
+
+    it "have only 3 items" do
+      expect(notes.size).to eq 3
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'lutra'
+
+def example_data
+  File.open("#{File.dirname(__FILE__)}/example").read
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: lutra
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuri Artemev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Parse tags (todo, fixme, optimize) in your source code
+email:
+- i@artemeff.com
+executables:
+- lutra
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lutra.gemspec
+- lib/lutra/formatter.rb
+- lib/lutra/formatters/base.rb
+- lib/lutra/formatters/default.rb
+- lib/lutra/note.rb
+- lib/lutra/scanner.rb
+- lib/lutra/version.rb
+- lib/lutra.rb
+- spec/example
+- spec/formatter_spec.rb
+- spec/formatters/base_spec.rb
+- spec/formatters/default_spec.rb
+- spec/lutra_spec.rb
+- spec/note_spec.rb
+- spec/scanner_spec.rb
+- spec/spec_helper.rb
+- bin/lutra
+homepage: http://github.com/artemeff/lutra
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.1.4
+signing_key: 
+specification_version: 4
+summary: In source annotaions parser
+test_files:
+- spec/example
+- spec/formatter_spec.rb
+- spec/formatters/base_spec.rb
+- spec/formatters/default_spec.rb
+- spec/lutra_spec.rb
+- spec/note_spec.rb
+- spec/scanner_spec.rb
+- spec/spec_helper.rb