publican_creators 1.2.3 → 1.2.5

data/lib/publican_creators.rb

@@ -1,209 +1,210 @@
-#!/usr/bin/env ruby
-# Copyright (C) 2013-2019 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_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 'xdg'
-
-# Main Class of PublicanCreators
-# @return [String] true or false
-class PublicanCreators
-  puts 'publican_creators'.color(:yellow)
-  puts "Version: #{VERSION}".color(:yellow)
-  puts
-  puts 'Copyright (C) 2015-2018 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
-  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']
-  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']
-  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 and put them into a array
-  environment, type, opt, title = PublicanCreatorsGet.title
-
-  puts "Environment: #{environment}"
-  puts "Type: #{type}"
-  puts "Optional: #{opt}"
-  puts "Title: #{title}"
-
-  # @note Sets the default values
-  report = 'FALSE'
-  homework = 'FALSE'
-  report = 'TRUE' if opt == 'Report'
-  homework = 'TRUE' if opt == 'Homework'
-
-  # @note Hardcoded variables
-  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"
-
-  # 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] 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,
-                                                books_dir_business, homework,
-                                                articles_dir_private,
-                                                homework_dir_private,
-                                                books_dir_private)
-
-  # 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
-  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
-  FileUtils.cd(targetdir) do
-    # 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)
-    # @param [String] brand_private e.g. manns (config file)
-    PublicanCreatorsChange.check_environment(environment, title, type, language,
-                                             brand, db5, homework,
-                                             brand_homework, brand_private)
-
-    # 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] 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)
-
-    # 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)
-    # @param [String] art_info Path to Article_Info.xml
-    PublicanCreatorsChange.remove_legal(environment, type, legal, art_info)
-
-    # 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(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] email private email address (config file)
-    # @param [String] rev_hist Path to Revision_History.xml
-    PublicanCreatorsChange.fix_revhist(environment, name, email_business, email,
-                                       rev_hist)
-
-    # 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,
-                                           a_group)
-
-    # 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] pdf_view your prefered PDF-Viewer (config file)
-    PublicanCreatorsExport.export_buildscript(title, builds, language,
-                                              xfc_brand_dir, pdf_view)
-
-    puts "Now you can find your documentation there: #{targetdir}/#{title}".color(:green)
-    Notifier.run
-    puts "Thanks for using: publican_creators #{PublicanCreators::Version::STRING}".color(:green)
-  end
-end
+#!/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_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 'xdg'
+
+# Main Class of PublicanCreators
+# @return [String] true or false
+class PublicanCreators
+  puts 'publican_creators'.color(:yellow)
+  puts "Version: #{VERSION}".color(:yellow)
+  puts
+  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']
+  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']
+  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 and put them into a array
+  environment, type, opt, title = PublicanCreatorsGet.title
+
+  puts "Environment: #{environment}"
+  puts "Type: #{type}"
+  puts "Optional: #{opt}"
+  puts "Title: #{title}"
+
+  # @note Sets the default values
+  report = 'FALSE'
+  homework = 'FALSE'
+  report = 'TRUE' if opt == 'Report'
+  homework = 'TRUE' if opt == 'Homework'
+
+  # @note Hardcoded variables
+  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"
+
+  # 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] 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,
+                                                books_dir_business, homework,
+                                                articles_dir_private,
+                                                homework_dir_private,
+                                                books_dir_private)
+
+  # 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
+  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
+  FileUtils.cd(targetdir) do
+    # 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)
+    # @param [String] brand_private e.g. manns (config file)
+    PublicanCreatorsChange.check_environment(environment, title, type, language,
+                                             brand, db5, homework,
+                                             brand_homework, brand_private)
+
+    # 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] 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)
+
+    # 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)
+    # @param [String] art_info Path to Article_Info.xml
+    PublicanCreatorsChange.remove_legal(environment, type, legal, art_info)
+
+    # 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(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] email private email address (config file)
+    # @param [String] rev_hist Path to Revision_History.xml
+    PublicanCreatorsChange.fix_revhist(environment, name, email_business, email,
+                                       rev_hist)
+
+    # 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,
+                                           a_group)
+
+    # 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] pdf_view your prefered PDF-Viewer (config file)
+    PublicanCreatorsExport.export_buildscript(title, builds, language,
+                                              xfc_brand_dir, pdf_view)
+
+    puts "Now you can find your documentation there: #{targetdir}/#{title}".color(:green)
+    Notifier.run
+    puts "Thanks for using: publican_creators #{PublicanCreators::Version::STRING}".color(:green)
+  end
+end

data/lib/publican_creators/change.rb

@@ -1,287 +1,287 @@
-# Copyright (C) 2013-2019 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 'nokogiri'
-require_relative 'create'
-require_relative 'checker'
-
-# Module what contains all methods who are doing changes in files
-module PublicanCreatorsChange
-  # Method for replacing content in agroup
-  # @param [String] nice_description is the default text in the target file
-  # @param [String] value_name the replace text
-  # @param [String] file Target file like Author_Group.xml
-  # @return [String] true or false
-  def self.add_result(nice_description, value_name, file)
-    text = File.read(file)
-    new_value = text.gsub(nice_description, value_name)
-    puts new_value
-    File.open(file, 'w') do |file1|
-      file1.puts new_value
-    end
-  end
-
-  # This method checks the environment and runs the method for
-  # @param [String] environment   shows if you actually want to create a private or Business Publication. If Work is
-  #                               given it reads your global entity file and appends it on the ent file.
-  # @param [String] title         comes from the get method. This param represents the name or title of your work. It
-  #                               is used in all important code places.
-  # @param [String] type          represents the Document-Type like Article or Book.
-  # @param [String] language      is just the ISO Code of your target language like: de-DE, en-GB or such things.
-  # @param [String] brand         can be a special customized brand for your company to fit the styleguide.
-  # @param [String] db5           just sets your preferences.
-  # @param [String] brand_homework can be a special customized brand for distance learning schools.
-  # @param [String] brand_private is used in all methods with a "private" in the name. If this brand is set it will
-  #                               be used instead of the original publican brand.
-  # @param [String] homework      if homework is set
-  # @return [String] true or false
-  def self.check_environment(environment, title, type, language, brand, db5, homework, brand_homework, brand_private)
-    if environment == 'Work'
-      PublicanCreatorsCreate.init_docu_work(title, type, language, brand, db5)
-    else
-      PublicanCreatorsCreate.init_docu_private(title, type, homework, language, brand_homework, brand_private, db5)
-    end
-  end
-
-  # 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   shows if you actually want to create a private or Business Publication. If Work
-  #                               is given it reads your global entity file and appends it on the ent file.
-  # @param [String] global_entities is just the path to the global entity file.
-  # @param [String] ent Path to the entity file
-  # @return [String] true or false
-  def self.add_entity(environment, global_entities, ent)
-    if environment == 'Work'
-      if global_entities.empty?
-        puts 'Nothing to do'
-      else
-        puts 'Adding global entities...'
-        # @note Adding global entities
-        open(ent, 'a') do |add|
-          add << "\n"
-          add << "<!-- COMMON ENTITIES -->\n"
-        end
-        input = File.open(global_entities)
-        data_to_copy = input.read
-        output = File.open(ent, 'a')
-        output.write(data_to_copy)
-        input.close
-        output.close
-      end
-    else
-      puts 'Nothing to do'
-    end
-  end
-
-  # 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.
-  # @note If the environment "Work" is given the entity file will be set as HOLDER otherwise it sets your name.
-  # @param [String] title comes from the get method.
-  # @param [String] environment shows if you actually want to create a private
-  #                 or Business Publication. If Work is given it reads your
-  #                 global entity file and appends it on the ent file.
-  # @param [String] name is your name.
-  # @param [String] company_name is the name of your company
-  # @param [String] ent Path to the entity file
-  # @return [String] true or false
-  def self.change_holder(title, environment, name, company_name, ent)
-    # @note Replace the Holder with the real one
-    puts 'Replace holder field with the present user'
-    namefill = if environment == 'Work'
-                 company_name.to_s
-               else
-                 name.to_s
-               end
-    change_holder_do(namefill, title, ent)
-  end
-
-  # This method does the changes
-  # @param [String] namefill can be the name or the company_name depends on
-  #                 environment
-  # @param [String] title comes from the get method. This @param represents the
-  #                 name or title of your work. It is used in all important code
-  #                 places.
-  # @param [String] ent Path to the entity file
-  # @return [String] true or false
-  def self.change_holder_do(namefill, title, ent)
-    text = File.read(ent)
-    new_contents = text.gsub("| You need to change the HOLDER entity in the de-DE/#{title}.ent file |", namefill.to_s)
-    puts new_contents
-    File.open(ent, 'w') { |file| file.puts new_contents }
-  end
-
-  # This method removes the <orgname> node from the XML file. Remove titlepage logo because of doing this with the
-  # publican branding files. This method will applied if environment is Work, "type" is Article and title_logo is
-  # "false". It returns a sucess or fail.
-  # TODO: Try to fix this in future
-  # rubocop:disable Style/GuardClause
-  # @param [String] info        can be bookinfo or artinfo
-  # @param [String] title_logo  means that you can set if you want to use Publican's Title Logo or use your own Title
-  #                             Logo with your Stylesheets.
-  # @return [String] true or false
-  def self.remove_orgname(info, title_logo)
-    if title_logo == 'false'
-      puts 'Remove title logo from Article_Info or Books_Info'
-      puts info
-      doc = Nokogiri::XML(IO.read(info))
-      doc.search('orgname').each do |node|
-        node.remove
-        node.content = 'Children removed'
-      end
-      IO.write(info, doc.to_xml)
-    end
-  end
-
-  # Checks if bookinfo or artinfo is needed, then it starts remove_orgname
-  # @param [String] bookinfo    Book_Info. Which is used there depends on the param "type".
-  # @param [String] artinfo     Article_Info. Which is used there depends on the param "type".
-  # @param [String] title_logo  means that you can set if you want to use Publican's Title Logo or use your
-  #                             own Title Logo with your Stylesheets.
-  # @param [String] type        represents the Document-Type like Article or Book.
-  def self.remove_orgname_prepare(bookinfo, artinfo, title_logo, type)
-    info = artinfo if type == 'Article'
-    info = bookinfo if type == 'Book'
-    remove_orgname(info, title_logo)
-  end
-
-  # This method replaces the old productversion to the new revision
-  # @param [String] language The default language from the config file
-  # @param [String] revision The new revision number
-  # @param [String] edition The new edition number
-  # @return [String] true or false
-  def self.replace_productnumber(revision, edition, language)
-    puts 'Replacing the productnumber'
-    info = if File.exist?("#{language}/Article_Info.xml")
-             "#{language}/Article_Info.xml"
-           else
-             "#{language}/Book_Info.xml"
-           end
-    doc = Nokogiri::XML(IO.read(info))
-    doc.search('productnumber').each do |node|
-      node.content = revision.to_s
-    end
-    doc.search('edition').each do |node|
-      node.content = edition.to_s
-    end
-    IO.write(info, doc.to_xml)
-  end
-
-  # This method removes the XI-Includes for the legal notice. It returns a sucess or fail.
-  # @param [String] environment shows if you actually want to create a private or Business Publication. If Work is
-  #                             given it reads your global entity file and appends it on the ent file.
-  # @param [String] type        represents the Document-Type like Article or Book.
-  # @param [String] legal       means if you don't like to have a Legal Notice on Publican's default place you can
-  #                             define it there. Actually it just works with Articles. In my case i'm using the
-  #                             Legal Notice inside the Article's Structure.
-  # @param [String] artinfo     Article_Info. Which is used there depends on the param "type".
-  # @return [String] true or false
-  def self.remove_legal(environment, type, legal, artinfo)
-    if environment == 'Work'
-      if type == 'Article'
-        if legal == 'true'
-          # @note Remove the Legal Notice XI-Include in case it is an article.
-          # XCOM articles using another way to add them.
-          puts 'Remove XI-Includes for Legal Notice...'
-          text = File.read(artinfo)
-          # rubocop:disable Metrics/LineLength
-          new_contents = text.gsub('<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />', '')
-          puts new_contents
-          File.open(artinfo, 'w') { |file| file.puts new_contents }
-        end
-      else
-        puts 'Nothing to do'
-      end
-    else
-      puts 'Nothing to do'
-    end
-  end
-
-  # 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] revhist     Path to the Revision_History
-  # @param [String] environment shows if you actually want to create a private or Business Publication. If Work is
-  #                             given it reads your global entity file and appends it on the ent file.
-  # @param [String] name        is your name.
-  # @param [String] email_business is your business email address.
-  # @param [String] email       is your private email address.
-  # @return [String] true or false
-  def self.fix_revhist(environment, name, email_business, email, revhist)
-    firstname, surname = get_name(name)
-    # @note Revision_History: Change default stuff to the present user
-    puts 'Replace the default content with the new content from the user
-(Revision History)'
-    add_result('Enter your first name here.', firstname.to_s, revhist)
-    add_result('Enter your surname here.', surname.to_s, revhist)
-    add_result('Initial creation by publican', 'Initial creation', revhist)
-
-    if environment == 'Work'
-      add_result('Enter your email address here.', email_business.to_s, revhist)
-    else
-      add_result('Enter your email address here.', email.to_s, revhist)
-    end
-  end
-
-  # 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.
-  # TODO: Try to fix this in future
-  # rubocop:disable Metrics/AbcSize
-  # @param [String] name is your name.
-  # @param [String] email_business is your business email address.
-  # @param [String] company_name is just your companies name.
-  # @param [String] company_division is your companies part/division.
-  # @param [String] email is your private email address.
-  # @param [String] environment shows if you actually want to create a private
-  #                 or Business Publication. If Work is given it reads your
-  #                 global entity file and appends it on the ent file.
-  # @param [String] agroup Path to Author_Group.xml
-  # @return [String] true or false
-  def self.fix_authorgroup(name, email_business, company_name, company_division,
-                           email, environment, agroup)
-    firstname, surname = get_name(name)
-    # @note Author Group: Change the default stuff to the present user
-    puts 'Replace the default content with the new content from the user
-(Authors_Group)'
-    add_result('Enter your first name here.', firstname.to_s, agroup)
-    add_result('Enter your surname here.', surname.to_s, agroup)
-    add_result('Initial creation by publican', 'Initial creation', agroup)
-
-    if environment == 'Work'
-      add_result('Enter your email address here.', email_business.to_s, agroup)
-      add_result('Enter your organisation\'s name here.', company_name.to_s,
-                 agroup)
-      add_result('Enter your organisational division here.',
-                 company_division.to_s, agroup)
-    else
-      add_result('Enter your email address here.', email.to_s, agroup)
-      add_result('Enter your organisation\'s name here.', '', agroup)
-      add_result('Enter your organisational division here.', '', agroup)
-    end
-  end
-
-  # Method for splitting the name variable into firstname and surname
-  # @param [String] name The name from config file
-  # @return [String] true or false
-  def self.get_name(name)
-    namechomp = name.chomp
-    # @note Split the variable to the array title[*]
-    name = namechomp.split(' ')
-    firstname = name[0]
-    surname = name[1]
-    [firstname, surname]
-  end
-end
+# 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 'nokogiri'
+require_relative 'create'
+require_relative 'checker'
+
+# Module what contains all methods who are doing changes in files
+module PublicanCreatorsChange
+  # Method for replacing content in agroup
+  # @param [String] nice_description is the default text in the target file
+  # @param [String] value_name the replace text
+  # @param [String] file Target file like Author_Group.xml
+  # @return [String] true or false
+  def self.add_result(nice_description, value_name, file)
+    text = File.read(file)
+    new_value = text.gsub(nice_description, value_name)
+    puts new_value
+    File.open(file, 'w') do |file1|
+      file1.puts new_value
+    end
+  end
+
+  # This method checks the environment and runs the method for
+  # @param [String] environment   shows if you actually want to create a private or Business Publication. If Work is
+  #                               given it reads your global entity file and appends it on the ent file.
+  # @param [String] title         comes from the get method. This param represents the name or title of your work. It
+  #                               is used in all important code places.
+  # @param [String] type          represents the Document-Type like Article or Book.
+  # @param [String] language      is just the ISO Code of your target language like: de-DE, en-GB or such things.
+  # @param [String] brand         can be a special customized brand for your company to fit the styleguide.
+  # @param [String] db5           just sets your preferences.
+  # @param [String] brand_homework can be a special customized brand for distance learning schools.
+  # @param [String] brand_private is used in all methods with a "private" in the name. If this brand is set it will
+  #                               be used instead of the original publican brand.
+  # @param [String] homework      if homework is set
+  # @return [String] true or false
+  def self.check_environment(environment, title, type, language, brand, db5, homework, brand_homework, brand_private)
+    if environment == 'Work'
+      PublicanCreatorsCreate.init_docu_work(title, type, language, brand, db5)
+    else
+      PublicanCreatorsCreate.init_docu_private(title, type, homework, language, brand_homework, brand_private, db5)
+    end
+  end
+
+  # 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   shows if you actually want to create a private or Business Publication. If Work
+  #                               is given it reads your global entity file and appends it on the ent file.
+  # @param [String] global_entities is just the path to the global entity file.
+  # @param [String] ent Path to the entity file
+  # @return [String] true or false
+  def self.add_entity(environment, global_entities, ent)
+    if environment == 'Work'
+      if global_entities.empty?
+        puts 'Nothing to do'
+      else
+        puts 'Adding global entities...'
+        # @note Adding global entities
+        open(ent, 'a') do |add|
+          add << "\n"
+          add << "<!-- COMMON ENTITIES -->\n"
+        end
+        input = File.open(global_entities)
+        data_to_copy = input.read
+        output = File.open(ent, 'a')
+        output.write(data_to_copy)
+        input.close
+        output.close
+      end
+    else
+      puts 'Nothing to do'
+    end
+  end
+
+  # 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.
+  # @note If the environment "Work" is given the entity file will be set as HOLDER otherwise it sets your name.
+  # @param [String] title comes from the get method.
+  # @param [String] environment shows if you actually want to create a private
+  #                 or Business Publication. If Work is given it reads your
+  #                 global entity file and appends it on the ent file.
+  # @param [String] name is your name.
+  # @param [String] company_name is the name of your company
+  # @param [String] ent Path to the entity file
+  # @return [String] true or false
+  def self.change_holder(title, environment, name, company_name, ent)
+    # @note Replace the Holder with the real one
+    puts 'Replace holder field with the present user'
+    namefill = if environment == 'Work'
+                 company_name.to_s
+               else
+                 name.to_s
+               end
+    change_holder_do(namefill, title, ent)
+  end
+
+  # This method does the changes
+  # @param [String] namefill can be the name or the company_name depends on
+  #                 environment
+  # @param [String] title comes from the get method. This @param represents the
+  #                 name or title of your work. It is used in all important code
+  #                 places.
+  # @param [String] ent Path to the entity file
+  # @return [String] true or false
+  def self.change_holder_do(namefill, title, ent)
+    text = File.read(ent)
+    new_contents = text.gsub("| You need to change the HOLDER entity in the de-DE/#{title}.ent file |", namefill.to_s)
+    puts new_contents
+    File.open(ent, 'w') { |file| file.puts new_contents }
+  end
+
+  # This method removes the <orgname> node from the XML file. Remove titlepage logo because of doing this with the
+  # publican branding files. This method will applied if environment is Work, "type" is Article and title_logo is
+  # "false". It returns a sucess or fail.
+  # TODO: Try to fix this in future
+  # rubocop:disable Style/GuardClause
+  # @param [String] info        can be bookinfo or artinfo
+  # @param [String] title_logo  means that you can set if you want to use Publican's Title Logo or use your own Title
+  #                             Logo with your Stylesheets.
+  # @return [String] true or false
+  def self.remove_orgname(info, title_logo)
+    if title_logo == 'false'
+      puts 'Remove title logo from Article_Info or Books_Info'
+      puts info
+      doc = Nokogiri::XML(IO.read(info))
+      doc.search('orgname').each do |node|
+        node.remove
+        node.content = 'Children removed'
+      end
+      IO.write(info, doc.to_xml)
+    end
+  end
+
+  # Checks if bookinfo or artinfo is needed, then it starts remove_orgname
+  # @param [String] bookinfo    Book_Info. Which is used there depends on the param "type".
+  # @param [String] artinfo     Article_Info. Which is used there depends on the param "type".
+  # @param [String] title_logo  means that you can set if you want to use Publican's Title Logo or use your
+  #                             own Title Logo with your Stylesheets.
+  # @param [String] type        represents the Document-Type like Article or Book.
+  def self.remove_orgname_prepare(bookinfo, artinfo, title_logo, type)
+    info = artinfo if type == 'Article'
+    info = bookinfo if type == 'Book'
+    remove_orgname(info, title_logo)
+  end
+
+  # This method replaces the old productversion to the new revision
+  # @param [String] language The default language from the config file
+  # @param [String] revision The new revision number
+  # @param [String] edition The new edition number
+  # @return [String] true or false
+  def self.replace_productnumber(revision, edition, language)
+    puts 'Replacing the productnumber'
+    info = if File.exist?("#{language}/Article_Info.xml")
+             "#{language}/Article_Info.xml"
+           else
+             "#{language}/Book_Info.xml"
+           end
+    doc = Nokogiri::XML(IO.read(info))
+    doc.search('productnumber').each do |node|
+      node.content = revision.to_s
+    end
+    doc.search('edition').each do |node|
+      node.content = edition.to_s
+    end
+    IO.write(info, doc.to_xml)
+  end
+
+  # This method removes the XI-Includes for the legal notice. It returns a sucess or fail.
+  # @param [String] environment shows if you actually want to create a private or Business Publication. If Work is
+  #                             given it reads your global entity file and appends it on the ent file.
+  # @param [String] type        represents the Document-Type like Article or Book.
+  # @param [String] legal       means if you don't like to have a Legal Notice on Publican's default place you can
+  #                             define it there. Actually it just works with Articles. In my case i'm using the
+  #                             Legal Notice inside the Article's Structure.
+  # @param [String] artinfo     Article_Info. Which is used there depends on the param "type".
+  # @return [String] true or false
+  def self.remove_legal(environment, type, legal, artinfo)
+    if environment == 'Work'
+      if type == 'Article'
+        if legal == 'true'
+          # @note Remove the Legal Notice XI-Include in case it is an article.
+          # XCOM articles using another way to add them.
+          puts 'Remove XI-Includes for Legal Notice...'
+          text = File.read(artinfo)
+          # rubocop:disable Metrics/LineLength
+          new_contents = text.gsub('<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />', '')
+          puts new_contents
+          File.open(artinfo, 'w') { |file| file.puts new_contents }
+        end
+      else
+        puts 'Nothing to do'
+      end
+    else
+      puts 'Nothing to do'
+    end
+  end
+
+  # 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] revhist     Path to the Revision_History
+  # @param [String] environment shows if you actually want to create a private or Business Publication. If Work is
+  #                             given it reads your global entity file and appends it on the ent file.
+  # @param [String] name        is your name.
+  # @param [String] email_business is your business email address.
+  # @param [String] email       is your private email address.
+  # @return [String] true or false
+  def self.fix_revhist(environment, name, email_business, email, revhist)
+    firstname, surname = get_name(name)
+    # @note Revision_History: Change default stuff to the present user
+    puts 'Replace the default content with the new content from the user
+(Revision History)'
+    add_result('Enter your first name here.', firstname.to_s, revhist)
+    add_result('Enter your surname here.', surname.to_s, revhist)
+    add_result('Initial creation by publican', 'Initial creation', revhist)
+
+    if environment == 'Work'
+      add_result('Enter your email address here.', email_business.to_s, revhist)
+    else
+      add_result('Enter your email address here.', email.to_s, revhist)
+    end
+  end
+
+  # 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.
+  # TODO: Try to fix this in future
+  # rubocop:disable Metrics/AbcSize
+  # @param [String] name is your name.
+  # @param [String] email_business is your business email address.
+  # @param [String] company_name is just your companies name.
+  # @param [String] company_division is your companies part/division.
+  # @param [String] email is your private email address.
+  # @param [String] environment shows if you actually want to create a private
+  #                 or Business Publication. If Work is given it reads your
+  #                 global entity file and appends it on the ent file.
+  # @param [String] agroup Path to Author_Group.xml
+  # @return [String] true or false
+  def self.fix_authorgroup(name, email_business, company_name, company_division,
+                           email, environment, agroup)
+    firstname, surname = get_name(name)
+    # @note Author Group: Change the default stuff to the present user
+    puts 'Replace the default content with the new content from the user
+(Authors_Group)'
+    add_result('Enter your first name here.', firstname.to_s, agroup)
+    add_result('Enter your surname here.', surname.to_s, agroup)
+    add_result('Initial creation by publican', 'Initial creation', agroup)
+
+    if environment == 'Work'
+      add_result('Enter your email address here.', email_business.to_s, agroup)
+      add_result('Enter your organisation\'s name here.', company_name.to_s,
+                 agroup)
+      add_result('Enter your organisational division here.',
+                 company_division.to_s, agroup)
+    else
+      add_result('Enter your email address here.', email.to_s, agroup)
+      add_result('Enter your organisation\'s name here.', '', agroup)
+      add_result('Enter your organisational division here.', '', agroup)
+    end
+  end
+
+  # Method for splitting the name variable into firstname and surname
+  # @param [String] name The name from config file
+  # @return [String] true or false
+  def self.get_name(name)
+    namechomp = name.chomp
+    # @note Split the variable to the array title[*]
+    name = namechomp.split(' ')
+    firstname = name[0]
+    surname = name[1]
+    [firstname, surname]
+  end
+end