haplo 2.4.2-java → 2.5.2-java

data/lib/i18n_extract_text.rb

@@ -0,0 +1,46 @@
+
+module PluginTool
+
+  def self.i18n_extract_text(plugins)
+    text = {}
+
+    # Get text from templates. This is exact, because each template is parsed.
+    parser_config = TemplateParserConfiguration.new
+    plugins.each do |plugin|
+      Dir.glob("#{plugin.plugin_dir}/template/**/*.hsvt").sort.each do |template|
+        template = Java::OrgHaploTemplateHtml::Parser.new(File.read(template), "extract", parser_config).parse()
+        template.extractTranslatedStrings().each do |string|
+          text[string] = string
+        end
+      end
+    end
+
+    # Get text from JS files, which isn't exact, because it just relies on convention and hopes for the best.
+    plugins.each do |plugin|
+      Dir.glob("#{plugin.plugin_dir}/js/**/*.js").sort.each do |js_file|
+        js = File.read(js_file)
+        [/\bi\['([^']+)'\]/, /\bi\["([^"]+)"\]/].each do |regexp|
+          js.scan(regexp) do
+            text[$1] = $1
+          end
+        end
+      end
+    end
+
+    # Last, add in any of the default locale's text, so where text is looked up by symbol, the translation is included.
+    plugins.each do |plugin|
+      ['global','local'].each do |scope|
+        maybe_strings = "#{plugin.plugin_dir}/i18n/#{scope}/#{plugin.default_locale_id}.template.json"
+        if File.exist?(maybe_strings)
+          strings = JSON.parse(File.read(maybe_strings))
+          strings.each do |k,v|
+            text[k] = v
+          end
+        end
+      end
+    end
+
+    puts JSON.pretty_generate(text)
+  end
+
+end

data/lib/manifest.rb

@@ -7,7 +7,7 @@
 
 module PluginTool
 
-  PLUGIN_ACCEPTABLE_FILENAME = /\A(js|static|template|test|file)\/([A-Za-z0-9_\.-]+\/)*[A-Za-z0-9_\.-]+\.[A-Za-z0-9]+\z/
+  PLUGIN_ACCEPTABLE_FILENAME = /\A(js|static|template|test|file|i18n)\/([A-Za-z0-9_\.-]+\/)*[A-Za-z0-9_\.-]+\.[A-Za-z0-9]+\z/
   PLUGIN_ACCEPTABLE_FILENAME_EXCEPTIONS = ['plugin.json', 'requirements.schema', 'global.js', 'certificates-temp-http-api.pem', 'developer.json', 'readme.txt']
   def self.plugin_filename_allowed?(filename)
     (filename =~ PLUGIN_ACCEPTABLE_FILENAME) || (PLUGIN_ACCEPTABLE_FILENAME_EXCEPTIONS.include?(filename))

data/lib/packing.rb

@@ -50,7 +50,10 @@ module PluginTool
       end
       # Minimise file?
       unless filename =~ /\A(js|test)\//
-        data = minimiser.process(data, filename)
+        # Is this file explicitly excluded from minimisation?
+        unless plugin.exclude_files_from_minimisation.include?(filename)
+          data = minimiser.process(data, filename)
+        end
       end
       hash = Digest::SHA256.hexdigest(data)
       # Make sure output directory exists, write file

data/lib/plugin.rb

@@ -29,6 +29,11 @@ module PluginTool
     attr_accessor :depend
     attr_accessor :loaded_plugin_id
 
+    def default_locale_id
+      # TODO: Other default locales
+      'en'
+    end
+
     # ---------------------------------------------------------------------------------------------------------
 
     @@pending_apply = []
@@ -97,6 +102,17 @@ module PluginTool
       end
     end
 
+    def exclude_files_from_minimisation
+      @exclude_files_from_minimisation ||= begin
+        # developer.json file might specify files which should skip minimisation when packing
+        if developer_json['excludeFromMinimisation'].kind_of?(Array)
+          developer_json['excludeFromMinimisation']
+        else
+          []
+        end
+      end
+    end
+
     # ---------------------------------------------------------------------------------------------------------
 
     def command(cmd, errors)
@@ -175,11 +191,16 @@ module PluginTool
           hash = action
           # Minimise file before uploading?
           if @options.minimiser != nil && filename =~ /\A(static|template)\//
-            size_before = data.length
-            data = @options.minimiser.process(data, filename)
-            size_after = data.length
-            hash = Digest::SHA256.hexdigest(data)
-            puts "        minimisation: #{size_before} -> #{size_after} (#{(size_after * 100) / size_before}%)"
+            # Is this file explicitly excluded from minimisation?
+            unless exclude_files_from_minimisation.include?(filename)
+              size_before = data.length
+              data = @options.minimiser.process(data, filename)
+              size_after = data.length
+              hash = Digest::SHA256.hexdigest(data)
+              puts "        minimisation: #{size_before} -> #{size_after} (#{(size_after * 100) / size_before}%)"
+            else
+              puts "        minimisation: skipped by developer.json, unmodified file uploaded"
+            end
           end
           r = PluginTool.post_with_json_response("/api/development-plugin-loader/put-file/#{@loaded_plugin_id}", params, {:file => [filename, data]})
           if r["result"] == 'success'

data/lib/plugin_tool.rb

@@ -17,7 +17,7 @@ end
 PluginTool.try_load_custom
 
 WORKSPACE_FILE = 'workspace.json'
-LOCAL_ONLY_COMMANDS = {"license-key" => true, "pack" => true, "check" => true, "new" => true, "list" => true}
+LOCAL_ONLY_COMMANDS = {"license-key" => true, "pack" => true, "check" => true, "new" => true, "list" => true, "extract-text" => true}
 NO_DEPENDENCY_COMMANDS = {"reset-db" => true}.merge(LOCAL_ONLY_COMMANDS)
 NO_DEPENDENCY_COMMANDS.delete('list')
 PLUGIN_SEARCH_PATH = ['.']
@@ -144,7 +144,7 @@ unless LOCAL_ONLY_COMMANDS[PLUGIN_TOOL_COMMAND]
   PluginTool.setup_auth(options)
   PluginTool.check_for_certificate_file
   application_info = PluginTool.get_application_info
-  puts "Remote application name: #{(application_info["name"]||'').to_s.strip.gsub(/\s+/,' ')}"
+  STDERR.puts "Remote application name: #{(application_info["name"]||'').to_s.strip.gsub(/\s+/,' ')}"
 end
 
 if PLUGIN_TOOL_COMMAND == 'devtools'
@@ -171,6 +171,18 @@ if PLUGIN_TOOL_COMMAND == 'template-debugging'
   end
 end
 
+if PLUGIN_TOOL_COMMAND == 'i18n-debugging'
+  disable = (ARGV[0] == 'disable')
+  puts disable ? "Disabling i18n debugging..." : "Enabling i18n debugging..."
+  if 'OK' == PluginTool.post("/api/development-plugin-loader/i18n-debugging?enable=#{disable ? '0' : '1'}")
+    puts "Done"
+    exit 0
+  else
+    puts "Error updating server"
+    exit 1
+  end
+end
+
 # If the user didn't requested a plugin, try to use the application info to select the root plugin
 if requested_plugins.empty? && application_info
   application_root_plugin = application_info["config"]["applicationRootPlugin"]
@@ -291,7 +303,7 @@ if PLUGIN_TOOL_COMMAND == 'list'
   exit 0
 end
 
-puts "#{plugins.length} plugin#{plugins.length != 1 ? 's' : ''}"
+STDERR.puts "#{plugins.length} plugin#{plugins.length != 1 ? 's' : ''}"
 
 # Custom behaviour for this repo?
 PluginTool.custom_behaviour.start(plugins, PLUGIN_TOOL_COMMAND, options, LOCAL_ONLY_COMMANDS[PLUGIN_TOOL_COMMAND])
@@ -304,6 +316,9 @@ when 'pack'
 when 'check'
   PluginTool.check_plugins(plugins)
   exit 0
+when 'extract-text'
+  PluginTool.i18n_extract_text(plugins)
+  exit 0
 end
 
 # Set up local plugin objects against server

data/lib/run.rb

@@ -70,4 +70,5 @@ require "#{PLUGIN_TOOL_ROOT_DIR}/lib/watchers.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/minimise.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/check.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/custom.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/i18n_extract_text.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/plugin_tool.rb"

data/lib/server.rb

@@ -50,6 +50,7 @@ module PluginTool
     http.use_ssl = true
     http.verify_mode = OpenSSL::SSL::VERIFY_PEER
     http.cert_store = ssl_ca
+    http.read_timeout = 3600 # 1 hour, in case a test runs for a very long time
     http.start
     http
   end

data/lib/usage.txt

@@ -68,6 +68,10 @@ Commands:
     Enable or disable template debugging, including adding comments in generated HTML
     to indicate which templates were used.
 
+  i18n-debugging [disable]
+    Enable or disable internationalisation debugging, including indicating which text
+    in the user interface is translated.
+
   auth [SERVER]
     Authorise with server. SERVER can optionally include a non-default port number.
 
@@ -93,6 +97,10 @@ Commands:
   check
     Perform checks on the plugin as a quick test before it's submitted for review.
 
+  extract-text
+    Extract translatable text from templates, and attempt to extract text from JavaScript
+    files, and output a JSON data structure suitable for translation.
+
   license-key <application-id>
     Generate a license key to allow plugin installation by a client. The numeric
     application ID is displayed during plugin installation.

data/lib/version.txt

@@ -1 +1 @@
-ed77bab
+8864920

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haplo
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.2
 platform: java
 authors:
 - Haplo Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies: []
 description: Development tools for developing Haplo plugins, see https://haplo.org
 email: client.services@haplo-services.com
@@ -27,6 +27,7 @@ files:
 - lib/haplo-templates.jar
 - lib/hmac.rb
 - lib/hsvt_parser_config.rb
+- lib/i18n_extract_text.rb
 - lib/js.jar
 - lib/js_min.js
 - lib/js_syntax_test.js