lutra 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120c9b5137a29993b0cf99cf77d4fd973ca5c6dc
-  data.tar.gz: 129e3e23967864255313f50b34a202ca299bf4d0
+  metadata.gz: 7337112eafc3be539708c9e4ca191af02a8948cd
+  data.tar.gz: b3d62818e4b3ef41951f905d6ac8ae1e01b19da7
 SHA512:
-  metadata.gz: 2eca1f7883a4068402aef57296caa1d031f7d2e69e7dd88e911e53723c055b424b7ab32b728fb20381910b180b748a3353900c30009528882b9190e6a059e590
-  data.tar.gz: 05f875eb64f93cc561629ade90eac7fb4800ec968c4cf05e3555cdb5bdf8f5c4ea1b590d9db301259399d6be8cf835bb7074cd8295c533b5c2b8418430c97d3a
+  metadata.gz: 2fe4243548f43a30468271ff6c718519331955f499c09c0f305f8451b4080e0d07bbac6c7dd45bca0f08de7e98be233547189cf6289839a7e469b8c93efd1242
+  data.tar.gz: 02733a43a2d7c3e2958bdf02feb18f9871cd584980a11c76d0b32c2a72b51017f97d0d20bdf2703fe2f3830d8a1cbc44f98b3b3d8f4d4608a85adf4c7a537086

data/bin/lutra

@@ -9,7 +9,6 @@ color    = STDOUT.tty?
 usage    = 'Usage: lutra [OPTIONS] [PATH]'
 tags     = Lutra::TAGS
 comments = Lutra::COMMENTS
-formatter_name = :default
 formatter_opts = {}
 
 ARGV.options do |o|
@@ -24,10 +23,6 @@ ARGV.options do |o|
     comments = com.split(',').map(&:strip)
   end
 
-  o.on('-f', '--formatter=NAME', 'Use your own formatter') do |name|
-    formatter_name = name.to_sym
-  end
-
   o.on('-s', '--text-size=SIZE', 'Set text size for formatter') do |size|
     formatter_opts[:text_size] = size.to_i
   end
@@ -55,7 +50,8 @@ rescue => e
   exit 1
 end
 
-scanner = Lutra::Scanner.new(tags: tags, comments: comments)
+formatter = Lutra::Formatters::Default.new(formatter_opts)
+scanner = Lutra::Scanner.new(formatter)
 
 Find.find(*paths) do |path|
   unless paths.include?(path)
@@ -65,7 +61,7 @@ Find.find(*paths) do |path|
   next if File.directory?(path)
 
   begin
-    scanner.scan_file(path)
+    scanner.scan_file(path, tags, comments)
   rescue Errno::ENOENT => e
     STDERR.puts "lutra: #{e.message} (broken symlink?)" if verbose
   rescue => e
@@ -73,8 +69,4 @@ Find.find(*paths) do |path|
   end
 end
 
-formatter = Lutra::Formatter.new(formatter_opts)
-formatter.set(formatter_name)
-formatter.display(scanner.notes)
-
 exit

data/lib/lutra.rb

@@ -1,5 +1,4 @@
 require 'lutra/scanner'
-require 'lutra/formatter'
 require 'lutra/formatters/base'
 require 'lutra/formatters/default'
 
@@ -10,5 +9,4 @@ module Lutra
   NotImplementedError = Class.new(StandardError)
   EmptyTagListError = Class.new(StandardError)
   EmptyCommentListError = Class.new(StandardError)
-  FormatterNotFound = Class.new(StandardError)
 end

data/lib/lutra/scanner.rb

@@ -2,31 +2,31 @@ require 'lutra/note'
 
 module Lutra
   class Scanner
-    attr_accessor :tags, :comments
-    attr_reader :notes
+    attr_reader :formatter
 
-    def initialize(tags: Lutra::TAGS, comments: Lutra::COMMENTS)
-      raise EmptyTagListError if tags.empty?
-      raise EmptyCommentListError if comments.empty?
-
-      @tags, @comments = tags, comments
-      @notes = []
+    def initialize(formatter = Formatters::Default.new)
+      @formatter = formatter
     end
 
-    def scan_file(path)
-      extract(File.open(path), path)
+    def scan_file(path, tags, comments)
+      notes = extract(File.open(path), path, tags, comments)
+
+      formatter.display(notes)
     end
 
   private
 
-    def extract(source, path)
-      regexp = compile_regexp(@comments, @tags)
+    def extract(source, path, tags, comments)
+      regexp = compile_regexp(comments, tags)
+      notes  = []
 
       source.each_with_index do |line, i|
         if result = regexp.match(line)
-          @notes << Note.new(result[:tag], result[:comment], result[:text], i + 1, path)
+          notes << Note.new(result[:tag], result[:comment], result[:text], i + 1, path)
         end
       end
+
+      notes
     end
 
     def compile_regexp(comments, tags)

data/lib/lutra/version.rb

@@ -1,3 +1,3 @@
 module Lutra
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/lib/scanner_spec.rb

@@ -4,46 +4,36 @@ 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(['#'])
+    it 'default formatter' do
+      expect(subject.new.formatter).to be_a(Lutra::Formatters::Default)
     end
   end
 
-  context '#scan_file' do
-    let(:filename) { data_file('sample') }
-    let(:notes)    { subject.notes }
+  context '#extract' do
+    let(:path) { data_file('sample') }
+    let(:file) { File.open(path) }
+    let(:tags) { Lutra::TAGS }
+    let(:comm) { Lutra::COMMENTS }
 
-    before { subject.scan_file(filename) }
+    subject { described_class.new.send(:extract, file, path, tags, comm) }
 
     it 'have todo, fixme and optimize' do
-      expect(notes.map(&:tag)).to eq(['TODO', 'FIXME', 'OPTIMIZE'])
+      expect(subject.map(&:tag)).to eq(['TODO', 'FIXME', 'OPTIMIZE'])
     end
 
     context 'with custom tags' do
-      subject { described_class.new(tags: ['TODO']) }
+      let(:tags) { ['TODO'] }
 
       it 'returns notes with only specified tag' do
-        expect(notes.map(&:tag)).to eq(['TODO'])
+        expect(subject.map(&:tag)).to eq(['TODO'])
       end
     end
 
     context 'with custom comments' do
-      subject { described_class.new(comments: ['#']) }
+      let(:comm) { ['#'] }
 
       it 'returns notes with only specified comments' do
-        expect(notes.map(&:comment)).to eq(['#'])
+        expect(subject.map(&:comment)).to eq(['#'])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutra
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Yuri Artemev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies: []
 description: Parse tags (todo, fixme, optimize) in your source code
 email:
@@ -22,8 +22,6 @@ files:
 - README.md
 - 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
@@ -31,7 +29,6 @@ files:
 - lib/lutra/version.rb
 - lutra.gemspec
 - 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
@@ -64,7 +61,6 @@ specification_version: 4
 summary: In source annotaions parser
 test_files:
 - 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

data/lib/lutra/formatter.rb

@@ -1,47 +0,0 @@
-require 'lutra/formatter_entry'
-
-module Lutra
-  class Formatter
-    attr_reader :formatters, :current
-
-    def initialize(options = {})
-      @options = options
-      @current = :default
-      @formatters = [default_formatter]
-    end
-
-    def get(name)
-      @formatters.find do |f|
-        f.name == name || f.short == name
-      end
-    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 << FormatterEntry.new(name, short_name, class_name)
-      end
-    end
-
-    def display(notes)
-      get(@current).class_name.new(@options).display(notes)
-    end
-
-  private
-
-    def formatter?(class_name)
-      class_name.new.respond_to?(:display)
-    end
-
-    def default_formatter
-      FormatterEntry.new(:default, :d, Lutra::Formatters::Default)
-    end
-  end
-end

data/lib/lutra/formatter_entry.rb

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

data/spec/lib/formatter_spec.rb

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