issue-beaver 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+gem 'treetop'
+gem 'octokit'
+gem 'activemodel'
+gem 'levenshtein'
+gem 'hashie'
+gem 'time-lord'
+gem 'enumerable-lazy', '~> 0.0.1'
+gem 'enumerator-memoizing'
+gem 'grit'
+
+group :test do
+  gem 'rspec'
+end
+
+group :development do
+  gem 'debugger'
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    builder (3.0.3)
+    columnize (0.3.6)
+    debugger (1.2.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
+    diff-lcs (1.1.3)
+    enumerable-lazy (0.0.1)
+    enumerator-memoizing (0.0.1)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.8)
+      faraday (>= 0.7.4, < 0.9)
+    grit (2.5.0)
+      diff-lcs (~> 1.1)
+      mime-types (~> 1.15)
+      posix-spawn (~> 0.3.6)
+    hashie (1.2.0)
+    i18n (0.6.1)
+    levenshtein (0.2.2)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    octokit (1.13.0)
+      addressable (~> 2.2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.2)
+      multi_json (~> 1.3)
+    polyglot (0.3.3)
+    posix-spawn (0.3.6)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    time-lord (0.2.5)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  debugger
+  enumerable-lazy (~> 0.0.1)
+  enumerator-memoizing
+  grit
+  hashie
+  levenshtein
+  octokit
+  rspec
+  time-lord
+  treetop

data/README.md

@@ -0,0 +1,38 @@
+Issue Beaver
+============
+
+**This is work in progress**
+
+ * **Issue Beaver** scans your project's source code for comments containing *TODO*.
+
+ * **Issue Beaver** automatically creates new issues on Github for each TODO comment it finds.
+
+ * **Issue Beaver** automatically closes issues on Github when you remove a TODO comment.
+
+The goal is to provide simple and lightweight tracking of low-level technical issues (TODOs) and make the project's progress more transparent for people who don't want to read the source code.
+
+![a beaver](http://kidsfront.com/coloring-pages/sm_color/beaver.jpg)
+
+Configuration
+-------------
+
+### Repository
+Issue beaver tries to use the Github repository specified in **remote.origin** of your local git repository for storing the issues. If you want to use a different repository (e.g. that of your own fork) you can set the **issuebeaver.repository** config variable:
+
+```
+git config issuebeaver.repository eckardt/issue-beaver
+```
+
+### Github login
+If you don't want to be asked for your Github login you can set the **github.user** config variable. Your Github password won't be stored.
+
+```
+git config github.user eckardt
+```
+
+### Issue labels
+You can specify a list of labels that should be used for issues created by Issue Beaver. Make sure to create the labels for your repository using Github Issues' *Manage Labels* feature, otherwise Issue Beaver will fail.
+
+```
+git config issuebeaver.labels todo,@high
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+
+class GemHelperWithForce < Bundler::GemHelper
+  def build_gem
+    file_name = nil
+    sh("gem build -f -V '#{spec_path}'") { |out, code|
+      file_name = File.basename(built_gem_path)
+      FileUtils.mkdir_p(File.join(base, 'pkg'))
+      FileUtils.mv(built_gem_path, 'pkg')
+      Bundler.ui.confirm "#{name} #{version} built to pkg/#{file_name}"
+    }
+    File.join(base, 'pkg', file_name)
+  end
+end
+
+GemHelperWithForce.install_tasks

data/bin/issuebeaver

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'issue_beaver'
+IssueBeaver::Runner.run(*ARGV)

data/issue-beaver.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "issue-beaver"
+  s.version     = "0.1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Stephan Eckardt"]
+  s.email       = ["mail@stephaneckardt.com"]
+  s.homepage    = "https://github.com/eckardt/issue-beaver"
+  s.summary     = %q{Issue Beaver creates Github Issues for TODO comments in your source code}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/enumerable/merge.rb

@@ -0,0 +1,24 @@
+module Enumerable
+  # The right enumerator is accessed first
+  def merge_right(other_enum, id_method = nil)
+    Enumerator.new do |yielder|
+      yielded_ids = []
+
+      other_enum.each do |x|
+        id = id_method ? x.send(id_method) : x
+        yielded_ids << id
+        yielder << x
+      end
+
+      self.each do |x|
+        id = id_method ? x.send(id_method) : x
+        yielder << x unless yielded_ids.include? id
+      end
+    end
+  end
+
+  # The left enumerator is accessed first
+  def merge_left(other_enum, id_method = nil)
+    other_enum.merge_right(self, id_method)
+  end
+end

data/lib/issue_beaver/grammars/ruby_comments.rb

@@ -0,0 +1,9 @@
+module IssueBeaver
+  module Grammars
+    module RubyComments
+      class Mention < Treetop::Runtime::SyntaxNode
+        
+      end
+    end
+  end
+end

data/lib/issue_beaver/grammars/ruby_comments.treetop

@@ -0,0 +1,110 @@
+module IssueBeaver
+  module Grammars
+    grammar RubyComments
+      rule comments
+        (comment / non_comment)* {
+          def comments
+            elements.map{|element|
+              next unless element.respond_to?(:title)
+
+              {
+                'begin_line' => element.begin_line,
+                'title' => element.title,
+                'body' => element.body,
+                'assignee' => element.assignee
+              }
+            }.compact
+          end
+        }
+      end
+
+      rule non_comment
+        .
+      end
+
+      rule comment
+        todo_comment / normal_comment
+      end
+
+      rule todo_comment
+        todo_comment_title todo_comment_body {
+          def label() todo_comment_title.label end
+          def title() todo_comment_title.text end
+          def assignee() todo_comment_title.assignee end
+
+          def begin_line
+            parent.text_value.line_of interval.begin
+          end
+
+          def body
+            todo_comment_body.text
+          end
+        }
+      end
+
+      rule todo_comment_title
+        '#' white? 'TODO' ':'? white? comment_line white? eoc {
+          def label() 'todo' end
+
+          def assignee() comment_line.mentions.first end
+
+          def text
+            comment_line.text
+          end
+        }
+      end
+
+      rule todo_comment_body
+        todo_comment_body_line* {
+          def text
+            elements.map(&:text).join("\n") if elements.any?
+          end
+        }
+      end
+
+      rule todo_comment_body_line
+        white? '#' white? comment_line eoc {
+          def text
+            comment_line.text_value
+          end
+        }
+      end
+
+      rule normal_comment
+        '#' white? comment_line eoc
+      end
+ 
+      # TODO: Big refactor to make this fast
+      rule comment_line
+        (mention / (!eoc .))* {
+          def mentions
+            elements.select {|element|
+              element.kind_of? Mention
+            }.map(&:text_value)
+          end
+          def text
+            elements.reject {|element|
+              element.kind_of? Mention
+            }.map(&:text_value).join("")
+          end
+        }
+      end
+
+      rule mention
+        white '@' [a-zA-Z]+ white? <Mention> {
+          def text_value
+            elements[2].text_value
+          end
+        }
+      end
+
+      rule white
+        [ \t]+
+      end
+
+      rule eoc
+        "\n" / !.
+      end
+    end
+  end
+end

data/lib/issue_beaver/grammars.rb

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

data/lib/issue_beaver/models/git.rb

@@ -0,0 +1,63 @@
+require 'grit'
+
+module IssueBeaver
+  module Models
+    class Git
+
+      def initialize(dir, repo_name)
+        @root_dir = discover_root_dir(dir)
+        @git = Grit::Repo.new(@root_dir)
+        @repo_name = repo_name || @git.config['issuebeaver.repository'] || 'remote.origin'
+      end
+
+      attr_reader :root_dir
+
+
+      def slug
+        @slug ||= discover_github_repo(@repo_name)
+      end
+
+
+      def github_user
+        @github_user ||= @git.config['github.user']
+      end
+
+      def labels
+        @labels ||= (@git.config['issuebeaver.labels'] || "").split(',')
+      end
+
+
+      def discover_github_repo(repo_name)
+        github_repo = nil
+        if repo_name.match(/[^\.]+\/[^\.]+/)
+          github_repo = repo_name
+        else
+          url = @git.config["#{repo_name}.url"]
+          github_repo = url.match(/git@github\.com:([^\.]+)\.git/)[1] if url
+        end
+        github_repo
+      end
+
+
+      def files(dir)
+        IO.popen(%Q{cd "#{@root_dir}" && git ls-files "#{dir}"}).lazy.memoizing.
+          map(&:chomp).map{|file| File.absolute_path(file, @root_dir) }.lazy
+      end
+
+
+      private
+
+      def discover_root_dir(dir)
+        cd = dir
+        loop do
+          return nil if !Dir.exists?(cd)
+          return nil if File.absolute_path(cd) == '/'
+          return cd if Dir.exists?(File.join(cd, '.git'))
+          cd = File.join(cd, '..')
+        end
+        return nil
+      end
+
+    end
+  end
+end

data/lib/issue_beaver/models/github_issue.rb

@@ -0,0 +1,106 @@
+require 'active_support/core_ext' # Needed for delegate
+require 'time'
+
+module IssueBeaver
+  module Models
+    class GithubIssue
+
+      def self.use_repository(repository)
+        @repository = repository
+
+        class << self
+          delegate :update, :create, :default_attributes, :first, to: :@repository
+        end
+      end
+
+
+      def self.repo_name() @repository.repo if @repository end
+
+
+      def self.all
+        Shared::ModelCollection.new(self, @repository.all.map{|attrs| new_from_github(attrs.dup)})
+      end
+
+
+      include Shared::AttributesModel
+      ATTRIBUTES = [:number, :state, :title, :body, :file, :begin_line, :created_at, :updated_at, :labels, :assignee]      
+
+
+      def closed?() state == "closed" end
+
+
+      def open?() state == "open" end
+
+
+      def new?() !number end
+
+
+      def persisted?() !new? && !changed? end
+
+
+      def must_update?() changed_attributes_for_update.any? end
+
+
+      def changed_attributes_for_update
+        Hashie::Mash.new(changed_attributes).only(:title, :body, :assignee)
+      end
+
+
+      def self.new_from_github(attrs)
+        new(attrs).tap do |obj|
+          obj.clean_attributes_from_github
+        end
+      end
+
+
+      def self.new_from_todo(attrs)
+        new(attrs).tap do |obj|
+          obj.clean_attributes_from_todo
+        end
+      end
+
+
+      def initialize(attrs = {})
+        @attributes = Hashie::Mash.new(attrs)
+        ATTRIBUTES.each do |attr| @attributes[attr] ||= nil end
+      end
+
+
+      def clean_attributes_from_github
+        self.attributes.merge! self.class.default_attributes
+        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)
+        @changed_attributes = nil
+      end
+
+
+      def clean_attributes_from_todo
+        basename = File.basename(self.file)
+        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}}
+        @changed_attributes = nil
+      end
+
+
+      def update_attributes_with_limit(attrs)
+        update_attributes_without_limit(attrs.only(:title, :body, :updated_at, :assignee))
+      end
+      alias_method_chain :update_attributes, :limit
+
+
+      def save
+        if new?
+          @attributes = self.class.create(attributes)
+        elsif changed?
+          @attributes = self.class.update(number, attributes)
+        end
+        @changed_attributes.clear
+        true
+      end
+
+    end
+  end
+end