hexa 0.1.4 → 0.2.0

data/README.md

@@ -1,29 +1,51 @@
 # Hexa
 
-TODO: Write a gem description
+Hexa is a gem which provides some objects to work on my math works. There are shapes and objects like circles, squares or cylinders. Each object has its own set of methods like `perimeter`, `volume` or `area`.
 
-## Installation
+There are also extended core objects such as `Fixnum`. They have new methods to simplify operations such as `!`, `prime?` or `sqrt`. 
 
-Add this line to your application's Gemfile:
+For the moment, the project isn't very complete. You can contribute if you want! 
 
-    gem 'hexa'
+## Installation
 
-And then execute:
+If you want to install hexa and start use it:
 
-    $ bundle
+```
+$ gem install hexa
+```
 
-Or install it yourself as:
+Now you can use hexa into IRB or a Ruby file:
 
-    $ gem install hexa
+```ruby
+require "hexa"
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Hexa comes with a set of objects. Objects (Ruby objects) are divided into shapes and objects. Main objects (Ruby) are Circle, Square, Cylinder and Cube. Each constructor accept a Hash of options. Here an example of a IRB session:
+
+```ruby
+>> c = Circle.new :radius => 10
+=> #<Circle:0x00000001a00360 @radius=10, @diameter=20>
+>> c.diameter
+=> 20
+>> c.area
+=> 314.1592653589793
+```
+
+Other objects (such as Cylinder) allows you to pass other object to set attributes.
+
+```ruby
+>> circle = Circle.new :diameter => 10
+=> #<Circle:0x00000001a03b28 @radius=5, @diameter=10>
+>> cylinder = Cylinder.new :radius => circle, :height => 40
+=> #<Cylinder:0x00000001a0b210 @radius=5, @diameter=10, @height=40>
+```
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+If you want to contribute, just fork the project then write and commit your patch. Finally, you can open a pull-request.
+
+## License
+
+Hexa is released under the MIT license. See the `LICENSE` file for more information.

data/lib/hexa/core_ext/fixnum.rb

@@ -0,0 +1,54 @@
+class Fixnum
+
+	# Allows tou to know the factorial of self
+	# @return [Fixnum] factorial of self
+	def factorial
+		if self == 1 or self == 0
+			return 1
+		else
+			return self * (self - 1).factorial
+		end
+	end
+
+	alias :! :factorial
+
+	# @return [Float] the square root of self
+	def sqrt
+		Math.sqrt(self)
+	end
+
+	# Predicate method which allows you to know if the number is a prime number
+	# @return [Boolean]
+	def prime?
+		if self < 2
+			false
+		elsif self == 2
+			true
+		elsif self % 2 == 0
+			false
+		else
+			i = 3
+			while i*i <= self
+				return false if self % i == 0
+				i += 2
+			end
+			return true
+		end
+	end
+
+	# @return [Fixnum] the opposite of self
+	def opposite
+		- self
+	end
+
+	# @return [Float] inverse of self
+	def inverse
+		if self == 0
+			return 0
+		else
+			return 1 / self
+		end
+	end
+
+	alias :reverse :inverse
+end

data/lib/hexa/objects/cube.rb

@@ -0,0 +1,35 @@
+class Cube
+
+  attr_accessor :side
+
+  # Create a new Cube object
+  # @param [Hash] you should specify the :side option. You can either pass
+  # a Fixnum or a Square object.
+  # @return [Cube] a new Cube object
+  def initialize(options = {})
+    if options[:side]
+      if options[:side].instance_of?(Square)
+        @side = options[:side].side
+      elsif options[:side].instance_of?(Fixnum)
+        @side = options[:side]
+      else
+        @side = 1
+      end
+    else
+      @side = 1
+    end
+  end
+
+
+  # @return [Fixnum] the volume of the cube
+  def volume
+    @side ** 3
+  end
+
+  # Same behavior as volume but you can call it without a Cube instance
+  # like Cube::volume(10) => 1000
+  # @return [Fixnum] the volume of a cube with a given
+  def self.volume(side = 1)
+    side ** 3
+  end
+end

data/lib/hexa/shapes/circle.rb

@@ -14,7 +14,7 @@ class Circle
 			@diameter = options[:diameter]
 		else
 			@radius = 1
-			@diamter = 2
+			@diameter = 2
 		end
 	end
 

data/lib/hexa/version.rb

@@ -1,6 +1,6 @@
 module Hexa
 	MAJOR = 0
-	MINOR = 1
-	TINY = 4
+	MINOR = 2
+	TINY = 0
   VERSION = [MAJOR, MINOR, TINY].compact.join(".")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hexa
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies: []
 description: A personnal library to check my math homeworks
 email:
@@ -25,6 +25,8 @@ files:
 - Rakefile
 - hexa.gemspec
 - lib/hexa.rb
+- lib/hexa/core_ext/fixnum.rb
+- lib/hexa/objects/cube.rb
 - lib/hexa/objects/cylinder.rb
 - lib/hexa/shapes/circle.rb
 - lib/hexa/shapes/square.rb