publican_creators 1.0.2

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/bin/publican_creators.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'publican_creators'
+require 'bundler/setup'
+
+IRB.start

data/bin/revision_creator.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# @author Sascha Manns
+# @abstract Class RevisionCreator for PublicanCreator
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: GPL-3
+
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   '../lib/publican_creators', 'revision.rb'))
+RevisionCreator.new

data/config.reek

@@ -0,0 +1,111 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 3
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+ModuleInitialize:
+  enabled: true
+  exclude: []
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+PrimaDonnaMethod:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 2
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 25
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 15
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept:
+  - Inline::C
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  - !ruby/regexp /^_/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - _
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []

data/etc/publicancreators.cfg

@@ -0,0 +1,85 @@
+# Configuration file for PublicanCreators
+# Change this file to pacify your needs
+conf_ver = '1'
+
+# Global
+name = 'Sascha Manns'
+email_private = 'samannsml@directbox.com'
+
+# Specify your language like de-DE
+language = 'de-DE'
+
+# If you want to use DocBook5 as default so set it there
+db5 = 'true'
+
+# Choose if you like to use a special brand or use the publicacn default
+use_brand = 'true'
+
+# If you write anything do you would like to use the default titlelogo
+# Hint: Another way can be to write own XSL-FO Stylesheets and use an own brand
+title_logo = 'false'
+
+# Would you like to remove the XI-Include from articles?
+# Hint: Maybe you use it in another way.
+legal = 'true'
+
+# If you have an own xfc brand (xfc is a fo processor for docx, odt and so on)
+# you can place your path there
+xfc_brand_dir = "/opt/XMLmind/xfc-xcom-stylesheet/xsl/fo/docbook.xsl"
+
+# Set your prefered PDF-Viewer e.g. evince
+pdfview = "/opt/cxoffice/bin/wine --bottle "PDF-XChange Viewer 2.x" --cx-app PDFXCview.exe"
+
+# Private
+
+# If you are using different brands for your homework and private you can place it there
+# If you would like to use the publican brand just set brand_private = '' and brand_homework = ''
+brand_private = 'manns'
+brand_homework = 'ils'
+
+# Define your standard directory for articles if you writing private
+# Please set the directory without leading "/home/username"
+articles_dir_priv = "Dokumente/Textdokumente/publican-manns/articles"
+
+# If the option homework is given in the dialog the program
+# uses this directory.
+# Please set the directory without leading "/home/username"
+homework_dir = "Dokumente/Textdokumente/publican-manns/articles/homework"
+
+# Define there your books directory
+# Please set the directory without leading "/home/username"
+books_dir_priv = "Dokumente/Textdokumente/publican-manns/books"
+
+# Work
+
+# If choosen yes please tell the name as shown in /usr/share/publican/Common_Content
+# Like XCOM for /usr/share/publican/Common_Content/XCOM or
+# manns for /usr/share/publican/Common_Content/manns
+# If you would like to use the publican brand just set brand = ''
+brand = 'XCOM'
+company_name = 'XCOM AG'
+company_division = 'SWE7 (Sascha Bochartz)'
+email_business = 'Sascha.Manns@xcom.de'
+
+# System Variables
+# If you are using a publican brand you can place there
+# the full path to them
+brand_dir = '/usr/share/publican/Common_Content/XCOM'
+
+# If the brand has a global entities file you can place
+# the path there. Please leave the #{brand_dir} because
+# it will be handled by ruby later.
+globalentities = "de-DE/entitiesxcom.ent"
+
+# Define your standard directory for articles
+# Please set the directory without leading "/home/username"
+articles_dir = "Dokumente/Textdokumente/publican-documentation/articles/Projekte/GSBUHA/Dokumentation/"
+
+# If the option Reports is given in the dialog the program
+# uses this directory.
+# Please set the directory without leading "/home/username"
+reports_dir = "Dokumente/Textdokumente/publican-documentation/articles/Projekte/GSBUHA/Dokumentation/Reports"
+
+# Define there your books directory
+# Please set the directory without leading "/home/username"
+books_dir = "Dokumente/Textdokumente/publican-documentation/books"

data/lib/PublicanCreators.rb

@@ -0,0 +1,233 @@
+#!/usr/bin/env ruby
+# @author Sascha Manns
+# @abstract Main Class for PublicanCreators
+#
+# Copyright (C) 2015  Sascha Manns <samannsml@directbox.com>
+# License: MIT
+
+# Dependencies
+require 'publican_creators/checker'
+require 'publican_creators/get'
+require 'publican_creators/change'
+require 'publican_creators/export'
+require 'publican_creators/prepare'
+require 'publican_creators/notifier'
+require 'fileutils'
+require 'nokogiri'
+require 'rainbow/ext/string'
+require 'bundler/setup'
+require 'manns_shared'
+
+# Main Class of PublicanCreators
+# @return [String] true or false
+class PublicanCreators
+  # Versionizing
+  VERSION = '1.0.2'
+
+  my_name = File.basename($PROGRAM_NAME)
+
+  puts "Script: #{my_name}"
+  puts "Version: #{VERSION}"
+  puts
+  puts 'Copyright (C) 2015 Sascha Manns <samannsml@directbox.com>'
+  puts 'Description: This script creates a article or book set with'
+  puts 'Publican. Then it modifies it for your needs.'
+  puts 'License: GPL-3'
+  puts 'Bugs: Please file bugs on https://gitlab.com/saigkill/publican_creators/issues'
+
+  puts 'Reading the config file in publicancreators.cfg'
+  # @note Run config method who reads in the config file and puts the variables
+  # in an array
+  # name, email, language, use_brand, title_logo, legal, brand, company_name,
+  #     company_division, email_business, brand_dir, glob_entities,
+  #     articles_dir_business, reports_dir_business, books_dir_business,
+  #     articles_dir_private, homework_dir_private, books_dir_private,
+  #     brand_private, brand_homework, db5, conf_ver, xfc_brand_dir,
+  #     pdfview = PublicanCreatorsGet.config
+
+  home = Dir.home
+  config = ParseConfig.new("#{home}/.publican_creators/publicancreators.cfg")
+  conf_ver = config['conf_ver']
+  name = config['name']
+  email = config['email_private']
+  language = config['language']
+  use_brand = config['use_brand']
+  title_logo = config['title_logo']
+  legal = config['legal']
+  brand = config['brand']
+  company_name = config['company_name']
+  company_division = config['company_division']
+  email_business = config['email_business']
+  brand_dir = config['brand_dir']
+  glob_entities = config['globalentities']
+  articles_dir_business = config['articles_dir']
+  reports_dir_business = config['reports_dir']
+  books_dir_business = config['books_dir']
+  articles_dir_private = config['articles_dir_priv']
+  homework_dir_private = config['homework_dir']
+  books_dir_private = config['books_dir_priv']
+  brand_private = config['brand_private']
+  brand_homework = config['brand_homework']
+  db5 = config['db5']
+  xfc_brand_dir = config['xfc_brand_dir']
+  pdfview = config['pdfview']
+
+  puts 'Your configuration is:'
+  puts "Your Name: #{name}"
+  puts "Your private emailaddress: #{email}"
+  puts "Your choosen language: #{language}"
+  puts "Using an own brand: #{use_brand}"
+  puts "Leave title_logo: #{title_logo}"
+  puts "Leave legalnotice in article: #{legal}"
+  puts "Choosen brand: #{brand}"
+  puts "Your company name: #{company_name}"
+  puts "Your company division: #{company_division}"
+  puts "Your business email address: #{email_business}"
+  puts "Your brand dir: #{brand_dir}"
+  puts "Your global entities: #{glob_entities}"
+  puts "Your business articles dir: #{articles_dir_business}"
+  puts "Your business reports dir: #{reports_dir_business}"
+  puts "Your business books dir: #{books_dir_business}"
+  puts "Your private articles dir: #{articles_dir_private}"
+  puts "Your homework dir: #{homework_dir_private}"
+  puts "Your private books dir: #{books_dir_private}"
+  puts "Your private brand: #{brand_private}"
+  puts "Your homework brand: #{brand_homework}"
+  puts "DocBook5 as default: #{db5}"
+  puts "Config version: #{conf_ver}"
+  puts "XFC brand dir: #{xfc_brand_dir}"
+  puts "Your prefered PDF-Viewer: #{pdfview}"
+
+  global_entities = "#{brand_dir}/#{glob_entities}"
+  puts "Your global entities file is there: #{global_entities}"
+
+  # @note Ask for the title and other settings via yad and put them into a array
+  environment, type, opt, title = PublicanCreatorsGet.title
+
+  puts "Environment: #{environment}"
+  puts "Type: #{type}"
+  puts "Optional: #{opt}"
+  puts "Title: #{title}"
+
+  # This method sets the default value for report
+  # @param [String] opt Can be Report or Homework or Normal
+  # @return [String] report
+
+  report = 'FALSE'
+  homework = 'FALSE'
+  report = 'TRUE' if opt == 'Report'
+  homework = 'TRUE' if opt == 'Homework'
+
+  # @note Hardcoded variables
+  artinfo = "#{title}/#{language}/Article_Info.xml"
+  bookinfo = "#{title}/#{language}/Book_Info.xml"
+  revhist = "#{title}/#{language}/Revision_History.xml"
+  agroup = "#{title}/#{language}/Author_Group.xml"
+  ent = "#{title}/#{language}/#{title}.ent"
+  builds = "#{title}/#{language}/Rakefile"
+
+  # @note Run one of the both methods to get the variable targetdir
+  # @param [String] type Book or Article
+  # @param [String] reports_dir_business path to that dir where you store your
+  #                 reports
+  # @param [String] articles_dir_business path to that dir where you store
+  #                 business articles
+  # @param [String] report true or false
+  # @param [String] books_dir_business path to that dir where you store your
+  #                 business books
+  # @param [String] true or false
+  # @param [String] articles_dir_private path to your private articles directory
+  # @param [String] homework path to your homework directory
+  # @param [String] books_dir_private path to your private books directory
+  targetdir = PublicanCreatorsPrepare.targetdir(environment, type, report,
+                                                reports_dir_business,
+                                                articles_dir_business,
+                                                books_dir_business, homework,
+                                                articles_dir_private,
+                                                homework_dir_private,
+                                                books_dir_private)
+
+  # @note Checks if the needed directory targetdir is available. Otherwise it
+  # creates one.
+  puts "Creating directory #{targetdir}"
+  # @param [String] targetdir comes from PublicanCreatorsPrepare.prepare_work or
+  # .prepare_private
+  MannsShared.check_dir(targetdir)
+
+  # @note Change to target directory
+  puts 'Change to this directory'
+  # @param [String] targetdir comes from PublicanCreatorsPrepare.prepare_work or
+  # .prepare_private
+  FileUtils.cd(targetdir) do
+    # @param [String] title comes from titleget[3]
+    # @param [String] type Book or Article
+    # @param [String] language comes from config file in format de-DE
+    # @param [String] brand e.g. Debian or nothing for using publicans default
+    #                 brand (config file)
+    # @param [String] db5 DocBook5 as default? (config file)
+    # @param [String] homework true or false
+    # @param [String] brand_homework e.g. ils (config file)
+    # @param [String] brand_private e.g. manns (config file)
+    PublicanCreatorsChange.check_environment(environment, title, type, language,
+                                             brand, db5, homework,
+                                             brand_homework, brand_private)
+
+    # @param [String] title comes from titleget[3]
+    # @param [String] environment Work or Private
+    # @param [String] global_entities path to a global entities file
+    #                 (config file)
+    # @param [String] brand e.g. Debian or nothing for using publicans default
+    #                 brand (config file)
+    PublicanCreatorsChange.add_entity(environment, global_entities, ent)
+
+    # @param [String] title comes from titleget[3]
+    # @param [String] environment Work or Private
+    # @param [String] name your name (config file)
+    # @param [String] company_name (config file)
+    PublicanCreatorsChange.change_holder(title, environment, name, company_name,
+                                         ent)
+
+    # @param [String] title comes from titleget[3]
+    # @param [String] environment Work or Private
+    # @param [String] type Book or Article
+    # @param [String] legal remove legalnotice from article? (config file)
+    PublicanCreatorsChange.remove_legal(environment, type, legal, artinfo)
+
+    # @param [String] artinfo path to Article_Info (hardcoded)
+    # @param [String] bookinfo path to Book_Info (hardcoded)
+    # @param [String] title_logo remove titlelogo from articlepage (config file)
+    # @param [String] type Book or Article
+    PublicanCreatorsChange.remove_orgname_prepare(bookinfo, artinfo, title_logo,
+                                                  type)
+
+    # @param [String] environment Work or Private
+    # @param [String] name your name (config file)
+    # @param [String] email_business business email address (config file)
+    # @param [String] title comes from titleget[3]
+    PublicanCreatorsChange.fix_revhist(environment, name, email_business, email,
+                                       revhist)
+
+    # @param [String] title comes from titleget[3]
+    # @param [String] name your name (config file)
+    # @param [String] email_business business email address (config file)
+    # @param [String] company_name your company's name (config file)
+    # @param [String] company_division your companiy's division
+    # @param [String] email your private email address
+    PublicanCreatorsChange.fix_authorgroup(name, email_business, company_name,
+                                           company_division, email, environment,
+                                           agroup)
+
+    # @param [String] title comes from titleget[3]
+    # @param [String] builds path to buildscript (hardcoded)
+    # @param [String] language comes from config file in format de-DE
+    # @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)
+    PublicanCreatorsExport.export_buildscript(title, builds, language,
+                                              xfc_brand_dir, pdfview)
+
+    puts "Now you can find your documentation there: #{targetdir}/#{title}"
+    Notifier.run
+    puts "Thanks for using: #{my_name} #{version}"
+  end
+end