jekyll-books 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05d7de00a1cc4d87c6bb5556da5932e93ef225c0
-  data.tar.gz: cf0c0764cb29c908a9bb3db3f6f69276cdb99e19
+SHA256:
+  metadata.gz: a7edf01d18099c1f513ac1f774c5a7d93b6dd3a4971f21c9629c3dd3e9ddc3ba
+  data.tar.gz: 8e16eafab4ecead378df3e11aa555df329bd0c2c04affba8f4ec7ab9a7814c1a
 SHA512:
-  metadata.gz: eb4c197bf9f1535383a6348ad7d1bd12f88024c7dd83d69bd97f9f0b556a1ea8a87383acb85749b515b488a31b869cd83745793537f3c5a9180668eb6329270e
-  data.tar.gz: 3f2caa14d4f23cd9b10f055706ab1ea5fc193e54e9ddc2c87692d84a049f16dbe37de46d18f83b2109a7d62e94878c4a2781c5387e7189b7521b9b50c4d78b2e
+  metadata.gz: 910665e60755b12cc6889a2bd9d98e974999e6c8bf266459ec7164430e9b111a8704ff973b75ba215e1a24621887024b82ea4d4fab55a52ce977eedd1d153482
+  data.tar.gz: 8477939381f9971f07f47e01fbbf84bb517123271b7a6deef0c5d738be2a5f1478d4edaed7805db50f1a924a2d65c896c981359346bdd36075a9f1dfba1cb118

data/README.md

@@ -22,6 +22,10 @@ And then execute:
 Or install it yourself as:
 
     $ gem install jekyll-books
+    
+## Usage
+
+[Usage](https://github.com/erlzhang/jekyll-theme-persephone/blob/master/docs/books.md)
 
 ## Contributing
 

data/jekyll-books.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-books"
-  spec.version       = "0.1.0"
+  spec.version       = "0.3.1"
   spec.authors       = ["Sharon Zhang"]
   spec.email         = ["zhangshiyu1992@hotmail.com"]
 
@@ -14,9 +14,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_runtime_dependency "jekyll", "~> 3.5"
+  spec.add_runtime_dependency "jekyll", ">= 3.5"
   spec.add_runtime_dependency 'nokogiri', '~> 1.9'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.0"
+  # spec.add_development_dependency "bundler", "~> 1.16"
+  # spec.add_development_dependency "rake", "~> 12.0"
 end

data/lib/_config.yml

@@ -0,0 +1,17 @@
+books_settings:
+  # 自动读取书籍的目录
+  source: "_books"
+  # 生成书籍的根目录
+  destination: "/"
+  # 书籍首页的默认布局
+  book:
+    layout: "book"
+  chapter:
+    layout: "chapter"
+  # 是否自动打包成电子书
+  ebooks:
+    enabled: true
+    formats:
+      - "mobi"
+      - "pdf"
+      - ""

data/lib/jekyll-books.rb

@@ -1,186 +1,3 @@
-module Jekyll
-  require_relative "util"
-
-  class BookPage < Page
-    def initialize(site, base, dir)
-      @site = site
-      @base = base
-      @dir = dir.gsub(/^_/, "").downcase
-      @name = "index.md"
-
-      self.process(@name)
-
-      read_yaml(File.join(@base, "_books", @dir), @name)
-
-      self.data["layout"] = 'book'
-      
-      Util.init_date_of_book(self.data)
-    end
-  end
-
-  class ChapterPage < Page
-    def initialize(site, base, dir, name, book, config)
-      @site = site
-      @base = base
-
-      if name.include?("/")
-        names = File.split(name)
-        @dir = File.join(dir, names[0])
-        @name = names[1]
-      else
-        @dir = dir
-        @name = name
-      end
-
-      self.process(@name)
-
-      read_yaml(File.join(base, "_books", @dir), @name)
-
-      self.data["layout"] = 'chapter'
-      self.data["book"] = book
-      self.data["title"] = config["title"]
-      self.data["level"] = config["level"]
-    end
-
-    def is_top_level?
-      self.data["level"] == 1
-    end
-  end
-
-  class BooksGenerator < Generator
-    def generate(site)
-
-      books = []
-
-      dir = "_books"
-      begin
-        Dir.foreach(dir) do |book_dir|
-          book_path = File.join(dir, book_dir)
-          if File.directory?(book_path) and book_dir.chars.first != "."
-            book = BookPage.new(site, site.source, book_dir)
-
-            summary = File.read(File.join(book_path, "SUMMARY.md"))
-
-            parts = get_parts_from_summary(summary)
-
-            chapters = create_chapters(site, parts, book_dir, book)
-
-            add_prev_and_next_to_every_chapter(chapters)
-
-            push_chapters_to_site_pages(site, chapters)
-
-            add_next_to_book_and_prev_to_chapter(book, chapters.first)
-
-            books << book
-            site.pages << book
-          end
-        end
-
-        books += get_books_from_data(site)
-
-        sort_books_by_date(books)
-
-        site.config["books"] = books
-      rescue Exception => e
-        puts e
-      end
-    end
-
-    private
-      def get_parts_from_summary(summary)
-        require "nokogiri"
-
-        html = Kramdown::Document.new(summary).to_html
-        parsed_html = Nokogiri::HTML(html)
-
-        chapters = []
-
-        list = parsed_html.xpath("//body/ul/li")
-        list.each do |li|
-          chapters.push( get_chapter_from_li(li, 1) )
-
-          li.xpath("ul/li").each do |sub_li|
-            chapters.push( get_chapter_from_li(sub_li, 2) )
-          end
-        end
-        return chapters
-      end
-
-      def get_chapter_from_li(li, level)
-        chapter = Hash.new
-        chapter["link"] = li.xpath("a/@href").to_s
-        chapter["title"] = li.xpath("a/text()").to_s
-        chapter["level"] = level
-        return chapter
-      end
-
-      def add_prev_and_next_to_every_chapter(chapters)
-        chapters.each_with_index do |chapter, index|
-          if index > 0
-            chapter.data["prev"] = chapters[index - 1]
-          end
-          if index < chapters.size - 1
-            chapter.data["next"] = chapters[index + 1]
-          end
-        end
-      end
-
-      def push_chapters_to_site_pages(site, chapters)
-        chapters.each do |chapter|
-          site.pages << chapter
-        end
-      end
-
-      def add_next_to_book_and_prev_to_chapter(book, chapter)
-        book.data["next"] = chapter
-        chapter.data["prev"] = book
-      end
-
-      def create_index_page(site, books)
-        book_index = IndexPage.new(site, site.source, "", books[0..3])
-        book_index.render(site.layouts, site.site_payload)
-        book_index.write(site.dest)
-        return book_index
-      end
-
-      def create_chapters(site, parts, book_dir, book)
-        chapters = []
-        book.data["parts"] = []
-
-        current = nil
-
-        parts.each do |part|
-          chapter = ChapterPage.new(site, site.source, book_dir, part["link"], book, part)
-
-          if chapter.is_top_level?
-            book.data["parts"].push(chapter)
-            current = chapter
-            chapter.data["parts"] = []
-          else
-            current.data["parts"].push(chapter)
-          end
-
-          chapters.push(chapter)
-        end
-        return chapters
-      end
-
-      def sort_books_by_date(books)
-        books.sort_by! do |book|
-          if book.respond_to? "data"
-            [book.data["end"], book.data["start"]]
-          else
-            [book["end"], book["end"]]
-          end
-        end
-        books.reverse!
-      end
-
-      def get_books_from_data(site)
-        books = site.data["books"]
-        books.each do |book|
-          Util.init_date_of_book(book)
-        end
-      end
-  end
-end
+require "jekyll/generators/book"
+require "jekyll/commands/book"
+require "jekyll/hooks/ebook"

data/lib/jekyll-books/book_reader.rb

@@ -0,0 +1,111 @@
+require "jekyll/pages/chapter"
+require "jekyll/pages/book"
+require "jekyll/pages/ebook"
+require_relative "summary"
+
+class BookReader
+  attr_reader :root, :site, :name, :destination, :params
+  attr_accessor :index, :pages
+
+  def initialize(params, site, name)
+    @root        = params["source"]
+    @destination = params["destination"]
+    @params      = params
+    @site        = site
+    @name        = name
+    @index       = 0
+    @pages       = []
+  end
+
+  def read
+    @pages = [book_page]
+    index = 0
+
+    recursive_read_chapters(summary.read, 1, book_page)
+    add_prev_and_next
+
+    if params["ebook"] && params["ebook"]["enabled"]
+      pages << ebook_page
+
+      ebook_page.data["book"] = book_page
+    end
+
+    pages
+  end
+
+  def recursive_read_chapters(chapters, level, parent)
+    page = parent
+    chapter = chapters[index]
+
+    while chapter do
+      break if chapter["level"] < level
+
+      if chapter["level"] > level
+        recursive_read_chapters(chapters, chapter["level"], page)
+        @index -= 1
+      else
+        page = read_chapter(chapter)
+        pages << page
+        parent.data["parts"] << page
+      end
+
+      @index += 1
+      chapter = chapters[index]
+    end
+  end
+
+  def add_prev_and_next
+    pages.each_with_index do |page, i|
+      if i > 0
+        page.data["prev"] = pages[i - 1]
+      end
+      if i < pages.size - 1
+        page.data["next"] = pages[i + 1]
+      end
+    end
+  end
+
+  def read_chapter(chapter)
+    page = Jekyll::ChapterPage.new(
+      site,
+      params.merge({
+        "chapter" => chapter.merge(params["chapter"]),
+        "name" => name
+      }).merge(chapter)
+    )
+    page.data["book"] = book_page
+    page
+  end
+
+  def summary
+    Summary.new(book_folder)
+  end
+
+  def book_folder
+    File.join(site.source, root, name)
+  end
+
+  def book_page
+    @book_page ||= Jekyll::BookPage.new(
+      site,
+      params.merge({
+        "name" => name
+      })
+    )
+  end
+
+  def ebook_page
+    default_setting = {
+      "layout" => "ebook",
+      "destination" => "ebooks"
+    }
+    @ebook_page ||= Jekyll::EbookPage.new(
+      site,
+      default_setting
+        .merge(params["ebook"])
+        .merge({
+        "name" => name
+      })
+    )
+  end
+end

data/lib/jekyll-books/book_writer.rb

@@ -0,0 +1,70 @@
+require_relative "summary"
+require "util"
+
+class BookWriter
+  attr_reader :name, :root, :params, :summary
+  def initialize(name, root, params)
+    @name   = name
+    @root   = root
+    @params = params
+    @summary = Summary.new(book_folder)
+  end
+
+  def run
+    mkdir
+    create_index
+    create_summary
+  end
+
+  def book_folder
+    File.join(root, name)
+  end
+
+  def summary_file
+    summary.file_path
+  end
+
+  def index_file
+    summary.index_path
+  end
+
+  def mkdir
+    unless File.directory?(book_folder)
+      FileUtils.mkdir_p(book_folder)
+    end
+  end
+
+  def create_index
+    return if File.file?(index_file)
+
+    f = File.new(index_file, "w+")
+    f.write(content)
+  end
+
+  def create_summary
+    return if File.file?(summary_file) && !params["forced"]
+
+    summary.write(true)
+  end
+
+  def content
+    front_matter = YAML.dump(
+      Util.cover_default({
+        "title"  => name.capitalize,
+        "start"  => default_year,
+        "end"    => default_year,
+        "img"    => img_url
+      }, params)
+    )
+
+    front_matter + "---\n"
+  end
+
+  def default_year
+    Date.today.year
+  end
+
+  def img_url
+    "/img/home/#{name}.jpg"
+  end
+end

data/lib/jekyll-books/books_parser.rb

@@ -0,0 +1,27 @@
+require_relative "book_reader"
+
+class BooksParser
+  attr_reader :root, :site, :books, :pages
+
+  def initialize(root, site)
+    @root = root
+    @site = site
+    @books = []
+    @pages = []
+  end
+
+  def root_path
+    File.join(site.source, root)
+  end
+
+  def parse(params)
+    Dir.foreach(root_path) do |book_dir|
+      book_path = File.join(root_path, book_dir)
+      if File.directory?(book_path) and book_dir.chars.first != "."
+        pages = BookReader.new(params, site, book_dir).read
+        books << pages[0]
+        @pages += pages
+      end
+    end
+  end
+end

data/lib/jekyll-books/summary.rb

@@ -0,0 +1,95 @@
+require "find"
+require "nokogiri"
+require "kramdown"
+
+class Summary
+  attr_reader :folder
+
+  def initialize(folder)
+    @folder = folder
+  end
+
+  def file_path
+    File.join(folder, "SUMMARY.md")
+  end
+
+  def index_path
+    File.join(folder, "index.md")
+  end
+
+  def chapter_files
+    files = []
+    Find.find(folder) do |f|
+      if File.file?(f) and
+         ![file_path, index_path].include?(f)
+        files << f if File.file?(f)
+      end
+    end
+    files.sort! do |f1, f2|
+      File.ctime(f1) <=> File.ctime(f2) 
+    end
+  end
+
+  def chapters
+    chapter_files.map do |f|
+      {
+        :title => get_title(f),
+        :path => get_relative_path(f)
+      }
+    end
+  end
+
+  def get_title(file)
+    content = File.read(file)
+    html = Kramdown::Document.new(content).to_html
+    parsed_html = Nokogiri::HTML(html)
+    parsed_html.xpath("//h1/text()").to_s
+  end
+
+  def get_relative_path(file)
+    file.sub(folder + "/", "")
+  end
+
+  def write(autoload = false)
+    File.open(file_path, "w+") do |f|
+      f.write summary_title
+      if autoload
+        chapters.each do |chapter|
+          f.write "* [#{chapter[:title]}](#{chapter[:path]})\n"
+        end
+      end
+    end
+  end
+
+  def read
+    content = File.read(file_path)
+    html = Kramdown::Document.new(content).to_html
+    parsed_html = Nokogiri::HTML(html)
+
+    chapters = []
+    parsed_html.xpath("//body/ul/li").each do |li|
+      recursive_parse_chapter(li, 1, chapters)
+    end
+    chapters
+  end
+
+  def recursive_parse_chapter(content, level, result)
+    result << parse_chapter(content, level)
+
+    content.xpath("ul/li").each do |li|
+      recursive_parse_chapter(li, level + 1, result)
+    end
+  end
+
+  def parse_chapter(chapter, level)
+    {
+      "link" => chapter.xpath("a/@href").to_s,
+      "title" => chapter.xpath("a/text()").to_s,
+      "level" => level
+    }
+  end
+
+  def summary_title
+    "# Summary\n\n"
+  end
+end

data/lib/jekyll/commands/book.rb

@@ -0,0 +1,31 @@
+require "jekyll-books/book_writer"
+
+module Jekyll
+  module Commands
+    class Book < Command
+      def self.init_with_program(prog)
+        prog.command(:book) do |c|
+          c.syntax "book [options]"
+          c.description 'Create a new book.'
+  
+          add_options(c)
+  
+          c.action do |args, options|
+            configs = Jekyll.configuration()
+            BookWriter.new(
+              options["name"],
+              File.join(configs["source"], "_books"),
+              options
+            ).run
+          end
+        end
+      end
+  
+      def self.add_options(cmd)
+        cmd.option "name", "-n", "--name NAME"
+        cmd.option "title", "-t", "--title TITLE"
+        cmd.option "forced", "-f", "--forced"
+      end
+    end
+  end
+end

data/lib/jekyll/generators/book.rb

@@ -0,0 +1,55 @@
+require "jekyll-books/books_parser"
+require "util"
+
+module Jekyll
+  class BooksGenerator < Generator
+    def generate(site)
+      params = get_params(site)
+
+      parser = BooksParser.new(params["source"], site)
+      parser.parse(params)
+      site.pages += parser.pages
+
+      books = parser.books
+      books += get_books_from_data(site)
+      sort_books_by_date(books)
+      site.config["books"] = books
+    end
+
+    def get_params(site)
+      default_setting = {
+        "source" => "_books",
+        "destination" => "/",
+        "book" => {
+          "layout" => "book"
+        },
+        "chapter" => {
+          "layout" => "chapter"
+        }
+      }
+
+      default_setting.merge(site.config["books_settings"] || {})
+    end
+
+    private
+      def get_books_from_data(site)
+        books = site.data["books"]
+        return [] unless books
+
+        books.each do |book|
+          Util.init_date_of_book(book)
+        end
+      end
+
+      def sort_books_by_date(books)
+        books.sort_by! do |book|
+          if book.respond_to? "data"
+            [book.data["end"], book.data["start"]]
+          else
+            [book["end"], book["start"]]
+          end
+        end
+        books.reverse!
+      end
+  end
+end

data/lib/jekyll/hooks/ebook.rb

@@ -0,0 +1,24 @@
+require "jekyll/pages/ebook"
+
+module Jekyll
+  Jekyll::Hooks.register :pages, :post_write do |page|
+    if page.is_a? Jekyll::EbookPage
+      default_setting = {
+        "formats" => ["pdf"]
+      }
+
+      configs = Jekyll.configuration()
+      books_config = configs["books_settings"] || {}
+      ebook_config = default_setting.merge(books_config["ebook"] || {})
+      if ebook_config["enabled"]
+        input = page.destination("")
+        site = page.site
+        dir = site.in_dest_dir(page.dir)
+        ebook_config["formats"].each do |format|
+          output = File.join(dir, "#{page.data["name"]}.#{format}")
+          system "ebook-convert #{input} #{output} --title=#{page.data['book']['title']} --authors=#{configs['title']} --level1-toc=//h:h1"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pages/book.rb

@@ -0,0 +1,24 @@
+require "util"
+
+module Jekyll
+  class BookPage < Page
+    def initialize(site, params)
+      @site = site
+      @base = site.source
+      @dir  = File.join(params["destination"], params["name"])
+      @name = "index.md"
+
+      self.process(@name)
+
+      read_yaml(
+        File.join(@base, params["source"], params["name"]),
+        @name
+      )
+
+      self.data = params["book"].merge(self.data)
+      self.data["parts"] = []
+
+      Util.init_date_of_book(self.data)
+    end
+  end
+end

data/lib/jekyll/pages/chapter.rb

@@ -0,0 +1,25 @@
+module Jekyll
+  class ChapterPage < Page
+    def initialize(site, params)
+      @site = site
+      @base = site.source
+
+      path = File.join(params["name"], File.dirname(params["link"]))
+      @dir = File.join(params["destination"], path)
+
+      @name = File.basename(params["link"])
+
+      self.process(name)
+
+      read_yaml(
+        File.dirname(
+          File.join(@base, params["source"], path)
+        ),
+        name
+      )
+      
+      self.data = params["chapter"].merge(self.data)
+      self.data["parts"] = []
+    end
+  end
+end

data/lib/jekyll/pages/ebook.rb

@@ -0,0 +1,16 @@
+module Jekyll
+  class EbookPage < Page
+    def initialize(site, params)
+      @site = site
+      @base = site.source
+      @dir  = params["destination"]
+      @name = "#{params["name"]}.md"
+
+      self.process(@name)
+
+      self.data = {}
+      self.data["name"] = params["name"]
+      self.data["layout"] = params["layout"] #temp
+    end
+  end
+end

data/lib/util.rb

@@ -14,4 +14,11 @@ module Util
       book["date"] = "#{book["start"]}-#{book["end"]}"
     end
   end
+
+  def Util.cover_default(default, params)
+    for key in default
+      default[key] = params[key] unless params[key].nil?
+    end
+    default
+  end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-books
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sharon Zhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2021-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
@@ -38,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
 description: 
 email:
 - zhangshiyu1992@hotmail.com
@@ -78,7 +50,18 @@ files:
 - LICENSE.txt
 - README.md
 - jekyll-books.gemspec
+- lib/_config.yml
 - lib/jekyll-books.rb
+- lib/jekyll-books/book_reader.rb
+- lib/jekyll-books/book_writer.rb
+- lib/jekyll-books/books_parser.rb
+- lib/jekyll-books/summary.rb
+- lib/jekyll/commands/book.rb
+- lib/jekyll/generators/book.rb
+- lib/jekyll/hooks/ebook.rb
+- lib/jekyll/pages/book.rb
+- lib/jekyll/pages/chapter.rb
+- lib/jekyll/pages/ebook.rb
 - lib/util.rb
 homepage: https://github.com/erlzhang/jekyll-books
 licenses:
@@ -99,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll books generatoer.