correspondence-markup 0.2.0 → 0.3.0

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

@@ -28,11 +28,13 @@ grammar CorrespondenceMarkupLanguage
   end
 
   rule structure
-    structure_class s itemGroups:("[" item_group "]" s)*
+    structure_annotation s itemGroups:("[" item_group "]" s)*
     { 
       def value
         itemGroupObjects = itemGroups.elements.map {|e| e.item_group.value}
-        CorrespondenceMarkup::Structure.new(structure_class.text_value, itemGroupObjects)
+        class_name, description = structure_annotation.value
+        CorrespondenceMarkup::Structure.new(class_name, description, 
+                                            itemGroupObjects)
       end
     }
   end
@@ -41,6 +43,20 @@ grammar CorrespondenceMarkupLanguage
     ([a-zA-Z] [a-zA-Z0-9_-]*)?
   end
 
+  rule structure_annotation
+    structure_class description_section:(":" s description:[^\n]* "\n")?
+    {
+      def value
+        class_name = structure_class.text_value
+        description = nil
+        if description_section.elements
+          description = description_section.description.text_value
+        end
+        [class_name, description]
+      end
+    }
+  end
+
   rule item_group
     optional_id:(id:[A-Z]* ":")? components:(item / non_item)*
     { 

data/lib/correspondence-markup/types.rb

@@ -99,15 +99,18 @@ module CorrespondenceMarkup
   
   # A structure, containing a sequence of items and non-items
   class Structure
-    attr_reader :type, :item_groups
+    attr_reader :type, :description, :item_groups
     
-    def initialize(type, item_groups)
+    def initialize(type, description, item_groups)
       @type = type
+      @description = description
       @item_groups = item_groups
     end
 
     def ==(otherStructure)
-      otherStructure.class == Structure && otherStructure.type == @type && otherStructure.item_groups == @item_groups
+      otherStructure.class == Structure && otherStructure.type == @type  &&
+        otherStructure.description == description &&
+        otherStructure.item_groups == @item_groups
     end
     
     def css_class_names
@@ -121,6 +124,7 @@ module CorrespondenceMarkup
     def to_html(options={})
       itemGroupHtmls = @item_groups.map{|x| x.to_html(options)}
       "<div class=\"#{css_class_names}\">\n  " + 
+        (@description ? "<div class=\"language\">#{@description}</div>\n  " : "") +
         itemGroupHtmls.join("").chomp("\n").gsub("\n", "\n  ") +
         "\n</div>\n"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: correspondence-markup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -38,7 +38,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1007145873
+      hash: -1049094467
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: