jekyll-sqlite 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4537bdf95266e26c50110d5ca259f83726b540fe3bf3a6714821d2aa64e83a4
-  data.tar.gz: f3aa0e1a40abd05e112a44b36aea75e39fc9bc03c49cf1f10710e0bf1fca1aee
+  metadata.gz: 84fe35922543ed1ca397dedc961e89c6529ee97bc2ef414e7278defa90a73de5
+  data.tar.gz: c001a8544fea6b316d9e1a4f71fc3897508e408c8af141073e5234b34744b173
 SHA512:
-  metadata.gz: 97d7e1abe1fdcf60b04336443201eb2063e6f4c7c226d4c9b1052efc01b770d080cc967a3d7f9cebe479fa2b2abce800ddb5e8655a0023c682e9d845d0c5c2c7
-  data.tar.gz: 97508c414be1884ba85f465316eb33c0494fc49190e4f3dec2a6a05739cca7e72b3fd745b45a2bb30d263660fea942fb92c8c210cf38d3f737a739ca1a3c8147
+  metadata.gz: fb3009dfc71784e54b032331b0530c1bbc130929152758497aaa4496e142f3af5d9d0f4187eec1ca9a6342cdc93025a5d18e6a08b912592014e010ea6372880f
+  data.tar.gz: daefd3282ecb6586d4c1a75559d7663b9b8063d74e044e57ccb034c0f1b14bd7c7494e67c420154bf445c328675ca21e03942252843209c8497f8b0a855dbf6e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-sqlite (0.1.0)
+    jekyll-sqlite (0.1.1)
       sqlite3 (~> 1.6)
 
 GEM
@@ -32,10 +32,12 @@ GEM
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
     sqlite3 (1.6.2-aarch64-linux)
+    sqlite3 (1.6.2-x86_64-linux)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   aarch64-linux
+  x86_64-linux
 
 DEPENDENCIES
   jekyll-sqlite!

data/README.md

@@ -1,12 +1,14 @@
-# Jekyll SQlite plugin
+# Jekyll SQLite plugin
 
-A Jekyll generator plugin to lets you use SQLite database instead of data files as a data source.
+A Jekyll generator plugin to lets you use SQLite database instead of data files as a data source. It lets you easily create APIs and websites from a SQLite database, by linking together a database file, your template, and the relevant queries.
+
+It additionally supports nested queries, so that you can use the rows of `site.data.items` as bind_params for your nested query.
 
 [![Continuous Integration](https://github.com/captn3m0/jekyll-sqlite/actions/workflows/main.yml/badge.svg)](https://github.com/captn3m0/jekyll-sqlite/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/jekyll-sqlite.svg)](https://badge.fury.io/rb/jekyll-sqlite)
 
 ## Installation
 
-Add this line to your site's Gemfile:
+Add this line to your site's `Gemfile`:
 
 ```ruby
 gem 'jekyll-sqlite'
@@ -16,46 +18,42 @@ And then add this line to your site's `_config.yml`:
 
 ```yml
 plugins:
-  - jekyll-sqlite
+  - jekyll_sqlite
 ```
 
 :warning: If you are using Jekyll < 3.5.0 use the `gems` key instead of `plugins`.
 
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
 ## Usage
 
 Update your `_config.yml` to define your data sources with your SQLite database.
 
 ```yml
 ...
+# These are run in sequence, so any nested data can work well.
 sqlite:
-  members:
+  - data: members
     file: _db/users.db
-    sql: SELECT * FROM members ORDER by created_at DESC
+    query: SELECT * FROM members ORDER by created_at DESC
   # You can use `results_as_hash` to switch between array or hash results (default).
-  verified:
+  - data: verified
     results_as_hash: false # default true
     file: _db/users.db
-    sql: SELECT username, email FROM members WHERE verified=1
+    query: SELECT username, email FROM members WHERE verified=1
+  - data: members.posts
+    file: _db/posts.db
+    query: SELECT * FROM posts WHERE user_id = :id
 ```
 
 Then, you can use the `site.data` attributes accordingly:
 
 ```liquid
-{% for user in site.data.members %}
-- {{user.username}}
+{% for member in site.data.members %}
+- {{member.username}}
+
+  # Your Posts
+  {% for post in member.posts %}
+    {{post}}
+  {% endfor %}
 {% endfor %}
 
 # Result here is an array instead of a hash.
@@ -64,6 +62,77 @@ Then, you can use the `site.data` attributes accordingly:
 {% endfor %}
 ```
 
+## Generating Pages
+
+It works well with the `datapage_gen` plugin:
+
+See the [datapage_gen](https://github.com/avillafiorita/jekyll-datapage_gen) docs for more details.
+
+Here's a sample configuration:
+
+```yaml
+# This will automatically generate a file for each restaurant
+# restaurants/#{id}.html file
+# with the layout `_layouts/restaurant.html`
+# and page.id, page.name, page.active set
+# and page.title set to restaurant name
+sqlite:
+  restaurants:
+    file: _db/reviews.db
+    sql: SELECT id, name, last_review_date > 1672531200 as active, address FROM restaurants;
+page_gen:
+  - data: restaurants
+    template: restaurant
+    name: id
+    title: name
+    filter: active
+```
+
+## Nested Queries
+
+You can use the rows of `site.data.items` as bind_params for your nested query. For this to work against
+data generated by the plugin, the configuration order must be correct, so you need `site.data.items` above `site.data.items.nested` in your configuration.
+
+Say you have a YAML file defining your items (`data/items.yaml`):
+
+```yaml
+- id: 31323952-2708-42dc-a995-6006a23cbf00
+  name: Item 1
+- id: 5c8e67a0-d490-4743-b5b8-8e67bd1f95a2
+  name: Item 2
+```
+and the prices for the items in your SQLite database, the following configuration will enrich the `items` array with the price:
+
+```yaml
+sql:
+- data: site.data.items.meta
+  query: SELECT price,author FROM pricing WHERE id =:id
+```
+This would allow the following Liquid loop to be written:
+
+```liquid
+{% for item in site.data.items %}
+{{item.meta.price}}, {{item.meta.author}}
+{% endfor %}
+```
+
+This works well with `results_as_configuration` as well.
+
+```yaml
+sql:
+- data: site.data.items.meta
+  query: SELECT price,author FROM pricing WHERE id =:id
+  results_as_hash: false
+```
+
+The following also renders the price and author:
+
+```liquid
+{% for item in site.data.items %}
+  {{item.meta[0]}}, {{item.meta[1]}}
+{% endfor %}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/jekyll-sqlite/generator.rb

@@ -13,14 +13,72 @@ module JekyllSQlite
       db.execute("PRAGMA query_only = ON")
     end
 
+    # Get the root of where we are generating the data
+    def get_root(root, name)
+      name.split(".")[0..-2].each do |p|
+        root = root[p]
+      end
+      root
+    end
+
+    def gen_hash_data(root, db, _query)
+      root ||= {}
+
+      root[name] = db.execute(config["query"])
+      root[name].size
+    end
+
+    def gen_nested_data(item, db, query, name)
+      item[name] = []
+      db.prepare(query) do |stmt|
+        # We bind params, ignoring any errors
+        # Since there's no way to get required params
+        # From a statement
+        item.each do |key, value|
+          stmt.bind_param key, value
+        rescue StandardError # rubocop:disable Lint/SuppressedException
+        end
+        stmt.execute.each { |d| item[name] << d }
+      end
+      item[name].size
+    end
+
+    def array_gen(root, config, name, db)
+      count = 0
+      root.each do |item|
+        # TODO: Add support for binding Arrays as well.
+        if item.is_a? Hash
+          count += gen_nested_data(item, db, config["query"], name)
+        else
+          Jekyll.logger.info "Jekyll SQLite:", "Item is not a hash for #{name}. Unsupported configuration"
+        end
+      end
+      count
+    end
+
+    def gen_data(root, config, name, db)
+      count = 0
+      if root.nil? || (root.is_a? Hash)
+        count = gen_hash_data(root, db, config["query"])
+      elsif root.is_a? Array
+        count = array_gen(root, config, name, db)
+      end
+      count
+    end
+
+    def get_tip(name)
+      name.split(".")[-1]
+    end
+
     def generate(site)
-      site.config["sqlite"].each do |name, config|
+      site.config["sqlite"].each do |config|
+        name = config["data"]
         SQLite3::Database.new config["file"], readonly: true do |db|
-          Jekyll.logger.info "Jekyll SQLite:", "Starting to load #{name}"
           fast_setup db
           db.results_as_hash = config.fetch("results_as_hash", true)
-          site.data[name] = db.execute(config["query"])
-          Jekyll.logger.info "Jekyll SQLite:", "Loaded #{name}. Count=#{site.data[name].size}"
+          root = get_root(site.data, name)
+          count = gen_data(root, config, get_tip(name), db)
+          Jekyll.logger.info "Jekyll SQLite:", "Loaded #{name}. Count=#{count}. as_hash=#{db.results_as_hash}"
         end
       end
     end

data/lib/jekyll-sqlite/version.rb

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

data/lib/jekyll_sqlite.rb

@@ -5,5 +5,4 @@ require "jekyll-sqlite/generator"
 
 module JekyllSQlite
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sqlite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nemo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3