jekyll-build-ebook 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f62eabbb712aa04efcc2d52d8d5b3e8e0aedfe04fb10549277c95951a8cc4fd
-  data.tar.gz: 4d9079146bd7711f26c62b54e094f0ee606ec79c029f651ceae79cb510944503
+  metadata.gz: 24ba968d95403fed60c26ea91cbaca4f6dc8165e6813d635a7cf4b9787b3496e
+  data.tar.gz: 55e128d636b39639579e9e9557df04dd9303193a0d52420725e90f5e5d6e7adc
 SHA512:
-  metadata.gz: 5d7f91f9dab141615ac2e4d44eeec31d7a7b00a32e16b98a74548beb3c96e0b9c11028573859a76c83bf6cfa7b5fa7bd97660f6133f7fb3cfd3031fc0a5b04de
-  data.tar.gz: 1663cdabf0ea77463560b82b20536f0f1c98efbf7d23786c89916c58361b42108a0497611c6b0ae995b258c9fd9a314cb783f8144802645e269b09416fa28bd2
+  metadata.gz: 761ac329ef84fe8c5a74ab7bb292480942c1269ddb8c9276704b1f95d008e1cacdecb0420dc2014c34fac0b5400827ca77f01ca65a375e1477e620da5132de0a
+  data.tar.gz: 3094624f1c9f5b1c49eecd6864136d1db8e3f0ef9af9abd129889c4703956a3f2361b6858dd9f4613adbca037f3a1b4bae619e3e481d1956a30f00e2a6ba6e31

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    jekyll-build-ebook (0.1.1)
+    jekyll-build-ebook (0.2.0)
       gepub (~> 0.7)
       jekyll (~> 3.5)
-      nokogiri (~> 1.0)
+      nokogiri (~> 1.8)
 
 GEM
   remote: https://rubygems.org/

data/jekyll-e-book.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jekyll', '~> 3.5'
 
   spec.add_dependency 'gepub', '~> 0.7'
-  spec.add_dependency 'nokogiri', '~> 1.0'
+  spec.add_dependency 'nokogiri', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'meowcop'

data/lib/jekyll-build-ebook.rb

@@ -1,9 +1,13 @@
 require 'jekyll'
 
+require 'securerandom'
+
 require 'gepub'
 require 'nokogiri'
 
 require_relative 'jekyll/commands/build_ebook'
 require_relative 'jekyll-build-ebook/config'
+require_relative 'jekyll-build-ebook/filters'
 require_relative 'jekyll-build-ebook/generator'
+require_relative 'jekyll-build-ebook/hooks'
 require_relative 'jekyll-build-ebook/version'

data/lib/jekyll-build-ebook/config.rb

@@ -4,67 +4,42 @@ module JekyllBuildEbook
   class Config
     DEFAULTS = {
       'ebook' => {
-        'destination' => '_ebook',
+        'destination' => File.join(Dir.pwd, '_ebook'),
+        'layout'      => 'ebook',
       },
     }.freeze
 
-    def initialize(config)
-      @config = config
-    end
-
-    def layout
-      ebook['layout']
-    end
-
-    def destination
-      File.expand_path(ebook['destination'])
-    end
-
-    def file_name
-      "#{ebook['file_name'] || title}.epub"
-    end
-
-    def identifier
-      ebook['identifier'] || site['url'].nil? ? nil : "#{site['url']}#{site['base_url']}" || SecureRandom.uuid
-    end
-
-    def title
-      ebook['title'] || site['title'] or raise InvalidConfigError, 'Title is required'
-    end
-
-    def language
-      ebook['language'] || site['language'] || site['lang'] or raise InvalidConfigError, 'Language is required'
-    end
-
-    def date
-      ebook['date']
-    end
-
-    def creator
-      case
-      when !ebook['creator'].nil?
-        ebook['creator']
-      when site['author'].is_a?(String)
-        site['author']
-      when site['author'].is_a?(Hash) && !site['author']['name'].nil?
-        site['author']['name']
-      else
-        nil
+    REQUIRED_FIELDS = %w[identifier title language].freeze
+
+    attr_reader :data
+
+    def initialize(site_config)
+      @data = {
+        'file_name'  => site_config['title'],
+        'identifier' => site_config['url'].nil? ? SecureRandom.uuid : "#{site_config['url']}#{site_config['base_url']}",
+        'title'      => site_config['title'],
+        'language'   => site_config['language'] || site_config['lang'],
+        'creator'    => case site_config['author']
+                        when String
+                          site_config['author']
+                        when Hash
+                          site_config['author']['name']
+                        else
+                          nil
+                        end,
+      }.merge(site_config['ebook'])
+
+      REQUIRED_FIELDS.each do |field|
+        raise InvalidConfigError, "#{field} is required" if data[field].nil?
       end
     end
 
-    def page_progression_direction
-      ebook['page_progression_direction']
-    end
-
-    private
-
-    def site
-      @config
+    def [](key)
+      data[key]
     end
 
-    def ebook
-      @config['ebook']
+    def file_path
+      "#{File.join(data['destination'], data['file_name'])}.epub"
     end
   end
 end

data/lib/jekyll-build-ebook/filters.rb

@@ -0,0 +1,24 @@
+module JekyllBuildEbook
+  module Filters
+    def self.register
+      Liquid::Template.register_filter(URLFilters)
+    end
+
+    module URLFilters
+      include Jekyll::Filters::URLFilters
+
+      def relative_url(input)
+        return if input.nil?
+        input = input.url if input.respond_to?(:url)
+        return input if Addressable::URI.parse(input.to_s).absolute?
+
+        page     = @context.registers[:page]
+        page_dir = Pathname.new(page.url).dirname
+
+        Pathname.new(ensure_leading_slash(input)).relative_path_from(page_dir).to_s
+      end
+
+      alias_method :absolute_url, :relative_url
+    end
+  end
+end

data/lib/jekyll-build-ebook/generator.rb

@@ -3,13 +3,12 @@ module JekyllBuildEbook
     def generate(site, book: GEPUB::Book.new)
       config = Config.new(site.config)
 
-      book.date                       = site.time
-      book.identifier                 = config.identifier
-      book.title                      = config.title
-      book.language                   = config.language
-      book.creator                    = config.creator
-      book.date                       = config.date || site.time
-      book.page_progression_direction = config.page_progression_direction
+      book.date                       = config['date'] || site.time
+      book.identifier                 = config['identifier']
+      book.title                      = config['title']
+      book.language                   = config['language']
+      book.creator                    = config['creator']
+      book.page_progression_direction = config['page_progression_direction']
 
       site.static_files.each do |static_file|
         File.open(static_file.path) do |io|
@@ -19,27 +18,17 @@ module JekyllBuildEbook
 
       book.ordered do
         site.posts.docs.each do |post|
-          output = render(site, post, layout: config.layout || site.layouts.key?('ebook') ? 'ebook' : 'none')
+          post.output = Jekyll::Renderer.new(site, post).run
 
           book
-            .add_item("#{post.cleaned_relative_path}.xhtml")
-            .add_content(StringIO.new(output))
+            .add_item(post.url)
+            .add_content(StringIO.new(Nokogiri::HTML(post.output).to_xhtml))
             .toc_text(post['title'])
         end
       end
 
-      FileUtils.mkdir_p(config.destination)
-      book.generate_epub(File.join(config.destination, config.file_name))
-    end
-
-    private
-
-    def render(site, post, layout:)
-      original_layout = post['layout']
-      post.merge_data!('layout' => layout)
-      output = Jekyll::Renderer.new(site, post).run
-      post.merge_data!('layout' => original_layout)
-      Nokogiri::HTML(output).to_xhtml
+      FileUtils.mkdir_p(config['destination'])
+      book.generate_epub("#{File.join(config['destination'], config['file_name'])}.epub")
     end
   end
 end

data/lib/jekyll-build-ebook/hooks.rb

@@ -0,0 +1,19 @@
+module JekyllBuildEbook
+  module Hooks
+    def self.register
+      overwrite_post_data
+    end
+
+    def self.overwrite_post_data
+      Jekyll::Hooks.register :posts, :pre_render do |post, _payload|
+        layout    = post.site.config['ebook']['layout']
+        permalink = "#{post.cleaned_relative_path}.xhtml"
+
+        post.merge_data!(
+          'layout'    => post.site.layouts.key?(layout) ? layout : 'none',
+          'permalink' => permalink,
+        )
+      end
+    end
+  end
+end

data/lib/jekyll-build-ebook/version.rb

@@ -1,3 +1,3 @@
 module JekyllBuildEbook
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/jekyll/commands/build_ebook.rb

@@ -4,28 +4,44 @@ module Jekyll
       # Create the Mercenary command for the Jekyll CLI for this Command
       def self.init_with_program(prog)
         prog.command(:'build-ebook') do |c|
-          c.syntax 'build-ebook'
+          c.syntax 'build-ebook [options]'
           c.description 'Build your ebook'
           c.alias :be
 
+          c.option 'config', '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+          c.option 'destination', '-d', '--destination DESTINATION', 'The current folder will be generated into DESTINATION'
+          c.option 'source', '-s', '--source SOURCE', 'Custom source directory'
+          c.option 'future', '--future', 'Publishes posts with a future date'
+          c.option 'limit_posts', '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
+          c.option 'show_drafts', '-D', '--drafts', 'Render posts in the _drafts folder'
+          c.option 'unpublished', '--unpublished', 'Render posts that were marked as unpublished'
+          c.option 'quiet', '-q', '--quiet', 'Silence output.'
+          c.option 'verbose', '-V', '--verbose', 'Print verbose output.'
+
           c.action do |_args, options|
             process(options)
           end
         end
       end
 
-      # Build your jekyll ebook
-      def self.process(options, generator: JekyllBuildEbook::Generator.new)
+      def self.process(options)
         # Adjust verbosity quickly
         Jekyll.logger.adjust_verbosity(options)
 
+        JekyllBuildEbook::Hooks.register
+        JekyllBuildEbook::Filters.register
+
         options = Jekyll::Utils.deep_merge_hashes(JekyllBuildEbook::Config::DEFAULTS, options)
-        options = configuration_from_options(options)
-        site    = Jekyll::Site.new(options)
+        config  = configuration_from_options(options)
+        site    = Jekyll::Site.new(config)
+
+        build(site, config)
+      end
 
+      def self.build(site, config, generator: JekyllBuildEbook::Generator.new)
         t           = Time.now
-        source      = options['source']
-        destination = options['ebook']['destination']
+        source      = config['source']
+        destination = config['ebook']['destination']
 
         Jekyll.logger.info 'Source:', source
         Jekyll.logger.info 'Destination:', destination

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-build-ebook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fuji Nakahara
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,9 @@ files:
 - jekyll-e-book.gemspec
 - lib/jekyll-build-ebook.rb
 - lib/jekyll-build-ebook/config.rb
+- lib/jekyll-build-ebook/filters.rb
 - lib/jekyll-build-ebook/generator.rb
+- lib/jekyll-build-ebook/hooks.rb
 - lib/jekyll-build-ebook/version.rb
 - lib/jekyll/commands/build_ebook.rb
 homepage: https://github.com/fuji-nakahara/jekyll-build-ebook