condom 0.2.0 → 1.0.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 1.0.0
+
+* Rewrote the executable, it is now simpler and allow user to change every fields (see the README).
+* Renamed 'outputdir' attribute to 'directory'.
+* Changed syntax according to 1.9.* Ruby versions (e.g. ':' in case), **but still doesn't work on 1.9.* Ruby versions!**
+
 == 0.2.0
 
 * Changed files organisation: specific documents now extend a Base class.

data/README.rdoc

@@ -28,29 +28,36 @@ This command needs Rubygems (rubygems package on Ubuntu).
 
 === Executable
 
-Condom gem provides a condom shell command.
+Condom gem provides a 'condom' shell command.
 
   $ condom --help
-  Usage: condom [options] [destination]
+  Usage: condom [type] [options]
+
+  Available types:
+      document                         'article', 'report' or other classes
+      presentation                     'beamer' class
+      letter                           'letter' class
 
   Available options:
-      -m, --math                       Math packages
-      -l, --listings                   Listings package
-      -f, --fancyhdr                   Fancyhdr package
-      -p, --pdf                        PDF config
-      -g, --graphics                   Images packages
       -n, --filename=FILENAME          Define a file name
       -a, --author=AUTHOR              Define the author
       -t, --title=TITLE                Define the title
       -d, --date=DATE                  Define the date
-      -c, --class=CLASS                Define the document class
-                                       "beamer" for a presentation, "letter" for a letter
-      -L, --language=LANGUAGE          Define the language
-      -P, --package=PACKAGE            Add another package
+      -c, --document-class=CLASS       Define the document class
+      -l, --language=LANGUAGE          Define the language
+      -p, --package=PACKAGE            Add another package
+      -o, --directory=DIRECTORY        Define the output directory
+      -q, --quiet                      Don't ask any question
       -v, --version                    Print Condom version
 
-In generated files, there is a Makefile.
-Just use your document (from the source folder) like below.
+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).
+
+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.
 
 compile with:
   $ make
@@ -84,7 +91,7 @@ All constructors of these classes will use default values, but also accept:
 * 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, :outputdir => "here")
+  doc = Condom::Document.new(:document_class => "report", :math => true, :directory => "here")
 
 You can get all options with:
 
@@ -99,14 +106,14 @@ Then, once your document is ready to be generated, create it with:
 
   doc.create
 
-This method will generate all files in the outputdir directory.
+This method will generate all files in the output directory.
 
 == Technique
 
 The following command:
-  $ condom -mlfpg -t "Condom makes LaTeX easier" here
+  $ condom document -t "Condom makes LaTeX easier" -o here
 
-will generate:
+may result the creation of these folders/files:
   $ tree here/
   here/
   ├── fig

data/bin/condom

@@ -1,74 +1,103 @@
 # Command line tool for Condom
-# Author: Vivien 'v0n' Didelot.
-
-# Add ../lib to the load path
-#lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
-#$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include? lib_dir
+#
+# Author:: Vivien 'v0n' Didelot <vivien.didelot@gmail.com>
+# See:: http://github.com/v0n/condom
 
 require 'condom'
 require 'optparse'
 
-doc = Condom::Base.new
-ops = doc.get_options
+quiet = false
+types = ['document', 'presentation', 'letter']
+ops = {:other_packages => []}
 
 ARGV.options do |o|
-  o.banner = "Usage: #{File.basename $0} [options] [destination]\n"
-  o.on_head("\nAvailable options:")
-  o.on("-m", "--math",                      "Math packages")             { ops[:math] = true }
-  o.on("-l", "--listings",                  "Listings package")          { ops[:listings] = true }
-  o.on("-f", "--fancyhdr",                  "Fancyhdr package")          { ops[:fancyhdr] = true }
-  o.on("-p", "--pdf",                       "PDF config")                { ops[:pdf] = true }
-  o.on("-g", "--graphics",                  "Images packages")           { ops[:graphics] = true }
-  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 }
-  o.on("-t", "--title=TITLE",       String, "Define the title")          { |v| ops[:title] = v }
-  o.on("-d", "--date=DATE",         String, "Define the date")           { |v| ops[:date] = v }
-  o.on("-c", "--class=CLASS",       String, "Define the document class",
-               "\"beamer\" for a presentation, \"letter\" for a letter") { |v| ops[:document_class] = v }
-  o.on("-L", "--language=LANGUAGE", String, "Define the language")       { |v| ops[:language] = v }
-  o.on("-P", "--package=PACKAGE",   String, "Add another package")       { |v| ops[:other_packages].push v }
-  o.on("-v", "--version",                   "Print Condom version")      { puts "Condom lib: version #{Condom::VERSION}" ; exit }
+  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",
+    "\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 }
+  o.on("-t", "--title=TITLE",          String, "Define the title")            { |v| ops[:title] = v }
+  o.on("-d", "--date=DATE",            String, "Define the date")             { |v| ops[:date] = v }
+  o.on("-c", "--document-class=CLASS", String, "Define the document class")   { |v| ops[:document_class] = v }
+  o.on("-l", "--language=LANGUAGE",    String, "Define the language")         { |v| ops[:language] = v }
+  o.on("-p", "--package=PACKAGE",      String, "Add another package")         { |v| ops[:other_packages].push v }
+  o.on("-o", "--directory=DIRECTORY",  String, "Define the output directory") { |v| ops[:directory] = v }
+  o.on("-q", "--quiet",                        "Don't ask any question")      { quiet = true }
+  o.on("-v", "--version",                      "Print Condom version")        { puts "Condom lib: version #{Condom::VERSION}" ; exit }
 end
 
 begin
   ARGV.options.parse!
+  raise "Bad syntax. Try \`#{File.basename $0} --help' for more information." if ARGV.length > 1
 
-  raise "Bad syntax." if ARGV.length > 1
-  if ARGV.length == 1
-    ops[:outputdir] = (ARGV.first == ".") ? Dir.getwd : ARGV.first
-  end
-
-  # Ask for confirmation
-  ops.each do |key, val|
-    value = case val
-            when true: "yes"
-            when false: "no"
-            when Array: val.join(", ")
-            else val
-            end
-    printf "%-15s=> %s\n", key, value
-  end
-  print "\nContinue [Y/n/h]? "
-  case STDIN.gets.strip
-  when 'Y', 'y', ''
-  when 'h'
-    puts ARGV.options
-    exit
+  if ARGV.size == 1
+    doc = case ARGV.first
+          when 'document' then Condom::Document.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."
+          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
+          end
   else
-    puts "Cancel."
-    exit
+    doc = Condom::Document.new
   end
 
-  doc = case ops[:document_class]
-        when 'beamer': Condom::Presentation.new
-        when 'letter': Condom::Letter.new
-        else Condom::Document.new
-        end
   doc.set_options(ops)
+
+  unless quiet
+    # Ask for confirmation
+    puts "Enter the new value, or press ENTER for the default"
+
+    doc_type = doc.class.to_s.split('::').last.downcase
+    printf "    type [%s]: ", 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
+
+    loop do
+      ops = Hash.new
+      doc.get_options.each do |key, value|
+        displayed_value = case value
+                          when true then "yes"
+                          when false then "no"
+                          when Array then value.join(', ')
+                          else value
+                          end
+        printf "    %-17s [%s]: ", 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
+                   elsif key == :other_packages then new_value.split(/\s*,\s*/)
+                   else new_value
+                   end unless new_value.empty?
+      end
+      doc.set_options(ops) unless ops.empty?
+
+      print "\nIs the information correct? [Y/n/q] "
+      case STDIN.gets.strip
+        when /^Y?$/i then break
+        when 'q' then exit
+      end
+    end
+  end
+
   doc.create
-  puts "Files created in #{doc.outputdir}."
+  puts "info: Files created in #{doc.directory}."
 rescue => e
-  STDERR.puts "error: #{e}"
+  STDERR.puts "fail: #{e}"
 end
 
 exit

data/lib/condom.rb

@@ -1,3 +1,8 @@
+# Condom, a Ruby lib for LaTeX document.
+#
+# Author:: Vivien 'v0n' Didelot <vivien.didelot@gmail.com>
+# See:: http://github.com/v0n/condom
+
 require "condom/base"
 require "condom/letter"
 require "condom/document"
@@ -7,7 +12,7 @@ require "etc"
 
 module Condom
   # Lib version
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 
   # Constant views directory
   VIEWS_DIR = File.join(File.expand_path(File.dirname(__FILE__)), 'views')

data/lib/condom/base.rb

@@ -9,7 +9,7 @@ module Condom
   # This is the main class of the condom lib.
   # It will contain all common attributes and methods to every LaTeX document.
   class Base
-    attr_accessor :outputdir, :filename,
+    attr_accessor :directory, :filename,
       :author, :title, :date, :document_class, :language,
       :other_packages
 
@@ -20,11 +20,11 @@ module Condom
     # * a hash of options.
     def initialize(args = nil)
       # Need to initialize each variables else they won't exist in instance_variables.
-      @outputdir = @filename = @author = @title = @date = @document_class = @language = @other_packages = nil
+      @directory = @filename = @author = @title = @date = @document_class = @language = @other_packages = nil
 
       # The default options
       set_options({
-        :outputdir      => Dir.getwd,
+        :directory      => Dir.getwd,
         :filename       => 'main',
         :author         => Condom.get_user_name,
         :title          => 'Document \LaTeX',
@@ -62,7 +62,7 @@ module Condom
 
     # This method will create in output directory all needed files.
     def create
-      in_outputdir do
+      in_directory do
         raise("Please use a specific Condom class, not Base.")
       end
     end
@@ -71,14 +71,14 @@ module Condom
 
     # This method creates the output directory (if needed)
     # and execute the block given in parameter.
-    def in_outputdir
+    def in_directory
       # Verify output
-      FileUtils.makedirs @outputdir
+      FileUtils.makedirs @directory
       raise(ArgumentError, "A block should be given") unless block_given?
 
-      Dir.chdir @outputdir do
-        raise("#{@outputdir}: it already exists a main.tex file") if File.exist? "main.tex"
-        raise("#{@outputdir}: it already exists a Makefile") if File.exist? "Makefile"
+      Dir.chdir @directory do
+        raise("#{@directory}: it already exists a main.tex file") if File.exist? "main.tex"
+        raise("#{@directory}: it already exists a Makefile") if File.exist? "Makefile"
 
         # Call the given instructions block
         yield

data/lib/condom/document.rb

@@ -35,7 +35,7 @@ module Condom
 
     # This method will write in the output directory all needed files.
     def create
-      in_outputdir do
+      in_directory do
         # Create files
         build "main.tex"
         build "Makefile"

data/lib/condom/letter.rb

@@ -35,7 +35,7 @@ module Condom
 
     # This method will write in the output directory all needed files.
     def create
-      in_outputdir do
+      in_directory do
         # Create files
         build "letter.tex"
         File.rename("letter.tex", "main.tex")

data/lib/condom/presentation.rb

@@ -17,7 +17,7 @@ module Condom
         # The default options
         options = {
           :document_class => 'beamer',
-          :title          => 'Présentation \LaTeX',
+          :title          => 'Presentation \LaTeX',
           :filename       => 'presentation',
           :listings       => false,
           :graphics       => true,
@@ -35,7 +35,7 @@ module Condom
 
     # This method will write in the output directory all needed files.
     def create
-      in_outputdir do
+      in_directory do
         # Create files
         build "presentation.tex"
         File.rename("presentation.tex", "main.tex")

metadata

@@ -4,10 +4,10 @@ version: !ruby/object:Gem::Version
   hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
   - 0
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Vivien Didelot
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 +10:00
+date: 2010-08-19 00:00:00 +10:00
 default_executable: 
 dependencies: []