publican_creators 1.0.2

data/lib/publican_creators/export.rb

@@ -0,0 +1,230 @@
+# PublicanCreatorsExport
+# @author Sascha Manns
+# @abstract Class for exporting bash scripts
+#
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: MIT
+
+# Dependencies
+
+require 'publican_creators/change'
+require 'fileutils'
+require 'rainbow/ext/string'
+
+# rubocop:disable Metrics/MethodLength
+# Module for running exports to a file
+module PublicanCreatorsExport
+  # Exports a predefined Shellscript to the target directory.
+  # It returns a sucess or fail.
+  # Description:
+  # @param [String] title comes from the get method. This parameter represents
+  #                 the name or title of your work. It is used in all important
+  #                 code places.
+  # @param [String] builds is the path to your buildscript
+  # @param [String] language is just the ISO Code of your target language
+  #                 like: en-GB or such things.
+  # @param [String] xfc_brand_dir if present the path to your branded xfc
+  #                 stylesheets (config file)
+  # @param [String] pdfview your prefered PDF-Viewer (config file)
+  # @return [String] true or false
+  def self.export_buildscript(title, builds, language, xfc_brand_dir, pdfview)
+    puts 'Export the buildscript into new directory...'
+    FileUtils.touch "#{builds}"
+    # rubocop:disable Metrics/LineLength
+    File.write "#{builds}", <<EOF
+# -*- ruby -*-
+# encoding: utf-8
+require 'fileutils'
+
+task :default do
+  puts 'usage: rake [export_docx] [export_odt] [export_rtf] [export_wml] [export_pdf] [export_html] [export_man] [export_txt] [export_txt] [export_epub]'
+  puts
+  puts 'Options:'
+  puts 'export_docx : Export DocBook source to DOCX'
+  puts ' Example: rake export_docx'
+  puts 'export_odt : Export DocBook source to ODT'
+  puts ' Example: rake export_odt'
+  puts 'export_rtf : Export DocBook source to RTF'
+  puts ' Example: rake export_rtf'
+  puts 'export_wml: Export DocBook source to WML'
+  puts ' Example: rake export_wml'
+  puts 'export_pdf: Export Docbook source to PDF'
+  puts ' Example: rake export_pdf'
+  puts 'export_html: Export DocBook source to HTML'
+  puts ' Example: rake export_html'
+  puts 'export_man: Export DocBook source to MAN'
+  puts ' Example: rake export_man'
+  puts 'export_txt: Export DocBook source to TXT'
+  puts ' Example: rake export_txt'
+  puts 'export_epub: Export DocBook source to EPUB'
+  puts ' Example: rake export_epub'
+  puts 'export_eclipse: Export DocBook source to Eclipse Help'
+  puts ' Example: rake export_eclipse'
+end
+
+require 'dir'
+require 'fileutils'
+desc 'Checks if temp dir is available. Otherwise it creates it'
+task :checker do
+  todos = "../tmp/#{language}/docx"
+  if Dir.exist?(todos)
+    puts 'Found directory. Im using it.'
+  else
+    puts 'No directory found. Im creating it.'
+    FileUtils.mkdir_p(todos)
+  end
+  todos = "../tmp/#{language}/odt"
+  if Dir.exist?(todos)
+    puts 'Found directory. Im using it.'
+  else
+    puts 'No directory found. Im creating it.'
+    FileUtils.mkdir_p(todos)
+  end
+  todos = "../tmp/#{language}/rtf"
+  if Dir.exist?(todos)
+    puts 'Found directory. Im using it.'
+  else
+    puts 'No directory found. Im creating it.'
+    FileUtils.mkdir_p(todos)
+  end
+  todos = "../tmp/#{language}/wml"
+  if Dir.exist?(todos)
+    puts 'Found directory. Im using it.'
+  else
+    puts 'No directory found. Im creating it.'
+    FileUtils.mkdir_p(todos)
+  end
+end
+
+desc 'Convert to DOCX'
+task :export_docx => [:checker] do
+  puts 'Resolving all XML-Entities and XI-Includes'
+  system("xmllint --noent --dropdtd --xinclude #{title}.xml -o #{title}-resolved.xml")
+  puts 'Formatting XML to XSL-FO'
+  system("saxon-xslt -o #{title}.fo #{title}-resolved.xml #{xfc_brand_dir}")
+  puts 'Removing temporary resolved file'
+  FileUtils.rm('#{title}-resolved.xml')
+  puts 'Transforming to DOCX'
+  system("fo2docx #{title}.fo > ../tmp/#{language}/docx/#{title}.docx")
+  puts 'Launching LibreOffice Writer for Preview'
+  system("lowriter ../tmp/#{language}/docx/#{title}.docx &")
+end
+
+desc 'Convert to ODT'
+task :export_odt => [:checker] do
+  puts 'Resolving all XML-Entities and XI-Includes'
+  system("xmllint --noent --dropdtd --xinclude #{title}.xml -o #{title}-resolved.xml")
+  puts 'Formatting XML to XSL-FO'
+  system("saxon-xslt -o #{title}.fo #{title}-resolved.xml #{xfc_brand_dir}")
+  puts 'Removing temporary resolved file'
+  FileUtils.rm('#{title}-resolved.xml')
+  puts 'Transforming to ODT'
+  system("fo2odt #{title}.fo > ../tmp/#{language}/odt/#{title}.odt")
+  puts 'Launching LibreOffice Writer for Preview'
+  system("lowriter ../tmp/#{language}/odt/#{title}.odt &")
+end
+
+desc 'Convert to RTF'
+task :export_rtf => [:checker] do
+  puts 'Resolving all XML-Entities and XI-Includes'
+  system("xmllint --noent --dropdtd --xinclude #{title}.xml -o #{title}-resolved.xml")
+  puts 'Formatting XML to XSL-FO'
+  system("saxon-xslt -o #{title}.fo #{title}-resolved.xml #{xfc_brand_dir}")
+  puts 'Removing temporary resolved file'
+  FileUtils.rm('#{title}-resolved.xml')
+  puts 'Transforming to RTF'
+  system("fo2rtf #{title}.fo > ../tmp/#{language}/rtf/#{title}.rtf")
+  puts 'Launching LibreOffice Writer for Preview'
+  system("lowriter ../tmp/#{language}/rtf/#{title}.rtf &")
+end
+
+desc 'Convert to WML'
+task :export_wml => [:checker] do
+  puts 'Resolving all XML-Entities and XI-Includes'
+  system("xmllint --noent --dropdtd --xinclude #{title}.xml -o #{title}-resolved.xml")
+  puts 'Formatting XML to XSL-FO'
+  system("saxon-xslt -o #{title}.fo #{title}-resolved.xml #{xfc_brand_dir}")
+  puts 'Removing temporary resolved file'
+  FileUtils.rm('#{title}-resolved.xml')
+  puts 'Transforming to WML'
+  system("fo2wml #{title}.fo > ../tmp/#{language}/wml/#{title}.wml")
+end
+
+desc 'Convert to PDF'
+task :export_pdf do
+  FileUtils.cd('..')
+  puts 'Cleaning up temp directory'
+  system('publican clean')
+  puts 'Formatting to PDF'
+  system('publican build --langs=#{language} --formats=pdf --allow_network')
+  puts 'Launching PDF-Viewer'
+  system('#{pdfview} tmp/#{language}/pdf/*.pdf &')
+end
+
+desc 'Convert to HTML'
+task :export_html do
+  FileUtils.cd('..')
+  puts 'Cleaning up temp directory'
+  system('publican clean')
+  puts 'Formatting to PDF'
+  system('publican build --langs=#{language} --formats=html --allow_network')
+  puts 'Launching Browser'
+  system('firefox tmp/#{language}/html/index.html &')
+end
+
+desc 'Convert to MAN'
+task :export_man do
+  FileUtils.cd('..')
+  puts 'Cleaning up temp directory'
+  system('publican clean')
+  puts 'Formatting to MAN'
+  system('publican build --langs=#{language} --formats=man --allow_network')
+end
+
+desc 'Convert to TXT'
+task :export_txt do
+  FileUtils.cd('..')
+  puts 'Cleaning up temp directory'
+  system('publican clean')
+  puts 'Formatting to TXT'
+  system('publican build --langs=#{language} --formats=txt --allow_network')
+  puts 'Launching Texteditor'
+  system('gedit tmp/#{language}/txt/*.txt &')
+end
+
+desc 'Convert to EPUB'
+task :export_epub do
+  FileUtils.cd('..')
+  puts 'Cleaning up temp directory'
+  system('publican clean')
+  puts 'Formatting to EPUB'
+  system('publican build --langs=#{language} --formats=epub --allow_network')
+  if File.exist?('/usr/bin/ebook-viewer')
+    puts 'Launching EPUB-Viewer'
+    system('ebook-viewer /tmp/#{language}/*.epub &')
+  else
+    puts 'You have to install calibre for using ebook-viewer for preview'
+  end
+end
+
+desc 'Convert to ECLIPSE'
+task :export_eclipse do
+  FileUtils.cd('..')
+  puts 'Cleaning up temp directory'
+  system('publican clean')
+  puts 'Formatting to ECLIPSE'
+  system('publican build --langs=#{language} --formats=eclipse --allow_network')
+end
+
+desc 'Run convert to most used formats'
+task :export_most => [:export_docx, :export_odt, :export_rtf, :export_html, :export_pdf] do
+  puts 'Successful exported to DOCX, ODT, RTF, HTML and PDF'
+end
+
+desc 'Run convert to all formats'
+task :export_all => [:export_most, :export_wml, :export_man, :export_txt, :export_epub, :export_eclipse] do
+  puts 'Successfull exported to all formats'
+end
+EOF
+  end
+end

data/lib/publican_creators/get.rb

@@ -0,0 +1,66 @@
+# PublicanCreatorsGet
+# @author Sascha Manns
+# @abstract Class for gathering information from config file and user input
+#
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: MIT
+
+# Dependencies
+
+require 'parseconfig'
+
+# This method provides methods for user inputs
+module PublicanCreatorsGet
+  # This method ask for the title, environment, type and optional settings.
+  # It returns the title variable.
+  # @return [String] environment, type, opt, title
+  def self.title
+    # @note Put the yad input as variable titlein
+    titlein = `yad --title="Create documentation" --center --on-top --form \
+--item-separator=, --separator="|"  --field="Environment:CBE" \
+--field="Type:CBE" --field="Optional:CBE" --field="Enter a title name \
+(with underscores instead of blanks and without umlauts):TEXT" \
+--field="Please file bugs or feature requests \
+on http://saigkill-bugs.myjetbrains.com/youtrack/:LBL" --button="Go!" "Work,Private" \
+"Article,Book" "Normal,Report,Homework"`
+    # @note Format: Work/Private Article/Book title!Normal Report Homework
+    # @note Cleanup the array
+    environment, type, opt, titlefix = titlein.chomp.split('|')
+
+    # @note replace blanks with underscores
+    title = titlefix.gsub(/ /, '_')
+
+    [environment, type, opt, title]
+  end
+
+  # This method ask for revision information
+  # Description:
+  # @return [String] revision
+  def self.revision
+    # @note Put the yad input as variable revhistin
+    revhistin = `yad --title="Create Revision" --center --on-top --form \
+--item-separator=, --separator="|" --field="Choose the directory where your \
+project publican.cfg is:LBL" --field="Projectdir:DIR" --field="Enter your \
+first revision text:TEXT" --field="Enter your second revision text:TEXT" \
+--field="Enter your third revision text:TEXT" --field="Enter your fourth \
+revision text:TEXT" --field="Enter your fifth revision text:TEXT" \
+--field="Enter Revision number:TEXT" --field="You can use backslashes for \
+entering Revision textes with blanks.:LBL" --button="Go!"`
+    # @note Format: Directory|One|Two|Three|Four|Five|Revision
+    # @note Cleanup the array
+    revision = revhistin.chomp.split('|')
+    # @note Split the variable to array revision[*]
+    puts revision
+  end
+
+  # This method gets the language from the config file for using in
+  # RevisionCreator
+  # @return [String] language
+  def self.config_revision
+    include ParseConfig
+    home = Dir.home
+    config = ParseConfig.new("#{home}/.publican_creators/publicancreators.cfg")
+    language = config['language']
+    puts language
+  end
+end

data/lib/publican_creators/notifier.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# @author Sascha Manns
+# @abstract Notifier Module for latex_curriculum_vitae
+#
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: MIT
+
+# Dependencies
+
+# Module for notify the user
+require 'notifier'
+
+module Notifier
+  def self.run
+    home = Dir.home
+    prefix = "#{home}/.rvm/rubies/default"
+    datadir = "#{prefix}/share"
+    img = "#{datadir}/.publican_creators/publican.png"
+    Notifier.notify(
+        :image => "#{img}",
+        :title => "Your Documentation",
+        :message => "The preparation of your Documentation is finished."
+    )
+  end
+end

data/lib/publican_creators/prepare.rb

@@ -0,0 +1,82 @@
+# PublicanCreatorsPrepare
+# @author Sascha Manns
+# @abstract Class for preparing the configuration
+#
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: MIT
+
+# Dependencies
+
+# The module Prepare contains some methods for preparing the directories. They
+# will be used in the make directory function
+module PublicanCreatorsPrepare
+  # This method sets the needed targetdir depending on the environment
+  # @param [String] type represents the Document-Type like Article or Book.
+  # @param [String] reports_dir_business contains the directory to your reports
+  # @param [String] articles_dir_bus represents the directory for your articles
+  # @param [String] report contains a true or false. There you can set if the
+  #                 new Publication is a Report or not.
+  # @param [String] books_dir_business contains the directory for your business
+  #                 books
+  # @param [String] homework contains true or false. If your present Publication
+  #                 is a homework you can set it there.
+  # @param [String] articles_dir_private contains the path to your private
+  #                 articles_dir
+  # @param [String] homework_dir_private contains the path to your homework dir.
+  # @param [String] books_dir_private contains the path to your private
+  #                 books_dir
+  # @return [String] targetdir
+  def self.targetdir(environment, type, report, reports_dir_business,
+      articles_dir_bus, books_dir_business, homework,
+      articles_dir_private, homework_dir_private, books_dir_private)
+    home = Dir.home
+    if environment == 'Work'
+      if type == 'Article'
+        targetdir_work(report, reports_dir_business, articles_dir_bus)
+      else
+        books_dir = "#{home}/#{books_dir_business}"
+        return books_dir
+      end
+    else
+      if type == 'Article'
+        targetdir_private(homework, articles_dir_private,
+                          homework_dir_private)
+      else
+        books_dir = "#{home}/#{books_dir_private}"
+        return books_dir
+      end
+    end
+  end
+
+  # Prepares the articles_dir for work environment
+  # @param [String] reports_dir_business contains the directory to your reports
+  # @param [String] articles_dir_bus represents the directory for your articles
+  # @param [String] report contains a true or false. There you can set if the
+  #                 new Publication is a Report or not.
+  def self.targetdir_work(report, reports_dir_business, articles_dir_bus)
+    home = Dir.home
+    if report == 'TRUE'
+      articles_dir = "#{home}/#{reports_dir_business}"
+    else
+      articles_dir = "#{home}/#{articles_dir_bus}"
+    end
+    return articles_dir
+  end
+
+  # Prepares the articles_dir for home environment
+  # @param [String] homework contains true or false. If your present Publication
+  #                 is a homework you can set it there.
+  # @param [String] articles_dir_private contains the path to your private
+  #                 articles_dir
+  # @param [String] homework_dir_private contains the path to your homework dir.
+  def self.targetdir_private(homework, articles_dir_private,
+      homework_dir_private)
+    home = Dir.home
+    if homework == 'FALSE'
+      articles_dir = "#{home}/#{articles_dir_private}"
+    else
+      articles_dir = "#{home}/#{homework_dir_private}"
+    end
+    return articles_dir
+  end
+end

data/lib/publican_creators/revision.rb

@@ -0,0 +1,61 @@
+# @author Sascha Manns
+# @abstract Class RevisionCreator for PublicanCreator
+#
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: MIT
+#
+# Dependencies
+require 'fileutils'
+require 'rainbow/ext/string'
+require File.expand_path(File.join(File.dirname(__FILE__), 'change.rb'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'get.rb'))
+
+# A class for creating a revison to a publican project
+class RevisionCreator
+  # @note Ask for the revision information
+  null, directory, member1, member2, member3, member4, member5,
+      revnumber = PublicanCreatorsGet.revision
+  language = PublicanCreatorsGet.config_revision
+
+  revision, edition = revnumber.split('-')
+
+  puts "Directory: #{directory}"
+  puts "Member1: #{member1}"
+  puts "Member2: #{member2}"
+  puts "Member3: #{member3}"
+  puts "Member4: #{member4}"
+  puts "Member5: #{member5}"
+  puts "Language: #{language}"
+  puts "Revnumber: #{revnumber}"
+  puts "Revision: #{revision}"
+  puts "Edition: #{edition}"
+  puts null
+
+  # This method prepares the string for adding a new revision
+  # @param [String] member1 is the first string into revdescription
+  # @param [String] member2 is the second string into revdescription
+  # @param [String] member3 is the third string into revdescription
+  # @param [String] member4 is the fourth string into revdescription
+  # @param [String] member5 is the fifth string into revdescription
+  # @param [String] revnumber is the revision number
+  # @param [String] language is the language. Comes from config file.
+  # @return [String] string is that string for creating the commit
+  def self.prepare_revision(member1, member2, member3, member4, member5,
+      revnumber, language)
+    string = "--member \"#{member1}\""
+    string << " --member \"#{member2}\"" if member2 != ''
+    string << " --member \"#{member3}\"" if member3 != ''
+    string << " --member \"#{member4}\"" if member4 != ''
+    string << " --member \"#{member5}\"" if member5 != ''
+    string << " --revnumber \"#{revnumber}\""
+    string << " --lang \"#{language}\""
+  end
+
+  # This method changes to the target directory
+  FileUtils.cd(directory) do
+    string = prepare_revision(member1, member2, member3, member4, member5,
+                              revnumber, language)
+    PublicanCreatorsChange.replace_productnumber(revision, edition, language)
+    system("publican add_revision #{string}")
+  end
+end