joules 0.3.1 → 0.3.2

data/lib/joules/waves.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing waves formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Waves module (waves.rb)
@@ -15,9 +15,9 @@ module Joules
   # @param frequency [Int, Float]
   #   frequency > 0; frequency is in hertz
   # @param wavelength [Int, Float]
-  #   wavelength >= 0; wavelength is in meters
+  #   wavelength >= 0; wavelength is in metres
   # @return [Float]
-  #   return value >= 0; return value is in meters per second
+  #   return value >= 0; return value is in metres per second
   # @example
   #   Joules.wave_speed(3250, 0.1) #=> 325.0
   def wave_speed(frequency, wavelength)
@@ -26,29 +26,39 @@ module Joules
 
   # Calculates the wavelength given wave speed and frequency.
   # @param wave_speed [Int, Float]
-  #   wave_speed >= 0; wave_speed is in meters per second
+  #   wave_speed >= 0; wave_speed is in metres per second
   # @param frequency [Int, Float]
   #   frequency > 0; frequency is in hertz
   # @return [Float]
-  #   return value is in meters
+  #   return value is in metres
+  # @raise [ZeroDivisionError] if frequency = 0
   # @example
   #   Joules.wavelength(325, 3250) #=> 0.1
   def wavelength(wave_speed, frequency)
-    return wave_speed / frequency.to_f
+    if frequency.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return wave_speed / frequency.to_f
+    end
   end
 
   # Calculates the frequency given wave speed and wavelength.
   # @param wave_speed [Int, Float]
-  #   wave_speed >= 0; wave_speed is in meters per second
+  #   wave_speed >= 0; wave_speed is in metres per second
   # @param wavelength [Int, Float]
-  #   wavelength > 0; wavelength is in meters
+  #   wavelength > 0; wavelength is in metres
   # @return [Float]
   #   return value is in hertz
+  # @raise [ZeroDivisionError] if wavelength = 0
   # @example
   #   Joules.frequency_v1(325, 0.1) #=> 3250.0
   # @note There is one other method for calculating frequency.
   def frequency_v1(wave_speed, wavelength)
-    return wave_speed / wavelength.to_f
+    if wavelength.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return wave_speed / wavelength.to_f
+    end
   end
 
   # Calculates the frequency given time period.
@@ -56,11 +66,16 @@ module Joules
   #   time_period > 0; time_period is in seconds
   # @return [Float]
   #   return value > 0; return value is in hertz
+  # @raise [ZeroDivisionError] if time_period = 0
   # @example
   #   Joules.frequency_v2(12.5) #=> 0.08
   # @note There is one other method for calculating frequency.
   def frequency_v2(time_period)
-    return 1.0 / time_period
+    if time_period.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return 1.0 / time_period
+    end
   end
 
   # Calculates the time period given frequency.
@@ -68,35 +83,50 @@ module Joules
   #   frequency > 0; frequency is in hertz
   # @return [Float]
   #   return value > 0; return value is in hertz
+  # @raise [ZeroDivisionError] if frequency = 0
   # @example
   #   Joules.time_period(0.08) #=> 12.5
   def time_period(frequency)
-    return 1.0 / frequency
+    if frequency.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return 1.0 / frequency
+    end
   end
 
   # Calculates the refractive index of a substance given angle of incidence and angle of refraction.
   # @param angle_of_incidence [Int, Float]
   #   angle_of_incidence is in degrees
   # @param angle_of_refraction [Int, Float]
-  #   angle_of_refraction is in degrees
+  #   angle_of_refraction != 0; angle_of_refraction is in degrees
   # @return [Float]
+  # @raise [ZeroDivisionError] if angle_of_refraction = 0
   # @example
   #   Joules.refractive_index_v1(50, 35) #=> 1.3355577296591308
   # @note There is one other method for calculating refractive index.
   def refractive_index_v1(angle_of_incidence, angle_of_refraction)
-    return Math.sin(to_radians(angle_of_incidence)) /
-           Math.sin(to_radians(angle_of_refraction))
+    if angle_of_refraction.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return Math.sin(to_radians(angle_of_incidence)) /
+             Math.sin(to_radians(angle_of_refraction))
+    end
   end
 
   # Calculates the refractive index of a substance given critical angle.
   # @param critical_angle [Int, Float]
   #   critical_angle != 0; critical_angle is in degrees
   # @return [Float]
+  # @raise [ZeroDivisionError] if critical_angle = 0
   # @example
   #   Joules.refractive_index_v2(48.7535) #=> 1.3299993207924483
   # @note There is one other method for calculating refractive index.
   def refractive_index_v2(critical_angle)
-    return 1.0 / Math.sin(to_radians(critical_angle))
+    if critical_angle.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return 1.0 / Math.sin(to_radians(critical_angle))
+    end
   end
 
   # Calculates the magnification given image height and object height.
@@ -106,34 +136,49 @@ module Joules
   #   object_height > 0; object_height has the same units as image_height
   # @return [Float]
   #   return value >= 0
+  # @raise [ZeroDivisionError] if object_height = 0
   # @example
   #   Joules.magnification(10, 5) #=> 2.0 
   def magnification(image_height, object_height)
-    return image_height / object_height.to_f
+    if object_height.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return image_height / object_height.to_f
+    end
   end
 
   # Calculates the focal length of a lens given object distance and image distance.
   # @param object_distance [Int, Float]
-  #   object_distance > 0; object_distance is in meters
+  #   object_distance > 0; object_distance is in metres
   # @param image_distance [Int, Float]
-  #   image_distance > 0; image_distance is in meters
+  #   image_distance > 0; image_distance is in metres
   # @return [Float]
-  #   return value >= 0; return value is in meters
+  #   return value >= 0; return value is in metres
+  # @raise [ZeroDivisionError] if object_distance = 0 or image_distance = 0
   # @example
   #   Joules.focal_length(45.7, 22.8) #=> 15.21109489051095
   def focal_length(object_distance, image_distance)
-    return 1 / ((1.0 / object_distance) + (1.0 / image_distance))
+    if object_distance.zero? || image_distance.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return 1 / ((1.0 / object_distance) + (1.0 / image_distance))
+    end
   end
 
   # Calculates the power of a lens given focal length.
   # @param focal_length [Int, Float]
-  #   focal_length > 0; focal_length is in meters
+  #   focal_length > 0; focal_length is in metres
   # @return [Float]
   #   return value > 0; return value is in dioptres
+  # @raise [ZeroDivisionError] if focal_length = 0
   # @example
   #   Joules.power_of_lens(2) #=> 0.5
   def power_of_lens(focal_length)
-    return 1.0 / focal_length
+    if focal_length.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return 1.0 / focal_length
+    end
   end
 
 end

data/lib/joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Joules module (joules.rb)
@@ -15,6 +15,7 @@ require 'joules/density'
 require 'joules/forces'
 require 'joules/momentum_impulse'
 require 'joules/energy_work_power'
+require 'joules/stress_strain'
 require 'joules/pressure'
 require 'joules/thermodynamics'
 require 'joules/waves'
@@ -22,5 +23,6 @@ require 'joules/electricity'
 require 'joules/quantum'
 require 'joules/gravitational_fields'
 require 'joules/electric_fields'
+require 'joules/magnetic_fields'
 require 'joules/geometry'
 require 'joules/conversion'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies: []
 description: "    Joules is a library (gem) for providing simple Physics formulas\n
   \   in kinematics, forces, waves, electricity, and so much more. A\n    selection
@@ -31,10 +31,12 @@ files:
 - lib/joules/geometry.rb
 - lib/joules/gravitational_fields.rb
 - lib/joules/kinematics.rb
+- lib/joules/magnetic_fields.rb
 - lib/joules/mass_weight.rb
 - lib/joules/momentum_impulse.rb
 - lib/joules/pressure.rb
 - lib/joules/quantum.rb
+- lib/joules/stress_strain.rb
 - lib/joules/thermodynamics.rb
 - lib/joules/waves.rb
 homepage: http://elailai94.github.io/Joules