RubyGems - nora_mark - Versions diffs - 0.2beta3 - Mend

nora_mark 0.2beta3

Files changed (28) hide show

checksums.yaml +7 -0
data/.gitignore +19 -0
data/CHANGELOG.md +13 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/README.md +188 -0
data/Rakefile +12 -0
data/lib/nora_mark/html/abstract_item_writer.rb +14 -0
data/lib/nora_mark/html/context.rb +119 -0
data/lib/nora_mark/html/generator.rb +177 -0
data/lib/nora_mark/html/header_writer.rb +35 -0
data/lib/nora_mark/html/pages.rb +56 -0
data/lib/nora_mark/html/paragraph_writer.rb +52 -0
data/lib/nora_mark/html/tag_writer.rb +110 -0
data/lib/nora_mark/html/util.rb +12 -0
data/lib/nora_mark/html/writer_selector.rb +24 -0
data/lib/nora_mark/parser.kpeg +123 -0
data/lib/nora_mark/parser.kpeg.rb +3422 -0
data/lib/nora_mark/parser.rb +31 -0
data/lib/nora_mark/version.rb +3 -0
data/lib/nora_mark.rb +46 -0
data/nora_mark.gemspec +22 -0
data/spec/created_files/.gitignore +1 -0
data/spec/fixture/test_src_ja.nora +50 -0
data/spec/nokogiri_test_helper.rb +41 -0
data/spec/nora_mark_spec.rb +840 -0
data/spec/spec_helper.rb +29 -0
metadata +116 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a2886da05fdf6ceef15ef567fe80634a580b381
+  data.tar.gz: 0a34c663272a064a68d6256f1743008309fcf0ca
+SHA512:
+  metadata.gz: a38237dbfa6e03d97caf7b80c00413b968faf1e1efb731b692212dee2c33a3dfedc769108dc4ad2c7ef70349ed32afd5d3d69ba9ee69ef3b712f91862fd52d97
+  data.tar.gz: 3cc67438a689ecfaf3ef11e635ee8d09c9d0b8f8ff50ecfbbd61ccfc7cc973081e1a313d921460fcfaf66bde4216467e2de381b2f41b525fa630427f8e60a22b

data/.gitignore ADDED Viewed

@@ -0,0 +1,19 @@
+*~
+\#*#
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,13 @@
+# version 0.2beta1 (NoraMark beta)
+ * Change name to NoraMark
+# version 0.1beta3 (pre NoraMark)
+ * Totally rewrite using kpeg.
+ * remove toc feature (for the old toc feature is so poor)
+ * removed custom BlockParser. Instead of the feature, easy and powerful customization will be introduced in NoraText 0.2
+ * markup change: alternate block notation stnorang with 'd{---' has removed
+ * markup change: inline image notation is changed form [img(alt-text){src}] to [img(src, alt)]

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in nora_mark.gemspec
+gemspec

data/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2012 KOJIMA Satoshi
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,188 @@
+# NoraMark
+NoraMark is a simple text markup language. It is designed to create XHTML files for EPUB books. Its default mode is for Japanese text.
+**CAUTION This is very early alpha version, so it's not stable at all, even the markup syntax**
+In the next release,  the library name will change from NoraMark to NoraMark.
+In NoraMark release version, the syntax will be more stable.
+## Installation
+Add this line to your application's Gemfile:
+    gem 'nora_mark'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install nora_mark
+## Usage
+    require 'nora_mark'
+    document = NoraMark::Document.parse(string_or_io)
+    put document.html[0] # outputs 1st page of converted XHTML file
+An example of markup text (text is in english, but the paragraph style is japanese)
+    # line begins with # is a comment.
+    # you don't need to indent noramark text.
+    lang: ja
+    title: test title
+    stylesheets: css/normalize.css, css/main.css
+    art {
+        h1: header 1
+        article comes here.
+        linebreak will produce paragraph.
+        blank line will procude div.pgroup.
+        d.column {
+            This block will produce div.column.
+            Inline commands like [link(http://github.com/skoji/nora_mark/){this}] and [s.strong{this}] is available.
+        }
+    }
+The converted XHTML file
+    <?xml version="1.0" encoding="UTF-8"?>
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+    <head>
+    <title> test title</title>
+    <link rel="stylesheet" type="text/css" href="css/normalize.css" />
+    <link rel="stylesheet" type="text/css" href="css/main.css" />
+    </head>
+    <body>
+    <article>
+    <h1>header 1</h1>
+    <div class='pgroup'>
+    <p>article comes here.</p>
+    <p>linebreak will produce paragraph.</p>
+    </div>
+    <div class='pgroup'>
+    <p>blank line will produce</p>
+    </div>
+    <div class='column'>
+    <div class='pgroup'>
+    <p>This block will produce div.column.</p>
+    <p>Inline commands like <a href='http://github.com/skoji/nora_mark/'>this</a> and <span class='strong'>this</span> is available.</p>
+    </div>
+    </div>
+    </article>
+    </body>
+    </html>
+Another example of markup text in non-japanese (paragraph style is default)
+    # line begins with # is a comment.
+    # you don't need to indent noramark text.
+    lang: en
+    title: test title
+    stylesheets: css/normalize.css, css/main.css
+    art {
+        h1: header 1
+        article comes here.
+        linebreak will produce br.
+        blank line will procude paragraph.
+        d.column {
+            This block will produce div.column.
+            Inline commands like [link(http://github.com/skoji/nora_mark/){this}] and [s.strong{this}] is available.
+        }
+    }
+The converted XHTML file
+    <?xml version="1.0" encoding="UTF-8"?>
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+    <head>
+    <title> test title</title>
+    <link rel="stylesheet" type="text/css" href="css/normalize.css" />
+    <link rel="stylesheet" type="text/css" href="css/main.css" />
+    </head>
+    <body>
+    <article>
+    <h1>header 1</h1>
+    <p>article comes here.<br />linebreak will produce paragraph.</p>
+    <p>blank line will produce paragraph</p>
+    <div class='column'>
+    <p>This block will produce div.column.<br />Inline commands like <a href='http://github.com/skoji/nora_mark/'>this</a> and <span class='strong'>this</span> is available.</p>
+    </div>
+    </article>
+    </body>
+    </html>
+Another example of markup text
+    # Markdown-ish heading will creates section
+    lang: ja
+    title: test title
+    stylesheets: css/normalize.css, css/main.css
+    =: this is the first heading
+    This line is in a section.
+    This line is in a section.
+    ==: this is the second heading
+    This section is nested.
+    =: this is the third heading
+    will terminate lower level section
+The converted XHTML file
+    <?xml version="1.0" encoding="UTF-8"?>
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+    <head>
+    <title>test title</title>
+    <link rel="stylesheet" type="text/css" href="css/normalize.css" />
+    <link rel="stylesheet" type="text/css" href="css/main.css" />
+    </head>
+    <body>
+    <section><h1>this is the first heading</h1>
+    <div class='pgroup'><p>This line is in a section.</p>
+    <p>This line is in a section.</p>
+    </div>
+    <section><h2>this is the second heading</h2>
+    <div class='pgroup'><p>This section is nested.</p>
+    </div>
+    </section>
+    </section>
+    <section><h1>this is the third heading</h1>
+    <div class='pgroup'><p>will terminate lower level section</p>
+    </div>
+    </section>
+    </body>
+    </html>
+In a near future version, you will be able to add custom commands.
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile ADDED Viewed

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+rule(/\.kpeg\.rb/ => proc {|task_name| task_name.sub(/kpeg\.rb$/, 'kpeg')}) do
+  |t|
+  system "kpeg -f #{t.prerequisites[0]}"
+end
+desc "run rspec"
+task :test => ["lib/nora_mark/parser.kpeg.rb"] do
+  system 'rspec'
+end

data/lib/nora_mark/html/abstract_item_writer.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module NoraMark
+  module Html
+    class AbstractItemWriter
+      def initialize(generator)
+        @generator = generator
+      end
+      def write(item)
+        item[:children].each do |child|
+          @generator.to_html child
+        end
+      end
+    end
+  end
+end

data/lib/nora_mark/html/context.rb ADDED Viewed

@@ -0,0 +1,119 @@
+module NoraMark
+  module Html
+    class Context
+      attr_accessor :title, :head_inserters, :toc, :lang, :stylesheets, :enable_pgroup
+      def initialize(param = {})
+        @head_inserters = []
+        @toc = []
+        @lang = param[:lang] || 'en'
+        @title = param[:title] || 'NoraMark generated document'
+        @stylesheets = param[:stylesheets] || []
+        @stylesheets_alt = param[:stylesheets_alt] || []
+        @enable_pgroup = param[:enable_pgroup] || true
+        self.paragraph_style= param[:paragraph_style]
+        @pages = Pages.new(param[:filename_base], param[:sequence_format])
+        @block_delimiter_stack = []
+        head_inserter do
+          ret = ""
+          @stylesheets.each { |s|
+            if s.is_a? String
+              ret << "<link rel=\"stylesheet\" type=\"text/css\" href=\"#{s}\" />\n"
+            elsif s.is_a? Array
+              ret << "<link rel=\"stylesheet\" type=\"text/css\" media=\"#{s[1]}\" href=\"#{s[0]}\" />\n"
+            else
+              raise "Can't use #{s} as a stylesheet"
+            end
+          }
+          ret
+        end
+      end
+      def created_files
+        @pages.created_files
+      end
+      def chop_last_space
+        @pages.last.sub!(/[[:space:]]+$/, '')
+      end
+      def paragraph_style=(style)
+        return if style.nil?
+        raise "paragrapy_style accepts only :default or :use_paragraph_group but is #{style}" if style != :default && style != :use_paragraph_group
+        @paragraph_style = style
+      end
+      def paragraph_style
+        if @paragraph_style
+          @paragraph_style
+        elsif @lang.split('-')[0] == 'ja'
+          :use_paragraph_group
+        else
+          :default
+        end
+      end
+      def head_inserter(&block)
+        head_inserters << block
+      end
+      def start_html(title = nil)
+        @title = title if !title.nil?
+        if @pages.size >0 && !@pages.last.frozen?
+          end_html
+        end
+        page = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+        page << "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"#{@lang}\" xml:lang=\"#{@lang}\">\n"
+        page << "<head>\n"
+        page << "<title>#{@title}</title>\n"
+        @head_inserters.each {
+          |f|
+          page << f.call
+        }
+        page << "</head>\n"
+        page << "<body>\n"
+        @pages << page
+        @toc << title
+      end
+      def end_html
+        page = @pages.last
+        if !page.frozen?
+          page << "</body>\n"
+          page << "</html>\n"
+          page.freeze
+        end
+      end
+      def enter_block(lexed)
+        @block_delimiter_stack.push(lexed[:delimiter])
+      end
+      def exit_block(lexed)
+        @block_delimiter_stack.pop
+        nil
+      end
+      def block_close?(line)
+        line == (@block_delimiter_stack.last || '') + '}'
+      end
+      def toc=(label)
+        @toc[-1] = label if @toc.size > 0
+      end
+      def <<(text)
+        if @pages.size == 0 || @pages.last.frozen?
+          start_html
+        end
+        @pages.last << text
+      end
+      def result
+        if !@pages.last.frozen?
+          end_html
+        end
+        @pages
+      end
+    end
+  end
+end

data/lib/nora_mark/html/generator.rb ADDED Viewed

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+require 'nora_mark/html/util'
+require 'nora_mark/html/pages'
+require 'nora_mark/html/context'
+require 'nora_mark/html/tag_writer'
+require 'nora_mark/html/header_writer'
+require 'nora_mark/html/paragraph_writer'
+require 'nora_mark/html/writer_selector'
+require 'nora_mark/html/abstract_item_writer'
+module NoraMark
+  module Html
+    class Generator
+      include Util
+      attr_reader :context
+      def initialize(param = {})
+        @context = Context.new(param)
+        article_writer = TagWriter.create('article', self)
+        section_writer = TagWriter.create('section', self)
+        link_writer = TagWriter.create('a', self, trailer: '',
+                                       item_preprocessor: proc do |item|
+                                         (item[:attrs] ||= {}).merge!({:href => [ item[:args][0] ]})
+                                         item
+                                       end)
+        header_writer = HeaderWriter.new self
+        paragraph_writer = ParagraphWriter.new self
+        abstract_item_writer = AbstractItemWriter.new self
+        @writers = {
+          :page => abstract_item_writer,
+          :headers => abstract_item_writer,
+          :paragraph => paragraph_writer,
+          :paragraph_group => paragraph_writer,
+          :block =>
+          WriterSelector.new(self,
+                             {
+                               'd' => TagWriter.create('div', self),
+                               'art' => article_writer,
+                               'arti' => article_writer,
+                               'article' => article_writer,
+                               'sec' => section_writer,
+                               'sect' => section_writer,
+                               'section' => section_writer,
+                             }),
+          :line_command =>
+          WriterSelector.new(self,
+                             {
+                               'image' =>
+                               TagWriter.create('div', self,
+                                                item_preprocessor: proc do |item|
+                                                  add_class_if_empty item, 'img-wrap'
+                                                  item
+                                                end,
+                                                write_body_preprocessor: proc do |item|
+                                                  src = item[:args][0].strip
+                                                  alt = (item[:args][1] || '').strip
+                                                  caption_before = item[:named_args][:caption_before]
+                                                  if caption_before && children_not_empty(item)
+                                                    output "<p>"; write_children item; output "</p>"
+                                                  end
+                                                  output "<img src='#{src}' alt='#{escape_html alt}' />"
+                                                  if !caption_before && children_not_empty(item)
+                                                    output "<p>"; write_children item; output "</p>"
+                                                  end
+                                                  :done
+                                                end
+                                                ),
+                               }),
+          :inline =>
+          WriterSelector.new(self,
+                             {
+                               'link' => link_writer,
+                               'l' => link_writer,
+                               's' => TagWriter.create('span', self),
+                               'img' =>
+                               TagWriter.create('img', self,
+                                                item_preprocessor: proc do |item|
+                                                  item[:no_body] = true #TODO : it is not just an item's attribute, 'img_inline' has no body. maybe should specify in parser.{rb|kpeg}
+                                                  (item[:attrs] ||= {}).merge!({:src => [item[:args][0] ]})
+                                                  item[:attrs].merge!({:alt => [ escape_html(item[:args][1].strip)]}) if (item[:args].size > 1 && item[:args][1].size > 0)
+                                                  item
+                                                end)  ,
+                               'tcy' =>
+                               TagWriter.create('span', self,
+                                                item_preprocessor: proc do |item|
+                                                  add_class item, 'tcy'
+                                                  item
+                                                end),
+                               'ruby' =>
+                               TagWriter.create('ruby', self,
+                                                write_body_preprocessor: proc do |item|
+                                                  write_children item
+                                                  output "<rp>(</rp><rt>#{escape_html item[:args][0].strip}</rt><rp>)</rp>"
+                                                  :done
+                                                end),
+                             },
+                             trailer_default:''
+                             ),
+          :ol => TagWriter.create('ol', self),
+          :ul => TagWriter.create('ul', self),
+          :li => TagWriter.create('li', self),
+          :dl => TagWriter.create('dl', self),
+          :dtdd =>
+          TagWriter.create('', self, chop_last_space: true, item_preprocessor: proc do |item| item[:no_tag] = true; item end,
+                           write_body_preprocessor: proc do |item|
+                             output "<dt>"; write_array item[:args][0]; output "</dt>"
+                             output "<dd>"; write_array item[:args][1]; output "</dd>"
+                             :done
+                           end),
+          :newpage =>
+          TagWriter.create('div', self,
+                           item_preprocessor: proc do |item|
+                             item[:no_tag] = true
+                             item
+                           end,
+                           write_body_preprocessor: proc do |item|
+                             title = nil
+                             if item[:args].size > 0 && item[:args][0].size > 0
+                               title = escape_html item[:args].first
+                             end
+                             @context.title = title unless title.nil?
+                             @context.end_html
+                             :done
+                           end
+                           ),
+          #headed-section
+          :h_section =>
+          TagWriter.create('section', self, write_body_preprocessor: proc do |item|
+                             output "<h#{item[:level]}>#{item[:heading].strip}</h#{item[:level]}>\n"
+                             :continue
+                           end),
+          # headers
+          :stylesheets => header_writer,
+          :title => header_writer,
+          :lang => header_writer,
+          :paragraph_style => header_writer,
+          # pre-formatted
+          :preformatted =>
+          TagWriter.create('pre', self,write_body_preprocessor: proc do |item|
+                             output "<code>" if item[:name] == 'precode'
+                             output item[:children].join "\n"
+                             output "</code>" if item[:name] == 'precode'
+                             :done
+                           end),
+          #break
+          :br =>
+            TagWriter.create('br', self, item_preprocessor: proc do |item|
+                               item[:no_body] = true
+                               item
+                             end),
+          }
+      end
+      def convert(parsed_result)
+        parsed_result.each {
+          |item|
+          to_html(item)
+        }
+        @context.result
+      end
+      def to_html(item)
+        if item.is_a? String
+          @context << escape_html(item)
+        else
+          writer = @writers[item[:type]]
+          if writer.nil?
+            warn "can't find html generator for \"#{item}\""
+            @context << escape_html(item[:raw_text])
+          else
+            writer.write(item)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nora_mark/html/header_writer.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module NoraMark
+  module Html
+    class HeaderWriter
+      include Util
+      def initialize(generator)
+        @generator = generator
+        @context = generator.context
+        @writers = {
+          :stylesheets => proc do |item|
+            @context.stylesheets.concat( item[:stylesheets].map do
+              |s|
+              if s =~ /^(.+?\.css):\((.+?)\)$/
+                [$1, $2]
+              else
+                s
+              end
+            end)
+          end,
+          :title => proc do |item|
+            @context.title = escape_html item[:title].strip
+          end,
+          :lang => proc do |item|
+            @context.lang = escape_html item[:lang].strip
+          end,
+          :paragraph_style => proc do |item|
+            @context.paragraph_style = item[:paragraph_style].strip
+          end
+        }
+      end
+      def write(item)
+        @writers[item[:type]].call item
+      end
+    end
+  end
+end

data/lib/nora_mark/html/pages.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'securerandom'
+module NoraMark
+  module Html
+    class Context
+      class Pages
+        attr_reader :created_files
+        def initialize(filename_base = nil, sequence_format='%05d')
+          @filename_base = filename_base || "noramark_#{SecureRandom.uuid}"
+          @sequence_format = sequence_format || '%05d'
+          @result = []
+        end
+        def last
+          @result.last[:content]
+        end
+        def size
+          @result.size
+        end
+        def <<(page)
+          seq = @result.size + 1
+          @result << { content: page, filename: "#{@filename_base}_#{@sequence_format%(seq)}.xhtml" }
+        end
+        def [](num)
+          page = @result[num]
+          page.nil? ? nil : page[:content]
+        end
+        def pages
+          @result
+        end
+        def write_as_files(directory: nil)
+          dir = directory || Dir.pwd
+          Dir.chdir(dir) do
+            @result.each do
+              |page|
+              File.open(page[:filename], 'w+') do
+                |file|
+                file << page[:content]
+              end
+            end
+          end
+        end
+        def write_as_single_file(filename)
+          File.open(filename, 'w+') {
+            |file|
+            file << @result[0][:content]
+          }
+        end
+      end
+    end
+  end
+end