jishan_fast_track_gem 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f64eba00a1433661823e20a32f1c75abbd03655249dcd4e31920a0f90232842
-  data.tar.gz: 58efb93f674470f24eab69c7af2cfadd034c310d95ebbd9f842f110417378154
+  metadata.gz: ef81de508e2f0c7e201d363ba14ed5bdd53b065ac967410e085f1f73fd7410c6
+  data.tar.gz: b6d53990bf8fd209090965b199980ef49e0a4556ca01b33fa352c96f04514a68
 SHA512:
-  metadata.gz: 0340ba5c291065a9af02fa65da465b3d0994f60e95416d1d1d92a40ba1c41bfbfd35cb92a596d1b88c00f45a13192712bc95ddbbeb7ebff9bdd8ef4ecd5b2b7b
-  data.tar.gz: cb7d8c457e8449bb55bfa59eaca3501eda1dc8ed98a0cd46cfc646e3a0a3b5f3f8b1b5da968f420dcf123b116b5693ffb37bc6b66ca349b24eab1e5ee7408bbc
+  metadata.gz: d7866b62f19042d6c3a8044c63edccf0c8f1f1b77cf279bbfd5ac1598b770055288d1adf52111e3e75bb7cffd6a48351c290222df67258162117b6657303026e
+  data.tar.gz: 16d5e9e16a00b1b8107f5caf6192530389f37181db8d0f98440af25e60cfdf2c78050ac9e51989e9954e8f953113e948f1af78f8ed897762af74703571e4acd8

data/README.md

@@ -1,44 +1,107 @@
-# JishanFastTrackGem
+### Source control respository
+https://github.com/jishan33/T1A2
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jishan_fast_track_gem`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+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. 
 
-## Requirements
-  - Ruby is required to install the Gem
+This application will make the rebate process easier for users and managers as all the process can be completed in one terminal app. 
 
-## Installation
+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. 
 
-Install the gem on your local system:
+The manager can easily arrange the lists of applicants and assign applicants to the appropriate lists as well as remove it.
 
-```
-gem install jishan_fast_track_gem
-```
+Although the information for the solar panel rebates can be easily accessed online, the applying process sometimes can be hectic.
 
-And then execute:
+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. 
 
-    $ jishan_fast_track_gem
+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 households combined income who would like to install some solar panels on their properties.  
 
-## Usage
+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.
 
-After executing the program, 
+Three features description
+----------------------------
+### Check Rebate Eligibility
 
-## Development
+The program will prompt the user with several yes/no questions. Based on the users’ response to these questions, the program will determine whether or not the user is eligible for the solar panel rebate program. The users’ answers will be put into an array and rules from the Victoria solar panel rebate information website (see references) will be used to determine eligibility based on the users’ responses once all responses have been collected.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Check Required Files
+As part of the application process for the rebate, several documents need to be collected including proof of income, two forms of identification and a quote from a certified retailer. The application will prompt the user for a link to the above and assist in ensuring that the links provided are valid URLs to a supported file type (pdf or doc file). In the case of the quote, the domain of the URL is used to check that the quote comes from a retailer from the CEC (Clean Energy Council) approved solar retailers (see references) in Victoria. During this process, the user can also opt to exit the program at any time by providing a '0' as a response.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Calculate Solar Panel Rebate
+Finally, the program will prompt the user for the details of their solar installation and postcode. Based on this information, it will apply the Small-scale Technology Certificates (STC) equation (see references) in order to determine the number of STC's for the installation. The program will then multiply this number by the current market value of STC's at the time of implementation (see references).
 
-## Contributing
+Once this calculation has been completed, the program will display the results to the user and exit.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jishan_fast_track_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jishan_fast_track_gem/blob/master/CODE_OF_CONDUCT.md).
 
 
-## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+ Outline of the user interaction and experience 
+----------------------------
+The user will be interactively guided through each feature of the program on program launch.
+
+Initially, some instructions are displayed to the user to prime them as to what to expect from the program.
+
+After this, each feature of the program guides the user by prompting them for the required information as needed. The results are then printed to the terminal.
+
+If the program encounters any errors during this process (ie, invalid user input), the program will restate the input requirements and prompt the user to input again.
+
+
+
+
+Implementation Plan
+----------------------------
+
+Please refer to my [Trello board](https://trello.com/b/QiHS8LxP/t1a2)
+
+
+
+Requirements
+---
+  - Ruby
+  - Bundler
+
+Installation
+----
+
+ - Clone the repository
+ - Run bundle install
+
+
+
+Usage
+---
+Run `./bin/jishan_solar_rebate`
+
+
+This is a command-line application rather than a library so no need to add anything to your Gemfile.
+
+Script to run the application has been included in the `bin` directory for ease of use.
+
+After running the application, you will be provided with instructions.
+
+
+Reference
+---------------------
+ Victoria solar panel rebate information
+https://www.solar.vic.gov.au/solar-panel-rebate
+
+ Postcode ratings for photovoltaic systems 
+http://www.cleanenergyregulator.gov.au/DocumentAssets/Documents/Postcode%20zone%20ratings%20and%20postcode%20zones%20for%20solar%20panel%20systems.pdf  
+
+  STCs (Small_scale Technology Certificates) equation  
+http://www.solazone.com.au/solar-power/off-grid-solar-power/calculating-stcs/
+
+ CEC (Clean Energy Council) approved solar retailers in Australia
+https://www.greenwire.com.au/clean-energy-council-approved-solar-retailers/
+
+ STCs current market value
+https://www.tradeingreen.com.au/prices-93.html
+
+  
 
-Everyone interacting in the JishanFastTrackGem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jishan_fast_track_gem/blob/master/CODE_OF_CONDUCT.md).

data/lib/jishan_fast_track_gem/version.rb

@@ -1,3 +1,3 @@
 module JishanFastTrackGem
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
 end

data/lib/jishan_fast_track_gem.rb

@@ -8,7 +8,7 @@ require_relative 'manage_list'
 # 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.ower_of_the_property
+# john.ower_of_the_property
 john_files = Files_check.new("John Files")
 # john_files.income_proof
 
@@ -27,8 +27,8 @@ john_files = Files_check.new("John Files")
 
 # p Manage_list.display_processing_number
 
-john_rebate = Rebate_calculator.new(3163, 5, 7)
-john_rebate.stc_postcode_rating
+john_rebate = Rebate_calculator.new
+john_rebate.ask_parameters
 
 
 

data/lib/rebate_calculator.rb

@@ -1,15 +1,29 @@
 require 'csv'
 require 'colorize'
 
+
 class Rebate_calculator
-  def initialize(postcode, kw, deeming_year)
-    @postcode = postcode
-    @kw = kw
-    @deeming_year = deeming_year
+  def initialize
+    @postcode = 0
+    @kw = 0
+    @deeming_year = 0
     @stc_rating = 0
     @stc = 0
   end
 
+  def ask_parameters
+    puts "what is your postcode?"
+      postcode = gets.chomp.to_i
+      @postcode = postcode
+    puts "How many kilowatt is your future solar panel?"
+      kw = gets.chomp.to_i
+      @kw = kw
+    puts "What is the lifetime of your future solar panel?"
+      deeming_year = gets.chomp.to_i
+      @deeming_year = deeming_year
+    stc_postcode_rating
+  end
+  private
   def stc_postcode_rating
     csv_text = File.read(__dir__ + '/stc_rating.csv')
     csv = CSV.parse(csv_text, headers: true)
@@ -21,8 +35,6 @@ class Rebate_calculator
     stc_calculator
   end
 
-  private
-
   def stc_calculator
     @stc = (@kw * @stc_rating * @deeming_year).floor
     rebate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jishan_fast_track_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Jishan_Lu
@@ -43,7 +43,7 @@ files:
 - bin/console
 - bin/gemoji
 - bin/htmldiff
-- bin/jishan_solar_rebate
+- bin/jishan_solar_panel_rebate
 - bin/ldiff
 - bin/rake
 - bin/rspec