tempture-convertor 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ed8a313eed1f3b5d8943eccb7c202442f88edd325ab8a22887d05ca9eee425a
-  data.tar.gz: 3d30504a1ad9abd073f51a6782f2087f824a07d8ff59b1c309b64601521055d5
+  metadata.gz: f8dc1c1e1024ee0ffcd4c1846f7c232f2e73a83888854a7ca8b3ffa7e4ccdbc3
+  data.tar.gz: 535c2098075224fb2a194de03ad692c556a3a23df0e8d6014f2eb11233198c6d
 SHA512:
-  metadata.gz: 40e690dd017c1766c0e73e2d342f8368380de15994db96de871e77de60c228bf54f324784e536801f869861608b177f2073aa209aeb01ac2957424da20251d1b
-  data.tar.gz: a520c6496e9d983f7d5f47424142a5a70c6191a7972dabeaf2e3fa92ca20c51dddc17cb4797c3bda8f6216e96c0bab7d76d60252921223c1e4402cb41e72decf
+  metadata.gz: 809d556edd12b7ce8fad7e93aeb7f09812f99b4bbb060351eb6e51846c29e157435eeaa3b3a292232302941f7cae7d897e8835c7ca745fdacb6d5fe42d3789bf
+  data.tar.gz: 7353078c2deb97673a6fd8356774b6cbf64f62e3563e33771e13b52eb1c60d272f141144064dc4a20f304aea9067bfb15ae604bfeec16f0acfdb76d26c7d2038

data/README.md

@@ -1,6 +1,6 @@
 # Temperature Convertor
 
-convert temperature from fehrenheit or kelvin to celsius
+Convert temperature between fehrenheit, kelvin and celsius
 
 
 ## Detail
@@ -9,12 +9,12 @@ The "Temperature" class stores and controls the value and convert function
 
 **Constructor**
 
-> ` def initialize(temperature, mode) `
+> def initialize(temperature, mode)
 
-The initialization process retrieve temperature user input and specific Temperature Mode and store temperature in celsius form.<br>
-[param] temperature: float --> the temperature value<br>
-[param] mode: TemperatureMode --> the temperature unit (Fahrenheit, Celsius or Kelvin)<br>
-Note the TemperatureMode is an enumerate that holds value of TemperatureMode::Celsius, TemperatureMode::Fahrenheit or TemperatureMode::Kelvin. The implementation is:<br>
+>> The initialization process retrieve temperature user input and specific Temperature Mode and store temperature in celsius form.<br>
+>> [param] temperature: float --> the temperature value<br>
+>> [param] mode: TemperatureMode --> the temperature unit (Fahrenheit, Celsius or Kelvin)<br>
+>> Note the TemperatureMode is an enumerate that holds value of TemperatureMode::Celsius, TemperatureMode::Fahrenheit or TemperatureMode::Kelvin. The implementation is:<br>
 
 ```ruby
 module TemperatureMode
@@ -26,30 +26,30 @@ end
 
 **method**
 
-> ` def toFahrenheit() `
+> def toFahrenheit()
 
-Convert the temperature to Fahrenheit<br>
-[return] temperature in Fahrenheit, type in float<br>
+>> Convert the temperature to Fahrenheit<br>
+>> [return] temperature in Fahrenheit, type in float<br>
 
-> ` def toKelvin() `
+> def toKelvin()
 
-Convert the temperature to Kelvin<br>
-[return] temperature in Kelvin, type in float<br>
+>> Convert the temperature to Kelvin<br>
+>> [return] temperature in Kelvin, type in float<br>
 
 **Property**
 
-> ` this.temperature `
+> attr_reader :temperature  # default save in Celsius
 
-temperature in Celsius, type in float
+>> temperature in Celsius, type in float
 
 ## Get Start
 
 Use following script for testing
 
 ```ruby
-temp = Temperature.new(-24, 1)
+temp = Temperature.new(-24, 1) # construct 24 degree Celsius
 
-puts temp.toString
-puts "Current temperature is #{'%.2f' % temp.toFahrenheit} °F"
-puts "Current temperature is #{'%.2f' % temp.toKelvin} K"
+puts temp.toString  # the struct default save in Celsius
+puts "Current temperature is #{'%.2f' % temp.toFahrenheit} °F"  ## Convert to Fahrenheit
+puts "Current temperature is #{'%.2f' % temp.toKelvin} K"  ## Convert to Fahrenheit
 ```

data/lib/tempture_convertor.rb

@@ -10,38 +10,26 @@ module TemperatureMode
   Kelvin = 4
 end
 
-
+# temperature class
 class Temperature
-  # temperature class
   
+  # initial temperature (load & save in celsius form)
   def initialize(temperature, mode)
-    # initial temperature (load & save in celsius form)
+    temp = temperature.to_f
 
     # first check the mode
     case mode
     when TemperatureMode::Celsius
-      @temperature = temperature
+      @temperature = temp
     when TemperatureMode::Fahrenheit
-      @temperature = Temperature.FahrenheitToCelsius(temperature)
+      @temperature = Temperature.FahrenheitToCelsius(temp)
     when TemperatureMode::Kelvin
-      @temperature = Temperature.KelvinToCelsius(temperature)
+      @temperature = Temperature.KelvinToCelsius(temp)
     else
       # invalid mode met
       raise ArgumentError, "The temperature can only be chosen within fehrenheit, celsius and kelvin!"
     end
 
-    # now use switch case rather than if else
-    # if mode === TemperatureMode::Celsius
-    #   @temperature = temperature
-    # elsif mode === TemperatureMode::Fahrenheit
-    #   @temperature = Temperature.FahrenheitToCelsius(temperature)
-    # elsif mode === TemperatureMode::Kelvin
-    #   @temperature = Temperature.KelvinToCelsius(temperature)
-    # else
-    #   # invalid mode met
-    #   raise ArgumentError, "The temperature can only be chosen within fehrenheit, celsius and kelvin!"
-    # end
-
   end
 
   attr_reader :temperature
@@ -75,12 +63,3 @@ class Temperature
   end
 
 end
-
-if __FILE__ == $0
-  temp = Temperature.new(-24, 1)
-
-  puts temp.toString
-  # puts temp.temperature
-  puts "Current temperature is #{'%.2f' % temp.toFahrenheit} °F"
-  puts "Current temperature is #{'%.2f' % temp.toKelvin} K"
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tempture-convertor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sicheng Zhong
@@ -9,62 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  # Temperature Convertor
-
-  convert temperature from fehrenheit or kelvin to celsius
-
-
-  ## Detail
-
-  The "Temperature" class stores and controls the value and convert function
-
-  **Constructor**
-
-  > ` def initialize(temperature, mode) `
-
-  The initialization process retrieve temperature user input and specific Temperature Mode and store temperature in celsius form.<br>
-  [param] temperature: float --> the temperature value<br>
-  [param] mode: TemperatureMode --> the temperature unit (Fahrenheit, Celsius or Kelvin)<br>
-  Note the TemperatureMode is an enumerate that holds value of TemperatureMode::Celsius, TemperatureMode::Fahrenheit or TemperatureMode::Kelvin. The implementation is:<br>
-
-  ```ruby
-  module TemperatureMode
-    Celsius = 1
-    Fahrenheit = 2
-    Kelvin = 4
-  end
-  ```
-
-  **method**
-
-  > ` def toFahrenheit() `
-
-  Convert the temperature to Fahrenheit<br>
-  [return] temperature in Fahrenheit, type in float<br>
-
-  > ` def toKelvin() `
-
-  Convert the temperature to Kelvin<br>
-  [return] temperature in Kelvin, type in float<br>
-
-  **Property**
-
-  > ` this.temperature `
-
-  temperature in Celsius, type in float
-
-  ## Get Start
-
-  Use following script for testing
-
-  ```ruby
-  temp = Temperature.new(-24, 1)
-
-  puts temp.toString
-  puts "Current temperature is #{'%.2f' % temp.toFahrenheit} °F"
-  puts "Current temperature is #{'%.2f' % temp.toKelvin} K"
-  ```
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -73,7 +17,7 @@ files:
 - lib/tempture_convertor.rb
 homepage: https://github.com/Ayano-Keiko
 licenses:
-- GPL-3.0-only
+- MIT
 metadata: {}
 rdoc_options: []
 require_paths:
@@ -89,7 +33,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.21
 specification_version: 4
 summary: temperature converting between fehrenheit, kelvin and celsius
 test_files: []