litedb 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23fe5303539c84fa0323b9b1d4f875c9fee899f2c8cedf9abfe37ed18ee6d17e
-  data.tar.gz: baad8c74278a8d2efc7781c7692789abeeef52b5e37917a844c4bef335fa621b
+  metadata.gz: '03940873fc6d049cf80790e80b04325ad29d0b51af711ad5dc4442df01396cb5'
+  data.tar.gz: ce364a86c99bc2ad9211163f606a850b9f943838579ec3d53225de7fb7fcd41d
 SHA512:
-  metadata.gz: 5842f4d166945c9c8ef0e3a41c7c767378cb4b7386b4cfa98758e6796419d3e7b042698f02762ae3cc7a1df0feced037db75a7569d3cc48c6acdba9d747b5e6e
-  data.tar.gz: be7703fecba593e2e5342ae59a5bd31d2ab9934c5d6678484dfb5c6b83f24fc9e4268938ba3d05eb8ca0bf6ba11f7f13dfd1a22427d882d630b68caa107e2bbf
+  metadata.gz: 2392eabd26b22e60b87559d984481c7b1d029df091a22994cbabedd42bc8fc5700423c840c749eee0e72d1b8a5c5658d91df262bfdd7124601014cff0cb128db
+  data.tar.gz: 104675e33444e702ffaba66e1908464800f5432ee00bbc717bb0514ad8f983b308ed9355650193f4ef790d5f36a6a7cc5bf5372ac6add652f85a4c95b0f00306

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2023-08-11
+
+- Move the `SQLite3::Database` wrapper to `Litedb::Connection` class. This both makes it easier to extend the gem to wrap other SQLite3 classes (like `Statement`) and also makes dealing with the VERSION reasonable (and possible). Keeping VERSION in a separate file proved impossible when having Litedb be a class that inherited from SQLite3::Database, because the gemspec needed the version before sqlite3 was required.
+
+## [0.2.0] - 2023-08-10
+
+- Initial release of usable code
+
 ## [0.1.0] - 2023-08-09
 
-- Initial release
+- Initial release to reserve gem name

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    litedb (0.1.0)
+    litedb (0.2.1)
+      litescheduler (>= 0.2.0)
+      sqlite3 (>= 1.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    docile (1.4.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    litescheduler (0.2.1)
     minitest (5.19.0)
     parallel (1.23.0)
     parser (3.2.2.3)
@@ -36,6 +40,14 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (1.6.3-arm64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
     standard (1.30.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -52,11 +64,13 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   litedb!
   minitest (~> 5.0)
   rake (~> 13.0)
+  simplecov
   standard (~> 1.3)
 
 BUNDLED WITH

data/lib/litedb/connection.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+require "litescheduler"
+
+module Litedb
+  class Connection < SQLite3::Database
+    DEFAULT_FILE = ":memory:"
+    DEFAULT_OPTIONS = {
+      synchronous: :NORMAL,
+      mmap_size: 32 * 1024, # 32 kilobytes
+      journal_size_limit: 64 * 1024 * 1024 # 64 megabytes
+    }.freeze
+
+    attr_reader :config
+
+    def initialize(file = nil, options = {}, zvfs = nil)
+      @scheduler = Litescheduler.instance
+      file ||= DEFAULT_FILE
+      options = options.transform_keys { |key|
+        begin
+          key.to_sym
+        rescue
+          key
+        end
+      }
+      @config = DEFAULT_OPTIONS.merge(options)
+
+      super(file, @config, zvfs)
+
+      set_pragmas
+      run_migrations
+      prepare_statements
+    end
+
+    def run_statement(statement, *args)
+      statements[statement].execute!(*args)
+    end
+
+    private
+
+    def set_pragmas
+      # set a custom busy handler to override the `busy_timeout`
+      # this ensures we either switch to another execution context or try again to connect
+      # https://www.sqlite.org/pragma.html#pragma_busy_timeout
+      busy_handler { @scheduler.switch || sleep(rand * 0.001) }
+      # Journal mode WAL allows for greater concurrency (many readers + one writer)
+      # https://www.sqlite.org/pragma.html#pragma_journal_mode
+      self.journal_mode = :WAL
+      # level of database durability
+      # 2 = "FULL" (sync on every write)
+      # 1 = "NORMAL" (sync every 1000 written pages)
+      # 0 = "OFF" (don't sync)
+      # https://www.sqlite.org/pragma.html#pragma_synchronous
+      self.synchronous = @config[:synchronous]
+      # set the global memory map so all processes can share data
+      # https://www.sqlite.org/pragma.html#pragma_mmap_size
+      # https://www.sqlite.org/mmap.html
+      self.mmap_size = @config[:mmap_size]
+      # impose a limit on the WAL file to prevent unlimited growth (with a negative impact on read performance as well)
+      # https://www.sqlite.org/pragma.html#pragma_journal_size_limit
+      self.journal_size_limit = @config[:journal_size_limit]
+    end
+
+    def run_migrations
+      return if @config[:migrations].nil?
+
+      migrations = if @config[:migrations].is_a?(Hash)
+        @config[:migrations].values
+      elsif @config[:migrations].is_a?(Array)
+        @config[:migrations]
+      else
+        raise Error.new("`migrations` option must be either a Hash or an Array")
+      end
+
+      transaction(:immediate) do
+        migrations.each do |sql|
+          execute(clean_sql(sql))
+        end
+      end
+    end
+
+    def prepare_statements
+      instance_variable_set(:@statements, {})
+      self.class.attr_reader(:statements) unless respond_to?(:statements)
+
+      return if @config[:statements].nil?
+
+      @config[:statements].each do |key, sql|
+        statements[key.to_sym] = prepare(clean_sql(sql))
+      end
+    end
+
+    def clean_sql(sql)
+      sql.gsub(/[[:space:]]+/, " ").strip
+    end
+  end
+end

data/lib/litedb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Litedb
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/litedb.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "litedb/version"
+require_relative "litedb/connection"
+
+require "sqlite3"
+require "litescheduler"
 
 module Litedb
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: litedb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mohamed Hassan
@@ -9,8 +9,50 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.5.0
+- !ruby/object:Gem::Dependency
+  name: litescheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - oldmoe@gmail.com
@@ -28,6 +70,7 @@ files:
 - README.md
 - Rakefile
 - lib/litedb.rb
+- lib/litedb/connection.rb
 - lib/litedb/version.rb
 - sig/litedb.rbs
 homepage: https://github.com/litestack-ruby/litedb