condom 1.0.1 → 2.0.0

data/CHANGELOG.rdoc

@@ -1,11 +1,21 @@
+== 2.0.0
+
+* Added the BEER-WARE license.
+* Added a CV class.
+* Renamed 'flyleaf.tex' into 'first-page.tex'.
+* Renamed the 'Document' class into 'Classic'.
+* The executable now:
+  * understands 'article', 'report' and 'book' instead of 'document' type;
+  * prompts for type confirmation only when it is not already defined by the user.
+
 == 1.0.1
 
 * Added fixes for 1.9.* Ruby versions:
-  * Added a workaround for instance_variables method (see set_options in base.rb)
-  * Used RUBY_PLATFORM instead of PLATFORM (removed in 1.9.1)
-* Renamed main.tex.erb to document.tex.erb
-* Renamed lst-conf.tex.erb to listings.tex.erb
-* Cleaned generated LaTeX code indentation
+  * added a workaround for instance_variables method (see set_options in base.rb);
+  * used RUBY_PLATFORM instead of PLATFORM (removed in 1.9.1).
+* Renamed main.tex.erb to document.tex.erb.
+* Renamed lst-conf.tex.erb to listings.tex.erb.
+* Cleaned generated LaTeX code indentation.
 
 == 1.0.0
 

data/LICENSE

@@ -0,0 +1,6 @@
+-------------------------------------------------------------------------------
+ "THE BEER-WARE LICENSE" (Revision 42):
+ <vivien.didelot@gmail.com> wrote this gem. As long as you retain this notice
+ you can do whatever you want with this stuff. If we meet some day, and you
+ think this stuff is worth it, you can buy me a beer in return. Vivien Didelot
+-------------------------------------------------------------------------------

data/README.rdoc

@@ -12,9 +12,10 @@ The compilation, cleanup and interaction with the sources
 are facilitated by the usage of a Makefile (see the Usage section below).
 
 The document types supported for the moment are:
-* Any classic type (article, report, book, ...)
-* Presentation (i.e. a beamer document)
-* Letter
+* any classic type (article, report, book, ...);
+* presentation (i.e. a beamer document);
+* letter;
+* Curriculum Vitae (i.e. a moderncv document).
 
 == Installation
 
@@ -22,22 +23,25 @@ Condom is available on Rubygems.org[http://rubygems.org/gems/condom] and can be
 
   $ gem install condom
 
-This command needs Rubygems (rubygems package on Ubuntu).
+This command needs Rubygems ('rubygems' package on Ubuntu).
 
 == Usage
 
-=== Executable
+=== The condom executable
 
 Condom gem provides a 'condom' shell command.
 
   $ condom --help
   Usage: condom [type] [options]
-
+  
   Available types:
-      document                         'article', 'report' or other classes
-      presentation                     'beamer' class
-      letter                           'letter' class
-
+      article (default)                i.e. the 'article' class
+      report                           i.e. the 'report' class
+      book                             i.e. the 'book' class
+      presentation                     i.e. the 'beamer' class
+      letter                           i.e. the 'letter' class
+      cv                               i.e. the 'moderncv' class
+  
   Available options:
       -n, --filename=FILENAME          Define a file name
       -a, --author=AUTHOR              Define the author
@@ -50,11 +54,14 @@ Condom gem provides a 'condom' shell command.
       -q, --quiet                      Don't ask any question
       -v, --version                    Print Condom version
 
+The type is just a shortcut (and maybe an alias) to define the LaTeX document class and choose the corresponding Condom class.
+The options are options common to every Condom classes. Specific options (such as "recipient" for the letter) will be prompt if --quiet option is not given.
+
 For example, you can easily generate a set of files for a presentation in a folder named 'My Presentation' using:
 
   condom presentation -o "My Presentation"
 
-Unless the --quiet option is used, every options will be prompted for confirmation until the validation of the user (the type will be prompted just one time).
+Unless the --quiet option is used, every options will be prompted for confirmation until the validation of the user (the type will be prompted just one time, if it is not already defined).
 
 In generated files, there is a Makefile (see the Technique section below for more information about the file organization).
 Just use your document (from the source folder) with the following commands.
@@ -68,14 +75,14 @@ clean sources (remove .out, .toc, etc. files) with:
 archive the whole document with:
   $ make archive
 
-=== Lib
+=== The Condom lib
 
 You can use the lib to create your document (e.g. using IRB).
 Here's a quick overview of its operation.
 
-Create a document with:
+Create a document (article, report or book) with:
 
-  doc = Condom::Document.new
+  doc = Condom::Classic.new
 
 or a presentation with:
 
@@ -85,13 +92,17 @@ or a letter with:
 
   doc = Condom::Letter.new
 
+or a Resumé with:
+
+  doc = Condom::CV.new
+
 All constructors of these classes will use default values, but also accept:
 * no argument
 * a String: will be the title of the document
 * a Hash of options. Keys of the options hash should be symbols with the same name than the attributes of the class.
 i.e.:
 
-  doc = Condom::Document.new(:document_class => "report", :math => true, :directory => "here")
+  doc = Condom::Classic.new(:document_class => "report", :math => true, :directory => "here")
 
 You can get all options with:
 
@@ -111,7 +122,7 @@ This method will generate all files in the output directory.
 == Technique
 
 The following command:
-  $ condom document -t "Condom makes LaTeX easier" -o here
+  $ condom report -t "Condom makes LaTeX easier" -o here
 
 may result the creation of these folders/files:
   $ tree here/
@@ -121,6 +132,7 @@ may result the creation of these folders/files:
   ├── inc
   │   ├── colors.tex
   │   ├── commands.tex
+  │   ├── first-page.tex
   │   ├── listings.tex
   │   └── packages.tex
   ├── main.tex
@@ -134,6 +146,7 @@ This is the folder where you should put your images.
 This folder has all configuration tex files:
 * colors.tex - customized colors
 * commands.tex - customized commands
+* first-page.tex - customized first-page (only for reports)
 * listings.tex - configuration file for the listings package
 * packages - all needed packages
 

data/bin/condom

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 # Command line tool for Condom
 #
 # Author:: Vivien 'v0n' Didelot <vivien.didelot@gmail.com>
@@ -7,15 +9,19 @@ require 'condom'
 require 'optparse'
 
 quiet = false
-types = ['document', 'presentation', 'letter']
+classic_classes = ['article', 'report', 'book']
+types = ['presentation', 'letter', 'cv'].unshift(classic_classes).flatten
 ops = {:other_packages => []}
 
 ARGV.options do |o|
   o.banner = "Usage: #{File.basename $0} [type] [options]\n"
   o.on_head("\nAvailable types:",
-    "    document                         'article', 'report' or other classes",
-    "    presentation                     'beamer' class",
-    "    letter                           'letter' class",
+    "    article (default)                i.e. the 'article' class",
+    "    report                           i.e. the 'report' class",
+    "    book                             i.e. the 'book' class",
+    "    presentation                     i.e. the 'beamer' class",
+    "    letter                           i.e. the 'letter' class",
+    "    cv                               i.e. the 'moderncv' class",
     "\nAvailable options:")
   o.on("-n", "--filename=FILENAME",    String, "Define a file name")          { |v| ops[:filename] = v }
   o.on("-a", "--author=AUTHOR",        String, "Define the author")           { |v| ops[:author] = v }
@@ -31,42 +37,65 @@ end
 
 begin
   ARGV.options.parse!
-  raise "Bad syntax. Try \`#{File.basename $0} --help' for more information." if ARGV.length > 1
+  error_msg = "Bad syntax. Try \`#{File.basename $0} --help' for more information."
+  raise error_msg if ARGV.length > 1
+
+  is_doc_class_explicitly_set = true # We first supposed a type is defined by user
 
-  if ARGV.size == 1
-    doc = case ARGV.first
-          when 'document' then Condom::Document.new
+  if ARGV.length == 1
+    type = ARGV.first
+    if classic_classes.include? type
+      ops[:document_class] = type
+      type = "classic"
+    end
+    doc = case type
+          when 'classic' then Condom::Classic.new
           when 'presentation' then Condom::Presentation.new
           when 'letter' then Condom::Letter.new
-          else raise "Bad syntax. Try \`#{File.basename $0} --help' for more information."
+          when 'cv' then Condom::CV.new
+          else raise error_msg
           end
   elsif ops.has_key? :document_class
     doc = case ops[:document_class]
           when 'beamer' then Condom::Presentation.new
           when 'letter' then Condom::Letter.new
-          else Condom::Document.new
+          when 'moderncv' then Condom::CV.new
+          else Condom::Classic.new
           end
   else
-    doc = Condom::Document.new
+    is_doc_class_explicitly_set = false
+    doc = Condom::Classic.new
   end
 
   doc.set_options(ops)
 
   unless quiet
     # Ask for confirmation
+    format = "    %-17s [%s]: " # Question format
     puts "Enter the new value, or press ENTER for the default"
-
-    doc_type = doc.class.to_s.split('::').last.downcase
-    printf "    %-17s [%s]: ", "type", doc_type
-    type = STDIN.gets.strip
-    doc = case type
-          when 'document' then Condom::Document.new(ops)
-          when 'presentation' then Condom::Presentation.new(ops)
-          when 'letter' then Condom::Letter.new(ops)
-          else raise "Bad syntax. Try \`#{File.basename $0} --help' for more information."
-          end unless type.empty? || type == doc_type
     puts
 
+    unless is_doc_class_explicitly_set
+      puts "The type can be #{types.map { |t| "'#{t}'" }.join ', '}."
+
+      doc_type = doc.class.to_s.split('::').last.downcase
+      doc_type = doc.document_class if doc_type == "classic"
+      printf format, "type", doc_type
+      type = STDIN.gets.strip
+      if classic_classes.include? type
+        ops[:document_class] = type
+        type = "classic"
+      end
+      doc = case type
+            when 'classic' then Condom::Classic.new(ops)
+            when 'presentation' then Condom::Presentation.new(ops)
+            when 'letter' then Condom::Letter.new(ops)
+            when 'cv' then Condom::CV.new(ops)
+            else raise error_msg
+            end unless type.empty?
+      puts
+    end
+
     loop do
       ops = Hash.new
       doc.get_options.each do |key, value|
@@ -76,7 +105,7 @@ begin
                           when Array then value.join(', ')
                           else value
                           end
-        printf "    %-17s [%s]: ", key, displayed_value
+        printf format, key, displayed_value
         new_value = STDIN.gets.strip
         ops[key] = if value.is_a?(FalseClass) && new_value == "yes" then true
                    elsif value.is_a?(TrueClass) && new_value == "no" then false

data/lib/condom.rb

@@ -4,15 +4,16 @@
 # See:: http://github.com/v0n/condom
 
 require "condom/base"
-require "condom/letter"
-require "condom/document"
+require "condom/classic"
 require "condom/presentation"
+require "condom/letter"
+require "condom/cv"
 
 require "etc"
 
 module Condom
   # Lib version
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
   # Constant views directory
   VIEWS_DIR = File.join(File.expand_path(File.dirname(__FILE__)), 'views')

data/lib/condom/base.rb

@@ -1,8 +1,6 @@
 require "fileutils"
 require "erb"
 
-#TODO Split author with space to get firstname and lastname?
-
 # The Condom module
 module Condom
   # The Base class.

data/lib/condom/{document.rb → classic.rb}

@@ -1,8 +1,8 @@
 # The Condom module
 module Condom
-  # The Document class.
-  # This class is used to produce classic document such as article, report, etc.
-  class Document < Condom::Base
+  # The Classic class.
+  # This class is used to produce a classic document such as an article, a report or a book.
+  class Classic < Condom::Base
     attr_accessor :listings, :fancyhdr, :graphics, :math, :pdf
 
       # The constructor.
@@ -37,8 +37,8 @@ module Condom
     def create
       in_directory do
         # Create files
-        build "document.tex"
-        File.rename("document.tex", "main.tex")
+        build "classic.tex"
+        File.rename("classic.tex", "main.tex")
         build "Makefile"
         if @graphics
           build "fig.tex"
@@ -51,7 +51,7 @@ module Condom
           build "commands.tex"
           build "colors.tex"
           build "listings.tex" if @listings
-          build "flyleaf.tex" if @document_class == "report"
+          build "first-page.tex" if @document_class == "report"
         end
       end
     end

data/lib/condom/cv.rb

@@ -0,0 +1,46 @@
+# The Condom module
+module Condom
+  # The CV class.
+  # This class is used to produce a résumé.
+  class CV < Condom::Base
+    attr_accessor :theme, :color
+
+      # The constructor.
+      # Argument could be:
+      # * nothing,
+      # * the title of the document,
+      # * a hash of options.
+      def initialize(args = nil)
+        # Need to initialize each variables else they won't exist in instance_variables.
+        @theme = @color = nil
+
+        # The default options
+        options = {
+          :document_class => 'moderncv',
+          :title          => 'Curriculum Vitae',
+          :filename       => 'cv',
+          :theme          => 'classic',
+          :color          => 'grey'
+        }
+
+        if args.is_a? String
+          options[:title] = args
+        elsif args.is_a? Hash
+          options.merge! args
+        end
+
+        super(options)
+      end
+
+    # This method will write in the output directory all needed files.
+    def create
+      in_directory do
+        # Create files
+        build "cv.tex"
+        File.rename("cv.tex", "main.tex")
+        build "Makefile"
+      end
+    end
+  end
+end
+

data/lib/condom/presentation.rb

@@ -51,7 +51,6 @@ module Condom
           build "commands.tex"
           build "colors.tex"
           build "listings.tex" if @listings
-          build "flyleaf.tex" if @document_class == "report"
         end
       end
     end

data/lib/views/{document.tex.erb → classic.tex.erb}

@@ -28,7 +28,7 @@
 \title{<%= @title %>}
 
 <% if @document_class == "report" %>
-%\input{inc/flyleaf.tex} % page de garde personnalisee
+%\input{inc/first-page.tex} % page de garde personnalisee
 %\location{}
 %\blurb{}
 <% end %>

data/lib/views/cv.tex.erb

@@ -0,0 +1,135 @@
+% LaTeX CV skeleton
+% generated on <%= Time.now %>
+% by <%= @author %>
+% With the Condom lib (version <%= Condom::VERSION %>)
+% See http://github.com/v0n/condom
+
+%% Copyright 2006-2010 Xavier Danaux (xdanaux@gmail.com).
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License version 1.3c,
+% available at http://www.latex-project.org/lppl/.
+%
+% See http://www.ctan.org/tex-archive/macros/latex/contrib/moderncv/examples/
+% for the full template with publications.bib file and everything.
+
+\documentclass[11pt,a4paper]{moderncv}
+
+% moderncv themes
+\moderncvtheme[<%= @color %>]{<%= @theme %>}                 % optional argument are 'blue' (default), 'orange', 'red', 'green', 'grey' and 'roman' (for roman fonts, instead of sans serif fonts)
+%\moderncvtheme[green]{classic}                % idem. Theme can be 'classic' or 'casual'
+
+% character encoding
+\usepackage[<%= (RUBY_PLATFORM.include? 'linux') ? 'utf8' : 'latin1' %>]{inputenc}                   % replace by the encoding you are using
+
+% adjust the page margins
+\usepackage[scale=0.8]{geometry}
+%\setlength{\hintscolumnwidth}{3cm}                     % if you want to change the width of the column with the dates
+%\AtBeginDocument{\setlength{\maketitlenamewidth}{6cm}}  % only for the classic theme, if you want to change the width of your name placeholder (to leave more space for your address details
+%\AtBeginDocument{\recomputelengths}                     % required when changes are made to page layout lengths
+
+% personal data
+\firstname{<%= @author.split[0] %>}
+\familyname{<%= @author.split[1..-1].join(' ') %>}
+\title{<%= @title %>}               % optional, remove the line if not wanted
+\address{street and number}{postcode city}    % optional, remove the line if not wanted
+\mobile{mobile (optional)}                    % optional, remove the line if not wanted
+\phone{phone (optional)}                      % optional, remove the line if not wanted
+\fax{fax (optional)}                          % optional, remove the line if not wanted
+\email{email (optional)}                      % optional, remove the line if not wanted
+%\homepage{homepage (optional)}                % optional, remove the line if not wanted
+\extrainfo{additional information (optional)} % optional, remove the line if not wanted
+%\photo[64pt]{picture}                         % '64pt' is the height the picture must be resized to and 'picture' is the name of the picture file; optional, remove the line if not wanted
+\quote{Some quote (optional)}                 % optional, remove the line if not wanted
+
+% to show numerical labels in the bibliography; only useful if you make citations in your resume
+%\makeatletter
+%\renewcommand*{\bibliographyitemlabel}{\@biblabel{\arabic{enumiv}}}
+%\makeatother
+
+% bibliography with mutiple entries
+%\usepackage{multibib}
+%\newcites{book,misc}{{Books},{Others}}
+
+%\nopagenumbers{}                             % uncomment to suppress automatic page numbering for CVs longer than one page
+%----------------------------------------------------------------------------------
+%            content
+%----------------------------------------------------------------------------------
+\begin{document}
+\maketitle
+
+\section{Education}
+\cventry{year--year}{Degree}{Institution}{City}{\textit{Grade}}{Description}  % arguments 3 to 6 can be left empty
+\cventry{year--year}{Degree}{Institution}{City}{\textit{Grade}}{Description}
+
+\section{Master thesis}
+\cvline{title}{\emph{Title}}
+\cvline{supervisors}{Supervisors}
+\cvline{description}{\small Short thesis abstract}
+
+\section{Experience}
+\subsection{Vocational}
+\cventry{year--year}{Job title}{Employer}{City}{}{General description no longer than 1--2 lines.\newline{}%
+Detailed achievements:%
+\begin{itemize}%
+\item Achievement 1;
+\item Achievement 2, with sub-achievements:
+  \begin{itemize}%
+  \item Sub-achievement (a);
+  \item Sub-achievement (b), with sub-sub-achievements (don't do this!);
+    \begin{itemize}
+    \item Sub-sub-achievement i;
+    \item Sub-sub-achievement ii;
+    \item Sub-sub-achievement iii;
+    \end{itemize}
+  \item Sub-achievement (c);
+  \end{itemize}
+\item Achievement 3.
+\end{itemize}}
+\cventry{year--year}{Job title}{Employer}{City}{}{Description line 1\newline{}Description line 2}
+\subsection{Miscellaneous}
+\cventry{year--year}{Job title}{Employer}{City}{}{Description}
+
+\section{Languages}
+\cvlanguage{Language 1}{Skill level}{Comment}
+\cvlanguage{Language 2}{Skill level}{Comment}
+\cvlanguage{Language 3}{Skill level}{Comment}
+
+\section{Computer skills}
+\cvcomputer{category 1}{XXX, YYY, ZZZ}{category 4}{XXX, YYY, ZZZ}
+\cvcomputer{category 2}{XXX, YYY, ZZZ}{category 5}{XXX, YYY, ZZZ}
+\cvcomputer{category 3}{XXX, YYY, ZZZ}{category 6}{XXX, YYY, ZZZ}
+
+\section{Interests}
+\cvline{hobby 1}{\small Description}
+\cvline{hobby 2}{\small Description}
+\cvline{hobby 3}{\small Description}
+
+\section{Extra 1}
+\cvlistitem{Item 1}
+\cvlistitem{Item 2}
+\cvlistitem[+]{Item 3}            % optional other symbol
+
+\renewcommand{\listitemsymbol}{-} % change the symbol for lists
+
+\section{Extra 2}
+\cvlistdoubleitem{Item 1}{Item 4}
+%\cvlistdoubleitem{Item 2}{Item 5 \cite{book1}}
+\cvlistdoubleitem{Item 3}{}
+
+% Publications from a BibTeX file without multibib\renewcommand*{\bibliographyitemlabel}{\@biblabel{\arabic{enumiv}}}% for BibTeX numerical labels
+%\nocite{*}
+%\bibliographystyle{plain}
+%\bibliography{publications}       % 'publications' is the name of a BibTeX file
+
+% Publications from a BibTeX file using the multibib package
+%\section{Publications}
+%\nocitebook{book1,book2}
+%\bibliographystylebook{plain}
+%\bibliographybook{publications}   % 'publications' is the name of a BibTeX file
+%\nocitemisc{misc1,misc2,misc3}
+%\bibliographystylemisc{plain}
+%\bibliographymisc{publications}   % 'publications' is the name of a BibTeX file
+
+\end{document}
+

data/lib/views/fig.tex.erb

@@ -4,6 +4,8 @@
 % With the Condom lib (version <%= Condom::VERSION %>)
 % See http://github.com/v0n/condom
 
+% This file is useless, it's just a note about images manipulation with LaTeX.
+
 % [!h] est facultatif, ca permet d'indiquer la position de la figure (si possible !)
 % ! = forcer la position
 % h = here

data/lib/views/{flyleaf.tex.erb → first-page.tex.erb}

@@ -1,4 +1,4 @@
-% Custom flyleaf for reports
+% Custom first-page for reports
 % generated on <%= Time.now %>
 % by <%= @author %>
 % With the Condom lib (version <%= Condom::VERSION %>)

metadata

@@ -3,10 +3,10 @@ name: condom
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 1
+  - 2
   - 0
-  - 1
-  version: 1.0.1
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Vivien Didelot
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 +10:00
+date: 2010-12-10 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -27,23 +27,26 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/views/flyleaf.tex.erb
-- lib/views/document.tex.erb
-- lib/views/presentation.tex.erb
-- lib/views/packages.tex.erb
-- lib/views/listings.tex.erb
-- lib/views/fig.tex.erb
-- lib/views/letter.tex.erb
+- lib/condom.rb
+- lib/condom/presentation.rb
+- lib/condom/cv.rb
+- lib/condom/letter.rb
+- lib/condom/classic.rb
+- lib/condom/base.rb
 - lib/views/colors.tex.erb
 - lib/views/Makefile.erb
 - lib/views/commands.tex.erb
-- lib/condom/base.rb
-- lib/condom/document.rb
-- lib/condom/letter.rb
-- lib/condom/presentation.rb
-- lib/condom.rb
+- lib/views/listings.tex.erb
+- lib/views/fig.tex.erb
+- lib/views/packages.tex.erb
+- lib/views/letter.tex.erb
+- lib/views/presentation.tex.erb
+- lib/views/classic.tex.erb
+- lib/views/first-page.tex.erb
+- lib/views/cv.tex.erb
 - README.rdoc
 - CHANGELOG.rdoc
+- LICENSE
 - bin/condom
 has_rdoc: true
 homepage: