jekyll-ebook_reader 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccdea2673cc4e1899604b328a1f43ed3709a362d5020dc9affe02f2a3afc4e44
-  data.tar.gz: c895480b789f80577cf8f1b6064bca2ca8270369dd564ed30337d13b647b2fdf
+  metadata.gz: e361e553631b855b813f001eb2d58d78bfb8c5752042a9316ea850146941b60d
+  data.tar.gz: 82bd977ff5b759642f7e599f32f299b6e235641196226c97fd2ce11ea716e99b
 SHA512:
-  metadata.gz: 5d46a21953420e4b79c53c4364e78c645e6e77852ee3bb74d2c4e6a8e12e8e5cd3c45f5cdaff2ed0c75df3f2e4e879ebd6687c47f48f104119060ebd618ffbbb
-  data.tar.gz: 519f93377b19398884a9263cdde4103b32b2f6cd261a82a31a3fdd15109da27fe01d38dfa38628400c02c037ac99ef1327ec2eb7a47be9b05a609598399e8f5d
+  metadata.gz: d52f0daa15ee8d4f89e6170eb61761d0b98d913fa5fe0489e41eda0d62f5d097968e0c5b53d31ebb2cb23551cd4b484b4ecd9c467ab3e828304a7e037d45fc3d
+  data.tar.gz: d715edc681a9abac59d4e6291824ef3fb21071cc7a2b00e23e24db64321c62d35e8521b075f8299ea55d6328f987d79e6b6febfaddeb1da131f4430680d74175

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+jekyll-ebook_reader-*.gem

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    jekyll-ebook_reader (0.1.1)
+      fileutils (>= 1.1.0, <= 1.5.0)
+      jekyll (>= 3.0, < 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.8)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.14.2)
+    fileutils (1.5.0)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rouge (3.26.0)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  bundler
+  jekyll-ebook_reader!
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  rubocop-rake
+
+BUNDLED WITH
+   2.2.9

data/README.md

@@ -1,8 +1,9 @@
-# Jekyll::EbookReader
+# Jekyll-EbookReader
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/ebook_reader`. To experiment with that code, run `bin/console` for an interactive prompt.
+This plugin allows you to embed eBooks in your site on any page or post!
+
+It uses [EPUB.js](http://futurepress.org/) to do so.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +23,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To embed a book on a page/post:
+1. Add your ebook file to your `/assets` folder. Take note of the path to your book, starting at the base of your site. (E.g. it may be '/assets/myBook.epub', or if you put it inside an "ebooks" subfolder, it might be 'assets/ebooks/myBook.epub'.)
+2. Go to the page you want to embed it on and
+    a. add an 'ebook_path' variable to your front matter.
+    b. add an `{% ebook %}` tag wherever you'd like the book to appear.
+That's it!
+
+For example, if you wanted to embed Moby Dick on a page, you could add MobyDick.epub to your assets folder, and then make a page that looks like this:
+
+```
+---
+layout: default
+title:  "EbookExample"
+date:   2021-02-12 15:01:30 -0500 
+ebook_path: "/assets/MobyDick.epub"
+---
+
+Gosh this is my favorite book!!
+
+{% ebook %}
+
+```
+
+
 
 ## Development
 
@@ -32,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-ebook_reader.
+Bug reports and pull requests are welcome on GitHub at https://github.com/qbatten/jekyll-ebook_reader.
 
 ## License
 

data/Rakefile

@@ -6,3 +6,6 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: :rubocop
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ["--display-cop-names", "--auto-correct"]
+end

data/jekyll-ebook_reader.gemspec

@@ -27,8 +27,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
   spec.add_dependency "fileutils", ">= 1.1.0", "<= 1.5.0"
+  spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rubocop-rake"
 end

data/lib/jekyll/ebook_reader.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "jekyll"
 
-
 module Jekyll
   module EbookReader
+    # Generates static files
     class EbookEmbed < Jekyll::Generator
       safe false
       priority :low
       def generate(site)
         @site = site
         @site = site.static_files += add_all_static_files
-
       end
 
-      private 
+      private
 
       # Destination for sitemap.xml file within the site source directory
       def destination_path(file)
@@ -21,24 +22,24 @@ module Jekyll
       end
 
       def static_files_to_include
-        ["reader.js" , "ebookreader_main.css", "ebookreader_iframe.css", "ajax-loader.gif"]
+        ["reader.js", "ebookreader_main.css", "ebookreader_iframe.css", "ajax-loader.gif"]
       end
 
       def add_all_static_files
         files ||= []
         static_files_to_include.each do |file_name|
-          incl = Jekyll::StaticFile.new(@site, File.join( File.dirname(__FILE__), 'ebook_reader'), "assets/jekyll-ebookreader-assets", file_name)
+          incl = Jekyll::StaticFile.new(@site, File.join(File.dirname(__FILE__), "ebook_reader"),
+                                        "assets/jekyll-ebookreader-assets", file_name)
           incl.destination(destination_path(file_name))
           files.append(incl)
         end
         files
       end
     end
-
   end
 end
 
-
+# Adds relevant scripts and html tags to html body
 class EBookReaderTag < Liquid::Tag
   def initialize(tag_name, input, tokens)
     super
@@ -46,21 +47,18 @@ class EBookReaderTag < Liquid::Tag
   end
 
   def render(context)
-    path = File.join(File.dirname(__FILE__), 'ebook_reader', "assets/jekyll-ebookreader-assets/ebook_include_body_tag.html")
+    path = File.join(File.dirname(__FILE__), "ebook_reader",
+                     "assets/jekyll-ebookreader-assets/ebook_include_body_tag.html")
     include_string = File.read(path)
-    processed = Liquid::Template.parse(include_string).render(context)
-    return processed
+    Liquid::Template.parse(include_string).render(context)
   end
 end
 
-    # Add relevant scripts and style tags to doc head
+# Add relevant scripts and style tags to doc head
 Jekyll::Hooks.register [:pages, :posts], :post_render do |post|
-  path = File.join(File.dirname(__FILE__), 'ebook_reader', "assets/jekyll-ebookreader-assets/ebook_include_header.html")
+  path = File.join(File.dirname(__FILE__), "ebook_reader", "assets/jekyll-ebookreader-assets/ebook_include_header.html")
   include_string = File.read(path)
-
-  if post.data.has_key? ("ebook_path")
-    post.output = post.output.gsub("</head>", include_string + "</head>")
-  end
+  post.output = post.output.gsub("</head>", "#{include_string}</head>") if post.data.key?("ebook_path")
 end
 
-Liquid::Template.register_tag('ebook', EBookReaderTag)
+Liquid::Template.register_tag("ebook", EBookReaderTag)

data/lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/ebook_include_body_tag.html

@@ -1,42 +1,41 @@
 <div id="ebook-includes">
     <script type="text/javascript">
-        let ebookPath = "{{page.ebook.ebook_path}}" || "{{page.ebook_path}}";
-        let style_path = "{{page.ebook_iframe_custom_stylesheet}}" || "/assets/jekyll-ebookreader-assets/ebookreader_iframe.css"
-        let eBookRenderOptions = {
-            flow: "scrolled-doc",
-            ignoreClass: "annotator-hl",
-            width: "100%",
-            height: "100%",
-            stylesheet: style_path
-        }
-        document.addEventListener(
-            'DOMContentLoaded',
-            () => launchEpubJS(ebookPath, eBookRenderOptions),
-            false);
-        </script>
-        <a id="opener">
-            <i class="material-icons">menu</i>
-        </a>
-        <div id="ebook-main">
-            <div id="viewer" class="loading"></div>
-            <span id="hiddenTitle"></span>
-            <div id="bottom-nav-arrows">
-                <a id="prev" href="#prev" class="arrow">
-                    <i class="material-icons">chevron_left</i>
-                </a>
-                <a id="next" href="#next" class="arrow">
-                    <i class="material-icons">chevron_right</i>
-                </a>
-            </div>
-        </div>
-        <div id="navigation">
-            <a id="closer">
-                <i class="material-icons">close</i>
+    let ebookPath = "{{page.ebook.ebook_path}}" || "{{page.ebook_path}}";
+    let style_path = "{{page.ebook_iframe_custom_stylesheet}}" || "/assets/jekyll-ebookreader-assets/ebookreader_iframe.css"
+    let eBookRenderOptions = {
+        flow: "scrolled-doc",
+        ignoreClass: "annotator-hl",
+        width: "100%",
+        height: "100%",
+        stylesheet: style_path
+    }
+    document.addEventListener(
+        'DOMContentLoaded',
+        () => launchEpubJS(ebookPath, eBookRenderOptions),
+        false);
+    </script>
+    <a id="opener">
+        <i class="material-icons">menu</i>
+    </a>
+    <div id="ebook-main">
+        <div id="viewer" class="loading"></div>
+        <span id="hiddenTitle"></span>
+        <div id="bottom-nav-arrows">
+            <a id="prev" href="#prev" class="arrow">
+                <i class="material-icons">chevron_left</i>
+            </a>
+            <a id="next" href="#next" class="arrow">
+                <i class="material-icons">chevron_right</i>
             </a>
-            <h1 id="title">...</h1>
-            <image id="cover" width="150px" />
-            <h2 id="author">...</h2>
-            <ul id="toc"></ul>
         </div>
     </div>
+    <div id="navigation">
+        <a id="closer">
+            <i class="material-icons">close</i>
+        </a>
+        <h1 id="title">...</h1>
+        <image id="cover" width="150px" />
+        <h2 id="author">...</h2>
+        <ul id="toc"></ul>
+    </div>
 </div>

data/lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/reader.js

@@ -204,102 +204,4 @@ function launchEpubJS(bookURL, bookRenderOptions) {
 
     });
 
-}
-
-
-function wait(t) {
-    return new Promise(function(resolve) {
-        window.setTimeout(resolve, t)
-    });
-}
-
-function handleHypothesisChange(state) {
-
-    let epubjsStyleIfHypoOpen = `body.hypothesis-highlights-always-on { padding-left: 5px !important; }`
-
-    let main = document.querySelector('#ebook-main');
-    let hypoWasAlreadyOpen = main.classList.contains('hypoIsOpen');
-    let hypoSidebarDidChange = (
-        (hypoWasAlreadyOpen && !state.expanded)
-        || (!hypoWasAlreadyOpen && state.expanded));
-    if (hypoSidebarDidChange) {
-        // Wait until epub.js iframe is loaded
-        if (!document.querySelector('div.epub-view iframe')) {
-            wait(1500)
-                .then(
-                    (a) => {
-                        console.log('waiting...', a);
-                        resizeReflowAndScroll();
-                    }
-                );
-        } else {
-            resizeReflowAndScroll();
-        }
-    } else {
-        return;
-    }
-
-    // Reflow txt to still be visible, scroll to maintain location
-    function resizeReflowAndScroll() {
-        console.log('reflowing...')
-
-        // Main window
-        let currScroll = scrollY;
-        let viewer = document.querySelector("#viewer");
-        let parsedRenditionWidthPct = Number.parseInt(rendition.settings.width) / 100;
-
-        // Hypothesis
-        let hypoSidebar = document.querySelector("hypothesis-sidebar")
-            .shadowRoot.querySelector('div.annotator-frame');
-
-        // epub.js iframe
-        let iframeEl = document.querySelector('iframe');
-        let iframePaddingElement = iframeEl.contentDocument.querySelector("#iframePaddingElement");
-        console.log(iframeEl, iframePaddingElement);
-        if (!iframePaddingElement) {
-            iframePaddingElement = document.createElement("style");
-            iframePaddingElement.id = "iframePaddingElement";
-            iframeEl.contentDocument.head.appendChild(iframePaddingElement);
-        }
-        console.log(iframeEl, iframePaddingElement);
-
-        let bodyEl = iframeEl.contentDocument.body;
-        let currBodyPadding = [Number.parseInt(bodyEl.style.paddingLeft),
-            Number.parseInt(bodyEl.style.paddingRight)
-        ];
-
-        // If hypothesis expanded (this fn is only called if it was a real sidebar open/close)
-        if (state.expanded) {
-            main.classList.add('hypoIsOpen');
-
-            // Inject reduced padding styling to epub iframe
-            iframePaddingElement.textContent = epubjsStyleIfHypoOpen;
-
-            // Calculate new size
-            let rectViewer = viewer.getBoundingClientRect();
-            let rectHypo = hypoSidebar.getBoundingClientRect();
-            let spaceNeeded = Number.parseFloat(rectViewer.right - (rectHypo.left - rectHypo.width));
-            let pct = spaceNeeded / Number.parseFloat(rectViewer.width);
-            pct = (1 - pct) * 100;
-            pct = Number.parseInt(pct).toString();
-            pct = pct + '%';
-            console.log('resizeDetails', {pct, spaceNeeded, rectHypo, rectViewer});
-            rendition.resize(pct);
-
-            let scrollNew = currScroll + 0.262 * currScroll;
-            wait(300).then(() => scrollTo({ 'top': scrollNew }));
-
-        } else if ((state.expanded === false)) {
-            rendition.resize("100%");
-            main.classList.remove("hypoIsOpen");
-            iframePaddingElement.textContent = "";
-
-            let scrollNew = currScroll / 1.262;
-            wait(300)
-                .then(() => scrollTo({ 'top': scrollNew }));
-
-        }
-
-    };
-
 }

data/lib/jekyll/ebook_reader/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module EbookReader
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ebook_reader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Quinn Batten
@@ -10,6 +10,26 @@ bindir: exe
 cert_chain: []
 date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -31,27 +51,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: fileutils
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,6 +90,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile