issue-beaver 0.1.2 → 0.2.0

data/lib/enumerable/merge.rb

@@ -14,7 +14,7 @@ module Enumerable
         id = id_method ? x.send(id_method) : x
         yielder << x unless yielded_ids.include? id
       end
-    end
+    end.lazy
   end
 
   # The left enumerator is accessed first

data/lib/issue_beaver/grammars.rb

@@ -1,4 +1,6 @@
 require 'treetop'
 
 require 'issue_beaver/grammars/ruby_comments'
-Treetop.load File.expand_path('../grammars/ruby_comments.treetop', __FILE__)
+require 'issue_beaver/grammars/github_issue_body'
+Treetop.load File.expand_path('../grammars/ruby_comments.treetop', __FILE__)
+Treetop.load File.expand_path('../grammars/github_issue_body.treetop', __FILE__)

data/lib/issue_beaver/grammars/github_issue_body.rb

@@ -0,0 +1,11 @@
+module IssueBeaver
+  module Grammars
+    module GithubIssueBody
+      MAGIC = "ISSUEBEAVER_ISSUE"
+
+      def self.build_mark(file, begin_line, commit)
+        "<!-- #{MAGIC}[#{file}:#{begin_line}@#{commit}] -->"
+      end
+    end
+  end
+end

data/lib/issue_beaver/grammars/github_issue_body.treetop

@@ -0,0 +1,51 @@
+module IssueBeaver
+  module Grammars
+    grammar GithubIssueBody
+      rule details
+        (mark / .)* {
+          def details
+            details = elements.find{|e| e.respond_to?(:is_mark?) }
+            return nil unless details
+
+            {
+              commit: details.commit_id.text_value.to_s,
+              begin: details.begin_line.text_value.to_i,
+              file: details.file.text_value.to_s
+            }
+          end
+        }
+      end
+
+      # Example for a mark:
+      # <!-- ISSUEBEAVER_ISSUE[fixtures/ruby.rb:2@879bee2f50] -->
+      # Update GithubIssueBody.build_mark when changing this!
+      rule mark
+        '<!--' white? magic_string '[' file ':' begin_line '@' commit_id ']' white? '-->' {
+          def is_mark?
+            true
+          end
+        }
+      end
+
+      rule magic_string
+        'ISSUEBEAVER_ISSUE'
+      end
+
+      rule file
+        [^:]+
+      end
+
+      rule begin_line
+        [0-9]+
+      end
+
+      rule commit_id
+        [0-9a-fA-F]+
+      end
+
+      rule white
+        [ \t]+
+      end
+    end
+  end
+end

data/lib/issue_beaver/models/git.rb

@@ -45,6 +45,17 @@ module IssueBeaver
       end
 
 
+      def head_commit
+        @head_commit ||= `git rev-parse HEAD`.chomp
+      end
+
+
+      def is_ahead?(commit)
+        return false unless commit
+        !`git rev-list "#{head_commit}" | grep $(git rev-parse "#{commit}")`.chomp.empty?
+      end
+
+
       private
 
       def discover_root_dir(dir)

data/lib/issue_beaver/models/github_issue.rb

@@ -9,10 +9,14 @@ module IssueBeaver
         @repository = repository
 
         class << self
-          delegate :update, :create, :default_attributes, :first, to: :@repository
+          delegate :update, :create, :first, to: :@repository
         end
       end
 
+      def self.default_attributes
+        @repository ? @repository.default_attributes : {}
+      end
+
 
       def self.repo_name() @repository.repo if @repository end
 
@@ -23,8 +27,7 @@ module IssueBeaver
 
 
       include Shared::AttributesModel
-      ATTRIBUTES = [:number, :state, :title, :body, :file, :begin_line, :created_at, :updated_at, :labels, :assignee]      
-
+      ATTRIBUTES = [:number, :state, :title, :body, :file, :begin_line, :created_at, :updated_at, :labels, :assignee, :commit]      
 
       def closed?() state == "closed" end
 
@@ -41,6 +44,15 @@ module IssueBeaver
       def must_update?() changed_attributes_for_update.any? end
 
 
+      def must_close?() !!@must_close end
+
+
+      def mark_for_closing(flag = true)
+        @must_close = flag
+        self.state = "closed"
+      end
+
+
       def changed_attributes_for_update
         Hashie::Mash.new(changed_attributes).only(:title, :body, :assignee)
       end
@@ -71,6 +83,14 @@ module IssueBeaver
         self.created_at = Time.parse(created_at) if created_at.kind_of?(String)
         self.updated_at = Time.parse(updated_at) if updated_at.kind_of?(String)
         self.assignee = assignee.login if assignee.respond_to?(:login)
+        self.body ||= ""
+
+        if details = Grammars::GithubIssueBodyParser.new.parse(self.body).details
+          self.commit = details[:commit]
+          self.begin_line = details[:begin]
+          self.file = details[:file]
+        end
+
         @changed_attributes = nil
       end
 
@@ -80,10 +100,13 @@ module IssueBeaver
         self.title ||= ""
         self.title = "#{self.title.capitalize} (#{basename}:#{self.begin_line})"
         github_line_url = "https://github.com/#{self.class.repo_name}/blob/master/#{self.file}\#L#{self.begin_line}"
-        self.body = %Q{#{self.body}\n\n#{github_line_url}}
+        self.body = %Q{#{self.body}\n\n#{github_line_url}\n\n#{magic_mark}}
         @changed_attributes = nil
       end
 
+      def magic_mark
+        Grammars::GithubIssueBody.build_mark(file, begin_line, commit)
+      end
 
       def update_attributes_with_limit(attrs)
         update_attributes_without_limit(attrs.only(:title, :body, :updated_at, :assignee))
@@ -97,7 +120,7 @@ module IssueBeaver
         elsif changed?
           @attributes = self.class.update(number, attributes)
         end
-        @changed_attributes.clear
+        @changed_attributes.clear if @changed_attributes
         true
       end
 

data/lib/issue_beaver/models/merger.rb

@@ -4,9 +4,10 @@ module IssueBeaver
   module Models
     class Merger
 
-      def initialize(issues, todos)
+      def initialize(issues, todos, repo)
         @issues = issues
         @matcher = Matcher.new(@issues, todos)
+        @repo = repo
       end
 
 
@@ -21,12 +22,14 @@ module IssueBeaver
 
 
       def changed
-        @changed ||= merged_issues.select{|e| e.must_update? || e.new? }
+        @changed ||= added.merge_left(modified).merge_left(closed, :number)
       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 closed
+        @closed ||= unmatched_issues.select(&:must_close?)
+      end
+
 
       def merged_issues
         @merged_issues ||=
@@ -41,6 +44,18 @@ module IssueBeaver
           issue
         end
       end
+
+      # TODO: Tidy up a bit
+      def unmatched_issues
+        @unmatched_issues ||=
+          Enumerator.new do |yielder|
+            @issues.to_a.each do |issue|
+              next if merged_issues.to_a.map(&:number).include? issue.number
+              issue.mark_for_closing if @repo.is_ahead?(issue.commit)
+              yielder << issue
+            end
+          end.memoizing.lazy
+      end
     end
 
 

data/lib/issue_beaver/models/todo_comments.rb

@@ -9,21 +9,22 @@ module IssueBeaver
   module Models
     class TodoComments
 
-      def initialize(root_dir, files)
+      def initialize(root_dir, files, head)
         @root_dir = root_dir
         @files = files
+        @head = head
       end
 
 
       def all
-        @todos ||= enum_scanned_files(@files).memoizing.lazy
+        @todos ||= enum_scanned_files(@files, @head).memoizing.lazy
       end
 
 
       private
 
       # TODO: Allow individual TODOs to follow right after each other without newline in between
-      def enum_scanned_files(files)
+      def enum_scanned_files(files, head_commit)
         Enumerator.new do |yielder|
           todos = []
           parser = Grammars::RubyCommentsParser.new
@@ -34,7 +35,8 @@ module IssueBeaver
               yielder << new_todo(
                 comment.merge('file' => relative_path(file),
                               'created_at' => File.ctime(file),
-                              'updated_at' => File.ctime(file)
+                              'updated_at' => File.ctime(file),
+                              'commit' => head_commit
                               ))
             }
           end

data/lib/issue_beaver/runner.rb

@@ -119,7 +119,8 @@ module IssueBeaver
       @todo_comments ||=
       Models::TodoComments.new(
         repo(config).root_dir,
-        repo(config).files(config['dir'])
+        repo(config).files(config['dir']),
+        repo(config).head_commit
         )
     end
 
@@ -139,8 +140,8 @@ module IssueBeaver
     end
 
 
-    def merger(a, b)
-      @merger ||= Models::Merger.new(a, b)
+    def merger(a, b, repo = repo)
+      @merger ||= Models::Merger.new(a, b, repo)
     end
 
 

data/lib/issue_beaver/shared/attributes_model.rb

@@ -40,6 +40,8 @@ module IssueBeaver
         def modifier
           if new?
             "added"
+          elsif must_close?
+            "closed"
           elsif changed?
             "modified"
           end

data/lib/issue_beaver/version.rb

@@ -1,3 +1,3 @@
 module IssueBeaver
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/spec/fixtures/github_issue.txt

@@ -0,0 +1,4 @@
+And this should be found
+as the body
+
+<!-- ISSUEBEAVER_ISSUE[fixtures/ruby.rb:2@879bee2f50] -->

data/spec/grammars/github_issue_body_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../spec_helper'
+
+describe IssueBeaver::Grammars::RubyCommentsParser do
+  subject { IssueBeaver::Grammars::GithubIssueBodyParser.new.parse(body) }
+  let(:details) {subject.details}
+
+  context "github_issue.txt" do
+    let(:body) { File.read('./spec/fixtures/github_issue.txt') }
+
+    it "should find a magic mark" do
+      details.should_not == nil
+    end
+
+    it "should find the file name" do
+      details[:file].should == "fixtures/ruby.rb"
+    end
+
+    it "should find the line number" do
+      details[:begin].should == 2
+    end
+
+    it "should find the commit id" do
+      details[:commit].should == "879bee2f50"
+    end
+  end
+
+  context "with empty body" do
+    let(:body){""}
+
+    it "should return nil" do
+      details.should == nil
+    end
+  end
+end

data/spec/models/github_issue_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../spec_helper'
+
+describe IssueBeaver::Models::GithubIssue do
+  let(:body) { File.read('./spec/fixtures/github_issue.txt') }
+  subject { IssueBeaver::Models::GithubIssue.new_from_github(body: body, title: "Foo") }
+  let(:attrs) { subject.attributes }
+
+  it "should find the file name" do
+    attrs[:file].should == "fixtures/ruby.rb"
+  end
+
+  it "should find the line number" do
+    attrs[:begin_line].should == 2
+  end
+
+  it "should find the commit id" do
+    attrs[:commit].should == "879bee2f50"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: issue-beaver
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -204,6 +204,8 @@ files:
 - lib/enumerable/merge.rb
 - lib/issue_beaver.rb
 - lib/issue_beaver/grammars.rb
+- lib/issue_beaver/grammars/github_issue_body.rb
+- lib/issue_beaver/grammars/github_issue_body.treetop
 - lib/issue_beaver/grammars/ruby_comments.rb
 - lib/issue_beaver/grammars/ruby_comments.treetop
 - lib/issue_beaver/models.rb
@@ -219,9 +221,12 @@ files:
 - lib/issue_beaver/shared/model_collection.rb
 - lib/issue_beaver/version.rb
 - lib/password/password.rb
+- spec/fixtures/github_issue.txt
 - spec/fixtures/ruby.rb
 - spec/fixtures/ruby2.rb
+- spec/grammars/github_issue_body_spec.rb
 - spec/grammars/ruby_comments_spec.rb
+- spec/models/github_issue_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/eckardt/issue-beaver
 licenses: []
@@ -248,7 +253,10 @@ signing_key:
 specification_version: 3
 summary: Issue Beaver creates Github Issues for TODO comments in your source code
 test_files:
+- spec/fixtures/github_issue.txt
 - spec/fixtures/ruby.rb
 - spec/fixtures/ruby2.rb
+- spec/grammars/github_issue_body_spec.rb
 - spec/grammars/ruby_comments_spec.rb
+- spec/models/github_issue_spec.rb
 - spec/spec_helper.rb