arti_mark 0.0.1.beta0

data/.gitignore

@@ -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/Gemfile

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

data/LICENSE

@@ -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

@@ -0,0 +1,75 @@
+# ArtiMark
+
+ArtiMark is a simple text markup language. It focuses on creating XHTML files for EPUB books. It is optimized for Japanese text for the present. 
+
+**CAUTION This is very early alpha version, so it's not stable at all. Even the markup syntax will change. **
+
+I hope it will be partly stable by the end of Feburary, 2013
+
+## Installation
+
+Note: This gem is not yet released to rubygems.org.
+
+Add this line to your application's Gemfile:
+
+    gem 'arti_mark'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arti_mark
+
+## Usage
+
+    require 'arti_mark'
+
+    document = ArtiMark::Document.new(:lang => 'ja')
+    document.read(string_or_io)
+    put document.result[0] # outputs 1st page of converted XHTML file
+
+Source text looks like this. 
+
+    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 [l(http://github.com/skoji/arti_mark/){this}] and [s.strong{this}] is available.
+        }
+    }
+    
+It is converted to XHTML like this, sorrounded with appropriate html,head and  body tags.
+
+    <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/arti_mark/'>this</a> and <span class='strong'>this</span> is available.</p>
+    </div>
+    </div>
+    </article>
+
+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

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/arti_mark.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/arti_mark/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["KOJIMA Satoshi"]
+  gem.email         = ["skoji@mac.com"]
+  gem.description   = %q{simple and customizable text markup language for EPUB}
+  gem.summary       = %q{simple and customizable text markup language for EPUB}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "arti_mark"
+  gem.require_paths = ["lib"]
+  gem.version       = ArtiMark::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.11"
+  gem.add_development_dependency "nokogiri", "~> 1.5.6"
+end

data/lib/arti_mark/article_parser.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  class ArticleParser
+    include CommonBlockParser, Singleton
+    def initialize
+      @command = /(art|article)/
+      @markup = 'article'
+    end
+  end
+end

data/lib/arti_mark/base_parser.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+module ArtiMark
+  module BaseParser
+    include CommandLexer
+
+
+    def paragraph(line, syntax, cls_array = [])
+      if line =~/^(「|『|（)/ # TODO: should be plaggable
+        cls_array << 'noindent'
+      end
+      "<p#{class_string(cls_array)}>#{line}</p>\n"
+    end
+
+    def process_line(line, syntax, context)
+      line = escape_html line
+      line = replace_inline_commands(line, syntax, context)
+      lexed = lex_line_command(line)
+      if !lexed[:cmd].nil? && syntax.linecommand_handler.respond_to?(lexed[:cmd].to_sym)
+        syntax.linecommand_handler.send(lexed[:cmd], lexed, context)
+      else
+        paragraph(line, syntax)
+      end
+    end
+  end
+end

data/lib/arti_mark/block_image_parser.rb

@@ -0,0 +1,24 @@
+#require 'singleton'
+
+module ArtiMark
+  class BlockImageParser
+    include BaseParser, Singleton
+    def accept?(lines)
+      lex_line_command(lines[0])[:cmd] =~ /image/
+    end
+
+    def parse(lines, r, syntax)
+      lexed = lex_line_command(lines[0])
+      raise 'HeadParser called for #{lines[0]}' unless lexed[:cmd] =~ /image/
+      lines.shift
+      lexed[:cls] << 'img-wrap' if lexed[:cls].size == 0
+      src = lexed[:params][0].strip
+      alt = lexed[:params][1].strip
+      caption = lexed[:text].strip
+
+      r << "<div#{class_string(lexed[:cls])}><img src='#{src}' alt='#{alt}' />"
+      r << "<p>#{caption}</p>" if !caption.nil?  && caption.size > 0
+      r << "</div>\n"
+    end
+  end
+end

data/lib/arti_mark/command_lexer.rb

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+module ArtiMark
+  module CommandLexer
+    def escape_html(string)
+      string.to_s.gsub("&", "&").
+        gsub("<", "&lt;").
+        gsub(">", "&gt;").
+        gsub('"', "&quot;")
+    end
+
+    def class_string(cls_array)
+      if cls_array.size == 0
+        ''
+      else
+        " class='#{cls_array.join(' ')}'"
+      end
+    end
+
+    def class_array(cls_part)
+      cls_array = []
+      if !cls_part.nil? && cls_part.size > 0
+        cls_array = cls_part[1..-1].split('.')
+      end
+      cls_array
+    end
+
+    def param_array(param_part)
+      r = []
+      if !param_part.nil? && param_part.size > 0
+        r = param_part.split(',')
+      end
+      r
+    end 
+
+    def lex_line_command(line)
+        line =~ /^([\w\*;]+?)((?:\.[A-Za-z0-9_\-]+?)*)(?:\((.+?)\))?\s*:(.*?)$/
+        return { :cmd => $1, :cls => class_array($2), :params => param_array($3), :text => $4 }
+    end
+
+    def lex_block_command(line)
+        line =~ /^(\w+?)((?:\.[A-Za-z0-9_\-]+?)*)(?:\((.+?)\))?\s*{\s*$/
+        return { :cmd => $1, :cls => class_array($2), :params => param_array($3)}
+    end
+
+    def replace_inline_commands(line, syntax, context)
+      line.gsub(/\[(\w+?)((?:\.[A-Za-z0-9_\-]+?)*)(?:\((.+?)\))?\s*{(.*?)}\]/) {
+        |matched|
+        lexed = {:cmd => $1, :cls => class_array($2), :params => param_array($3), :text => $4 }
+        if !lexed[:cmd].nil? 
+          syntax.inline_handler.send(lexed[:cmd], lexed, context)
+        else
+          matched
+        end
+      }
+    end
+
+  end
+end

data/lib/arti_mark/common_block_parser.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  module CommonBlockParser
+    include BaseParser
+    def accept?(lines)
+      lex_block_command(lines[0])[:cmd] =~ @command
+    end
+
+    def parse(lines, r, syntax)
+      lexed = lex_block_command(lines.shift)
+      throw 'something wrong here #{lines}' unless lexed[:cmd] =~ @command
+      @markup = lexed[:cmd] if @markup.nil?
+      process_block(lines, r, syntax, lexed[:cls], lexed[:params])
+    end
+    
+    def process_block(lines, r, syntax, cls_array, params)
+      previous_pgroup , r.enable_pgroup = r.enable_pgroup , false if params.member? 'wo-pgroup'
+      r << "<#{@markup}#{class_string(cls_array)}>\n"
+      while lines.size > 0
+        if lines[0] == '}' 
+          lines.shift
+          break
+        else
+          syntax.determine_parser(lines, :get_default => true).call(lines, r, syntax)
+        end
+      end
+      r << "</#{@markup}>\n"
+      r.enable_pgroup = previous_pgroup if !previous_pgroup.nil?
+    end
+
+  end
+end

data/lib/arti_mark/context.rb

@@ -0,0 +1,78 @@
+module ArtiMark
+  class Context
+    attr_accessor :title, :head_inserters, :toc, :stylesheets, :enable_pgroup
+    def initialize(param = {})
+      @head_inserters = []
+      @toc = []
+      @lang = param[:lang] || 'en'
+      @title = param[:title] || 'ArtiMark generated document'
+      @stylesheets = param[:stylesheets] || []
+      @stylesheets_alt = param[:stylesheets_alt] || []
+      @enable_pgroup = param[:enable_pgroup] || true
+      @pages = []
+      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 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 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

data/lib/arti_mark/definition_list_parser.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  class DefinitionListParser
+    include ListParser, Singleton
+ 
+    def initialize
+      @cmd = /;/
+      @blockname = 'dl'
+    end
+
+    def process_block(lines, r, syntax)
+      while lines.size > 0  
+        lexed = lex_line_command(lines[0])
+        return unless lexed[:cmd] =~ @cmd
+        dt, dd = lexed[:text].split(':', 2).map(&:strip)
+        r << "<dt>#{escape_html dt}</dt><dd>#{escape_html dd}</dd>\n"
+        lines.shift
+      end
+    end
+  end
+end

data/lib/arti_mark/div_parser.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  class DivParser
+    include CommonBlockParser, Singleton
+    def initialize
+      @command = /(d|div)/
+      @markup = 'div'
+    end
+  end
+end

data/lib/arti_mark/head_parser.rb

@@ -0,0 +1,18 @@
+#require 'singleton'
+
+module ArtiMark
+  class HeadParser
+    include BaseParser, Singleton
+    def accept?(lines)
+      lex_line_command(lines[0])[:cmd] =~ /h[1-6]/
+    end
+
+    def parse(lines, r, syntax)
+      lexed = lex_line_command(lines[0])
+      raise 'HeadParser called for #{lines[0]}' unless lexed[:cmd] =~ /h([1-6])/
+      lines.shift
+      r << "<#{lexed[:cmd]}#{class_string(lexed[:cls])}>#{escape_html lexed[:text].strip}</#{lexed[:cmd]}>\n"
+      r.toc = lexed[:text].strip if lexed[:params].member? 'in-toc'
+    end
+  end
+end

data/lib/arti_mark/list_parser.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+module ArtiMark
+  module ListParser
+    include BaseParser
+ 
+    def accept?(lines)
+      lex_line_command(lines[0])[:cmd] =~ @cmd
+    end
+
+    def parse(lines, r, syntax)
+      lexed = lex_line_command(lines[0])
+      r << "<#{@blockname}#{class_string(lexed[:cls])}>\n"
+      process_block(lines, r, syntax)
+      r << "</#{@blockname}>\n"
+    end
+
+    def process_block(lines, r, syntax)
+      while lines.size > 0  
+        lexed = lex_line_command(lines[0])
+        return unless lexed[:cmd] =~ @cmd
+        r << "<li>#{escape_html lexed[:text].strip}</li>\n"
+        lines.shift
+      end
+    end
+  end
+end

data/lib/arti_mark/ordered_list_parser.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  class OrderedListParser
+    include ListParser, Singleton
+ 
+    def initialize
+      @cmd = /[0-9]+/
+      @blockname = 'ol'
+    end
+
+  end
+end

data/lib/arti_mark/paragraph_parser.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  class ParagraphParser
+    include BaseParser, Singleton
+
+    def accept?(lines)
+      lines[0].size == 0
+    end
+    def parse(lines, context, syntax)
+        lines.shift while lines[0].size == 0
+        return unless syntax.determine_parser(lines).nil? 
+        context << process_paragraph_group(lines, '', syntax, context)
+    end
+
+    def process_paragraph_group(lines, paragraph, syntax, context)
+      paragraph << "<div class='pgroup'>\n" if context.enable_pgroup
+      while (lines.size > 0 && 
+            lines[0] != '}' && # TODO: is this correct...?
+            syntax.determine_parser(lines).nil?)
+          paragraph << process_line(lines.shift, syntax, context) 
+      end
+      paragraph << "</div>\n" if context.enable_pgroup
+      paragraph
+    end
+  end
+end

data/lib/arti_mark/result_holder.rb

@@ -0,0 +1,74 @@
+module ArtiMark
+  class Context
+    attr_accessor :title, :head_inserters, :toc
+    def initialize(param = {})
+      @head_inserters = []
+      @toc = []
+      @lang = param[:lang] || 'en'
+      @title = param[:title] || 'ArtiMark generated document'
+      @stylesheets = param[:stylesheets] || []
+      @stylesheets_alt = param[:stylesheets_alt] || []
+      @pages = []
+      head_inserter do
+        ret = ""
+        @stylesheets.each { |s|
+          ret << "<link rel=\"stylesheet\" type=\"text/css\" href=\"#{s}\" />\n"
+        }
+        @stylesheets_alt.each { |s,m|
+          ret << "<link rel=\"stylesheet\" type=\"text/css\" media = \"#{m}\" href=\"#{s}\" />\n"  
+        }
+        ret
+      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 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

data/lib/arti_mark/section_parser.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+require 'singleton'
+
+module ArtiMark
+  class SectionParser
+    include CommonBlockParser, Singleton
+    def initialize
+      @command = /(sec|section)/
+      @markup = 'section'
+    end
+  end
+end