resme 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4b83addb2d49ccfb3361db0479f50f43d4df7a9582321d0a44e2593a62ced8c
-  data.tar.gz: 94b3872e6fcb0761568207338304e2e6e2c360f4657f519a808a3e87777d29e0
+  metadata.gz: fc8089fb6322bfe0ad1563829fc2561a2bdb764efe06915ff5a3778b765d24fd
+  data.tar.gz: 8a9555ec7df7bd51b12ff20fd826b5c2e75fd83f36f33fcb61163d17a324424e
 SHA512:
-  metadata.gz: 49e6883df829d23e6b775bc711e9cbf372317bf3deeaed5e6f13b4cd2b22cc3caecef2c08074e5a7fda6b6bb290e234d8f41dcb25b3a724425defbb64688d17b
-  data.tar.gz: '09089b1eb1a2c7078b20a2b076f19bedbbe7651467937cb8b104395c243a4461029e873c9a3b2d1c959fe811cd5093482cb3b02f6b1686cca42b3a743e5ff89c'
+  metadata.gz: 60d455fbb2943111933b3ace506bd01e2beb1a594dd0095098250b8ff010be69ab07b8233a9c7c96d635bc96c3ea8779a80280922f5b2db8ddcf4149651b0547
+  data.tar.gz: 16f09e4d698179c59a25acc5e6894bd6632a431dfd46d84516455142f5ddf149ced3ef0cc22cf12303f1659532e5cc340d1f513eb287e3db1787fcf19fb54790

data/CHANGELOG.org

@@ -1,6 +1,21 @@
 #+TITLE: CHANGELOG
 #+AUTHOR: Adolfo Villafiorita
 
+* Version 2.0.0
+
+- Fully rewritten code
+- Removed export to Markdown (which can be gotten from Org Mode)
+- Fixed JSON Resume export
+- Added new keys and renamed some existing keys to make them closer to JSON Resume.
+  - added url in education section
+  - added country_code and region to addresses
+  - renamed who -> name (in projects: stakeholder)
+  - renamed role -> position
+  - renamed from -> start_date
+  - renamed to -> end_date
+  - renamed website -> url
+
+    
 * Version 1.0.1
 
 - Documentation updated

data/CODE_OF_CONDUCT.org

@@ -0,0 +1,16 @@
+#+TITLE: Code of Conduct
+
+"resme" follows [[https://www.ruby-lang.org/en/conduct][The Ruby Community
+Conduct Guideline]] in all "collaborative space", which is defined as community
+communications channels (such as mailing lists, submitted patches, commit
+comments, etc.):
+
+- Participants will be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal
+  attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always
+  assume good intentions.
+- Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us
+at [[mailto:"adolfo@shair.tech"][adolfo@shair.tech]].

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Adolfo Villafiorita
+Copyright (c) 2026 Adolfo Villafiorita
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.org

@@ -3,20 +3,13 @@
 #+DATE: <2020-07-14 Tue>
 #+STARTUP: showall
 
-Keep your resume in YAML and output it in various formats, including
-Org Mode, Markdown, and JSON.
+Keep your resume in YAML and output it Org Mode and JSON Resume formats.
+Org Mode is flexible enough to export to various other formats.
 
 The rendering engine is based on ERB. This simplifies the creation of
 new output formats (and extending/modifying the YML structure to one's
 needs).
 
-#+BEGIN_QUOTE
-Support for the Europass XML format has been dropped in version 1.0.0, as the
-version generated by resme (Europass schema version 3.3.0) is no longer
-supported by the Europasss website and documentation about the changes to make
-it working again are kind of difficult to retrieve.
-#+END_QUOTE
-
 ** Installation
    :PROPERTIES:
    :CUSTOM_ID: installation
@@ -59,42 +52,31 @@ are not relevant for your resume.
 You can now generate a resume using one of the existing formats:
 
 #+begin_example sh
-  resme --to org resume.yml
+  resme --format org --build resume.yml
 #+end_example
 
-Supported formats include:
-
-- =org=: Org Mode format
-- =md=: Markdown format
-- =json=: JSON format (https://jsonresume.org/)
-
 If you are not satisfied with the provided templates, you can write your own
 (see below).
 
-Notice that you can specify more than one YML file in input. This allows you to
-store data about your resume in different files, if you like to do so (e.g.,
-work experiences could be in one file and talks in another).  The YML files are
-merged before processing them.
-
 Full syntax:
 
 #+begin_src sh :results raw output :wrap example
-resme help
+resme --help
 #+end_src
 
 #+RESULTS:
 #+begin_example
-resme command [options] [args]
-Available commands:
-  check resume.yml # Check syntax of resume.yml
-  list resume.yml # List main sections in resume.yml
-  version # print version information
-  view --template FORMAT # Print template used for format
-  generate [options] resume.yml ... # output resume
-  console # enter the console
-  man # print resme manual page
-  help [command] # print command usage
-  init [options] # generate an empty resume.yml file
+resme [options] - Format and manage a resume in YAML
+        --format FORMAT              Output format
+        --init                       Init a new resume
+        --validate FILENAME          Validate the resume
+        --build FILENAME             Build the resume in FILENAME
+        --sections FILENAME          List sections in FILENAME
+        --list                       List available templates
+        --except x,y,z               Excluded section
+        --cat TEMPLATE               View a template
+        --version
+    -h, --help                       Print this help
 #+end_example
 
 ** Checking validity
@@ -102,11 +84,11 @@ Available commands:
    :CUSTOM_ID: checking-validity
    :END:
 
-Use the =check= command to verify whether your YAML file conforms with
+Use the =--validate= option to verify whether your YAML file conforms with
 the intended syntax.
 
 #+begin_example sh
-  resme check resume.yaml
+  resme --validate resume.yaml
 #+end_example
 
 ** Dates in the resume
@@ -124,79 +106,6 @@ Enter dates in the resume in one of the following formats:
 The third and the forth format allows you to enter "partial" dates
 (e.g., when the month or the day have been forgotten or are irrelevant).
 
-** Creating your own templates
-   :PROPERTIES:
-   :CUSTOM_ID: creating-your-own-templates
-   :END:
-
-The resumes are generated from the YML matter using ERB templates. The
-provided output formats should support different back ends.  Org Mode
-and Markdown, for instance, easily allow for generation of PDFs, HTML,
-and ODT, to mention a few.
-
-However, if you want, you can define your own templates.
-
-Use the command =view= to print one of the templates used by =resme=
-and build from that.
-
-#+begin_example sh
-  resme view --template md
-#+end_example
-
-Notice that all the data in the resume is made available in the =data=
-variable.  Thus, for instance, the following code snippets generates a
-list of all the work experiences:
-
-#+begin_example xml
-  <% data["work"] each do |exp| %>
-  - <%= exp["who"] %>
-    From: <%=  exp["from"] %> till: <%= exp["till"] %>
-  <% end %>
-#+end_example
-
-To specify your own ERB template to build your resume use the option
-=-e= (=--erb=). Thus, for instance:
-
-#+begin_example sh
-  resme render -e template.md.erb [-o output_filename] file.yaml ...
-#+end_example
-
-uses =template.md.erb= to generate the resume.
-
-Some functions can be used in the templates to better control the
-output.
-
-String manipulation functions:
-
-- =clean string= removes any space at the beginning of =string=
-- =reflow string, n= makes =string= into an array of strings of length
-  lower or equal to =n= (useful if you are outputting a textual format,
-  for instance.
-
-Dates manipulation functions:
-
-- =period= generates a string recapping a period. The function abstracts
-  different syntax you can use for entries (i.e., =date= or =from= and
-  =till=) and different values for the entries (e.g., a missing value
-  for =till=)
-- =year string=, =month string=, =day string= return, respectively the
-  year, month and day from strings in the format =YYYY-MM-DD=s
-- =has_month input= returns true if =input= has a month, that is, it is
-  a date or it is in the form =YYYY-MM=
-- =has_day input= returns true if =input= has a day, that is, it is a
-  date or it is in the form =YYYY-MM-DD=
-
-You can find the templates in =lib/resme/templates=. These might be good
-starting points if you want to develop your own.
-
-** Contributing your templates
-   :PROPERTIES:
-   :CUSTOM_ID: contributing-your-templates
-   :END:
-
-If you develop an output template and want to make it available, please
-let me know, so that I can include it in future releases of this gem.
-
 ** Development
    :PROPERTIES:
    :CUSTOM_ID: development
@@ -225,35 +134,16 @@ https://github.com/avillafiorita/resme.
    :CUSTOM_ID: license
    :END:
 
-The gem is available as open source under the terms of the [[http://opensource.org/licenses/MIT][MIT License]].
+The gem is available as open source under the terms of the [[http://opensource.org/licenses/MIT.txt][MIT License]].
 
 ** Change Log
 
 In [[file:./CHANGELOG.org][CHANGELOG.org]]
 
-** Roadmap
-   :PROPERTIES:
-   :CUSTOM_ID: roadmap
-   :END:
-
-In [[file:./doc/todo.org][todo.org]] ... guess what is my preferred editor!
-
 ** Bugs
    :PROPERTIES:
    :CUSTOM_ID: bugs
    :END:
 
-There are still slight differences in the syntax of entries and in the
-way in which the information is formatted in various output formats.
-
-*Entries are not sorted by date before outputting them. Make sure you
-put them in the order you want them to appear in your resume.*
-
-Unknown number of unknown bugs.
-
-** Release History
-   :PROPERTIES:
-   :CUSTOM_ID: release-history
-   :END:
+An unknown number of unknown bugs.
 
-   Moved to [[file:./CHANGELOG.org][CHANGELOG.org]].

data/Rakefile

@@ -1,2 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/TAGS

@@ -0,0 +1,83 @@
+
+/home/adolfo/Sources/ruby/resme/lib/resme/document.rb,292
+module ResmeResme
3,31
+  class DocumentDocument
7,88
+    attr_reader :filename, :datafilename
8,105
+    attr_reader :filename, :datadata
8,105
+    def initialize(filename)initialize
10,139
+    def dig(*keys)dig
16,292
+    def fetch(*keys, default)fetch
21,422
+    def loadload
27,502
+
+/home/adolfo/Sources/ruby/resme/test/test_helper.rb,0
+
+/home/adolfo/Sources/ruby/resme/test/test_resme.rb,200
+class TestResme < Minitest::TestTestResme
5,54
+  def test_that_it_has_a_version_numbertest_that_it_has_a_version_number
6,87
+  def test_it_does_something_usefultest_it_does_something_useful
10,166
+
+/home/adolfo/Sources/ruby/resme/templates/org.erb,0
+
+/home/adolfo/Sources/ruby/resme/lib/resme.rb,0
+
+/home/adolfo/Sources/ruby/resme/templates/json.erb,0
+
+/home/adolfo/Sources/ruby/resme/lib/resme/document_validator.rb,421
+module ResmeResme
3,31
+  class DocumentValidatorDocumentValidator
7,76
+    def initialize(document)initialize
8,102
+    def validatevalidate
12,167
+    OPTIONAL_STRING = [:optional, String, NilClass]OPTIONAL_STRING
32,626
+    OPTIONAL_PARTIAL_DATE = [:optional, Date, String, Integer, NilClass]OPTIONAL_PARTIAL_DATE
33,678
+    PARTIAL_DATE = [Date, String, Integer]PARTIAL_DATE
34,751
+    SCHEMA = {SCHEMA
40,891
+
+/home/adolfo/Sources/ruby/resme/lib/resme/helper.rb,990
+module ResmeResme
3,31
+  module HelperHelper
7,87
+    def clean(string)clean
9,178
+    def full_name(data)full_name
13,250
+    def reflow_a(string, line_break: 78)reflow_a
33,855
+    def blank?(char)blank?
68,2023
+    def reflow_s(string, line_break: 75, delimiter: "\n", indent: 3)reflow_s
75,2256
+    def period(entry, date: :date, from: :start_date, to: :end_date, separator: "--")period
100,3229
+    def itemize(entry, header: %i[role who address], summary_key: :summary)itemize
125,3984
+    def propertify(entry, except: %i[summary details], indent: 3)propertify
136,4430
+    def select(contacts, label: :email)select
146,4731
+    def format_date(date, format: "%Y-%m-%d")format_date
162,5262
+    def complete_date(incomplete_date, format: "%Y-%m-%d")complete_date
166,5376
+    def year(input)year
181,5784
+    def month(input)month
186,5902
+    def day(input)day
191,6019
+    def y?(input)y?
196,6161
+    def ym?(input)ym?
201,6280
+    def ymd?(input)ymd?
206,6398
+
+/home/adolfo/Sources/ruby/resme/lib/resme/json_resume.rb,196
+module ResmeResme
3,31
+  class JsonResumeJsonResume
7,78
+    def initialize(document)initialize
10,121
+    def buildbuild
15,214
+    def split_highlights(highlights)split_highlights
150,4552
+
+/home/adolfo/Sources/ruby/resme/lib/resme/version.rb,57
+module ResmeResme
3,31
+  VERSION = "2.0.0"VERSION
4,44
+
+/home/adolfo/Sources/ruby/resme/lib/resme/cli.rb,218
+module ResmeResme
3,31
+  class CliCli
7,75
+    attr_reader :optionsoptions
8,87
+    def initialize(arguments)initialize
10,113
+    def parseparse
15,257
+    def commandcommand
20,332
+    def parserparser
26,391
+
+/home/adolfo/Sources/ruby/resme/lib/resme/executor.rb,294
+module ResmeResme
3,31
+  class ExecutorExecutor
4,44
+    def initialize(input)initialize
8,124
+    def executeexecute
14,234
+    def output_filename(format)output_filename
76,2176
+    def backup(filename)backup
80,2264
+    def backup_and_write(filename, content)backup_and_write
85,2405

data/exe/resme

@@ -2,5 +2,5 @@
 
 require "resme"
 
-# read-eval-print-step passing all commands and the argument
-Resme::CommandSemantics.execute Resme::CommandSyntax.commands, ARGV
+e = Resme::Executor.new(ARGV)
+e.execute

data/lib/resme/cli.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Resme
+  #
+  # Parse command line
+  #
+  class Cli
+    attr_reader :options
+
+    def initialize(arguments)
+      # no arguments is equivalent to --help
+      @arguments = arguments == [] ? ["--help"] : arguments
+    end
+
+    def parse
+      @options = {}
+      parser.parse!(@arguments)
+    end
+
+    def command
+      @options[:cmd]
+    end
+
+    private
+
+    def parser
+      OptionParser.new do |parser|
+        parser.banner = "resme [options] - Format and manage a resume in YAML"
+
+        # parser.on("-o", "--output FILENAME", String, "Output filename") do |v|
+        #   @options[:output] = v
+        # end
+
+        parser.on("--format FORMAT", String, "Output format") do |v|
+          @options[:format] = v
+        end
+
+        parser.on("--init", "Init a new resume") do |v|
+          @options[:cmd] = :init
+        end
+
+        parser.on("--validate FILENAME", "Validate the resume") do |v|
+          @options[:cmd] = :validate
+          @options[:filename] = v
+        end
+
+        parser.on("--build FILENAME", "Build the resume in FILENAME") do |v|
+          @options[:cmd] = :build
+          @options[:filename] = v
+        end
+
+        parser.on("--sections FILENAME", "List sections in FILENAME") do |v|
+          @options[:cmd] = :sections
+          @options[:filename] = v
+        end
+
+        parser.on("--list", "List available templates") do |v|
+          @options[:cmd] = :list
+        end
+
+        parser.on("--except x,y,z", Array, "Excluded section") do |v|
+          @options[:except] = v.map { |x| x.to_sym }
+        end
+
+        parser.on("--cat TEMPLATE", "View a template") do |v|
+          @options[:cmd] = :cat
+          @options[:template] = v
+        end
+
+        parser.on("--version") do |_|
+          @options[:cmd] = :version
+        end
+
+        parser.on("-h", "--help", "Print this help") do
+          puts parser
+        end
+      end
+    end
+  end
+end

data/lib/resme/document.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Resme
+  #
+  # Wrap the YAML data into a class
+  #
+  class Document
+    attr_reader :filename, :data
+
+    def initialize(filename)
+      @filename = filename
+      @data = load
+    end
+
+    # Access values references by *keys. Keys are Symbols or Strings
+    def dig(*keys)
+      @data.dig keys.map { |x| x.to_s }
+    end
+
+    # Access values references by *keys. Default to "default"
+    def fetch(*keys, default)
+      dig(*keys) || default
+    end
+
+    private
+
+    def load
+      begin
+        YAML.load_file @filename, permitted_classes: [Date], symbolize_names: true
+      rescue Psych::SyntaxError => ex
+        puts "#{@filename} has an invalid structure."
+        puts ex.message
+        exit 1
+      end
+    end
+  end
+end