leg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 286e3954f7bbf9670f82bd13781641352b4ea836
+  data.tar.gz: 7072bb1eb4f69782adf5b62fdf31bbd52b583f55
+SHA512:
+  metadata.gz: 8098a085df44829793ff34b0c2a8d4ba53aaf7a2bee1c1450e4e760ad7947baef9ec99120e5664dd4722ee988863d42169a6aa8c3add8d0f7170ca5b2ee62843
+  data.tar.gz: 77a5adb334ce1d0ba9fd2582a7d169e2cfee7155b34b148033189bbaa037fe5ed244bb940d2b4a8b7b5d006779e6d36a6693777b7525ebea50217db909f0c8e8

data/bin/leg

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require 'snaptoken'
+
+cli = Snaptoken::CLI.new
+cli.run(ARGV)
+

data/lib/snaptoken.rb

@@ -0,0 +1,24 @@
+require 'erb'
+require 'fileutils'
+require 'optparse'
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+require 'rugged'
+require 'yaml'
+
+module Snaptoken
+end
+
+require 'snaptoken/cli'
+require 'snaptoken/commands'
+require 'snaptoken/default_templates'
+require 'snaptoken/diff'
+require 'snaptoken/diff_line'
+require 'snaptoken/diff_transformers'
+require 'snaptoken/markdown'
+require 'snaptoken/page'
+require 'snaptoken/representations'
+require 'snaptoken/step'
+require 'snaptoken/template'
+require 'snaptoken/tutorial'

data/lib/snaptoken/cli.rb

@@ -0,0 +1,61 @@
+class Snaptoken::CLI
+  CONFIG_FILE = "leg.yml"
+
+  def initialize
+    initial_dir = FileUtils.pwd
+
+    @tutorial = nil
+    last_dir = nil
+    while FileUtils.pwd != last_dir
+      if File.exist?(CONFIG_FILE)
+        config = YAML.load_file(CONFIG_FILE)
+        if config == false
+          puts "Error: Invalid config file."
+          exit!
+        end
+        config = {} unless config.is_a?(Hash)
+        config[:path] = FileUtils.pwd
+        config = symbolize_keys(config)
+        @tutorial = Snaptoken::Tutorial.new(config)
+        break
+      end
+
+      last_dir = FileUtils.pwd
+      FileUtils.cd('..')
+    end
+
+    FileUtils.cd(initial_dir)
+  end
+
+  def run(args)
+    args = ["help"] if args.empty?
+    cmd_name = args.shift.downcase
+
+    if cmd_name =~ /\A\d+\z/
+      args.unshift(cmd_name)
+      cmd_name = "step"
+    end
+
+    if cmd = Snaptoken::Commands::LIST.find { |cmd| cmd.name == cmd_name }
+      cmd.new(args, @tutorial).run
+    else
+      puts "There is no '#{cmd_name}' command. Run `leg help` for help."
+    end
+  end
+
+  private
+
+  def symbolize_keys(value)
+    case value
+    when Hash
+      value.map do |k, v|
+        [k.to_sym, symbolize_keys(v)]
+      end.to_h
+    when Array
+      value.map { |v| symbolize_keys(v) }
+    else
+      value
+    end
+  end
+end
+

data/lib/snaptoken/commands.rb

@@ -0,0 +1,13 @@
+module Snaptoken::Commands
+  LIST = []
+end
+
+require 'snaptoken/commands/base_command'
+
+require 'snaptoken/commands/build'
+require 'snaptoken/commands/status'
+require 'snaptoken/commands/commit'
+require 'snaptoken/commands/amend'
+require 'snaptoken/commands/resolve'
+require 'snaptoken/commands/step'
+require 'snaptoken/commands/help'

data/lib/snaptoken/commands/amend.rb

@@ -0,0 +1,27 @@
+class Snaptoken::Commands::Amend < Snaptoken::Commands::BaseCommand
+  def self.name
+    "amend"
+  end
+
+  def self.summary
+    "Modify a step."
+  end
+
+  def self.usage
+    ""
+  end
+
+  def setopts!(o)
+  end
+
+  def run
+    needs! :config, :repo
+
+    if @git.commit!(amend: true)
+      git_to_litdiff!
+      puts "Success!"
+    else
+      puts "Looks like you've got a conflict to resolve!"
+    end
+  end
+end

data/lib/snaptoken/commands/base_command.rb

@@ -0,0 +1,92 @@
+class Snaptoken::Commands::BaseCommand
+  attr_reader :config
+
+  def initialize(args, tutorial)
+    @args = args
+    @tutorial = tutorial
+    @git = Snaptoken::Representations::Git.new(@tutorial)
+    @litdiff = Snaptoken::Representations::Litdiff.new(@tutorial)
+    parseopts!
+  end
+
+  def self.name; raise NotImplementedError; end
+  def self.summary; raise NotImplementedError; end
+  def setopts!(o); raise NotImplementedError; end
+  def run; raise NotImplementedError; end
+
+  def self.inherited(subclass)
+    Snaptoken::Commands::LIST << subclass
+  end
+
+  def parseopts!
+    parser = OptionParser.new do |o|
+      o.banner = "Usage: leg #{self.class.name} #{self.class.usage}"
+      self.class.summary.split("\n").each do |line|
+        o.separator "    #{line}"
+      end
+      o.separator ""
+      o.separator "Options:"
+      setopts!(o)
+      o.on_tail("-h", "--help", "Show this message") do
+        puts o
+        exit
+      end
+    end
+    @opts = {}
+    parser.parse!(@args)
+  rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
+    puts "#{e.message}"
+    puts
+    parser.parse("--help")
+  end
+
+  def needs!(*whats)
+    whats.each do |what|
+      case what
+      when :config
+        if @tutorial.nil?
+          puts "Error: You are not in a leg working directory."
+          exit 1
+        end
+      when :repo
+        if @litdiff.modified? and @git.modified?
+          puts "Error: doc/ and .leg/repo have diverged!"
+          exit 1
+        elsif @litdiff.modified? or !@git.exists?
+          litdiff_to_git!
+        end
+      end
+    end
+  end
+
+  def git_to_litdiff!
+    @git.load! do |step_num|
+      print "\r\e[K[repo/ -> Tutorial] Step #{step_num}" unless @opts[:quiet]
+    end
+    puts unless @opts[:quiet]
+
+    num_steps = @tutorial.num_steps
+    @litdiff.save! do |step_num|
+      print "\r\e[K[Tutorial -> doc/] Step #{step_num}/#{num_steps}" unless @opts[:quiet]
+    end
+    puts unless @opts[:quiet]
+
+    @tutorial.synced!
+  end
+
+  def litdiff_to_git!
+    @litdiff.load! do |step_num|
+      print "\r\e[K[doc/ -> Tutorial] Step #{step_num}" unless @opts[:quiet]
+    end
+    puts unless @opts[:quiet]
+
+    num_steps = @tutorial.num_steps
+    @git.save! do |step_num|
+      print "\r\e[K[Tutorial -> repo/] Step #{step_num}/#{num_steps}" unless @opts[:quiet]
+    end
+    puts unless @opts[:quiet]
+
+    @tutorial.synced!
+  end
+end
+

data/lib/snaptoken/commands/build.rb

@@ -0,0 +1,107 @@
+class Snaptoken::Commands::Build < Snaptoken::Commands::BaseCommand
+  def self.name
+    "build"
+  end
+
+  def self.summary
+    "Render repo/ into an HTML or Markdown book."
+  end
+
+  def self.usage
+    "[-q]"
+  end
+
+  def setopts!(o)
+    o.on("-q", "--quiet", "Don't output progress") do |q|
+      @opts[:quiet] = q
+    end
+  end
+
+  def run
+    args = @opts[:quiet] ? ["--quiet"] : []
+
+    needs! :config, :repo
+
+    @git.load!(full_diffs: true, diffs_ignore_whitespace: true) do |step_num|
+      print "\r\e[K[repo/ -> Tutorial] Step #{step_num}" unless @opts[:quiet]
+    end
+    puts unless @opts[:quiet]
+
+    num_steps = @tutorial.num_steps
+
+    if @tutorial.config[:diff_transformers]
+      transformers = @tutorial.config[:diff_transformers].map do |transformer_config|
+        if transformer_config.is_a? String
+          transformer = transformer_config
+          options = {}
+        else
+          transformer = transformer_config.keys.first
+          options = transformer_config.values.first
+        end
+        Snaptoken::DiffTransformers.const_get(transformer).new(options)
+      end
+
+      @tutorial.transform_diffs(transformers) do |step_num|
+        print "\r\e[K[Transform diffs] Step #{step_num}/#{num_steps}" unless @opts[:quiet]
+      end
+      puts unless @opts[:quiet]
+    end
+
+    FileUtils.mkdir_p(File.join(@tutorial.config[:path], "template"))
+    FileUtils.cd(File.join(@tutorial.config[:path], "template")) do
+      FileUtils.rm_rf("../build")
+      FileUtils.mkdir_p("../build/html")
+      FileUtils.mkdir_p("../build/html-offline")
+
+      include_default_css = true
+      if File.exist?("page.html.erb")
+        @tutorial.page_template = File.read("page.html.erb")
+        include_default_css = false
+      end
+
+      if File.exist?("step.html.erb")
+        @tutorial.step_template = File.read("step.html.erb")
+      end
+      @tutorial.step_template.gsub!(/\\\s*/, "")
+
+      @tutorial.pages.each do |page|
+        print "\r\e[K[Tutorial -> build/] Page #{page.filename}" unless @opts[:quiet]
+
+        html = page.to_html(@tutorial, false)
+        File.write("../build/html/#{page.filename}.html", html)
+
+        offline_html = page.to_html(@tutorial, true)
+        File.write("../build/html-offline/#{page.filename}.html", offline_html)
+      end
+      puts unless @opts[:quiet]
+
+      Dir["*"].each do |f|
+        name = File.basename(f)
+
+        next if %w(page.html.erb step.html.erb).include? name
+        next if name.start_with? "_"
+
+        # XXX: currently only processes top-level ERB template files.
+        if name.end_with? ".erb"
+          output = Snaptoken::Template.new(File.read(f), @tutorial, offline: false).render_template
+          File.write("../build/html/#{name[0..-5]}", output)
+
+          output = Snaptoken::Template.new(File.read(f), @tutorial, offline: true).render_template
+          File.write("../build/html-offline/#{name[0..-5]}", output)
+        else
+          FileUtils.cp_r(f, "../build/html/#{name}")
+          FileUtils.cp_r(f, "../build/html-offline/#{name}")
+        end
+      end
+
+      if include_default_css && !File.exist?("../build/html/style.css")
+        output = Snaptoken::Template.new(Snaptoken::DefaultTemplates::CSS, @tutorial, offline: false).render_template
+        File.write("../build/html/style.css", output)
+      end
+      if include_default_css && !File.exist?("../build/html-offline/style.css")
+        output = Snaptoken::Template.new(Snaptoken::DefaultTemplates::CSS, @tutorial, offline: true).render_template
+        File.write("../build/html-offline/style.css", output)
+      end
+    end
+  end
+end

data/lib/snaptoken/commands/commit.rb

@@ -0,0 +1,27 @@
+class Snaptoken::Commands::Commit < Snaptoken::Commands::BaseCommand
+  def self.name
+    "commit"
+  end
+
+  def self.summary
+    "Append or insert a new step."
+  end
+
+  def self.usage
+    ""
+  end
+
+  def setopts!(o)
+  end
+
+  def run
+    needs! :config, :repo
+
+    if @git.commit!
+      git_to_litdiff!
+      puts "Success!"
+    else
+      puts "Looks like you've got a conflict to resolve!"
+    end
+  end
+end

data/lib/snaptoken/commands/help.rb

@@ -0,0 +1,38 @@
+class Snaptoken::Commands::Help < Snaptoken::Commands::BaseCommand
+  def self.name
+    "help"
+  end
+
+  def self.summary
+    "Print out list of commands, or get help\n" +
+    "on a specific command."
+  end
+
+  def self.usage
+    "[<command>]"
+  end
+
+  def setopts!(o)
+  end
+
+  def run
+    if @args.empty?
+      puts "Usage: leg <command> [args...]"
+      puts
+      puts "Commands:"
+      Snaptoken::Commands::LIST.each do |cmd|
+        puts "  #{cmd.name} #{cmd.usage}"
+        cmd.summary.split("\n").each do |line|
+          puts "      #{line}"
+        end
+      end
+      puts
+      puts "For more help on a specific command, run `leg help <command>`."
+    elsif cmd = Snaptoken::Commands::LIST.find { |cmd| cmd.name == @args.first }
+      cmd.new(["--help"], @tutorial)
+    else
+      puts "There is no '#{@args.first}' command."
+    end
+  end
+end
+

data/lib/snaptoken/commands/resolve.rb

@@ -0,0 +1,27 @@
+class Snaptoken::Commands::Resolve < Snaptoken::Commands::BaseCommand
+  def self.name
+    "resolve"
+  end
+
+  def self.summary
+    "Continue rewriting steps after resolving a merge conflict."
+  end
+
+  def self.usage
+    ""
+  end
+
+  def setopts!(o)
+  end
+
+  def run
+    needs! :config, :repo
+
+    if @git.resolve!
+      git_to_litdiff!
+      puts "Success!"
+    else
+      puts "Looks like you've got a conflict to resolve!"
+    end
+  end
+end