issuesrc 0.0.3 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTk4MDIyOTg3MjA5YWNmY2IwNTBmNzcyMTNlODAxMTlmN2YyNTZiOA==
+    YmZiMTYzMmRlMWVkZDQxZGU2NjcxYTBhY2JhM2ZhZTRiMDk2ZTkwNw==
   data.tar.gz: !binary |-
-    NjdkYzAwNDE4NDNjMGIzMWQ5ZmQ2ZjViZTE1MGQ0MzYwZmU4ZjEyYw==
+    ZTQzZGVhY2Q2ZDhiMjdkNmQ2ZmJkMjM0MjI0MTQyMWE2ZmUyMmE4ZA==
 SHA512:
   metadata.gz: !binary |-
-    MTAyNWM0NjM1ZGRiNjY5NmE4OWUwOGFhMmMzMjYwNDUzNThlMjI5NGFiZjk1
-    YTgxODhhMDFmOGU1OGYwNDgxY2VkOWQ3ZWEyOWM2M2UyOGU4YzA2Y2QzNDM5
-    YWZiYjAyZWZhZTkwMWRkMDQwODE0NzdlMmRiNDI5NDU4YzRmYTg=
+    YmM1YzFmZDRiYmQ1M2ZjN2VhM2E2ZGM0NDQ0NjIwYTQ1NDY2YzM4ZWY3MDNi
+    NjM0OGI4MzAyMTc2MmQ2ZTg0ZTZjMjE3MWJiZGYzNzNiOTlmZWExYjM1M2I2
+    MzJhN2Q1NTIwZTJhYWMzNjk1NzVjNGZmNmUwMGE2ZDgxMWUxMmE=
   data.tar.gz: !binary |-
-    ZjhlMzlkYTcxZDg2YTAzZTNkZTNkZGMxZjM5OTQ0MjhkYjc2ODdjYTM3Zjhi
-    NjQyNTY0NzYzNmYxOGE3OGI2OTUyOWE3Nzk3Yzc2N2Q1OGQ3ZDRiMmRiMDRj
-    MDkzODFlMWY5ZWVmNzUxMTQzNTA3Yzk5YTg4OWFmNGYxOWQwZTk=
+    MmM3OTEzODY0ZDZhMTkyMzgwYTNlYmU5ODUwZjZkZDFhMGUzMjNkYjBmNDZh
+    N2QzODUyNjdmNjUwMDBkNzgxZDNkNGJhZWZkNmUwNDY2MGQ2NGI3NDEyZjc4
+    MmYwZWFkMTA4ZjYyZWFmNzczZjBiZTdjOGQ1ODlmOTljYTE2YTQ=

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+    - 1.9.3
+

data/Gemfile

@@ -7,3 +7,6 @@ gem 'toml', '~> 0.1.2'
 gem 'plist', '~> 3.1.0'
 gem 'em-http-request', '~> 1.1.2'
 gem 'ptools', '~> 1.2.6'
+group :coverage do
+  gem 'simplecov', :require => false
+end

data/README.md

@@ -1,4 +1,4 @@
-# issuesrc
+# issuesrc [![Build Status](https://secure.travis-ci.org/tcard/issuesrc.svg?branch=master)](http://travis-ci.org/tcard/issuesrc) [![Gem Version](https://badge.fury.io/rb/issuesrc.svg)](http://badge.fury.io/rb/issuesrc) [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/tcard/issuesrc/master)
 
 **WARNING: very early stage of development. Test at your own risk!**
 
@@ -6,10 +6,10 @@ Synchronize in-source commented tasks with your issue tracker.
 
 issuesrc scans your files looking for comments tagged with labels such as TODO, BUG, FIXME, etc., and adds them your issue tracker.
 
-* Newly found tags **will be opened as issues**. Each ID will be added in the source code, for keeping them in sync.
-* From the source code you can change the label or the description of the issue. 
+* Newly found tags **will be opened as issues**. Each tag will be edited in the source code to add its issue number next to it.
+* From the source code you can change the label or the description of the issue. Running the command again will synchronize changes in the repo.
 * You can also **appoint an assignee** by putting her username alongside the tag (eg. `TODO(tcard)`; `TODO(tcard#12345)`).
-* Synchronization is one-way; changes that you do in the issue tracker will be lost when you run the program again.
+* Synchronization is one-way; changes that you do to a issuesrc issue from the issue tracker will be lost when you run the program again. You should add any further information as comments.
 * When a tag is removed from the code, it is **closed in the issue tracker**.
 
 ## Installation
@@ -20,10 +20,16 @@ issuesrc scans your files looking for comments tagged with labels such as TODO,
 
 issuesrc connects comments found in source code with an issue tracker. It needs to be configured to talk to both.
 
-Configuration is done both via a .toml config file and via command line arguments. See `example.toml` and run `issuesrc -h` for details.
+Configuration is done both via a .toml config file and via command line arguments. See [`example.toml`](https://github.com/tcard/issuesrc/blob/master/example.toml) and run `issuesrc -h` for details.
 
 Currently, issuesrc only supports Git for retrieving source code, and GitHub as issue tracker.
 
+The easiest way to get started would be something like this:
+
+    $ issuesrc --repo youruser/yourrepo --github-token xxxxxxxxxxx
+
+That will extract tasks from the comments at github.com/youruser/yourrepo, open issues for them, add each issue's number next to its comment, and commit and push the changes. (You will thus need to have push access from the environment you run this command in.)
+
 ## Contributing
 
 1. Fork it ( https://github.com/tcard/issuesrc/fork )

data/lib/issuers/github_issuer.rb

@@ -1,4 +1,5 @@
 require 'issuesrc/config'
+require 'issuers/issuers'
 require 'em-http-request'
 require 'json'
 require 'set'
@@ -7,35 +8,6 @@ module Issuesrc
   module Issuers
     DEFAULT_LABEL = 'issuesrc'
 
-    class Issues
-      def initialize(queue)
-        @queue = queue
-        @queue_done = false
-        @cache = []
-      end
-
-      def each
-        i = 0
-        while i < @cache.length
-          yield @cache[i]
-          i += 1
-        end
-
-        while !@queue_done
-          @queue.pop do |issue_page|
-            if issue_page == :end
-              @queue_done = true
-              next
-            end
-            issue_page.each do |issue|
-              yield issue unless issue.include? 'pull_request'
-            end
-          end
-        end
-      end
-
-    end
-
     class GithubIssuer
       def initialize(args, config, event_loop)
         @user, @repo = find_repo(args, config)
@@ -109,25 +81,25 @@ module Issuesrc
         end
       end
 
+      private
       def make_sure_issue_exists_and_then
         # TODO(#21)
         yield true
       end
 
-      private
       def find_repo(args, config)
-        repo_arg = Issuesrc::Config::option_from_both(
+        repo_arg = Issuesrc::Config.option_from_both(
           :repo, ['github', 'repo'], args, config, :require => true)
         repo_arg.split('/')
       end
 
       def try_find_token(args, config)
-        Issuesrc::Config::option_from_both(
+        Issuesrc::Config.option_from_both(
           :github_token, ['github', 'auth_token'], args, config)
       end
 
       def try_find_issuesrc_label(args, config)
-        label = Issuesrc::Config::option_from_both(
+        label = Issuesrc::Config.option_from_both(
           :issuesrc_label, ['issuer', 'issuesrc_label'], args, config)
         if label.nil?
           label = DEFAULT_LABEL

data/lib/issuers/issuers.rb

@@ -0,0 +1,102 @@
+module Issuesrc
+
+  # This module holds the different classes that can be used as issuers.
+  #
+  # An issuer handles an external issue tracker. It retrieves, creates,
+  # updates and deletes issues in an external service.
+  # 
+  # Every issuer must implement the interface defined in the 
+  # {Issuers::IssuerInterface} class.
+  module Issuers
+
+    # This class is here for documentation only. All classes in the Issuers
+    # module that want to be considered issuers need to implement this
+    # interface.
+    class IssuerInterface
+      # @param args Command line arguments, as key => value.
+      # @param config Arguments from the configuration file, as key => value.
+      # @param [Issuesrc::EventLoop] event_loop An event loop that can be used
+      #         to make asynchronous I/O.
+      def initialize(args, config, event_loop); end
+
+      # Loads all the open issues marked with
+      # {Issuesrc::Issuers::DEFAULT_LABEL} (or the label chose in the config)
+      # from the issue tracker.
+      #
+      # @return [Issuesrc::Issuers::Issues]
+      def async_load_issues(); end
+
+      # Opens a new issue with the information hold in +tag+. Sets the just
+      # created issue ID as +tag+'s +issue_id+ attribute.
+      #
+      # @param [Issuesrc::Tag] tag
+      # @yieldparam [Issuesrc::Tag] The passed tag, with the issue ID updated.
+      def async_create_issue(tag, &block); end
+
+      # Updates an existing issue with the information hold in +tag+.
+      #
+      # @param issue_id The ID of the issue that should be updated.
+      # @param [Issuesrc::Tag] tag
+      # @yieldparam [Issuesrc::Tag] The passed tag.
+      def async_update_issue(issue_id, tag, &block); end
+
+      # Closes an issue.
+      #
+      # @param issue_id The ID of the issue that should be closed.
+      # @yieldparam [Issuesrc::Tag] The passed tag.
+      def async_close_issue(issue_id, &block); end
+
+      # Updates and closes a bunch of issues.
+      #
+      # It matches the issues that are currently open in the issue tracker with
+      # the tags found in the source code. Those that are only in the issue
+      # tracker are closed. Those that are in both are updated with the
+      # information from the source code.
+      #
+      # Reports what is being done to the passed block.
+      #
+      # @param prev_issues An array of issues, as they are returned from
+      #                    {Issuesrc::Issuers::IssuerInterface.async_load_issues}.
+      # @param tags_by_issue_id
+      # @yieldparam issue_id The ID of an issue.
+      # @yieldparam {Issuesrc::Tag} tag The tag associated with the issue.
+      # @yieldparam action Either +:updated+ or +:closed+.
+      def async_update_or_close_issues(prev_issues, tags_by_issue_id, &block)
+      end
+    end
+
+    # A generator of issues.
+    #
+    # Reads issues from the queue passed to the constructor and yields them.
+    # 
+    # The format of each issue is specific to a particular issuer.
+    class Issues
+      def initialize(queue)
+        @queue = queue
+        @queue_done = false
+        @cache = []
+      end
+
+      def each
+        i = 0
+        while i < @cache.length
+          yield @cache[i]
+          i += 1
+        end
+
+        while !@queue_done
+          @queue.pop do |issue_page|
+            if issue_page == :end
+              @queue_done = true
+              next
+            end
+            issue_page.each do |issue|
+              yield issue unless issue.include? 'pull_request'
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/issuesrc.rb

@@ -40,9 +40,10 @@ module Issuesrc
     issues = issuer.async_load_issues()
 
     created_tags, updated_tags, closed_issues = [], [], []
+    tags_by_issue_id = {}
 
     sourcer.retrieve_files().each do |file|
-      if Issuesrc::Config::option_from_args(:verbose, args)
+      if Issuesrc::Config.option_from_args(:verbose, args)
         puts file.path
       end
 
@@ -54,7 +55,8 @@ module Issuesrc
       tags = []
       tag_finder.find_tags(file) { |tag| tags << tag }
 
-      tags_by_issue_id, new_tags = program.classify_tags(tags, file)
+      tags_in_file, new_tags = program.classify_tags(tags)
+      tags_by_issue_id.update(tags_in_file)
 
       new_tags.each do |tag|
         created_tags << tag
@@ -62,16 +64,16 @@ module Issuesrc
           program.save_tag_in_file(tag)
         end
       end
+    end
 
-      issuer.async_update_or_close_issues(issues, tags_by_issue_id) do
-      |issue_id, tag, action|
-        case action
-        when :updated
-          program.save_tag_in_file(tag)
-          updated_tags << tag
-        when :closed
-          closed_issues << issue_id
-        end
+    issuer.async_update_or_close_issues(issues, tags_by_issue_id) do
+    |issue_id, tag, action|
+      case action
+      when :updated
+        program.save_tag_in_file(tag)
+        updated_tags << tag
+      when :closed
+        closed_issues << issue_id
       end
     end
 
@@ -87,6 +89,8 @@ module Issuesrc
     @config = config
   end
 
+  attr_accessor :files_offsets
+
   def init_files_offsets
     @files_offsets = {}
   end
@@ -128,7 +132,7 @@ module Issuesrc
   end
 
   def load_component(config_key, arg_key, default, options)
-    type = Config::option_from_both(arg_key, config_key, @args, @config)
+    type = Config.option_from_both(arg_key, config_key, @args, @config)
     if type.nil?
       type = default
     end
@@ -137,7 +141,7 @@ module Issuesrc
 
   def load_component_by_type(type, options)
     if !options.include?(type)
-      exec_fail 'Unrecognized sourcer type: #{type}'
+      Issuesrc::exec_fail 'Unrecognized sourcer type: #{type}'
     end
 
     options[type]
@@ -146,7 +150,7 @@ module Issuesrc
   # Like `load_sourcer` but for the tag finders. It only looks at
   # `[tag_finders] tag_finders = [...]` from the config file.
   def load_tag_finders
-    tag_finders = Config::option_from_config(
+    tag_finders = Config.option_from_config(
       ['tag_finders', 'tag_finders'], @config)
     if tag_finders.nil?
       tag_finders = DEFAULT_TAG_FINDERS
@@ -155,7 +159,7 @@ module Issuesrc
   end
 
   def load_tag_finders_by_types(types)
-    tag_extractor = Issuesrc::TagExtractor.new(@args, @config)
+    tag_extractor = load_tag_extractor()
     tag_finders = []
     types.each do |type|
       path, cls = load_component_by_type(type, TAG_FINDERS)
@@ -165,6 +169,10 @@ module Issuesrc
     tag_finders
   end
 
+  def load_tag_extractor
+    Issuesrc::TagExtractor.new(@args, @config)
+  end
+
   def make_tag_finder(cls, tag_extractor)
     Issuesrc::TagFinders.const_get(cls).new(tag_extractor, @args, @config)
   end
@@ -180,7 +188,7 @@ module Issuesrc
     ret
   end
 
-  def classify_tags(tags, file)
+  def classify_tags(tags)
     tags_by_issue = {}
     new_tags = []
     tags.each do |tag|

data/lib/issuesrc/file.rb

@@ -1,4 +1,25 @@
 module Issuesrc
+  # This class is here for documentation only. All classes in the Sourcers
+  # module that want to be considered issuers need to implement this
+  # interface.
+  class FileInterface
+    # @return The type of the file as a file extension.
+    def type; end
+
+    # @return [IO] The body of the file.
+    def body; end
+
+    # Replaces part of the body of the file, and saves it.
+    #
+    # @param pos Position from the beginning of the body in which the new
+    #        content starts.
+    # @param old_content_length Length of previous content that should be
+    #        replaced.
+    # @param new_content A string that will be written in +pos+ at the file.
+    def replace_at(pos, old_content_length, new_content); end
+  end
+
+  # A file from the filesystem.
   class FSFile
     attr_reader :type
     attr_reader :path
@@ -15,7 +36,7 @@ module Issuesrc
     def replace_at(pos, old_content_length, new_content)
       fbody = body.read
       fbody = replace_in_string(fbody, pos, old_content_length, new_content)
-      f = File.open(@path, 'wb')
+      f = body_for_writing()
       f.write(fbody)
       f.close()
     end
@@ -24,8 +45,13 @@ module Issuesrc
     def replace_in_string(s, pos, deleted_length, new_content)
       (s[0...pos] || '') + new_content + (s[pos + deleted_length..-1] || '')
     end
+
+    def body_for_writing
+      File.open(@path, 'wb')
+    end
   end
 
+  # A file from the filesystem that is indexed in a Git repository.
   class GitFile < FSFile
     attr_reader :repo
     attr_reader :path_in_repo

data/lib/issuesrc/tag.rb

@@ -1,13 +1,17 @@
 module Issuesrc
+
+  # A tag is an annotation found in the source code of a file that holds
+  # information about the issue it corresponds to, the author or assignee, a
+  # label, a title for the isssue, and its position in the file.
   class Tag
     attr_reader :label
     attr_accessor :issue_id
     attr_reader :author
     attr_reader :title
-    attr_reader :file
-    attr_reader :line
-    attr_reader :begin_pos
-    attr_reader :end_pos
+    attr_accessor :file
+    attr_accessor :line
+    attr_accessor :begin_pos
+    attr_accessor :end_pos
 
     def initialize(label, issue_id, author, title, file, line, 
                    begin_pos, end_pos)
@@ -21,6 +25,7 @@ module Issuesrc
       @end_pos = end_pos
     end
 
+    # The string representation of the tag, to be included in the source file.
     def to_s
       ret = ""
       ret << @label
@@ -40,6 +45,17 @@ module Issuesrc
       ret
     end
 
+    # Writes the tag in its file, using its string representation.
+    #
+    # Also updates the tag position information depending on +offset+
+    #
+    # @param offsets As the tag's position information might have been outdated
+    #        by other tags having been written to the file, this function needs
+    #        to know how much does it need to correct its position. +offsets+
+    #        is a list of pairs +(position, offset)+ that tells that at
+    #        a given position a given offset has been added or substracted.
+    # @return +offsets+, updated with the new offset resulting from editing the
+    #         file.
     def write_in_file(offsets)
       total_offset = 0
       offsets.each do |pos, offset|

data/lib/issuesrc/tag_extractor.rb

@@ -1,4 +1,5 @@
 require 'issuesrc/config'
+require 'issuesrc/tag'
 
 module Issuesrc
   TAG_EXTRACTORS = [
@@ -22,11 +23,26 @@ module Issuesrc
       end
     end
 
+    # Extracts a tag from a line of source code, if there is one.
+    #
+    # It passes the line through one or more extractor functions. The first
+    # that returns non-nil will be returned.
+    # 
+    # @param source A string.
+    # @return [Issuesrc::Tag] Or +nil+ if no tag is found.
     def extract(source)
       @extractors.each do |extr|
-        tag = try_extractor(extr, source)
-        if !tag.nil?
-          return tag
+        tag_data = try_extractor(extr, source)
+        if !tag_data.nil?
+          return Issuesrc::Tag.new(
+            tag_data['type'],
+            tag_data['issue_id'],
+            tag_data['author'],
+            tag_data['title'],
+            nil, nil,
+            tag_data['begin_pos'],
+            tag_data['end_pos']
+          )
         end
       end
       nil

data/lib/issuesrc/version.rb

@@ -1,3 +1,3 @@
 module Issuesrc
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/sourcers/git_sourcer.rb

@@ -77,7 +77,7 @@ module Issuesrc
       end
 
       def init_exclude(config)
-        @exclude = Issuesrc::Config::option_from_config(
+        @exclude = Issuesrc::Config.option_from_config(
           ['sourcer', 'exclude_files'], config)
         if @exclude.nil?
           @exclude = []
@@ -86,12 +86,12 @@ module Issuesrc
 
 
       def try_find_repo_url(args, config)
-        Issuesrc::Config::option_from_both(:repo_url, ['git', 'repo'],
+        Issuesrc::Config.option_from_both(:repo_url, ['git', 'repo'],
                                            args, config)
       end
 
       def try_find_repo_path(args, config)
-        Issuesrc::Config::option_from_both(:repo_path, ['git', 'repo_path'],
+        Issuesrc::Config.option_from_both(:repo_path, ['git', 'repo_path'],
                                            args, config)
       end
 
@@ -104,7 +104,7 @@ module Issuesrc
       end
 
       def decide_when_done(args_key, config_key, args, config)
-        opt = Issuesrc::Config::option_from_both(
+        opt = Issuesrc::Config.option_from_both(
           args_key, ['git', config_key], args, config)
         if opt.nil?
           opt = is_downloaded?

data/lib/sourcers/github_sourcer.rb

@@ -17,7 +17,7 @@ module Issuesrc
 
       private
       def try_find_repo(args, config)
-        repo_arg = Issuesrc::Config::option_from_both(
+        repo_arg = Issuesrc::Config.option_from_both(
           :repo, ['github', 'repo'], args, config)
         repo_arg.split('/')
       end

data/lib/sourcers/sourcers.rb

@@ -0,0 +1,33 @@
+module Issuesrc
+
+  # This module holds the different classes that can be used as sourcers.
+  #
+  # A sourcer handles source code. It retrieves, reads from and edits the files
+  # in which tags can be found.
+  # 
+  # Every sourcer must implement the interface defined in the 
+  # {Sourcers::SourcerInterface} class.
+  module Sourcers
+
+    # This class is here for documentation only. All classes in the Sourcers
+    # module that want to be considered issuers need to implement this
+    # interface.
+    class SourcerInterface
+      # @param args Command line arguments, as key => value.
+      # @param config Arguments from the configuration file, as key => value.
+      def initialize(args, config); end
+
+      # Retrieves all the files in which there may be tags to find.
+      #
+      # @return [Enumerator] Enumerator of {Issuesrc::FileInterface}.
+      def retrieve_files; end
+
+      # Optional. Called when the execution of the program finishes.
+      #
+      # @param created_tags Array of {Issuesrc::Tag}.
+      # @param updated_tags Array of {Issuesrc::Tag}.
+      # @param closed_issue_ids Array of IDs, which are Strings.
+      def finish(created_tags, updated_tags, closed_issue_ids); end
+    end
+  end
+end

data/lib/tag_finders/blunt_tag_finder.rb

@@ -2,6 +2,11 @@ require 'issuesrc/tag'
 
 module Issuesrc
   module TagFinders
+
+    # A tag finder that doesn't do any parsing; it just bluntly traverses the
+    # source code looking for things that look like comments.
+    #
+    # It tries to skip comments inside strings.
     class BluntTagFinder
       DEFAULT_COMMENT_MARKERS = [['//', "\n"], ['/*', '*/']]
       DEFAULT_STRING_MARKERS = ['"', "'"]
@@ -38,18 +43,13 @@ module Issuesrc
           # span several lines.
           nline_offset = 0
           comment.split("\n").each do |line|
-            tag_data = @tag_extractor.extract(line)
-            if !tag_data.nil?
-              yield Issuesrc::Tag.new(
-                tag_data['type'],
-                tag_data['issue_id'],
-                tag_data['author'],
-                tag_data['title'],
-                file,
-                nline + nline_offset,
-                pos + tag_data['begin_pos'],
-                pos + tag_data['end_pos']
-              )
+            tag = @tag_extractor.extract(line)
+            if !tag.nil?
+              tag.file = file
+              tag.line = nline + nline_offset
+              tag.begin_pos += pos
+              tag.end_pos += pos
+              yield tag
             end
             pos += line.length + 1
             nline_offset += 1
@@ -60,7 +60,7 @@ module Issuesrc
       private
       def find_comments(file)
         comment_markers, string_markers = decide_markers(file)
-        body = file.body.read.force_encoding('BINARY') # TODO(#26): Use less memory here.
+        body = get_file_body(file)
         comment_finder = CommentFinder.new(body, comment_markers, string_markers)
         pos = 0
 
@@ -76,6 +76,10 @@ module Issuesrc
         ]
       end
 
+      def get_file_body(file)
+        file.body.read.force_encoding('BINARY') # TODO(#26): Use less memory here.
+      end
+
       class CommentFinder
         def initialize(body, comment_markers, string_markers)
           @body = body
@@ -129,15 +133,15 @@ module Issuesrc
         end
 
         def read_delimited(markers)
-          consumed = state_boundary(markers, :begin)
+          marker_i, consumed = state_boundary(markers, :begin)
           lex = @body[0...consumed]
           consume_body(consumed)
 
-          consumed_end = state_boundary(markers, :end)
+          _, consumed_end = state_boundary(markers, :end, marker_i)
           while !@body.empty? && consumed_end.nil?
             lex << @body[0]
             consumed += consume_body(1)
-            consumed_end = state_boundary(markers, :end)
+            _, consumed_end = state_boundary(markers, :end, marker_i)
           end
 
           if !consumed_end.nil?
@@ -158,18 +162,24 @@ module Issuesrc
           end
         end
 
-        def state_boundary(markers, begin_or_end)
+        def state_boundary(markers, begin_or_end, marker_i=nil)
           if @body.nil?
             nil
           end
 
+          i = 0
           markers.each do |marker|
+            if !marker_i.nil? && i != marker_i
+              i += 1
+              next
+            end
             if marker.instance_of? Array 
               marker = marker[begin_or_end == :begin ? 0 : 1]
             end
             if @body.start_with? marker
-              return marker.length
+              return [i, marker.length]
             end
+            i += 1
           end
           nil
         end

data/lib/tag_finders/tag_finders.rb

@@ -0,0 +1,37 @@
+module Issuesrc
+
+  # This module holds the different classes that can be used as tag finders.
+  #
+  # An issuer handles an external issue tracker. It retrieves, creates,
+  # updates and deletes issues in an external service.
+  # 
+  # Every tag finder must implement the interface defined in the 
+  # {TagFinders::TagFinderInterface} class.
+  module TagFinders
+
+    # This class is here for documentation only. All classes in the TagFinders
+    # module that want to be considered tag finders need to implement this
+    # interface.
+    class TagFinderInterface
+      # @param tag_extractor [Issuesrc::TagExtractor]
+      # @param args Command line arguments, as key => value.
+      # @param config Arguments from the configuration file, as key => value.
+      def initialize(tag_extractor, args, config); end
+
+      # Tells if the tag finder can process the given file or not.
+      #
+      # @param [Issuesrc::FileInterface] file
+      # @return [Bool]
+      def accepts?(file); end
+
+      # Finds all the tags in a file.
+      #
+      # Reads in the file's body looking for tags, using the instance's
+      # +tag_extractor+.
+      #
+      # @param [Issuesrc::FileInterface] file
+      # @yieldparam tag [Issuesrc::Tag]
+      def find_tags(file); end
+    end
+  end
+end

data/spec/issuers/github_issuer_spec.rb

@@ -0,0 +1,4 @@
+require_relative '../spec_helper'
+require_relative '../../lib/issuers/github_issuer'
+
+# TODO(#29): Test GithubIssuer.

data/spec/issuesrc/config_spec.rb

@@ -0,0 +1,4 @@
+require_relative '../spec_helper'
+require_relative '../../lib/issuesrc/config'
+
+# TODO(#30): Test Config.

data/spec/issuesrc/event_loop_spec.rb

@@ -0,0 +1,4 @@
+require_relative '../spec_helper'
+require_relative '../../lib/issuesrc/event_loop'
+
+# TODO(#31): Test EventLoop.

data/spec/issuesrc/file_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../spec_helper'
+require_relative '../../lib/issuesrc/file'
+
+describe Issuesrc::FSFile do
+  before :all do
+    @obj = Issuesrc::FSFile.new('/made/up/path.txt')
+  end
+
+  it 'extracts the type from the extension' do
+    expect(@obj.type).to be == 'txt'
+  end
+
+  describe '#replace_at' do
+    it 'replaces in the middle of the body' do
+      body = double()
+      allow(body).to receive(:write).with('Lorem ipsum REPLACED sit amet')
+      allow(@obj).to receive(:body).and_return(
+        double(:read => 'Lorem ipsum dolor sit amet'))
+      allow(@obj).to receive(:body_for_writing).and_return(body)
+      expect(body).to receive(:close)
+
+      @obj.replace_at(12, 5, 'REPLACED')
+    end
+
+    it 'replaces at the beginning of the body' do
+      body = double()
+      allow(body).to receive(:write).with('REPLACED ipsum dolor sit amet')
+      allow(@obj).to receive(:body).and_return(
+        double(:read => 'Lorem ipsum dolor sit amet'))
+      allow(@obj).to receive(:body_for_writing).and_return(body)
+      expect(body).to receive(:close)
+
+      @obj.replace_at(0, 5, 'REPLACED')
+    end
+
+    it 'replaces at the end of the body' do
+      body = double()
+      allow(body).to receive(:write).with('Lorem ipsum dolor sit amREPLACED')
+      allow(@obj).to receive(:body).and_return(
+        double(:read => 'Lorem ipsum dolor sit amet'))
+      allow(@obj).to receive(:body_for_writing).and_return(body)
+      expect(body).to receive(:close)
+
+      @obj.replace_at(24, 2, 'REPLACED')
+    end
+  end
+end

data/spec/issuesrc/tag_extractor_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../spec_helper'
+require_relative '../../lib/issuesrc/tag_extractor'
+
+describe Issuesrc::TagExtractor do
+  before :each do
+    @tag_extractor = Issuesrc::TagExtractor.new({}, {})
+  end
+
+  it 'parses several representations OK' do
+    cases = {
+      'TODO()  Test ' => 'TODO: Test',
+      'FIXME:Test' => 'FIXME: Test',
+      'FIXME' => 'FIXME',
+      'TODO ( #  1234 )Test' => 'TODO(#1234): Test',
+      'BUG  (   tcard)' => 'BUG(tcard)',
+      'BUG  (   tcard # 1234  ):Test   ' => 'BUG(tcard#1234): Test',
+    }
+
+    cases.each do |input, expected|
+      got = @tag_extractor.extract(input)
+      expect(got.to_s).to be == expected
+      idempotent = @tag_extractor.extract(expected)
+      expect(idempotent.to_s).to be == expected
+    end
+  end
+
+  it 'returns nil when no tag is found' do
+    got = @tag_extractor.extract('no tag here, sorry')
+    expect(got).to be == nil
+  end
+end

data/spec/issuesrc/tag_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../spec_helper'
+require_relative '../../lib/issuesrc/tag'
+
+describe Issuesrc::Tag do
+  before :all do
+    @file = instance_double('Issuesrc::FSFile')
+    @obj = Issuesrc::Tag.new(
+      'LABEL',
+      'abc123',
+      'theauthor',
+      'The title',
+      @file,
+      111,
+      222,
+      300)
+  end
+
+  describe '#write_in_file' do
+    it 'writes itself in its file with offsets' do
+      offset = [[50, 10], [60, 15], [999, 999]]
+
+      allow(@file).to receive(:replace_at)
+        .with(222 + 10 + 15, 300 - 222, @obj.to_s)
+      old_length = 300 - 222
+      new_length = @obj.to_s.length
+      expect(@obj.write_in_file(offset.clone))
+        .to be == (offset + [[222, new_length - old_length]])
+    end
+  end
+end

data/spec/issuesrc_spec.rb

@@ -1,15 +1,18 @@
+require_relative 'spec_helper'
 require_relative '../lib/issuesrc'
 
 describe Issuesrc do
   before :each do
+    @args = {
+      :arg => 'fake arg'
+    }
+    @config = {
+      'config' => ['fake', 'config']
+    }
     @obj = Class.new do
       include Issuesrc
     end.new
-    @obj.send(:set_config, {
-      :arg => 'fake arg'
-    }, {
-      'config' => ['fake', 'config']
-    })
+    @obj.send(:set_config, @args, @config)
   end
 
   describe '#load_sourcer' do
@@ -70,12 +73,129 @@ describe Issuesrc do
     end
 
     it 'fails when loading an unknown component' do
-      allow(@obj).to receive(:exec_fail).and_raise('failed')
-
       expect { @obj.send(:load_component, ['fake'], :fake, 'def', {}) }
-        .to raise_error('failed')
+        .to raise_error(Issuesrc::IssuesrcError)
+    end
+  end
+
+  describe '#load_tag_finders' do
+    def test_load_tag_finders(from_config, mock_load_comp=true)
+      allow(Issuesrc::Config).to receive(:option_from_config)
+        .with(['tag_finders', 'tag_finders'], @config)
+        .and_return(from_config)
+      allow(@obj).to receive(:load_tag_extractor)
+        .and_return('fake tag extractor')
+
+      types = from_config ? from_config : Issuesrc::DEFAULT_TAG_FINDERS
+      if types
+        i = 1
+        types.each do |v|
+          if mock_load_comp
+            path, cls = ["fake path #{i}", "fake cls #{i}"]
+            allow(@obj).to receive(:load_component_by_type)
+              .with(v, Issuesrc::TAG_FINDERS)
+              .and_return([path, cls])
+          else
+            path, cls = @obj.send(
+              :load_component_by_type, v, Issuesrc::TAG_FINDERS)
+          end
+          allow(@obj).to receive(:do_require)
+            .with(path)
+          allow(@obj).to receive(:make_tag_finder)
+            .with(cls, 'fake tag extractor')
+            .and_return("finder #{v}")
+          i += 1
+        end
+      end
+
+      @obj.send(:load_tag_finders)
+    end
+
+    it 'loads the required tag finders' do
+      got = test_load_tag_finders(['fake', 'types'])
+      expect(got).to be == ['finder fake', 'finder types']
+    end
+
+    it 'loads the default tag finders when no option is given' do
+      got = test_load_tag_finders(nil)
+      expect(got).to be == (Issuesrc::DEFAULT_TAG_FINDERS.collect do |v|
+        "finder #{v}"
+      end)
+    end
+
+    it 'fails when loading an unknown component' do
+      expect { test_load_tag_finders(['madeup'], false) }
+        .to raise_error(Issuesrc::IssuesrcError)
+    end
+  end
+
+  describe '#select_tag_finder_for' do
+    before :each do
+      @file = instance_double('Issuesrc::FSFile', :type => 'ty')
+      @tag_finders = [
+        instance_double('Issuesrc::TagFinder'),
+        instance_double('Issuesrc::TagFinder')
+      ]
+    end
+
+    it 'returns the finder which accepts this file type' do
+      allow(@tag_finders[0]).to receive(:accepts?)
+        .with(@file).and_return(false)
+      allow(@tag_finders[1]).to receive(:accepts?)
+        .with(@file).and_return(true)
+
+      got = @obj.select_tag_finder_for(@file, @tag_finders)
+
+      expect(got).to be == @tag_finders[1]
+    end
+
+    it 'returns nil when no finder is found' do
+      allow(@tag_finders[0]).to receive(:accepts?)
+        .with(@file).and_return(false)
+      allow(@tag_finders[1]).to receive(:accepts?)
+        .with(@file).and_return(false)
+
+      got = @obj.select_tag_finder_for(@file, @tag_finders)
+
+      expect(got).to be == nil
     end
   end
 
-  # TODO(#27): Complete testing.
+  describe '#classify_tags' do
+    before :each do
+      @tags = [
+        instance_double('Issuesrc::Tag', :issue_id => '123'),
+        instance_double('Issuesrc::Tag', :issue_id => nil),
+        instance_double('Issuesrc::Tag', :issue_id => '456'),
+        instance_double('Issuesrc::Tag', :issue_id => nil),
+      ]
+    end
+
+    it 'classifies tags between those with IDs and new ones' do
+      tags_by_issue, new_tags = @obj.send(:classify_tags, @tags)
+      expect(tags_by_issue).to be == {
+        '123' => @tags[0],
+        '456' => @tags[2],
+      }
+      expect(new_tags).to be == [@tags[1], @tags[3]]
+    end
+  end
+
+  describe '#save_tag_in_file' do
+    before :each do
+      @obj.init_files_offsets()
+      @tag = instance_double('Issuesrc::Tag',
+          :issue_id => '123',
+          :file => instance_double('Issuesrc::FSFile', :path => 'fake path'))
+    end
+
+    it 'saves a tag in its file and saves the given offset' do
+      allow(@tag).to receive(:write_in_file).with([]).and_return('offsets')
+      @obj.send(:save_tag_in_file, @tag)
+
+      expect(@obj.files_offsets).to be == {
+        'fake path' => 'offsets'
+      }
+    end
+  end
 end

data/spec/sourcers/git_sourcer_spec.rb

@@ -0,0 +1,4 @@
+require_relative '../spec_helper'
+require_relative '../../lib/sourcers/git_sourcer'
+
+# TODO(#34): Test GitSourcer.

data/spec/sourcers/github_sourcer_spec.rb

@@ -0,0 +1,4 @@
+require_relative '../spec_helper'
+require_relative '../../lib/sourcers/github_sourcer'
+
+# TODO(#35): Test GithubSourcer.

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+
+  SimpleCov.start
+end

data/spec/tag_finders/blunt_tag_finder_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../spec_helper'
+require_relative '../../lib/tag_finders/blunt_tag_finder'
+
+describe Issuesrc::TagFinders::BluntTagFinder do
+  before :all do
+    tag_extractor = Issuesrc::TagExtractor.new({}, {})
+    @obj = Issuesrc::TagFinders::BluntTagFinder.new(tag_extractor, {}, {})
+
+    # BUG: Comments in @base_file are being parsed! We need a way of overriding this.
+    @base_file = <<EOD
+This is a file with several kind of comments supposed to be caught.
+
+/*This is a normal block of BUG code*/
+
+<!--
+TODO: Multiline should work too.
+abc  BUG: Another one.
+-->
+
+Haskell has {- TODO comments like-} this.
+
+
+// This should match FIXME(tcard): until the end of the line.
+
+Also # TODO(#38): like this.
+"Don't" be -- crazy TODO and # TODO(#39): mix them!
+
+EOD
+    
+    @cases = {
+      'madeup' => [
+        # BUG(#40): Shouldn't match end of block comments.
+        [97, 107, 'BUG: code*/'],
+        [240, 280, 'FIXME(tcard): until the end of the line.'],
+      ],
+      'html' => [
+        [114, 146, 'TODO: Multiline should work too.'],
+        [152, 169, 'BUG: Another one.'],
+      ],
+      'sql' => [
+        [326, 351, 'TODO: and # TODO mix them!'],
+      ],
+      'sh' => [
+        [289, 305, 'TODO: like this.'],
+        [337, 351, 'TODO: mix them!'],
+      ],
+      'hs' => [
+        [190, 210, 'TODO: comments like-}'],
+        [326, 351, 'TODO: and # TODO mix them!'],
+      ],
+    }
+  end
+
+  it 'finds all the expected tags for each language' do
+    @cases.each do |type, expected|
+      file = instance_double('Issuesrc::FSFile', :type => type)
+      expect(@obj.accepts?(file)).to be == true
+
+      allow(@obj).to receive(:get_file_body).with(file)
+        .and_return(@base_file)
+
+      tags = []
+      @obj.find_tags(file) do |tag|
+        expect(tag.file).to be == file
+        tags << [tag.begin_pos, tag.end_pos, tag.to_s]
+      end
+
+      expect(tags).to be == expected
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: issuesrc
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Toni Cárdenas
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,6 +98,7 @@ files:
 - example.toml
 - issuesrc.gemspec
 - lib/issuers/github_issuer.rb
+- lib/issuers/issuers.rb
 - lib/issuesrc.rb
 - lib/issuesrc/config.rb
 - lib/issuesrc/event_loop.rb
@@ -106,7 +108,9 @@ files:
 - lib/issuesrc/version.rb
 - lib/sourcers/git_sourcer.rb
 - lib/sourcers/github_sourcer.rb
+- lib/sourcers/sourcers.rb
 - lib/tag_finders/blunt_tag_finder.rb
+- lib/tag_finders/tag_finders.rb
 - spec/issuers/github_issuer_spec.rb
 - spec/issuesrc/config_spec.rb
 - spec/issuesrc/event_loop_spec.rb
@@ -116,6 +120,7 @@ files:
 - spec/issuesrc_spec.rb
 - spec/sourcers/git_sourcer_spec.rb
 - spec/sourcers/github_sourcer_spec.rb
+- spec/spec_helper.rb
 - spec/tag_finders/blunt_tag_finder_spec.rb
 homepage: https://github.com/tcard/issuesrc
 licenses:
@@ -151,5 +156,6 @@ test_files:
 - spec/issuesrc_spec.rb
 - spec/sourcers/git_sourcer_spec.rb
 - spec/sourcers/github_sourcer_spec.rb
+- spec/spec_helper.rb
 - spec/tag_finders/blunt_tag_finder_spec.rb
 has_rdoc: