showoff 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e79f2890ed22c967bf20c13e7086bdd7e6fa441c
-  data.tar.gz: 5c328c3d8979191809a404b984202d2fca92a8cd
+  metadata.gz: fa2018ebcc69b506515c2a88f49b446347256416
+  data.tar.gz: 97d7de5896a47cdfc5432315513819fdc060a9c7
 SHA512:
-  metadata.gz: 281b88028b291de836db367604aaadead708eb79a34f060e1231defc51b188f5dc0cf01f1ceb8ca17e1662528d6f0d168929410f75a880a7c1ca5b24f95c0071
-  data.tar.gz: 2408b4d8909d3f84df131a7af5069cbc5029d8f768b67d6508d83899ccafec0d549e863554ef4dbfafe921be89395e2013fe505ee1bd77eb900bba1888d66cbe
+  metadata.gz: 55efb2446f06b35a6cf7d0dd28144ce9aaae1dcb95de8897bacf5fd82e896750525a555762305a7f4e47ee9ba7860607b6a1ed3619b21520a77cb4f636f14a50
+  data.tar.gz: 420f79aea8433eb3f147600bd774a2e4c9907c3c78c78a4bcd38cb077807d14e1de24fb8ca1b3e4018fbc7ef1243b640224b239989cd03d3011608ffb173c324

data/Rakefile

@@ -69,6 +69,43 @@ task :test do
   sh "turn test/*_test.rb #{suffix}"
 end
 
+
+desc 'Validate translation files'
+task 'lang:check' do
+  require 'yaml'
+
+  def compare_keys(left, right, name, stack=nil)
+    left.each do |key, val|
+      inner   = stack.nil? ? key : "#{stack}.#{key}"
+      compare = right[key]
+
+      case compare
+      when Hash
+        compare_keys(val, compare, name, inner)
+      when String
+        next
+      when NilClass
+        puts "Error: '#{inner}' is missing from #{name}"
+      else
+        puts "Error: '#{inner}' in #{name} is a #{compare.class}, not a Hash"
+      end
+    end
+
+  end
+
+  canonical = YAML.load_file('locales/en.yml')
+  languages = Dir.glob('locales/*.yml').reject {|lang| lang == 'locales/en.yml' }
+
+  languages.each do |langfile|
+    lang = YAML.load_file(langfile)
+    code = File.basename(langfile, '.yml')
+    key  = lang.keys.first
+
+    puts "Error: #{langfile} has the wrong language code (#{key})" unless code == key
+    compare_keys(canonical['en'], lang[key], langfile)
+  end
+end
+
 begin
   require 'mg'
   MG.new("showoff.gemspec")

data/bin/showoff

@@ -304,6 +304,9 @@ module Wrapper
     c.default_value "showoff.json"
     c.flag [:f, :file, :pres_file]
 
+    c.desc 'Language code to generate.'
+    c.flag [:l, :lang, :language, :locale]
+
     c.action do |global_options,options,args|
       ShowOff.do_static(args, options)
     end

data/lib/showoff.rb

@@ -9,6 +9,12 @@ require 'htmlentities'
 require 'sinatra-websocket'
 require 'tempfile'
 
+require 'i18n'
+require 'i18n/backend/fallbacks'
+require 'rack'
+require 'rack/contrib'
+require 'iso-639'
+
 here = File.expand_path(File.dirname(__FILE__))
 require "#{here}/showoff_utils"
 require "#{here}/commandline_parser"
@@ -53,6 +59,16 @@ class ShowOff < Sinatra::Application
   set :encoding, nil
   set :url, nil
 
+  # automatically select the translation based on the user's configured browser language
+  use Rack::Locale
+
+  configure do
+    I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+    I18n.load_path += Dir[File.join(settings.root, '..', 'locales', '*.yml')]
+    I18n.backend.load_translations
+    I18n.enforce_available_locales = false
+  end
+
   def initialize(app=nil)
     super(app)
     @logger = Logger.new(STDOUT)
@@ -62,10 +78,6 @@ class ShowOff < Sinatra::Application
     @review  = settings.review
     @execute = settings.execute
 
-    dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-    @logger.debug(dir)
-
-    showoff_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
     settings.pres_dir ||= Dir.pwd
     @root_path = "."
 
@@ -139,7 +151,7 @@ class ShowOff < Sinatra::Application
     @slide_count   = 0
     @section_major = 0
     @section_minor = 0
-    @section_title = settings.showoff_config['name'] rescue 'Showoff Presentation'
+    @section_title = settings.showoff_config['name'] rescue I18n.t('name')
     @@slide_titles  = [] # a list of generated slide names, used for cross references later.
 
     @logger.debug settings.pres_template
@@ -183,8 +195,9 @@ class ShowOff < Sinatra::Application
 
     @@downloads = Hash.new # Track downloadable files
     @@cookie    = nil      # presenter cookie. Identifies the presenter for control messages
+    @@master    = nil      # this holds the @client_id of the master presenter, for the cases in which multiple presenters are loaded
     @@current   = Hash.new # The current slide that the presenter is viewing
-    @@cache     = nil      # Cache slide content for subsequent hits
+    @@cache     = Hash.new # Cache slide content for subsequent hits
     @@activity  = []       # keep track of completion for activity slides
 
     if @interactive
@@ -199,8 +212,11 @@ class ShowOff < Sinatra::Application
 
     # Initialize Markdown Configuration
     MarkdownConfig::setup(settings.pres_dir)
-  end
 
+    # Process renderer config options
+    @engine_options = ShowOffUtils.showoff_renderer_options(settings.pres_dir)
+
+  end
   # save stats to disk
   def self.flush
     begin
@@ -260,6 +276,81 @@ class ShowOff < Sinatra::Application
       end
     end
 
+    # This is just a unified lookup method that takes a full locale name
+    # and then resolves it to an available version of the name
+    def with_locale(locale)
+      locale = locale.to_s
+      until (locale.empty?) do
+        result = yield(locale)
+        return result unless result.nil?
+
+        # if not found, chop off a section and try again
+        locale = locale.rpartition(/[-_]/).first
+      end
+    end
+
+    # turns a locale code into a string name
+    def get_language_name(locale)
+      with_locale(locale) do |str|
+        result = ISO_639.find(str)
+        result[3] unless result.nil?
+      end
+    end
+
+    # This function returns the directory containing translated *content*, defaulting
+    # to cwd. This works similarly to I18n fallback, but we cannot reuse that as it's
+    # a different translation mechanism.
+    def get_locale_dir(prefix, locale)
+      return '.' if locale == 'disable'
+
+      with_locale(locale) do |str|
+        path = "#{prefix}/#{str}"
+        return path if File.directory?(path)
+      end || '.'
+    end
+
+    # return a hash of all language codes available and the long name description of each
+    def language_names
+      Dir.glob('locales/*').inject({}) do |memo, entry|
+        next memo unless File.directory? entry
+
+        locale = File.basename(entry)
+        memo.update(locale => get_language_name(locale))
+      end
+    end
+
+    # returns the minimized canonical version of the current selected content locale
+    # it assumes that if the user has specified a locale, that it's already minimized
+    # note: if the locale doesn't exist on disk, it will just default to no translation
+    def locale(user_locale)
+      if [nil, '', 'auto'].include? user_locale
+        languages = I18n.available_locales
+        I18n.fallbacks[I18n.locale].select { |f| languages.include? f }.first
+      else
+        user_locale
+      end
+    end
+
+    # returns a hash of all translations for the current language. This is used
+    # for the javascript half of the translations
+    def get_translations
+      languages = I18n.backend.send(:translations)
+      fallback  = I18n.fallbacks[I18n.locale].select { |f| languages.keys.include? f }.first
+      languages[fallback]
+    end
+
+    # Finds the language key from strings.json and returns the strings hash. This is
+    # used for user translations in the presentation, e.g. SVG translations.
+    def user_translations
+      return {} unless File.file? 'locales/strings.json'
+      strings = JSON.parse(File.read('locales/strings.json')) rescue {}
+
+      with_locale(@locale) do |key|
+        return strings[key] if strings.include? key
+      end
+      {}
+    end
+
     # todo: move more behavior into this class
     class Slide
       attr_reader :classes, :text, :tpl, :bg
@@ -291,9 +382,8 @@ class ShowOff < Sinatra::Application
       if settings.encoding and content.respond_to?(:force_encoding)
         content.force_encoding(settings.encoding)
       end
-      engine_options = ShowOffUtils.showoff_renderer_options(settings.pres_dir)
       @logger.debug "renderer: #{Tilt[:markdown].name}"
-      @logger.debug "render options: #{engine_options.inspect}"
+      @logger.debug "render options: #{@engine_options.inspect}"
 
       # if there are no !SLIDE markers, then make every H1 define a new slide
       unless content =~ /^\<?!SLIDE/m
@@ -407,7 +497,7 @@ class ShowOff < Sinatra::Application
 
         # Apply the template to the slide and replace the key to generate the content of the slide
         sl = process_content_for_replacements(template.gsub(/~~~CONTENT~~~/, slide.text))
-        sl = Tilt[:markdown].new(nil, nil, engine_options) { sl }.render
+        sl = Tilt[:markdown].new(nil, nil, @engine_options) { sl }.render
         sl = build_forms(sl, content_classes)
         sl = update_p_classes(sl)
         sl = process_content_for_section_tags(sl, name, opts)
@@ -418,7 +508,7 @@ class ShowOff < Sinatra::Application
         content += "</div>\n"
         if content_classes.include? 'activity'
           content += '<span class="activityToggle">'
-          content += "  <label for=\"activity-#{ref}\">Activity complete</label>"
+          content += "  <label for=\"activity-#{ref}\">#{I18n.t('activity_complete')}</label>"
           content += "  <input type=\"checkbox\" class=\"activity\" name=\"activity-#{ref}\" id=\"activity-#{ref}\">"
           content += '</span>'
         end
@@ -497,14 +587,11 @@ class ShowOff < Sinatra::Application
       filename = File.join(settings.pres_dir, '_notes', "#{name}.md")
       @logger.debug "personal notes filename: #{filename}"
       if [nil, 'notes'].include? opts[:section] and File.file? filename
-        # TODO: shouldn't have to reparse config all the time
-        engine_options = ShowOffUtils.showoff_renderer_options(settings.pres_dir)
-
         # Make sure we've got a notes div to hang personal notes from
         doc.add_child '<div class="notes-section notes"></div>' if doc.css('div.notes-section.notes').empty?
         doc.css('div.notes-section.notes').each do |section|
-          text = Tilt[:markdown].new(nil, nil, engine_options) { File.read(filename) }.render
-          frag = "<div class=\"personal\"><h1>Personal Notes</h1>#{text}</div>"
+          text = Tilt[:markdown].new(nil, nil, @engine_options) { File.read(filename) }.render
+          frag = "<div class=\"personal\"><h1>#{I18n.t('presenter.notes.personal')}</h1>#{text}</div>"
           note = Nokogiri::HTML::DocumentFragment.parse(frag)
 
           if section.children.size > 0
@@ -715,8 +802,8 @@ class ShowOff < Sinatra::Application
 
       begin
         tools =  '<div class="tools">'
-        tools << '<input type="button" class="display" value="Display Results">'
-        tools << '<input type="submit" value="Save" disabled="disabled">'
+        tools << "<input type=\"button\" class=\"display\" value=\"#{I18n.t('forms.display')}\">"
+        tools << "<input type=\"submit\" value=\"#{I18n.t('forms.save')}\" disabled=\"disabled\">"
         tools << '</div>'
         form  = "<form id='#{title}' action='/form/#{title}' method='POST'>#{content}#{tools}</form>"
         doc = Nokogiri::HTML::DocumentFragment.parse(form)
@@ -742,7 +829,7 @@ class ShowOff < Sinatra::Application
     def form_element(id, code, name, required, rhs, text)
       required = required ? 'required' : ''
       str =  "<div class='form element #{required}' id='#{id}' data-name='#{code}'>"
-      str << "<label for='#{id}'>#{name}</label>"
+      str << "<label class='question' for='#{id}'>#{name}</label>"
       case rhs
       when /^\[\s+(\d*)\]$$/             # value = [    5]                                     (textarea)
         str << form_element_textarea(id, code, $1)
@@ -873,10 +960,10 @@ class ShowOff < Sinatra::Application
 
     def form_classes(modifier)
       modifier.downcase!
-      classes = []
+      classes = ['response']
       classes << 'correct' if modifier.include?('=')
 
-      classes.join
+      classes.join(' ')
     end
 
     def form_checked?(modifier)
@@ -1016,8 +1103,11 @@ class ShowOff < Sinatra::Application
     end
 
     def get_slides_html(opts={:static=>false, :pdf=>false, :toc=>false, :supplemental=>nil, :section=>nil})
+      sections = nil
+      Dir.chdir(get_locale_dir('locales', @locale)) do
+        sections = ShowOffUtils.showoff_sections(settings.pres_dir, settings.showoff_config, @logger)
+      end
 
-      sections = ShowOffUtils.showoff_sections(settings.pres_dir, @logger)
       if sections
         data = ''
         sections.each do |section, slides|
@@ -1102,17 +1192,11 @@ class ShowOff < Sinatra::Application
       # Provide a button in the sidebar for interactive editing if configured
       @edit     = settings.showoff_config['edit'] if @review
 
+      # translated UI strings, according to the current locale
+      @language = get_translations()
+
       # store a cookie to tell clients apart. More reliable than using IP due to proxies, etc.
-      if request.nil?   # when running showoff static
-        @client_id = guid()
-      else
-        if request.cookies['client_id']
-          @client_id = request.cookies['client_id']
-        else
-          @client_id = guid()
-          response.set_cookie('client_id', @client_id)
-        end
-      end
+      manage_client_cookies()
 
       erb :index
     end
@@ -1122,8 +1206,10 @@ class ShowOff < Sinatra::Application
       @issues    = settings.showoff_config['issues']
       @edit      = settings.showoff_config['edit'] if @review
       @feedback  = settings.showoff_config['feedback']
-      @@cookie ||= guid()
-      response.set_cookie('presenter', @@cookie)
+      @language  = get_translations()
+
+      manage_client_cookies(true)
+
       erb :presenter
     end
 
@@ -1165,21 +1251,26 @@ class ShowOff < Sinatra::Application
     end
 
     def slides(static=false)
+      @logger.warn "Cached presentations: #{@@cache.keys}"
+
+      # if we have a cache and we're not asking to invalidate it
+      return @@cache[@locale] if (@@cache[@locale] and params['cache'] != 'clear')
+
+      @logger.warn "Generating locale: #{@locale}"
+
       # If we're displaying from a repository, let's update it
       ShowOffUtils.update(settings.verbose) if settings.url
 
-      # if we have a cache and we're not asking to invalidate it
-      return @@cache if (@@cache and params['cache'] != 'clear')
       @@slide_titles = []
       content = get_slides_html(:static=>static)
 
       # allow command line cache disabling
-      @@cache = content unless settings.nocache
+      @@cache[@locale] = content unless settings.nocache
       content
     end
 
-    def print(static=false, section=nil)
-      @slides = get_slides_html(:static=>static, :toc=>true, :print=>true, :section=>section)
+    def print(section=nil)
+      @slides = get_slides_html(:static=>true, :toc=>true, :print=>true, :section=>section)
       @favicon = settings.showoff_config['favicon']
       erb :onepage
     end
@@ -1334,6 +1425,8 @@ class ShowOff < Sinatra::Application
       path = showoff.instance_variable_get(:@root_path)
       logger = showoff.instance_variable_get(:@logger)
 
+      I18n.locale = opts[:language]
+
       case what
       when 'supplemental'
         data = showoff.send(what, opt, true)
@@ -1342,7 +1435,7 @@ class ShowOff < Sinatra::Application
         data = showoff.send(what, opt)
       when 'print'
         opt ||= 'handouts'
-        data = showoff.send(what, true, opt)
+        data = showoff.send(what, opt)
       else
         data = showoff.send(what, true)
       end
@@ -1512,6 +1605,33 @@ class ShowOff < Sinatra::Application
     (request.cookies['presenter'] == @@cookie)
   end
 
+  def master_presenter?
+    @@master == @client_id
+  end
+
+  def manage_client_cookies(presenter=false)
+    # store a cookie to tell clients apart. More reliable than using IP due to proxies, etc.
+    if request.nil?   # when running showoff static
+      @client_id = guid()
+    else
+      if request.cookies['client_id']
+        @client_id = request.cookies['client_id']
+      else
+        @client_id = guid()
+        response.set_cookie('client_id', @client_id)
+      end
+
+      # if we have no content translations then remove the cookie
+      response.delete_cookie('locale') if language_names.empty?
+    end
+
+    if presenter
+      @@master ||= @client_id
+      @@cookie ||= guid()
+      response.set_cookie('presenter', @@cookie)
+    end
+  end
+
   post '/form/:id' do |id|
     client_id = request.cookies['client_id']
     @logger.warn("Saving form answers from ip:#{request.ip} with ID of #{client_id} for id:##{id}")
@@ -1723,7 +1843,7 @@ class ShowOff < Sinatra::Application
               control['id'] = guid()
               EM.next_tick { settings.presenters.each{|s| s.send(control.to_json) } }
 
-            when 'complete'
+            when 'complete', 'answerkey'
               EM.next_tick { settings.sockets.each{|s| s.send(control.to_json) } }
 
             when 'annotation', 'annotationConfig'
@@ -1771,7 +1891,8 @@ class ShowOff < Sinatra::Application
 
   # gawd, this whole routing scheme is bollocks
   get %r{/([^/]*)/?([^/]*)} do
-    @title = ShowOffUtils.showoff_title(settings.pres_dir)
+    @locale    = locale(request.cookies['locale'])
+    @title     = ShowOffUtils.showoff_title(settings.pres_dir)
     @pause_msg = ShowOffUtils.pause_msg
     what = params[:captures].first
     opt  = params[:captures][1]
@@ -1787,7 +1908,7 @@ class ShowOff < Sinatra::Application
 
     begin
       if (what != "favicon.ico")
-        if what == 'supplemental'
+        if ['supplemental', 'print'].include? what
           data = send(what, opt)
         else
           data = send(what)