oleg 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf4f5f87c6d337bb62e7b3df44db52ec21b28b6d
-  data.tar.gz: 38d29d3088c021488ee771d61093893011964e80
+  metadata.gz: fe515e58859a107bbab71359a195c02320c7103f
+  data.tar.gz: 9e6be5fa4d23ca96d0bb5818bec9aaf4d5f37f25
 SHA512:
-  metadata.gz: a245d260ca274707448ac4f2c3671f46c4cb8b6a57eab49fa68087b9a65ac876cc3c1ff2a651fc9c814a371ef305e2dadf3cc973ca585366fea5dc81d38fb731
-  data.tar.gz: c120b9ab3436791c35bfe5642e050f7005375cd6c95b36f49cc3c29dffa9334bf5b555947dfcff9f113cea243562c78f83cb296e631397a1300d29ce13e3d4ab
+  metadata.gz: 0616f537ca77cb5e405e4704f50043e54d8a217fe8e29de6b8e08859063bf46ebf11677461b23b05214e9b0e817c17d0264eaee172bd0b95876e6f9da0eb2a31
+  data.tar.gz: f315be05ebda93d8e3ac796f8456f872b39f3b53857d9068272a6b8629fbcb241b41cc099bc12c027893bacd81f52846bed34aaf4514623fd0659cebfeb554c3

data/lib/leg.rb

@@ -1,6 +1,8 @@
 require 'fileutils'
 require 'yaml'
 require 'rugged'
+require 'redcarpet'
+require 'rouge'
 
 module Leg
 end

data/lib/leg/commands.rb

@@ -5,8 +5,10 @@ end
 require 'leg/commands/base_command'
 
 require 'leg/commands/diff'
+require 'leg/commands/doc'
 require 'leg/commands/help'
 require 'leg/commands/pieces'
+require 'leg/commands/fancy'
 require 'leg/commands/ref'
 require 'leg/commands/repo'
 require 'leg/commands/undiff'

data/lib/leg/commands/base_command.rb

@@ -17,6 +17,9 @@ class Leg::Commands::BaseCommand
       true: "You are not in a leg working directory.",
       false: "You are already in a leg working directory."
     },
+    config_title: {
+      true: "You need to set a title in leg.yml."
+    },
     steps_folder: {
       true: "There is no steps folder.",
       false: "There is already a steps folder."
@@ -30,6 +33,9 @@ class Leg::Commands::BaseCommand
     },
     diff: {
       true: "There is no steps.diff file."
+    },
+    doc: {
+      true: "There is no doc folder."
     }
   }
 
@@ -45,6 +51,8 @@ class Leg::Commands::BaseCommand
       case what
       when :config
         valid = true if @config
+      when :config_title
+        valid = true if @config[:title]
       when :steps_folder
         valid = true if File.exist?(File.join(@config[:path], "steps"))
       when :steps
@@ -53,6 +61,8 @@ class Leg::Commands::BaseCommand
         valid = true if File.exist?(File.join(@config[:path], "repo"))
       when :diff
         valid = true if File.exist?(File.join(@config[:path], "steps.diff"))
+      when :doc
+        valid = true if File.exist?(File.join(@config[:path], "doc"))
       else
         raise NotImplementedError
       end

data/lib/leg/commands/diff.rb

@@ -11,7 +11,7 @@ class Leg::Commands::Diff < Leg::Commands::BaseCommand
     needs! :config, :repo
 
     FileUtils.cd(File.join(@config[:path], "repo")) do
-      patches = `git format-patch --stdout -p --no-signature --root master`
+      patches = `git format-patch --stdout -p --no-signature --histogram --root master`
       File.open("../steps.diff", "w") do |f|
         step_num = 1
         patches.each_line do |line|

data/lib/leg/commands/doc.rb

@@ -0,0 +1,221 @@
+class Leg::Commands::Doc < Leg::Commands::BaseCommand
+  def self.name
+    "doc"
+  end
+
+  def self.summary
+    "Renders files in doc folder into an HTML book"
+  end
+
+  def run
+    needs! :config, :config_title, :steps_folder, :steps, :doc
+
+    FileUtils.cd(File.join(@config[:path], "doc")) do
+      FileUtils.rm_rf("html_out")
+      FileUtils.mkdir("html_out")
+
+      copy_static_files
+      write_css
+      write_html_files(prerender_diffs)
+    end
+  end
+
+  private
+
+  def copy_static_files
+    Dir["html_in/*"].each do |f|
+      name = File.basename(f)
+      unless %w(template.html style.css).include? name
+        FileUtils.cp(f, "html_out/#{name}")
+      end
+    end
+  end
+
+  def write_css
+    @config[:rouge_theme] ||= "github"
+    if @config[:rouge_theme].is_a? String
+      theme = Rouge::Theme.find(@config[:rouge_theme])
+    elsif @config[:rouge_theme].is_a? Hash
+      theme = Class.new(Rouge::Themes::Base16)
+      theme.name "base16.custom"
+      theme.palette @config[:rouge_theme]
+    end
+
+    css = File.read("html_in/style.css")
+    css << theme.render(scope: ".highlight")
+
+    File.write("html_out/style.css", css)
+  end
+
+  def prerender_diffs
+    diffs = {}
+    FileUtils.cd("../steps") do
+      FileUtils.mkdir_p("0")
+
+      last_step = "0"
+      Dir["*"].sort_by(&:to_i).each do |step|
+        names = [step.to_i.to_s]
+        if step =~ /\d+\-([\w-]+)$/
+          names << $1
+        end
+
+        diffout = []
+        section_stack = []
+        in_diff = false
+        lexer = nil
+        formatter = Rouge::Formatters::HTML.new
+
+        diff = `git diff --histogram --unified=100000 --ignore-space-change --no-index #{last_step} #{step}`
+        diff.lines.each do |line|
+          if !in_diff && line =~ /^\+\+\+ (.+)$/
+            filename = File.basename($1)
+            lexer = Rouge::Lexer.guess(filename: filename)
+            diffout << {type: :section, section_type: :file, summary: filename, content: []}
+            section_stack = [diffout.last]
+          elsif line.start_with? '@@'
+            in_diff = true
+          elsif in_diff && [' ', '+', '-'].include?(line[0])
+            line_hl = formatter.format(lexer.lex(line[1..-1])).gsub("\n", "")
+            type = {' ' => :nochange, '+' => :add, '-' => :remove }[line[0]]
+
+            section_stack.each { |s| s[:dirty] = true } if type != :nochange
+
+            if line[1..-1] =~ /^\/\*\*\* (.+) \*\*\*\/$/
+              section_stack = [section_stack[0]]
+              section_stack.last[:content] << {type: :section, section_type: :comment, summary: line[1..-1].chomp, content: []}
+              section_stack.push(section_stack.last[:content].last)
+            elsif line[1] =~ /\S/ && line.chomp[-1] == "{"
+              section_stack.pop if section_stack.length > 1 && section_stack.last[:section_type] == :braces
+              section_stack.last[:content] << {type: :section, section_type: :braces, summary: line[1..-1].chomp + " ... ", content: []}
+              section_stack.push(section_stack.last[:content].last)
+            end
+
+            section_stack.last[:content] << {type: type, content: line_hl}
+
+            if line[1..-1] =~ /^(}( \w+)?;?)$/ && section_stack.last[:section_type] == :braces
+              s = section_stack.pop
+              s[:summary] << $1
+            end
+
+            section_stack.each { |s| s[:dirty] = true } if type != :nochange
+          else
+            in_diff = false
+          end
+        end
+
+        change_chain = []
+        diffout.each do |file|
+          to_render = file[:content].dup
+          until to_render.empty?
+            cur = to_render.shift
+            if cur[:type] == :section
+              if cur[:dirty]
+                to_render = cur[:content] + to_render
+              else
+                if change_chain.first && change_chain.first[:content].empty?
+                  change_chain.first[:type] = :nochange
+                end
+                if change_chain.last && change_chain.last[:content].empty?
+                  change_chain.last[:type] = :nochange
+                end
+                change_chain = []
+              end
+            else
+              if cur[:type] == :nochange
+                if change_chain.first && change_chain.first[:content].empty?
+                  change_chain.first[:type] = :nochange
+                end
+                if change_chain.last && change_chain.last[:content].empty?
+                  change_chain.last[:type] = :nochange
+                end
+                change_chain = []
+              else
+                change_chain << cur
+                if cur[:type] == :add
+                  change_chain.each { |c| c[:omit] = true if c[:type] == :remove }
+                elsif cur[:type] == :remove
+                  cur[:omit] = true if change_chain.any? { |c| c[:type] == :add }
+                end
+              end
+            end
+          end
+        end
+
+        html = ""
+        diffout.each do |file|
+          html << "<div class=\"diff\">\n"
+          html << "<div class=\"filename\">#{file[:summary]}</div>\n"
+          html << "<pre class=\"highlight\"><code>"
+
+          to_render = file[:content].dup
+          until to_render.empty?
+            cur = to_render.shift
+            if cur[:type] == :section
+              if cur[:dirty]
+                to_render = cur[:content] + to_render
+              else
+                summary = formatter.format(lexer.lex(cur[:summary])).gsub("\n", "")
+                html << "<div class=\"line folded\">#{summary}</div>"
+              end
+            elsif !cur[:omit]
+              tag = {nochange: :div, add: :ins, remove: :del}[cur[:type]]
+              html << "<#{tag} class=\"line\">#{cur[:content]}</#{tag}>"
+            end
+          end
+
+          html << "</code></pre>\n</div>\n"
+        end
+
+        names.each do |name|
+          diffs[name] = html
+        end
+
+        last_step = step
+      end
+
+      FileUtils.rmdir("0")
+    end
+
+    diffs
+  end
+
+  def write_html_files(diffs)
+    html_template = File.read("html_in/template.html")
+
+    index = ""
+    markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+    Dir["*.md"].sort.each do |md_file|
+      html_file = md_file.sub(/\.md$/, '.html')
+
+      md = File.read(md_file)
+      md =~ /^# (.+)$/
+      title = $1
+
+      index << "<li><a href='#{html_file}'>#{title}</a></li>\n"
+
+      content = markdown.render(md)
+      content.gsub!(/<p>{{([\w-]+)}}<\/p>/) { diffs[$1] }
+
+      html = html_template.dup
+      html.gsub!("{{title}}") { "#{@config[:title]} | #{title}" }
+      html.gsub!("{{content}}") { content }
+
+      File.write(File.join("html_out", html_file), html)
+    end
+
+    content = <<~HTML
+    <h1>#{@config[:title]}</h1>
+    <h2>Table of Contents</h2>
+    <ol>
+      #{index}
+    </ol>
+    HTML
+
+    html = html_template.dup
+    html.gsub!("{{title}}", @config[:title])
+    html.gsub!("{{content}}", content)
+
+    File.write("html_out/index.html", html)
+  end
+end
+

data/lib/leg/commands/fancy.rb

@@ -0,0 +1,26 @@
+class Leg::Commands::Fancy < Leg::Commands::BaseCommand
+  def self.name
+    "fancy"
+  end
+
+  def self.summary
+    "Run steps.diff through colordiff, diff-so-fancy, and less"
+  end
+
+  def run
+    needs! :config, :diff
+
+    FileUtils.cd(@config[:path]) do
+      exec("cat steps.diff | colordiff | diff-so-fancy | less --tabs=4 -RFX")
+    end
+  end
+
+  private
+
+  def apply_diff(dir, diff)
+    stdin = IO.popen("git --git-dir= apply --directory=#{dir} -", "w")
+    stdin.write diff
+    stdin.close
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oleg
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jeremy Ruten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -24,6 +24,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.25.1.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.7
 description: 
 email: jeremy.ruten@gmail.com
 executables:
@@ -37,6 +65,8 @@ files:
 - lib/leg/commands.rb
 - lib/leg/commands/base_command.rb
 - lib/leg/commands/diff.rb
+- lib/leg/commands/doc.rb
+- lib/leg/commands/fancy.rb
 - lib/leg/commands/help.rb
 - lib/leg/commands/pieces.rb
 - lib/leg/commands/ref.rb