ssmd 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d42b96948cc0f6cba51d32c373859288da241fb8
-  data.tar.gz: d8e345a4e1447f8f57b50d5f75bcf596257ecf0e
+SHA256:
+  metadata.gz: d09b748d209127855bbf790dc89eaa53891d978b3070773212203a6c1d460dc4
+  data.tar.gz: 90495308c981fd7cd3b857c05461a478ed287878fe79832584b67625ed768351
 SHA512:
-  metadata.gz: 27513191b8e046618af615c43dc0ac517095cdcd2a4608374cde81aa15db9b7b60a400b6c36a3d574371ace84fbfe6b908a10559dcec46fe2821fd9a82290cdc
-  data.tar.gz: 4e0dd07a0420d06b991495690a4c5843fdcc71236de492c389c6ddb2fd5f559b507d060eca10005427e5b2e14b4ef9486f60932c06381ced2ae874d559194aa7
+  metadata.gz: 80f139fc45586b23c2247275f7ffcca9c06d1664a123e25f7ff418ee15613cc0b59515d22b6de3aaca2b96eb61e9bb6921bec7a91b9ce5b001f19b49f18e16d1
+  data.tar.gz: 236365024367acb03f85422e30c4b773e80c478ef5d8743b4f65b85abc434511bbaa440b6a656cf011b743a7146c6b7e535597e5884eb325c904465e85a57b66

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/machisuji/ssmd.svg?branch=master)](https://travis-ci.org/machisuji/ssmd)
 
-Speech Synthesis Markdown (SSMD) is an lightweight alternative syntax for [SSML](https://www.w3.org/TR/speech-synthesis/).
+Speech Synthesis Markdown (SSMD) is a lightweight alternative syntax for [SSML](https://www.w3.org/TR/speech-synthesis/).
 This repository contains both the reference implementation of the SSMD-to-SSML conversion tool (`ssmd`) as well
 as the [specification](SPECIFICATION.md) of the language.
 
@@ -28,6 +28,8 @@ Or install it yourself as:
 
 ## Usage
 
+You can convert SSML to SSMD using `SSMD::to_ssml`:
+
 ```ruby
 require 'ssmd'
 
@@ -38,6 +40,19 @@ puts ssml
 # Output: <speak>hello <emphasis>SSMD</emphasis>!</speak>
 ```
 
+Sometimes you will want to see just the plain text without any SSMD annotations.
+For this you can use `SSMD::stip_ssmd`:
+
+```ruby
+require 'ssmd'
+
+ssmd = "[hallo](de) *SSMD*!"
+plain_text = SSMD.strip_ssmd ssmd
+
+puts plain_text
+# Output: hallo SSMD!
+```
+
 **Note:**
 
 This version is still under development. See below which essential SSML constructs are implemented so far:

data/SPECIFICATION.md

@@ -107,7 +107,7 @@ I saw <lang xml:lang="de-DE">"Die Häschenschule"</lang> in the cinema.
 
 ### Mark
 
-Sections of text can be tagged using marks. They do not effect the synthesis but
+Sections of text can be tagged using marks. They do not affect the synthesis but
 can be returned by SSML processing engines as meta information and to emit
 events during processing based on these marks.
 
@@ -242,7 +242,7 @@ medium
 ```
 
 The shortcuts are listed first. While they can be combined, sometimes it's easier and shorter to just use
-the explizit form shown in the last 2 lines. All of them can be nested, too.
+the explicit form shown in the last 2 lines. All of them can be nested, too.
 Moreover changes in volume (`[louder](v: +10dB)`) and pitch (`[lower](p: -4%)`) can also be given explicitly in relative values.
 
 ***

data/lib/ssmd/converter.rb

@@ -1,4 +1,5 @@
 require 'ssmd/processors'
+require 'cgi'
 
 module SSMD
   class Converter
@@ -14,7 +15,7 @@ module SSMD
     end
 
     def convert
-      result = processors.inject(input.encode(xml: :text)) do |text, processor|
+      result = processors.inject(escape_xml(input)) do |text, processor|
         process processor.new(processor_options), text
       end
 
@@ -22,9 +23,11 @@ module SSMD
     end
 
     def strip
-      processors.inject(input) do |text, processor|
+      result = processors.inject(escape_xml(input)) do |text, processor|
         process processor.new(processor_options), text, strip: true
       end
+
+      unescape_xml result
     end
 
     def processors
@@ -50,5 +53,22 @@ module SSMD
     def processor_options
       { skip: skip }
     end
+
+    ##
+    # Substitutes special characters with their XML entity.
+    # E.g. it substitutes "<" with "&lt;".
+    def escape_xml(text)
+      text.encode(xml: :text)
+    end
+
+    ##
+    # Substitutes back XML entities with their plain text equivalent.
+    # E.g. it substitutes "&lt;" with "<".
+    #
+    # @TODO Find alternative which applies to XML in general.
+    # Not sure if it even makes a difference in this case, though.
+    def unescape_xml(text)
+      CGI.unescape_html text
+    end
   end
 end

data/lib/ssmd/version.rb

@@ -1,3 +1,3 @@
 module SSMD
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssmd
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Markus Kahl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2018-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Speech Synthesis Markdown (SSMD) is an lightweight alternative syntax for