litestack 0.2.3 → 0.3.0

data/lib/litestack/litesupport.rb

@@ -4,47 +4,66 @@ require 'sqlite3'
 require 'logger'
 require 'oj'
 require 'yaml'
+require 'pathname'
+require 'fileutils'
 
 module Litesupport
 
   class Error < StandardError; end
   
-  # cache the environment we are running in
-  # it is an error to change the environment for a process 
-  # or for a child forked from that process
-  def self.environment
-    @env ||= detect_environment
-  end
-  
   def self.max_contexts
-    return 50 if environment == :fiber || environment == :polyphony
+    return 50 if scheduler == :fiber || scheduler == :polyphony
     5    
   end
-    
-  # identify which environment we are running in
-  # we currently support :fiber, :polyphony, :iodine & :threaded
-  # in the future we might want to expand to other environments
+
+  # Detect the Rack or Rails environment.
   def self.detect_environment
+    if defined? Rails
+      Rails.env
+    elsif ENV["RACK_ENV"]
+      ENV["RACK_ENV"]
+    elsif ENV["APP_ENV"]
+      ENV["APP_ENV"]
+    else
+      "development"
+    end
+  end
+
+  def self.environment
+    @environment ||= detect_environment
+  end
+
+  # cache the scheduler we are running in
+  # it is an error to change the scheduler for a process
+  # or for a child forked from that process
+  def self.scheduler
+    @scehduler ||= detect_scheduler
+  end
+
+  # identify which scheduler we are running in
+  # we currently support :fiber, :polyphony, :iodine & :threaded
+  # in the future we might want to expand to other schedulers
+  def self.detect_scheduler
     return :fiber if Fiber.scheduler 
     return :polyphony if defined? Polyphony
     return :iodine if defined? Iodine
-    return :threaded # fall back for all other environments
+    return :threaded # fall back for all other schedulers
   end
   
   # spawn a new execution context
   def self.spawn(&block)
-    if self.environment == :fiber
+    if self.scheduler == :fiber
       Fiber.schedule(&block)
-    elsif self.environment == :polyphony
+    elsif self.scheduler == :polyphony
       spin(&block)
-    elsif self.environment == :threaded or self.environment == :iodine
+    elsif self.scheduler == :threaded or self.scheduler == :iodine
       Thread.new(&block)
     end
     # we should never reach here
   end
-    
+
   def self.context
-    if environment == :fiber || environment == :poylphony
+    if scheduler == :fiber || scheduler == :poylphony
       Fiber.current.storage
     else
       Thread.current
@@ -52,7 +71,7 @@ module Litesupport
   end
   
   def self.current_context
-    if environment == :fiber || environment == :poylphony
+    if scheduler == :fiber || scheduler == :poylphony
       Fiber.current
     else
       Thread.current
@@ -61,10 +80,10 @@ module Litesupport
   
   # switch the execution context to allow others to run
   def self.switch
-    if self.environment == :fiber
+    if self.scheduler == :fiber
       Fiber.scheduler.yield
       true
-    elsif self.environment == :polyphony
+    elsif self.scheduler == :polyphony
       Fiber.current.schedule
       Thread.current.switch_fiber
       true
@@ -80,12 +99,12 @@ module Litesupport
     @@mutex ||= Mutex.new
   end
   
-  # bold assumption, we will only synchronize threaded code
-  # if some code explicitly wants to synchronize a fiber
+  # bold assumption, we will only synchronize threaded code!
+  # If some code explicitly wants to synchronize a fiber
   # they must send (true) as a parameter to this method
   # else it is a no-op for fibers
   def self.synchronize(fiber_sync = false, &block)
-    if self.environment == :fiber or self.environment == :polyphony
+    if self.scheduler == :fiber or self.scheduler == :polyphony
       yield # do nothing, just run the block as is
     else
       self.mutex.synchronize(&block)
@@ -103,7 +122,30 @@ module Litesupport
     end
     db
   end
-  
+
+  # Databases will be stored by default at this path.
+  def self.root
+    @root ||= ensure_root_volume detect_root
+  end
+
+  # Default path where we'll store all of the databases.
+  def self.detect_root
+    path = if ENV["LITESTACK_DATA_PATH"]
+      ENV["LITESTACK_DATA_PATH"]
+    elsif defined? Rails
+      "./db"
+    else
+      "."
+    end
+
+    Pathname.new(path).join(Litesupport.environment)
+  end
+
+  def self.ensure_root_volume(path)
+    FileUtils.mkdir_p path unless path.exist?
+    path
+  end
+
   class Mutex
   
     def initialize
@@ -111,7 +153,7 @@ module Litesupport
     end
     
     def synchronize(&block)
-      if Litesupport.environment == :threaded || Litesupport.environment == :iodine
+      if Litesupport.scheduler == :threaded || Litesupport.scheduler == :iodine
         @mutex.synchronize{ block.call }
       else
         block.call
@@ -120,21 +162,6 @@ module Litesupport
   
   end
    
-  module Forkable
-    
-    def _fork(*args)
-      ppid = Process.pid
-      result = super      
-      if Process.pid != ppid
-        # trigger a restart of all connections owned by Litesupport::Pool
-      end
-      result
-    end
-    
-  end
-
-  #::Process.singleton_class.prepend(::Litesupport::Forkable)
-  
   class Pool
   
     def initialize(count, &block)
@@ -188,7 +215,7 @@ module Litesupport
     def _fork(*args)
       ppid = Process.pid
       result = super
-      if Process.pid != ppid && [:threaded, :iodine].include?(Litesupport.environment)
+      if Process.pid != ppid && [:threaded, :iodine].include?(Litesupport.scheduler)
         ForkListener.listeners.each{|l| l.call }
       end
       result
@@ -201,6 +228,11 @@ module Litesupport
     include Forkable
 
     # close, setup, run_stmt and run_sql assume a single connection was created
+    
+    def options
+      @options
+    end
+    
     def close
       @running = false
       @conn.acquire do |q| 
@@ -209,6 +241,22 @@ module Litesupport
       end
     end
 
+    def size
+      run_sql("SELECT size.page_size * count.page_count FROM pragma_page_size() AS size, pragma_page_count() AS count")[0][0].to_f / (1024*1024)
+    end
+
+    def journal_mode
+      run_method(:journal_mode)
+    end
+    
+    def synchronous
+      run_method(:synchronous)
+    end
+    
+    def path
+      run_method(:filename)
+    end
+    
     private # all methods are private
         
     def init(options = {})
@@ -224,22 +272,14 @@ module Litesupport
       Litesupport::ForkListener.listen do
         setup
       end
-    end  
-    
+    end
+
     def configure(options = {})
-      # detect environment (production, development, etc.)
-      env = "development"
-      if defined? Rails
-        env = ENV["RAILS_ENV"]
-      elsif ENV["RACK_ENV"]
-        env = ENV["RACK_ENV"]  
-      elsif ENV["APP_ENV"]
-        env = ENV["RACK_ENV"]
-      end      
+      # detect enviornment (production, development, etc.)
       defaults = self.class::DEFAULT_OPTIONS rescue {}
       @options = defaults.merge(options)
       config = YAML.load_file(@options[:config_path]) rescue {} # an empty hash won't hurt
-      config = config[env] if config[env] # if there is a config for the current environment defined then use it, otherwise use the top level declaration
+      config = config[Litesupport.environment] if config[Litesupport.environment] # if there is a config for the current enviornment defined then use it, otherwise use the top level declaration
       config.keys.each do |k| # symbolize keys
         config[k.to_sym] = config[k]
         config.delete k
@@ -266,7 +306,7 @@ module Litesupport
     def exit_callback
       close
     end
-
+    
     def run_stmt(stmt, *args)
       @conn.acquire{|q| q.stmts[stmt].execute!(*args) }
     end
@@ -275,12 +315,21 @@ module Litesupport
       @conn.acquire{|q| q.execute(sql, *args) }
     end
     
+    def run_method(method, *args)
+      @conn.acquire{|q| q.send(method, *args)}
+    end
+
+    def run_stmt_method(stmt, method, *args)
+      @conn.acquire{|q| q.stmts[stmt].send(method, *args)}
+    end
+
+    
     def create_pooled_connection(count = 1)
       Litesupport::Pool.new(1){create_connection}  
     end
 
     # common db object options
-    def create_connection
+    def create_connection(path_to_sql_file = nil)
       conn = SQLite3::Database.new(@options[:path])
       conn.busy_handler{ Litesupport.switch || sleep(rand * 0.002) }
       conn.journal_mode = "WAL"
@@ -290,9 +339,40 @@ module Litesupport
       class << conn
         attr_reader :stmts
       end
+      yield conn if block_given?
+      # use the <client>.sql.yml file to define the schema and compile prepared statements
+      unless path_to_sql_file.nil?
+        sql = YAML.load_file(path_to_sql_file)
+        version = conn.get_first_value("PRAGMA user_version")
+        sql["schema"].each_pair do |v, obj| 
+          if v > version
+            conn.transaction do 
+              obj.each do |k, s| 
+                begin
+                  conn.execute(s)
+                rescue Exception => e
+                  STDERR.puts "Error parsing #{k}"
+                  STDERR.puts s
+                  raise e               
+                end
+              end
+              conn.user_version = v
+            end
+          end
+        end 
+        sql["stmts"].each do |k, v| 
+          begin
+            conn.stmts[k.to_sym] = conn.prepare(v)
+          rescue Exception => e
+            STDERR.puts "Error parsing #{k}"
+            STDERR.puts v
+            raise e               
+          end
+        end
+      end
       conn
     end
-    
+        
   end
       
 end  

data/lib/litestack/railtie.rb

@@ -0,0 +1,10 @@
+require "rails/railtie"
+
+module Litestack
+  class Railtie < ::Rails::Railtie
+    initializer :disable_production_sqlite_warning do |app|
+      # The whole point of this gem is to use sqlite3 in production.
+      app.config.active_record.sqlite3_production_warning = false
+    end
+  end
+end

data/lib/litestack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Litestack
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end       

data/lib/litestack.rb

@@ -16,6 +16,7 @@ require_relative "./railties/rails/commands/dbconsole" if defined? Rails && defi
 require_relative "./active_support/cache/litecache" if defined? ActiveSupport
 require_relative "./active_job/queue_adapters/litejob_adapter" if defined? ActiveJob
 require_relative "./action_cable/subscription_adapter/litecable" if defined? ActionCable
+require_relative "./litestack/railtie" if defined? Rails::Railtie
 
 module Litestack
   class NotImplementedError < Exception; end

data/lib/sequel/adapters/litedb.rb

@@ -15,7 +15,7 @@ module Sequel
       
       def connect(server)
       
-        Sequel.extension :fiber_concurrency if [:fiber, :polyphony].include? Litesupport.environment
+        Sequel.extension :fiber_concurrency if [:fiber, :polyphony].include? Litesupport.scheduler
       
         opts = server_opts(server)
         opts[:database] = ':memory:' if blank_object?(opts[:database])

data/template.rb

@@ -0,0 +1,7 @@
+# Run `rails new my-app -m https://raw.githubusercontent.com/bradgessler/litestack/master/template.rb`
+# to create a new Rails app with Litestack pre-installed.
+gem "litestack", github: "bradgessler/litestack"
+
+after_bundle do
+  generate "litestack:install"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litestack
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Mohamed Hassan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -38,10 +38,67 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: hanami-router
+  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: tilt
+  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: erubi
+  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'
 description: 
 email:
 - oldmoe@gmail.com
-executables: []
+executables:
+- liteboard
 extensions: []
 extra_rdoc_files: []
 files:
@@ -52,12 +109,15 @@ files:
 - README.md
 - Rakefile
 - WHYLITESTACK.md
+- assets/event_page.png
+- assets/index_page.png
 - assets/litecable_logo_teal.png
 - assets/litecache_logo_teal.png
 - assets/litedb_logo_teal.png
 - assets/litejob_logo_teal.png
 - assets/litestack_logo_teal.png
 - assets/litestack_logo_teal_large.png
+- assets/topic_page.png
 - bench/bench.rb
 - bench/bench_cache_rails.rb
 - bench/bench_cache_raw.rb
@@ -67,11 +127,25 @@ files:
 - bench/rails_job.rb
 - bench/skjob.rb
 - bench/uljob.rb
+- bin/liteboard
 - lib/action_cable/subscription_adapter/litecable.rb
 - lib/active_job/queue_adapters/litejob_adapter.rb
 - lib/active_record/connection_adapters/litedb_adapter.rb
 - lib/active_support/cache/litecache.rb
+- lib/generators/litestack/install/USAGE
+- lib/generators/litestack/install/install_generator.rb
+- lib/generators/litestack/install/templates/cable.yml
+- lib/generators/litestack/install/templates/database.yml
 - lib/litestack.rb
+- lib/litestack/liteboard/liteboard.rb
+- lib/litestack/liteboard/views/event.erb
+- lib/litestack/liteboard/views/index.erb
+- lib/litestack/liteboard/views/layout.erb
+- lib/litestack/liteboard/views/litecable.erb
+- lib/litestack/liteboard/views/litecache.erb
+- lib/litestack/liteboard/views/litedb.erb
+- lib/litestack/liteboard/views/litejob.erb
+- lib/litestack/liteboard/views/topic.erb
 - lib/litestack/litecable.rb
 - lib/litestack/litecable.sql.yml
 - lib/litestack/litecache.rb
@@ -82,15 +156,17 @@ files:
 - lib/litestack/litejobqueue.rb
 - lib/litestack/litemetric.rb
 - lib/litestack/litemetric.sql.yml
+- lib/litestack/litemetric_collector.sql.yml
 - lib/litestack/litequeue.rb
 - lib/litestack/litequeue.sql.yml
 - lib/litestack/litesupport.rb
-- lib/litestack/metrics_app.rb
+- lib/litestack/railtie.rb
 - lib/litestack/version.rb
 - lib/railties/rails/commands/dbconsole.rb
 - lib/sequel/adapters/litedb.rb
 - lib/sequel/adapters/shared/litedb.rb
 - samples/ultrajob.yaml
+- template.rb
 homepage: http://github.com/oldmoe/litestack
 licenses:
 - MIT
@@ -115,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: A SQLite based, lightning fast, super efficient and dead simple to setup

data/lib/litestack/metrics_app.rb

@@ -1,5 +0,0 @@
-require_relative '../lib/litestack/litemetrics'
-
-metric = Litemetrics.instance
-
-puts metric.ids