joules 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20266cc292103a7a4ec29036bf2eb5eca74653ea
-  data.tar.gz: df55eff3e23043443756fec9ea24ed7351313115
+  metadata.gz: ebea8b8abdde03c40493dc8bccd291448aae450a
+  data.tar.gz: 372309d709a479b124a2f45ca48fe2082cc93898
 SHA512:
-  metadata.gz: f744ec8a76f8a7fac6c7a74295eb01e8d3f29230729b5e447ec6f72d9c0dc6f25aa39dce9eb9c476a706a195196d1ba21932e27d52f9247aea646776836628db
-  data.tar.gz: 7f49d574908f32acb1c75332ee4f1e2d5f81413f4ad215049fc6122a820cd66386fc4039400b44857f08134bda28c136cf2fe6c254504cf0e9eb51d5fe2b175e
+  metadata.gz: d9b14eca944849f3a96e0d739bd2afa12d3a59d6a587a035b6696fe792c26cc3634c522c878207060afba456f1a8b5c9217a9796085a0cb70b6e434299cf3d70
+  data.tar.gz: 7958efaaca9e74f5d623d305cb62eaf3d37755647455fc4c3e2df6088673c89c15d354e233084c2b04313ac47e60fb20054fa20582bdc9fee3c3d7aa4e91cfd4

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+#### Version 0.0.1
+* Added Physics formulas in kinematics, mass, weight, density, forces, momentum, impulse, energy, work, power, and pressure
+* Added the following Physics constants: speed of light in free space and acceleration of free fall
+
+#### Version 0.0.2
+* Fixed publishing date in gem specification
+
+#### Version 0.0.3
+* Added the following Physics constants: permeability of free space, permittivity of free space, elementary charge, Planck constant, unified atomic mass unit, rest mass of electron, rest mass of proton, molar gas constant, avogadro constant, Boltzmann constant, and gravitational constant
+
+#### Version 0.1.0
+* Added Physics formulas in waves and thermodynamics
+* Added the following Physics constants: rest mass of neutron, Stefan constant, and Wien constant
+* Updated existing documentation style to YARD documentation style
+
+#### Version 0.2.0
+* Added Physics formulas in electricity
+* Added geometric and conversion formulas commonly used in Physics
+
+#### Version 0.3.0
+* Added Physics formulas in quantum
+* Added more geometric and conversion formulas commonly used in Physics
+
+#### Version 0.3.1
+* Added Physics formulas in gravitational fields and electric fields
+
+#### Version 0.3.2
+* Added Physics formulas in magnetic fields, stress, and strain
+
+#### Version 0.4.0
+* Added Physics formulas in circular motion
+
+#### Version 0.4.1
+* Added Physics formulas in oscillations
+
+#### Version 0.4.2
+* Added more Physics formulas in electricity and force
+* Added more geometric formulas commonly used in Physics

data/README.md

@@ -1,8 +1,9 @@
 ![Joules Logo](https://cloud.githubusercontent.com/assets/7763904/7764836/ef617b0a-0024-11e5-8044-3cf354a4a306.png)
 
-[![forthebadge](http://forthebadge.com/images/badges/built-with-ruby.svg)](http://forthebadge.com)
+[![Ruby Badge](http://forthebadge.com/images/badges/built-with-ruby.svg)](http://forthebadge.com)
 
 [![Gem Version](https://badge.fury.io/rb/joules.svg)](http://badge.fury.io/rb/joules)
+[![Inline Docs](http://inch-ci.org/github/elailai94/joules.svg?style=shields)](https://inch-ci.org/github/elailai94/Joules)
 
 ### About
 Joules is a library (gem) for providing simple Physics formulas in kinematics, forces, waves, electricity, and so much more. A selection of fundamental constants are also provided. It is written entirely in Ruby.
@@ -15,7 +16,7 @@ gem build joules.gemspec
 
 ### Library Installation
 ```Bash
-gem install joules-0.4.1.gem
+gem install joules-0.4.2.gem
 ```
 
 ### Library Import
@@ -36,42 +37,6 @@ Joules.power(Joules.work_done(40, 2.34), 4)
 This would return 23.4.
 > Note: For documentation on usage of methods and constants, please visit [http://www.rubydoc.info/gems/joules/](http://www.rubydoc.info/gems/joules/).
 
-### Change Log
-#### Version 0.0.1
-* Added Physics formulas in kinematics, mass, weight, density, forces, momentum, impulse, energy, work, power, and pressure
-* Added the following Physics constants: speed of light in free space and acceleration of free fall
-
-#### Version 0.0.2
-* Fixed publishing date in gem specification
-
-#### Version 0.0.3
-* Added the following Physics constants: permeability of free space, permittivity of free space, elementary charge, Planck constant, unified atomic mass unit, rest mass of electron, rest mass of proton, molar gas constant, avogadro constant, Boltzmann constant, and gravitational constant
-
-#### Version 0.1.0
-* Added Physics formulas in waves and thermodynamics
-* Added the following Physics constants: rest mass of neutron, Stefan constant, and Wien constant
-* Updated existing documentation style to YARD documentation style
-
-#### Version 0.2.0
-* Added Physics formulas in electricity
-* Added geometric and conversion formulas commonly used in Physics
-
-#### Version 0.3.0
-* Added Physics formulas in quantum
-* Added more geometric and conversion formulas commonly used in Physics
-
-#### Version 0.3.1
-* Added Physics formulas in gravitational fields and electric fields
-
-#### Version 0.3.2
-* Added Physics formulas in magnetic fields, stress, and strain
-
-#### Version 0.4.0
-* Added Physics formulas in circular motion
-
-#### Version 0.4.1
-* Added Physics formulas in oscillations
-
 ### Contribution
 Please feel free to submit any ideas, questions, or problems by reporting an issue. 
 

data/lib/joules/circular_motion.rb

@@ -3,13 +3,15 @@
 #
 # @description: Module for providing circular motion formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Circular motion module (circular_motion.rb)
 
 module Joules
   module_function
+  
+  # @!group Circular Motion Methods
 
   # Calculates the angular velocity given linear velocity and radius.
   # @param linear_velocity [Int, Float]
@@ -157,4 +159,6 @@ module Joules
     return 0.5 * moment_of_inertia * (angular_velocity ** 2)
   end
 
+  # @!endgroup
+
 end

data/lib/joules/constants.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Constants module (constants.rb)

data/lib/joules/conversion.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing conversion formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Conversion module (conversion.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Angle Conversion Methods
+
   # Calculates the equivalent angle in degrees given radians.
   # @param angle [Int, Float]
   #   angle is in radians
@@ -33,6 +35,10 @@ module Joules
     return (angle * Math::PI) / 180
   end
 
+  # @!endgroup
+
+  # @!group Temperature Conversion Methods
+
   # Calculates the equivalent temperature in kelvins given celcius.
   # @param temperature [Int, Float]
   #   temperature is in celcius
@@ -55,6 +61,10 @@ module Joules
     return temperature - 273.15
   end
 
+  # @!endgroup
+
+  # @!group Velocity Conversion Methods
+
   # Calculates the equivalent velocity in metres per second given kilometres per hour.
   # @param velocity [Int, Float]
   #   velocity is in kilometres per hour
@@ -77,4 +87,6 @@ module Joules
     return (velocity * 3600) / 1000.0
   end
 
+  # @!endgroup
+
 end

data/lib/joules/density.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing density formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Density module (density.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Density Methods
+
   # Calculates the density given mass and volume.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
@@ -29,4 +31,6 @@ module Joules
     end
   end
 
+  # @!endgroup
+
 end

data/lib/joules/electric_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing electric fields formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Electric fields module (electric_fields.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Electric Fields Methods
+
   # Calculates the electric field strength given voltage and distance between two plates.
   # @param voltage [Int, Float]
   #   voltage is in volts
@@ -100,4 +102,6 @@ module Joules
     return voltage * (charge / ELEMENTARY_CHARGE)
   end
 
+  # @!endgroup
+
 end

data/lib/joules/electricity.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing electricity formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Electricity module (electricity.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Electricity Methods
+
   # Calculates the current given charge and time.
   # @param charge [Int, Float]
   #   charge is in coulombs
@@ -20,8 +22,9 @@ module Joules
   #   return value is in amperes
   # @raise [ZeroDivisionError] if time = 0
   # @example
-  #   Joules.current(325, 5) #=> 65.0
-  def current(charge, time)
+  #   Joules.current_v1(325, 5) #=> 65.0
+  # @note There is one other method for calculating current.
+  def current_v1(charge, time)
     if time.zero?
       raise ZeroDivisionError.new('divided by 0')
     else
@@ -29,6 +32,24 @@ module Joules
     end
   end
 
+  # Calculates the current given cross sectional area, charge density, drift velocity, and charge.
+  # @param cross_sectional_area [Int, Float]
+  #   cross_sectional_area >= 0; cross_sectional_area is in metres squared
+  # @param charge_density [Int, Float]
+  #   charge_density is in per metres cubed
+  # @param drift_velocity [Int, Float]
+  #   drift_velocity is in metres per second
+  # @param charge [Int, Float]
+  #   charge is in coulombs
+  # @return [Float]
+  #   return value is in amperes
+  # @example
+  #   Joules.current_v2(0.9, 5e28, 8e-4, 1.6e-19) #=> 5759999.999999999
+  # @note There is one other method for calculating current.
+  def current_v2(cross_sectional_area, charge_density, drift_velocity, charge)
+    return cross_sectional_area * charge_density * drift_velocity * charge
+  end
+
   # Calculates the resistance given voltage and current.
   # @param voltage [Int, Float]
   #   voltage is in volts
@@ -298,4 +319,6 @@ module Joules
     return power_v2(voltage, current) * time
   end
 
+  # @!endgroup
+
 end

data/lib/joules/energy_work_power.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing energy, work, and power formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Energy, Work, and Power Methods
+
   # Calculates the gravitational potential energy given mass and height.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
@@ -137,4 +139,6 @@ module Joules
     end
   end
 
+  # @!endgroup
+
 end

data/lib/joules/forces.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Forces module (forces.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Forces Methods
+
   # Calculates the force given mass and acceleration.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
@@ -75,6 +77,19 @@ module Joules
     return coefficient_of_friction * normal_force.to_f
   end
 
+  # Calculates the buoyant force given density and volume of liquid displaced.
+  # @param density [Int, Float]
+  #   density >= 0; density is in kilograms per metre cubed
+  # @param volume_of_liquid_displaced [Int, Float]
+  #   volume_of_liquid_displaced >= 0; volume_of_liquid_displaced is in metres cubed
+  # @return [Float]
+  #   return value >= 0; return value is in newtons
+  # @example
+  #   Joules.buoyant_force(1000, 0.00150) #=> 14.715
+  def buoyant_force(density, volume_of_liquid_displaced)
+    return density * FREE_FALL_ACCELERATION * volume_of_liquid_displaced
+  end
+
   # Calculates the moment given force, distance, and angle.
   # @param force [Int, Float]
   #   force is in newtons
@@ -90,4 +105,6 @@ module Joules
     return force * distance * Math.sin(to_radians(angle))
   end
 
+  # @!endgroup
+
 end

data/lib/joules/geometry.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing geometry formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Geometry module (geometry.rb)
@@ -11,18 +11,7 @@
 module Joules
   module_function
 
-  # Calculates the area of a rectangle given length and width.
-  # @param length [Int, Float]
-  #   length >= 0; length is in a unit of length
-  # @param width [Int, Float]
-  #   width >= 0; width has the same units as length
-  # @return [Float]
-  #   return value >= 0; return value has the same units squared as length 
-  # @example
-  #   Joules.rectangle_area(2, 3.4) #=> 6.8
-  def rectangle_area(length, width)
-    return length * width.to_f
-  end
+  # @!group Arc Length Method
 
   # Calculates the arc length of a circle given radius and central angle.
   # @param radius [Int, Float]
@@ -37,6 +26,10 @@ module Joules
     return radius * central_angle.to_f
   end
 
+  # @!endgroup
+
+  # @!group Circumference Method
+
   # Calculates the circumference of a circle given radius.
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
@@ -48,6 +41,51 @@ module Joules
     return 2 * Math::PI * radius
   end
 
+  # @!endgroup
+
+  # @!group Area Methods
+
+  # Calculates the area of a triangle given base and height.
+  # @param base [Int, Float]
+  #   base >= 0; base is in a unit of length
+  # @param height [Int, Float]
+  #   height >= 0; height has the same units as base
+  # @return [Float]
+  #   return value >= 0; return value has the same units squared as base
+  # @example
+  #   Joules.triangle_area(2, 3.4) #=> 3.4
+  def triangle_area(base, height)
+    return 0.5 * base * height
+  end
+
+  # Calculates the area of a trapezium given top base, bottom base, and height.
+  # @param top_base [Int, Float]
+  #   top_base >= 0; top_base is in a unit of length
+  # @param bottom_base [Int, Float]
+  #   bottom_base >= 0; bottom_base has the same units as top_base
+  # @param height [Int, Float]
+  #   height >= 0; height has the same units as top_base
+  # @return [Float]
+  #   return value >= 0; return value has the same units squared as top_base
+  # @example
+  #   Joules.trapezium_area(10, 15, 3) #=> 37.5
+  def trapezium_area(top_base, bottom_base, height)
+    return 0.5 * (top_base + bottom_base) * height
+  end
+
+  # Calculates the area of a rectangle given length and width.
+  # @param length [Int, Float]
+  #   length >= 0; length is in a unit of length
+  # @param width [Int, Float]
+  #   width >= 0; width has the same units as length
+  # @return [Float]
+  #   return value >= 0; return value has the same units squared as length 
+  # @example
+  #   Joules.rectangle_area(2, 3.4) #=> 6.8
+  def rectangle_area(length, width)
+    return length * width.to_f
+  end
+
   # Calculates the area of a circle given radius.
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
@@ -59,16 +97,9 @@ module Joules
     return Math::PI * (radius ** 2)
   end
 
-  # Calculates the surface area of a sphere given radius.
-  # @param radius [Int, Float]
-  #   radius >= 0; radius is in a unit of length
-  # @return [Float]
-  #   return value >= 0; return value has the same units squared as radius
-  # @example
-  #   Joules.sphere_surface_area(12) #=> 1809.5573684677208
-  def sphere_surface_area(radius)
-    return 4 * circle_area(radius)
-  end
+  # @!endgroup
+
+  # @!group Volume Methods
 
   # Calculates the volume of a sphere given radius.
   # @param radius [Int, Float]
@@ -81,19 +112,6 @@ module Joules
     return (4 * circle_area(radius) * radius) / 3
   end
 
-  # Calculates the surface area of a cone given radius and slant height.
-  # @param radius [Int, Float]
-  #   radius >= 0; radius is in a unit of length
-  # @param slant_height [Int, Float]
-  #   slant_height >= 0; slant_height has the same units as radius
-  # @return [Float]
-  #   return value >= 0; return value has the same units squared as radius
-  # @example
-  #   Joules.cone_surface_area(3, 5.83) #=> 83.22078939359362
-  def cone_surface_area(radius, slant_height)
-    return circle_area(radius) + (Math::PI * radius * slant_height)
-  end
-
   # Calculates the volume of a cone given radius and height.
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
@@ -107,30 +125,60 @@ module Joules
     return (circle_area(radius) * height) / 3
   end
 
-  # Calulates the surface area of a cylinder given radius and height.
+  # Calculates the volume of a cylinder given radius and height.
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
   # @param height [Int, Float]
   #   height >= 0; height has the same units as radius
   # @return [Float]
+  #   return value >= 0; return value has the same units cubed as radius
+  # @example
+  #   Joules.cylinder_volume(6.5, 3) #=> 398.196868842506 
+  def cylinder_volume(radius, height)
+    return circle_area(radius) * height
+  end
+
+  # @!endgroup
+
+  # @!group Surface Area Methods
+
+  # Calculates the surface area of a sphere given radius.
+  # @param radius [Int, Float]
+  #   radius >= 0; radius is in a unit of length
+  # @return [Float]
   #   return value >= 0; return value has the same units squared as radius
   # @example
-  #   Joules.cylinder_surface_area(6.5, 3) #=> 122.522113490002
-  def cylinder_surface_area(radius, height)
-    return circumference(radius) * height
+  #   Joules.sphere_surface_area(12) #=> 1809.5573684677208
+  def sphere_surface_area(radius)
+    return 4 * circle_area(radius)
   end
 
-  # Calculates the volume of a cylinder given radius and height.
+  # Calculates the surface area of a cone given radius and slant height.
+  # @param radius [Int, Float]
+  #   radius >= 0; radius is in a unit of length
+  # @param slant_height [Int, Float]
+  #   slant_height >= 0; slant_height has the same units as radius
+  # @return [Float]
+  #   return value >= 0; return value has the same units squared as radius
+  # @example
+  #   Joules.cone_surface_area(3, 5.83) #=> 83.22078939359362
+  def cone_surface_area(radius, slant_height)
+    return circle_area(radius) + (Math::PI * radius * slant_height)
+  end
+
+  # Calulates the surface area of a cylinder given radius and height.
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
   # @param height [Int, Float]
   #   height >= 0; height has the same units as radius
   # @return [Float]
-  #   return value >= 0; return value has the same units cubed as radius
+  #   return value >= 0; return value has the same units squared as radius
   # @example
-  #   Joules.cylinder_volume(6.5, 3) #=> 398.196868842506 
-  def cylinder_volume(radius, height)
-    return circle_area(radius) * height
+  #   Joules.cylinder_surface_area(6.5, 3) #=> 122.522113490002
+  def cylinder_surface_area(radius, height)
+    return circumference(radius) * height
   end
 
+  # @!group  
+
 end

data/lib/joules/gravitational_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing gravitational fields formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Gravitational fields module (gravitational_fields.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Gravitational Fields Methods
+
   # Calculates the gravitational force given object mass 1, object mass 2, and distance between the centres of the two objects.
   # @param object_mass1 [Int, Float]
   #   object_mass1 >= 0; object_mass1 is in kilograms
@@ -88,4 +90,6 @@ module Joules
     end
   end
 
+  # @!endgroup
+
 end

data/lib/joules/kinematics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Kinematics Methods
+
   # Calculates the average speed given distance and time.
   # @param distance [Int, Float]
   #   distance >= 0; distance is in metres
@@ -147,4 +149,6 @@ module Joules
     return (final_velocity * time) - (0.5 * acceleration * (time ** 2))
   end
 
+  # @!endgroup
+
 end

data/lib/joules/magnetic_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing magnetic fields formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Magnetic fields module (magnetic_fields.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Magnetic Fields Methods
+
   # Calculates the magnetic force on a current given flux density, current, conductor length, and angle.
   # @param flux_density [Int, Float]
   #   flux_density is in teslas
@@ -75,4 +77,6 @@ module Joules
     return magnetic_flux * number_of_coils.to_f
   end
 
+  # @!endgroup
+
 end

data/lib/joules/mass_weight.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Mass and Weight Methods
+
   # Calculates the weight given mass.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
@@ -33,4 +35,6 @@ module Joules
     return weight / FREE_FALL_ACCELERATION
   end
 
+  # @!endgroup
+
 end

data/lib/joules/momentum_impulse.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Momentum and Impulse Methods
+
   # Calculates the momentum given mass and velocity.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
@@ -54,4 +56,6 @@ module Joules
     return (final_velocity - initial_velocity) * mass.to_f
   end
 
+  # @!endgroup
+
 end

data/lib/joules/oscillations.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing oscillations formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Oscillations module (oscillations.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Oscillations Methods
+
   # Calculates the acceleration of a particle in oscillation given angular velocity and particle displacement.
   # @param angular_velocity [Int, Float]
   #   angular_velocity is in radians per second
@@ -121,4 +123,6 @@ module Joules
     return 2 * Math::PI * ((pendulum_length / FREE_FALL_ACCELERATION) ** 0.5)
   end
 
+  # @!endgroup
+
 end

data/lib/joules/pressure.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Pressure Methods
+
   # Calculates the pressure given force and area.
   # @param force [Int, Float]
   #   force >= 0; force is in newtons
@@ -42,4 +44,6 @@ module Joules
     return density * FREE_FALL_ACCELERATION * height
   end
 
+  # @!endgroup
+
 end

data/lib/joules/quantum.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing quantum formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Quantum module (quantum.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Quantum Methods
+
   # Calculates the photon energy given frequency.
   # @param frequency [Int, Float]
   #   frequency > 0; frequency is in hertz
@@ -66,4 +68,6 @@ module Joules
     end
   end
 
+  # @!endgroup
+
 end

data/lib/joules/stress_strain.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing stress and strain formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Stress and strain module (stress_strain.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Stress and Strain Methods
+
   # Calculates the tensile stress given force and area.
   # @param force [Int, Float]
   #   force >= 0; force is in newtons
@@ -65,4 +67,6 @@ module Joules
     end
   end
 	
+  # @!endgroup
+
 end

data/lib/joules/thermodynamics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing thermodynamics formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Thermodynamics module (thermodynamics.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Thermodynamics Methods
+
   # Calculates the energy given mass, specific heat capacity, and temperature change.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
@@ -41,4 +43,6 @@ module Joules
     return mass * specific_latent_heat.to_f
   end
 
+  # @!endgroup
+
 end

data/lib/joules/waves.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing waves formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Waves module (waves.rb)
@@ -11,6 +11,8 @@
 module Joules
   module_function
 
+  # @!group Waves Methods
+
   # Calculates the wave speed given frequency and wavelength.
   # @param frequency [Int, Float]
   #   frequency > 0; frequency is in hertz
@@ -182,4 +184,6 @@ module Joules
     end
   end
 
+  # @!endgroup
+
 end

data/lib/joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.4.1 07/06/2015
+# @version: 0.4.2 10/06/2015
 #==============================================================================
 
 # Joules module (joules.rb)

data/test/test_joules.rb

@@ -0,0 +1,30 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for testing the Joules module
+# @author: Elisha Lai
+# @version: 0.4.2 10/06/2015
+#==============================================================================
+
+# Testing module for joules.rb (test_joules.rb)
+
+require 'test/unit'
+require 'joules'
+include Joules
+
+EPSILON = 0.00001
+
+# Unit tests for kinematics module
+class KinematicsTests < Test::Unit::TestCase
+  def test_avg_speed_extreme_1
+    assert_in_epsilon(0, avg_speed(0,0.001), EPSILON)
+  end
+
+  def test_avg_speed_extreme_2
+    assert_in_epsilon(1.03010, avg_speed(928476103, 901348726), EPSILON)
+  end
+
+  def test_avg_speed_big_divisor
+    assert_in_epsilon(6.32386e-09, avg_speed(5.7, 901348726), EPSILON)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-07 00:00:00.000000000 Z
+date: 2015-06-10 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
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - lib/joules.rb
@@ -41,6 +42,7 @@ files:
 - lib/joules/stress_strain.rb
 - lib/joules/thermodynamics.rb
 - lib/joules/waves.rb
+- test/test_joules.rb
 homepage: http://elailai94.github.io/Joules
 licenses:
 - MIT