document_generator 0.0.2

data/document_generator.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'document_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'document_generator'
+  spec.version       = DocumentGenerator::VERSION
+  spec.authors       = ['wiscoDude', 'm5rk', 'stevenhallen']
+  spec.email         = ['philip@stevenhallen.com', 'mark@stevenhallen.com']
+  spec.description   = <<-DOCUMENT_GENERATOR
+Generate documentation from a git repository.
+DOCUMENT_GENERATOR
+  spec.summary       = 'Generate documentation from a git repository.'
+  spec.homepage      = 'http://github.com/stevenhallen/document_generator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.add_runtime_dependency 'git', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'rspec-fire', '~> 1.3'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+end

data/index.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Home
+---
+#{% include name.md %}
+
+TODO: We could put the content of the README file here, right?

data/lib/document_generator.rb

@@ -0,0 +1,17 @@
+require 'addressable/uri'
+require 'git'
+require 'optparse'
+require 'ostruct'
+require 'tmpdir'
+require 'uri'
+
+require 'document_generator/version'
+
+require 'document_generator/cli'
+require 'document_generator/commit'
+require 'document_generator/diff_file'
+require 'document_generator/output'
+require 'document_generator/repository'
+
+module DocumentGenerator
+end

data/lib/document_generator/cli.rb

@@ -0,0 +1,27 @@
+module DocumentGenerator
+  class CLI
+    def self.start(args)
+      options = parse(args)
+
+      Repository.new(options.url).generate
+    end
+
+    def self.parse(args)
+      options = OpenStruct.new
+
+      parser = OptionParser.new do |opts|
+        opts.on('-u', '--url URL',
+                'URL for the repository') do |url|
+          options.url = url
+        end
+      end
+
+      parser.parse!(args)
+
+      # TODO: Do something better than this.
+      raise OptionParser::MissingArgument unless options.url
+
+      options
+    end
+  end
+end

data/lib/document_generator/commit.rb

@@ -0,0 +1,85 @@
+module DocumentGenerator
+  class Commit
+    attr_accessor :base_url, :git_commit
+
+    def initialize(base_url, git_commit)
+      @base_url = base_url
+      @git_commit = git_commit
+    end
+
+    def diff_files
+      return [] unless git_commit.parent
+
+      git_commit.parent.diff(git_commit).map do |git_diff_file|
+        DiffFile.new(git_diff_file)
+      end
+    end
+
+    def relative_filename
+      filename
+    end
+
+    def create
+      File.open(relative_filename, 'w') do |writer|
+        writer.write(header)
+        writer.write(details_of_commit_message) if details_of_commit_message
+
+        diff_files.each do |diff_file|
+          writer.write(diff_file.content)
+        end
+
+        writer.write(additional)
+      end
+    end
+
+    def header
+      <<-HEADER
+---
+layout: default
+title: #{first_line_of_commit_message}
+---
+
+<h1 id="main">#{first_line_of_commit_message}</h1>
+HEADER
+    end
+
+    def additional
+      <<-ADDITIONAL
+
+### Additional Resources
+
+* [Changes in this step in `diff` format](#{URI.join(base_url, 'commit/', git_commit.sha)})
+
+ADDITIONAL
+    end
+
+    def commit_message_lines
+      git_commit.message.split("\n")
+    end
+
+    def first_line_of_commit_message
+      commit_message_lines.first
+    end
+
+    def details_of_commit_message
+      commit_message_lines[1..-1].join("\n") if commit_message_lines.length > 1
+    end
+
+    def basename_prefix
+      message = first_line_of_commit_message
+      message = message.split.join('-')
+      message.gsub!(%r{[^\w-]}, '')
+      message.downcase!
+      message.tr!('_', '-')
+      message
+    end
+
+    def filename
+      "#{basename_prefix}.md"
+    end
+
+    def link
+      "<li><a href='#{basename_prefix}.html'>#{first_line_of_commit_message}</a></li>"
+    end
+  end
+end

data/lib/document_generator/diff_file.rb

@@ -0,0 +1,157 @@
+require 'cgi'
+
+module DocumentGenerator
+  class DiffFile
+    attr_accessor :git_diff_file
+
+    def type
+      git_diff_file.type
+    end
+
+    def initialize(git_diff_file)
+      @git_diff_file = git_diff_file
+    end
+
+    def git_diff_file_lines
+      git_diff_file.patch.split("\n")
+    end
+
+    def patch_heading
+      "#{action_type} `#{git_diff_file.path}`"
+    end
+
+    def content
+      if type == 'deleted'
+        return patch_heading + "\n\n"
+      end
+
+      temp = []
+      temp << patch_heading
+
+      if markdown_outputs.any?
+        markdown_outputs.each do |output|
+          temp << "\n\n"
+          temp << output.description
+          temp << "\n<pre><code>"
+          temp << output.escaped_content
+          temp << "</code></pre>\n"
+        end
+      end
+
+      if git_diff_file.type == "modified"
+        temp << "\n\n"
+        temp << "Becomes"
+        temp << "\n<pre><code>"
+        temp << ending_code
+        temp << "\n</code></pre>\n"
+      end
+
+      temp << "\n\n"
+
+      temp.join
+    end
+
+    def ending_code
+      clean_lines = []
+      git_diff_file_lines[code_line_start..-1].each_with_index do |line, index|
+
+        if (line[0]) == "-" || ignore_line?(line)
+          next
+        end
+
+        if (line[0]) == "+"
+          line = remove_first_character(line)
+        end
+        clean_lines << line
+      end
+      Output.no_really_escape(CGI.escapeHTML(clean_lines.join("\n")))
+    end
+
+    def action_type
+      { new: 'Create file',
+        modified: 'Update file',
+        deleted: 'Remove file' }.fetch(type.to_sym, type)
+    end
+
+    def markdown_outputs # returns an array of outputs
+      outputs = []
+      last_line = 0
+      git_diff_file_lines.each_with_index do |line, index|
+        next if index < code_line_start
+        next if index <= last_line
+        case line.strip[0]
+
+        when "+"
+          last_line = last_same_line(index)
+          output = Output.new
+          output.description = "Add"
+          output.content = line_block(index, last_line)
+          outputs << output
+        when "-"
+          if line_sign(index + 1) == "+"
+            output = Output.new
+            output.description = "Change"
+            output.content = line_block(index, last_same_line(index))
+            outputs << output
+            last_line = last_same_line(last_same_line(index) + 1)
+            output = Output.new
+            output.description = "To"
+            output.content = line_block(last_same_line(index) + 1, last_line)
+            outputs << output
+          else
+            output = Output.new
+            output.description = "Remove"
+            last_line = last_same_line(index)
+            output.content = line_block(index, last_line)
+            outputs << output
+          end
+        end
+
+      end
+      outputs
+    end
+
+  private
+
+    def ignore_line?(line)
+      line.strip == 'No newline at end of file'
+    end
+
+    def last_same_line(line_index)
+      starting_sign = line_sign(line_index)
+
+      git_diff_file_lines[line_index..-1].each_with_index do |line, index|
+        if line_sign(index + 1 + line_index) != starting_sign
+          return (index + line_index)
+        end
+      end
+    end
+
+    def line_block(beginning, ending)
+      lines = []
+      git_diff_file_lines[beginning..ending].each do |line|
+        if ["+", "-"].include?(line[0..0])
+          line = remove_first_character(line)
+        end
+        if !ignore_line?(line)
+          lines << line
+        end
+      end
+      lines
+    end
+
+    def line_sign(line_number)
+      (git_diff_file_lines[line_number] || '').strip[0]
+    end
+
+    def remove_first_character(line)
+      " " + line[1..-1]
+    end
+
+    def code_line_start
+      git_diff_file_lines.each_with_index do |line, index|
+        return (index + 1) if line[0..1] == "@@"
+      end
+    end
+  end
+end

data/lib/document_generator/output.rb

@@ -0,0 +1,27 @@
+module DocumentGenerator
+  class Output
+    attr_accessor :description, :content
+
+    # TODO: This is due to a bug in maruku.  We should create
+    # an issue there--and possibly a PR to fix?
+    def self.no_really_escape(value)
+      value.split("\n").map do |line|
+        if line.strip.size.zero?
+          " "
+        else
+          line
+        end
+      end.join("\n")
+    end
+
+    def escaped_content
+      temp = []
+      content.each do |line|
+        temp << line
+        temp << "\n"
+      end
+
+      Output.no_really_escape(CGI.escapeHTML(temp.join.rstrip))
+    end
+  end
+end

data/lib/document_generator/repository.rb

@@ -0,0 +1,89 @@
+module DocumentGenerator
+  class Repository
+    attr_accessor :url
+
+    def self.menu_dirname
+      '_includes'
+    end
+
+    def self.menu_relative_filename
+      File.join(menu_dirname, 'menu.md')
+    end
+
+    def self.default_dirname
+      '_layouts'
+    end
+
+    def self.default_relative_filename
+      File.join(default_dirname, 'default.html')
+    end
+
+    def initialize(url)
+      @url = url
+    end
+
+    def base_url
+      "https://#{uri.host}#{uri.path}/"
+    end
+
+    def name
+      uri.path.split('/')[-1]
+    end
+
+    def generate
+      prepare
+
+      File.open(Repository.menu_relative_filename, 'w') do |menu_writer|
+        commits do |commit|
+          menu_writer.write(commit.link)
+          commit.create
+        end
+      end
+    end
+
+    def commits
+      Dir.mktmpdir do |path|
+        repo = Git.clone(url, name, path: path)
+
+        # TODO: Allow options to influence branch, number of commits, etc.
+        repo.log(nil).reverse_each.map do |git_commit|
+          yield Commit.new(base_url, git_commit)
+        end
+      end
+    end
+
+  private
+    def prepare
+      Dir.mkdir(Repository.menu_dirname) unless Dir.exists?(Repository.menu_dirname)
+      copy_layout
+    end
+
+    def copy_layout
+      return if File.exists?(Repository.default_relative_filename)
+
+      Dir.mkdir(Repository.default_dirname) unless Dir.exists?(Repository.default_dirname)
+
+      src = File.expand_path('../../../assets/_layouts/default.html', __FILE__)
+      dest = Repository.default_relative_filename
+
+      FileUtils.copy_file(src, dest)
+    end
+
+    def normalized_url
+      replacements = [
+        [%r(\Agit@github\.com:), 'git://github.com/'],
+        [%r(\.git\Z), '']
+      ]
+
+      replacements.each do |pattern, replacement|
+        url.gsub!(pattern, replacement)
+      end
+
+      url
+    end
+
+    def uri
+      Addressable::URI.parse(normalized_url)
+    end
+  end
+end