correspondence-markup 0.0.4

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rspec/core/rake_task'
+
+begin
+  require "bundler"
+  Bundler.setup
+rescue LoadError
+  $stderr.puts "You need to have Bundler installed to be able build this gem."
+end
+
+gemspec = eval(File.read("correspondence-markup.gemspec"))
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*spec.rb'
+end
+
+task :default => :spec
+
+

data/lib/correspondence-markup.rb

@@ -0,0 +1,22 @@
+require 'polyglot'
+require 'treetop'
+
+require 'correspondence-markup/bracketed-grammar'
+
+module CorrespondenceMarkup
+  
+  class CorrespondenceMarkupCompiler
+    def initialize
+      @parser = CorrespondenceMarkupLanguageParser.new
+    end
+    
+    def compile_structure_groups(markup)
+      @parser.parse(markup, root: :structure_groups).value
+    end
+  end
+  
+  def self.sayHello
+    "hello"
+  end
+  
+end

data/lib/correspondence-markup/bracketed-grammar.treetop

@@ -0,0 +1,79 @@
+require "correspondence-markup/types"
+
+grammar CorrespondenceMarkupLanguage
+
+  include CorrespondenceMarkup
+
+  rule structure_groups
+    s groups:("[" structure_group "]" s)*
+    {
+      def value
+        groups.elements.map {|e| e.structure_group.value}
+      end
+    }
+  end
+
+  rule structure_group
+    s structures:("[" structure "]" s)*
+    { 
+      def value
+        structureObjects = structures.elements.map {|e| e.structure.value}
+        CorrespondenceMarkup::StructureGroup.new(structureObjects)
+      end
+    }
+  end
+
+  rule structure
+    components:(item / non_item)*
+    { 
+      def value
+        CorrespondenceMarkup::Structure.new(components.elements.map &:value)
+      end
+    }
+  end
+  
+  rule non_item
+    text:text
+    { 
+      def value
+        CorrespondenceMarkup::NonItem.new(text.value)
+      end
+    }
+  end
+
+  rule item
+    "[" id:number S text:text "]"
+    { 
+      def value
+        CorrespondenceMarkup::Item.new(id.value, text.value)
+      end
+    }
+  end
+
+  rule text
+    (("\\" .) / (![\[\]\\] .))+
+    { 
+      def value
+        text_value.gsub(/\\(.)/, '\1')
+      end
+    }
+  end
+
+  rule number
+    [0-9]+
+    { 
+      def value
+        text_value.to_i
+      end
+    }
+  end
+
+  rule s
+    [\s\n\r\t]*
+  end
+
+  rule S
+    [\s\n\r\t]+
+  end
+
+end

data/lib/correspondence-markup/types.rb

@@ -0,0 +1,134 @@
+
+require 'cgi'
+
+module CorrespondenceMarkup
+  
+  module Helpers
+    
+    # Either 1: a tag enclosed in "<" & ">", possibly missing the ">", or, 2: text outside a tag
+    TAGS_AND_TEXT_REGEX = /([<][^>]*[>]?)|([^<]+)/
+    
+    def self.split_tags_and_text(html)
+      html.scan(TAGS_AND_TEXT_REGEX).to_a
+    end
+    
+    def text_to_html(text, options)
+      html = text
+      if options[:escaped]
+        html = CGI.escape_html(html)
+      end
+      if options[:br]
+        html = html.gsub("\n", "<br/>")
+      end
+      if options[:nbsp]
+        tags_and_text = Helpers.split_tags_and_text(html)
+        html = tags_and_text.map do |tag_or_text| 
+          if tag_or_text[0] then tag_or_text[0] else tag_or_text[1].gsub(" ", "&nbsp;") end
+        end.join("")
+      end
+      html
+    end
+  end
+  
+  # An item is text in a structure with an associated id
+  class Item
+    include Helpers
+    
+    attr_reader :id, :text
+    
+    def initialize(id, text)
+      @id = id
+      @text = text
+    end
+    
+    def item?
+      true
+    end
+    
+    def ==(otherItem)
+      otherItem.class == Item && otherItem.id == @id && otherItem.text == @text
+    end
+    
+    def to_html(options={})
+      text_html = text_to_html(@text, options)
+      "<span data-id=\"#{@id}\">#{text_html}</span>"
+    end
+  end
+  
+  # A non-item is text in a structure that is not an item - it is just text
+  class NonItem
+    include Helpers
+    
+    attr_reader :text
+    
+    def initialize(text)
+      @text = text
+    end
+    
+    def item?
+      false
+    end
+    
+    def ==(otherNonItem)
+      otherNonItem.class == NonItem && otherNonItem.text == @text
+    end
+    
+    def to_html(options={})
+      text_to_html(@text, options)
+    end
+  end
+  
+  # A structure, containing a sequence of items and non-items
+  class Structure
+    attr_reader :content
+    
+    def initialize(content)
+      @content = content
+    end
+
+    def ==(otherStructure)
+      otherStructure.class == Structure && otherStructure.content == @content
+    end
+    
+    def to_html(options={})
+      "<div class=\"structure\">\n  " + @content.map{|x| x.to_html(options)}.join("") + "\n</div>\n"
+    end
+    
+  end
+  
+  class StructureGroup
+    attr_reader :structures
+    
+    def initialize(structures)
+      @structures = structures
+    end
+
+    def ==(otherStructureGroup)
+      otherStructureGroup.class == StructureGroup && otherStructureGroup.structures == @structures
+    end
+
+    def to_html(options={})
+      numStructures = structures.length
+      structureOptions = Array.new(numStructures)
+      for i in 0...numStructures do
+        structureOptions[i] = {}
+      end
+      for key in options.keys do
+        value = options[key]
+        if value.kind_of? Array
+          for i in 0...([value.length, numStructures].min) do
+            structureOptions[i][key] = value[i]
+          end
+        else
+          for i in 0...numStructures do
+            structureOptions[i][key] = value
+          end
+        end
+      end
+      structureHtmls = (0...(structures.length)).map{|i| @structures[i].to_html(structureOptions[i])}
+      "<div class=\"structure-group\">\n  " + 
+        structureHtmls.join("").chomp("\n").gsub("\n", "\n  ") + 
+        "\n</div>\n"
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: correspondence-markup
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Philip Dorrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies: []
+description: Use to generate HTML pages containing structure groups, structures and
+  items as used by correspondence.js.
+email:
+- http://thinkinghard.com/email.html
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/correspondence-markup.rb
+- lib/correspondence-markup/types.rb
+- lib/correspondence-markup/bracketed-grammar.treetop
+- LICENSE.txt
+- Rakefile
+homepage: https://github.com/pdorrell/correspondence-markup
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 496569331
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: correspondence-markup
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A markup language to generate 'Correspondence' HTML
+test_files: []