publican_creators 1.1.1 → 1.2.5

data/MAINTENANCE.md

@@ -0,0 +1,19 @@
+# MAINTENANCE POLICY:
+
+I'm following the Semantic Versioning for its releases: (Major).(Minor).(Patch).
+
+ * Major version: Whenever there is something significant or any backwards
+   incompatible changes.
+ * Minor version: When new, backwards compatible functionality is introduced a
+   minor feature is introduced, or when a set of smaller features is rolled out.
+ * Patch number: When backwards compatible bug fixes are introduced that fix
+   incorrect behavior.
+ * The current stable release will receive security patches and bug fixes
+   (eg. 5.0 -> 5.0.1).
+ * Feature releases will mark the next supported stable release where the minor
+   version is increased numerically by increments of one (eg. 5.0 -> 5.1).
+
+I encourage everyone to run the latest stable release to ensure that you can
+easily upgrade to the most secure and feature rich experience. In order to
+make sure you can easily run the most recent stable release, we are working
+hard to keep the update process simple and reliable.

data/README.md

@@ -0,0 +1,95 @@
+# publican_creators
+
+## DESCRIPTION:
+
+publican_creators are a small tool for daily DocBook writers who are using the Redhat publican tool
+https://fedorahosted.org/publican/. 
+
+publican_creators provides a simple gui for creating new DocBook stuff. It supports different environments, so you can predefine currently
+three environments (like work, home, home2) and work with them. You also can build to different output targets through
+the shipped Buildscript.
+
+The CHANGELOG.md contains a detailed description of what has changed.
+
+hoe-reek is released under the GPL3 License, see the file 'LICENSE.md' for more information.
+
+The official website is:
+
+    https://github.com/saigkill/publican_creators
+
+|What|Where|
+|-----|-------------------------------------------------------------------------------------|
+|code  | https://github.com/saigkill/publican_creators |
+|docs | https://saigkill.github.io/publican_creators/ |
+|apidoc | http://rubydoc.info/gems/publican_creators |
+|bugs & feature requests  | https://github.com/saigkill/publican_creators/issues |
+|mailing list | https://groups.google.com/forum/#!forum/publican_creators |
+|openhub statistics | https://www.openhub.net/p/publicancreators |
+|authors blog | https://saschamanns.de |
+|min. rubyver | 2.3.0 |
+
+| What | Status |
+|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|last public version | [![Last Version](https://badge.fury.io/rb/publican_creators.png)](http://rubygems.org/gems/publican_creators) |
+|downloads latest | [![Downloads latest](https://img.shields.io/gem/dtv/publican_creators.svg)](http://rubygems.org/gems/publican_creators)  |
+|downloads all | [![Downloads all](https://img.shields.io/gem/dt/publican_creators.svg)](http://rubygems.org/gems/publican_creators) |
+|code quality | [![Maintainability](https://api.codeclimate.com/v1/badges/e6e62c135374e4c9e495/maintainability)](https://codeclimate.com/github/saigkill/publican_creators/maintainability) |
+|continuous integration | ![CI](https://github.com/saigkill/publican_creators/workflows/CI/badge.svg?branch=master&event=push) |
+|dependencies|[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=saigkill/publican_creators)](https://dependabot.com) |
+|security | [![Security](https://hakiri.io/github/saigkill/publican_creators/master.svg)](https://hakiri.io/github/saigkill/publican_creators/master/shield) |
+|vulnerabilities|[![Known Vulnerabilities](https://snyk.io/test/github/saigkill/publican_creators/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/saigkill/publican_creators?targetFile=Gemfile.lock) | 
+|documentation quality | [![Documentation Quality](https://inch-ci.org/github/saigkill/publican_creators.svg?branch=master)](https://inch-ci.org/github/saigkill/publican_creators) |
+
+
+## SCREENSHOT
+
+### Main
+[![Screenshot](https://saschamanns.de//img/screenshots/PublicanCreators.png)](https://github.com/saigkill/publican_creators)
+
+### Revision Creator
+[![Screenshot](https://saschamanns.de//img/screenshots/RevisionCreator.png)](https://github.com/saigkill/publican_creators)
+
+## FEATURES/PROBLEMS:
+
+* GUI to control publican
+
+## SYNOPSIS:
+
+    $ publican_creators.rb (Main program)
+    $ revision_creator.rb (The revision updater)
+
+    Or just use the Launcher.
+
+This Gem was programmed and tested on Linux systems. If anyone would like to make the methods also fit for other OS,
+I'm happy about Pull requests.
+
+## REQUIREMENTS:
+
+* nokogiri
+* parseconfig
+* rainbow
+* notifier
+
+## REQUIREMENTS (hard dependencies):
+
+* yad
+* publican (a 4.x version is needed)
+
+## INSTALL:
+
+The installation is very easy.
+
+    gem install publican_creators
+    cd /path/to/gem (In case of using RVM ~/.rvm/gems/ruby-$RUBYVERSION/gems/publican_creators)
+    rake
+
+You have to run the setup after each gem update.
+
+## DEVELOPERS:
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.

data/bin/publican_creators.rb

@@ -1,4 +1,20 @@
 #!/usr/bin/env ruby
+# Copyright (C) 2013-2020 Sascha Manns <Sascha.Manns@outlook.de>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Dependencies
 require 'rubygems'
 require 'publican_creators'
 require 'bundler/setup'

data/bin/revision_creator.rb

@@ -1,9 +1,20 @@
 #!/usr/bin/env ruby
-# @author Sascha Manns
-# @abstract Class RevisionCreator for PublicanCreator
-# Copyright (C) 2015 - 2017 Sascha Manns <Sascha.Manns@mailbox.org>
-# License: GPL-3
+# Copyright (C) 2013-2020 Sascha Manns <Sascha.Manns@outlook.de>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   '../lib/publican_creators', 'revision.rb'))
+# Dependencies
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/publican_creators', 'revision.rb'))
 RevisionCreator.new

data/etc/publicancreators.cfg

@@ -4,7 +4,7 @@ conf_ver = '1'
 
 # Global
 name = 'Sascha Manns'
-email_private = 'samannsml@directbox.com'
+email_private = 'Sascha.Manns@outlook.de'
 
 # Specify your language like de-DE
 language = 'de-DE'
@@ -12,7 +12,7 @@ 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
+# Choose if you like to use a special brand or use the publican default
 use_brand = 'true'
 
 # If you write anything do you would like to use the default titlelogo
@@ -58,7 +58,7 @@ books_dir_priv = "Dokumente/Textdokumente/publican-manns/books"
 # If you would like to use the publican brand just set brand = ''
 brand = 'XCOM'
 company_name = 'XCOM AG'
-company_division = 'SWE7 (Sascha Bochartz)'
+company_division = 'SWE7 (Sascha B)'
 email_business = 'Sascha.Manns@xcom.de'
 
 # System Variables

data/lib/publican_creators.rb

@@ -1,52 +1,51 @@
 #!/usr/bin/env ruby
-# @author Sascha Manns
-# @abstract Main Class for PublicanCreators
+# Copyright (C) 2013-2020 Sascha Manns <Sascha.Manns@outlook.de>
 #
-# Copyright (C) 2015-2017  Sascha Manns <Sascha.Manns@mailbox.org>
-# License: MIT
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 # 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_relative 'publican_creators/checker'
+require_relative 'publican_creators/get'
+require_relative 'publican_creators/change'
+require_relative 'publican_creators/export'
+require_relative 'publican_creators/prepare'
+require_relative 'publican_creators/notifier'
+require_relative 'publican_creators/version'
 require 'fileutils'
 require 'nokogiri'
 require 'rainbow/ext/string'
-require 'bundler/setup'
-require 'manns_shared'
+require 'xdg'
 
 # Main Class of PublicanCreators
 # @return [String] true or false
 class PublicanCreators
-  # Versionizing
-  VERSION = '1.1.1'
-
-  my_name = File.basename($PROGRAM_NAME)
-
-  puts "Script: #{my_name}"
-  puts "Version: #{VERSION}"
+  puts 'publican_creators'.color(:yellow)
+  puts "Version: #{VERSION}".color(:yellow)
   puts
-  puts 'Copyright (C) 2015-2016 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")
+  puts 'Copyright (C) 2015-2020 Sascha Manns <Sascha.Manns@outlook.de>'.color(:yellow)
+  puts 'Description: This script creates a article or book set with'.color(:yellow)
+  puts 'Publican. Then it modifies it for your needs.'.color(:yellow)
+  puts 'License: GPL-3'.color(:yellow)
+  puts 'Bugs: Please file bugs on https://github.com/saigkill/publican_creators/issues'.color(:yellow)
+
+  puts 'Reading the config file in publicancreators.cfg'.color(:yellow)
+  # @note Run config method who reads in the config file and puts the variables in an array
+  # TODO: Try to fix this in future (conf_ver, use_brand)
+  # rubocop:disable Lint/UselessAssignment
+  xdg = XDG::Environment.new
+  sys_xdg = xdg.config_home
+  config = ParseConfig.new("#{sys_xdg}/publican_creators/publicancreators.cfg")
   conf_ver = config['conf_ver']
   name = config['name']
   email = config['email_private']
@@ -70,38 +69,12 @@ class PublicanCreators
   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}"
+  pdf_view = config['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
+  # @note Ask for the title and other settings and put them into a array
   environment, type, opt, title = PublicanCreatorsGet.title
 
   puts "Environment: #{environment}"
@@ -109,36 +82,31 @@ class PublicanCreators
   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
-
+  # @note Sets the default values
   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"
+  art_info = "#{title}/#{language}/Article_Info.xml"
+  book_info = "#{title}/#{language}/Book_Info.xml"
+  rev_hist = "#{title}/#{language}/Revision_History.xml"
+  a_group = "#{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
+  # Run one of the both methods to get the variable targetdir
+  # @param [String] environment Comes from PublicanCreatorsGet.title
+  # @param [String] type Comes from PublicanCreatorsGet.title
   # @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
+  # @param [String] reports_dir_business comes from publicancreators.cfg
+  # @param [String] articles_dir_business comes from publicancreators.cfg
+  # @param [String] books_dir_business comes from publicancreators.cfg
+  # @param [String] articles_dir_private comes from publicancreators.cfg
+  # @param [String] homework true or false
+  # @param [String] homework_dir_private comes from publicancreators.cfg
+  # @param [String] books_dir_private comes from publicancreators.cfg
   targetdir = PublicanCreatorsPrepare.targetdir(environment, type, report,
                                                 reports_dir_business,
                                                 articles_dir_business,
@@ -147,23 +115,21 @@ class PublicanCreators
                                                 homework_dir_private,
                                                 books_dir_private)
 
-  # @note Checks if the needed directory targetdir is available. Otherwise it
-  # creates one.
+  # 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)
+  # @param [String] targetdir comes from PublicanCreatorsPrepare.prepare_work or .prepare_private
+  Checker.check_dir(targetdir)
 
   # @note Change to target directory
   puts 'Change to this directory'
-  # @param [String] targetdir comes from PublicanCreatorsPrepare.prepare_work or
-  # .prepare_private
+  # @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)
+    # This method checks the environment and runs the method for
+    # @param [String] environment Comes from PublicanCreatorsGet.title
+    # @param [String] title Comes from PublicanCreatorsGet.title
+    # @param [String] type Comes from PublicanCreatorsGet.title
+    # @param [String] language Comes from publicancreators.cfg
+    # @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)
@@ -172,62 +138,73 @@ class PublicanCreators
                                              brand, db5, homework,
                                              brand_homework, brand_private)
 
-    # @param [String] title comes from titleget[3]
+    # By working for my employer i'm creating publications which refers to a global entity file.
+    # This method adds the entities from that file into the local one. It returns a success or fail.
     # @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)
+    # @param [String] global_entities path to a global entities file (config file)
+    # @param [String] ent Path to Entityfile
     PublicanCreatorsChange.add_entity(environment, global_entities, ent)
 
+    # In this method the standard-holder from the local entity-file will be replaced with the company_name or if it
+    # is a private work the name of the present user. It returns a sucess or fail.
     # @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)
+    # @param [String] ent Path to Entityfile
     PublicanCreatorsChange.change_holder(title, environment, name, company_name,
                                          ent)
 
-    # @param [String] title comes from titleget[3]
+    # This method removes the XI-Includes for the legal notice. It returns a sucess or fail.
     # @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] art_info Path to Article_Info.xml
+    PublicanCreatorsChange.remove_legal(environment, type, legal, art_info)
 
-    # @param [String] artinfo path to Article_Info (hardcoded)
-    # @param [String] bookinfo path to Book_Info (hardcoded)
+    # Checks if bookinfo or artinfo is needed, then it starts remove_orgname
+    # @param [String] art_info path to Article_Info (hardcoded)
+    # @param [String] book_info 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,
+    PublicanCreatorsChange.remove_orgname_prepare(book_info, art_info, title_logo,
                                                   type)
 
+    # This method splits the name variable into firstname and surname. These variables are setted into the
+    # Revision_History. If the environment is "Work" your email_business will be used, otherwise your private
+    # email_address. It returns a sucess or fail.
     # @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]
+    # @param [String] email private email address (config file)
+    # @param [String] rev_hist Path to Revision_History.xml
     PublicanCreatorsChange.fix_revhist(environment, name, email_business, email,
-                                       revhist)
+                                       rev_hist)
 
-    # @param [String] title comes from titleget[3]
+    # This method replaces the standard values from Author_Group to the present user issues. It will be launched for
+    # the Work environment. It returns a sucess or fail.
     # @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
+    # @param [String] environment Work or Private
+    # @param [String] a_group Path to Author_Group.xml
     PublicanCreatorsChange.fix_authorgroup(name, email_business, company_name,
                                            company_division, email, environment,
-                                           agroup)
+                                           a_group)
 
-    # @param [String] title comes from titleget[3]
+    # Exports a predefined Shellscript to the target directory. It returns a sucess or fail.
+    # @param [String] title comes from PublicanCreatorsGet.title
     # @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)
+    # @param [String] xfc_brand_dir if present the path to your branded xfc stylesheets (config file)
+    # @param [String] pdf_view your prefered PDF-Viewer (config file)
     PublicanCreatorsExport.export_buildscript(title, builds, language,
-                                              xfc_brand_dir, pdfview)
+                                              xfc_brand_dir, pdf_view)
 
-    puts "Now you can find your documentation there: #{targetdir}/#{title}"
+    puts "Now you can find your documentation there: #{targetdir}/#{title}".color(:green)
     Notifier.run
-    puts "Thanks for using: #{my_name} #{VERSION}"
+    puts "Thanks for using: publican_creators #{PublicanCreators::Version::STRING}".color(:green)
   end
 end