publican_creators 1.1.2 → 1.2.0

data/lib/publican_creators/checker.rb

@@ -1,9 +1,17 @@
-# PublicanCreatorsChecker
-# @author Sascha Manns
-# @abstract Class for checking directories and creating them
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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
 
@@ -18,6 +26,8 @@ module Checker
   # @return [String] true or false
   def self.check_dir(todos)
     # @note Checking if dir exists
+    # TODO: Try to fix this in future
+    # rubocop:disable Style/GuardClause
     if Dir.exist?(todos)
       puts 'Found directory. Im using it.'
     else
@@ -27,7 +37,7 @@ module Checker
       if Dir.exist?(todos)
         puts 'Created new directory...'
       else
-        fail('Cant create directory')
+        raise('Cant create directory')
       end
     end
   end
@@ -42,7 +52,7 @@ module Checker
     if Dir.exist?(title)
       puts 'Creating documentation was a success...'
     else
-      fail('Cant create documentation. Please try it manual with publican...')
+      raise('Cant create documentation. Please try it manual with publican...')
     end
   end
 end

data/lib/publican_creators/create.rb

@@ -1,14 +1,21 @@
-# Create Module for PublicanCreators
-# PublicanCreatorsChange
-# @author Sascha Manns
-# @abstract Class for all file changes
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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 'nokogiri'
-require 'publican_creators/checker'
+require_relative 'checker'
 
 # Class for creating stuff
 class PublicanCreatorsCreate
@@ -51,6 +58,7 @@ class PublicanCreatorsCreate
   #                       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] homework can be true or false
   # @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.
@@ -65,8 +73,7 @@ class PublicanCreatorsCreate
   # the method it starts another method "PublicanCreatorsChange.check_result".
   # This method checks if the directory with the content of the parameter title
   # is available.
-  def self.init_docu_private(title, type, homework, language, brand_homework,
-      brand_private, db5)
+  def self.init_docu_private(title, type, homework, language, brand_homework, brand_private, db5)
     puts 'Creating initial documentation ...'
 
     if type == 'Article'
@@ -95,8 +102,7 @@ class PublicanCreatorsCreate
   # @param [String] brand_homework can be a special customized brand for
   #                       distance learning schools.
   # @param [String] homework true if homework set
-  def self.private_article(language, title, brand_private, brand_homework,
-      homework)
+  def self.private_article(language, title, brand_private, brand_homework, homework)
     # @note Initial creation of documentation with publican
     string = "--type Article --lang #{language} --name #{title}"
     # Use brand_private if brand_private is set

data/lib/publican_creators/export.rb

@@ -1,17 +1,23 @@
-# PublicanCreatorsExport
-# @author Sascha Manns
-# @abstract Class for exporting bash scripts
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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/change'
+require_relative 'change'
 require 'fileutils'
 require 'rainbow/ext/string'
-
-# rubocop:disable Metrics/MethodLength
 # Module for running exports to a file
 module PublicanCreatorsExport
   # Exports a predefined Shellscript to the target directory.
@@ -29,9 +35,9 @@ module PublicanCreatorsExport
   # @return [String] true or false
   def self.export_buildscript(title, builds, language, xfc_brand_dir, pdfview)
     puts 'Export the buildscript into new directory...'
-    FileUtils.touch "#{builds}"
-    # rubocop:disable Metrics/LineLength
-    File.write "#{builds}", <<EOF
+    FileUtils.touch builds.to_s
+    # rubocop:disable Layout/IndentHeredoc
+    File.write builds.to_s, <<BUILDSCRIPT
 # -*- ruby -*-
 # encoding: utf-8
 require 'fileutils'
@@ -225,6 +231,6 @@ desc 'Run convert to all formats'
 task :export_all => [:export_most, :export_wml, :export_man, :export_txt, :export_epub, :export_eclipse] do
   puts 'Successfull exported to all formats'
 end
-EOF
+BUILDSCRIPT
   end
 end

data/lib/publican_creators/get.rb

@@ -1,13 +1,22 @@
-# PublicanCreatorsGet
-# @author Sascha Manns
-# @abstract Class for gathering information from config file and user input
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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 'parseconfig'
+require 'xdg'
 
 # This method provides methods for user inputs
 module PublicanCreatorsGet
@@ -21,14 +30,14 @@ module PublicanCreatorsGet
 --field="Type:CBE" --field="Optional:CBE" --field="Enter a title name \
 (with underscores instead of blanks and without umlauts):TEXT" \
 --field="Please file bugs or feature requests \
-on http://saigkill-bugs.myjetbrains.com/youtrack/:LBL" --button="Go!" "Work,Private" \
+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.gsub(/ /, '_')
+    title = titlefix.tr(' ', '_')
 
     [environment, type, opt, title]
   end
@@ -58,8 +67,8 @@ entering Revision textes with blanks.:LBL" --button="Go!"`
   # @return [String] language
   def self.config_revision
     include ParseConfig
-    home = Dir.home
-    config = ParseConfig.new("#{home}/.publican_creators/publicancreators.cfg")
+    sys_xdg = XDG['CONFIG_HOME']
+    config = ParseConfig.new("#{sys_xdg}/publican_creators/publicancreators.cfg")
     language = config['language']
     puts language
   end

data/lib/publican_creators/notifier.rb

@@ -1,26 +1,32 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# @author Sascha Manns
-# @abstract Notifier Module for latex_curriculum_vitae
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# Copyright (C) 2015-2016  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
-
-# Module for notify the user
 require 'notifier'
+require 'xdg'
 
+# Module for notify the user
 module Notifier
   def self.run
-    home = Dir.home
-    prefix = "#{home}/.rvm/rubies/default"
-    datadir = "#{prefix}/share"
-    img = "#{datadir}/.publican_creators/publican.png"
+    data_xdg = XDG['DATA_HOME']
+    install_path = "#{data_xdg}/icons/"
+    img = "#{install_path}/publican.png"
     Notifier.notify(
-        :image => "#{img}",
-        :title => "Your Documentation",
-        :message => "The preparation of your Documentation is finished."
+      image: img.to_s,
+      title: 'Your Documentation',
+      message: 'The preparation of your Documentation is finished.'
     )
   end
-end
+end

data/lib/publican_creators/prepare.rb

@@ -1,9 +1,17 @@
-# PublicanCreatorsPrepare
-# @author Sascha Manns
-# @abstract Class for preparing the configuration
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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
 
@@ -11,6 +19,7 @@
 # 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
@@ -27,9 +36,11 @@ module PublicanCreatorsPrepare
   #                 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)
+                     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)
@@ -39,8 +50,7 @@ module PublicanCreatorsPrepare
       end
     else
       if type == 'Article'
-        targetdir_private(homework, articles_dir_private,
-                          homework_dir_private)
+        targetdir_private(homework, articles_dir_private, homework_dir_private)
       else
         books_dir = "#{home}/#{books_dir_private}"
         return books_dir
@@ -49,17 +59,17 @@ module PublicanCreatorsPrepare
   end
 
   # Prepares the articles_dir for work environment
-  # @param [String] reports_dir_business contains the directory to your reports
-  # @param [String] articles_dir_bus represents the directory for your articles
   # @param [String] report contains a true or false. There you can set if the
   #                 new Publication is a Report or not.
+  # @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
-    if report == 'TRUE'
-      articles_dir = "#{home}/#{reports_dir_business}"
-    else
-      articles_dir = "#{home}/#{articles_dir_bus}"
-    end
+    articles_dir = if report == 'TRUE'
+                     "#{home}/#{reports_dir_business}"
+                   else
+                     "#{home}/#{articles_dir_bus}"
+                   end
     return articles_dir
   end
 
@@ -69,14 +79,13 @@ module PublicanCreatorsPrepare
   # @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)
+  def self.targetdir_private(homework, articles_dir_private, homework_dir_private)
     home = Dir.home
-    if homework == 'FALSE'
-      articles_dir = "#{home}/#{articles_dir_private}"
-    else
-      articles_dir = "#{home}/#{homework_dir_private}"
-    end
+    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,36 +1,33 @@
-# @author Sascha Manns
-# @abstract Class RevisionCreator for PublicanCreator
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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 'fileutils'
 require 'rainbow/ext/string'
-require File.expand_path(File.join(File.dirname(__FILE__), 'change.rb'))
-require File.expand_path(File.join(File.dirname(__FILE__), 'get.rb'))
+require_relative 'change'
+require_relative 'get'
 
 # A class for creating a revison to a publican project
 class RevisionCreator
   # @note Ask for the revision information
-  null, directory, member1, member2, member3, member4, member5,
-      revnumber = PublicanCreatorsGet.revision
+  # rubocop:disable Layout/UselessAssignment
+  null, directory, member1, member2, member3, member4, member5, revnumber = PublicanCreatorsGet.revision
   language = PublicanCreatorsGet.config_revision
 
   revision, edition = revnumber.split('-')
 
-  puts "Directory: #{directory}"
-  puts "Member1: #{member1}"
-  puts "Member2: #{member2}"
-  puts "Member3: #{member3}"
-  puts "Member4: #{member4}"
-  puts "Member5: #{member5}"
-  puts "Language: #{language}"
-  puts "Revnumber: #{revnumber}"
-  puts "Revision: #{revision}"
-  puts "Edition: #{edition}"
-  puts null
-
   # This method prepares the string for adding a new revision
   # @param [String] member1 is the first string into revdescription
   # @param [String] member2 is the second string into revdescription
@@ -40,8 +37,7 @@ class RevisionCreator
   # @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)
+  def self.prepare_revision(member1, member2, member3, member4, member5, revnumber, language)
     string = "--member \"#{member1}\""
     string << " --member \"#{member2}\"" if member2 != ''
     string << " --member \"#{member3}\"" if member3 != ''
@@ -53,8 +49,7 @@ class RevisionCreator
 
   # This method changes to the target directory
   FileUtils.cd(directory) do
-    string = prepare_revision(member1, member2, member3, member4, member5,
-                              revnumber, language)
+    string = prepare_revision(member1, member2, member3, member4, member5, revnumber, language)
     PublicanCreatorsChange.replace_productnumber(revision, edition, language)
     system("publican add_revision #{string}")
   end

data/lib/publican_creators/testlib.rb

@@ -1,10 +1,17 @@
-# Testing Module for PublicanCreators
-# PublicanCreatorsChange
-# @author Sascha Manns
-# @abstract Class for all file changes
+# Copyright (C) 2013-2017 Sascha Manns <Sascha.Manns@mailbox.org>
 #
-# 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 'fileutils'