lutra 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59d911ed406e63282be41712f2613b7225d13dd6
-  data.tar.gz: e6c90ff275373cbba0eafd9cdd53ab413cd6c226
+  metadata.gz: 7f8c765a1000685a3016a70883f677a1b04f2d8e
+  data.tar.gz: 28ebafeccba7985f66f792eb95147612458df62a
 SHA512:
-  metadata.gz: a815072f42e68d1705c0812ad8207dffdef13eae9e29375f6fe2f845734d5ff9721c0d77f7038a0cc46567cd4beffc9b76a559a20421a1a1be3ab74461088d3d
-  data.tar.gz: 950dd6dc571266a999899157e985f4f3cd6a84aad890dcfdc72ba049fa36701e0d8c5694f0e72ef99df059e17e2433ca42fc7e3b9248024e7ba17dc9b37a7550
+  metadata.gz: 9033f3b86c5bd1faf8c709a02397995420b7f35e36652b8d8cb523af488e818a316a6235470de8458cbf0d01e9ff76f4d1fa54a4ca5e791525838364c795ce6e
+  data.tar.gz: 910a84648c31d3ae93d903f50c625e52302a4d77ebd2ae44ed36064331244da48efd8d6234ec705387f5a236dccdd18694aa80053f58275aebc094593458854e

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Yuri Artemev
+Copyright (c) 2015 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

data/README.md

@@ -1,4 +1,4 @@
-### 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)
+### lutra [![Gem version](https://img.shields.io/gem/v/lutra.svg)](https://rubygems.org/gems/lutra) [![Build Status](https://img.shields.io/travis/artemeff/lutra.svg)](https://travis-ci.org/artemeff/lutra) [![Code Climate](https://img.shields.io/codeclimate/github/artemeff/lutra.svg)](https://codeclimate.com/github/artemeff/lutra)
 
 ---
 

data/lib/lutra/formatter.rb

@@ -1,19 +1,19 @@
+require 'lutra/formatter_entry'
+
 module Lutra
   class Formatter
     attr_reader :formatters, :current
 
     def initialize(options = {})
-      @options = default_options.merge(options)
+      @options = options
       @current = :default
-      @formatters = [
-        { name: :default, short: :d, class: Lutra::Formatters::Default }
-      ]
+      @formatters = [default_formatter]
     end
 
     def get(name)
-      @formatters.select do |f|
-        f[:name] == name || f[:short] == name
-      end.first
+      @formatters.find do |f|
+        f.name == name || f.short == name
+      end
     end
 
     def set(name)
@@ -26,25 +26,22 @@ module Lutra
 
     def add(name, short_name, class_name)
       if formatter?(class_name)
-        @formatters << { name: name, short: short_name, class: class_name }
+        @formatters << FormatterEntry.new(name, short_name, class_name)
       end
     end
 
     def display(notes)
-      get(@current)[:class].new(@options).display(notes)
+      get(@current).class_name.new(@options).display(notes)
     end
 
   private
 
     def formatter?(class_name)
-      class_name.new.respond_to?(:prepare)
+      class_name.new.respond_to?(:display)
     end
 
-    def default_options
-      {
-        display_tags: true,
-        text_size: 55
-      }
+    def default_formatter
+      FormatterEntry.new(:default, :d, Lutra::Formatters::Default)
     end
   end
 end

data/lib/lutra/formatter_entry.rb

@@ -0,0 +1,3 @@
+module Lutra
+  FormatterEntry = Struct.new(:name, :short, :class_name)
+end

data/lib/lutra/formatters/base.rb

@@ -1,13 +1,24 @@
 module Lutra
   module Formatters
     class Base
+      attr_reader :options
+
       def initialize(options = {})
-        @options = options
+        @options = default_options.merge(options)
       end
 
       def display(notes)
         raise NotImplementedError
       end
+
+    private
+
+      def default_options
+        {
+          display_tags: true,
+          text_size: 55
+        }
+      end
     end
   end
 end

data/lib/lutra/formatters/default.rb

@@ -14,10 +14,10 @@ module Lutra
       end
 
       def prepare(note, indent)
-        s =  "[#{note[:line].to_s.rjust(indent)}] "
-        s << "[#{note[:tag]}] " if @options[:display_tags]
-        s << note[:text][0..@options[:text_size]].strip.chomp
-        s << "..." if note[:text].size > @options[:text_size]
+        s =  "[#{note.line.to_s.rjust(indent)}] "
+        s << "[#{note.tag}] " if options[:display_tags]
+        s << note.text[0..options[:text_size]].strip.chomp
+        s << '...' if note.text.size > options[:text_size]
         s
       end
 

data/lib/lutra/note.rb

@@ -1,3 +1,3 @@
 module Lutra
-  Note = Struct.new(:tag, :text, :line, :file)
+  Note = Struct.new(:tag, :comment, :text, :line, :file)
 end

data/lib/lutra/scanner.rb

@@ -1,14 +1,16 @@
+require 'lutra/note'
+
 module Lutra
   class Scanner
     attr_accessor :tags, :comments
     attr_reader :notes
 
-    def initialize(tags = nil, comments = nil)
-      @tags     = tags || Lutra::TAGS
-      @comments = comments || Lutra::COMM
-      @notes    = []
+    def initialize(tags: Lutra::TAGS, comments: Lutra::COMMENTS)
+      raise EmptyTagListError if tags.empty?
+      raise EmptyCommentListError if comments.empty?
 
-      check_tags and check_comments
+      @tags, @comments = tags, comments
+      @notes = []
     end
 
     def scan_file(path)
@@ -18,24 +20,17 @@ module Lutra
   private
 
     def extract(source, path)
-      rxp = regexp
+      regexp = compile_regexp(@comments, @tags)
+
       source.each_with_index do |line, i|
-        if r = rxp.match(line)
-          @notes << Note.new(r[:tag], r[:text], i + 1, path)
+        if result = regexp.match(line)
+          @notes << Note.new(result[:tag], result[:comment], result[:text], i + 1, path)
         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>.*)/
+    def compile_regexp(comments, tags)
+      /(?<comment>#{comments.join('|')})\s*(?<tag>#{tags.join('|')})[\s|\:]*(?<text>.*)/
     end
   end
 end

data/lib/lutra/version.rb

@@ -1,3 +1,3 @@
 module Lutra
-  VERSION = "0.0.3"
+  VERSION = '0.1.0'
 end

data/lib/lutra.rb

@@ -1,17 +1,14 @@
-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[# % ; // --]
+  COMMENTS = %w[# % ; // --]
 
-  # errors
-  class NotImplementedError < Exception; end
-  class EmptyTagListError < Exception; end
-  class EmptyCommentListError < Exception; end
-  class FormatterNotFound < Exception; end
+  NotImplementedError = Class.new(StandardError)
+  EmptyTagListError = Class.new(StandardError)
+  EmptyCommentListError = Class.new(StandardError)
+  FormatterNotFound = Class.new(StandardError)
 end

data/lutra.gemspec

@@ -19,7 +19,4 @@ Gem::Specification.new do |s|
   s.test_files = Dir.glob("spec/**/*")
 
   s.executables << 'lutra'
-
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '>= 2.1'
 end

data/spec/lib/formatter_spec.rb

@@ -0,0 +1,48 @@
+describe Lutra::Formatter do
+  context '.new' do
+    it 'have one formatter' do
+      expect(subject.formatters.size).to eq(1)
+    end
+
+    it 'have default formatter' do
+      expect(subject.formatters.first[:name]).to eq(:default)
+    end
+  end
+
+  context '#add' do
+    it 'adds new formatter' do
+      expect(subject.add(:new, :n, Lutra::Formatters::Default).size).to eq(2)
+    end
+  end
+
+  context '#get' do
+    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
+    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
+
+  context '#display' do
+    let(:out) { capture_stdout { subject.display([]) } }
+
+    it 'prints notes with selected formatter' do
+      expect(out).to eq('')
+    end
+  end
+end

data/spec/lib/formatters/base_spec.rb

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

data/spec/lib/formatters/default_spec.rb

@@ -0,0 +1,16 @@
+describe Lutra::Formatters::Default do
+  let(:note) { Lutra::Note.new('TODO', '#', 'test', 113, '.././app/lib/test.rb') }
+
+  context '#display' do
+    let(:out)   { capture_stdout { subject.display([note]) } }
+    let(:lines) { out.split("\n") }
+
+    it 'has filename in first line' do
+      expect(lines[0]).to eq('app/lib/test.rb:')
+    end
+
+    it 'has todo entry in seconds line' do
+      expect(lines[1]).to eq(' * [113] [TODO] test')
+    end
+  end
+end

data/spec/lib/scanner_spec.rb

@@ -0,0 +1,50 @@
+require 'benchmark'
+
+describe Lutra::Scanner do
+  context '.new' do
+    subject { described_class }
+
+    it 'default tags' do
+      expect(subject.new.tags).to eq(['TODO', 'FIXME', 'OPTIMIZE'])
+    end
+
+    it 'custom tags' do
+      expect(subject.new(tags: ['X']).tags).to eq(['X'])
+    end
+
+    it 'default comments' do
+      expect(subject.new.comments).to eq(['#', '%', ';', '//', '--'])
+    end
+
+    it 'custom comments' do
+      expect(subject.new(comments: ['#']).comments).to eq(['#'])
+    end
+  end
+
+  context '#scan_file' do
+    let(:filename) { data_file('sample') }
+    let(:notes)    { subject.notes }
+
+    before { subject.scan_file(filename) }
+
+    it 'have todo, fixme and optimize' do
+      expect(notes.map(&:tag)).to eq(['TODO', 'FIXME', 'OPTIMIZE'])
+    end
+
+    context 'with custom tags' do
+      subject { described_class.new(tags: ['TODO']) }
+
+      it 'returns notes with only specified tag' do
+        expect(notes.map(&:tag)).to eq(['TODO'])
+      end
+    end
+
+    context 'with custom comments' do
+      subject { described_class.new(comments: ['#']) }
+
+      it 'returns notes with only specified comments' do
+        expect(notes.map(&:comment)).to eq(['#'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,13 @@
 require 'lutra'
 
-def example_data
-  File.open("#{File.dirname(__FILE__)}/example").read
+if ENV.fetch('CODECLIMATE_REPO_TOKEN', nil)
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+Dir.glob('./spec/support/**/*.rb') { |file| require file }
+
+RSpec.configure do |config|
+  include STDSupport
+  include DataSupport
 end

data/spec/support/data_support.rb

@@ -0,0 +1,9 @@
+module DataSupport
+  def load_data_file(name)
+    File.open(data_file(name)).read
+  end
+
+  def data_file(name)
+    "#{File.dirname(__FILE__)}/../fixtures/#{name}"
+  end
+end

data/spec/support/std_support.rb

@@ -0,0 +1,10 @@
+module STDSupport
+  def capture_stdout(&blk)
+    old = $stdout
+    $stdout = fake = StringIO.new
+    blk.call
+    fake.string
+  ensure
+    $stdout = old
+  end
+end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lutra
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Yuri Artemev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 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'
+date: 2015-08-07 00:00:00.000000000 Z
+dependencies: []
 description: Parse tags (todo, fixme, optimize) in your source code
 email:
 - i@artemeff.com
@@ -51,20 +23,21 @@ files:
 - bin/lutra
 - lib/lutra.rb
 - lib/lutra/formatter.rb
+- lib/lutra/formatter_entry.rb
 - lib/lutra/formatters/base.rb
 - lib/lutra/formatters/default.rb
 - lib/lutra/note.rb
 - lib/lutra/scanner.rb
 - lib/lutra/version.rb
 - lutra.gemspec
-- 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/fixtures/sample
+- spec/lib/formatter_spec.rb
+- spec/lib/formatters/base_spec.rb
+- spec/lib/formatters/default_spec.rb
+- spec/lib/scanner_spec.rb
 - spec/spec_helper.rb
+- spec/support/data_support.rb
+- spec/support/std_support.rb
 homepage: http://github.com/artemeff/lutra
 licenses:
 - MIT
@@ -85,17 +58,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 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/fixtures/sample
+- spec/lib/formatter_spec.rb
+- spec/lib/formatters/base_spec.rb
+- spec/lib/formatters/default_spec.rb
+- spec/lib/scanner_spec.rb
 - spec/spec_helper.rb
+- spec/support/data_support.rb
+- spec/support/std_support.rb
 has_rdoc: 

data/spec/formatter_spec.rb

@@ -1,50 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

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

data/spec/lutra_spec.rb

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

data/spec/note_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-describe Lutra::Note do
-  subject do
-    described_class.new('X', 'text', 1, 'ex.rb')
-  end
-
-  it "#tag" do
-    expect(subject.tag).to eq 'X'
-  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

@@ -1,35 +0,0 @@
-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(['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(['X'], ['#']).comments).to eq ["#"]
-    end
-  end
-
-  context "#scan_file" do
-    let(:notes) do
-      scanner = subject.new
-      scanner.scan_file("#{File.dirname(__FILE__)}/example")
-      scanner.notes
-    end
-
-    it "have todo, fixme and optimize" do
-      expect(notes.map(&:tag)).to eq ['TODO', 'FIXME', 'OPTIMIZE']
-    end
-  end
-end