talk_like_a_pirate 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,50 @@
+Ahoy, mateys!
+=====
+
+Delight yer users with the flavor of the high seas!
+
+Add a pirate translation layer to your Rails app! Talk, like a Pirate!
+
+Translate English to Pirate on the fly!
+----
+
+    TalkLikeAPirate.translate("Today is a good day to die")
+    => "Today is a jolly good day t' die"
+
+If you pass in a sentence (and have a bit o' luck), you might get some extra piratey flavoring sprinkled on the end of your string!
+
+Build a Pirate locale layer for i18n
+----
+Use i18n? The pirate rake task can generate a pirate locale (arr, by default) based on your English locale files.
+
+    rake pirate:translate["config/locales"]
+
+It'll iterate through all of your en.yml files in that location and build a pirate version. You can also specify a specific en.yml file to translate just that file!
+
+Config
+----
+The pirate dictionary is fairly generic. You my have domain-specific lingo you think would be fucking hillarious in pirate. So, add on to the dictionary!
+
+Add a config file at
+
+    config/pirate_booty.yml
+
+And format it like so (all keys are optional):
+
+    locale: pirate     # This defaults to arr, but you can override it if you'd prefer a different locale string!
+    dictionary:
+      computer: voodoo
+      bill: debt
+      policies: creeds
+      inventory: treasure chest
+
+    pirate_flavor:         # the flavoring occasionally added to the ends of sentences
+      - "T' Davy Jones' locker wit ya"
+
+Contributions
+=====
+Feel free to write specs, add to the standard dictionary, etc. Submit a pull request and we'll see what happens!
+
+Credits
+=====
+Copyright (c) 2013, developed and maintained by Steve Hodges, and is released under the open MIT Licence

data/lib/talk_like_a_pirate.rb

@@ -17,16 +17,24 @@ private #####################################################################
   def self.translate_string(me_string)
     me_string.split(/ /).map do |word|
       capitalized = (word.slice(0,1) == word.slice(0,1).upcase)
-      pluralized = word.pluralize == word
-      if dictionary.has_key?(word.downcase.singularize)
-        word = dictionary[word.downcase.singularize]
-        word = pluralized ? word.pluralize : word
-        word = capitalized ? capitalize_first(word) : word
-      end
-      word
+      word = rails_present? ? piratize_with_pluralization(word) : piratize(word)
+      capitalized ? capitalize_first(word) : word
     end.join(" ")
   end
 
+  def self.piratize_with_pluralization(word)
+    pluralized = word.pluralize == word
+    if dictionary.has_key?(word.downcase.singularize)
+      word = dictionary[word.downcase.singularize]
+      word = pluralized ? word.pluralize : word
+    end
+    word
+  end
+
+  def self.piratize(word)
+    dictionary.has_key?(word.downcase) ? dictionary[word.downcase] : word
+  end
+
   def self.prepare_original_sentence(sentence)
     sentence.gsub!(/\.\z/, "")
     sentence = sentence + "." if sentence.match(/\w\z/)
@@ -46,11 +54,11 @@ private #####################################################################
   end
 
   def self.sprinklings_of_flavor
-    @@fill ||= (config["pirate_flavor"] << local_flavor).compact
+    @@fill ||= (config["pirate_flavor"] << local_flavor).compact.flatten
   end
 
   def self.config
-    @@config ||= YAML.load_file(File.dirname(__FILE__) + "/talk_like_a_pirate/pirate_booty.yml")
+    @@config ||= YAML::load_file(File.dirname(__FILE__) + "/talk_like_a_pirate/pirate_booty.yml")
   end
 
   def self.local_dictionary
@@ -62,7 +70,7 @@ private #####################################################################
   end
 
   def self.local_config
-    @@local_configs ||= YAML.load_file("#{Rails.root.to_s}/config/pirate_booty.yml") rescue {}
+    @@local_configs ||= YAML::load_file("#{Rails.root.to_s}/config/pirate_booty.yml") rescue {}
   end
 
   def self.capitalize_first(string)
@@ -71,6 +79,14 @@ private #####################################################################
     string.slice(0,1).capitalize + string.slice(1..-1)
   end
 
+  def self.rails_present?
+    Object.const_defined? :Rails
+  end
+
 end
 
-require 'talk_like_a_pirate/railties'
+if Object.const_defined? :Rails
+  require "talk_like_a_pirate/railties"
+else
+  require "yaml"
+end

data/talk_like_a_pirate.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'talk_like_a_pirate'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.authors     = ['Steve Hodges']
   s.email       = ['sjhodges@gmail.com']
   s.homepage    = 'https://github.com/stevehodges/talk_like_a_pirate'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: talk_like_a_pirate
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- README.md
 - lib/talk_like_a_pirate.rb
 - lib/talk_like_a_pirate/pirate_booty.yml
 - lib/talk_like_a_pirate/railties.rb