jishan_fast_track_gem 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2cad18214303ea2d8d295fb3722892ba30d4c46e5b1568ae53e5314ce9e8520
-  data.tar.gz: f5130bc86312f938dd7f0ee09128b18f116f93bac9724a3e271ffdea56599144
+  metadata.gz: bcb60c3065d08a743960f08beeae0ff05b06b1d62ed28cf253a3d6e2867bcf38
+  data.tar.gz: daf7971c43aaa256d75994053c31d229f767adab626b6758705df0793e57b32a
 SHA512:
-  metadata.gz: 57811c443a45d199e44d515f3fb6895e27d001e770e5b2821629481eb88cb4512ea45b2d2e4d11540e5320e264be2faf84be1bb504b8ef93c98cf38df058ba90
-  data.tar.gz: 3c30c22ed90806a6aa9155f19c01653c02cffffd4201cf850e26df6087212a73b8630dcc68b2839a1810ce2cb11c64d83a5858be237868e6d41e795eca9ec729
+  metadata.gz: 9c4214c6d2c1636b1daaea447545327d3168f320c2bbe27f9928c32fdc96fd93ca016505b066b962391f9bfe56c0097e82d3eee0ad7f5b05742e3db3b13de129
+  data.tar.gz: d1ddaa69626a0aea99a1e95d05becbe54d0fbf87da2253fdb9bb79222ab2525bdeddb63a5ea92a768aa18a4c7ffc44406137432e68549326e493fab8867e740f

data/README.md

@@ -4,24 +4,37 @@ https://github.com/jishan33/T1A2
 
 Software Development Plan
 --------------------------
-The main purpose of building this app is to try to combine my coding knowledge and engineering background at an entry-level. Hopefully, I can extend this experience to further apply more complex coding concepts into the engineering field in the near future. 
-I like the idea of using technology to ease people’s life and simultaneously providing a more environmental environment. Solar panel rebate is a great program to encourage people to use more sustainable energy to support a more independent and efficient lifestyle. Making the program process more accessible is a great way to promote the concept of combing technology and sustainable energy. 
+This application will make the solar panel rebate process easier for users and managers as the whole process can be completed in one terminal app. 
 
-This application will make the rebate process easier for users and managers as all the process can be completed in one terminal app. 
+Users can check if they are eligible by answering a short questionnaire. Also, they can easily check whether all the files have been successfully uploaded and are of the correct type. The rebate can be easily evaluated by simply provide postcode, kw and deeming year. 
 
-Users can check if they are eligible by answering a short questionnaire. Also, they can easily check whether all the files have been successfully uploaded. The rebate can be easily evaluated by simply provide postcode, kw and deeming year. 
+The manager can easily arrange the lists of applicants and assign applicants to the appropriate lists as well as remove them.
 
-The manager can easily arrange the lists of applicants and assign applicants to the appropriate lists as well as remove it.
+Although the information for the solar panel rebates can be easily accessed online, the application process sometimes can be difficult.
 
-Although the information for the solar panel rebates can be easily accessed online, the applying process sometimes can be hectic.
+In order to reduce the difficulty of the application process, transforming the long and bland list into a more interactive questionnaire might increase the number of potential applicants. 
 
-In order to reduce the difficulty of applying process. Transforming the long and bland list into a more interactive questionnaire might increase the number of potential applicants. 
+Also, providing the rebate assessment and the eligibility check on the same platform encourages the potential applicants to go through the process. Allocating the rebate calculator at the beginning and at the end could potentially increase their interests in this rebate program.
 
-Also, providing the rebate assessment and the eligibility check on the same platform encourages the potential applicants to go through the process. Allocating the rebate calculator at the beginning could potentially increase their interests in this rebate program.
+The target audiences are the property owners with less than 180,000 household income combined income who would like to install some solar panels on their properties.  
 
-The target audiences are the property owners with less than 180,000 households combined income who would like to install some solar panels on their properties.  
+This terminal app is a comparably easy process for them to use. They probably would play around with this app to have some basic ideas about this rebate program. And further, apply for it with the required documents.
+
+### Functions to be implemented:
+- `instruction (eligibility check)`
+    - This function can kick off the application by presenting the user with a description of how to use the program and kick off the initial sequence of questions.
+    
+- `eligibility_response`
+    - This function will be called to asses the answers provided by the user and determine whether or not they are eligible and inform them
+- `answer_check`
+    - There will be many questions with the same yes/no/exit response, therefore it makes sense to implement an answer check method to avoid duplicating code for each question. This function can take in the answer provided by the user and add to the list of ineligable answers / exit the program / prompt for the next question as appropriate.
+- `valid_file_check`
+    - The user will be prompted to submit several different files with similar requirements. As such, it makes sense to create a method that has common validation rules and ensures that the user provides a correct file in each case.
+- `stc_postcode_rating`
+    - Reads in a csv which lists postcode ranges as their respective STC ratings to be used later in the rebate function. This data is then used to determine the STC rating based on the users postcode. 
+- `rebate`
+    - Once the user has determined their eligibility and provided the details of their solar panel installation and location, the rebate method is used to calculate the approximate amount of rebate the user would be eligible to receive under the scheme.
 
-This terminal app is a comparably easy process for them to use. They probably would play around with this app to have some basic ideas about this rebate program. And further, apply it with the required documents.
 
 Three features description
 ----------------------------

data/lib/eligibility_check.rb

@@ -60,7 +60,8 @@ class Eligibility_check
 
   def eligibility_response
     if @answers.size == 0
-       puts "Congrats! You are eligible for solar panel rebate #{Emoji.find_by_alias("clap").raw} #{Emoji.find_by_alias("clap").raw} #{Emoji.find_by_alias("clap").raw}".colorize(:red)
+        clap = Emoji.find_by_alias("clap").raw + " "
+        puts "Congrats! You are eligible for solar panel rebate #{clap * 3}".colorize(:red)
     else 
       puts "Sorry, you are not eligible for solar panel rebate program."
     end

data/lib/jishan_fast_track_gem/version.rb

@@ -1,3 +1,3 @@
 module JishanFastTrackGem
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
 end

data/lib/jishan_fast_track_gem.rb

@@ -6,7 +6,6 @@ require_relative 'manage_list'
 
 #  write the intro
 # Help file includes *comprehensive* instructions which *accurately* describe: steps to install the application; dependencies required by the application; system/hardware requirements; features of the application.
-
 john = Eligibility_check.new("John")
 # john.instruction
 john_files = Files_check.new("John Files")

data/lib/rebate_calculator.rb

@@ -24,8 +24,10 @@ class Rebate_calculator
       if postcode > 9999
       puts "It's not a valid postcode, please type a valid postcode.".colorize(:light_yellow)
       end
-    break if postcode < 9999
      @postcode = postcode
+      if postcode < 9999
+        break
+      end
     end
     
     puts "How many kilowatt is your future solar panel?"
@@ -50,6 +52,9 @@ class Rebate_calculator
 
   def stc_calculator
     @stc = (@kw * @stc_rating * @deeming_year).floor
+
+        p self
+    
     rebate
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jishan_fast_track_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Jishan_Lu