pirka 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b62ef7b04eada438c72e2b96ed9121a370422c01
-  data.tar.gz: f10abfecad074936a7f469ca1beee3b9e0532644
+  metadata.gz: 88fcda5b7f58df80108a0eba4386756ccd9ddbaf
+  data.tar.gz: 428c8af5035de8b0da4a0fc63507f3b5f8d2f6fe
 SHA512:
-  metadata.gz: 026aec15e3d275e63b57ee70db453cd2e0e89b46951b501eb64b635e6d586210677b6d95615cc705d118372dfb673aaf8026d209fb3792c31469947f343cd607
-  data.tar.gz: bdc08a466ab58d14f3b42e9910d8e58f9e06eb719e836ed3c219c38b387b13ba5197068a49ba75b39c27a0f84e5e2f7b55aad0bba0ec40a3efe6c88dea2539fe
+  metadata.gz: 55814a01738772bead120d50677462cc911d72df46621fb43b97747a603d8175d909652cc1e7a00d6b93f4c1398af654017b6b6282b658c17b7975939672515e
+  data.tar.gz: 9037389b5d65fa6867a41901102f5e8b91f5cb270e74c57357276159a3aae17dca21107a17e13a5ff8eaa8d03cc1910479fdec54942227a18536878a8bd9f6f4

data/README.md

@@ -28,6 +28,8 @@ It's a short cut to:
 
     $ pirka highlight path/to/book.epub
 
+To highlight books, run `pirka update`(see below for details) just after installation because `pirka highlight` requires library files.
+
 ### Detecting source code from EPUB books ###
 
     $ pirka detect path/to/book.epub
@@ -71,7 +73,7 @@ You also determine languages interactively. Set `-i`(`--interactive`) option:
 
     $ pirka update
 
-Pirka provides official library files for some EPUB books as Git repository((https://gitlab.com/KitaitiMakoto/pirka-library)[https://gitlab.com/KitaitiMakoto/pirka-library]). `pirka update` command fethes the files from the repository and you benefit from it.
+Pirka provides official library files for some EPUB books as Git repository([https://gitlab.com/KitaitiMakoto/pirka-library](https://gitlab.com/KitaitiMakoto/pirka-library)). `pirka update` command fethes the files from the repository and you benefit from it.
 
 Additionally, you can host library files by your own and make Pirka recognizes it by configuration file. See later section for that.
 
@@ -92,24 +94,24 @@ Pirka can be configured by environment variables, config file and command-line o
 
 #### Environment variables ####
 
-XDG_DATA_HOME
+`XDG_DATA_HOME`
 : Affects directory to save library files.
 : Library files are saved to `$XDG_DATA_HOME/pirka/local`
 : The directory is used to search library, too.
 : Default: `$HOME/.local/share`
 
-XDG_DATA_DIRS
+`XDG_DATA_DIRS`
 : Affects directory to save library files.
 : You can specify multiple directory by seperating with a colon like `XDG_DATA_DIRS=/dir1:/dir2`.
 : `/dir1/pirka/local` and `/dir2/pirka/local` are used to search library, for example.
 : Default: `/usr/local/share:/usr/share`
 
-XDG_CONFIG_HOME
+`XDG_CONFIG_HOME`
 : Affects directory to search and save config file.
 : `$XDG_CONFIG_DIRS/pirka.yaml` is recognized as config file.
 : Default: `$HOME/.config`
 
-XDG_CONFIG_DIRS
+`XDG_CONFIG_DIRS`
 : Affects directory to search config file.
 : You can specify multiple directory by seperating with a colon like `XDG_CONFIG_DIRS=/dir1:/dir2`.
 : `/dir1/pirka.yaml` and `/dir2/pirka.yaml` are searched as config file.
@@ -119,16 +121,16 @@ XDG_CONFIG_DIRS
 
 Config file is a YAML file. Properties below are recognized:
 
-data_home
+`data_home`
 : Directory to save and search library files.
 : Default: `$XDG_CONFIG_HOME/pirka/local`
 
-additional_directories
+`additional_directories`
 : Directories to search library files.
 : Expressed by sequence(array).
 : Default: `[]`
 
-library_repositories
+`library_repositories`
 : Git repository URIs used by `pirka lib` command.
 : Expressed by sequence(array).
 : Default: `[]`

data/app/highlight.rb

@@ -6,6 +6,7 @@ require "epub/maker"
 require "rouge"
 require "rouge/lexers/fluentd"
 require "pirka/library"
+require "pirka/highlighter"
 require_relative "subcommand"
 
 module Pirka
@@ -20,7 +21,7 @@ module Pirka
       DUMMY_ORIGIN = Addressable::URI.parse("file:///")
       CSS_PATH = "pirka/style.css" # @todo Avoid conflict with existing item by other than Pirka
       CSS_CLASS_NAME = "pirka"
-      SCOPE = "code.#{CSS_CLASS_NAME}"
+      SCOPE = ".#{CSS_CLASS_NAME}"
       THEME = "github"
 
       def initialize(config)
@@ -79,7 +80,17 @@ module Pirka
       def highlight_contents(epub, css_item, library)
         need_save = []
 
-        formatter = Rouge::Formatters::HTML.new
+        highlighter = Highlighter::Middleware::ClassName.new(
+          Highlighter::Middleware::Rouge.new(
+            Highlighter.new),
+          class_name: CSS_CLASS_NAME)
+        middleware = library.metadata["middleware"]
+        if middleware && !library.metadata["middleware"].empty?
+          highlighter = library.metadata["middleware"].reduce(highlighter) {|highlighter, desc|
+            params = desc["params"] || {}
+            Highlighter::Middleware.const_get(desc["name"]).new(highlighter, params)
+          }
+        end
 
         library.each.reverse_each do |(cfi, data)|
           lang = data["language"]
@@ -90,18 +101,8 @@ module Pirka
           itemref, elem, _ = EPUB::Searcher.search_by_cfi(epub, cfi)
           item = itemref.item
           doc = elem.document
-          lexer = Rouge::Lexer.find(lang) || Rouge::Lexer.guess(source: elem.content)
-          unless lexer
-            warn "Cannot find lexer for #{lang}"
-            next
-          end
-          elem.inner_html = formatter.format(lexer.lex(elem.content)) # @todo Consider the case `elem` has descendants
 
-          classes = (elem["class"] || "").split(/\s+/)
-          unless classes.include? CSS_CLASS_NAME
-            classes << CSS_CLASS_NAME
-            elem["class"] = classes.join(" ")
-          end
+          highlighter.markup elem, lang
 
           link = doc.at('#pirka') # @todo Avoid conflict with existing link
           unless link

data/lib/pirka/highlighter.rb

@@ -0,0 +1,73 @@
+require "rouge"
+require "rouge/lexers/fluentd"
+
+module Pirka
+  class Highlighter
+    def markup(element, lang)
+      # noop
+    end
+
+    class Middleware
+      class Rouge
+        FORMATTER = ::Rouge::Formatters::HTML.new
+
+        def initialize(highlighter, formatter: FORMATTER)
+          @highlighter = highlighter
+          @formatter = formatter
+        end
+
+        def markup(element, lang)
+          @highlighter.markup(element, lang)
+          lexer = ::Rouge::Lexer.find(lang) || ::Rouge::Lexer.guess(source: element.content)
+          unless lexer
+            warn "Cannot find lexer for #{lang}"
+            return
+          end
+          element.inner_html = @formatter.format(lexer.lex(element.content)) # @todo Consider the case `element` has descendants
+        end
+      end
+
+      class ClassName
+        ATTR_NAME = "class"
+        ATTR_SEPARATOR = /\s+/
+        CLASS_NAME = "pirka"
+
+        def initialize(highlighter, class_name: CLASS_NAME)
+          @highlighter = highlighter
+          @class_name = class_name
+        end
+
+        def markup(element, lang)
+          @highlighter.markup element, lang
+          class_names = (element[ATTR_NAME] || "").split(ATTR_SEPARATOR)
+          return if class_names.include? @class_name
+          class_names << @class_name
+          element[ATTR_NAME] = class_names.join(" ")
+        end
+      end
+
+      class LineNum
+        def initialize(highlighter, params = {})
+          @highlighter = highlighter
+          @selector = params["selector"]
+          raise "selector param not specified" unless @selector
+        end
+
+        def markup(element, lang)
+          nums = element.search(@selector)
+          nums.each(&:unlink)
+          @highlighter.markup element, lang
+          return if nums.empty?
+          element.inner_html = element.inner_html.lines.collect.with_index {|line, index|
+            num = nums[index].to_xml
+            if line.length > 1
+              line[0..0] << num << line[1..-1]
+            else
+              num << line
+            end
+          }.join
+        end
+      end
+    end
+  end
+end

data/lib/pirka/version.rb

@@ -17,6 +17,6 @@
 
 module Pirka
   # pirka version
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
   EPUB_PARSER_VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pirka
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - KITAITI Makoto
@@ -258,6 +258,7 @@ files:
 - bin/pirka
 - lib/pirka.rb
 - lib/pirka/config.rb
+- lib/pirka/highlighter.rb
 - lib/pirka/library.rb
 - lib/pirka/version.rb
 - pirka.gemspec