resme 1.0.1 → 2.0.0

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in resme.gemspec
-gemspec
-
-gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    resme (0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (12.3.3)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  bundler (~> 2.3.20)
-  rake (~> 12.0)
-  resme!
-
-BUNDLED WITH
-   2.3.20

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "resme"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/resme/cli/command_semantics.rb

@@ -1,198 +0,0 @@
-# frozen_string_literal: true
-
-require "resme/version"
-require "readline"
-require "fileutils"
-require "date"
-require "yaml"
-require "erb"
-require "json"
-
-module Resme
-  # Give e meaning to commands
-  module CommandSemantics
-    APPNAME = "resme"
-    VERSION = Resme::VERSION
-
-    #
-    # Main App Starts Here!
-    #
-    def self.version(opts = nil, argv = [])
-      puts "#{APPNAME} version #{VERSION}"
-    end
-
-    def self.man(opts = nil, argv = [])
-      path = File.join(File.dirname(__FILE__), "/../../../README.org")
-      file = File.open(path, "r")
-      puts file.read
-    end
-
-    def self.help(opts = nil, argv = [])
-      all_commands = CommandSyntax.commands
-
-      if argv == []
-        puts "#{APPNAME} command [options] [args]\n"
-        puts "Available commands:\n"
-        all_commands.each_key do |key|
-          puts "  #{all_commands[key][:options].banner}"
-        end
-      else
-        argv.map do |x|
-          puts all_commands[x.to_sym][:help]
-          puts "\n\n"
-        end
-      end
-    end
-
-    def self.console(opts = nil, argv = [])
-      all_commands = CommandSyntax.commands
-      all_commands.delete(:console)
-
-      i = 0
-      loop do
-        string = Readline.readline("#{APPNAME}:%03d> " % i, true)
-        # as a courtesy, remove any leading appname string
-        string.gsub!(/^#{APPNAME} /, "")
-        exit 0 if %w[exit quit .].include? string
-        execute all_commands, string.split(" ")
-        i += 1
-      end
-    end
-
-    # read-eval-print step
-    # check if argv is in any of all_commands, parse options
-    # according to the specification in all_commands and invoke
-    # a function in this class to actually do the work
-    def self.execute(all_commands, argv)
-      if argv == [] or argv[0] == "--help" or argv[0] == "-h"
-        help
-        exit 0
-      else
-        command = argv[0]
-        command_spec = all_commands[command.to_sym]
-
-        if command_spec
-          command_name = command_spec[:name]
-          option_parser = command_spec[:options]
-
-          begin
-            argv.shift # remove command name from ARGV
-            options = {}
-            parser = option_parser.parse!(into: options)
-            eval "CommandSemantics::#{command_name}(options, argv)"
-          rescue Exception => e
-            puts "#{APPNAME} error: #{e}"
-            puts "Help with \"#{APPNAME} help #{command_name}\""
-          end
-        else
-          puts "#{APPNAME} error: "#{command}" is not a valid command."
-          puts "List commands with \"#{APPNAME} help\"."
-        end
-      end
-    end
-
-    #
-    # APP SPECIFIC COMMANDS
-    #
-    def self.check(opts, argv)
-      begin
-        document = YAML.load_file(argv[0], permitted_classes: [Date])
-      rescue Psych::SyntaxError => ex
-        puts "The file #{argv[0]} has an invalid structure."
-        puts ex.message
-        exit 1
-      end
-        
-      begin
-        errors = ResumeStructureValidator.validate(document)
-      rescue Exception => ex
-        puts "The files #{argv[0]} does not validate"
-        ex.entries.each do |error|
-          puts "#{error[:full_path]}: #{error[:message]}"
-        end
-        exit 1
-      end
-      puts "The file #{argv[0]} has a valid structure."
-    end
-
-    def self.init(opts, argv)
-      output = opts[:output] || "resume.yml"
-      force = opts[:force]
-      path = File.dirname(__FILE__), "/../templates/resume.yml"
-      template = File.join(path)
-
-      # avoid catastrophe
-      if File.exist?(output) && !force
-        puts "#{APPNAME} error: file #{output} already exists."
-        puts "Use --force if you want to overwrite it."
-      else
-        content = File.read(template)
-        backup_and_write output, content
-        puts "YML resume template generated in #{output}"
-      end
-    end
-
-    def self.list(opts, argv)
-      data = {}
-      argv.each do |file|
-        data = data.merge(YAML.load_file(file, permitted_classes: [Date]))
-      end
-      puts "Sections included in #{argv.join(", ")}:"
-      data.keys.each do |key|
-        puts "- #{key}: #{(data[key] || []).size} entries"
-      end
-    end
-
-    def self.view(opts, argv)
-      format = opts[:to]
-      template = File.join(File.dirname(__FILE__), "/../templates/resume.#{format}.erb")
-      puts File.read template
-    end
-
-    def self.generate(opts, argv)
-      format = opts[:to]
-      output = opts[:output] || "resume-#{Date.today}.#{format}"
-
-      if opts[:erb]
-        template = opts[:erb]
-      else
-        template = File.join(File.dirname(__FILE__), "/../templates/resume.#{format}.erb")
-      end
-
-      skipped_sections = opts[:skip] || []
-
-      if !File.exist?(template)
-        puts "#{APPNAME} error: format #{format} is not understood."
-      end
-
-      render argv, template, output, skipped_sections
-      puts "Resume generated in #{output}"
-    end
-
-    private_class_method def self.render(yml_files, template_name, output_name, skipped_sections)
-      data = {}
-      yml_files.each do |file|
-        data = data.merge(YAML.load_file(file, permitted_classes: [Date]))
-      end
-      skipped_sections.each do |section|
-        data.reject! { |k| k == section }
-      end
-      template = File.read(template_name)
-      output = ERB.new(template, trim_mode: "-").result(binding)
-      # it is difficult to write readable ERBs with no empty lines...  we use
-      # gsub to replace multiple empty lines with \n\n in the final output
-      output.gsub!(/([\t ]*\n){3,}/, "\n\n")
-      backup_and_write output_name, output
-    end
-
-    private_class_method def self.backup(filename)
-      FileUtils::cp filename, filename + "~"
-      puts "Backup copy #{filename} created in #{filename}~."
-    end
-
-    private_class_method def self.backup_and_write(filename, content)
-      backup(filename) if File.exist?(filename)
-      File.open(filename, "w") { |f| f.puts content }
-    end
-  end
-end

data/lib/resme/cli/command_syntax.rb

@@ -1,282 +0,0 @@
-require "optparse"
-
-module Resme
-  module CommandSyntax
-    # Return a hash of hashes.  Each key is the name of a command and
-    # includes useful information, such as an Option object to
-    # parse options and a documentation string.
-    def self.commands
-      cmd_spec = {}
-      methods.each do |method|
-        cmd_spec = cmd_spec.merge eval(method.to_s) if method.to_s.include?("_opts")
-      end
-      cmd_spec
-    end
-
-    def self.version_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "version # print version information"
-      end
-      
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          return version information
-
-        EXAMPLES
-          # resme version
-          resme version #{VERSION}
-      EOS
-      
-      {
-        version: {
-          name: :version,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.console_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "console # enter the console"
-      end
-      
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Invoke a console, from which you can more easily run
-          resme commands.
-
-        EXAMPLES
-          resme console
-          resme:000> check
-          resme:001> generate -t md
-          resme:002>
-      EOS
-      
-      {
-        console: {
-          name: :console,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.man_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "man # print resme manual page"
-      end
-      
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Print the README file of this gem
-
-        EXAMPLES
-          resme man
-      EOS
-      
-      {
-        man: {
-          name: :man,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.help_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "help [command] # print command usage"
-      end
-
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Print help about a command
-
-        EXAMPLES
-          resme help
-          resme help generate
-      EOS
-      {
-        help: {
-          name: :help,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.init_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "init [options] # generate an empty resume.yml file"
-        opts.on("-o", "--output FILENAME", String, "Output filename")
-        opts.on("-f", "--force", FalseClass, "Overwrite existing file (if present)")
-      end
-      
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Generate a YAML template for your resume in the current directory.
-
-        EXAMPLES
-          resme init
-          resme init -o r.yml
-          resme init -o r.yml --force
-      EOS
-      {
-        init: {
-          name: :init,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.check_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "check resume.yml # Check syntax of resume.yml"
-      end
-
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Check whether a YAML file conforms with the RESME syntax.
-
-        EXAMPLES
-          resme check file.yml
-      EOS
-      
-      {
-        check: {
-          name: :check,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.list_opts
-      opts = OptionParser.new do |opts|
-        opts.banner = "list resume.yml # List main sections in resume.yml"
-      end
-
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          List main sections in resume.yml.
-
-        EXAMPLES
-          resme list file.yml
-      EOS
-      
-      {
-        list: {
-          name: :list,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.view_opts
-      opts = OptionParser.new do |o|
-        o.banner = "view --template FORMAT # Print template used for format"
-        o.on("-t", "--template FORMAT", String, "View template for FORMAT")
-      end
-
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Print template used for FORMAT
-
-        EXAMPLES
-          resme view --template md
-      EOS
-      
-      {
-        view: {
-          name: :view,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-
-    def self.generate_opts
-      opts = OptionParser.new do |o|
-        o.banner = "generate [options] resume.yml ... # output resume"
-        o.on("-e", "--erb FILENAME", String, "Template to use")
-        o.on("-t", "--to FORMAT", String, "Output format")
-        o.on("-o", "--output FILENAME", String, "Output filename")
-        o.on("-s", "--skip SECTION,SECTION", Array, "Sections to skip")
-      end
-
-      help = <<-EOS
-        NAME
-          #{opts.banner}
-
-        SYNOPSYS
-          #{opts.to_s}
-
-        DESCRIPTION
-          Generate a resume from the YAML input files.
-
-        EXAMPLES
-          resme generate -t org resume.yml
-          resme generate -t md -o r.md section-1.yml section-2.yml
-      EOS
-      
-      {
-        generate: {
-          name: :generate,
-          options: opts,
-          help: help.gsub("        ", "")
-        }
-      }
-    end
-  end
-end