leg 0.0.1 → 0.0.2

data/lib/leg/representations/litdiff.rb

@@ -0,0 +1,85 @@
+module Leg
+  module Representations
+    class Litdiff < BaseRepresentation
+      def save!(tutorial, options = {})
+        FileUtils.mkdir_p(path)
+        FileUtils.rm_rf(File.join(path, "."), secure: true)
+
+        step_num = 1
+        tutorial.pages.each.with_index do |page, page_idx|
+          output = ""
+          page.steps.each do |step|
+            output << step.text << "\n\n" unless step.text.empty?
+            output << "~~~ #{step_num}. #{step.summary}\n"
+            output << step.to_patch(unchanged_char: "|", strip_git_lines: true) << "\n"
+
+            yield step_num if block_given?
+            step_num += 1
+          end
+          output << page.footer_text << "\n" if page.footer_text
+
+          filename = page.filename + ".litdiff"
+          filename = "%02d.%s" % [page_idx + 1, filename] if tutorial.pages.length > 1
+
+          File.write(File.join(path, filename), output)
+        end
+      end
+
+      def load!(options = {})
+        step_num = 1
+        tutorial = Leg::Tutorial.new(@config)
+        Dir[File.join(path, "*.litdiff")].sort_by { |f| File.basename(f).to_i }.each do |diff_path|
+          filename = File.basename(diff_path).sub(/\.litdiff$/, "").sub(/^\d+\./, "")
+          page = Leg::Page.new(filename)
+          File.open(diff_path, "r") do |f|
+            cur_text = ""
+            cur_diff = nil
+            cur_summary = nil
+            while line = f.gets
+              if line =~ /^~~~\s*(\d+\.)?(.+)$/
+                cur_summary = $2.strip
+                cur_diff = ""
+              elsif cur_diff
+                if line.chomp.empty?
+                  step_diffs = Leg::Diff.parse(cur_diff)
+                  page << Leg::Step.new(step_num, cur_summary, cur_text.strip, step_diffs)
+
+                  yield step_num if block_given?
+                  step_num += 1
+
+                  cur_text = ""
+                  cur_summary = nil
+                  cur_diff = nil
+                else
+                  cur_diff << line.sub(/^\|/, " ")
+                end
+              else
+                cur_text << line
+              end
+            end
+            if cur_diff
+              step_diffs = Leg::Diff.parse(cur_diff)
+              page << Leg::Step.new(step_num, cur_summary, cur_text.strip, step_diffs)
+            elsif !cur_text.strip.empty?
+              page.footer_text = cur_text.strip
+            end
+          end
+          tutorial << page
+        end
+        tutorial
+      end
+
+      def path
+        File.join(@config.path, "doc")
+      end
+
+      private
+
+      def modified_at
+        if File.exist? path
+          Dir[File.join(path, "**/*")].map { |f| File.mtime(f) }.max
+        end
+      end
+    end
+  end
+end

data/lib/leg/step.rb

@@ -0,0 +1,16 @@
+module Leg
+  class Step
+    attr_accessor :number, :summary, :text, :diffs
+
+    def initialize(number, summary, text, diffs)
+      @number = number
+      @summary = summary.strip
+      @text = text.strip
+      @diffs = diffs
+    end
+
+    def to_patch(options = {})
+      @diffs.map { |diff| diff.to_patch(options) }.join("\n")
+    end
+  end
+end

data/lib/leg/template.rb

@@ -0,0 +1,95 @@
+module Leg
+  module Template
+    def self.render(template_source, tutorial, config, params = {})
+      Leg::Template::Context.new(template_source, tutorial, config, params).render_template
+    end
+
+    def self.render_page(page_template, step_template, format, page, tutorial, config)
+      content = ""
+      page.steps.each do |step|
+        if !step.text.strip.empty?
+          output = step.text.strip + "\n\n"
+          if format == "html"
+            output = Leg::Markdown.render(output)
+          end
+          content << output
+        end
+
+        content << Leg::Template.render_step(step_template, step, tutorial, config)
+      end
+      if page.footer_text
+        # TODO: DRY this up. Please.
+        output = page.footer_text.strip + "\n\n"
+        if format == "html"
+          output = Leg::Markdown.render(output)
+        end
+        content << output
+      end
+
+      page_number = tutorial.pages.index(page) + 1
+
+      Leg::Template.render(page_template, tutorial, config,
+        page_title: page.title,
+        content: content,
+        page_number: page_number,
+        prev_page: page_number > 1 ? tutorial.pages[page_number - 2] : nil,
+        next_page: page_number < tutorial.pages.length ? tutorial.pages[page_number] : nil
+      )
+    end
+
+    def self.render_step(step_template, step, tutorial, config)
+      Leg::Template.render(step_template, tutorial, config,
+        number: step.number,
+        summary: step.summary,
+        diffs: step.diffs
+      )
+    end
+
+    class Context
+      def initialize(template_source, tutorial, config, params)
+        @template_source = template_source
+        @tutorial = tutorial
+        @config = config
+        @params = params
+      end
+
+      def render_template
+        b = binding
+        @config.options.merge(@params).each do |name, value|
+          b.local_variable_set(name, value)
+        end
+        ERB.new(@template_source).result(b)
+      end
+
+      def render(path)
+        if !path.end_with? ".md"
+          raise ArgumentError, "Only .md files are supported by render() at the moment."
+        end
+
+        contents = File.read(path)
+        Leg::Markdown.render(contents)
+      end
+
+      def markdown(source)
+        Leg::Markdown.render(source)
+      end
+
+      def pages
+        @tutorial.pages
+      end
+
+      def syntax_highlighting_css(scope)
+        syntax_theme = @config.options[:syntax_theme] || "github"
+        if syntax_theme.is_a? String
+          theme = Rouge::Theme.find(syntax_theme)
+        elsif syntax_theme.is_a? Hash
+          theme = Class.new(Rouge::Themes::Base16)
+          theme.name "base16.custom"
+          theme.palette syntax_theme
+        end
+
+        theme.render(scope: scope)
+      end
+    end
+  end
+end

data/lib/leg/tutorial.rb

@@ -0,0 +1,49 @@
+module Leg
+  class Tutorial
+    attr_accessor :config
+    attr_reader :pages
+
+    def initialize(config = nil)
+      @config = config
+      @pages = []
+    end
+
+    def <<(page)
+      @pages << page
+      self
+    end
+
+    def clear
+      @pages.clear
+    end
+
+    def step(number)
+      cur = 1
+      @pages.each do |page|
+        page.steps.each do |step|
+          return step if cur == number
+          cur += 1
+        end
+      end
+    end
+
+    def num_steps
+      @pages.map(&:steps).map(&:length).sum
+    end
+
+    def transform_diffs(transformers, &progress_block)
+      step_num = 1
+      @pages.each do |page|
+        page.steps.each do |step|
+          step.diffs.map! do |diff|
+            transformers.inject(diff) do |acc, transformer|
+              transformer.transform(acc)
+            end
+          end
+          progress_block.(step_num) if progress_block
+          step_num += 1
+        end
+      end
+    end
+  end
+end

data/lib/leg/version.rb

@@ -0,0 +1,3 @@
+module Leg
+  VERSION = "0.0.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Ruten
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-03-25 00:00:00.000000000 Z
+date: 2019-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.25.1.1
+        version: 0.27.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.25.1.1
+        version: 0.27.2
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -52,42 +52,117 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: jeremy.ruten@gmail.com
+email:
+- jeremy.ruten@gmail.com
 executables:
 - leg
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/leg
-- lib/snaptoken.rb
-- lib/snaptoken/cli.rb
-- lib/snaptoken/commands.rb
-- lib/snaptoken/commands/amend.rb
-- lib/snaptoken/commands/base_command.rb
-- lib/snaptoken/commands/build.rb
-- lib/snaptoken/commands/commit.rb
-- lib/snaptoken/commands/help.rb
-- lib/snaptoken/commands/resolve.rb
-- lib/snaptoken/commands/status.rb
-- lib/snaptoken/commands/step.rb
-- lib/snaptoken/default_templates.rb
-- lib/snaptoken/diff.rb
-- lib/snaptoken/diff_line.rb
-- lib/snaptoken/diff_transformers.rb
-- lib/snaptoken/diff_transformers/base_transformer.rb
-- lib/snaptoken/diff_transformers/fold_sections.rb
-- lib/snaptoken/diff_transformers/omit_adjacent_removals.rb
-- lib/snaptoken/diff_transformers/trim_blank_lines.rb
-- lib/snaptoken/markdown.rb
-- lib/snaptoken/page.rb
-- lib/snaptoken/representations.rb
-- lib/snaptoken/representations/base_representation.rb
-- lib/snaptoken/representations/git.rb
-- lib/snaptoken/representations/litdiff.rb
-- lib/snaptoken/step.rb
-- lib/snaptoken/template.rb
-- lib/snaptoken/tutorial.rb
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- TUTORIAL.md
+- bin/console
+- bin/setup
+- exe/leg
+- leg.gemspec
+- lib/leg.rb
+- lib/leg/cli.rb
+- lib/leg/commands.rb
+- lib/leg/commands/amend.rb
+- lib/leg/commands/base_command.rb
+- lib/leg/commands/build.rb
+- lib/leg/commands/commit.rb
+- lib/leg/commands/diff.rb
+- lib/leg/commands/help.rb
+- lib/leg/commands/init.rb
+- lib/leg/commands/reset.rb
+- lib/leg/commands/resolve.rb
+- lib/leg/commands/save.rb
+- lib/leg/commands/status.rb
+- lib/leg/commands/step.rb
+- lib/leg/config.rb
+- lib/leg/default_templates.rb
+- lib/leg/diff.rb
+- lib/leg/diff_transformers.rb
+- lib/leg/diff_transformers/base_transformer.rb
+- lib/leg/diff_transformers/fold_sections.rb
+- lib/leg/diff_transformers/omit_adjacent_removals.rb
+- lib/leg/diff_transformers/syntax_highlight.rb
+- lib/leg/diff_transformers/trim_blank_lines.rb
+- lib/leg/line.rb
+- lib/leg/markdown.rb
+- lib/leg/page.rb
+- lib/leg/representations.rb
+- lib/leg/representations/base_representation.rb
+- lib/leg/representations/git.rb
+- lib/leg/representations/litdiff.rb
+- lib/leg/step.rb
+- lib/leg/template.rb
+- lib/leg/tutorial.rb
+- lib/leg/version.rb
 homepage: https://github.com/yjerem/leg
 licenses:
 - MIT
@@ -107,9 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: tools for .leg files
+summary: Tools for creating step-by-step programming tutorials
 test_files: []

data/bin/leg

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