extralite 1.25 → 1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a6e8245385b707be08a300ff6bb089291cfa27500fd99f35698f3dc566147e0
-  data.tar.gz: 1bc49ffc376a8e8f17da33cda6afdd59299e9d6dac381ef2ff9c7ea8d3a92418
+  metadata.gz: 459a362b27b2061131a291b8e8b7f73fbc226847f17973de29771af1b3ff694c
+  data.tar.gz: 0774ca30f4107711a9fe79ffde59e606073bf5f95c0de1f12bc0e1c14876560a
 SHA512:
-  metadata.gz: 1e119afa5f07f499935cd83692cb86c22c548ed7f4e35b46735860349186e66c5b1cd1ca2b32cbc8aa41c1e9106c942d38958b145480b397d838a5d75d32985f
-  data.tar.gz: 28f0b76e7ed23e51b9f99f7a8756534163330f909668d7f2d1fa34bd1517ee37ccfdcffe18028fa51cbf427353f313256832daead4ed09a00742a4bd24236744
+  metadata.gz: 6b7ca365d43357ebbdaed90d18299bdae324fc2526c5206c5810c447bf59aecd56202991a5d46290da3097d6a73605297cb6ed769b53e402b6e1d18099c054d0
+  data.tar.gz: b6f2b2a578896df9154e3db60a0f84a6afc5c0fee6d4a650b259d3f757dda94c763ad37a6d9c6e428cc92db8311acb0861072b63cfd841d3eb6fca2e84dd3d60

data/.github/FUNDING.yml

@@ -1 +1 @@
-github: ciconia
+github: noteflakes

data/.yardopts

@@ -0,0 +1,8 @@
+-o ./_yardoc
+-m markdown -M redcarpet
+--verbose
+--protected
+--no-private
+--exclude sqlite3_constants.rb
+./lib
+./ext/extralite

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.26 2023-05-17
+
+- Improve documentation
+
 # 1.25 2023-03-10
 
 - Remove bundled sqlite3 source files from extralite.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    extralite (1.25)
+    extralite (1.26)
 
 GEM
   remote: https://rubygems.org/

data/ext/extralite/extconf.rb

@@ -56,6 +56,7 @@ else
     $CFLAGS << ' -DTAINTING_SUPPORT'
   end
   
+  # @!visibility private
   def asplode missing
     if RUBY_PLATFORM =~ /mingw|mswin/
       abort "#{missing} is missing. Install SQLite3 from " +

data/ext/extralite/prepared_statement.c

@@ -1,6 +1,12 @@
 #include <stdio.h>
 #include "extralite.h"
 
+/*
+ * Document-class: Extralite::PreparedStatement
+ *
+ * This class represents a prepared statement.
+ */
+
 VALUE cPreparedStatement;
 
 static size_t PreparedStatement_size(const void *ptr) {

data/lib/extralite/sqlite3_constants.rb

@@ -1,5 +1,4 @@
 module Extralite
-
   SQLITE_STATUS_MEMORY_USED           =  0
   SQLITE_STATUS_PAGECACHE_USED        =  1
   SQLITE_STATUS_PAGECACHE_OVERFLOW    =  2

data/lib/extralite/version.rb

@@ -1,3 +1,4 @@
 module Extralite
-  VERSION = '1.25'
+  # Extralite version
+  VERSION = '1.26'
 end

data/lib/extralite.rb

@@ -29,6 +29,7 @@ module Extralite
   class Database
     alias_method :execute, :query
 
+    # @!visibility private
     TABLES_SQL = <<~SQL
       SELECT name FROM sqlite_master
       WHERE type ='table'

data/lib/sequel/adapters/extralite.rb

@@ -7,22 +7,28 @@
 require 'extralite'
 require 'sequel/adapters/shared/sqlite'
 
+# @!visibility private
 module Sequel
+  # Extralite Sequel adapter
   module Extralite
+    # @!visibility private
     FALSE_VALUES = (%w'0 false f no n'.each(&:freeze) + [0]).freeze
 
     blob = Object.new
+    # @!visibility private
     def blob.call(s)
       Sequel::SQL::Blob.new(s.to_s)
     end
 
     boolean = Object.new
+    # @!visibility private
     def boolean.call(s)
       s = s.downcase if s.is_a?(String)
       !FALSE_VALUES.include?(s)
     end
 
     date = Object.new
+    # @!visibility private
     def date.call(s)
       case s
       when String
@@ -37,22 +43,26 @@ module Sequel
     end
 
     integer = Object.new
+    # @!visibility private
     def integer.call(s)
       s.to_i
     end
 
     float = Object.new
+    # @!visibility private
     def float.call(s)
       s.to_f
     end
 
     numeric = Object.new
+    # @!visibility private
     def numeric.call(s)
       s = s.to_s unless s.is_a?(String)
       BigDecimal(s) rescue s
     end
 
     time = Object.new
+    # @!visibility private
     def time.call(s)
       case s
       when String
@@ -82,8 +92,10 @@ module Sequel
     end
     SQLITE_TYPES.freeze
 
+    # @!visibility private
     USE_EXTENDED_RESULT_CODES = false
     
+    # Database adapter for Sequel
     class Database < Sequel::Database
       include ::Sequel::SQLite::DatabaseMethods
       
@@ -157,10 +169,12 @@ module Sequel
         end
       end
       
+      # @!visibility private
       def execute_insert(sql, opts=OPTS)
         _execute(:insert, sql, opts)
       end
       
+      # @!visibility private
       def freeze
         @conversion_procs.freeze
         super
@@ -298,9 +312,11 @@ module Sequel
       end
     end
     
+    # Dataset adapter for Sequel
     class Dataset < Sequel::Dataset
       include ::Sequel::SQLite::DatasetMethods
 
+      # @!visibility private
       module ArgumentMapper
         include Sequel::Dataset::ArgumentMapper
         
@@ -323,9 +339,12 @@ module Sequel
         end
       end
       
+      # @!visibility private
       BindArgumentMethods = prepared_statements_module(:bind, ArgumentMapper)
+      # @!visibility private
       PreparedStatementMethods = prepared_statements_module(:prepare, BindArgumentMethods)
 
+      # @!visibility private
       def fetch_rows(sql, &block)
         execute(sql, &block)
         # execute(sql) do |result|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: '1.25'
+  version: '1.26'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -91,6 +91,7 @@ files:
 - ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock