snaptoken 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c492a2e7a3649a7e4638c89a4544a5606a4728ee
-  data.tar.gz: dcff67fe519ba5e1fe342b7551e9e59c30a04851
+  metadata.gz: '03814fd3146986918c4c33d8fa606e741245fd68'
+  data.tar.gz: 18e23c04b3104332f2fdb9a752bb1eb51e6fbbd1
 SHA512:
-  metadata.gz: 5825f024669bd795e3d1c971a7edcb1e9d914d1fe36c47e4bb179e6385c361ac4f5b89ff03b38c9241907b8473932ec86055355059d16fbf07b5a1d5d7327830
-  data.tar.gz: 29d4f660dbd1b2eeb07d0654b5004923bf085a8301127a9b20c83fb4b0d095fc2394e985a841bfaddac82b8603818b3f50bf5a0b607e20e94d9e71d3c170eda0
+  metadata.gz: cd071cc29eb3336f2dc4b8fe40cdc4f76dba7163cadd350f647f9fcc7c08744ee11eecfa9aa0a6300229e9fbae766c1b3552deca61299961261c2d24cb37555a
+  data.tar.gz: e77a2cdc1c27dcc53f6f81070559fe347790b365f0491566ace1fc016d13ca7ff6019cfba710b7d47aa0e203bf8ab7f56a97a7c063acd4ccc68d492f90fcf500

data/lib/snaptoken/commands/base_command.rb

@@ -17,6 +17,9 @@ class Snaptoken::Commands::BaseCommand
       true: "You are not in a leg working directory.",
       false: "You are already in a leg working directory."
     },
+    config_name: {
+      true: "You need to set a name in leg.yml."
+    },
     config_title: {
       true: "You need to set a title in leg.yml."
     },
@@ -57,6 +60,8 @@ class Snaptoken::Commands::BaseCommand
       case what
       when :config
         valid = true if @config
+      when :config_name
+        valid = true if @config[:name]
       when :config_title
         valid = true if @config[:title]
       when :steps_folder

data/lib/snaptoken/commands/doc.rb

@@ -8,7 +8,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
   end
 
   def run
-    needs! :config, :config_title, :steps_folder, :steps, :doc
+    needs! :config, :config_name, :config_title, :steps_folder, :steps, :doc
 
     FileUtils.cd(File.join(@config[:path], "doc")) do
       FileUtils.rm_rf("html_out")
@@ -40,7 +40,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
   def copy_static_files
     Dir["html_in/*"].each do |f|
       name = File.basename(f)
-      unless %w(template.html style.css).include? name
+      unless %w(template.html template_index.html style.css).include? name
         FileUtils.cp_r(f, "html_out/#{name}")
       end
     end
@@ -73,7 +73,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
           names << $1
         end
 
-        diff = Snaptoken::Diff.new(last_step, step)
+        diff = Snaptoken::Diff.new(@config, last_step, step)
 
         names.each do |name|
           diffs[name] = diff.html.values.join("\n")
@@ -91,24 +91,35 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
 
     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)
+    pages = Dir["*.md"].sort.map { |f| f.sub(/\.md$/, '') }
+    pages.each.with_index do |page, idx|
+      md = File.read("#{page}.md")
       md =~ /^# (.+)$/
       title = $1
 
-      index << "<li><a href='#{html_file}'>#{title}</a></li>\n"
+      index << "<li><a href='#{page}.html'>#{title}</a></li>\n"
+
+      prev_link = "<a href='#'></a>"
+      if idx > 0
+        prev_link = "<a href='#{pages[idx-1]}.html'>&larr; prev</a>"
+      end
+
+      next_link = "<a href='#'></a>"
+      if idx < pages.length - 1
+        next_link = "<a href='#{pages[idx+1]}.html'>next &rarr;</a>"
+      end
 
       content = markdown.render(md)
       content = Redcarpet::Render::SmartyPants.render(content)
       content.gsub!(/<p>{{([\w-]+)}}<\/p>/) { diffs[$1] }
 
       html = html_template.dup
-      html.gsub!("{{title}}") { "#{@config[:title]} | #{title}" }
+      html.gsub!("{{title}}") { "#{idx+1}. #{title} | #{@config[:title]}" }
+      html.gsub!("{{prev_link}}") { prev_link }
+      html.gsub!("{{next_link}}") { next_link }
       html.gsub!("{{content}}") { content }
 
-      File.write(File.join("html_out", html_file), html)
+      File.write(File.join("html_out", "#{page}.html"), html)
     end
 
     content = <<~HTML
@@ -119,9 +130,16 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
     </ol>
     HTML
 
-    html = html_template.dup
-    html.gsub!("{{title}}", @config[:title])
-    html.gsub!("{{content}}", content)
+    if File.exist?("html_in/template_index.html")
+      html = File.read("html_in/template_index.html")
+    else
+      html = html_template.dup
+    end
+
+    html.gsub!("{{title}}") { "Table of contents | #{@config[:title]}" }
+    html.gsub!("{{prev_link}}") { "<a href='#'></a>" }
+    html.gsub!("{{next_link}}") { "<a href='#{pages.first}.html'>next &rarr;</a>" }
+    html.gsub!("{{content}}") { content }
 
     File.write("html_out/index.html", html)
   end

data/lib/snaptoken/commands/fancy.rb

@@ -14,13 +14,5 @@ class Snaptoken::Commands::Fancy < Snaptoken::Commands::BaseCommand
       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
 

data/lib/snaptoken/commands/repo.rb

@@ -34,7 +34,11 @@ class Snaptoken::Commands::Repo < Snaptoken::Commands::BaseCommand
       options[:parents] = repo.empty? ? [] : [repo.head.target]
       options[:update_ref] = 'HEAD'
 
-      Rugged::Commit.create(repo, options)
+      commit_oid = Rugged::Commit.create(repo, options)
+
+      if step_name(step)
+        repo.references.create("refs/tags/#{step_name(step)}", commit_oid)
+      end
     end
 
     repo.checkout_head(strategy: :force)

data/lib/snaptoken/diff.rb

@@ -3,14 +3,18 @@ class Snaptoken::Diff
 
   attr_reader :files, :html
 
-  def initialize(step_a, step_b)
+  def initialize(config, step_a, step_b)
     git_diff = `git diff #{GIT_DIFF_OPTIONS} #{step_a} #{step_b}`
     parse_git_diff(git_diff)
     @files.values.each(&:omit_adjacent_removals!)
 
+    step = step_b.split('-')
+    step.shift
+    step = step.join('-')
+
     @html = {}
     @files.each do |filename, file|
-      @html[filename] = file.to_html
+      @html[filename] = file.to_html(config[:name], step)
     end
   end
 
@@ -96,7 +100,7 @@ class Snaptoken::Diff
       end
     end
 
-    def to_html
+    def to_html(project, step)
       formatter = Rouge::Formatters::HTML.new
       formatter = HTMLLineByLine.new(formatter)
 
@@ -105,7 +109,7 @@ class Snaptoken::Diff
 
       html = ""
       html << "<div class=\"diff\">\n"
-      html << "<div class=\"filename\">#{@filename}</div>\n"
+      html << "<div class=\"filename\"><a href=\"https://github.com/snaptoken/#{project}/blob/#{step}/#{@filename}\">#{@filename}</a></div>\n"
       html << "<pre class=\"highlight\"><code>"
 
       to_render = @contents.dup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptoken
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jeremy Ruten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged