thermostat_Elise_DeSmet 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32e4d2b6d3920e8ae9059d8aa6cee4b38a2888b0
-  data.tar.gz: 1da68595d89fd641bc7b0c2db069d152d6ec00b3
+  metadata.gz: 754c9f84f61604ac04f926962b25f209a42f0e37
+  data.tar.gz: 9f63695938dfc4784efff5adfe89b7cfe0c413ce
 SHA512:
-  metadata.gz: 2f434062dd0cada2d273ae0c8e610aa89d6cdb575fc5e3936d350b844592dbee0e5ab2d55ef4d8c28a419253dfd5e8ceda4ed08cfe4934c24a17126475ea2b78
-  data.tar.gz: 906a2f30afb86632333d480aba5f5e74012714ee14b54826d1caa38cd284b2af84e8c1c9ea175550298514f84df05f276a702cf906e6a452d45d83d9ece54749
+  metadata.gz: 63a674e137255776eb0e46e2443d2f4520f15d622ae64eb7f0d814ce5e8e5619256bba33c9cb63793409735764dacc3da34f395d5bffc983558341b343b36797
+  data.tar.gz: a1d2e50c6c0684f800461f259c8df16fb2cff50a9eac48ecc74a37f3925cbc50f67c8ca15ea8d86d980317559af8eac520bd4d47952c8c3e0d663a7321de7bc9

data/lib/convert.rb

@@ -1,4 +1,18 @@
+# Convert class will convert temperature in 
+# different units. 
+
 class Convert
+  # Convert method will loop over units and will
+  # check if unit is nil, celsius, kelvin or fahrenheit.
+  # It will convert the temperature 
+  # in celsius, kelvin or fahrenheit
+  # @param [String] some wanted values:
+  #  * :unit [String] The unit of the temperature
+  #  * :temperature [Double] The value of the temperature
+  # @return [Double] the resulting temperature
+  # @example
+  #   convert.convert(86, 'fahrenheit')
+  #   returns: 30
   def convert(temperature, unit)
     return temperature if unit.nil?
     return temperature if unit == 'celsius'

data/lib/json_thermostat.rb

@@ -4,6 +4,9 @@ require 'convert.rb'
 
 class JSONThermostat
   attr_reader :thermostat, :convert
+  # Initialize method that created new convert object,
+  # converts the temperature and gives values to thermostat
+  # @param setting [String] gets the settings in string
   def initialize(settings = ' ')
     obj = JSON.parse(settings)
     convert = Convert.new
@@ -11,6 +14,11 @@ class JSONThermostat
     @thermostat = Thermostat.new(temperature, temperature, obj['range'])
   end
 
+  # The update method will parse the json input, it will
+  # get the temperature and unit.
+  # A new convert object is made and it is being convert
+  # and checked.
+  # @param json [String] gets a json string with a temperature and unit
   def update(json = ' ')
     obj = JSON.parse(json)
     temperature = obj['temperature']
@@ -19,9 +27,11 @@ class JSONThermostat
     temperature = convert.convert(obj['temperature'], obj['unit'])
     @thermostat.put_temperature(temperature)
     @thermostat.check
+    return generate_Json
   end
 
-  def generateJson
+  # This method will generate Json values
+  def generate_Json
     JSON.generate(cooling: @thermostat.airco, heating: @thermostat.heating)
   end
 end

data/lib/thermostat.rb

@@ -1,26 +1,45 @@
 class Thermostat
   attr_accessor :current_value, :wanted_value, :range, :heating, :airco
+  # The initialize method makes a thermostat
+  # @param [Double] Json object that contains following values
+  #  * :current_value [Double] The temperature in the room
+  #  * :wanted_value [Double] The temperature that is wanted in the room
+  #  * :range [Double]The upper and under margin of the temperature
   def initialize(current_value = 0.0, wanted_value = 0.0, range = 0.0)
     @current_value = current_value
     @wanted_value = wanted_value
     @range = range / 2
   end
 
+  # Heat method will set the heating on and airco off
+  # when temperature is bellow the wanted value
   def heat
     @heating = true
     @airco = false
   end
 
+  # Cool method will set the airco on and heating off
+  # when temperature is above the wanted value
   def cool
     @heating = false
     @airco = true
   end
 
+  # The off method will turn off the heating and 
+  # airco
   def off
     @heating = false
     @airco = false
   end
 
+  # This method wil check the input values: current value,
+  # wanted value and the range.
+  # When the current value is larger than the wanted value
+  # (plus the range), the cool method is being called. 
+  # If the current value is smaller than the wanted value
+  # (minus the range), the heat method is being called.
+  # Otherwise the thermostat is putted off.
+  # @return [String] the thermostat status
   def check
     if @current_value > (@wanted_value + @range)
       cool
@@ -34,6 +53,8 @@ class Thermostat
     end
   end
 
+  # The put_temperature methode will get the temperature
+  # from the input values
   def put_temperature(temperature)
     @current_value = temperature
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thermostat_Elise_DeSmet
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Elise De Smet