Merge pull request #5 from hayat01sh1da/hayat01sh1da/optimise-docs-and-code-designs

Optimise Docs and Code Designs

Author: hayat01sh1da

python/main.py

@@ -5,22 +5,16 @@
 sys.path.append('./src')
 from application import Application
 
-username = input('Provide your username(Default: hayat01sh1da): ')
-unit     = input('Provide your preferred unit d(daily - default), w(weekly) or m(monthly): ')
-year     = input('Provide the specific year you would like to create working report templates for(Default: the current year): ')
+username = input('Provide your username(Default: hayat01sh1da): ').strip()
+unit     = input('Provide your preferred unit d(daily - default), w(weekly) or m(monthly): ').strip()
+year     = input('Provide the specific year you would like to create working report templates for(Default: the current year): ').strip()
 
-if username and unit and year:
-    app = Application(username = username, unit = unit, year = year)
-elif username:
-    app = Application(username = username)
-elif unit:
-    app = Application(unit = unit)
-elif year:
-    app = Application(year = year)
-else:
-    app = Application()
+params = dict()
+for key, value in { 'username': username, 'unit': unit, 'year': year }.items():
+    if value:
+        params[key] = value
 
-app.run()
+Application(**params).run()
 
 pycaches = glob.glob(os.path.join('.', '**', '__pycache__'), recursive = True)
 for pycache in pycaches:

python/src/application.py

@@ -132,8 +132,7 @@ def __export_template__(self, directory, index, day = '', month = ''):
             date += f'{day} '
         date += f'{month} {self.year}'
         filename = os.path.join(directory, f'{self.year}{index}{day}_{self.__full_unit__()}_working_report.md')
-        if not os.path.exists(directory):
-            os.makedirs(directory)
+        os.makedirs(directory, exist_ok = True)
         with open(filename, 'w') as f:
             f.write(self.__body__(date))
 

python/test/test_application.py

@@ -57,24 +57,29 @@ def test_run_by_monthly_unit(self):
 
 class TestIrregularCase(TestApplication):
     def test_initialize_with_invalid_username(self):
-        with self.assertRaises(ValueError, msg = 'InvalidUsername is NOT a permitted username.'):
+        with self.assertRaises(ValueError) as cm:
             Application(username = 'InvalidUsername', unit = 'foobar', year = self.year).run()
+        self.assertEqual('InvalidUsername is NOT a permitted username.', str(cm.exception))
 
     def test_initialize_with_invalid_unit(self):
-        with self.assertRaises(ValueError, msg = 'Provide d, w or m as a valid unit.'):
+        with self.assertRaises(ValueError) as cm:
             Application(username = self.username, unit = 'foobar', year = self.year).run()
+        self.assertEqual('Provide d, w or m as a valid unit.', str(cm.exception))
 
     def test_initialize_with_non_digit_argument(self):
-        with self.assertRaises(ValueError, msg = 'invalid literal for int() with base 10: "foobar"'):
+        with self.assertRaises(ValueError) as cm:
             Application(username = self.username, year = 'foobar')
+        self.assertEqual('invalid literal for int() with base 10: \'foobar\'', str(cm.exception))
 
     def test_initialize_with_invalid_value_as_year(self):
-        with self.assertRaises(ValueError, msg = 'Year must be 4 digits.'):
+        with self.assertRaises(ValueError) as cm:
             Application(username = self.username, year = '20233')
+        self.assertEqual('Year must be 4 digits.', str(cm.exception))
 
     def test_initialize_with_older_year(self):
-        with self.assertRaises(ValueError, msg = 'Provide newer than or equal to the current year.'):
+        with self.assertRaises(ValueError) as cm:
             Application(username = self.username, year = '2022')
+        self.assertEqual('Provide newer than or equal to the current year.', str(cm.exception))
 
 if __name__ == '__main__':
     unittest.main()

ruby/main.rb

@@ -1,26 +1,14 @@
 require_relative './src/application'
 
 puts 'Provide your username(Default: hayat01sh1da)'
-_username = gets.chomp
+username = gets.chomp.strip
 
 puts 'Provide your preferred unit d(daily - default), w(weekly) or m(monthly)'
-_unit = gets.chomp
+unit = gets.chomp.strip
 
 puts 'Provide the specific year you would like to create working report templates for(Default: the current year)'
-_year = gets.chomp
+year = gets.chomp.strip
 
-username = _username.empty? ? nil : _username
-unit     = _unit.empty? ? nil : _unit
-year     = _year.empty? ? nil : _year
+params = { username:, unit:, year: }.reject { |_, value| value.empty? }
 
-if username && unit && year
-  Application.run(username:, unit:, year:)
-elsif username
-  Application.run(username:)
-elsif unit
-  Application.run(unit:)
-elsif year
-  Application.run(year:)
-else
-  Application.run
-end
+Application.run(**params)

ruby/src/application.rb

@@ -8,24 +8,24 @@ class DigitLengthError < StandardError; end
   USERNAMES = ['hayat01sh1da'].freeze
 
   def self.run(username: 'hayat01sh1da', unit: 'd', year: Time.now.year.to_s)
-    instance = new(username, unit, year)
-    instance.validate_username!(username)
-    instance.validate_unit!(unit)
-    instance.validate_year!(year)
+    instance = new(username:, unit:, year:)
+    instance.validate_username!
+    instance.validate_unit!
+    instance.validate_year!
     instance.run
   end
 
-  def initialize(username, unit, year)
+  def initialize(username: 'hayat01sh1da', unit: 'd', year: Time.now.year.to_s)
     @username = username
     @unit     = unit
     @year     = year
   end
 
-  def validate_username!(username)
+  def validate_username!
     raise ValueError, "#{username} is NOT a permitted username." unless USERNAMES.include?(username)
   end
 
-  def validate_unit!(unit)
+  def validate_unit!
     case unit
     when 'd', 'w', 'm'
       unit
@@ -34,7 +34,7 @@ def validate_unit!(unit)
     end
   end
 
-  def validate_year!(year)
+  def validate_year!
     Integer(year)
     if year.length > 4
       raise DigitLengthError, 'Year must be 4 digits.'