qipowl 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 11832e5a92068dd4a814b706480c20aae99c3a30
+  data.tar.gz: 01dc0566c1f58d83664dff49c923dc68d5b58eeb
+!binary "U0hBNTEy":
+  metadata.gz: f4ee26556053853856c043979387e2fedd29901d0b199902bbff5bbd9ce0b37bfe5f5c3e819d77643655c811d8b2df42c2318ae4f7b4f536aea7e8452c39cefd
+  data.tar.gz: eeac33cd357ad9c0c5ebf3785c4ecb4a98289ac5498c3291b1c19029ed3ab431d7a7befdd03741e1a32a12a3b594f291943c8cc76a75d61c97939e090864904a

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/nbproject/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=Fuubar

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/.yardopts

@@ -0,0 +1,3 @@
+--private
+--markup markdown
+--hide-void-return

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typogrowl.gemspec
+gemspec
+
+gem 'htmlbeautifier', :git => 'https://github.com/threedaymonk/htmlbeautifier'
+gem 'aquarium', '~> 0.6', :git => 'git://github.com/deanwampler/Aquarium.git'
+gem "crochets", :git => 'git://github.com/mudasobwa/crochets.git'
+
+#gem "diff-lcs", :git => 'git://github.com/halostatue/diff-lcs.git'
+
+#gem "rspec-core", :git => 'git://github.com/rspec/rspec-core.git'
+#gem "rspec-expectations", :path => '../rspec-expectations'
+#gem "rspec-mocks", :git => 'git://github.com/rspec/rspec-mocks.git'
+# gem "rspec", :git => 'git://github.com/rspec/rspec.git'
+
+gem 'rake', :group => :test

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alexei Matyushkin
+
+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,345 @@
+![qipowl](/images/owl.png)
+
+## Name
+
+_qipowl_ (pronounced as **keep all**)
+
+[![Build Status](https://travis-ci.org/mudasobwa/qipowl.png)](https://travis-ci.org/mudasobwa/qipowl)
+[![Gemnasium](https://gemnasium.com/mudasobwa/qipowl.png?travis)](https://gemnasium.com/mudasobwa/qipowl)
+[![Stories in Ready](https://badge.waffle.io/mudasobwa/qipowl.png?label=ready)](http://waffle.io/mudasobwa/qipowl)
+
+**Status:** Minimum viable product
+
+---
+
+[Introduction into techniques](http://rocket-science.ru/qipowl/)
+
+## Intro
+
+_qipowl_ is the next generation parser environment. It’s not the
+library for parsing, rather it is the framework to build extensive
+parsers for virtually every markup anyone may imagine.
+
+The main idea of _qipowl_ is to yield the power of 
+[DSL in Ruby](http://jroller.com/rolsen/entry/building_a_dsl_in_ruby).
+The whole input text is treated neither more nor less than `DSL`. 
+That gives the user an ability to make virtually every term in input text
+the _operating entity_.
+
+## Examples
+
+This chapter should be the last one, but who wants to read technical details
+without any clue of how they might be applied? So, here we go.
+
+### Shipping with: Markright
+
+Right is looking right past up and down, right? _qipowl_ comes with built-in
+markright parser, which is superset of markdown.
+
+_qipowl_ markright utilizes UTF-8 heavily. The standard markup (here and further:
+_qipowl markup_, or _qp_) lays on unicode characters instead of
+legacy asterisks and underscores in markdown. It brings the better 
+readability to plain text before it’s processed with _qipowl_ and
+allows more readable `DSL` for processing. For instance, the input:
+
+    §3 Emphasized text
+
+    There are four standard modifiers for emphasizing text:
+    ▶ “≡” — bold
+    ▶ “≈” — italic
+    ▶ “↓” — small
+    ▶ “λ” — code
+
+    The formers are to surround the target text piece.
+    This text contains:
+    • ≡bold≡,
+    • ≈italics≈,
+    • ↓small↓ 
+    • and even some λcodeλ.
+
+will be processed as:
+
+```html
+<h3>Emphasized text</h3>
+<p class='dropcap'>There are four standard modifiers for emphasizing text:</p>
+<dl><dt>“≡”</dt><dd>bold</dd>
+<dt>“≈”</dt><dd>italic</dd>
+<dt>“↓”</dt><dd>small</dd>
+<dt>“λ”</dt><dd>code</dd></dl>
+<p class='dropcap'>The formers are to surround the target text piece.
+This text contains:</p>
+<ul><li><strong>bold</strong>,</li>
+<li><em>italics</em>,</li>
+<li><small>small</small></li>
+<li>and even some <code>code</code>.</li></ul>
+```
+
+The valuable subset of HTML5 is implemented directly, plus the user may
+eventually extend the list of understandable tags.
+
+The markup-specific symbols, like “▶” and “•” in the previous example
+may be mapped to keyboard (see `typo` file within `data` directory of the 
+project.
+
+## Internals
+
+_qipowl_ markup implementation consists of two parts: markup definition
+(kinda `yaml` file) and markup processor. The latter derives from base
+processor implementation `Qipowl::Bowler`.
+
+### Markup definition
+
+_qipowl_ understands six types of ‘operators’:
+
+* flush
+* block
+* magnet
+* inplace
+* linewide
+* handshake
+* kiss
+* custom
+
+#### :flush
+
+The operators in this group are executed immediately and do not break
+the control flow. Technically, they are simply being substituted with 
+their representation.
+
+    :flush
+      :⏎ : :br
+
+means that “⏎” anywhere in text will be substituted with “&lt;br&gt;”
+
+#### :block
+
+This group contains operators, which are driving the blocks. Such a block
+should start with the operator and ends with it. Operator may receive an
+additional parameter, located on the same string as the opening operator.
+
+    :block
+      :Λ : :pre
+
+means that the following block:
+
+    Λ ruby
+      @mapping[:block].each { |tag, htmltag|
+        break if tag < :inplace
+      }
+    Λ
+
+is to be left intouch (except of html is escaped inside) 
+and surrounded with `pre` tags:
+
+    <pre class='ruby'>
+      @mapping[:block].each { |tag, htmltag|
+        break if tag &lt; :inplace
+      }
+    </pre>
+
+This operator is the only one which preserves the line breaks.
+
+#### :magnet
+
+Almost the same as `:inplace` but does not require closing match.
+Operates on the following text piece until the space. E.g.
+
+    :magnet
+      :☎ : :span†phone
+
+will produce
+
+    <span class='phone'>☎ +1(987)5554321</span>
+
+for the markup:
+
+    ☎ +1(987)5554321
+
+#### :inplace
+
+Acts mostly like `:block` but inside one text block (text blocks are
+likely paragraphs, delimited with double carriage returns.) Requires
+closing element. Inplace operators are of highest priority and may
+overlap.
+
+    :inplace
+      :≡ : :strong
+
+will convert
+
+    That is ≡bold≡ text.
+
+into
+
+    That is <strong>bold</strong> text.
+
+#### :linewide
+
+Those are not require closings, since they are operated on the _rest_ of
+the text. Support nesting by prepending tags with _non-breakable space_:
+
+    :linewide
+      :• : li
+
+The following syntax 
+
+    • Line item 1
+     • Nested li 1
+     • Nested li 2
+    • Line item 2
+
+will produce:
+
+    <ul><li>Line item 1</li>
+    <ul><li>Nested li 1</li>
+    <li>Nested li 2</li></ul>
+    <li>Line item 2</li></ul>
+
+#### :handshake
+
+**TODO** rewrite examples for latex
+
+The group contains operators, acting on left and right operands between
+the delimiters given. By default it takes the whole line from `^` till `$`.
+
+    :handshake :
+      :∈ : :mathml
+      :⊂ :
+        :tag  : :mathml
+        :from : '\s'
+        :till : '.'
+        
+The following syntax 
+
+    Let we have A ⊂ ∅. Then the following formula is OK:
+    ∀ a ∈ ∅
+    which is evident, though.
+    
+will produce:
+
+    Let we have <mathml>A ⊂ ∅</mathml>. Then the following formula is OK:
+    <mathml>∀ a ∈ ∅</mathml>
+    which is evident, though.
+
+#### :kiss
+
+Almost the same as `:handshake` but operates on the preceeding/following pair of
+text piece without spaces. E.g.
+
+    :kiss
+      :÷ : :mathml
+
+The following syntax 
+
+    The formula 12 ÷ 5 is simple.
+    
+will produce:
+
+    The formula <mathml>12 ÷ 5</mathml> is simple.
+
+#### :custom
+
+Custom is not yet fully powerful mechanism to make substitutions inplace
+for generic words. Please use on your own risk.
+
+### Extending
+
+Extending _qipowl_ is as easy as writing a couple of strings in YAML format.
+Let’s take a look at additional rules file for markdown support:
+
+```yaml
+:synsugar :
+  # Code blocks, 4+ spaces indent
+  '(?x-mi:(\R)((?:(?:\R)+(?:\s{4,}|\t).*)+\R)(?=\R))' : "\\1\nΛ auto\\2Λ\n"
+  # Pictures
+  '!\[(.*?)\]\((.*?)\)' :  '⚓\2 \1⚓'
+  # Links
+  '\[(.*?)\]\((.*?)\)' :  '⚓\2 \1⚓'
+  # Blockquotes
+  '^\s*>' : '〉'
+  '^\s*>\s*>' : '〉 〉'
+  '^\s*\*\s*\*' : '〉 •'
+  '^\s+\*' : '• •'
+
+
+:inplace : 
+  :'__' : :strong
+  :'**' : :strong
+  :'_' : :em
+  :'*' : :em
+  :'`' : :code
+```
+
+Bold, italic, code, images, links, blockquotes (including nesteds) are now 
+supported by _qipowl_. Let any one of you who is not delighted with, 
+be the first to throw a stone at me.
+
+Need custom support for `github`-flavored markdown _strikethrough_? Oneliner
+inside an `:inplace` section of custom rules came on scene:
+
+```yaml
+  :'~~' :strike
+```
+
+#### Sophisticated extending
+
+Whether one needs more sophisticated rules, she is to write her own 
+descendant of `Bowler` class, implementing DSL herself. E.g. `Html`
+markup uses the following DSL for handling video links to YouTube:
+
+```ruby
+ # Handler for Youtube video
+ # @param [Array] args the words, gained since last call to {#harvest}
+ # @return [Nil] nil
+ def ✇ *args
+   id, *rest = args.flatten
+   harvest nil, orphan(rest.join(SEPARATOR)) unless rest.vacant?
+   harvest __callee__, "<iframe width='560' height='315' 
+           src='http://www.youtube.com/embed/#{id}' 
+           frameborder='0' allowfullscreen></iframe>"
+ end
+```
+
+Here we harvest the previously gained words (`rest`) and transform copy-pasted
+link to video into embedded frame with video content as by YouTube.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'typogrowl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typogrowl
+
+## Usage
+
+```ruby
+require 'typogrowl'
+…
+tg =  Qipowl::Html.new 
+puts tg.parse_and_roll(text)
+```
+
+or even simplier
+
+```ruby
+require 'typogrowl'
+…
+tg =  Qipowl.tg_md__html # typogrowl markup _and_ markdown
+
+puts tg.parse_and_roll(text)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+
+desc 'Tests'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+#  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+desc 'Cucumber'
+Cucumber::Rake::Task.new(:features)
+
+task :default => [:features, :spec]
+
+require 'yard'
+desc 'YARD'
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.files   = ['**/*.rb', 'features/**/*.feature', 'features/**/*.rb']
+end

data/bin/bowler

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'optparse'
+require_relative '../lib/qipowl'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} FILE|STRING"
+
+  # Bowl result?
+  opts.on("-a", "--action ACTION", [:bowl, :ruby, :cmd, :yaml, :html],
+          "Action to apply on input (bowl, ruby, cmd, yaml, html); default: html") do |action|
+    options[:action] = action || :bowl
+  end
+
+  # No argument, shows at tail.  This will print an options summary.
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+raise "Run `#{$0} --help` for execution examples. Exiting…" if ARGV.size.zero?
+
+file_or_string = ARGV.first
+file_or_string = File.read(file_or_string) if File.exist?(file_or_string)
+
+case options[:action]
+when :bowl
+  puts file_or_string.bowl
+when :ruby
+  puts Qipowl::Mapping.new(nil, file_or_string).to_ruby
+when :html
+  puts Qipowl::Html.parse file_or_string
+when :cmd
+  puts Qipowl::Cmd.execute file_or_string
+when :yaml
+  puts Qipowl::Yaml.parse file_or_string
+else
+  puts Qipowl::Html.parse file_or_string
+end  

data/config/bowlers/cmd.yaml

@@ -0,0 +1,3 @@
+:entities          :
+  :regular         :
+    :список_файлов : :ls

data/config/bowlers/html.yaml

@@ -0,0 +1,128 @@
+# encoding: utf-8
+
+# bowler’s entity values: - type, - synonyms, - parent
+# possible types: - block, - alone, - grip, - magnet, - regular, - custom
+
+# html specifics: - tag, - class
+
+:includes :
+  - 'html_supplemental'
+  - 'markdown2html'
+
+:entities       :
+  :block        :
+    :✍             :
+      :synonyms :
+        - :'---'
+    :Λ          :
+      :tag      : :pre
+      :class    : :code
+  :alone        :
+    :⏎             : :br
+    :——         : :hr
+  :magnet       :
+    :☎            :
+      :tag      : :span
+      :class    : :phone
+    :✉             :
+      :tag      : :span
+      :class    : :email
+      :synonyms :
+        - :mail
+    :✎             : :lj
+    :☇              : :a
+  :grip         :
+    :≡             : :strong
+    :≈          : :em
+    :↑             : :sup
+    :↓             : :small
+    :λ          : :code
+    :⚓             : :a
+    :†          : :abbr
+    :✁             : :del
+    :✿_span_nobr : :nobr
+  :regular      :
+    :•          :
+      :tag      : :li
+      :parent   :
+        :tag    : :ul
+        :class  : :fancy
+    :◦              :
+      :tag      : :li
+      :parent   : :ol
+      :class    : :active
+    :▶             :
+      :tag      : :dt
+      :parent   : :dl
+    :▷             :
+      :tag      : :dt
+      :parent   :
+        :tag    : :dl
+        :class  : :dl_horizontal
+    :℁            : :address
+    :〉          :
+      :tag      : :p
+      :parent   : :blockquote
+      :class    : :blockquote
+    :§1         : :h1
+    :§2         : :h2
+    :§3         : :h3
+    :§4         : :h4
+    :§5         : :h5
+    :§6         : :h6
+    :¶          :
+      :tag      : :p
+      :class    : :lead
+    :☆             :
+      :tag      : :p
+      :class    : :text_muted
+    :★             : :em
+    :☛             :
+      :tag      : :p
+      :class    : :text_success
+    :☞             :
+      :tag      : :p
+      :class    : :text_info
+    :☣             :
+      :tag      : :p
+      :class    : :text_warning
+    :☢             :
+      :tag      : :p
+      :class    : :text_danger
+    :✇             : :video
+    :⚘             : :figure
+    :✿_p_address :
+      :tag      : :p
+      :class    : :address
+    :✿_p_epigraph :
+      :tag      : :p
+      :class    : :epigraph
+    :✿_p_afterepigraph :
+      :tag      : :p
+      :class    : :afterepigraph
+    :✿_p_auto  :
+      :tag      : :p
+      :class    : :dropcap
+
+:custom :
+  '^\s*‒\p{Blank}+(.+),\s*(\S+)' : ' ⏎ ↓ ⚓\2 \1⚓'
+  '(\S+)¹(\S+?)(?=\s|\)|\.\s|\.\Z|\,\s|;\s|␍|\Z)' : '⚓\2 \1⚓'
+  '(\S+)†(.+?)†' : '†\1 \2†'
+# http://youtu.be/SAJ_TzLqy1U?t=6s
+  'http://youtu\.be/([A-Za-z0-9_]+)(?:\?t=(\d+)s)?' : '✇ \1'
+# http://www.youtube.com/watch?v=SAJ_TzLqy1U
+  'http://www\.youtube\.com/(?:watch\?v=|v/)([A-Za-z0-9_]+)' : '✇ \1'
+# Standalone images and quotes
+  '^(https?://\S+)(\s*.*)$' : '⚘ \1 \2'
+  
+:enclosures :
+  :•       :
+    :tag   : :ul
+    :class : :fancy
+  :◦ :     :ol
+  :▶ :     :dl
+  :▷         :
+    :tag   : :dl
+    :class : :dl_horizontal
+  :〉       : :blockquote
+

data/config/bowlers/html_supplemental.yaml

@@ -0,0 +1,3 @@
+:entities :
+  :grip :
+    :÷ : :del

data/config/bowlers/markdown2html.yaml

@@ -0,0 +1,23 @@
+:custom :
+  '(?x-mi:(\R)((?:(?:\R)+(?:\s{4,}|\t).*)+\R)(?=\R))' : "\\1\nΛ auto\\2Λ\n"
+  '^!\[(.*?)\]\((.*?)\)$' :  '⚘ \2 \1'
+  '!\[(.*?)\]\((.*?)\)' :  '⚓\2 \1⚓'
+  '\[(.*?)\]\((.*?)\)' :  '⚓\2 \1⚓'
+  '^\s*>' : '〉'
+  '^\s*>\s*>' : ' 〉'
+  '^\s+\*' : ' •'
+  ' {2,}(?=$)' : " ⏎"
+
+
+:entities :
+  :grip :
+    :'**' :
+      :tag      : :strong
+      :marker   : :≡
+      :synonyms :
+        - :'__'
+    :'*' :
+      :tag      : :em
+      :marker   : :≈
+    :'`' : :code
+    :'~~' : :del

data/extras/demo/main.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'cgi'
+require 'json'
+require 'sinatra'
+
+require_relative '../qipowl'
+
+use Rack::Session::Pool, :expire_after => 2592000
+
+before do
+  session[:typo] ||= Qipowl.tg_md__html
+end
+
+get '/html/mapping' do
+  content_type :json
+  session[:typo].mapping.hash.to_json
+end
+
+delete '/html/mapping/:key' do |key|
+  content_type :json
+  session[:typo].mapping.remove_spice(key.to_sym).to_json
+end
+
+put '/html/mapping/:section/:key/:value/?:enclosure?' do |section, key, value, enclosure|
+  content_type :json
+  session[:typo].mapping.add_spice(section.to_sym, key.to_sym, value.to_sym, enclosure ? enclosure.to_sym : nil).to_json
+end
+
+get '/html/parse' do
+  str = CGI::parse(request.query_string)['text'].first
+  content_type :html
+  session[:typo].parse_and_roll str
+end