jekyll-books 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05d7de00a1cc4d87c6bb5556da5932e93ef225c0
+  data.tar.gz: cf0c0764cb29c908a9bb3db3f6f69276cdb99e19
+SHA512:
+  metadata.gz: eb4c197bf9f1535383a6348ad7d1bd12f88024c7dd83d69bd97f9f0b556a1ea8a87383acb85749b515b488a31b869cd83745793537f3c5a9180668eb6329270e
+  data.tar.gz: 3f2caa14d4f23cd9b10f055706ab1ea5fc193e54e9ddc2c87692d84a049f16dbe37de46d18f83b2109a7d62e94878c4a2781c5387e7189b7521b9b50c4d78b2e

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 zhangshiyu
+
+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,32 @@
+# Jekyll Books Generator
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-books"
+```
+
+Add `jekyll-books` to your Jekyll site's `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-books
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-books
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/erlzhang/jekyll-books. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/jekyll-books.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-books"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Sharon Zhang"]
+  spec.email         = ["zhangshiyu1992@hotmail.com"]
+
+  spec.summary       = "Jekyll books generatoer."
+  spec.homepage      = "https://github.com/erlzhang/jekyll-books"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+
+  spec.required_ruby_version = '>= 2.3'
+
+  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"
+end

data/lib/jekyll-books.rb

@@ -0,0 +1,186 @@
+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

data/lib/util.rb

@@ -0,0 +1,17 @@
+module Util
+  def Util.init_date_of_book(book)
+    if not book["end"]
+      book["end"] = Time.now.year
+    end
+
+    if not book["start"]
+      book["start"] = book["end"]
+    end
+
+    if book["start"] == book["end"]
+      book["date"] = book["start"].to_s
+    else
+      book["date"] = "#{book["start"]}-#{book["end"]}"
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-books
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sharon Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-28 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
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- jekyll-books.gemspec
+- lib/jekyll-books.rb
+- lib/util.rb
+homepage: https://github.com/erlzhang/jekyll-books
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Jekyll books generatoer.
+test_files: []