jekyll-calibre 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbbf254d6c7dec3597ffcd430b075a4a6dca0ab1e75f55b3632ce8155cc64576
+  data.tar.gz: 117d0e9cf2647b85ae5f5bc4792e16bbaaef17521d87294d6dc2f50273bf056a
+SHA512:
+  metadata.gz: 7ad85f2dd1e70ccccf14e56904427b3122edea7b51c9651e392e50769564a631235c4550782ddf44bfbffcf7ff0b9f18915e7a60ebab75fe949c67c5c292d959
+  data.tar.gz: 7b61defe30a2f052585407a843c87ff329865844d4311ea0aeb19f352e30f34e94516e8c6af43b11b6a98068d80418eb38f50a9cfccd2a28d8d14623eeb66fd6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 fauno <fauno@partidopirata.com.ar>
+
+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.es.md

@@ -0,0 +1,75 @@
+# jekyll-calibre
+
+Este plugin genera un sitio Jekyll a partir de una biblioteca de
+Calibre, de forma que cualquier plantilla de Jekyll pude convertirse en
+una biblioteca :)
+
+Crea un artículo por cada libro en la biblioteca de Calibre,
+convirtiendo los metadatos de Calibre en metadatos de Jekyll.  Además
+copia la cubierta y los archivos en el sitio final y los incorpora al
+artículo como metadatos, para poder descargarlos.
+
+## Metadatos / "Frontmatter"
+
+El plugin genera documentos de Jekyll como si fuesen archivos de la
+colección `_posts` (está pendiente poder configurar la colección).
+
+Si fueran escritos como archivos, quedarían así:
+
+```
+---
+authors: [ Autorx, Autorx ]
+title: Título del libro
+slug: titulo-del-libro
+date: (Fecha en que el libro se agregó a la biblioteca)
+cover: /baseurl/url/absoluta/a/la/cubierta.jpg
+files:
+  epub: /baseurl/url/absoluta/al/libro.epub
+  pdf:  /baseurl/url/absoluta/al/libro.pdf
+pubdate: (Fecha de publicación del libro)
+publisher: [ Editora ]
+---
+
+Comentarios del libro / Reseña
+```
+
+## Configuración
+
+El plugin acepta estas opciones en `_config.yml`:
+
+```yaml
+calibre:
+  dir: '/ruta/absoluta/a/la/biblioteca/de/calibre'
+  layout: plantilla
+  files:
+    dir: directorio/base/donde/se/copian/los/libros
+  cover:
+    field: campo-del-frontmatter-donde-van-las-cubiertas
+    dir: directorio/base/donde/se/copian/las/cubiertas
+```
+
+* `calibre` es la base de la configuración del plugin
+* `dir` es el directorio donde se encuentra la biblioteca de Calibre,
+  probablemente en tu `~`
+* `layout` debe corresponder a un archivo dentro de `_layouts` y es la
+  plantilla para cada libro.
+* `files` son las opciones relacionadas con archivos.
+* `dir` dentro de `files` es el directorio donde se copian los archivos.
+* `cover` son las opciones relacionadas con cubiertas.
+* `dir` dentro de `cover` es el directorio donde se copian las
+  cubiertas.
+* `field` es el campo del _frontmatter_ donde la plantilla espera
+  encontrar las imágenes de cubierta.
+
+La única opción requerida es el directorio donde se encuentra la
+biblioteca.  Las opciones por defecto son:
+
+```yaml
+calibre:
+  layout: post
+  files:
+    dir: files
+  cover:
+    dir: covers
+    field: cover
+```

data/README.md

@@ -0,0 +1,74 @@
+# jekyll-calibre
+
+This Jekyll plugin creates a site from a Calibre library.  So it's able
+to turn *any* Jekyll theme into a library!
+
+It creates a post for every book in a Calibre library, by mapping the
+book's metadata into a post metadata.  Then it copies the cover and the
+files into the final site and also makes them available as metadata, so
+the site can have download buttons.
+
+## Metadata / Frontmatter
+
+The plugin will generate Jekyll documents as if they were files in the
+`_posts` collection (it's on the `TODO` list to be able to configure the
+collection).
+
+If they were written down as actual files, they would end up like this:
+
+```
+---
+authors: [ Author, Author ]
+title: Book title
+slug: book-title
+date: (Date the book was added to the library)
+cover: /baseurl/absolute/url/to/book/cover.jpg
+files:
+  epub: /baseurl/absolute/url/to/book.epub
+  pdf: /baseurl/absolute/url/to/book.pdf
+pubdate: (Publication date according to book)
+publisher: [ Publisher ]
+---
+
+Book comments
+```
+
+## Configuration
+
+The plugin accepts these options in `_config.yml`:
+
+```yaml
+calibre:
+  dir: '/absolute/path/to/calibre/library'
+  layout: default-layout-for-books
+  files:
+    dir: base/directory/where/files/are/stored/in/site
+  cover:
+    field: field-in-front-matter-where-covers-are-stored
+    dir: base/directory/where/covers/are/stored/in/site
+```
+
+* `calibre` is the base for this plugin configuration
+* `dir` is the Calibre library directory, it's probably in your home.
+* `layout` must correspond to a file in `_layouts` and is the template
+  for each book.
+* `files` are options related to files
+* `dir` inside `files` is the directory where files are copied into
+* `cover` are options related to covers
+* `dir` inside `cover` is the directory where covers are copied into
+* `field` is the frontmatter field where the theme expects to find
+  cover images
+
+The only required option is the dir where the library is stored, the
+default options are:
+
+```yaml
+calibre:
+  layout: post
+  files:
+    dir: files
+  cover:
+    dir: covers
+    field: cover
+```
+

data/jekyll-calibre.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/calibre/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'jekyll-calibre'
+  gem.version       = Jekyll::Calibre::VERSION
+  gem.authors       = ['fauno']
+  gem.email         = ['fauno@partidopirata.com.ar']
+  gem.description   = %q{Jekyll plugin to generate a site from a Calibre library}
+  gem.summary       = %q{Jekyll plugin to generate a site from a Calibre library}
+  gem.homepage      = 'https://0xacab.org/utopias-piratas/jekyll-calibre'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency('calibre-ruby', '~> 0')
+  gem.add_dependency('jekyll', '~> 4')
+end

data/lib/jekyll/calibre/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  class Calibre
+    VERSION = '0.0.2'.freeze
+  end
+end

data/lib/jekyll/calibre.rb

@@ -0,0 +1,97 @@
+require 'calibre'
+
+# Monkeypatch to Jekyll::Site
+module Jekyll
+  class Site
+    alias_method :read_one, :read
+
+    # The goal here is to create books into posts without having to
+    # write them as actual files.
+    def read
+      # Read other posts normally
+      read_one
+
+      # Get the calibre dir from _config.yml
+      calibre_dir = config.dig('calibre','dir')
+      # Where to copy the covers
+      cover_dir   = config.dig('calibre', 'cover', 'dir') || 'covers'
+
+      # TODO fail if calibre_dir is missing
+
+      # Open the database
+      Calibre.db = File.join(calibre_dir, 'metadata.db')
+
+      # For every book
+      # TODO make the query customizable
+      Calibre::Book.all.each do |book|
+        # Create a new document on the posts collection
+        # TODO use a _books collection
+        post = Jekyll::Document.new('unneeded', { site: self, collection: posts })
+
+        # The layout comes from the config
+        post.data['layout'] = config.dig('calibre', 'layout') || 'post'
+        # It's a markdown file
+        post.data['ext'] = 'markdown'
+        # The slug is the slugified title
+        post.data['slug'] = Utils.slugify(book.title)
+        # The title is the title :P
+        post.data['title'] = book.title
+        # Other metadata
+        post.data['date']      = book.timestamp
+        post.data['pubdate']   = book.pubdate
+        post.data['author']    = book.authors.map(&:name).compact
+        post.data['publisher'] = book.publishers.map(&:name).compact
+        # The content comes in html but we don't care much because
+        # markdown supports html
+        # TODO convert to markdown anyway in case the parser gives
+        # custom attributes and classes, like id's to h* tags
+        post.content = book.comments.map(&:text).compact.join
+
+        # The formats and files for easy access
+        # TODO fail if missing
+        files_dest = config.dig('calibre', 'files', 'dir') || 'files'
+        post.data['files'] = Hash[book.data.map do |f|
+          # Copy the actual files
+          file      = File.join(files_dest, f.path)
+          file_dest = File.join(dest, file)
+          file_orig = File.join(calibre_dir, f.path)
+          FileUtils.mkdir_p(File.dirname(file_dest))
+          FileUtils.cp(file_orig, file_dest)
+          self.keep_files << file
+
+          # Also create a Hash { format: path } as absolute url
+          [ f.format, config.fetch('baseurl', '') + '/' + file ]
+        end]
+
+        # Copy the covers to the final site
+        if book.cover?
+          # Where in the metadata we want to store the path to cover
+          cover_field = config.dig('calibre', 'cover', 'field') || 'cover'
+          # The path is the absolute URL
+          post.data[cover_field] = "#{config.fetch('baseurl', '')}/#{cover_dir}/#{book.cover}"
+
+          # The cover is stored in a path mimicking the path from
+          # calibre
+          # TODO maybe use the slug or something, calibre uses spaces in
+          # directories :(
+          post_dir   = File.join(dest, cover_dir, book.path)
+          # Original cover
+          cover      = File.join(calibre_dir, book.cover)
+          # Final cover
+          dest_cover = File.join(post_dir, 'cover.jpg')
+
+          # Create the directory and copy the file
+          FileUtils.mkdir_p(post_dir)
+          FileUtils.cp(cover, dest_cover)
+
+          # Tell Jekyll to keep the files once finishes building
+          # keep_files needs the relative path
+          self.keep_files << File.join(cover_dir, book.cover)
+        end
+
+        # Add the book to the _posts collection
+        posts.docs << post
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-calibre
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- fauno
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: calibre-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Jekyll plugin to generate a site from a Calibre library
+email:
+- fauno@partidopirata.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.es.md
+- README.md
+- jekyll-calibre.gemspec
+- lib/jekyll/calibre.rb
+- lib/jekyll/calibre/version.rb
+homepage: https://0xacab.org/utopias-piratas/jekyll-calibre
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: Jekyll plugin to generate a site from a Calibre library
+test_files: []