resuby 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fd599e4cbec4923371bc76965fc672c7d7a8fa3
-  data.tar.gz: ce42045b330c1f7b9ce6560b9ab4371a6b94977c
+  metadata.gz: a39bc8b678cb2e72c5f51779ab719482b98ff0f0
+  data.tar.gz: 382c006dd90706b9a6a13c373c5563bc229590ca
 SHA512:
-  metadata.gz: 1b7c7e4171a359fe0c7bd8096a166ba27257cd242d11a48277523db91f952215d889961e6c821d1b2a1c8448f247263aa06cd18b6006cd5964fda95241444ff8
-  data.tar.gz: 495ec1437faca54af1073b34081d7b2ebce477b6deb75382da61c02373c9ab67e578d29a59710c7b9084ef8a8d0eb03a3623dbfbc23751dc7149c8fcd77a9ee9
+  metadata.gz: 2ef5d314c79fa1b3bc35c056634b73e35825d17c44cd56e691ed5beeaac1aa7b7d832ee656f7387f53ceae9357f867d889c61624e47eb7e7e6de08f41b4bc61d
+  data.tar.gz: 42164fcc704bac4ced41a739d575db4d965cfb3c9e6c5a0d3b3780bea360c618e3709b5b31bc61fe00ce2f686de0b339d98be3804606a626a9ed70d15d1ad6f8

data/README.md

@@ -6,11 +6,14 @@
 
 ## Overview
 
-Resuby is a gem that takes a `yaml` configuration file that contains all of your
-resume information, and turns it into a resume you can actually use to find your
-next job. After you generate your resume, you will have an HTML file that you
-can open in your favorite browser (as long as yor favorite browser is Chrome or
-Safari), and view the end result.
+Resuby is a gem that takes a `YAML` or `JSON` configuration file that contains all of your resume information, and turns
+it into a resume you can actually use to find your next job. The data file is converted into an HTML file, and the
+accompanying CSS styles, which you can then view in a browser. From there, you can print your resume, save it as a PDF,
+or do anything else you can do to a web page.
+
+This project was inpired by my need to get away from awkward tables in Word, and my desire to be able to version control
+my resume. With Resuby, you only need to store the `JSON`, or `YAML` file, as the HTML and CSS can easily be generated
+again (although you could certainly save that too).
 
 ## Table of Contents
 
@@ -21,7 +24,9 @@ Safari), and view the end result.
   - [Table of Contents](#table-of-contents)
   - [Installation](#installation)
   - [Usage](#usage)
-  - [Generating Resume](#generating-resume)
+    - [CLI](#cli)
+      - [Generating Resume](#generating-resume)
+      - [Generating Resume Data Template](#generating-resume-data-template)
   - [Compatibility](#compatibility)
 
 <!-- /TOC -->
@@ -30,53 +35,65 @@ Safari), and view the end result.
 
 To install, simply run `gem install resuby`.
 
-In addition to resuby, it will install SASS, which is a common CSS pre-compiler
-that is used by resuby to generate the CSS file for your resume.
+In addition to resuby, it will install SASS, which is a common CSS pre-compiler that is used by resuby to generate the
+CSS file for your resume, and Optimist, which is used to handle CLI interactions.
 
 ## Usage
 
-In order for the script to work, you will first need to create a file in the
-root directory of the project called `resume.yaml`. This file should contain
-your name, contact information, and any other information that you want in your
-resume. Below are the keywords that are expected in the yaml file.
+### CLI
+
+By default, the `resuby` executable will look for a file called `resume.yaml` in your current working directory (you can
+pass it a different path). The `YAML` or `JSON` file needs to contain all of the information you want in your resume.
+The table below summarizes the keys that `resuby` expects to find in the data file.
 
 |Key|Class|Required|Description|
 |---|-----|--------|-----------|
-|`name`|String|True|Your name|
-|`contact`|Array|True|Any contact information (i.e. phone, email)|
-|`profile`|String|False|A small paragraph that describes you|
-|Any other key|Array|False|These will become the headers for your other resume sections (i.e. education -> Education, projects_&_experience -> Projects & Experience|
+|`name`|String|*|Your name|
+|`contact`|Array|*|Any contact information (i.e. phone, email)|
+|`profile`|String||A small paragraph that describes you|
+|Any other key|Array||These will become the headers for your other resume sections (i.e. `education` -> `Education`, `projects_&_experience` -> `Projects & Experience`|
 
-Each array element under the headers you create is expected to be a hash. All of
-the array elements under those sections will become a new row under that header.
-Below are the expected key values for each array element under your headers.
+Each array element under the headers you create is expected to be a hash. All of the array elements under those sections
+will become a new row under that header. Below are the expected key values for each array element.
 
 |Key|Class|Required|Description|
 |---|-----|--------|-----------|
-|`title`|String|False|Main point for that row, will have slightly larger font than the rest of the values|
-|`desc`|String|True|Description for that section (i.e. dates), will be displayed to the left of that section|
-|`subtitle`|String|False|Will be displayed right under the title, will be in italics|
-|`data`|Array|True|Any other info, such as accomplishments,  each array element will be a new bullet|
+|`desc`|String|*|Description for that section (i.e. dates), will be displayed to the left of that section|
+|`title`|String||Main point for that row, will have slightly larger font than the rest of the values|
+|`subtitle`|String||Will be displayed right under the title, will be in italics|
+|`data`|Array|*|Any other info, such as accomplishments,  each array element will be a new bullet|
 
-[`default.yaml`](/examples/default.yaml) contains a sample structure.
+[`default.yaml`](/examples/default.yaml) contains a sample `YAML` structure. [`default.json`](/examples/default.json)
+contains a sample `JSON` structure.
 
-## Generating Resume
+#### Generating Resume
 
-Once you have created a `resume.yaml` file, you can run the following command
-from the same directoy:
+Once you have a data file, you can run the following command from the same directoy:
 
 ```
 resuby generate
 ```
 
-Running this command will generate a file called `resume.html` in your current
-directory. Now you can simply open this in a browser, and print it (__make sure
-that the printed page has no margins, as the HTML generated will have its
-own margins set__).
+Running this command will generate a file called `resume.html`, and a `css/` directory in your current workspace. Now
+you can simply open this in a browser, and print it (__make sure that the printed page has no margins, as the HTML
+generated will have its own margins set__).
+
+#### Generating Resume Data Template
+
+Think converting your resume to `YAML` or `JSON` will take too long? Well, the `resuby` CLI can help take some of that
+burden off of your shoulders by generating a data template. Once you have the template, simply fill in the file with
+your information, and you should be ready to go. To create a template just do:
+
+```
+resuby generate -o <path/to/template> -y
+```
+
+This will generate the template in `YAML` format, however, you can make it output `JSON` just as easily if that's more
+your style.
 
+You can run `resuby generate --help` to get additional information about the executable.
 
 ## Compatibility
 
-The generated HTML and styling has only been tested in Chrome and Safari.
-This doesn't mean it won't work on other browsers, but it is not guaranteed to
-look as designed.
+The generated HTML and styling has only been tested in Chrome and Safari. This doesn't mean it won't work on other
+browsers, but it is not guaranteed to look as designed.

data/bin/resuby

@@ -2,16 +2,9 @@
 
 require 'resuby'
 
-options = ARGV
-
-if options.first == 'generate'
-  new_resume = Resuby.new
-  resume_data = File.join(Dir.pwd, 'resume.yaml')
-  resume = File.join(Dir.pwd, 'resume.html')
-  new_resume.read_source(resume_data)
-  new_resume.save_resume(resume)
-  new_resume.compile_styles
-else
-  puts 'Specify an action to create your resume'
+begin
+  Resuby::CLI.run
+rescue Interrupt
+  warn 'Aborted'
   exit 1
 end

data/lib/resuby.rb

@@ -1,44 +1,5 @@
-require 'erb'
-require 'yaml'
-require 'sass'
+require 'resuby/resume/resume'
+require 'resuby/cli/cli'
+require 'resuby/version'
 
-class Resuby
-  attr_reader :name, :contact_info, :sections, :template, :profile
-
-  def initialize
-    @template = File.read(File.join(File.dirname(__FILE__), 'resuby/templates/resume.erb'))
-  end
-
-  def read_source(source)
-    puts "Reading in data from #{source}"
-    resume_data = YAML.load_file(source)
-    @name = resume_data['name']
-    @contact_info = resume_data['contact']
-    @profile = resume_data['profile']
-    @sections = resume_data.reject { |key, value| ['name', 'contact', 'profile'].include?(key) }
-  end
-
-  def render
-    ERB.new(self.template).result( binding )
-  end
-
-  def save_resume(file)
-    puts "Saving your resume at #{file}"
-    File.open(file, "w+") do |f|
-      f.write(render)
-    end
-  end
-
-  def compile_styles
-    options = {
-      cache: true,
-      syntax: :scss,
-      style: :compressed,
-    }
-
-    scss_file = File.join(File.dirname(__FILE__), 'resuby/css/main.scss')
-    render = Sass::Engine.new(File.read(scss_file), options).render
-    Dir.mkdir(File.join(Dir.pwd, 'css'), 0755) unless File.directory?(File.join(Dir.pwd, 'css'))
-    File.write(File.join(Dir.pwd, 'css/main.css'), render)
-  end
-end
+module Resuby; end

data/lib/resuby/cli/banners.rb

@@ -0,0 +1,30 @@
+module Resuby::CLI
+  RESUBY_BANNER = <<-EOT
+Create an HTML resume from a YAML file.
+
+Usage: resuby <options> [command] [<args>]
+
+Commands:
+generate      Generate an HTML resume
+init          Initialize project by creating a resume data template
+
+Options:
+  EOT
+
+  GENERATE_BANNER = <<-EOT
+Generate an HTML file that contains your resume. This will also generate the
+required CSS styles for the HTML template.
+
+Usage: resuby generate <options>
+
+Options:
+  EOT
+
+  INIT_BANNER = <<-EOT
+Creates a template for the resume data file.
+
+Usage: resuby init <options>
+
+Options:
+  EOT
+end

data/lib/resuby/cli/cli.rb

@@ -0,0 +1,61 @@
+require 'resuby/cli/banners'
+require 'resuby/cli/exe'
+require 'optimist'
+
+module Resuby::CLI
+  def self.run
+    Resuby::CLI.options
+  end
+
+  def self.options
+    Resuby::CLI.global_options
+    @subcommand = ARGV.shift
+    Resuby::CLI.subcommand_options
+    Resuby::CLI.execute
+  end
+
+  def self.global_options
+    @global_opts = Optimist::options do
+      banner Resuby::CLI::RESUBY_BANNER
+      version "resuby version #{Resuby::VERSION}"
+      stop_on %w(generate init)
+    end
+  end
+
+  def self.subcommand_options
+    case @subcommand
+    when 'generate'
+      @opts = Optimist::options do
+        banner Resuby::CLI::GENERATE_BANNER
+        opt :data, 'Path to file containing data for the resume', default: File.join(Dir.pwd, 'resume.yaml')
+        opt :json, 'Read in data file as a JSON formatted file'
+        opt :output, 'Output file for generated HTML', default: File.join(Dir.pwd, 'resume.html')
+        opt :yaml, 'Read in data file as a YAML formatted file'
+      end
+      Optimist::die 'Data file connot be JSON and YAML' if @opts[:json] && @opts[:yaml]
+    when 'init'
+      @opts = Optimist::options do
+        banner Resuby::CLI::INIT_BANNER
+        opt :force, 'Force overwrite of data file if already present'
+        opt :json, 'Outputs data template in JSON format'
+        opt :output, 'Path to file where data template should be placed', required: true, type: :string
+        opt :yaml, 'Outputs data template in YAML format'
+      end
+      Optimist::die 'Cannot output two different formats at the same time' if @opts[:json] && @opts[:yaml]
+      Optimist::die 'You must specify an output format' unless @opts[:json] || @opts[:yaml]
+    else
+      Optimist::die "Unknonwn subcommand #{@subcommand.inspect}"
+    end
+  end
+
+  def self.execute
+    case @subcommand
+    when 'generate'
+      Resuby::CLI.generate
+    when 'init'
+      Resuby::CLI.init
+    else
+      Optimist::die "Unknonwn subcommand #{@subcommand.inspect}"
+    end
+  end
+end

data/lib/resuby/cli/exe.rb

@@ -0,0 +1,112 @@
+module Resuby::CLI
+  def self.generate
+    resume = Resuby::Resume.new
+    ext =
+      if @opts[:yaml]
+        '.yaml'
+      elsif @opts[:json]
+        '.json'
+      else
+        nil
+      end
+    resume.read_source(@opts[:data], ext)
+    resume.save_resume(@opts[:output])
+    resume.compile_styles
+  end
+
+  def self.init
+    unless @opts[:force]
+      if File.file?(@opts[:output]) && File.size?(@opts[:output])
+        print "#{@opts[:output]} already exists, would you like to proceed (Y/N)? "
+        proceed = gets.chomp
+        unless proceed == 'Y'
+          warn 'Aborted!'
+          exit 1
+        end
+      end
+    end
+    template = {
+      'name'=> 'Bob Smith',
+      'contact'=> [
+        '(321) 321-4321',
+        'bob.smith@resuby.com',
+      ],
+      'profile'=> 'This section is optional, but it is a good place to write a short paragraph about yourself.',
+      'experience'=> [
+        {
+          'title'=> 'Position 1',
+          'subtitle'=> 'Company 1',
+          'desc'=> 'Jan 2018 - present',
+          'data'=> [
+            'Responsibility/accomplishment 1',
+            'Responsibility/accomplishment 2',
+            'Responsibility/accomplishment 3',
+          ],
+        },{
+          'title'=> 'Position 2',
+          'subtitle'=> 'Company 2',
+          'desc'=> 'Jan 2017 - Jan 2018',
+          'data'=> [
+            'Responsibility/accomplishment 1',
+            'Responsibility/accomplishment 2',
+            'Responsibility/accomplishment 3',
+          ],
+        }
+      ],
+      'projects'=> [
+        {
+          'title'=> 'Project 1',
+          'subtitle'=> 'Company 1',
+          'desc'=> 'Aug 2018 - present',
+          'data'=> [
+            'Responsibility/accomplishment 1',
+            'Responsibility/accomplishment 2',
+            'Responsibility/accomplishment 3',
+          ]
+        },{
+          'title'=> 'Project 2',
+          'subtitle'=> 'Company 2',
+          'desc'=> 'Mar 2017 - Jan 2018',
+          'data'=> [
+            'Responsibility/accomplishment 1',
+            'Responsibility/accomplishment 2',
+            'Responsibility/accomplishment 3',
+          ],
+        }
+      ],
+      'education'=> [
+        {
+          'title' => 'Some University',
+          'desc' => 'Aug 2010 - May 2014',
+          'data' => [
+            'Degree, GPA',
+          ],
+        }
+      ],
+      'skills'=> [
+        {
+          'desc' => 'Languages',
+          'data' => [
+            'Ruby, Python',
+            'HTML, CSS, Javascript',
+          ],
+        },{
+          'desc' => 'Tools',
+          'data' => [
+            'Tool 1, Tool 2',
+            'Tool 3, Tool 4',
+          ],
+        },
+      ],
+    }
+    puts "Storing template at #{@opts[:output]}"
+    if @opts[:yaml]
+      File.open(@opts[:output], 'w') { |f| f.puts template.to_yaml }
+    elsif @opts[:json]
+      File.open(@opts[:output], 'w') { |f| f.puts JSON.pretty_generate(template) }
+    else
+      puts 'Template format is not supported'
+      exit 1
+    end
+  end
+end

data/lib/resuby/css/main.scss

@@ -75,7 +75,7 @@ body {
     padding: 0;
     font-size: 10pt;
 
-    .info-title, .info-subtitle {
+    .info-title {
       font-size: 11pt;
     }
 

data/lib/resuby/resume/resume.rb

@@ -0,0 +1,60 @@
+require 'erb'
+require 'json'
+require 'yaml'
+require 'sass'
+require 'resuby/version'
+
+class Resuby::Resume
+  attr_reader :name, :contact_info, :sections, :template, :profile
+
+  def initialize
+    @template = File.read(File.join(__dir__, '../templates/resume.erb'))
+  end
+
+  def read_source(source, extension = nil)
+    puts "Reading in data from #{source}"
+    ext = extension || File.extname(source)
+    resume_data =
+    case ext
+    when '.yaml', '.yml'
+      YAML.load_file(source)
+    when '.json'
+      JSON.parse(File.read(source))
+    else
+      puts 'File type not supported'
+      exit 1
+    end
+    store_data(resume_data)
+  end
+
+  def store_data(data)
+    @name = data['name']
+    @contact_info = data['contact']
+    @profile = data['profile']
+    @sections = data.reject { |key, value| ['name', 'contact', 'profile'].include?(key) }
+  end
+
+  def render
+    ERB.new(self.template, nil, '-').result( binding )
+  end
+
+  def save_resume(file)
+    puts "Saving your resume at #{file}"
+    File.open(file, "w+") do |f|
+      f.write(render)
+    end
+  end
+
+  def compile_styles
+    options = {
+      cache: true,
+      syntax: :scss,
+      style: :compressed,
+    }
+
+    scss_file = File.join(__dir__, '../css/main.scss')
+    render = Sass::Engine.new(File.read(scss_file), options).render
+    Dir.mkdir(File.join(Dir.pwd, 'css'), 0755) unless File.directory?(File.join(Dir.pwd, 'css'))
+    File.write(File.join(Dir.pwd, 'css/main.css'), render)
+  end
+end

data/lib/resuby/templates/resume.erb

@@ -12,45 +12,46 @@
     <div class="header">
       <h1 class="name"><%=@name%></h1>
       <ul>
-        <% for @info in @contact_info %>
+        <%- for @info in @contact_info -%>
         <li class="contact-info"><%=@info%></li>
-        <% end %>
+        <%- end -%>
       </ul>
     </div>
 
     <div>
-      <% if @profile %>
+      <%- if @profile -%>
       <h2 class="section-header">Profile</h2>
       <span class="hr"></span>
       <p class="section-profile">
         <%=@profile%>
       </p>
-      <% end %>
+      <%- end -%>
 
-      <% for @section in @sections.keys %> 
+      <%- for @section in @sections.keys -%>
       <h2 class="section-header"><%=@section.split('_').map { |word| word.capitalize }.join(' ')%></h2>
       <span class="hr"></span>
-      <% for @row in @sections[@section] %>
+      <%- for @row in @sections[@section] -%>
       <div class="section-row">
         <div class="section-desc">
           <%=@row['desc']%>
         </div>
         <div class="section-info">
           <ul>
-            <% if @row['title'] %>
+            <%- if @row['title'] -%>
             <li class="info-title"><%=@row['title']%></li>
-            <% end %>
-            <% if @row['subtitle'] %>
+            <%- end -%>
+            <%- if @row['subtitle'] -%>
             <li class="info-subtitle"><%=@row['subtitle']%></li>
-            <% end %>
-            <% for @data in @row['data'] %>
+            <%- end -%>
+            <%- for @data in @row['data'] -%>
             <li><%=@data%></li>
-            <% end %>
+            <%- end -%>
           </ul>
         </div>
       </div>
-      <% end %>
-      <% end %>
+
+      <%- end -%>
+      <%- end -%>
     </div>
   </body>
 </html>

data/lib/resuby/version.rb

@@ -1,3 +1,3 @@
-class Resuby
-  VERSION = '0.0.1'.freeze
+module Resuby
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resuby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Mario Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: |-
   Resuby generates an HTML and CSS resume that you can access with your
       browser. You simply define the content of your resume in a YAML file, and
@@ -44,7 +64,11 @@ files:
 - README.md
 - bin/resuby
 - lib/resuby.rb
+- lib/resuby/cli/banners.rb
+- lib/resuby/cli/cli.rb
+- lib/resuby/cli/exe.rb
 - lib/resuby/css/main.scss
+- lib/resuby/resume/resume.rb
 - lib/resuby/templates/resume.erb
 - lib/resuby/version.rb
 homepage: https://github.com/mardotio/resuby