snaptoken 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a81cb9783bd03718bb76147934e37db517b9e1f6
-  data.tar.gz: 6ec69608e410ab0c0ec3aaf728140b8dccdf0d90
+  metadata.gz: '006850149613e2b91770ee1d314f523a0e0741e2'
+  data.tar.gz: 4499961406d699b379850ae58c59d0e3251945c5
 SHA512:
-  metadata.gz: 7dc3fdf69e5dba4127d71dbb357da64bd7de0846b6f810075effab046d9d6ebb9fd6ade61989f774a7d81462a97f37f8ca6614f25a253d19af63966c61ae8b9d
-  data.tar.gz: f7678326bb314641b8e2bb8bb0f830061f45702c0ddd1b84d8beb6440dee138d0b614757d8c3713e865c169dcb3dfec0ccec57bdebe570aa7d98fd7a163a4a7f
+  metadata.gz: 9d6870227063fb6e61802d4838729a9797d56dba1baa17802384b3d3ea46ddb5a5886708ba7290e351db3f7b56314e74f121bb3a7271840490b8b61d904e018d
+  data.tar.gz: e7816626ea373b8c46f249a40acc499c19c76279499d9ebb65deab49778382a3e899a0b1feae248d700709eae5a697d2f5394b1b788e99163476d75fab5c4649

data/lib/snaptoken/commands/base_command.rb

@@ -2,21 +2,48 @@ class Snaptoken::Commands::BaseCommand
   def initialize(args, config)
     @args = args
     @config = 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)
     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 => e
+    puts "#{e.message}"
+    puts
+    parser.parse("--help")
+  end
+
   ERROR_MSG = {
     config: {
       true: "You are not in a leg working directory.",
       false: "You are already in a leg working directory."
     },
+    config_sync: {
+      true: "The :sync option in leg.yml must be set to 'repo' or 'steps'."
+    },
     steps_folder: {
       true: "There is no steps folder.",
       false: "There is already a steps folder."
@@ -37,6 +64,9 @@ class Snaptoken::Commands::BaseCommand
     doc_out: {
       true: "There are no doc output files."
     },
+    cached_diffs: {
+      true: "There are no cached diffs."
+    },
     ftp: {
       true: "There is no ftp.yml file."
     }
@@ -54,6 +84,8 @@ class Snaptoken::Commands::BaseCommand
       case what
       when :config
         valid = true if @config
+      when :config_sync
+        valid = true if %w(repo steps).include?(@config[:sync])
       when :steps_folder
         valid = true if File.exist?(File.join(@config[:path], "steps"))
       when :steps
@@ -66,6 +98,8 @@ class Snaptoken::Commands::BaseCommand
         valid = true if File.exist?(File.join(@config[:path], "doc"))
       when :doc_out
         valid = true if File.exist?(File.join(@config[:path], "doc/html_out"))
+      when :cached_diffs
+        valid = true if File.exist?(File.join(@config[:path], ".cached-diffs"))
       when :ftp
         valid = true if File.exist?(File.join(@config[:path], "ftp.yml"))
       else

data/lib/snaptoken/commands/deploy.rb

@@ -4,7 +4,15 @@ class Snaptoken::Commands::Deploy < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Pushes output files in doc/ to production server"
+    "Push output files in doc/html_out/ to\n" +
+    "production server (requires ftp.yml)."
+  end
+
+  def self.usage
+    "[pattern...]"
+  end
+
+  def setopts!(o)
   end
 
   def run

data/lib/snaptoken/commands/diff.rb

@@ -4,7 +4,17 @@ class Snaptoken::Commands::Diff < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Convert repo into a single file containing diffs for each step"
+    "Convert repo/ to steps.diff."
+  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
@@ -21,12 +31,14 @@ class Snaptoken::Commands::Diff < Snaptoken::Commands::BaseCommand
             break if $1.strip == "-"
             f << "\n" unless step_num == 1
             step = Snaptoken::Step.from_commit_msg(step_num, $1.strip)
+            print "\r\e[K[repo/ -> steps.diff] #{step.folder_name}" unless @opts[:quiet]
             f << "~~~ step: #{step.commit_msg}\n"
             step_num += 1
           elsif line.chomp.length > 0
             f << line
           end
         end
+        print "\n" unless @opts[:quiet]
       end
     end
   end

data/lib/snaptoken/commands/doc.rb

@@ -6,11 +6,37 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Renders files in doc folder into an HTML book"
+    "Render files in doc/ into an HTML book.\n" +
+    "(Automatically runs the `sync` command.)"
+  end
+
+  def self.usage
+    "[-c] [-z] [-q]"
+  end
+
+  def setopts!(o)
+    o.on("-c", "--cached", "Use cached diff HTML (much faster)") do |c|
+      @opts[:cached] = c
+    end
+
+    o.on("-z", "--zip", "Also create a .zip archive in doc/") do |z|
+      @opts[:zip] = z
+    end
+
+    o.on("-q", "--quiet", "Don't output progress") do |q|
+      @opts[:quiet] = q
+    end
   end
 
   def run
-    needs! :config, :steps_folder, :steps, :doc
+    needs! :config, :doc
+    if @opts[:cached]
+      needs! :cached_diffs
+    else
+      sync_args = @opts[:quiet] ? ["--quiet"] : []
+      Snaptoken::Commands::Sync.new(sync_args, @config).run
+      @steps = nil # XXX just in case @steps were already cached
+    end
 
     FileUtils.cd(File.join(@config[:path], "doc")) do
       FileUtils.rm_rf("html_out")
@@ -21,7 +47,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
       copy_static_files
       write_css
       write_html_files(prerender_diffs)
-      create_archive if @args.include? "-z"
+      create_archive if @opts[:zip]
     end
   end
 
@@ -66,7 +92,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
   end
 
   def prerender_diffs
-    if @args.include? "-c"
+    if @opts[:cached]
       return Marshal.load(File.read("../.cached-diffs"))
     end
 
@@ -75,7 +101,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
       FileUtils.mkdir_p("0")
       last_step = Snaptoken::Step.new(0, nil, [])
       steps.each do |step|
-        print "\r\e[K#{step.folder_name}"
+        print "\r\e[K[steps/ -> .cached-diffs] #{step.folder_name}" unless @opts[:quiet]
 
         diff = Snaptoken::Diff.new(@config, last_step, step)
 
@@ -83,7 +109,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
 
         last_step = step
       end
-      puts
+      print "\n" unless @opts[:quiet]
       FileUtils.rmdir("0")
     end
     File.write("../.cached-diffs", Marshal.dump(diffs))
@@ -99,6 +125,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
     pages = Dir["*.md"].sort.map { |f| f.sub(/\.md$/, '') }
     pages.delete "00.index"
     pages.each.with_index do |page, idx|
+      print "\r\e[K[doc/ -> doc/html_out/] #{page}.html" unless @opts[:quiet]
       md = File.read("#{page}.md")
       md =~ /^# (.+)$/
       title = $1
@@ -131,6 +158,7 @@ class Snaptoken::Commands::Doc < Snaptoken::Commands::BaseCommand
       File.write(File.join("html_out", "#{page}.html"), html)
       File.write(File.join("html_offline", "#{page}.html"), html)
     end
+    print "\n" unless @opts[:quiet]
 
     content = markdown.render(File.read("00.index.md"))
     content = Redcarpet::Render::SmartyPants.render(content)

data/lib/snaptoken/commands/fancy.rb

@@ -4,7 +4,15 @@ class Snaptoken::Commands::Fancy < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Run steps.diff through colordiff, diff-so-fancy, and less"
+    "Run steps.diff through colordiff,\n" +
+    "diff-so-fancy, and less."
+  end
+
+  def self.usage
+    ""
+  end
+
+  def setopts!(o)
   end
 
   def run

data/lib/snaptoken/commands/help.rb

@@ -4,16 +4,34 @@ class Snaptoken::Commands::Help < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Print out this help"
+    "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
-    puts "Usage: leg <command> [args...]"
-    puts
-    puts "Commands:"
-    Snaptoken::Commands::LIST.each do |cmd|
-      puts "  #{cmd.name}"
-      puts "      #{cmd.summary}"
+    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"], @config)
+    else
+      puts "There is no '#{@args.first}' command."
     end
   end
 end

data/lib/snaptoken/commands/ref.rb

@@ -4,7 +4,17 @@ class Snaptoken::Commands::Ref < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Convert a step number or name to a git commit reference"
+    "Get the commit hash in repo/ for a step\n" +
+    "name or step number. `leg <step-number>`\n" +
+    "can be used as a shortcut for\n" +
+    "`leg ref <step-number>`."
+  end
+
+  def self.usage
+    "[<step-name> | <step-number>]"
+  end
+
+  def setopts!(o)
   end
 
   def run

data/lib/snaptoken/commands/repo.rb

@@ -4,24 +4,47 @@ class Snaptoken::Commands::Repo < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Convert steps folder into a version controlled repository"
+    "Convert steps/ to repo/. Doesn't overwrite\n" +
+    "repo/ unless forced."
+  end
+
+  def self.usage
+    "[-f] [-q]"
+  end
+
+  def setopts!(o)
+    o.on("-f", "--force", "Overwrite repo/ folder") do |f|
+      @opts[:force] = f
+    end
+
+    o.on("-q", "--quiet", "Don't output progress") do |q|
+      @opts[:quiet] = q
+    end
   end
 
   def run
-    needs! :config, :steps_folder, :steps, not: :repo
+    needs! :config, :steps_folder, :steps
 
     FileUtils.cd(@config[:path])
 
+    if @opts[:force]
+      FileUtils.rm_rf("repo")
+    else
+      needs! not: :repo
+    end
+
     FileUtils.mkdir("repo")
     repo = Rugged::Repository.init_at("repo")
 
     steps.each do |step|
+      print "\r\e[K[steps/ -> repo/] #{step.folder_name}" unless @opts[:quiet]
       commit_oid = add_commit(repo, step, step_path(step))
 
       if step.name
         repo.references.create("refs/tags/#{step.name}", commit_oid)
       end
     end
+    print "\n" unless @opts[:quiet]
 
     if Dir.exist? "repo-extra"
       add_commit(repo, nil, [step_path(latest_step), "repo-extra"])

data/lib/snaptoken/commands/sync.rb

@@ -0,0 +1,75 @@
+class Snaptoken::Commands::Sync < Snaptoken::Commands::BaseCommand
+  def self.name
+    "sync"
+  end
+
+  def self.summary
+    "Sync repo/, steps/, and steps.diff using\n" +
+    "one of them as the source. The <source> can\n" +
+    "be 'repo', 'steps', or 'diff'. The :sync\n" +
+    "option in leg.yml sets the default source.\n" +
+    "If only one possible source exists, then that\n" +
+    "is the default source."
+  end
+
+  def self.usage
+    "[-q] [<source>]"
+  end
+
+  def setopts!(o)
+    o.on("-q", "--quiet", "Don't output progress") do |q|
+      @opts[:quiet] = q
+    end
+  end
+
+  def run
+    needs! :config
+
+    source = nil
+    if !@args.empty?
+      source = @args.first
+    else
+      FileUtils.cd(@config[:path])
+      repo_exists = File.exist?("repo")
+      steps_exists = File.exist?("steps")
+      diff_exists = File.exist?("steps.diff")
+
+      if !repo_exists && !steps_exists && !diff_exists
+        puts "Error: nothing to sync from."
+        exit
+      end
+
+      if repo_exists && !steps_exists && !diff_exists
+        source = "repo"
+      elsif steps_exists && !repo_exists && !diff_exists
+        source = "steps"
+      elsif diff_exists && !repo_exists && !steps_exists
+        source = "diff"
+      else
+        needs! :config_sync
+        source = @config[:sync]
+      end
+    end
+
+    if ! %w(repo steps diff).include?(source)
+      puts "Error: sync source must be 'repo', 'steps', or 'diff'."
+      exit
+    end
+
+    needs! source.to_sym
+
+    args = @opts[:quiet] ? ["--quiet"] : []
+    case source.to_sym
+    when :repo
+      Snaptoken::Commands::Diff.new(args + [], @config).run
+      Snaptoken::Commands::Undiff.new(args + ["--force"], @config).run
+    when :steps
+      Snaptoken::Commands::Repo.new(args + ["--force"], @config).run
+      Snaptoken::Commands::Diff.new(args + [], @config).run
+    when :diff
+      Snaptoken::Commands::Undiff.new(args + ["--force"], @config).run
+      Snaptoken::Commands::Repo.new(args + ["--force"], @config).run
+    end
+  end
+end
+

data/lib/snaptoken/commands/undiff.rb

@@ -4,13 +4,34 @@ class Snaptoken::Commands::Undiff < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Convert steps.diff to steps folder"
+    "Convert steps.diff to steps/. Doesn't\n" +
+    "overwrite steps/ unless forced."
+  end
+
+  def self.usage
+    "[-f] [-q]"
+  end
+
+  def setopts!(o)
+    o.on("-f", "--force", "Overwrite steps/ folder") do |f|
+      @opts[:force] = f
+    end
+
+    o.on("-q", "--quiet", "Don't output progress") do |q|
+      @opts[:quiet] = q
+    end
   end
 
   def run
-    needs! :config, :diff, not: :steps_folder
+    needs! :config, :diff
 
     FileUtils.cd(@config[:path]) do
+      if @opts[:force]
+        FileUtils.rm_rf("steps")
+      else
+        needs! not: :steps_folder
+      end
+
       FileUtils.mkdir("steps")
       FileUtils.cd("steps") do
         File.open("../steps.diff", "r") do |f|
@@ -28,6 +49,8 @@ class Snaptoken::Commands::Undiff < Snaptoken::Commands::BaseCommand
               prev_step = step
               step = Snaptoken::Step.from_commit_msg(prev_step.number + 1, $1)
 
+              print "\r\e[K[steps.diff -> steps/] #{step.folder_name}" unless @opts[:quiet]
+
               if step.number == 1
                 FileUtils.mkdir(step.folder_name)
               else
@@ -41,6 +64,7 @@ class Snaptoken::Commands::Undiff < Snaptoken::Commands::BaseCommand
             end
           end
           apply_diff(step, cur_diff) if cur_diff
+          print "\n" unless @opts[:quiet]
         end
       end
     end

data/lib/snaptoken/commands/unrepo.rb

@@ -4,13 +4,34 @@ class Snaptoken::Commands::Unrepo < Snaptoken::Commands::BaseCommand
   end
 
   def self.summary
-    "Convert repository into steps folder"
+    "Convert repo/ to steps/. Doesn't overwrite\n" +
+    "steps/ unless forced."
+  end
+
+  def self.usage
+    "[-f] [-q]"
+  end
+
+  def setopts!(o)
+    o.on("-f", "--force", "Overwrite steps/ folder") do |f|
+      @opts[:force] = f
+    end
+
+    o.on("-q", "--quiet", "Don't output progress") do |q|
+      @opts[:quiet] = q
+    end
   end
 
   def run
-    needs! :config, :repo, not: :steps_folder
+    needs! :config, :repo
 
     FileUtils.cd(@config[:path]) do
+      if @opts[:force]
+        FileUtils.rm_rf("steps")
+      else
+        needs! not: :steps_folder
+      end
+
       FileUtils.mkdir("steps")
 
       repo = Rugged::Repository.new("repo")
@@ -22,10 +43,12 @@ class Snaptoken::Commands::Unrepo < Snaptoken::Commands::BaseCommand
         break if commit.message.lines.first.strip == "-"
 
         step = Snaptoken::Step.from_commit_msg(idx + 1, commit.message.lines.first.strip)
+        print "\r\e[K[repo/ -> steps/] #{step.folder_name}" unless @opts[:quiet]
 
         repo.checkout(commit.oid, strategy: :force,
                                   target_directory: step_path(step))
       end
+      print "\n" unless @opts[:quiet]
     end
   end
 end

data/lib/snaptoken/commands.rb

@@ -4,14 +4,14 @@ end
 
 require 'snaptoken/commands/base_command'
 
-require 'snaptoken/commands/deploy'
-require 'snaptoken/commands/diff'
 require 'snaptoken/commands/doc'
-require 'snaptoken/commands/help'
-require 'snaptoken/commands/pieces'
+require 'snaptoken/commands/sync'
 require 'snaptoken/commands/fancy'
-require 'snaptoken/commands/ref'
+require 'snaptoken/commands/diff'
 require 'snaptoken/commands/repo'
 require 'snaptoken/commands/undiff'
 require 'snaptoken/commands/unrepo'
+require 'snaptoken/commands/ref'
+require 'snaptoken/commands/deploy'
+require 'snaptoken/commands/help'
 

data/lib/snaptoken/diff.rb

@@ -1,5 +1,4 @@
 class Snaptoken::Diff
-  # -r for recursive?
   GIT_DIFF_OPTIONS = "--histogram --unified=100000 --ignore-space-change --no-index"
 
   attr_reader :files, :html

data/lib/snaptoken.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'net/ftp'
+require 'optparse'
 require 'yaml'
 require 'rugged'
 require 'redcarpet'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptoken
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Jeremy Ruten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -69,9 +69,9 @@ files:
 - lib/snaptoken/commands/doc.rb
 - lib/snaptoken/commands/fancy.rb
 - lib/snaptoken/commands/help.rb
-- lib/snaptoken/commands/pieces.rb
 - lib/snaptoken/commands/ref.rb
 - lib/snaptoken/commands/repo.rb
+- lib/snaptoken/commands/sync.rb
 - lib/snaptoken/commands/undiff.rb
 - lib/snaptoken/commands/unrepo.rb
 - lib/snaptoken/diff.rb

data/lib/snaptoken/commands/pieces.rb

@@ -1,14 +0,0 @@
-class Snaptoken::Commands::Pieces < Snaptoken::Commands::BaseCommand
-  def self.name
-    "pieces"
-  end
-
-  def self.summary
-    "Print an inventory of the number of tokens used between two steps"
-  end
-
-  def run
-    puts "Not implemented"
-  end
-end
-