haplo 2.4.4-java → 2.5.3-java

data/lib/debuggers.rb

@@ -0,0 +1,109 @@
+# Haplo Plugin Tool             http://docs.haplo.org/dev/tool/plugin
+# (c) Haplo Services Ltd 2006 - 2016    http://www.haplo-services.com
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+module PluginTool
+
+  @@profile_output = nil
+
+  def self.request_profile(options)
+    output_file = $stdout
+    close_output_file = false
+    if options.profile_file
+      output_file = File.open(options.profile_file, "a")
+      close_output_file = true
+    end
+
+    formatter = nil
+    case options.profile_format || 'tree'
+    when 'tree'
+      @@profile_output = ProfilerFormatterTree.new(output_file)
+    when 'raw'
+      @@profile_output = ProfilerFormatterRaw.new(output_file)
+    else
+      puts "Unknown profiler format: #{options.profile_format}"
+      exit 1
+    end
+
+    if 'OK' == PluginTool.post("/api/development-plugin-loader/debugger-profile-start", {:min => options.profile})
+      puts "JavaScript profiler started."
+    else
+      puts "Error starting JavaScript profiler."
+      exit 1
+    end
+    at_exit do
+      puts
+      puts "Disabling JavaScript profiler..."
+      PluginTool.post("/api/development-plugin-loader/debugger-profile-stop")
+      puts "JavaScript profiler disabled."
+      output_file.close if close_output_file
+    end
+  end
+
+  class ProfilerFormatter
+    def initialize(output_file)
+      @output_file = output_file
+    end
+    def format(report)
+      _format(report, @output_file)
+      @output_file.flush
+    end
+  end
+
+  class ProfilerFormatterRaw < ProfilerFormatter
+    def _format(report, output_file)
+      output_file.write(report)
+    end
+  end
+
+  class ProfilerFormatterTree < ProfilerFormatter
+    def _format(report, output_file)
+      report.split("\n").each do |line|
+        depth, time, percent, count, position = line.split("\t")
+        if depth == 'REPORT'
+          output_file.write("PROFILE -- #{Time.new(time)}\n")
+        elsif depth == 'OMIT'
+          output_file.write(("  "*time.to_i)+"... children omitted\n")
+        else
+          output_file.write(("  "*depth.to_i)+"#{percent} #{count} #{time.to_i / 1000000} #{position}\n")
+        end
+      end
+    end
+  end
+
+  def self.profiler_handle_report(report)
+    if @@profile_output
+      @@profile_output.format(report)
+    end
+  end
+
+  # -------------------------------------------------------------------------
+
+  def self.request_coverage(options)
+
+    format = options.coverage_format || 'raw'
+    if format != 'raw'
+      puts "Unknown coverage format: #{format}"
+      exit 1
+    end
+
+    if 'OK' == PluginTool.post("/api/development-plugin-loader/debugger-coverage-start")
+      puts "Coverage capture started."
+    else
+      puts "Error starting coverage capture."
+      exit 1
+    end
+
+    at_exit do
+      coverage = PluginTool.post("/api/development-plugin-loader/debugger-coverage-stop")
+      # TODO: Check errors
+      File.open(options.coverage_file, "w") { |f| f.write coverage }
+    end
+
+  end
+
+end
+

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/notifications.rb

@@ -69,6 +69,9 @@ module PluginTool
     when 'log '
       # Output from console.log()
       puts "LOG:#{data}"
+    when 'prof'
+      # Profiler report
+      PluginTool.profiler_handle_report(data)
     when 'audt'
       decoded = JSON.parse(data)
       kind = decoded.find { |name,value| name == 'auditEntryType' }.last

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,13 +17,13 @@ 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 = ['.']
 
 # Options for passing to plugin objects
-options = Struct.new(:output, :minimiser, :no_dependency, :with_dependency, :exclude_with_prefix, :no_console, :show_system_audit, :args, :force, :turbo, :server_substring, :restrict_to_app_id).new
+options = Struct.new(:output, :minimiser, :no_dependency, :with_dependency, :exclude_with_prefix, :no_console, :show_system_audit, :args, :force, :turbo, :profile, :profile_file, :profile_format, :coverage_file, :coverage_format, :server_substring, :restrict_to_app_id).new
 
 # Parse arguments
 show_help = false
@@ -37,6 +37,11 @@ opts = GetoptLong.new(
   ['--server', '-s', GetoptLong::REQUIRED_ARGUMENT],
   ['--force', GetoptLong::NO_ARGUMENT],
   ['--turbo', GetoptLong::NO_ARGUMENT],
+  ['--profile', GetoptLong::REQUIRED_ARGUMENT],
+  ['--profile-file', GetoptLong::REQUIRED_ARGUMENT],
+  ['--profile-format', GetoptLong::REQUIRED_ARGUMENT],
+  ['--coverage-file', GetoptLong::REQUIRED_ARGUMENT],
+  ['--coverage-format', GetoptLong::REQUIRED_ARGUMENT],
   ['--output', GetoptLong::REQUIRED_ARGUMENT],
   ['--pack-restrict-to-app-id', GetoptLong::REQUIRED_ARGUMENT],
   ['--no-console', '-n', GetoptLong::NO_ARGUMENT],
@@ -72,6 +77,16 @@ opts.each do |opt, argument|
     options.force = true
   when '--turbo'
     options.turbo = true
+  when '--profile'
+    options.profile = argument.to_f
+  when '--profile-file'
+    options.profile_file = argument
+  when '--profile-format'
+    options.profile_format = argument
+  when '--coverage-file'
+    options.coverage_file = argument
+  when '--coverage-format'
+    options.coverage_format = argument
   end
 end
 # Handle rest of command line -- first arg is the command, the rest are passed on
@@ -144,7 +159,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 +186,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 +318,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,12 +331,22 @@ 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
 unless LOCAL_ONLY_COMMANDS[PLUGIN_TOOL_COMMAND]
   PluginTool.custom_behaviour.server_ready(plugins, PLUGIN_TOOL_COMMAND, options)
   plugins.each { |p| p.setup_for_server }
+
+  if options.profile
+    PluginTool.request_profile(options)
+  end
+  if options.coverage_file
+    PluginTool.request_coverage(options)
+  end
 end
 
 # Run the command

data/lib/run.rb

@@ -65,9 +65,11 @@ require "#{PLUGIN_TOOL_ROOT_DIR}/lib/syntax_checking.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/notifications.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/plugin.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/new_plugin.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/debuggers.rb"
 require "#{PLUGIN_TOOL_ROOT_DIR}/lib/misc.rb"
 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 @@
-ba15ef2
+a60e0f9

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haplo
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.5.3
 platform: java
 authors:
 - Haplo Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-24 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies: []
 description: Development tools for developing Haplo plugins, see https://haplo.org
 email: client.services@haplo-services.com
@@ -24,9 +24,11 @@ files:
 - lib/auth.rb
 - lib/check.rb
 - lib/custom.rb
+- lib/debuggers.rb
 - 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
@@ -69,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 2.7.9
 signing_key:
 specification_version: 4
 summary: Haplo Plugin Tool