RubyGems - html2index - Versions diffs - 1.2.1 - Mend

html2index 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/lib/template.rb ADDED Viewed

@@ -0,0 +1,134 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2017-2017 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+require 'logger'
+require 'date'
+require_relative 'logging'
+require_relative 'dictionary'
+require_relative 'constants'
+require_relative 'file_checking'
+class Template
+  self.extend(Logging)
+  @@log = init_logger
+  def initialize()
+    @log = @@log
+    @log.level = $log_level
+    template_file = $configuration.template
+    @template = nil
+    if template_file
+      msg = File_Checking::file_check(template_file, :file, :readable )
+      if !msg
+        ftype = File_Checking::file_type(template_file)
+        if ftype && !ftype.empty? && !ftype[0].downcase.match("(html|xml) .*document")
+          msg = template_file.dup << ' does not look like a valid template file for (x)html: ' << ftype.join('; ')
+        end
+      end
+      if(!msg)
+        @template = File.read(template_file)
+        @log.debug('using template ' << template_file)
+      else
+        @log.warn('Cannot use template ' << template_file << ': ' << msg << "\n\tusing default template")
+      end
+    end
+  end
+  def to_s
+    str = nil
+    if @template && @template.respond_to?(:to_str)
+      str = @template
+    else
+      @log.warn('Empty template, using default!')
+      str = @@def_template
+    end
+    str
+  end
+  attr_accessor :template
+  def self::default(name)
+    case name
+    when :fdelim
+      @@fdelim
+    when :placeholders
+      @@placeholders
+    when :def_template
+      @@def_template
+    else
+      @log.error('Do not know ' << name.to_s)
+      @log.error('Aborting. Bye!')
+    end
+  end
+  @@fdelim = '%='
+  @@placeholders = {:dict_list => 'dict_list', :glossary => 'index'}
+  @@def_template = %~<?xml version="1.0" encoding="utf-8"?>
+  <!-- created with HTML2Index #{VERSION}-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+                <meta http-equiv="Content-Script-Type" content="text/javascript" />
+                <meta http-equiv="Content-Style-Type" content="text/css" />
+                <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+                <meta http-equiv="Content-Type" content="application/xhtml+xml" />
+                <meta name="revisit-after" content="30 days" />
+                <title>Glossaire</title>
+                <style type="text/css">
+                        body {font-family:LinuxBiolinum, Trebuchet;}
+                        h1 {margin-left:1em; margin-bottom:1em;}
+                        div.content {margin-bottom:9em;margin-left:2em;width:80%;border:1px solid #000060;padding:1em;border-radius:1em;}
+                        div.sources {border:0.5pt solid #000060;border-radius:1em;padding:0 0.5em 0 0.5em;background-color:#e0e0f0;margin:3em;width:40em;}
+                        dt {font-weight:bold;color:#000070;}
+                        div.navtop {border:1px solid #000000;border-radius:1em;background-color:#ffffff;font-weight:bold;font-size:1.3em;position:fixed;top:1em;right:7em;}
+                        a {text-decoration:none;}
+                        a:hover {border:1px solid #800000;border-radius:1em;}
+                        dd i {text-decoration:underline;}
+                        #omega {color:#a000a0;font-weight:bold;text-align:right;margin-right:12em;}
+                </style>
+        </head>
+        <body>
+                <div class="navtop" title="début"><a href="#top">&#x21e7;</a></div>
+                <div><a id="top"></a></div>
+                <p style="position:absolute;right:2em;top:2em;">généré avec html2index #{VERSION}, #{Date.today.to_s}</p>
+                <h1>Glossaire </h1>
+                <div class="sources">
+                        <h2>Sources</h2>
+                        <!-- ============================ -->
+                        <!-- Insert list of dictionaries -->
+  #{@@fdelim}#{@@placeholders[:dict_list]}#{@@fdelim.reverse}
+                        <!-- ============================ -->
+                </div>
+                <div class="content">
+                       <!-- ============================ -->
+                       <!-- Insert glossary -->
+  #{@@fdelim}#{@@placeholders[:glossary]}#{@@fdelim.reverse}
+                       <!-- ============================ -->
+                      <div id="omega">&Omega;</div>
+                </div>
+        </body>
+</html>~
+end

data/lib/translating.rb ADDED Viewed

@@ -0,0 +1,89 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-2017, Michael Uplawski				           *
+ *   <michael.uplawski@uplawski.eu>  					   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+RD = File.expand_path(File.dirname(__FILE__) ) +  File::SEPARATOR if !defined?(RD)
+require 'yaml'
+require_relative 'file_checking'
+# A way to produce translated text in a ruby-program.
+# Translations are read from a file "translations" in the program folder.
+module Translating
+	# There are better ways to extend a translated
+	# string, but I keep the 'wild-card' for
+	# historical reasons.
+	@@awild = 'XX'
+	@@lang = nil
+	@@lang_file = format("%s%s", RD, 'LANG')
+	@@tr = YAML::load_file("#{RD}translations")
+	# find the current language-setting and return it.
+	def self.language()
+		if @@lang == nil
+			r = ENV['LANG']
+			if(r)
+				@@lang = r[0, 2]
+			elsif( !File_Checking::file_check(@@lang_file, [:exist?, :readable?]) && File::size(@@lang_file) >= 2)
+				File::open(@@lang_file, 'r') {|f| @@lang = f.readline}
+				@@lang.chomp!.downcase! if @@lang
+			end
+		end
+		@@lang = 'en' if !@@lang
+	end
+	# Translate a string to the currently set langage.
+	# The args parameter may contain replacement-text which
+	# will appear at the positions indicated by wildcard-characters
+	# in the original string.
+	def self.trl(t, *args)
+		Translating::language()
+		lt = @@tr[t]
+		if(lt)
+			lt = lt[@@lang]
+		else
+			# File.open('/tmp/mtf', 'a+') {|f| f << t << "\n"}
+			puts "\nTRANSLATION MISSING: \"" << t << "\""
+		end
+		lt ||= t
+		if(args && !args.empty?)
+			i = -1
+			lt = lt.gsub(@@awild) do |a|
+				i += 1
+				args.flatten[i]
+			end
+			lt += args[i + 1, args.length].join
+		end
+		return lt
+	end
+	# Translate a string to the currently set langage.
+	# The args parameter may contain replacement-text which
+	# will appear at the positions indicated by wildcard-characters
+	# in the original string.
+	def trl(t, *args )
+		Translating::trl(t, args)
+	end
+end

data/lib/translations ADDED Viewed

File without changes

data/lib/user_input.rb ADDED Viewed

@@ -0,0 +1,45 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright © 2014, Michael Uplawski <michael.uplawski@uplawski.eu>     *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+require 'io/wait'
+require 'io/console'
+def wait_for_user()
+	char = nil
+	STDIN.raw do
+		STDIN.noecho do
+			until (STDIN.ready?)
+				sleep(0.1)
+			end
+			char = (STDIN.read_nonblock(1).ord rescue nil)
+		end
+	end
+	return char
+end
+#### TEST
+if __FILE__ == $0
+	puts 'hit any key'
+	puts wait_for_user().chr
+end

data/lib/version.rb ADDED Viewed

@@ -0,0 +1,12 @@
+#
+# DON'T FORGET SCHWEINE-MET ON THE FENSTERBRETT !!
+# =================================================
+# - Change gemspec !!
+# - Change version in the doc/rst folder !!
+# - INSTALL AND TEST THAT GEM !!
+# - gem push
+#
+# - blame yourself.
+#
+VERSION='1.2.1'

metadata ADDED Viewed

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: html2index
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Michael Uplawski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.9
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+description: creates a glossary from HTML
+email: michael.uplawski@uplawski.eu
+executables:
+- html2index
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/html2index
+- doc/html/html2index.html
+- doc/man/html2index.1.gz
+- doc/pdf/html2index.pdf
+- doc/rst/html2index.rst
+- html2index.gemspec
+- lib/argparser.rb
+- lib/configuration.rb
+- lib/constants.rb
+- lib/definition.rb
+- lib/dictionary.rb
+- lib/file_checking.rb
+- lib/html2index.rb
+- lib/log.conf
+- lib/logging.rb
+- lib/template.rb
+- lib/translating.rb
+- lib/translations
+- lib/user_input.rb
+- lib/version.rb
+homepage: http://www.souris-libre.fr
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- nokogiri, ruby-filemagic
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: updated dependencies, updated use of the URI module.
+test_files: []