publican_creators 1.2.3 → 1.2.5

data/lib/publican_creators/get.rb

@@ -1,75 +1,76 @@
-# 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 'parseconfig'
-require 'xdg'
-
-# 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 https://bugs.launchpad.net/publicancreators: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.tr(' ', '_')
-
-    [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
-    sys_xdg = XDG['CONFIG_HOME']
-    config = ParseConfig.new("#{sys_xdg}/publican_creators/publicancreators.cfg")
-    language = config['language']
-    puts language
-  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 'parseconfig'
+require 'xdg'
+
+# 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 https://bugs.launchpad.net/publicancreators: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.tr(' ', '_')
+
+    [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
+    xdg = XDG::Environment.new
+    sys_xdg = xdg.config_home
+    config = ParseConfig.new("#{sys_xdg}/publican_creators/publicancreators.cfg")
+    language = config['language']
+    puts language
+  end
+end

data/lib/publican_creators/notifier.rb

@@ -1,32 +1,33 @@
-# 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 'notifier'
-require 'xdg'
-
-# Module for notify the user
-module Notifier
-  def self.run
-    data_xdg = XDG['DATA_HOME']
-    install_path = "#{data_xdg}/icons/"
-    img = "#{install_path}/publican.png"
-    Notifier.notify(
-      image: img.to_s,
-      title: 'Your Documentation',
-      message: 'The preparation of your Documentation is finished.'
-    )
-  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 'notifier'
+require 'xdg'
+
+# Module for notify the user
+module Notifier
+  def self.run
+    xdg = XDG::Environment.new
+    data_xdg = xdg.data_home
+    install_path = "#{data_xdg}/icons/"
+    img = "#{install_path}/publican.png"
+    Notifier.notify(
+      image: img.to_s,
+      title: 'Your Documentation',
+      message: 'The preparation of your Documentation is finished.'
+    )
+  end
+end

data/lib/publican_creators/prepare.rb

@@ -1,91 +1,91 @@
-# 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
-
-# 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] environment Work or Private
-  # @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
-    # TODO: Try to fix this in future
-    # rubocop:disable Style/IfInsideElse
-    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] report contains a true or false. There you can set if the
-  #                 new Publication is a Report or not.
-  # @param [String] reports_dir_business contains the directory to your reports
-  # @param [String] articles_dir_bus represents the directory for your articles
-  def self.targetdir_work(report, reports_dir_business, articles_dir_bus)
-    home = Dir.home
-    articles_dir = if report == 'TRUE'
-                     "#{home}/#{reports_dir_business}"
-                   else
-                     "#{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
-    articles_dir = if homework == 'FALSE'
-                     "#{home}/#{articles_dir_private}"
-                   else
-                     "#{home}/#{homework_dir_private}"
-                   end
-    return articles_dir
-  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
+
+# 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] environment Work or Private
+  # @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
+    # TODO: Try to fix this in future
+    # rubocop:disable Style/IfInsideElse
+    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] report contains a true or false. There you can set if the
+  #                 new Publication is a Report or not.
+  # @param [String] reports_dir_business contains the directory to your reports
+  # @param [String] articles_dir_bus represents the directory for your articles
+  def self.targetdir_work(report, reports_dir_business, articles_dir_bus)
+    home = Dir.home
+    articles_dir = if report == 'TRUE'
+                     "#{home}/#{reports_dir_business}"
+                   else
+                     "#{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
+    articles_dir = if homework == 'FALSE'
+                     "#{home}/#{articles_dir_private}"
+                   else
+                     "#{home}/#{homework_dir_private}"
+                   end
+    return articles_dir
+  end
+end

data/lib/publican_creators/revision.rb

@@ -1,56 +1,56 @@
-# 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 'fileutils'
-require 'rainbow/ext/string'
-require_relative 'change'
-require_relative 'get'
-
-# A class for creating a revison to a publican project
-class RevisionCreator
-  # @note Ask for the revision information
-  # rubocop:disable Layout/UselessAssignment
-  null, directory, member1, member2, member3, member4, member5, revnumber = PublicanCreatorsGet.revision
-  language = PublicanCreatorsGet.config_revision
-
-  revision, edition = revnumber.split('-')
-
-  # 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
+# 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 'fileutils'
+require 'rainbow/ext/string'
+require_relative 'change'
+require_relative 'get'
+
+# A class for creating a revison to a publican project
+class RevisionCreator
+  # @note Ask for the revision information
+  # rubocop:disable Layout/UselessAssignment
+  null, directory, member1, member2, member3, member4, member5, revnumber = PublicanCreatorsGet.revision
+  language = PublicanCreatorsGet.config_revision
+
+  revision, edition = revnumber.split('-')
+
+  # 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