leg 0.0.1 → 0.0.2

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "leg"
+
+include Leg
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/leg

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'leg'
+
+status = Leg::CLI.new.run(ARGV)
+exit! if status == false

data/leg.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "leg/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "leg"
+  spec.version       = Leg::VERSION
+  spec.authors       = ["Jeremy Ruten"]
+  spec.email         = ["jeremy.ruten@gmail.com"]
+
+  spec.summary       = %q{Tools for creating step-by-step programming tutorials}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/yjerem/leg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rugged', '0.27.2'
+  spec.add_runtime_dependency 'redcarpet', '3.4.0'
+  spec.add_runtime_dependency 'rouge', '2.0.7'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

data/lib/leg.rb

@@ -0,0 +1,27 @@
+require 'erb'
+require 'fileutils'
+require 'open3'
+require 'optparse'
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+require 'rugged'
+require 'yaml'
+
+require 'leg/cli'
+require 'leg/commands'
+require 'leg/config'
+require 'leg/default_templates'
+require 'leg/diff'
+require 'leg/diff_transformers'
+require 'leg/line'
+require 'leg/markdown'
+require 'leg/page'
+require 'leg/representations'
+require 'leg/step'
+require 'leg/template'
+require 'leg/tutorial'
+require 'leg/version'
+
+module Leg
+end

data/lib/leg/cli.rb

@@ -0,0 +1,42 @@
+module Leg
+  class CLI
+    def initialize(options = {})
+      @options = options
+
+      initial_dir = FileUtils.pwd
+
+      @config = nil
+      last_dir = nil
+      while FileUtils.pwd != last_dir
+        if File.exist?("leg.yml")
+          @config = Leg::Config.new(FileUtils.pwd)
+          @config.load!
+          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 = Leg::Commands::LIST.find { |cmd| cmd.name == cmd_name }
+        command = cmd.new(args, @config)
+        command.opts[:quiet] = true if @options[:force_quiet]
+        command.run
+      else
+        puts "There is no '#{cmd_name}' command. Run `leg help` for help."
+      end
+    end
+  end
+end

data/lib/leg/commands.rb

@@ -0,0 +1,19 @@
+require 'leg/commands/base_command'
+
+module Leg
+  module Commands
+    LIST = []
+  end
+end
+
+require 'leg/commands/init'
+require 'leg/commands/build'
+require 'leg/commands/status'
+require 'leg/commands/step'
+require 'leg/commands/diff'
+require 'leg/commands/commit'
+require 'leg/commands/amend'
+require 'leg/commands/save'
+require 'leg/commands/resolve'
+require 'leg/commands/reset'
+require 'leg/commands/help'

data/lib/leg/commands/amend.rb

@@ -0,0 +1,49 @@
+module Leg
+  module Commands
+    class Amend < BaseCommand
+      def self.name
+        "amend"
+      end
+
+      def self.summary
+        "Modify a step."
+      end
+
+      def self.usage
+         "[-s]"
+      end
+
+      def setopts!(o)
+        o.on("-m", "--message MESSAGE", "Set the step summary to MESSAGE") do |m|
+          @opts[:message] = m
+        end
+        o.on("-d", "--default-message", "Leave the step summary unchanged, or set it to a default if empty") do |d|
+          @opts[:default_message] = d
+        end
+        o.on("-s", "--stay", "Don't resolve rest of steps yet") do |s|
+          @opts[:stay] = s
+        end
+      end
+
+      def run
+        needs! :config, :repo
+
+        commit_options = {
+          amend: true,
+          no_rebase: @opts[:stay],
+          message: @opts[:message],
+          use_default_message: @opts[:default_message]
+        }
+
+        if @git.commit!(commit_options)
+          unless @opts[:stay]
+            git_to_litdiff!
+            output "Success!\n"
+          end
+        else
+          output "Looks like you've got a conflict to resolve!\n"
+        end
+      end
+    end
+  end
+end

data/lib/leg/commands/base_command.rb

@@ -0,0 +1,99 @@
+module Leg
+  module Commands
+    class BaseCommand
+      attr_reader :config, :opts
+
+      def initialize(args, config)
+        @args = args
+        @config = config
+        @git = Leg::Representations::Git.new(@config)
+        @litdiff = Leg::Representations::Litdiff.new(@config)
+        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)
+        Leg::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 @config.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 output(text)
+        print text unless @opts[:quiet]
+      end
+
+      def git_to_litdiff!
+        tutorial = @git.load! do |step_num|
+          output "\r\e[K[repo/ -> Tutorial] Step #{step_num}"
+        end
+        output "\n"
+
+        num_steps = tutorial.num_steps
+        @litdiff.save!(tutorial) do |step_num|
+          output "\r\e[K[Tutorial -> doc/] Step #{step_num}/#{num_steps}"
+        end
+        output "\n"
+
+        @config.synced!
+      end
+
+      def litdiff_to_git!
+        tutorial = @litdiff.load! do |step_num|
+          output "\r\e[K[doc/ -> Tutorial] Step #{step_num}"
+        end
+        output "\n"
+
+        num_steps = tutorial.num_steps
+        @git.save!(tutorial) do |step_num|
+          output "\r\e[K[Tutorial -> repo/] Step #{step_num}/#{num_steps}"
+        end
+        output "\n"
+
+        @config.synced!
+      end
+    end
+  end
+end

data/lib/leg/commands/build.rb

@@ -0,0 +1,126 @@
+module Leg
+  module Commands
+    class Build < 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
+        needs! :config, :repo
+
+        tutorial = @git.load!(full_diffs: true, diffs_ignore_whitespace: true) do |step_num|
+          output "\r\e[K[repo/ -> Tutorial] Step #{step_num}"
+        end
+        output "\n"
+
+        num_steps = tutorial.num_steps
+
+        if @config.options[:diff_transformers].nil?
+          @config.options[:diff_transformers] = [
+            { 'FoldSections' => {
+              unfold_before_new_section: true,
+              section_types: [
+                { name: 'comments', start: "^/\\*\\*\\*.+\\*\\*\\*/$", end: nil },
+                { name: 'braces', start: "^\\S.*{$", end: "^}( \\w+)?;?$" }
+              ]
+            }},
+            'TrimBlankLines',
+            'OmitAdjacentRemovals'
+          ]
+        end
+
+        if @config.options[:diff_transformers]
+          transformers = @config.options[: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
+            Leg::DiffTransformers.const_get(transformer).new(options)
+          end
+
+          tutorial.transform_diffs(transformers) do |step_num|
+            output "\r\e[K[Transform diffs] Step #{step_num}/#{num_steps}"
+          end
+          output "\n"
+        end
+
+        templates = Dir[File.join(@config.path, "template{,-?*}")].map do |template_dir|
+          [template_dir, File.basename(template_dir).split("-")[1] || "html"]
+        end
+        if templates.empty?
+          templates = [[nil, "html"], [nil, "md"]]
+        end
+
+        FileUtils.rm_rf(File.join(@config.path, "build"))
+        templates.each do |template_dir, format|
+          FileUtils.cd(@config.path) do
+            FileUtils.mkdir_p("build/#{format}")
+
+            include_default_css = (format == "html")
+            page_template = Leg::DefaultTemplates::PAGE[format]
+            if template_dir && File.exist?(File.join(template_dir, "page.#{format}.erb"))
+              page_template = File.read(File.join(template_dir, "page.#{format}.erb"))
+              include_default_css = false
+            end
+            page_template.gsub!(/\\\s*/, "")
+
+            step_template = Leg::DefaultTemplates::STEP[format]
+            if template_dir && File.exist?(File.join(template_dir, "step.#{format}.erb"))
+              step_template = File.read(File.join(template_dir, "step.#{format}.erb"))
+            end
+            step_template.gsub!(/\\\s*/, "")
+
+            tutorial.pages.each do |page|
+              output "\r\e[K[Tutorial -> build/] Page #{page.filename}"
+
+              content = Leg::Template.render_page(page_template, step_template, format, page, tutorial, @config)
+              File.write("build/#{format}/#{page.filename}.#{format}", content)
+            end
+            output "\n"
+
+            if template_dir
+              FileUtils.cd(template_dir) do
+                Dir["*"].each do |f|
+                  name = File.basename(f)
+
+                  next if ["page.#{format}.erb", "step.#{format}.erb"].include? name
+                  next if name.start_with? "_"
+
+                  # XXX: currently only processes top-level ERB template files.
+                  if name.end_with? ".erb"
+                    content = Leg::Template.render(File.read(f), tutorial, @config)
+                    File.write("../build/#{format}/#{name[0..-5]}", content)
+                  else
+                    FileUtils.cp_r(f, "../build/#{format}/#{name}")
+                  end
+                end
+              end
+            end
+
+            if include_default_css && !File.exist?("build/#{format}/style.css")
+              content = Leg::Template.render(Leg::DefaultTemplates::CSS, tutorial, @config)
+              File.write("build/#{format}/style.css", content)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/leg/commands/commit.rb

@@ -0,0 +1,48 @@
+module Leg
+  module Commands
+    class Commit < BaseCommand
+      def self.name
+        "commit"
+      end
+
+      def self.summary
+        "Append or insert a new step."
+      end
+
+      def self.usage
+        "[-s]"
+      end
+
+      def setopts!(o)
+        o.on("-m", "--message MESSAGE", "Set the step summary to MESSAGE") do |m|
+          @opts[:message] = m
+        end
+        o.on("-d", "--default-message", "Leave the step summary unchanged, or set it to a default if empty") do |d|
+          @opts[:default_message] = d
+        end
+        o.on("-s", "--stay", "Don't resolve rest of steps yet") do |s|
+          @opts[:stay] = s
+        end
+      end
+
+      def run
+        needs! :config, :repo
+
+        commit_options = {
+          no_rebase: @opts[:stay],
+          message: @opts[:message],
+          use_default_message: @opts[:default_message]
+        }
+
+        if @git.commit!(commit_options)
+          unless @opts[:stay]
+            git_to_litdiff!
+            output "Success!\n"
+          end
+        else
+          output "Looks like you've got a conflict to resolve!\n"
+        end
+      end
+    end
+  end
+end