talk_like_a_pirate 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db932721c1e5caeccac58345b7379689344ef469
-  data.tar.gz: d2dd475fec4e4ed4a7728e0996f0ed236f7f56bf
+SHA256:
+  metadata.gz: b944c0e195a2399e63c0d1465b6dd3ff7067cab4bfb5d585cba2d1dc46252fe2
+  data.tar.gz: 4668368266d7e559ff0f89949f16314e495f944415056fac7628aa2128190862
 SHA512:
-  metadata.gz: 15454681ef634d24030283d78ca7078c0c33298c261a79983641c29b32ab3129794164b3ac14e518e2e9e7c56ac23c3c618861ffa8367bfed4b01548f2635d6b
-  data.tar.gz: 4cd7aa50c037cacf5c4de9fae228d28d381c63528afeb461430e4f319f606f0ba7a3d19f3155a7eb27a28b53d3e5af3366f3879ff31fb0556abf8c2eb7cd3241
+  metadata.gz: 04baa81e63b7bda7d53de3564b9549894ffeaf0816885082944d8d0b16dd620dbf5c96034e716ba2eddedc84943b49fa7604623d6ec95c05417dc32a4239bb35
+  data.tar.gz: e43391d9ecea0bd54e3314ce2f4c1e0e6c5af5d9992cfb98699ad02473c359ff80168ed0059ee49209c12ed11b22370bd4cbc5133da436c91dff4c7a716eff67

data/.gitignore

@@ -0,0 +1,4 @@
+*.gemfile.lock
+gemfiles/*
+log
+*.gem

data/Appraisals

@@ -0,0 +1,31 @@
+appraise "rails-3-2" do
+  gem "activesupport", "~> 3.2.0"
+end
+
+appraise "rails-4-0" do
+  gem "activesupport", "~> 4.0.0"
+end
+
+appraise "rails-4-1" do
+  gem "activesupport", "~> 4.1.0"
+end
+
+appraise "rails-4-2" do
+  gem "activesupport", "~> 4.2.0"
+end
+
+appraise "rails-5-0" do
+  gem "activesupport", "~> 5.0.0"
+end
+
+appraise "rails-5-1" do
+  gem "activesupport", "~> 5.1.0"
+end
+
+appraise "rails-5-2" do
+  gem "activesupport", "~> 5.2.0"
+end
+
+appraise "rails-6-0" do
+  gem "activesupport", "~> 6.0.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## [0.2.1] - 2018-10-01
+### Added
+- rake pirate:initialize installs a sample YAML file into your Rails config folder
+- Specs for I18n generation
+
+### Changed
+- I18n generation now works with YAML files with prefixes (i.e. devise.en.yml)
+
+## [0.2.0] - 2018-10-01
+### Added
+- Now compatible with Rails 3.2 through 5.2.X
+- Specs for all supported Rails versions
+
+### Changed
+- Class public methods

data/Gemfile

@@ -1,7 +1,2 @@
 source 'https://rubygems.org'
-group :test do
-  gem "rspec"
-  gem "rake"
-  gem 'activesupport', '~> 3.0.0', :require => false
-  gem 'i18n'#, :require => false
-end
+gemspec

data/Gemfile.lock

@@ -1,24 +1,57 @@
+PATH
+  remote: .
+  specs:
+    talk_like_a_pirate (0.2.1)
+      activesupport (>= 3.0.0, < 6.0.1)
+      i18n
+
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.0.20)
-    diff-lcs (1.2.4)
-    i18n (0.6.4)
-    rake (10.0.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.12.2)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3.0.0)
-  i18n
-  rake
-  rspec
+  appraisal (~> 2.2)
+  bundler (~> 1.9)
+  rake (~> 10.0)
+  rspec (~> 3)
+  talk_like_a_pirate!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Steve Hodges
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,13 +1,14 @@
 Ahoy, mateys!
 =====
 
-Delight yer users with the flavor of the high seas!
+Translate English to Pirate on the fly! Delight yer users with the flavor of the high seas!
 
-Add a pirate translation layer to your Ruby or Rails app! Talk, like a Pirate!
+Plus, add a pirate translation layer to your Ruby or Rails app! Talk, like a Pirate!
 
-Try the gem out on [Ahoy Mat.ee](http://www.ahoymat.ee "Translate web pages into pirate"), which allows you to translate any page on the public internets.
+This gem has been functional tested against a public domain version of The Bible (which may or may not be available as an e-book on Amazon.com...)
+
+[![Gem Version](https://badge.fury.io/rb/talk_like_a_pirate.svg)](https://badge.fury.io/rb/talk_like_a_pirate)
 
-Translate English to Pirate on the fly!
 ----
 
     TalkLikeAPirate.translate("Today is a good day to die")
@@ -25,12 +26,20 @@ It'll iterate through all of your en.yml files in that location and build a pira
 
 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!
+The pirate dictionary is fairly generic. You may have domain-specific lingo you think would be hillarious in pirate. So, add on to the dictionary!
+
+You can generate a config file using the rake task:
+
+  rake pirate:initialize
 
-Add a config file at
+Or, add a config file at
 
+  * Rails:
     config/pirate_booty.yml
 
+  * Without Rails
+    Specify the path to your YAML file in ENV['TALK_LIKE_A_PIRATE_CONFIG_PATH']
+
 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!
@@ -52,15 +61,24 @@ If you want more sophistication in your translations, you can add the Rails Acti
     require "active_support"
     require "active_support/inflector"
 
-And, due to dependency weirdness in ActiveSupport, you'll also need the i18n gem installed. So, in your Gemfile:
-
-    gem 'activesupport', '~> 3.0.0'
-    gem 'i18n'
-
 Contributions
 =====
 Feel free to write specs, add to the standard dictionary, etc. Submit a pull request and we'll see what happens!
 
+Tests
+=====
+
+To test the gem against the current version of ActiveSupport (in [Gemfile.lock](Gemfile.lock)):
+
+1. `bundle install`
+2. `bundle exec rspec`
+
+Or, you can run tests for all supported Rails versions
+
+1. `gem install appraisal`
+1. `bundle exec appraisal install` *(this Generates gemfiles for all permutations of our dependencies, so you'll see lots of bundler output))*
+1. `bundle exec appraisal rspec`. *(This runs rspec for each dependency permutation. If one fails, appraisal exits immediately and does not test permutations it hasn't gotten to yet. Tests are not considered passing until all permutations are passing)*
+
 Credits
 =====
 Copyright (c) 2013, developed and maintained by Steve Hodges, and is released under the open MIT Licence

data/lib/config/sample_config.yml

@@ -0,0 +1,9 @@
+dictionary:
+  # Capitalization will be handled by talk_like_a_pirate.
+  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"

data/lib/install_local_config.rb

@@ -0,0 +1,48 @@
+class TalkLikeAPirate
+  class InstallLocalConfig
+    class << self
+      def install(target_file_path=nil)
+        target_file_path = set_target_file_path(target_file_path)
+        if File.exists?(target_file_path)
+          "Configuration file already exists at #{target_file_path}"
+        else
+          copy_local_config_template_to(target_file_path)
+          output_local_instructions(target_file_path)
+        end
+      end
+
+    private #####################################################################
+
+      def set_target_file_path(target_file_path)
+        if TalkLikeAPirate.on_rails?
+          Rails.root.join 'config', 'pirate_booty.yml'
+        else
+          target_file_path = path_looks_like_file(target_file_path) ?  FileUtils.pwd : target_file_path
+          File.join target_file_path, 'pirate_booty.yml'
+        end
+      end
+
+      def copy_local_config_template_to(target_file_path)
+        target_directory = File.dirname(target_file_path)
+        FileUtils.mkdir_p(target_directory) unless Dir.exists?(target_directory) 
+        source_path = File.join File.dirname(__FILE__), 'config', 'sample_config.yml'
+
+        FileUtils.copy source_path, target_file_path
+      end
+
+      def output_local_instructions(target_file_path)
+        return "Configuration installed at #{target_file_path}" if TalkLikeAPirate.on_rails?
+        <<-INSTRUCTIONS
+********************************************************************************************
+Be sure to specify the path to your YAML file in ENV['TALK_LIKE_A_PIRATE_CONFIG_PATH'], i.e.
+export TALK_LIKE_A_PIRATE_CONFIG_PATH="#{target_file_path}"
+********************************************************************************************
+INSTRUCTIONS
+      end
+
+      def path_looks_like_file(target_file_path)
+        target_file_path =~ /\.[^\.\/]*\z/
+      end
+    end
+  end
+end

data/lib/rails/i18n_translator.rb

@@ -0,0 +1,78 @@
+class TalkLikeAPirate
+  class I18nTranslator
+    def initialize(from_locale: 'en', verbose: false)
+      @source_locale = from_locale
+      @verbose = verbose
+    end
+
+    def translate_file_or_directory(path='config/locales')
+      path = Rails.root.join(path) if TalkLikeAPirate.on_rails? && !path.include?(Rails.root.to_s)
+      return translate(path) if File.exists?(path) && file_is_source_yaml_file?(path)
+
+      directory_contents(path).each do |file_path|
+        process_file_or_directory file_path
+      end
+    end
+    alias :translate :translate_file_or_directory
+
+  private #####################################################################
+
+    def process_file_or_directory(file_path)
+      if File.directory? file_path
+        source_path = File.join(file_path, "#{@source_locale}.yml")
+        translate_file(source_path) if File.exists?(source_path)
+        translate_file_or_directory file_path
+      elsif file_is_source_yaml_file?(file_path)
+        translate_file file_path
+      end
+    end
+
+    def file_is_source_yaml_file?(file_path)
+      file_path.to_s.match source_yaml_file_matcher
+    end
+
+    def source_yaml_file_matcher
+      # prefix_with_dot  locale_name  sublocale_name  .yml
+      /([^\/]*\.)?#{@source_locale}([a-zA-Z-]*).yml/
+    end
+
+    def translate_file(source_file_path)
+      pirate_locale_name  = pirate_locale_name_for(source_file_path)
+      target_file_path    = File.join File.dirname(source_file_path), "#{source_filename_prefix(source_file_path)}#{pirate_locale_name}.yml"
+      puts "Translatin' #{source_file_path} to #{pirate_locale_name}.yml" if @verbose
+
+      en_yml              = YAML::load_file(source_file_path)
+      translation         = {pirate_locale_name => parse_element(en_yml).values.first}
+      File.open(target_file_path, 'w:utf-8'){|f| YAML::dump translation, f }
+    end
+
+    def pirate_locale_name_for(source_filename)
+      TalkLikeAPirate.pirate_locale + source_filename.match(source_yaml_file_matcher)[2]
+    end
+
+    def source_filename_prefix(source_filename)
+      source_filename.match(source_yaml_file_matcher)[1]
+    end
+
+    def parse_element(element)
+      case element
+        when Hash
+          new_hash = {}
+          element.each{|k,v| new_hash[k] = parse_element(v)}
+          new_hash
+        when Array
+          element.map{|el| parse_element(element)}
+        when String
+          TalkLikeAPirate.translate element
+        else
+          element
+      end
+    end
+
+    def directory_contents(path)
+      Dir.new(path).entries.map do |filename|
+        File.join(path, filename) unless ['.', '..'].include?(filename)
+      end.compact
+    end
+  end
+end

data/lib/rails/railties.rb

@@ -0,0 +1,23 @@
+require_relative 'i18n_translator'
+require_relative '../install_local_config'
+
+class LoadTasks < Rails::Railtie
+  rake_tasks do
+
+		namespace 'pirate' do
+		  desc 'Translate config/locales dictionary into pirrrrate'
+		  task :translate, [:dir_or_file_to_translate] => :environment do |t, args|
+		    args.with_defaults(dir_or_file_to_translate: 'config/locales')
+		    TalkLikeAPirate::I18nTranslator.new.translate args[:dir_or_file_to_translate]
+		  end
+		end
+
+		namespace 'pirate' do
+		  desc 'Add a pirate config file to enable customization of the translation dictionary'
+		  task :initialize, [:target_path] => :environment do |t, args|
+		    message = TalkLikeAPirate::InstallLocalConfig.install(args[:target_path])
+		    puts "#{message}"
+		  end
+		end
+  end
+end

data/lib/talk_like_a_pirate.rb

@@ -1,126 +1,145 @@
 class TalkLikeAPirate
 
-  def self.translate(me_string)
-    me_string.is_a?(String) ? build_string(me_string) : me_string
-  end
+  class << self
+    def translate(me_string)
+      me_string.is_a?(String) ? build_string(me_string) : me_string
+    end
 
-private #####################################################################
+    def pirate_locale
+      @@locale ||= local_config['locale'] || config['locale']
+    end
 
-  def self.build_string(me_string)
-    sentence = translate_string(me_string)
-    if sentence.split(" ").length > 5 && sentence.match(/[!.?]\Z/) && rand(5) == 0
-      sentence = prepare_original_sentence(sentence) + " " + build_piratey_sentence
+    def on_rails?
+      Object.const_defined?(:Rails)
     end
-    sentence
-  end
 
-  def self.translate_string(me_string)
-    me_string.split(/ /).map do |word|
+  private #####################################################################
 
-      leading_punctuation, word, trailing_punctuation = extract_punctuation word
-      capitalized = (word.slice(0,1) == word.slice(0,1).upcase)
-      fully_capitalized = (word == word.upcase)
+    def build_string(me_string)
+      sentence = translate_string(me_string)
+      if sentence.split(" ").length > 5 && sentence.match(/[!.?]\Z/) && rand(5) == 0
+        sentence = prepare_original_sentence(sentence) + " " + build_piratey_sentence
+      end
+      sentence
+    end
 
-      word = Object.const_defined?(:ActiveSupport) ? piratize_with_pluralization(word.downcase) : piratize(word.downcase)
+    def translate_string(me_string)
+      me_string.split(/ /).map do |word|
 
-      word = capitalize_first(word) if capitalized
-      word = word.upcase if fully_capitalized
-      "#{leading_punctuation}#{word}#{trailing_punctuation}"
-    end.join(" ")
-  end
+        leading_punctuation, word, trailing_punctuation = extract_punctuation word
+        capitalized = (word.slice(0,1) == word.slice(0,1).upcase)
+        fully_capitalized = (word == word.upcase)
+
+        word = Object.const_defined?(:ActiveSupport) ? piratize_with_pluralization(word.downcase) : piratize(word.downcase)
 
-  def self.piratize_with_pluralization(word)
-    pluralized = pluralize(word) == word
-    if dictionary.has_key? singularize(word)
-      word = dictionary[singularize(word)]
-      pluralized ? pluralize(word) : word
-    else
-      translate_if_gerund word
+        word = capitalize_first(word) if capitalized
+        word = word.upcase if fully_capitalized
+        "#{leading_punctuation}#{word}#{trailing_punctuation}"
+      end.join(" ")
     end
-  end
 
-  def self.piratize(word)
-    if dictionary.has_key? word
-      dictionary[word]
-    else
-      translate_if_gerund word
+    def piratize_with_pluralization(word)
+      pluralized = pluralize(word) == word
+      if dictionary.has_key? singularize(word)
+        word = dictionary[singularize(word)]
+        pluralized ? pluralize(word) : word
+      else
+        translate_if_gerund word
+      end
     end
-  end
 
-  def self.translate_if_gerund(word)
-    if word[/ing\Z/]
-      word.sub(/ing\Z/, "in'")
-    elsif word[/ings\Z/]
-      word.sub(/ings\Z/, "in's")
-    else
-      word
+    def piratize(word)
+      if dictionary.has_key? word
+        dictionary[word]
+      else
+        translate_if_gerund word
+      end
     end
-  end
 
-  def self.extract_punctuation(word)
-    leading_punctuation = word.match(/\A([^a-zA-Z]*)/)[1] rescue ""
-    trailing_punctuation = word.match(/[a-zA-Z]+([^a-zA-Z]*)\Z/)[1] rescue ""
-    word_length = word.length - leading_punctuation.length - trailing_punctuation.length
-    word = word[leading_punctuation.length, word_length]
-    return leading_punctuation, word, trailing_punctuation
-  end
+    def translate_if_gerund(word)
+      if word[/ing\Z/]
+        word.sub(/ing\Z/, "in'")
+      elsif word[/ings\Z/]
+        word.sub(/ings\Z/, "in's")
+      else
+        word
+      end
+    end
 
-  def self.prepare_original_sentence(sentence)
-    sentence.gsub!(/\.\z/, "")
-    sentence = sentence + "." if sentence.match(/\w\z/)
-    capitalize_first(sentence)
-  end
+    def extract_punctuation(word)
+      leading_punctuation  = word.match(/\A([^a-zA-Z]*)/)[1] rescue ''
+      trailing_punctuation = word.match(/[a-zA-Z]+([^a-zA-Z]*)\Z/)[1] rescue ''
+      word_length = word.length - leading_punctuation.length - trailing_punctuation.length
+      word = word[leading_punctuation.length, word_length]
+      return leading_punctuation, word, trailing_punctuation
+    end
 
-  def self.build_piratey_sentence
-    capitalize_first(sprinklings_of_flavor.sample) + ["!!","!","."].sample
-  end
+    def prepare_original_sentence(sentence)
+      sentence.gsub!(/\.\z/, "")
+      sentence = sentence + "." if sentence.match(/\w\z/)
+      capitalize_first(sentence)
+    end
 
-  def self.pirate_locale
-    @@locale ||= local_config.has_key?("locale") ? local_config["locale"] : config["locale"]
-  end
+    def build_piratey_sentence
+      capitalize_first(sprinklings_of_flavor.sample) + ["!!","!","."].sample
+    end
 
-  def self.dictionary
-    @@dictionary_map ||= config["dictionary"].merge(local_dictionary)
-  end
+    def dictionary
+      @@dictionary_map ||= config['dictionary'].merge(local_dictionary)
+    end
 
-  def self.sprinklings_of_flavor
-    @@fill ||= (config["pirate_flavor"] << local_flavor).compact.flatten
-  end
+    def sprinklings_of_flavor
+      @@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")
-  end
+    def config
+      @@config ||= begin
+        gem_config_path = File.join File.dirname(__FILE__), 'config', 'pirate_booty.yml'
+        YAML::load_file gem_config_path
+      end
+    end
 
-  def self.local_dictionary
-    local_config.has_key?("dictionary") ? local_config["dictionary"] : {}
-  end
+    def local_dictionary
+      local_config['dictionary'] || {}
+    end
 
-  def self.local_flavor
-    local_config.has_key?("pirate_flavor") ? local_config["pirate_flavor"] : nil
-  end
+    def local_flavor
+      local_config['pirate_flavor'] || nil
+    end
 
-  def self.local_config
-    @@local_configs ||= YAML::load_file("#{Rails.root.to_s}/config/pirate_booty.yml") rescue {}
-  end
+    def local_config
+      @@local_configs ||= begin
+        local_config_path = if on_rails?
+          Rails.root.join 'config', 'pirate_booty.yml'
+        else
+          ENV['TALK_LIKE_A_PIRATE_CONFIG_PATH']
+        end
+        if local_config_path && File.exist?(local_config_path)
+          YAML::load_file(local_config_path)
+        else
+          {}
+        end
+      end
+    end
 
-  def self.capitalize_first(string)
-    return string unless string.is_a? String
-    return string.upcase if string.length < 2
-    string.slice(0,1).capitalize + string.slice(1..-1)
-  end
+    def capitalize_first(string)
+      return string unless string.is_a? String
+      return string.upcase if string.length < 2
+      string.slice(0,1).capitalize + string.slice(1..-1)
+    end
 
-  def self.singularize(word)
-    ActiveSupport::Inflector.singularize(word)
-  end
+    def singularize(word)
+      ActiveSupport::Inflector.singularize(word)
+    end
 
-  def self.pluralize(word)
-    ActiveSupport::Inflector.pluralize(word)
+    def pluralize(word)
+      ActiveSupport::Inflector.pluralize(word)
+    end
   end
-
 end
 
-if Object.const_defined? :Rails
-  require "talk_like_a_pirate/railties"
+if TalkLikeAPirate.on_rails?
+  require 'rails/railties'
 else
-  require "yaml"
+  require 'yaml'
 end

data/spec/lib/i18n_translator_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+include I18nHelperMethods
+
+describe TalkLikeAPirate::I18nTranslator do
+	let(:source_locale)   { 'en' }
+	let(:instance) { TalkLikeAPirate::I18nTranslator.new(from_locale: source_locale) }
+	setup_temp_folder
+	after { remove_temp_files }
+
+	describe '#translate_file_or_directory' do
+		let(:source_filename) { 'en.yml' }
+		let(:source_path)     { nil }
+
+		subject do
+			create_source_file source_path, source_filename
+			instance.translate_file_or_directory(@temp_folder)
+			target_filename = source_filename.sub(source_locale, 'arr')
+			tempfile_exists? File.join(*[source_path, target_filename].compact)
+		end
+
+		describe 'translated file creation' do
+			it { is_expected.to be true }
+
+			context 'prefixed filenames' do
+				let(:source_filename) { 'devise.en.yml' }
+				it { is_expected.to be true }
+			end
+
+			context 'sublocale filenames' do
+				let(:source_filename) { 'en-US.yml' }
+				it { is_expected.to be true }
+			end
+
+			context 'subfolders' do
+				let(:source_path)     { 'subfolder' }
+				it { is_expected.to be true }
+			end
+
+			context 'nested subfolders' do
+				let(:source_path)     { 'subfolder/another_subfolder' }
+				it { is_expected.to be true }
+			end
+
+			context 'multiple source files in folder' do
+				before do
+					create_source_file '', source_filename_1
+					create_source_file '', source_filename_2
+				end
+				let(:source_filename_1) { 'en.yml' }
+				let(:source_filename_2) { 'en-US.yml' }
+				it { expect(tempfile_exists?(source_filename_1)).to be true }
+				it { expect(tempfile_exists?(source_filename_2)).to be true }
+			end
+		end
+
+		describe 'yaml top level key' do
+			subject do
+				create_source_file '', source_filename
+				instance.translate_file_or_directory(@temp_folder)
+				target_filename = source_filename.sub(source_locale, 'arr')
+
+				yaml_for(target_filename).keys[0]
+			end
+
+			it { is_expected.to eq 'arr' }
+
+			context 'prefixed filenames' do
+				let(:source_filename) { 'devise.en.yml' }
+				it { is_expected.to eq 'arr' }
+			end
+
+			context 'sublocale filenames' do
+				let(:source_filename) { 'en-US.yml' }
+				it { is_expected.to eq 'arr-US' }
+			end
+		end
+
+		describe 'translations' do
+			def subject(yaml_path)
+				create_source_file '', 'en.yml'
+				instance.translate_file_or_directory(@temp_folder)
+				yaml_for('arr.yml').dig *yaml_path
+			end
+			it { expect(subject(['arr', 'house',  'address'])).to eq "Port o' call"}
+			it { expect(subject(['arr', 'house',  'country'])).to eq "Land"}
+			it { expect(subject(['arr', 'person', 'employee'])).to eq "Crew"}
+			it { expect(subject(['arr', 'person', 'family'])).to eq "kin"}
+		end
+	end
+end

data/spec/lib/talk_like_a_pirate_spec.rb

@@ -1,57 +1,63 @@
-require 'talk_like_a_pirate'
+require 'spec_helper'
 
 describe TalkLikeAPirate do
+  def execute(string)
+    TalkLikeAPirate.translate(string)
+  end
 
-  it "should make a word piratey" do
-    TalkLikeAPirate.translate('between').should == "betwixt"
+  it "makes a word piratey" do
+    expect(execute('between')).to eq "betwixt"
   end
 
-  it "shouldn't translate plural words without ActiveSupport" do
-    TalkLikeAPirate.translate("islands").should == 'islands'
+  it "makes gerunds piratey" do
+    expect(execute('having')).to eq "havin'"
   end
 
-  it "should make gerunds piratey" do
-    TalkLikeAPirate.translate('having').should == "havin'"
+  it "makes plural gerunds piratey" do
+    expect(execute('havings')).to eq "havin's"
   end
 
-  it "should make plural gerunds piratey" do
-    TalkLikeAPirate.translate('havings').should == "havin's"
+  it "capitalizes single words" do
+    expect(execute('Boss')).to eq "Admiral"
   end
 
-  it "should properly capitalize single words" do
-    TalkLikeAPirate.translate('Boss').should == "Admiral"
+  it "capitalizes all caps words" do
+    expect(execute('BOSS')).to eq "ADMIRAL"
+    expect(execute('BOSS!!!!')).to eq "ADMIRAL!!!!"
   end
 
-  it "should properly capitalize all caps words" do
-    TalkLikeAPirate.translate('BOSS').should == "ADMIRAL"
-    TalkLikeAPirate.translate('BOSS!!!!').should == "ADMIRAL!!!!"
+  it "capitalizes phrases" do
+    expect(execute('Bourbon Country')).to eq "Rum Land"
+    expect(execute('Bourbon country')).to eq "Rum land"
   end
 
-  it "should properly capitalize phrases" do
-    TalkLikeAPirate.translate('Bourbon Country').should == "Rum Land"
-    TalkLikeAPirate.translate('Bourbon country').should == "Rum land"
+  it "translates words with trailing punctuation" do
+    expect(execute('man!!!')).to eq "pirate!!!"
+    expect(execute('man!?!?!?!')).to eq "pirate!?!?!?!"
   end
 
-  it "should properly translate words with trailing punctuation" do
-    TalkLikeAPirate.translate('man!!!').should == "pirate!!!"
-    TalkLikeAPirate.translate('man!?!?!?!').should == "pirate!?!?!?!"
+  it "translates plural gerunds with trailing punctuation" do
+    expect(execute('belongings!')).to eq "belongin's!"
   end
 
-  it "should properly translate plural gerunds with trailing punctuation" do
-    TalkLikeAPirate.translate('belongings!').should == "belongin's!"
+  it "punctuates and translates words with leading and punctuation" do
+    expect(execute('"The boss said kill."')).to eq '"Tha admiral said keelhaul."'
+    expect(execute('"The boss said to kill the dude!"')).to eq '"Tha admiral said t\' keelhaul tha pirate!"'
   end
 
-  it "should properly punctuate and translate words with leading and punctuation" do
-    TalkLikeAPirate.translate('"The boss said kill."').should == '"Tha admiral said keelhaul."'
-    TalkLikeAPirate.translate('"The boss said to kill the dude!"').split(" ")[0..6].join(" ").should == '"Tha admiral said t\' keelhaul tha pirate!"'
+  context 'without ActiveSupport' do
+    it "does not translate plural words" do
+      expect(execute("islands")).to eq 'islands'
+    end
   end
 
-  it "should translate plural words when ActiveSupport's available" do
-    require "active_support"
-    require "active_support/inflector"
+  context 'with ActiveSupport' do
+    it "translates plural words" do
+      require "active_support"
+      require "active_support/inflector"
 
-    TalkLikeAPirate.translate("islands").should == 'isles'
-    TalkLikeAPirate.translate("men").should == 'pirates'
+      expect(execute("islands")).to eq 'isles'
+      expect(execute("men")).to eq 'pirates'
+    end
   end
-
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'talk_like_a_pirate'
+require 'support/i18n_helper_methods'
+require 'rails/i18n_translator'
+RSpec.configure do |c|
+end

data/spec/support/i18n_helper_methods.rb

@@ -0,0 +1,49 @@
+module I18nHelperMethods
+  def setup_temp_folder
+    before(:all) do
+      tmp_path     = File.join File.dirname(__FILE__), 'tmp'
+      @temp_folder = FileUtils.mkdir(tmp_path)[0]
+    end
+    after(:all) do
+      FileUtils.rm_r(@temp_folder) unless @temp_folder.nil?
+      @temp_folder = nil
+    end
+  end
+
+  def tempfile_exists?(target_filename)
+    File.exists? tempfile(target_filename)
+  end
+
+  def tempfile_contents(target_filename)
+    File.read tempfile(target_filename)
+  end
+
+  def yaml_for(target_filename)
+    YAML.load(tempfile_contents(target_filename))
+  end
+
+  def tempfile(target_filename)
+    File.join(@temp_folder, target_filename)
+  end
+
+  def remove_temp_files
+    return if @temp_folder.nil? || @temp_folder == ''
+    Dir.glob(@temp_folder).each do |file_path|
+      next if ['.','..',@temp_folder].include?(file_path)
+      FileUtils.remove_entry file_path
+    end
+  end
+
+  def create_source_file(target_path, target_filename)
+    target_path = File.join [@temp_folder, target_path].compact
+    FileUtils.mkdir_p(target_path) unless Dir.exists?(target_path)
+
+    source_path      = File.join File.dirname(__FILE__), 'source_template.yml'
+    target_file_path = File.join target_path, target_filename
+    FileUtils.copy source_path, target_file_path
+  end
+
+  def delete_config_file
+    FileUtils.remove_entry File.dirname(target_file_path)
+  end
+end

data/spec/support/source_template.yml

@@ -0,0 +1,7 @@
+en:
+  house:
+    address: Address
+    country: Country
+  person:
+    employee: Employee
+    family:   family

data/talk_like_a_pirate.gemspec

@@ -1,17 +1,22 @@
 # -*- encoding: utf-8 -*-
-Gem::Specification.new do |s|
-  s.name         = 'talk_like_a_pirate'
-  s.version      = '0.1.0'
-  s.authors      = ['Steve Hodges']
-  s.email         = ['sjhodges@gmail.com']
-  s.homepage  = 'https://github.com/stevehodges/talk_like_a_pirate'
-  s.summary    = 'Talk Like A Pirate'
-  s.description = 'Add a pirate translation layer to your Rails app! Talk, like a Pirate!'
+Gem::Specification.new do |spec|
+  spec.name         = 'talk_like_a_pirate'
+  spec.version      = '0.2.2'
+  spec.authors      = ['Steve Hodges']
+  spec.email        = ['shodges317@gmail.com']
+  spec.homepage     = 'https://github.com/stevehodges/talk_like_a_pirate'
+  spec.summary      = 'Talk Like A Pirate'
+  spec.description  = 'Add a pirate translation layer to your Rails app! Talk, like a Pirate!'
 
-  s.files           = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.files        = `git ls-files`.split("\n")
+  spec.test_files   = `git ls-files -- {spec}/*`.split("\n")
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.require_paths = ['lib']
+  spec.add_dependency 'activesupport', '>= 3.0.0', '< 6.0.1'
+  spec.add_dependency 'i18n'
+
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler',   '~> 1.9'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3'
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,59 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: talk_like_a_pirate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Steve Hodges
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Add a pirate translation layer to your Rails app! Talk, like a Pirate!
 email:
-- sjhodges@gmail.com
+- shodges317@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
+- lib/config/pirate_booty.yml
+- lib/config/sample_config.yml
+- lib/install_local_config.rb
+- lib/rails/i18n_translator.rb
+- lib/rails/railties.rb
 - lib/talk_like_a_pirate.rb
-- lib/talk_like_a_pirate/pirate_booty.yml
-- lib/talk_like_a_pirate/railties.rb
-- lib/talk_like_a_pirate/tasks/pirate.rake
+- spec/lib/i18n_translator_spec.rb
 - spec/lib/talk_like_a_pirate_spec.rb
+- spec/spec_helper.rb
+- spec/support/i18n_helper_methods.rb
+- spec/support/source_template.yml
 - talk_like_a_pirate.gemspec
 homepage: https://github.com/stevehodges/talk_like_a_pirate
 licenses: []
@@ -64,17 +136,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Talk Like A Pirate

data/lib/talk_like_a_pirate/railties.rb

@@ -1,5 +0,0 @@
-class LoadTasks < Rails::Railtie
-  rake_tasks do
-    Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
-  end
-end

data/lib/talk_like_a_pirate/tasks/pirate.rake

@@ -1,57 +0,0 @@
-namespace "pirate" do
-  desc "Use this task to translate config/locales dictionary into pirrrrate"
-  task :translate, :dir_or_file_to_translate do |t, args|
-    require 'cgi'
-    args.with_defaults(:dir_or_file_to_translate => "config/locales")
-    translate_locale(args[:dir_or_file_to_translate])
-  end
-end
-
-def translate(filename)
-  en_yml = YAML::load_file(filename)
-  target_filename = TalkLikeAPirate.pirate_locale + filename.match(/\/en([a-zA-Z-]*).yml/)[1]
-  dirname = filename.split("/")[0..-2].join("/")
-  translation = {target_filename => parse_element(en_yml).values.first}
-  File.open(dirname + "/#{target_filename}.yml", 'w:utf-8') do |f|
-    YAML::dump translation, f
-  end
-end
-
-def translate_locale(path)
-  path = "#{Rails.root}/#{path}" unless path.include? Rails.root.to_s
-  return translate(path) if File.exists?(path) && path.match("/\/en([a-zA-Z-]*).yml")
-
-  relevent_file_paths(path).each do |file_path|
-    if File.directory? file_path
-      translate(file_path + "/en.yml") if File.exists?(file_path + "/en.yml")
-      translate_locale file_path
-    elsif file_path.match("\/en([a-zA-Z-]*).yml")
-      puts file_path
-      translate file_path
-    end
-  end
-end
-
-def parse_element(element)
-  case element
-    when Hash
-      new_hash = {}
-      element.each {|k,v| new_hash[k] = parse_element(v)}
-      new_hash
-    when Array
-      element.map {|el| parse_element(element)}
-    when String
-      TalkLikeAPirate.translate element
-    else
-      element
-  end
-end
-
-def relevent_file_paths(path)
-  Dir.new(path).entries.reject do |filename|
-    [".", ".."].include? filename
-  end.map do |filename|
-    "#{path}/#{filename}"
-  end
-end
-