joules 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 099b17d28098801dae8781ee30b0bbcf4cee23a8
-  data.tar.gz: b2b53b493896f5bccfa160f663996c541ff1563e
+  metadata.gz: 7fa6d4e049d98465e2aee9e2a6eb52a2c2b51be3
+  data.tar.gz: 2ed2e3097bfb314308a4cff1818ed22dfcea9287
 SHA512:
-  metadata.gz: d01e73b536d71dcac4af085b7d04393af6e8052ef5920e19f19ce3f97c7857134b3fa7ae4298f671a0e256aa87a62b46195cb2fa48ad4d66aa098be5a00eba06
-  data.tar.gz: a214b4986b5f565e8c39568bc4c75ff9516d6cf22f59f1ce46bc0eec733bb65ba0eeae2e97448a4ba5f338cfe46f7aab97cb02ae6afb6bdc2382ac1ec767ee2c
+  metadata.gz: 080419812694ae0ed5eae62674e2c5b788617e4e2d3e92dc480563a79874c62124b5bee330a96d11ed78598c7eeb368c66ee5bd1c24cf4d152ec79cd32372cc6
+  data.tar.gz: ebbab7100a001d5b9898a0974a37dbf304fe432bef2d4002d7a75964b67618a9df12721c24b27206f1f4e1dc36c14e31977486d175d6b66545705841e05e6276

data/CHANGELOG.md

@@ -39,3 +39,6 @@
 
 #### Version 0.4.3
 * Added more Physics formulas in waves
+
+#### Version 0.4.4
+* Fixed particle acceleration method in oscillations module file

data/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+## Contributing to Joules
+In order to make Joules better, **everyone** is encouraged to help improve this project. Before diving into the code, please familiarize yourself with the following guidelines and conventions.
+
+### Getting Started
+1. Install the [Ruby programming language](https://www.ruby-lang.org/en/documentation/installation/) for your platform.
+2. [Fork](https://help.github.com/articles/fork-a-repo/) the project.
+
+   ```Bash
+   # Clone your fork of the repository into the current directory
+   git clone https://github.com/<your-username>/Joules
+   # Navigate to the newly cloned directory
+   cd <repo-name>
+   # Assign the original repository to a remote called "upstream"
+   git remote add upstream git://github.com/elailai94/Joules
+   ```
+3. Get the latest changes from upstream if you forked awhile ago.
+
+   ```Bash
+   git checkout master
+   git pull upstream master
+   ```
+
+4. Run all tests.
+
+   ```Bash
+   rake test
+   ```
+
+### Ways to Contribute
+Here are some ways you can contribute:
+* by using alpha, beta, and pre-release versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing code
+* by refactoring code
+* by closing [issues](https://www.github.com/elailai94/Joules/issues)
+
+### Issues
+The [GitHub issue tracker](https://www.github.com/elailai94/Joules/issues) is used to track bugs and features. 
+#### Bug Reports
+When submitting a bug report, please use the following guidelines:
+
+1. **Use the GitHub issue search** to check if the bug has already been reported.
+2. **Check if the issue has been fixed** by trying to reproduce it using the latest master in the repository.
+3. **Isolate the problem** by creating a reduced test case and a live example.
+4. **Elaborate as much as possible in your report** by including specific information about the environment (e.g.: operating system and version, library (gem) version, etc.) and steps required to reproduce the issue.
+
+#### Feature Requests
+When submitting a feature request, please use the following guidelines:
+
+1. **Use the GitHub issue search** to check if the feature has already been suggested.
+2. **Check if the feature has been introduced** by trying to test for it using the latest *master* in the repostory.
+3. **Elaborate as much as possible in your report** by providing as much detail and context as possible on why your idea fits the scope and aims of the project.
+
+> Note: Contribution enquiries should take place before any significant pull request. Otherwise, you risk spending a lot of time working on something that might be rejected for good reasons.
+
+### Pull Requests
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run ```rake doc:yard``` or ```yard doc```. If your changes are not 100% documented, go back to step 4.
+6. Commit and push your changes.
+7. Submit a [pull request](https://help.github.com/articles/using-pull-requests/) with a clear title and description. Please do not include changes to the gemspec or changelog file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+### Coding Convention
+Although there is currently no strict set of coding or style guidelines, it is advised that you use common sense when contributing code and make an effort to use a similar style to nearby existing code. It is strongly recommended that you read through the [Ruby style guide](https://www.github.com/styleguide/ruby).
+
+### Documentation Convention
+The [YARD documentation style](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md) is used to document code.
+
+### License
+By contributing to Joules, you agree that your contributions will be licensed under its [MIT license](https://www.github.com/elailai94/Joules/blob/master/LICENSE.md).

data/README.md

@@ -17,7 +17,7 @@ gem build joules.gemspec
 
 ### Library Installation
 ```Bash
-gem install joules-0.4.3.gem
+gem install joules-0.4.4.gem
 ```
 
 ### Library Import
@@ -38,8 +38,8 @@ 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/).
 
-### Contribution
-Please feel free to submit any ideas, questions, or problems by reporting an issue. 
+### Contributing
+In order to make Joules better, **everyone** is encouraged to help improve this project. Before diving into the code, please familiarize yourself with the [Guide to Contributing](https://www.github.com/elailai94/Joules/blob/master/CONTRIBUTING.md).
 
 ### License
-* Joules is licensed under the [MIT license](https://github.com/elailai94/Joules/blob/master/LICENSE.md).
+* Joules is licensed under the [MIT license](https://www.github.com/elailai94/Joules/blob/master/LICENSE.md).

data/lib/joules.rb

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

data/lib/joules/circular_motion.rb

@@ -3,14 +3,14 @@
 #
 # @description: Module for providing circular motion formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Circular motion module (circular_motion.rb)
 
 module Joules
   module_function
-  
+
   # @!group Circular Motion Methods
 
   # Calculates the angular velocity given linear velocity and radius.
@@ -23,7 +23,7 @@ module Joules
   # @raise [ZeroDivisionError] if radius = 0
   # @example
   #   Joules.angular_velocity_v1(9, 3) #=> 3.0
-  # @note There is one other method for calculating angular velocity. 
+  # @note There is one other method for calculating angular velocity.
   def angular_velocity_v1(linear_velocity, radius)
     if radius.zero?
       raise ZeroDivisionError.new('divided by 0')
@@ -39,7 +39,7 @@ module Joules
   #   return value >= 0; return value is in radians per second
   # @example
   #   Joules.angular_velocity_v2(1.5) #=> 9.42477796076938
-  # @note There is one other method for calculating angular velocity. 
+  # @note There is one other method for calculating angular velocity.
   def angular_velocity_v2(frequency_of_rotation)
     return 2 * Math::PI * frequency_of_rotation
   end
@@ -114,7 +114,7 @@ module Joules
       raise ZeroDivisionError.new('divided by 0')
     else
       return (mass * (linear_velocity ** 2.0)) / radius
-    end 
+    end
   end
 
   # Calculates the centripetal force given mass, angular velocity, and radius.

data/lib/joules/constants.rb

@@ -3,13 +3,13 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Constants module (constants.rb)
 
 module Joules
-  
+
   # Speed of light in free space.
   # @note This quantity is in metres per second.
   SPEED_OF_LIGHT = 3.00e8
@@ -51,7 +51,7 @@ module Joules
   MOLAR_GAS_CONSTANT = 8.31
 
   # Avogadro constant.
-  # @note This quantity is in per mole. 
+  # @note This quantity is in per mole.
   AVOGADRO_CONSTANT = 6.02e23
 
   # Boltzmann constant.

data/lib/joules/conversion.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing conversion formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Conversion module (conversion.rb)
@@ -71,7 +71,7 @@ module Joules
   # @return [Float]
   #   return value is in metres per second
   # @example
-  #   Joules.to_metres_per_second(200) #=> 55.55555555555556 
+  #   Joules.to_metres_per_second(200) #=> 55.55555555555556
   def to_metres_per_second(velocity)
     return (velocity * 1000) / 3600.0
   end

data/lib/joules/density.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing density formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Density module (density.rb)
@@ -20,7 +20,7 @@ module Joules
   #   volume > 0; volume is in metres cubed
   # @return [Float]
   #   return value >= 0; return value is in kilograms per metre cubed
-  # @raise [ZeroDivisionError] if volume = 0 
+  # @raise [ZeroDivisionError] if volume = 0
   # @example
   #   Joules.density(8.96, 0.002) #=> 4480.0
   def density(mass, volume)

data/lib/joules/electric_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing electric fields formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Electric fields module (electric_fields.rb)

data/lib/joules/electricity.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing electricity formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Electricity module (electricity.rb)
@@ -115,7 +115,7 @@ module Joules
   def resistance_in_parallel(resistances)
     total_resistance = 0
     if resistances.empty?
-      return total_resistance.to_f 
+      return total_resistance.to_f
     else
       resistances.each do |resistance|
         total_resistance += (1.0 / resistance)

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.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
@@ -112,7 +112,7 @@ module Joules
   #   return value >= 0
   # @raise [ZeroDivisionError] if energy_input = 0
   # @example
-  #   Joules.energy_efficiency(16, 20) #=> 80.0 
+  #   Joules.energy_efficiency(16, 20) #=> 80.0
   def energy_efficiency(useful_energy_output, energy_input)
     if energy_input.zero?
       raise ZeroDivisionError.new('divided by 0')

data/lib/joules/forces.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Forces module (forces.rb)
@@ -22,7 +22,7 @@ module Joules
   #   return value is in newtons
   # @example
   #   Joules.force_v1(120, 2.67) #=> 320.4
-  # @note There are two other methods for calculating force. 
+  # @note There are two other methods for calculating force.
   def force_v1(mass, acceleration)
     return mass * acceleration.to_f
   end

data/lib/joules/geometry.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing geometry formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Geometry module (geometry.rb)
@@ -36,7 +36,7 @@ module Joules
   # @return [Float]
   #   return value >= 0; return value has the same units as radius
   # @example
-  #   Joules.circumference(12) #=> 75.398223686155 
+  #   Joules.circumference(12) #=> 75.398223686155
   def circumference(radius)
     return 2 * Math::PI * radius
   end
@@ -79,7 +79,7 @@ module Joules
   # @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 
+  #   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)
@@ -92,7 +92,7 @@ module Joules
   # @return [Float]
   #   return value >= 0; return value has the same units squared as radius
   # @example
-  #   Joules.circle_area(12) #=> 452.38934211693 
+  #   Joules.circle_area(12) #=> 452.38934211693
   def circle_area(radius)
     return Math::PI * (radius ** 2)
   end
@@ -133,7 +133,7 @@ module Joules
   # @return [Float]
   #   return value >= 0; return value has the same units cubed as radius
   # @example
-  #   Joules.cylinder_volume(6.5, 3) #=> 398.196868842506 
+  #   Joules.cylinder_volume(6.5, 3) #=> 398.196868842506
   def cylinder_volume(radius, height)
     return circle_area(radius) * height
   end
@@ -179,6 +179,6 @@ module Joules
     return circumference(radius) * height
   end
 
-  # @!group  
+  # @!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.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Gravitational fields module (gravitational_fields.rb)

data/lib/joules/kinematics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)
@@ -40,7 +40,7 @@ module Joules
   #   return value is in metres per second
   # @raise [ZeroDivisionError] if time = 0
   # @example
-  #   Joules.avg_velocity(180, 4.8) #=> 37.5 
+  #   Joules.avg_velocity(180, 4.8) #=> 37.5
   def avg_velocity(displacement, time)
     if time.zero?
       raise ZeroDivisionError.new('divided by 0')

data/lib/joules/magnetic_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing magnetic fields formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Magnetic fields module (magnetic_fields.rb)

data/lib/joules/mass_weight.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)
@@ -21,7 +21,7 @@ module Joules
   # @example
   #   Joules.weight(79.41) #=> 779.0121
   def weight(mass)
-    return mass * FREE_FALL_ACCELERATION 
+    return mass * FREE_FALL_ACCELERATION
   end
 
   # Calculates the mass given weight.

data/lib/joules/momentum_impulse.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)

data/lib/joules/oscillations.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing oscillations formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Oscillations module (oscillations.rb)
@@ -24,7 +24,7 @@ module Joules
   #   Joules.particle_acceleration(2.4, 3) #=> -17.28
   # @note There is one other method for calculating acceleration.
   def particle_acceleration(angular_velocity, particle_displacement)
-    return (- (angular_velocity ** 2.0) * displacement)
+    return (- (angular_velocity ** 2.0) * particle_displacement)
   end
 
   # Calculates the displacement of a particle in oscillation given amplitude, angular velocity, and time.

data/lib/joules/pressure.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)
@@ -22,7 +22,7 @@ module Joules
   #   return value >= 0; return value is in pascals
   # @raise [ZeroDivisionError] if area = 0
   # @example
-  #   Joules.pressure(98, 0.04) #=> 2450.0 
+  #   Joules.pressure(98, 0.04) #=> 2450.0
   def pressure(force, area)
     if area.zero?
       raise ZeroDivisionError.new('divided by 0')

data/lib/joules/quantum.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing quantum formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Quantum module (quantum.rb)

data/lib/joules/stress_strain.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing stress and strain formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Stress and strain module (stress_strain.rb)
@@ -38,7 +38,7 @@ module Joules
   #   length > 0; length is in metres
   # @return [Float]
   #   return value >= 0
-  # @raise [ZeroDivisionError] if length = 0 
+  # @raise [ZeroDivisionError] if length = 0
   # @example
   #   Joules.tensile_strain(2, 10) #=> 0.2
   def tensile_strain(extension, length)
@@ -66,7 +66,7 @@ module Joules
       return tensile_stress / tensile_strain.to_f
     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.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Thermodynamics module (thermodynamics.rb)

data/lib/joules/waves.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing waves formulas
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Waves module (waves.rb)
@@ -159,7 +159,7 @@ module Joules
   #   return value >= 0
   # @raise [ZeroDivisionError] if object_height = 0
   # @example
-  #   Joules.magnification(10, 5) #=> 2.0 
+  #   Joules.magnification(10, 5) #=> 2.0
   def magnification(image_height, object_height)
     if object_height.zero?
       raise ZeroDivisionError.new('divided by 0')

data/test/test_joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for testing the Joules module
 # @author: Elisha Lai
-# @version: 0.4.3 13/06/2015
+# @version: 0.4.4 05/07/2015
 #==============================================================================
 
 # Testing module for joules.rb (test_joules.rb)
@@ -35,7 +35,7 @@ class CircularMotionTests < Test::Unit::TestCase
   end
 
   def test_angular_velocity_v1_example
-  	assert_in_epsilon(3, angular_velocity_v1(9, 3), EPSILON)
+    assert_in_epsilon(3, angular_velocity_v1(9, 3), EPSILON)
   end
 end
 

metadata

@@ -1,24 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-13 00:00:00.000000000 Z
+date: 2015-07-05 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
-  of fundamental constants are also provided. It is \n    written entirely in Ruby.\n"
+description: |2
+      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.
 email: elisha.lai@outlook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE.md
 - README.md
 - lib/joules.rb