Class: Twine::Formatters::Gettext

Inherits:
Abstract
  • Object
show all
Defined in:
lib/twine/formatters/gettext.rb

Constant Summary collapse

FORMAT_NAME = 
'gettext'
EXTENSION = 
'.po'
DEFAULT_FILE_NAME = 
'strings.po'

Instance Attribute Summary

Attributes inherited from Abstract

#options, #strings

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Abstract

#escape_quotes, #format_key_value, #format_section, #format_sections, #initialize, #key_value_pattern, #output_path_for_language, #set_comment_for_key, #set_translation_for_key, #write_all_files, #write_file

Constructor Details

This class inherits a constructor from Twine::Formatters::Abstract

Class Method Details

.can_handle_directory?(path) ⇒ Boolean

Returns:

  • (Boolean) 


10
11
12
 
# File 'lib/twine/formatters/gettext.rb', line 10

def self.can_handle_directory?(path)
  Dir.entries(path).any? { |item| /^.+\.po$/.match(item) }
end

Instance Method Details

#default_file_name ⇒ Object 



14
15
16
 
# File 'lib/twine/formatters/gettext.rb', line 14

def default_file_name
  return DEFAULT_FILE_NAME
end

#determine_language_given_path(path) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/twine/formatters/gettext.rb', line 18

def determine_language_given_path(path)
  path_arr = path.split(File::SEPARATOR)
  path_arr.each do |segment|
    match = /(..)\.po$/.match(segment)
    if match
      return match[1]
    end
  end

  return
end

#format_base_translation(row, lang) ⇒ Object 



94
95
96
 
# File 'lib/twine/formatters/gettext.rb', line 94

def format_base_translation(row, lang)
  "msgid \"#{row.translations[@default_lang]}\"\n"
end

#format_comment(row, lang) ⇒ Object 



86
87
88
 
# File 'lib/twine/formatters/gettext.rb', line 86

def format_comment(row, lang)
  "#. \"#{escape_quotes(row.comment)}\"\n" if row.comment
end

#format_file(strings, lang) ⇒ Object 



63
64
65
66
 
# File 'lib/twine/formatters/gettext.rb', line 63

def format_file(strings, lang)
  @default_lang = strings.language_codes[0]
  super
end

#format_header(lang) ⇒ Object 



68
69
70
 
# File 'lib/twine/formatters/gettext.rb', line 68

def format_header(lang)
  "msgid \"\"\nmsgstr \"\"\n\"Language: #{lang}\\n\"\n\"X-Generator: Twine #{Twine::VERSION}\\n\"\n"
end

#format_key(row, lang) ⇒ Object 



90
91
92
 
# File 'lib/twine/formatters/gettext.rb', line 90

def format_key(row, lang)
  "msgctxt \"#{row.key.dup}\"\n"
end

#format_row(row, lang) ⇒ Object 



80
81
82
83
84
 
# File 'lib/twine/formatters/gettext.rb', line 80

def format_row(row, lang)
  return nil unless row.translated_string_for_lang(@default_lang)

  super
end

#format_section_header(section) ⇒ Object 



72
73
74
 
# File 'lib/twine/formatters/gettext.rb', line 72

def format_section_header(section)
  "# SECTION: #{section.name}"
end

#format_value(row, lang) ⇒ Object 



98
99
100
 
# File 'lib/twine/formatters/gettext.rb', line 98

def format_value(row, lang)
  "msgstr \"#{row.translated_string_for_lang(lang)}\"\n"
end

#read_file(path, lang) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twine/formatters/gettext.rb', line 30

def read_file(path, lang)
  comment_regex = /#.? *"(.*)"$/
  key_regex = /msgctxt *"(.*)"$/
  value_regex = /msgstr *"(.*)"$/m
  File.open(path, 'r:UTF-8') do |f|
    while item = f.gets("\n\n")
      key = nil
      value = nil
      comment = nil

      comment_match = comment_regex.match(item)
      if comment_match
        comment = comment_match[1]
      end
      key_match = key_regex.match(item)
      if key_match
        key = key_match[1].gsub('\\"', '"')
      end
      value_match = value_regex.match(item)
      if value_match
        value = value_match[1].gsub(/"\n"/, '').gsub('\\"', '"')
      end
      if key and key.length > 0 and value and value.length > 0
        set_translation_for_key(key, lang, value)
        if comment and comment.length > 0 and !comment.start_with?("SECTION:")
          set_comment_for_key(key, comment)
        end
        comment = nil
      end
    end
  end
end

#row_pattern ⇒ Object 



76
77
78
 
# File 'lib/twine/formatters/gettext.rb', line 76

def row_pattern
  "%{comment}%{key}%{base_translation}%{value}"
end