json_resume 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 611619ad281dcba8a17ffa917d97277a9417061a
-  data.tar.gz: b7ca67570ed43f1f6d2b1d2d346e44e47894b294
+  metadata.gz: 5c2a37ce811da368c2df5af7af1e7e4088b34072
+  data.tar.gz: 39690709061e65e1183a938971689231a7662dc3
 SHA512:
-  metadata.gz: fab1a474d7a83b60006a117c9c9ff06b5dc8323ae5f53c8581bc484baccddfc90055218b184437d313d7ed158893c218d3b55e9b69f9b00e7e4dd27b0254b81c
-  data.tar.gz: fe42ee34a78d87edf5c6b5b32c6a706acddf4bd6ae5b138cc73dbf81951d84ad12dbac17818618eed5726baa780d171027fd8eb8010fa41cd8123acb6693140f
+  metadata.gz: 3f567a271f08691c337ae6141e4856107c84f30fbe98d2aecaebc9b05e0ddd0df21b5e4246179df9b0c7c67633e4e779b19b3d502c557430d8785566edb0708f
+  data.tar.gz: 262094ab199cc9c47d347e6dddef3e857b94719aa236cfc5ff11901602ed1e186067983957c5013d6f0ac1a485112f6c4fa5ca911b9c0ae49ac3f87b47f72492

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,87 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-29 14:04:27 +0530 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 253
+
+# Offense count: 36
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 213
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 30
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Enabled: true
+
+# Offense count: 1
+Style/ClassVars:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Keywords.
+Style/CommentAnnotation:
+  Enabled: true
+
+# Offense count: 11
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/EachWithObject:
+  Enabled: true
+
+# Offense count: 1
+Style/EvenOdd:
+  Enabled: true
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: true
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodName:
+  Enabled: true
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: true
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/RaiseArgs:
+  Enabled: true
+
+# Offense count: 2
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  Enabled: true
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Enabled: true

data/README.md

@@ -16,6 +16,8 @@ A [sample](https://github.com/prat0318/json_resume/blob/master/examples/prateek_
 
 Modify it as per the needs, and remove or keep rest of the fields empty.
 
+Note: YAML files are also supported. Try `$ json_resume sample --in=yaml`.
+
 ### Conversion
 
 * Syntax
@@ -23,12 +25,15 @@ Modify it as per the needs, and remove or keep rest of the fields empty.
 ```
     json_resume convert [--template=/path/to/custom/template]
                         [--out=html|html_pdf|tex|tex_pdf|md]
-                        [--locale=es|en|pt]
+                        [--locale=es|en|pt|zh_cn]
+			[--dest_dir=/path/to/put/output/files]
                         [--theme=default|classic] <json_input>
 
     <json_input> can be /path/to/json OR "{'json':'string'}" OR http://raw.json
 ```
 
+    NEW: YAML files are also supported. Pass path/to/yaml file (must have .yaml or .yml).
+
 * Default (HTML) version
 
 ```

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/json_resume

@@ -7,40 +7,52 @@ require_relative '../lib/json_resume'
 require 'zlib'
 require 'pdfkit'
 require 'rest-client'
+require 'json'
+require 'yaml'
 
-WL_URL = "https://www.writelatex.com/docs"
+WL_URL = 'https://www.overleaf.com/docs'
 
 class String
-        def red;            "\033[31m#{self}\033[0m" end
-        def green;          "\033[32m#{self}\033[0m" end
+  def red
+    "\033[31m#{self}\033[0m"
+  end
+
+  def green
+    "\033[32m#{self}\033[0m"
+  end
 end
 
 class JsonResumeCLI < Thor
-
-  desc "convert /path/to/json/file", "converts the json to pretty resume format"
-  option :out, :default=>"html", :banner=>"output_type", :desc=>"html|html_pdf|tex|tex_pdf|md"
-  option :template, :banner=>"template_path", :desc=>"path to customized template (optional)"
-  option :locale, :default=>"en", :banner=>"locale", :desc=>"en|es|pt"
-  option :theme, :default=>"default", :banner=>"theme", :desc=>"default|classic"
-  option :dest_dir, :default=>"current", :banner=>"dest_dir", :desc=>"location of dest. dir (optional)"
+  desc 'convert /path/to/json/file', 'converts the json to pretty resume format'
+  option :out, default: 'html', banner: 'output_type', desc: 'html|html_pdf|tex|tex_pdf|md'
+  option :template, banner: 'template_path', desc: 'path to customized template (optional)'
+  option :locale, default: 'en', banner: 'locale', desc: 'en|es|pt|zh_cn'
+  option :theme, default: 'default', banner: 'theme', desc: 'default|classic'
+  option :dest_dir, default: 'current', banner: 'dest_dir', desc: 'location of dest. dir (optional)'
   def convert(json_input)
-		set_i18n(options[:locale])
+    assign_i18n(options[:locale])
     puts "Generating the #{options[:out]} type..."
-    dest = options[:dest_dir] == 'current'? Dir.pwd : options[:dest_dir]
+    dest = options[:dest_dir] == 'current' ? Dir.pwd : options[:dest_dir]
     begin
-      puts send('convert_to_'+options[:out], json_input, get_template(options), dest)
+      puts send('convert_to_' + options[:out], json_input, get_template(options), dest)
     rescue Encoding::InvalidByteSequenceError
       puts "ERROR: You need to 'export LC_CTYPE=en_US.UTF-8' ...".green
     end
   end
 
-  desc "sample", "Generates a sample json file in cwd"
-  def sample()
-    cwd = Dir.pwd 
-    json_file_paths = Dir["#{@@orig_locn}/../examples/*.json"]
-    json_file_names = json_file_paths.map{|x| File.basename(x)}
-    FileUtils.cp json_file_paths, Dir.pwd
-    msg = "Generated #{json_file_names.join(" ")} in #{cwd}/".green
+  desc 'sample', 'Generates a sample json file in cwd'
+  option :in, default: 'json', banner: 'input_type', desc: 'json|yaml'
+  def sample
+    cwd = Dir.pwd
+    file_names = []
+    if options[:in] == 'yaml'
+      file_names = convert_sample_to_yaml
+    else
+      json_file_paths = Dir["#{@@orig_locn}/../examples/*.json"]
+      file_names = json_file_paths.map { |x| File.basename(x) }
+      FileUtils.cp json_file_paths, cwd
+    end
+    msg = "Generated #{file_names.join(' ')} in #{cwd}/".green
     msg += "\nYou can now modify it and call: json_resume convert <file.json>"
     puts msg
   end
@@ -48,42 +60,54 @@ class JsonResumeCLI < Thor
   no_commands do
     @@orig_locn = File.expand_path(File.dirname(__FILE__))
 
+    def convert_sample_to_yaml
+      cwd = Dir.pwd
+      json_file_paths = Dir["#{@@orig_locn}/../examples/*.json"]
+      json_file_paths.map do |json_file_path|
+        dest = File.basename(json_file_path).gsub(/json$/, 'yaml')
+        yaml_string = (JSON.parse(File.read(json_file_path))).to_yaml
+        File.open("#{cwd}/#{dest}", 'w') { |f| f.write(yaml_string) }
+        dest
+      end
+    end
+
     def get_template(options)
-        return options[:template] if options[:template]
-        out_type = options[:out].split('_').first #html for both html, html_pdf
-        out_type = 'html' if out_type == 'pdf'
-        theme = options[:theme]
-        template_path = "#{@@orig_locn}/../templates/#{theme}_#{out_type}.mustache"
-        if !(File.exists? template_path) and theme != 'default'
-            puts "Theme #{theme} doesn't exist for #{options[:out]} type yet! Using default...".red
-            template_path = "#{@@orig_locn}/../templates/default_#{out_type}.mustache"
-        end
-        return template_path
+      return options[:template] if options[:template]
+      out_type = options[:out].split('_').first # html for both html, html_pdf
+      out_type = 'html' if out_type == 'pdf'
+      theme = options[:theme]
+      template_path = "#{@@orig_locn}/../templates/#{theme}_#{out_type}.mustache"
+      if !(File.exist? template_path) && theme != 'default'
+        puts "Theme #{theme} doesn't exist for #{options[:out]} type yet! Using default...".red
+        template_path = "#{@@orig_locn}/../templates/default_#{out_type}.mustache"
+      end
+      template_path
     end
 
-    def convert_to_html(json_input, template, dest=Dir.pwd, dir_name='resume')
-        dest_dir = "#{dest}/#{dir_name}"
-        FileUtils.mkdir_p dest_dir
-        FileUtils.cp_r(Dir["#{@@orig_locn}/../extras/resume_html/*"], dest_dir)
-        msg = generate_file(json_input, template, "html", "#{dest_dir}/page.html")
-        msg += "\nPlace #{dest_dir}/ in /var/www/ to host."
+    def convert_to_html(json_input, template, dest = Dir.pwd, dir_name = 'resume')
+      dest_dir = "#{dest}/#{dir_name}"
+      FileUtils.mkdir_p dest_dir
+      FileUtils.cp_r(Dir["#{@@orig_locn}/../extras/resume_html/*"], dest_dir)
+      msg = generate_file(json_input, template, 'html', "#{dest_dir}/page.html")
+      msg += "\nPlace #{dest_dir}/ in /var/www/ to host."
+      msg
     end
 
-    def convert_to_pdf(json_input, template, dest=Dir.pwd)
+    def convert_to_pdf(json_input, template, dest = Dir.pwd)
       puts "Defaulting to 'html_pdf'..."
       convert_to_html_pdf(json_input, template, dest)
     end
 
-    def convert_to_html_pdf(json_input, template, dest=Dir.pwd)
-      tmp_dir = ".tmp_resume"
+    def convert_to_html_pdf(json_input, template, dest = Dir.pwd)
+      tmp_dir = '.tmp_resume'
       convert_to_html(json_input, template, dest, tmp_dir)
       PDFKit.configure do |config|
         wkhtmltopdf_path = `which wkhtmltopdf`.to_s.strip
         config.wkhtmltopdf = wkhtmltopdf_path unless wkhtmltopdf_path.empty?
         config.default_options = {
-          :footer_right => "Page [page] of [toPage]    .\n",
-          :footer_font_size => 10,
-          :footer_font_name => "Georgia"
+          footer_right: "Page [page] of [toPage]    .\n",
+          footer_font_size: 10,
+          footer_font_name: 'Georgia'
         }
       end
       html_file = File.new("#{dest}/#{tmp_dir}/core-page.html")
@@ -91,88 +115,92 @@ class JsonResumeCLI < Thor
       File.open("#{dest}/#{tmp_dir}/public/css/mobile.css", 'w') {}
 
       pdf_options = {
-        :margin_top => 2.0,
-        :margin_left=> 0.0, 
-        :margin_right => 0.0,
-        :margin_bottom => 4.0,
-        :page_size => 'Letter'
+        margin_top: 2.0,
+        margin_left: 0.0,
+        margin_right: 0.0,
+        margin_bottom: 4.0,
+        page_size: 'Letter'
       }
       kit = PDFKit.new(html_file, pdf_options)
 
       begin
-        kit.to_file(dest+"/resume.pdf")
+        kit.to_file(dest + '/resume.pdf')
       rescue Errno::ENOENT => e
         puts "\nTry: sudo apt-get update; sudo apt-get install libxtst6 libfontconfig1".green
         raise e
       end
       FileUtils.rm_rf "#{dest}/#{tmp_dir}"
       msg = "\nGenerated resume.pdf at #{dest}.".green
+      msg
     end
 
-    def convert_to_tex(json_input, template, dest=Dir.pwd, filename="resume.tex")
-      generate_file(json_input, template, "latex", "#{dest}/#{filename}")
+    def convert_to_tex(json_input, template, dest = Dir.pwd, filename = 'resume.tex')
+      generate_file(json_input, template, 'latex', "#{dest}/#{filename}")
     end
 
-    def convert_to_tex_pdf(json_input, template, dest=Dir.pwd)
-      file1 = "resume"; filename = "#{file1}.tex"
+    def convert_to_tex_pdf(json_input, template, dest = Dir.pwd)
+      file1 = 'resume'
+      filename = "#{file1}.tex"
       convert_to_tex(json_input, template, dest, filename)
-      if `which pdflatex` == ""
-        puts "It looks like pdflatex is not installed...".red
-        puts "Either install it with instructions at..."
-        puts "http://dods.ipsl.jussieu.fr/fast/pdflatex_install.html"
+      if `which pdflatex` == ''
+        puts 'It looks like pdflatex is not installed...'.red
+        puts 'Either install it with instructions at...'
+        puts 'http://dods.ipsl.jussieu.fr/fast/pdflatex_install.html'
         return use_write_latex(dest, filename)
       end
-      if `kpsewhich moderncv.cls` == ""
-        puts "It looks liks moderncv package for tex is not installed".red
-        puts "Read about it here: http://ctan.org/pkg/moderncv"
+      if `kpsewhich moderncv.cls` == ''
+        puts 'It looks liks moderncv package for tex is not installed'.red
+        puts 'Read about it here: http://ctan.org/pkg/moderncv'
         return use_write_latex(dest, filename)
       end
       system("pdflatex -shell-escape -interaction=nonstopmode #{dest}/#{filename}")
-      [".tex",".out",".aux",".log"].each do |ext|
+      ['.tex', '.out', '.aux', '.log'].each do |ext|
         FileUtils.rm "#{dest}/#{file1}#{ext}"
       end
       msg = "\nPDF is ready at #{dest}/#{file1}.pdf"
+      msg
     end
 
     def use_write_latex(dest, filename)
-       reply = ask "Create PDF online using writeLatex ([y]n)?"
-       if reply == "" || reply == "y"
-          return convert_using_writeLatex(dest, filename)  
-       end
-       msg = "Latex file created at #{dest}/#{filename}".green
+      reply = ask 'Create PDF online using writeLatex/overleaf ([y]n)?'
+      if reply == '' || reply == 'y'
+        return convert_using_write_latex(dest, filename)
+      end
+      msg = "Latex file created at #{dest}/#{filename}".green
+      msg
     end
 
-    def convert_using_writeLatex(dest, filename)
+    def convert_using_write_latex(dest, filename)
       tex_file = File.read("#{dest}/#{filename}")
-      RestClient.post(WL_URL, :snip => tex_file, :splash => "none") do |response, req, res, &bb| 
+      msg = ''
+      RestClient.post(WL_URL, snip: tex_file, splash: 'none') do |response, _, _, &_|
         FileUtils.rm "#{dest}/#{filename}"
         msg = "\nPDF is ready at #{response.headers[:location]}".green
       end
+      msg
     end
 
-    def convert_to_md(json_input, template, dest=Dir.pwd)
-      generate_file(json_input, template, "markdown", "#{dest}/resume.md")
+    def convert_to_md(json_input, template, dest = Dir.pwd)
+      generate_file(json_input, template, 'markdown', "#{dest}/resume.md")
     end
 
-def set_i18n(locale)
-	I18n.load_path = Dir["#{@@orig_locn}/../locale/*.yml"]
-	I18n.enforce_available_locales = true
-	I18n.locale = options[:locale].to_sym
-end
+    def assign_i18n(locale)
+      I18n.load_path = Dir["#{@@orig_locn}/../locale/*.yml"]
+      I18n.enforce_available_locales = true
+      I18n.locale = locale.to_sym
+    end
 
-def i18n(text)
-	text.gsub(/##(\w*?)##/) { I18n.t! Regexp.last_match[1], :scope => 'headings' }
-end
+    def i18n(text)
+      text.gsub(/##(\w*?)##/) { I18n.t! Regexp.last_match[1], scope: 'headings' }
+    end
 
     def generate_file(json_input, template, output_type, dest)
-      resume_obj = JsonResume.new(json_input, "output_type" => output_type)
+      resume_obj = JsonResume.new(json_input, 'output_type' => output_type)
       mustache_obj  = Mustache.render(i18n(File.read(template)), resume_obj.reader.hash)
-      File.open(dest,'w') {|f| f.write(mustache_obj) }
-      return "\nGenerated files present at #{dest}".green
+      File.open(dest, 'w') { |f| f.write(mustache_obj) }
+      "\nGenerated files present at #{dest}".green
     end
-
   end
-
 end
 
 JsonResumeCLI.start(ARGV)

data/json_resume.gemspec

@@ -4,28 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_resume/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "json_resume"
+  spec.name          = 'json_resume'
   spec.version       = JsonResume::VERSION
-  spec.authors       = ["Prateek Agarwal"]
-  spec.email         = ["prat0318@gmail.com"]
-  spec.description   = %q{json_resume creates pretty resume formats from a .json input file. Currently, it can convert to html, tex, markdown and pdf. Customizing the templates to your own needs is also super easy.}
-  spec.summary       = %q{Generates pretty resume formats out of json input file}
-  spec.homepage      = "http://github.com/prat0318/json_resume"
-  spec.license       = "MIT"
+  spec.authors       = ['Prateek Agarwal']
+  spec.email         = ['prat0318@gmail.com']
+  spec.description   = 'json_resume creates pretty resume formats from a .json input file. Currently, it can convert to html, tex, markdown and pdf. Customizing the templates to your own needs is also super easy.'
+  spec.summary       = 'Generates pretty resume formats out of json input file'
+  spec.homepage      = 'http://github.com/prat0318/json_resume'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = ["json_resume"]
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = ['json_resume']
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-
-  spec.add_dependency "i18n"
-  spec.add_dependency "mustache"
-  spec.add_dependency "pdfkit"
-  spec.add_dependency "rest-client"
-  spec.add_dependency "thor"
-  spec.add_dependency "wkhtmltopdf-binary"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 
+  spec.add_dependency 'i18n'
+  spec.add_dependency 'mustache'
+  spec.add_dependency 'pdfkit'
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'wkhtmltopdf-binary'
 end