latex_curriculum_vitae 2.0.0 → 2.1.0

data/lib/latex_curriculum_vitae/entityfile.rb

@@ -1,10 +1,17 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# @author Sascha Manns
-# @abstract module for creating the entity file for latex
-#
 # 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'
@@ -15,11 +22,12 @@ require 'url_shortener'
 module LatexCurriculumVitae
   # Module for creating the entityfile
   module Entityfile
+    # TODO: Try to fix this in future
     # rubocop:disable Metrics/LineLength
     # Method for getting information
-    # @param [String] entitytex Path to the entity.tex
-    # @return [Array] contact, emailaddress, jobtitle, contact_sex, company, proactive, job_url
-    def self.get_information(entitytex)
+    # @param [String] entity_tex Path to the entity.tex
+    # @return [Array] contact, email_address, job_title, contact_sex, company, proactive, job_url
+    def self.get_information(entity_tex)
       resume = `yad --title="Create application" --center --on-top --form --item-separator=, --separator="|" \
 --field="What is the jobtitle of your application? Escape amp with backslash:TEXT" \
 --field="Is it a proactive application?:CBE" \
@@ -33,123 +41,146 @@ module LatexCurriculumVitae
 --field="What kind of target:CBE" \
 --field="Tell me the URL of the job offer:TEXT" \
 --button="Go!" "" "no,yes" "yes,no" "" "" "" "male,female,unknown" "" "" "doku,support,kaufm"`
-      jobtitle, proactive, letter, company, street, city, contact_sex, contact, emailaddress, target, job_url = resume.chomp.split('|')
-      [jobtitle, proactive, letter, company, street, city, contact_sex, contact, emailaddress, target, job_url].each do |s|
-        puts s
-      end
+      job_title, proactive, letter, company, street, city, contact_sex, contact, email_address,
+          target, job_url = resume.chomp.split('|')
 
-      create_file(jobtitle, company, street, city, contact, entitytex, contact_sex, proactive, target)
-      [contact, emailaddress, jobtitle, contact_sex, company, letter, proactive, job_url]
+      create_file(job_title, company, street, city, contact, entity_tex, contact_sex, proactive, target)
+      [contact, email_address, job_title, contact_sex, company, letter, proactive, job_url, target]
     end
 
     # Method for shorten the URL
     # @param [String] job_url The Url to the job offer
-    # @param [String] bitly_user The Username in Bit.ly
-    # @param [String] bitly_apikey The Apikey from your Bit.ly User
-    # @return [String] joburl Returns the shortened Bit.ly URL
-    def self.shorten_url(job_url, bitly_user, bitly_apikey)
-      authorize = UrlShortener::Authorize.new "#{bitly_user}", "#{bitly_apikey}"
+    # @param [String] bit_ly_user The Username in Bit.ly
+    # @param [String] bit_ly_apikey The Apikey from your Bit.ly User
+    # @return [String] job_url_checked Returns the shortened Bit.ly URL
+    def self.shorten_url(job_url, bit_ly_user, bit_ly_apikey)
+      # TODO: Try to fix this in future
+      # rubocop:disable Style/UnneededInterpolation
+      authorize = UrlShortener::Authorize.new "#{bit_ly_user}", "#{bit_ly_apikey}"
       client = UrlShortener::Client.new authorize
 
       shorten = client.shorten("#{job_url}") # => UrlShortener::Response::Shorten object
       shorten.result # => returns a hash of all data returned from bitly
       shorten.urls # => Only returns the short urls look for more convenience methods in the UrlShortener::Response::Shorten class
       puts shorten.urls
-      joburl = shorten.urls
-      return joburl
+      job_url_checked = shorten.urls
+      return job_url_checked
     end
 
     # Method for creating the entity.tex
-    # @param [String] jobtitle Title of the target job
+    # @param [String] job_title Title of the target job
     # @param [String] company Comanys name
     # @param [String] street Companies street
     # @param [String] city City of the company
     # @param [String] contact Name of the contact
     # @param [String] contact_sex Sex of the contact
-    # @param [String] entitytex Path to the entity.tex
-    def self.create_file(jobtitle, company, street, city, contact, entitytex, contact_sex, proactive, target)
+    # @param [String] entity_tex Path to the entity.tex
+    # TODO: Try to fix this in future
+    # This method smells of :reek:LongParameterList
+    def self.create_file(job_title, company, street, city, contact, entity_tex, contact_sex, proactive, target)
       introduction = LatexCurriculumVitae::Entityfile.get_introduction(contact, contact_sex)
-      subject, intro = LatexCurriculumVitae::Entityfile.get_subject_intro(proactive, jobtitle)
-      addressstring = LatexCurriculumVitae::Entityfile.get_addressstring(company, contact, street, city)
-      targetblock = LatexCurriculumVitae::Entityfile.get_target_block(target)
+      subject, intro = LatexCurriculumVitae::Entityfile.get_subject_intro(proactive, job_title)
+      address_string = LatexCurriculumVitae::Entityfile.get_address_string(company, contact, contact_sex, street, city)
+      target_block = LatexCurriculumVitae::Entityfile.get_target_block(target)
 
-      FileUtils.rm(entitytex) if File.exist?(entitytex)
-      FileUtils.touch(entitytex)
-      File.write "#{entitytex}", <<EOF
-\\def\\jobtitle{#{jobtitle}}
+      FileUtils.rm(entity_tex) if File.exist?(entity_tex)
+      FileUtils.touch(entity_tex)
+      # TODO: Try to fix this in future
+      # rubocop:disable Layout/IndentHeredoc
+      File.write "#{entity_tex}", <<TEXFILE
+\\def\\jobtitle{#{job_title}}
 \\def\\company{#{company}}
 \\def\\contact{#{contact}}
 \\def\\street{#{street}}
 \\def\\city{#{city}}
 \\def\\introduction{#{introduction}}
 \\def\\subject{#{subject}}
-\\def\\addressstring{#{addressstring}}
+\\def\\addressstring{#{address_string}}
 \\def\\intro{#{intro}}
-\\def\\targetblock{#{targetblock}}
-EOF
+\\def\\targetblock{#{target_block}}
+TEXFILE
     end
 
     # Method for preparing the introduction variable
     # @param [String] contact Name of the contact
     # @param [String] contact_sex Sex of the contact
     # @return [String] introduction
+    # TODO: Try to fix this in future
+    # rubocop:disable Style/IfInsideElse
+    # This method smells of :reek:ControlParameter
     def self.get_introduction(contact, contact_sex)
-      if contact == ''
-        introduction = 'Sehr geehrte Damen und Herren,'
-      else
-        if contact_sex == 'male'
-          introduction = "Sehr geehrter Herr #{contact},"
-        else
-          introduction = "Sehr geehrte Frau #{contact},"
-        end
-      end
+      introduction = if contact == ''
+                       'Sehr geehrte Damen und Herren,'
+                     else
+                       if contact_sex == 'male'
+                         "Sehr geehrter Herr #{contact},"
+                       else
+                         "Sehr geehrte Frau #{contact},"
+                       end
+                     end
       return introduction
     end
 
     # Method for preparing the subject and intro variables
     # @param [String] proactive Can be yes or no
-    # @param [String] jobtitle Title of the target job
+    # @param [String] job_title Title of the target job
     # @return [Array] subject intro
-    def self.get_subject_intro(proactive, jobtitle)
+    # TODO: Try to fix this in future
+    # This method smells of :reek:ControlParameter
+    def self.get_subject_intro(proactive, job_title)
       if proactive == 'yes'
-        subject = "Initiativbewerbung um einen Arbeitsplatz als #{jobtitle}"
-        intro = "gerne möchte ich mich bei Ihnen um die Stelle als #{jobtitle} oder einer ähnlichen Position bewerben."
+        subject = "Initiativbewerbung um einen Arbeitsplatz als #{job_title}"
+        intro = "gerne möchte ich mich bei Ihnen um die Stelle als #{job_title} oder einer ähnlichen Position bewerben."
       else
-        subject = "Bewerbung um einen Arbeitsplatz als #{jobtitle}"
-        intro = "mit großem Interesse bin ich auf die ausgeschriebene Position aufmerksam geworden. Aus diesem Grund bewerbe ich mich bei Ihnen als #{jobtitle}."
+        subject = "Bewerbung um einen Arbeitsplatz als #{job_title}"
+        intro = "mit großem Interesse bin ich auf die ausgeschriebene Position aufmerksam geworden. Aus diesem Grund bewerbe ich mich bei Ihnen als #{job_title}."
       end
       [subject, intro]
     end
 
-    # Method for preparing the addressstring
+    # Method for preparing the address_string
     # @param [String] company Comanys name
     # @param [String] street Companies street
     # @param [String] city City of the company
     # @param [String] contact Name of the contact
-    # @return [String] addressstring
-    def self.get_addressstring(company, contact, street, city)
-      addressstring = "#{company} \\\\"
-      if contact == ''
-        addressstring << 'z.Hd. Personalabteilung \\\\'
-      else
-        addressstring << "z.Hd. #{contact} \\\\"
-      end
-      addressstring << "#{street} \\\\" if street != ''
-      addressstring << "#{city}" if city != ''
-      return addressstring
+    # @return [String] address_string
+    # TODO: Try to fix this in future
+    # This method smells of :reek:LongParameterList
+    # This method smells of :reek:ControlParameter
+    def self.get_address_string(company, contact, contact_sex, street, city)
+      address_string = "#{company} \\\\"
+      address_string << if contact == ''
+                          'z.Hd. Personalabteilung \\\\'
+                        else
+                          if contact_sex == 'male'
+                            "z.Hd. Herrn #{contact} \\\\"
+                          else
+                            "z.Hd. Frau #{contact} \\\\"
+                          end
+                        end
+      address_string << "#{street} \\\\" if street != ''
+      address_string << "#{city}" if city != ''
+      return address_string
     end
 
     # Method for getting the target code block
-    # @param [String] target The choosed target
-    # @returns [String] targetblock Returns a Block with the choosed Information
+    # @param [String] target The chosen target
+    # @returns [String] target_block Returns a Block with the chosen Information
+    # TODO: Try to fix this in future
+    # This method smells of :reek:ControlParameter
     def self.get_target_block(target)
       if target == 'doku'
-        targetblock = 'Neben der Beschreibungssprache DocBook samt XSL-FO lernte ich die Satzsprache \\LaTeX. \\\\ Selbstständig erarbeitete ich mir Kenntnisse in der Programmiersprache Ruby, sowie der Web-App-Entwicklung (Technische Hochschule Mittelrhein).\\\\'
+        target_block = 'Neben der Beschreibungssprache DocBook samt XSL-FO lernte ich die Satzsprache \\LaTeX. \\\\
+Selbstständig erarbeitete ich mir Kenntnisse in der Programmiersprache Ruby, Python, sowie der Web-App-Entwicklung
+(TH Mittelrhein).\\\\'
       elsif target == 'support'
-        targetblock = 'Im IT-Support hatte ich bereits erste Führungserfahrung als Dispatcher \\&Controller. Selbstständig erarbeitete ich mir Kenntnisse in der Programmiersprache Ruby, sowie der Web-App-Entwicklung (Technische Hochschule Mittelrhein).\\\\'
+        target_block = 'Im IT-Support hatte ich bereits erste Führungserfahrung als Dispatcher \\&Controller.
+Selbstständig erarbeitete ich mir Kenntnisse in den Programmiersprachen Bash, Ruby und Python, sowie der Web-App-Entwicklung (TH Mittelrhein).\\\\'
       else
-        targetblock = 'Im kaufmännischen Bereich habe ich bereits vielfältige Erfahrungen im Einkauf, Verkauf, Öffentlichkeitsarbeit und Vertrieb gemacht und bin stets bereit neues zu lernen.\\\\'
+        target_block = 'Im kaufmännischen Bereich habe ich bereits vielfältige Erfahrungen im Einkauf, Verkauf,
+Öffentlichkeitsarbeit und Vertrieb gemacht und bin stets bereit neues zu lernen.\\\\'
       end
+      return target_block
     end
   end
-end
+end

data/lib/latex_curriculum_vitae/get-config.rb

@@ -1,10 +1,17 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# @author Sascha Manns
-# @abstract module for getting information from a config file
-#
 # 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'
@@ -14,35 +21,38 @@ module LatexCurriculumVitae
   # Module for creating the GetConfig
   module GetConfig
     # This method gets the configs from the config file
-    # @return [Array] name_of_pdf, name_of_cover, name_of_resume, name_of_letter, pdf_reader, shorten_url, bitly_user, bitly_apikey
-    def self.get(sysconfdir)
-      config = ParseConfig.new("#{sysconfdir}/latex_curriculum_vitae.cfg")
+    # @param [String] sysconf_dir
+    # @return [Array] name_of_pdf, name_of_cover, name_of_resume, name_of_letter, pdf_reader, shorten_url,
+    # bit_ly_user, bit_ly_apikey
+    def self.get(sysconf_dir)
+      config = ParseConfig.new("#{sysconf_dir}/latex_curriculum_vitae.cfg")
       name_of_pdf = config['name_of_pdf']
       name_of_cover = config['name_of_cover']
       name_of_resume = config['name_of_resume']
       name_of_letter = config['name_of_letter']
       pdf_reader = config['pdf_reader']
       shorten_url = config['shorten_url']
-      bitly_user = config['bitly_user']
-      bitly_apikey = config['bitly_apikey']
+      bit_ly_user = config['bitly_user']
+      bit_ly_apikey = config['bitly_apikey']
+      mail_backend = config['mail_backend']
 
-      [name_of_pdf, name_of_cover, name_of_resume, name_of_letter, pdf_reader, shorten_url, bitly_user, bitly_apikey]
+      [name_of_pdf, name_of_cover, name_of_resume, name_of_letter, pdf_reader, shorten_url, bit_ly_user, bit_ly_apikey,
+       mail_backend]
     end
 
     # Method for getting smtp configuration
-    # @return [Array] own_name, own_email_address, own_smtp, own_username, own_password, own_port, own_domain, own_tls
-    def self.get_smtp(sysconfdir)
-      config = ParseConfig.new("#{sysconfdir}/latex_curriculum_vitae.cfg")
+    # @param [String] sysconf_dir
+    # @return [Array] own_name, own_email_address, own_smtp, own_username, own_password, own_port, own_domain
+    def self.get_smtp(sysconf_dir)
+      config = ParseConfig.new("#{sysconf_dir}/latex_curriculum_vitae.cfg")
       # own_name = config['own_name']
       own_email_address = config['own_email_address']
       own_smtp = config['own_smtp']
       own_username = config['own_username']
       own_password = config['own_password']
       own_port = config['own_port'].to_i
-      own_tls = config['own_tls']
 
-      [own_email_address, own_smtp, own_username, own_password, own_port, own_tls]
+      [own_email_address, own_smtp, own_username, own_password, own_port]
     end
-
   end
 end

data/lib/latex_curriculum_vitae/letter.rb

@@ -1,10 +1,17 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# @author Sascha Manns
-# @abstract module for creating a motivational letter
-#
 # 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'
@@ -15,14 +22,14 @@ module LatexCurriculumVitae
   # Module for creating the motivational letter
   module Letter
     # Method for creating a pdf from tex
-    # @param [String] tmpdir Name of the Tempdir
+    # @param [String] tmp_dir Name of the Tempdir
     # @param [String] name_of_letter Filename of the Letter
-    def self.create_letter(tmpdir, name_of_letter)
-      puts 'Compiling motivational letter'.colour(:yellow)
+    def self.create_letter(tmp_dir, name_of_letter)
+      puts 'Compiling motivational letter'.color(:yellow)
       system("pdflatex #{name_of_letter}.tex")
-      puts 'Done compiling motivational letter'.colour(:green)
-      system("cp #{name_of_letter}.pdf #{tmpdir}")
-      puts 'Copied motivational letter to tmpdir'.colour(:green)
+      puts 'Done compiling motivational letter'.color(:green)
+      system("cp #{name_of_letter}.pdf #{tmp_dir}")
+      puts 'Copied motivational letter to tmpdir'.color(:green)
     end
   end
 end

data/lib/latex_curriculum_vitae/notifier.rb

@@ -1,11 +1,17 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# @author Sascha Manns
-# @abstract module for notify the user about finishing the email send
-# process
-#
 # 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
 
@@ -16,13 +22,14 @@ require 'notifier'
 module LatexCurriculumVitae
   # Method for notifying the user
   module Notify
-    # @param [String] jobtitle The Title of your job application
-    def self.run(jobtitle, datadir)
-      img = "#{datadir}/share/icons/arbeitsagentur.png"
+    # @param [String] job_title The Title of your job application
+    # @param [String] data_dir Path to data dir
+    def self.run(job_title, data_dir)
+      img = "#{data_dir}/share/icons/arbeitsagentur.png"
       Notifier.notify(
-          :image => "#{img}",
-          :title => "Your Job Application",
-          :message => "Your Job Application #{jobtitle} was created now."
+        image: img.to_s,
+        title: 'Your Job Application',
+        message: "Your Job Application #{job_title} was created now."
       )
     end
   end

data/lib/latex_curriculum_vitae/outfile.rb

@@ -1,10 +1,17 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# @author Sascha Manns
-# @abstract module for adding new applications on the csv table
-#
 # 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 'csv'
@@ -14,29 +21,33 @@ module LatexCurriculumVitae
   # Module for creating and appending the outfile
   module CVOutfile
     # Method to adding the data into the csv file
-    # @param [String] jobtitle Title of the job application
+    # @param [String] job_title Title of the job application
     # @param [String] company Companyname for the application
     # @param [String] contact Name of the Contact in the Company
-    # @param [String] emailaddress Emailaddress of the Contact
-    # @param [String] csvout Name of the CSV-Outfile
-    # @param [String] joburl The shortened URL
-    def self.add_to_outfile(jobtitle, company, contact, emailaddress, csvout, joburl)
+    # @param [String] email_address Emailaddress of the Contact
+    # @param [String] csv_out Name of the CSV-Outfile
+    # @param [String] job_url_checked The shortened URL
+    # TODO: Try to fix this in future
+    # rubocop:disable Metrics/AbcSize
+    # This method smells of :reek:LongParameterList
+    def self.add_to_outfile(job_title, company, contact, email_address, csv_out, job_url_checked)
       time = Time.new
       date = time.strftime('%Y-%m-%d')
       contact.gsub!('%20', ' ')
-      jobtitle.gsub!('%20', ' ')
-      jobtitle.gsub!('%26', '&')
-      if File.exist?(csvout)
+      job_title.gsub!('%20', ' ')
+      job_title.gsub!('%26', '&')
+      if File.exist?(csv_out)
         puts 'do nothing'
       else
-        FileUtils.touch(csvout)
-        File.write "#{csvout}", <<EOF
+        FileUtils.touch(csv_out)
+        # rubocop:disable IndentHeredoc
+        File.write csv_out.to_s, <<CSV
 date,company,job,contact,email,status, joburl
-EOF
+CSV
       end
-      CSV.open("#{csvout}", 'a+') do |csv|
+      CSV.open(csv_out.to_s, 'a+') do |csv|
         # datum,firma,stelle,kontakt,email,status,joburl
-        csv << ["#{date}", "#{company}", "#{jobtitle}", "#{contact}", "#{emailaddress}", 'Open', "#{joburl}"]
+        csv << [date.to_s, company.to_s, job_title.to_s, contact.to_s, email_address.to_s, 'Open', job_url_checked.to_s]
       end
     end
   end