talk_like_a_pirate 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8889d472451363ee0bf6512c4b553f7930578c85
-  data.tar.gz: 1482daf20f68724ff9970cbd2c43f41a17806f61
+  metadata.gz: 801d5bcf62c5d990f5cb9b5379e823432dbf6f50
+  data.tar.gz: 588ff4de48eae2b03e5702a566fd53099e47593f
 SHA512:
-  metadata.gz: ee40a7bcd68a17fe95d9176163cb11b456c08cf3d9cd4241a34e5257c9decef44b6c87ef9097bb8897cbbb21b19042f49cee8fd39b7490fed879384130c427e0
-  data.tar.gz: 41256b674a9594ad736ccc4229fb2f0212a34f77c32d36aa06fcad9c1afaacc7043f11be42f5a32fec30bc3ac398a88217eb1016e2ad439161774ec727017763
+  metadata.gz: 70a8ecb9b3d870979dcf4af96b4e0435eb76bb48e7a1e738bef2cfe67a1d16081692f24bb0c43efd1681e513b23a2d21b52c49539d6ef2416ea3174d3580954e
+  data.tar.gz: c8c4718b9978ab21394746386c7265e947f2b8090a9c5b116647d2cee90d8fac12f983dcf940c9dc7243728f157c8505551100953f5444a54716b095202929f8

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/README.md

@@ -28,7 +28,11 @@ Config
 ----
 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!
 
-Add a config file at
+You can generate a config file using the rake task:
+
+  rake pirate:initialize
+
+Or, add a config file at
 
   * Rails:
     config/pirate_booty.yml

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

@@ -5,6 +5,14 @@ class TalkLikeAPirate
       me_string.is_a?(String) ? build_string(me_string) : me_string
     end
 
+    def pirate_locale
+      @@locale ||= local_config['locale'] || config['locale']
+    end
+
+    def on_rails?
+      Object.const_defined?(:Rails)
+    end
+
   private #####################################################################
 
     def build_string(me_string)
@@ -76,10 +84,6 @@ class TalkLikeAPirate
       capitalize_first(sprinklings_of_flavor.sample) + ["!!","!","."].sample
     end
 
-    def pirate_locale
-      @@locale ||= local_config.has_key?("locale") ? local_config["locale"] : config["locale"]
-    end
-
     def dictionary
       @@dictionary_map ||= config['dictionary'].merge(local_dictionary)
     end
@@ -90,7 +94,7 @@ class TalkLikeAPirate
 
     def config
       @@config ||= begin
-        gem_config_path = File.join File.dirname(__FILE__), 'talk_like_a_pirate', 'pirate_booty.yml'
+        gem_config_path = File.join File.dirname(__FILE__), 'config', 'pirate_booty.yml'
         YAML::load_file gem_config_path
       end
     end
@@ -105,8 +109,8 @@ class TalkLikeAPirate
 
     def local_config
       @@local_configs ||= begin
-        local_config_path = if Object.const_defined?(:Rails)
-          Rails.root.join('config', 'pirate_booty.yml')
+        local_config_path = if on_rails?
+          Rails.root.join 'config', 'pirate_booty.yml'
         else
           ENV['TALK_LIKE_A_PIRATE_CONFIG_PATH']
         end
@@ -134,8 +138,8 @@ class TalkLikeAPirate
   end
 end
 
-if Object.const_defined? :Rails
-  require 'talk_like_a_pirate/railties'
+if TalkLikeAPirate.on_rails?
+  require 'rails/railties'
 else
   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,6 +1,4 @@
-require 'talk_like_a_pirate'
-
-# TODO: Test Rails integration/railties/rake task
+require 'spec_helper'
 
 describe TalkLikeAPirate do
   def execute(string)
@@ -11,10 +9,6 @@ describe TalkLikeAPirate do
     expect(execute('between')).to eq "betwixt"
   end
 
-  it "shouldn't translate plural words without ActiveSupport" do
-    expect(execute("islands")).to eq 'islands'
-  end
-
   it "makes gerunds piratey" do
     expect(execute('having')).to eq "havin'"
   end
@@ -23,39 +17,47 @@ describe TalkLikeAPirate do
     expect(execute('havings')).to eq "havin's"
   end
 
-  it "properly capitalizes single words" do
+  it "capitalizes single words" do
     expect(execute('Boss')).to eq "Admiral"
   end
 
-  it "properly capitalizes all caps words" do
+  it "capitalizes all caps words" do
     expect(execute('BOSS')).to eq "ADMIRAL"
     expect(execute('BOSS!!!!')).to eq "ADMIRAL!!!!"
   end
 
-  it "properly capitalizes phrases" do
+  it "capitalizes phrases" do
     expect(execute('Bourbon Country')).to eq "Rum Land"
     expect(execute('Bourbon country')).to eq "Rum land"
   end
 
-  it "properly translates words with trailing punctuation" do
+  it "translates words with trailing punctuation" do
     expect(execute('man!!!')).to eq "pirate!!!"
     expect(execute('man!?!?!?!')).to eq "pirate!?!?!?!"
   end
 
-  it "properly translates plural gerunds with trailing punctuation" do
+  it "translates plural gerunds with trailing punctuation" do
     expect(execute('belongings!')).to eq "belongin's!"
   end
 
-  it "properly punctuates and translates words with leading and punctuation" do
+  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 "translates plural words when ActiveSupport's available" do
-    require "active_support"
-    require "active_support/inflector"
+  context 'without ActiveSupport' do
+    it "does not translate plural words" do
+      expect(execute("islands")).to eq 'islands'
+    end
+  end
+
+  context 'with ActiveSupport' do
+    it "translates plural words" do
+      require "active_support"
+      require "active_support/inflector"
 
-    expect(execute("islands")).to eq 'isles'
-    expect(execute("men")).to eq '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,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |spec|
   spec.name         = 'talk_like_a_pirate'
-  spec.version      = '0.2.0'
+  spec.version      = '0.2.1'
   spec.authors      = ['Steve Hodges']
   spec.email        = ['shodges317@gmail.com']
   spec.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.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Steve Hodges
@@ -109,16 +109,23 @@ 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: []

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
-