issue-beaver 0.1.0

data/lib/issue_beaver/models/github_issue_repository.rb

@@ -0,0 +1,96 @@
+require 'octokit'
+require 'hashie'
+require 'enumerable/lazy'
+require 'password/password'
+
+module IssueBeaver
+  module Models
+    class GithubIssueRepository
+
+      def initialize(repo, login = nil, password = nil, default_attributes = {})
+        @repo = repo
+        @login = login
+        @password = password
+        @default_attributes = Hashie::Mash.new(default_attributes)
+      end
+
+      attr_reader :default_attributes, :repo
+
+
+      def all
+        @fetched_issues ||=
+          Enumerator.new do |y|
+            with_login{@client.list_issues(@repo)}.each do |i|
+              y << i
+            end
+          end.memoizing.lazy
+        @local_issues ||= []
+        @issues ||= @fetched_issues.merge_right(@local_issues, :number).lazy
+      end
+
+
+      def first
+        all.at(0)
+      end
+
+
+      def update(number, attrs)
+        sync_cache do
+          with_login{@client.update_issue(@repo, number, attrs.title, attrs.body, attrs.only(:state, :labels, :assignee))}
+        end
+      end
+
+
+      def create(attrs)
+        sync_cache do
+          with_login{@client.create_issue(@repo, attrs.title, attrs.body, attrs.only(:state, :labels, :assignee))}
+        end
+      end
+
+
+      private
+
+      def sync_cache
+        new_attrs = begin
+          yield
+        rescue Octokit::UnprocessableEntity => e
+          puts "Failed to save issue (Check if there are invalid assignees or labels)"
+          puts e
+          return nil
+        end
+        @local_issues << new_attrs
+        new_attrs
+      end
+
+
+      def with_login(&block)
+        if @login && @password
+          @client ||= Octokit::Client.new(login: @login, password: @password)
+        else
+          @client ||= Octokit
+        end
+        block.call()
+      rescue Octokit::Unauthorized,Octokit::NotFound => e
+        @retries ||= 1
+        @client = nil
+        @login = nil if @retries > 1
+
+        unless @login
+          print "Github login: "
+          @login = STDIN.gets.chomp
+        end
+
+        @password = Password.ask("Github password: ")
+        puts
+
+        if @retries < 3
+          @retries += 1
+          retry
+        else
+          raise e
+        end
+      end
+
+    end
+  end
+end

data/lib/issue_beaver/models/merger.rb

@@ -0,0 +1,146 @@
+require 'levenshtein'
+
+module IssueBeaver
+  module Models
+    class Merger
+
+      def initialize(issues, todos)
+        @issues = issues
+        @matcher = Matcher.new(@issues, todos)
+      end
+
+
+      def added
+        @added ||= merged_issues.select(&:new?)
+      end
+
+
+      def modified
+        @modified ||= merged_issues.select(&:must_update?)
+      end
+
+
+      def changed
+        @changed ||= merged_issues.select{|e| e.must_update? || e.new? }
+      end
+
+
+      # TODO: Detect removed TODO comments and close Issue on Github
+      # Can probably be done by looking up the git history of a file.
+
+      def merged_issues
+        @merged_issues ||=
+        @matcher.matches.map do |todo, issue|
+          if issue
+            if todo.updated_at > issue.updated_at
+              issue.update_attributes(todo.attributes)
+            end
+          else
+            issue = todo
+          end
+          issue
+        end
+      end
+    end
+
+
+    class Matcher
+
+      def initialize(issues, todos)
+        @issue_matcher = IssueMatcher.new(issues)
+        @todos = todos
+      end
+
+
+      def matches
+        @matches ||=
+          Enumerator.new do |yielder|
+            @todos.each do |todo|
+              match = @issue_matcher.find_and_check_off(todo)
+              issue = match ? match.issue : nil
+              yielder << [todo, issue]
+            end
+          end.memoizing.lazy
+      end
+
+    end
+
+    class IssueMatcher
+
+      def initialize(issues)
+        @issues = issues
+        @found_issues = []
+      end
+
+
+      # Won't match the same issue twice for two different todos
+      def find_and_check_off(todo)
+        find(todo).tap do |match|
+          @found_issues.push match.issue if match
+        end
+      end
+
+
+      def find(todo)
+        best_match = all_matches(todo).sort_by(&:degree).first
+        if best_match && best_match.sane?
+          best_match
+        else
+          nil
+        end
+      end
+
+
+      private
+
+      def all_matches(todo)
+        @issues.reject{|issue| @found_issues.include? issue}.
+                map{|issue| Match.new(todo, issue) }
+      end
+
+
+      class Match
+
+        TITLE_THRESHOLD = 0.4
+        BODY_THRESHOLD = 0.9
+
+        def initialize(todo, issue)
+          @todo = todo
+          @issue = issue
+        end
+
+        attr_reader :todo, :issue
+
+
+        def sane?
+          (title_degree < TITLE_THRESHOLD) ||
+          ((body_degree < BODY_THRESHOLD) && (body_accuracy < 0.1))
+        end
+
+
+        def degree
+          title_degree + (body_degree * 0.25)
+        end
+
+
+        def title_degree() levenshtein(@issue.title, @todo.title) end
+
+
+        def body_degree() levenshtein(@issue.body, @todo.body) end
+
+
+        def body_accuracy() 1.0/[@issue.body.to_s.length, @todo.body.to_s.length].min.to_f end
+
+
+        private
+
+        def levenshtein(a, b)
+          Levenshtein.distance(a.to_s, b.to_s).to_f / [1, a.to_s.length, b.to_s.length].max
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/issue_beaver/models/todo_comments.rb

@@ -0,0 +1,57 @@
+require 'pathname'
+require 'active_support/core_ext' # Needed for delegate
+require 'active_model'
+require 'hashie'
+require 'enumerable/lazy'
+require 'enumerator/memoizing'
+
+module IssueBeaver
+  module Models
+    class TodoComments
+
+      def initialize(root_dir, files)
+        @root_dir = root_dir
+        @files = files
+      end
+
+
+      def all
+        @todos ||= enum_scanned_files(@files).memoizing.lazy
+      end
+
+
+      private
+
+      # TODO: Allow individual TODOs to follow right after each other without newline in between
+      def enum_scanned_files(files)
+        Enumerator.new do |yielder|
+          todos = []
+          parser = Grammars::RubyCommentsParser.new
+        
+          files.each do |file|
+            content = File.read(file)
+            parser.parse(content).comments.each{|comment| 
+              yielder << new_todo(
+                comment.merge('file' => relative_path(file),
+                              'created_at' => File.ctime(file),
+                              'updated_at' => File.ctime(file)
+                              ))
+            }
+          end
+        end
+      end
+
+
+      def new_todo(attrs)
+        GithubIssue.new_from_todo(attrs)
+      end
+
+
+      def relative_path(file)
+        Pathname.new(File.absolute_path(file)).
+          relative_path_from(Pathname.new(File.absolute_path(@root_dir))).to_s
+      end
+
+    end
+  end
+end

data/lib/issue_beaver/models.rb

@@ -0,0 +1,5 @@
+require 'issue_beaver/models/git'
+require 'issue_beaver/models/github_issue_repository'
+require 'issue_beaver/models/github_issue'
+require 'issue_beaver/models/todo_comments'
+require 'issue_beaver/models/merger'

data/lib/issue_beaver/runner.rb

@@ -0,0 +1,176 @@
+require 'yaml'
+require 'time-lord'
+
+module IssueBeaver
+  class Runner
+
+    COMMANDS = %w(find status diff commit help)
+
+    def self.run(*args)
+      command = args[0]
+      runner = self.new
+      command = args[0]
+      command = "unknown" unless COMMANDS.include? command
+      runner.send(command, *args)
+    end
+
+
+    def find(*args)
+      config['dir'] = dir(args[1]) if args[1]
+
+      if todo_comments.all.any?
+        _list_status(todo_comments.all)
+      else
+        puts "Nothing found"
+      end
+    end
+
+
+    def status(*args)
+      config['dir'] = dir(args[1]) if args[1]
+      issues = merger(github_issues.all, todo_comments.all).changed
+      if issues.any?
+        _list_status(issues)
+      else
+        puts "Nothing new"
+      end
+    end
+
+
+    def diff(*args)
+      config['dir'] = dir(args[1]) if args[1]
+      issues = merger(github_issues.all, todo_comments.all).changed
+      if issues.any?
+        _list_diff(issues)
+      else
+        puts "Nothing new"
+      end
+    end
+
+
+    def commit(*args)
+      config['dir'] = dir(args[1]) if args[1]
+      issues = merger(github_issues.all, todo_comments.all).changed
+      issues.each do |issue|
+        issue.save
+      end
+    end
+
+
+    def help
+      puts "Available commands: #{COMMANDS.join(", ")}"
+    end
+
+
+    private
+
+    def unknown(command = "", *args, &block)
+      puts "#{command}: Command not found"
+      help
+    end
+
+
+    def max_length(list, attr, elem = nil)
+      if elem
+        elem.send(attr).to_s.length
+      else
+        list.map(&attr).max{ |a,b| a.to_s.length <=> b.to_s.length}.to_s.length
+      end
+    end
+
+
+    def format_status(todos, todo)
+      mod = sprintf "%#{max_length(todos, :modifier, todo)}s   ", todo.modifier
+      file = sprintf "%#{max_length(todos, :file, todo)}s", todo.file
+      begin_line = sprintf "%-#{max_length(todos, :begin_line, todo)}s  ", todo.begin_line
+      title = sprintf "%-#{max_length(todos, :title, todo) + 8}s", todo.title
+      "#      #{mod}#{title} #{file}:#{begin_line}"
+    end
+
+
+    def format_diff(todos, todo)
+      mod = sprintf "%#{max_length(todos, :modifier, todo)}s   ", todo.modifier
+      file = sprintf "%#{max_length(todos, :file, todo)}s", todo.file
+      begin_line = sprintf "%-#{max_length(todos, :begin_line, todo)}s  ", todo.begin_line
+      title = sprintf "%-#{max_length(todos, :title, todo) + 8}s", todo.title
+      updated_at = "(#{todo.updated_at.ago_in_words})  "
+      attrs = sprintf "%-#{max_length(todos, :changed_attributes_for_update, todo)}s", todo.changed_attributes_for_update
+      "#      #{mod}#{title} at #{file}:#{begin_line}#{updated_at}#{attrs}"
+    end
+
+
+    def _list_diff(todos)
+      todos.each do |todo|
+        puts format_diff(todos, todo)
+      end
+    end
+
+
+    def _list_status(todos)
+      todos.each do |todo|
+        puts format_status(todos, todo)
+      end
+    end
+
+
+    def todo_comments(config = config)
+      @todo_comments ||=
+      Models::TodoComments.new(
+        repo(config).root_dir,
+        repo(config).files(config['dir'])
+        )
+    end
+
+
+    def github_issues(config = config)
+      Models::GithubIssue.use_repository(Models::GithubIssueRepository.new(
+        repo(config).slug,
+        repo(config).github_user,
+        nil,
+        {:labels => repo(config).labels})) 
+      Models::GithubIssue
+    end
+
+
+    def repo(config = config)
+      @repo ||= Models::Git.new(config['dir'], nil)
+    end
+
+
+    def merger(a, b)
+      @merger ||= Models::Merger.new(a, b)
+    end
+
+
+    def git_repo(config = config)
+      repo = Grit::Repo.new(config['dir'])
+    end
+
+
+    def config
+      @config ||=
+      begin
+        config_file = ".issuebeaver.yml"
+        config = DEFAULT_CONFIG.dup
+
+        if File.readable?(config_file)
+          config.merge!(YAML.load(File.read(config_file)))
+        end
+
+        config
+      end
+    end
+
+
+    def dir(path)
+      File.absolute_path(path)
+    end
+
+
+    DEFAULT_CONFIG =
+      {
+        'dir' => '.',
+      }
+
+  end
+end