inox_converter 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16c52be56598052d91b9bcb1b3730e2f7ac4a5f6
-  data.tar.gz: 3a76a8d1b4a74fe6a5093f8d22da03921631de5e
+  metadata.gz: 273f9f20df4e38caf13c755db9e3f094f26fc3f1
+  data.tar.gz: 110bd04f470dcd16ca8482d5831a2cdbb94438ac
 SHA512:
-  metadata.gz: 4968bcd70923e21f9fb5191ac676fc9959dcd45ee4e5dc110621751350d18495660e1e6990fc94226d525ec429f81c2eb6668fb420e957f92e7d9bceba3b6dc0
-  data.tar.gz: f0ac1b1744afdac693e83386e171d892d54b25811eee43e65a8ca2683a9db05fae1d98d6ae64d7b1738e81a4b1176fc9edae1896c438f0165729c32986e90d44
+  metadata.gz: daa289f93d854c4e79fefcf369d32a90bb55743b1bdb786352a0d21996a6c442ea343fa5f58846bbf90f5c32eca7679935c2a8b64be42ba30105fbedc4578c2a
+  data.tar.gz: 8f111944841c32c2f6ef6108a0244fec4583634da5806a1494a70474956812015700997c9f6141a684ab412a091a86796a6b4d2b033e252234bde38e7b7a1c27

data/README.md

@@ -1,8 +1,14 @@
 # InoxConverter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/inox_converter`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/vinisilvacar/InoxConverter.svg?branch=master)](https://travis-ci.org/vinisilvacar/InoxConverter)
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/inox_converter.svg)](https://badge.fury.io/rb/inox_converter)
+
+Hi! Welcome to Inox Converter official page!
+Our gem is created to work like a 'swiss army knife' for Ruby developers, bringing a easy and reliable way to convert some formats and units that commonly appear during the developing process.
+You can: convert area, currency, length, mass, volume and format time and date.
+You want to use one unit that doesn't exist in our gem? You can add that unit too!
+And more... As a framework you can extend our gem and create your own convertions type.
 
 ## Installation
 
@@ -22,7 +28,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To make a conversion:
+
+<i>
+- valueToConvert: the value you want to convert
+- firstUnit: actual unit -> string
+- secondUnit: the unit you want to convert to -> string 
+</i>
+
+- InoxConverter.convertCurrency(valueToConvert, firstUnit, secondUnit)
+- InoxConverter.convertLenght(valueToConvert, firstUnit, secondUnit)
+- InoxConverter.convertVolume(valueToConvert, firstUnit, secondUnit)
+- InoxConverter.convertArea(valueToConvert, firstUnit, secondUnit)
+- InoxConverter.convertMass(valueToConvert, firstUnit, secondUnit)
+- InoxConverter.convertTime(valueToConvert, firstUnit, secondUnit)
+
+Example:
+```ruby
+InoxConverter.convertLenght(10, 'meter', 'kilometer')
+```
+
+To add a unit:
+
+<i>
+- newUnit: name of the new unit to be added -> string
+- newRate: reason between new unit and base unit
+</i>
+
+- InoxConverter.addLenghtUnit(newUnit, newRate)
+- InoxConverter.addVolumeUnit(newUnit, newRate)
+- InoxConverter.addAreaUnit(newUnit, newRate)
+- InoxConverter.addMassUnit(newUnit, newRate)
+- InoxConverter.addTimeUnit(newUnit, newRate)
+- InoxConverter.addDateFormat(newFormat, newRate)
+- InoxConverter.addTimeFormat(newFormat, newRate)
+
+If you want to add a lenght unit called MyUnit that is ten times greater than the base unit of lenght (meter), you should to this:
+```ruby
+InoxConverter.addLenghtUnit('MyUnit', 10)
+```
+
+
+### Base units:
+
+- Area: squared meter
+- Currency: dollar
+- Length: meter
+- Mass: gram
+- Time: second
+- Volume: liter
 
 ## Development
 

data/lib/inox_converter/api/api.rb

@@ -55,23 +55,56 @@ module Api
 			end 
 		end
 
+		def validate_currency_unit(currency)
+			if @data == false || return_hash_currency(currency) == false
+				return false
+			else
+				return true
+			end
+		end
+
+		def validate_usd_unit(usd) 
+			if usd == "USD"
+		 		return true;
+		 	else
+		 		return false
+		 	end
+		end
+
 		#Template of execution sequence of the methods and return @hash
-		def dictionary_api(firstUnit, secondUnit)
+		def dictionary_api
 			consume_api
-			treat_data
-			data_validate_api(firstUnit, secondUnit)
-			
+			treat_data	
 		end
 
+		
 		#new metodo for convert currency
 		def convert_currency(valueToConvert, firstUnit, secondUnit)
-			
-			if dictionary_api(firstUnit, secondUnit) == false
-				return 0
-			else	 
-				finalValue = (valueToConvert / @hash[firstUnit]) * @hash[secondUnit]
-				return finalValue
-			end
+			dictionary_api
+			if validate_usd_unit(firstUnit) && validate_usd_unit(secondUnit)
+				return valueToConvert
+			elsif validate_usd_unit(firstUnit) && validate_usd_unit(secondUnit) == false
+				if validate_currency_unit(secondUnit)
+					finalValue = valueToConvert * @hash[secondUnit]
+					return finalValue
+				else
+					return 0
+				end
+			elsif validate_usd_unit(firstUnit) == false && validate_usd_unit(secondUnit)
+				if validate_currency_unit(firstUnit)
+					finalValue = valueToConvert / @hash[firstUnit]
+					return finalValue
+				else
+					return 0
+				end
+			else
+				if data_validate_api(firstUnit, secondUnit)
+					finalValue = (valueToConvert / @hash[firstUnit]) * @hash[secondUnit]
+					return finalValue
+				else	 
+					return 0
+				end
+			end		
 		end 
 	end
 end

data/lib/inox_converter/area.rb

@@ -11,7 +11,7 @@ module InoxConverter
         "square metre" => 1,
         "square meter" => 1,
         "m2" => 1,
-				"square centimeter"=> 10**-4,
+		"square centimeter"=> 10**-4,
         "square centimetre"=> 10**-4,
         "cm2"=> 10**-4,
         "square mile" => 2.59**6,

data/lib/inox_converter/converter.rb

@@ -11,13 +11,24 @@ module InoxConverter
 
 		# Template to convert
 		def convert(valueToConvert, firstUnit, secondUnit)
-			#First Step
+			# First Step
 			finalValue = valueToConvert.round(10)
-			#Second Step
-			finalValue *= getInDictionary(firstUnit).round(10)
-			#Third step
-			finalValue /= getInDictionary(secondUnit).round(10)
-			#Fourth step
+
+			# Second Step
+			firstUnitResultant = getInDictionary(firstUnit)
+			if firstUnitResultant.nil? 
+				raise NotImplementedError.new("#{firstUnit} isn't recognized by InoxConverter") 
+			end
+			finalValue *= firstUnitResultant.round(10)
+
+			# Third step
+			secondUnitResultant = getInDictionary(secondUnit)
+			if secondUnitResultant.nil? 
+				raise NotImplementedError.new("#{secondUnit} isn't recognized by InoxConverter") 
+			end
+			finalValue /= secondUnitResultant.round(10)
+
+			# Fourth step
 			return finalValue.round(10)
 		end
 
@@ -25,11 +36,6 @@ module InoxConverter
 			return @dictionary[unit]
 		end
 
-		def addUnitInDictionary(newUnit, newRate)
-			# Non-optional implementation
-			raise NotImplementedError.new("Convert method not implemented")
-		end
-
 		def initDictionary
 			raise NotImplementedError.new("Dictionary not initialize")
 		end

data/lib/inox_converter/version.rb

@@ -1,3 +1,3 @@
 module InoxConverter
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/inox_converter/volume.rb

@@ -5,7 +5,8 @@ module InoxConverter
     def initDictionary
       @dictionary = Hash.new
       @dictionary = {
-        "cubicmetre" => 1000,
+        "cubic_metre" => 1000,
+        "cubic_meter" => 1000,
         "m3" => 1000,
         "decaliter" => 10,
         "dal" => 10,

data/lib/inox_converter.rb

@@ -15,6 +15,10 @@ module InoxConverter
 	# Facade
 	# Conversion methods
 
+	def self.hi
+		puts "Hi, you are using InoxConverter!"
+	end
+
 	def self.convertDateFormat(dateToConvert, desiredFormat)
 		 puts "Date Formater"
 		 self.newDateFormatInstance
@@ -68,6 +72,8 @@ module InoxConverter
 
 
 	# Add unit methods
+	# newUnit: name of the new unit to be added
+	# newRate: reason between new unit and base unit
 
 	def self.addLenghtUnit(newUnit, newRate)
 		self.newLenghtInstance

metadata

@@ -1,14 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: inox_converter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Lucas Andrade
+- Júlio Xavier
+- Gesiel Freitas
+- Jhonatan Alves
+- Nicácio Neto
+- Vinícius Carvalho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,9 +43,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: Convert currency, temperature, lenght...
 email:
 - lucasandradeunb@gmail.com
+- julioxavierr@gmail.com
+- gesiel.was.f@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -59,7 +80,7 @@ files:
 - lib/inox_converter/time_format.rb
 - lib/inox_converter/version.rb
 - lib/inox_converter/volume.rb
-homepage: ''
+homepage: https://rubygems.org/gems/inox_converter
 licenses:
 - MIT
 metadata: {}