resuby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fd599e4cbec4923371bc76965fc672c7d7a8fa3
+  data.tar.gz: ce42045b330c1f7b9ce6560b9ab4371a6b94977c
+SHA512:
+  metadata.gz: 1b7c7e4171a359fe0c7bd8096a166ba27257cd242d11a48277523db91f952215d889961e6c821d1b2a1c8448f247263aa06cd18b6006cd5964fda95241444ff8
+  data.tar.gz: 495ec1437faca54af1073b34081d7b2ebce477b6deb75382da61c02373c9ab67e578d29a59710c7b9084ef8a8d0eb03a3623dbfbc23751dc7149c8fcd77a9ee9

data/README.md

@@ -0,0 +1,82 @@
+# Resuby
+
+[![Gem](https://img.shields.io/gem/v/resuby.svg?style=flat-square)](https://rubygems.org/gems/resuby)
+[![GitHub issues](https://img.shields.io/github/issues/mardotio/resuby.svg?style=flat-square)](https://github.com/mardotio/resuby/issues)
+[![Gem](https://img.shields.io/gem/dtv/resuby.svg?style=flat-square)](https://rubygems.org/gems/resuby)
+
+## 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.
+
+## Table of Contents
+
+<!-- TOC -->
+
+- [Resuby](#resuby)
+  - [Overview](#overview)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [Generating Resume](#generating-resume)
+  - [Compatibility](#compatibility)
+
+<!-- /TOC -->
+
+## Installation
+
+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.
+
+## 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.
+
+|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|
+
+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.
+
+|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|
+
+[`default.yaml`](/examples/default.yaml) contains a sample structure.
+
+## Generating Resume
+
+Once you have created a `resume.yaml` 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__).
+
+
+## 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.

data/bin/resuby

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+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'
+  exit 1
+end

data/lib/resuby/css/main.scss

@@ -0,0 +1,94 @@
+html {
+  font-family: "Muli";
+  width: 215.9mm;
+  height: 279.4mm;
+  border: 1px solid red;
+  display: flex;
+  align-items: center;
+
+  @media print {
+    border: 0;
+  }
+}
+
+body, ul, h1, h2, h3 {
+  margin: 0;
+  font-weight: normal;
+}
+
+body {
+  padding: 0 1in;
+  font-size: 11pt;
+}
+
+.header {
+  text-align: center;
+  ul {
+    padding: 0;
+  }
+
+  li {
+    display: inline;
+    &:after {
+      content: '\2022';
+      padding-left: 5px;
+    }
+  }
+
+  li:last-child {
+    &:after {
+      content: '';
+    }
+  }
+}
+
+.section-header {
+  margin-top: 5px;
+}
+
+.section-profile {
+  margin-top: 5px;
+  margin-bottom: 0;
+}
+
+.section-row {
+  display: flex;
+  margin-top: 5px;
+}
+
+.section-desc {
+  flex: 1;
+  text-align: right;
+  padding-right: 10px;
+  border-right: 2px solid black;
+  ul {
+    list-style: none;
+    padding: 0;
+  }
+}
+
+.section-info {
+  flex: 5.5;
+  padding-left: 10px;
+  ul {
+    list-style: none;
+    padding: 0;
+    font-size: 10pt;
+
+    .info-title, .info-subtitle {
+      font-size: 11pt;
+    }
+
+    .info-subtitle {
+      font-style: italic;
+    }
+  }
+}
+
+.hr {
+  width: 100%;
+  height: 2px;
+  background-color: black;
+  display: block;
+  margin-top: 5px;
+}

data/lib/resuby/templates/resume.erb

@@ -0,0 +1,56 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <link rel="stylesheet" href="css/main.css">
+    <link href="https://fonts.googleapis.com/css?family=Muli" rel="stylesheet">
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Resume</title>
+  </head>
+
+  <body>
+    <div class="header">
+      <h1 class="name"><%=@name%></h1>
+      <ul>
+        <% for @info in @contact_info %>
+        <li class="contact-info"><%=@info%></li>
+        <% end %>
+      </ul>
+    </div>
+
+    <div>
+      <% if @profile %>
+      <h2 class="section-header">Profile</h2>
+      <span class="hr"></span>
+      <p class="section-profile">
+        <%=@profile%>
+      </p>
+      <% end %>
+
+      <% 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] %>
+      <div class="section-row">
+        <div class="section-desc">
+          <%=@row['desc']%>
+        </div>
+        <div class="section-info">
+          <ul>
+            <% if @row['title'] %>
+            <li class="info-title"><%=@row['title']%></li>
+            <% end %>
+            <% if @row['subtitle'] %>
+            <li class="info-subtitle"><%=@row['subtitle']%></li>
+            <% end %>
+            <% for @data in @row['data'] %>
+            <li><%=@data%></li>
+            <% end %>
+          </ul>
+        </div>
+      </div>
+      <% end %>
+      <% end %>
+    </div>
+  </body>
+</html>

data/lib/resuby/version.rb

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

data/lib/resuby.rb

@@ -0,0 +1,44 @@
+require 'erb'
+require 'yaml'
+require 'sass'
+
+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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: resuby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mario Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.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.5.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
+      resuby will take care of creating a resume that you can use.
+email: lopezrobles.mario@gmail.com
+executables:
+- resuby
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/resuby
+- lib/resuby.rb
+- lib/resuby/css/main.scss
+- lib/resuby/templates/resume.erb
+- lib/resuby/version.rb
+homepage: https://github.com/mardotio/resuby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Resume generator
+test_files: []