jekyll-sqlite 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c9ba502f7b75dd59633f9cd88c9412dfe49d0146cd5e4bc3510bd517158c4c
-  data.tar.gz: 29656b5f23cffc2912c498562c5e1547a1e2ffa865cfec3fee35892deaa5d1b5
+  metadata.gz: f14ced1e5bddd23e8aca1460f7acc53449b2d19fbf3bb67eb97f55f194facc95
+  data.tar.gz: f2a21e3b7d89d2d8d476c71ee2876025037009eb311df7d64fb1b9e2dca5cac3
 SHA512:
-  metadata.gz: c0a65da0d781e76cd8bb2605cc57eef3dea1a89e45d059eaf2eb8b9de3b2423b9252831e9d7ae4cc0011097fa9dfc4c533d8593ced72e97e85fe2e86d2151054
-  data.tar.gz: 9c96bdb90d10f05a1d30c3d5e389f180d30e73f69534a047f8e8b755abb16850f4f76a4bdaf3fdf867a71f77a6d93e826a5caac363bca679b6887bdd0160650f
+  metadata.gz: 50c29d5008eb35fd2ed1fd6d9b6acf7cca7c1fcc0b5e3b4933506f0a29875118c02934ccbd2cec94f3676d7276f71527803bb4324467b36a29dcddfe8b8d2064
+  data.tar.gz: '09b4bd31b5fe04534892df1e5a229e3aca26cc447a147f2cf43d5e306a4c14c30156505b08481c78b89c1216b7e0aec6ba54ee3979ab002363d46dec3fc8f11a'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.3] - 2024-07-02
+- First functional version
+- Adds tests
+
 ## [0.1.0] - 2023-05-08
 
 - Initial release

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in jekyll-sqlite.gemspec
 gemspec
 
+# These are development dependencies
 gem "rake", "~> 13.0"
+gem "jekyll", "~> 4.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-rake", "~> 0.6.0"

data/README.md

@@ -25,41 +25,32 @@ plugins:
 
 ## Usage
 
-Update your `_config.yml` to define your data sources with your SQLite database.
+Update your `_config.yml` to define your data sources with your SQLite database. Please see
+the `test` directory for a functional example with the [Northwind database](https://github.com/jpwhite3/northwind-SQLite3).
 
 ```yml
 ...
-# These are run in sequence, so any nested data can work well.
 sqlite:
-  - data: members
-    file: _db/users.db
-    query: SELECT * FROM members ORDER by created_at DESC
-  # You can use `results_as_hash` to switch between array or hash results (default).
-  - data: verified
-    results_as_hash: false # default true
-    file: _db/users.db
-    query: SELECT username, email FROM members WHERE verified=1
-  - data: members.posts
-    file: _db/posts.db
-    query: SELECT * FROM posts WHERE user_id = :id
+  - data: orders
+    file: &db "_db/northwind.db"
+    query: SELECT * from Orders
+  - data: customers
+    file: *db
+    query: SELECT * from Customers
+  - data: categories
+    file: *db
+    query: SELECT CategoryID, CategoryName, Description FROM Categories
+  # Note that the CategoryID parameter in the query is coming from site.data.categories[].CategoryID
+  # which was picked up in the previous query
+  - data: categories.products
+    file: *db
+    query: SELECT ProductID, ProductName FROM Products WHERE Products.CategoryID=:CategoryID
 ```
 
 Then, you can use the `site.data` attributes accordingly:
 
 ```liquid
-{% 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.
-{% for user in site.data.verified %}
-- :check: {{user[0]}} (Email: {{user[1]}})
-{% endfor %}
+{{ site.data.categories | jsonify }}
 ```
 
 ## Generating Pages

data/lib/jekyll-sqlite/generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'sqlite3'
+require "sqlite3"
+
 module JekyllSQlite
   # Main generator class
   class Generator < Jekyll::Generator
@@ -14,22 +15,22 @@ module JekyllSQlite
     end
 
     # Get the root of where we are generating the data
-    def get_root(root, name)
-      name.split(".")[0..-2].each do |p|
+    def get_root(root, db_name)
+      db_name.split(".")[0..-2].each do |p|
         root = root[p]
       end
       root
     end
 
-    def gen_hash_data(root, db, _query)
+    def gen_hash_data(root, db, db_name, query)
       root ||= {}
 
-      root[name] = db.execute(config["query"])
-      root[name].size
+      root[db_name] = db.execute(query)
+      root[db_name].size
     end
 
-    def gen_nested_data(item, db, query, name)
-      item[name] = []
+    def gen_nested_data(item, db, query, db_name)
+      item[db_name] = []
       db.prepare(query) do |stmt|
         # We bind params, ignoring any errors
         # Since there's no way to get required params
@@ -38,30 +39,30 @@ module JekyllSQlite
           stmt.bind_param key, value
         rescue StandardError # rubocop:disable Lint/SuppressedException
         end
-        stmt.execute.each { |d| item[name] << d }
+        stmt.execute.each { |d| item[db_name] << d }
       end
-      item[name].size
+      item[db_name].size
     end
 
-    def array_gen(root, config, name, db)
+    def array_gen(root, config, db_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)
+          count += gen_nested_data(item, db, config["query"], db_name)
         else
-          Jekyll.logger.info "Jekyll SQLite:", "Item is not a hash for #{name}. Unsupported configuration"
+          Jekyll.logger.info "Jekyll SQLite:", "Item is not a hash for #{db_name}. Unsupported configuration"
         end
       end
       count
     end
 
-    def gen_data(root, config, name, db)
+    def gen_data(root, config, db_name, db)
       count = 0
       if root.nil? || (root.is_a? Hash)
-        count = gen_hash_data(root, db, config["query"])
+        count = gen_hash_data(root, db, db_name, config["query"])
       elsif root.is_a? Array
-        count = array_gen(root, config, name, db)
+        count = array_gen(root, config, db_name, db)
       end
       count
     end
@@ -70,15 +71,28 @@ module JekyllSQlite
       name.split(".")[-1]
     end
 
+    def validate_config(config)
+      return false unless config.is_a? Hash
+      return false unless config.key?("query")
+      return false unless File.exist?(config["file"])
+      return false unless config.key?("data")
+      true
+    end
+
     def generate(site)
-      site.config["sqlite"].each do |config|
-        name = config["data"]
+      gem_config = site.config['sqlite'] || []
+      gem_config.each do |config|
+        unless validate_config(config)
+          Jekyll.logger.error "Jekyll SQLite:", "Invalid Configuration. Skipping"
+          next
+        end
+        d_name = config["data"]
         SQLite3::Database.new config["file"], readonly: true do |db|
           fast_setup db
           db.results_as_hash = config.fetch("results_as_hash", true)
-          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}"
+          root = get_root(site.data, d_name)
+          count = gen_data(root, config, get_tip(d_name), db)
+          Jekyll.logger.info "Jekyll SQLite:", "Loaded #{d_name}. Count=#{count}"
         end
       end
     end

data/lib/jekyll-sqlite/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Sqlite
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sqlite
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nemo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -26,7 +26,7 @@ dependencies:
         version: '1.6'
 description:
 email:
-- jekyll@captnemo.in
+- jekyll-sqlite@captnemo.in
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,7 +35,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/jekyll-sqlite/generator.rb
@@ -64,9 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: A Jekyll plugin that lets you use SQLite database instead of data files as
-  a data source.
+summary: A Jekyll plugin to use SQLite databases as a data source.
 test_files: []

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll-sqlite (0.1.1)
-      sqlite3 (~> 1.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    json (2.6.3)
-    parallel (1.23.0)
-    parser (3.2.2.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rubocop (1.50.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
-      parser (>= 3.2.1.0)
-    rubocop-rake (0.6.0)
-      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!
-  rake (~> 13.0)
-  rubocop (~> 1.21)
-  rubocop-rake (~> 0.6.0)
-
-BUNDLED WITH
-   2.4.1