souvlaki 0.0.5 → 0.0.6

data/lib/souvlaki.rb

@@ -1,4 +1,13 @@
+# The main Class driver
 class Souvlaki
+  # Say the recipe!
+  #
+  # Example:
+  #   >> Souvlaki.say_in("english")
+  #   => display the recipe
+  #
+  # Arguments:
+  #   language: (String)
   def self.say_in(language)
     translator = Translator.new(language)
     translator.say_in

data/lib/souvlaki/translator.rb

@@ -1,37 +1,43 @@
 class Souvlaki::Translator
+  # Class constructor 
+   # @param [String]  The language
   def initialize(language= "english")
     @language = language
   end
 
-    def say_in
-      case @language
-      when "greek"
-        # ruby -Ilib ./bin/souvlaki
-        "Greek is comming soon"
-      else
-        "Ingredients
-
-        1 kg shoulder of pork (boneless) cut into cubes
-        10 pita breads
-        1 large tomato finely sliced
-        1 onion finely sliced and kept in a bowl with salted water
-        Juice from 1 lemon
-        180 ml olive oil
-        1 tsp salt and 1 tsp oregano mixed in a small bowl
-        1/2 tsp salt
-        1/2 tsp oregano
-        Salt and pepper
-        10 thin wooden skewers
-
-
-        Preparation
-
-        Fix the pork cubes onto the skewers.
-        Place them in a bowl, sprinkle with salt and pepper and then immerse in 60 ml of the oil.
-        Put in the fridge for approx. 1 hour.
-
-        Remove from the bowl and grill on both sides on a barbecue or in the grwill of the cooker.
-        Beat the remaining olive oil (setting aside 3 tbsp before you do so) in a bowl with the lemon juice.
+  # Main function, displays the recipe!
+  #
+  # Arguments:
+  #   language: (String)
+  def say_in
+    case @language
+    when "greek"
+      # ruby -Ilib ./bin/souvlaki
+      "Greek is comming soon"
+    else
+      "Ingredients
+
+      1 kg shoulder of pork (boneless) cut into cubes
+      10 pita breads
+      1 large tomato finely sliced
+      1 onion finely sliced and kept in a bowl with salted water
+      Juice from 1 lemon
+      180 ml olive oil
+      1 tsp salt and 1 tsp oregano mixed in a small bowl
+      1/2 tsp salt
+      1/2 tsp oregano
+      Salt and pepper
+      10 thin wooden skewers
+
+
+      Preparation
+
+      Fix the pork cubes onto the skewers.
+      Place them in a bowl, sprinkle with salt and pepper and then immerse in 60 ml of the oil.
+      Put in the fridge for approx. 1 hour.
+
+      Remove from the bowl and grill on both sides on a barbecue or in the grwill of the cooker.
+      Beat the remaining olive oil (setting aside 3 tbsp before you do so) in a bowl with the lemon juice.
 
         Dip the souvlakia in this mixture and then place on a large dish or platter.
         Sprinkle them with the salt and oregano mixture.
@@ -53,5 +59,5 @@ class Souvlaki::Translator
         "
       end
     end
-    
+
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: souvlaki
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ bindir: bin
 cert_chain: []
 date: 2012-04-30 00:00:00.000000000 Z
 dependencies: []
-description: A simple souvlaki recipe gem
+description: A simple souvlaki recipe gem!
 email: yannis.kolovos@gmail.com
 executables:
 - souvlaki