loadshedding 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df040f8f1753d16ad716ee57b713b44d7e97307c
-  data.tar.gz: 11f3d567f87e83bfc1051a8d792ecd8ffee7ff2f
+  metadata.gz: 0f0214a323db9c353507f4e1b572f03b0da7dc5e
+  data.tar.gz: e237eee04f609f9194f2a898c3a656574eb6c112
 SHA512:
-  metadata.gz: 0cd952440dc9b10ed87c1dae9583f20e1e8202cb5363f1a1790e732e7b6ee0be1b543fb55940a25b32dfd812fc52b0363ccf71856532a77234907af4eb1dc176
-  data.tar.gz: 5df25c641a4ae8cd89d340e1ef4097dacbae94486cace30a82c2a4e2d68752cbe6604b4ecd5a553408be1361c62c45089d3fff77a1c08f9ec19bdfcd9ac4d421
+  metadata.gz: 5fe6fbe006d20fb331b9566dcd0618f267373c6a765fcc8d040d2556d1875256e77e4268d74bcb5749d575cfce6a8b972735b66192e69950f75c41cdda65f63d
+  data.tar.gz: cb804481c0ca81d39dc0c21339f6df3c24ec7944239878e25da6dea4acd62a7ba6940db0f24f7d73a63d405e9b4eeee21dec807fdae3f2d219c5ea94f8c03155

data/lib/config_loader.rb

@@ -1,6 +1,7 @@
 class ConfigLoader
   CONFIG_FILE=File.expand_path('~/.load_shedding_config')
   class << self
+    # Loads the group data
     def load_group
       klass =  File.exists?(CONFIG_FILE) ? self : Interfacer
       obj = klass.new
@@ -9,6 +10,7 @@ class ConfigLoader
       group
     end
 
+    # sets the group data after asking form user
     def set_group
       obj = Interfacer.new
       group = obj.find_group
@@ -16,7 +18,7 @@ class ConfigLoader
     end
   end
 
-
+  # loads the group information form the file
   def find_group
     File.read(CONFIG_FILE)
   end

data/lib/day_finder.rb

@@ -1,15 +1,18 @@
 class DayFinder
   def initialize
   end
-
+  # finds the weekday and validates it
+  # @param week_day as an integer starting from monday as 1
   def find_week_day(week_day)
     week_day==0 ? Date.today.cwday : validate_week_day(week_day)
   end
 
+  # Validates the weekday to be within the week
   def validate_week_day(week_day)
     (1..7).cover?(week_day) ? week_day : invalid_week_day
   end
 
+  # Adjusts the week date for the -g parameter
   def adjusted_week_date(week_day)
     today = Date.today.cwday
     difference = (today - week_day)

data/lib/downloader.rb

@@ -11,6 +11,7 @@ class Downloader
     @schedule_json = Hash.new
   end
 
+  # Download the schedule form masquerade API
   def download
       puts "Downloading latest schedule".colorize(:green)
     (1..7).each do |group|

data/lib/interfacer.rb

@@ -5,10 +5,14 @@ class Interfacer
     @cli_handler = HighLine.new
   end
 
+  # asks user for the group number
   def find_group
    @cli_handler.ask "Please enter your group number(will be set as default).".colorize(:red)
   end
 
+  # Saves the group into the file
+  # @param group group number in inteder
+  # @param file path of file
   def persist(group, file)
    File.open(file,'w') do |f|
     f.write(group)

data/lib/schedule.rb

@@ -1,5 +1,8 @@
 class Schedule
 
+  # Returns the schedule for specific date and group
+  # @param date takes in weekday number
+  # @param group takes in group number
   def schedule_for date, group
     group_schedule = GroupSchedule.new(group)
     group_schedule.day_schedule date

data/lib/timer.rb

@@ -2,7 +2,12 @@ require 'time_diff'
 
 class Timer
  attr_reader :status, :alt_status, :time_to_change
-  def initialize(morning_range, evening_range)
+
+ # Gives back a timer object
+ # @param morning_range Range object having from and to hours
+ # @param evening_range Range object having from and to hours
+
+ def initialize(morning_range, evening_range)
     @morning_range = morning_range
     @evening_range = evening_range
     @current_time = Time.now

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loadshedding
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Kapil Raj Nakhwa (@xecutioner303)