ordlite 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab34acd6766a0c9219ceb16dc38ca59bf19b33b7de6a54aed644b5680ec5563
-  data.tar.gz: 62411ce2e9563bb9387a1f1fe72b5bb53f408a644a10f846a6ec4664647282d4
+  metadata.gz: 349d70aaa528cdced0835181ca83ad5bb8815982bc60bc7f9d5535095131b322
+  data.tar.gz: 505f8f222ea148ca87f84080696cc0ec8d369a1a285aa50270ce8db6632ace96
 SHA512:
-  metadata.gz: edad4aa42248de21b75ba2c7a7d3a372fb23c671b1ee38d1f7fcb971a3f3f86afb8f0c532988091f528024cfc8e23b3f46e2c53c1995f2bb910f1de4dada62e3
-  data.tar.gz: 3a4a42f490533813a585e86e5edc7333462cb92684df9b0b761c2a44a0590dfac8acae49c6fcc630f785fe11bcb18b9ee340e169c90aced3e1d469539048cd21
+  metadata.gz: 4a1ecae2ec91d531ae6ff660dea7861243569f7c2009cbf48315e88a406ddbc0b9cdf91a8b29291b8e64e2f99d5051188662356a3bbf70efd394d4f7e7f13cfa
+  data.tar.gz: 50cc3f57b2cade5086a12a9c459469a991a667fe9b30431f2b2f6c957c1462430a41bbd6e2e50b635631668d4f6f3ef70aa54a6f6ec7a9d812a17c920b1031f2

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+### 0.1.1 / 2023-07-01
 ### 0.0.1 / 2023-07-01
 
 * Everything is new. First release

data/Manifest.txt

@@ -3,3 +3,10 @@ Manifest.txt
 README.md
 Rakefile
 lib/ordlite.rb
+lib/ordlite/base.rb
+lib/ordlite/cache.rb
+lib/ordlite/models/blob.rb
+lib/ordlite/models/forward.rb
+lib/ordlite/models/inscribe.rb
+lib/ordlite/schema.rb
+lib/ordlite/version.rb

data/Rakefile

@@ -1,9 +1,9 @@
 require 'hoe'
-## require './lib/ordlite/version.rb'
+require './lib/ordlite/version.rb'
 
 Hoe.spec 'ordlite' do
 
-  self.version =   '0.0.1'  ##Pixelart::Module::Ordgen::VERSION
+  self.version =  Ordlite::VERSION
 
 
   self.summary = "ordlite - ordinals inscription (on bitcoin & co) database let's you query via sql and more"
@@ -20,6 +20,11 @@ Hoe.spec 'ordlite' do
 
   self.extra_deps = [
     ['activerecord'],
+    ['activerecord-utils'],
+    ['logutils'],
+    ['logutils-activerecord'],
+    ['props'],
+    ['props-activerecord'],
     ['sqlite3'],
   ]
 

data/lib/ordlite/base.rb

@@ -0,0 +1,106 @@
+# core and stlibs
+
+require 'pp'
+require 'fileutils'
+require 'uri'
+require 'json'
+require 'yaml'
+
+require 'logger'    # Note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
+
+
+# 3rd party gems / libs
+require 'props'           # see github.com/rubylibs/props
+require 'logutils'        # see github.com/rubylibs/logutils
+
+
+require 'active_record'   ## todo: add sqlite3? etc.
+
+## add more activerecords addons/utils
+# require 'tagutils'
+require 'activerecord/utils'
+require 'props/activerecord'      # includes ConfDb (ConfDb::Model::Prop, etc.)
+require 'logutils/activerecord'   # includes LogDb (LogDb::Model::Log, etc.)
+
+
+
+# our own code
+require_relative 'version'   # always goes first
+
+require_relative 'models/forward'
+
+require_relative 'models/inscribe'
+require_relative 'models/blob'
+
+
+require_relative 'schema'      
+
+require_relative 'cache'
+
+
+
+module OrdDb
+
+  def self.create
+    CreateDb.new.up
+    ConfDb::Model::Prop.create!( key: 'db.schema.ord.version', 
+                                 value: Ordlite::VERSION )
+  end
+
+  def self.create_all
+    LogDb.create    # add logs table
+    ConfDb.create   # add props table
+    OrdDb.create
+  end
+
+  def self.connect( config={} )
+
+    if config.empty?
+      puts "ENV['DATBASE_URL'] - >#{ENV['DATABASE_URL']}<"
+
+      ### change default to ./ord.db ?? why? why not?
+      db = URI.parse( ENV['DATABASE_URL'] || 'sqlite3:///ord.db' )
+
+      if db.scheme == 'postgres'
+        config = {
+          adapter: 'postgresql',
+          host: db.host,
+          port: db.port,
+          username: db.user,
+          password: db.password,
+          database: db.path[1..-1],
+          encoding: 'utf8'
+        }
+      else # assume sqlite3
+       config = {
+         adapter: db.scheme, # sqlite3
+         database: db.path[1..-1] # ord.db (NB: cut off leading /, thus 1..-1)
+      }
+      end
+    end
+
+    puts "Connecting to db using settings: "
+    pp config
+    ActiveRecord::Base.establish_connection( config )
+    # ActiveRecord::Base.logger = Logger.new( STDOUT )
+  end
+
+
+  def self.setup_in_memory_db
+
+    # Database Setup & Config
+    ActiveRecord::Base.logger = Logger.new( STDOUT )
+    ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+    self.connect( adapter:  'sqlite3',
+                  database: ':memory:' )
+
+    ## build schema
+    OrdDb.create_all
+  end # setup_in_memory_db (using SQLite :memory:)
+
+end  # module OrdDb
+
+
+# say hello
+puts Ordlite.banner     ## if defined?($RUBYCOCOS_DEBUG) && $RUBCOCOS_DEBUG

data/lib/ordlite/cache.rb

@@ -0,0 +1,123 @@
+
+module OrdDb
+
+
+class  Cache   
+
+   Inscribe = Model::Inscribe
+   Blob     = Model::Blob
+
+def initialize( dir='.' )
+    @dir = dir
+end
+
+
+
+def import_all   
+   paths = Dir.glob( "#{@dir}/**.json" )
+   puts "  #{paths.size} inscribe datafile(s) found"
+
+   paths.each_with_index do |path, i|
+     puts "==> inscribe #{i+1}/#{paths.size}..."
+     data = _read_inscribe( path )
+     
+     Inscribe.create( _parse_inscribe( data ))
+   end
+
+
+   paths = Dir.glob( "#{@dir}/content/**.txt" )
+   puts "  #{paths.size} content datafile(s) found"
+
+   paths.each_with_index do |path, i|
+      puts "==> blob #{i+1}/#{paths.size}..."
+      content = _read_blob( path )
+      id      = File.basename( path, File.extname( path ))
+      
+      Blob.create( id: id,
+                   content: content )
+    end
+end
+
+
+def import( id )
+   data = read( id )  
+   rec = Inscribe.create( _parse_inscribe( data ))
+   rec
+end
+
+def read( id )
+   _read_inscribe( "#{@dir}/#{id}.json" ) 
+end
+
+def _read_inscribe( path )
+   JSON.parse( _read_text( path )) 
+end
+
+def _read_blob( path )
+   blob = File.open( path, 'rb' ) { |f| f.read } 
+   ## auto force to ASCII-7BIT if not already - why? why not?
+   blob
+end
+
+
+def _read_text( path )
+   File.open( path, 'r:utf-8' ){ |f| f.read } 
+end
+
+def _parse_inscribe( data )
+   ## num via title
+   attributes = {
+    id:  data['id'],
+    num: _title_to_num( data['title'] ),
+    bytes: _content_length_to_bytes( data['content length'] ), 
+    sat:  data['sat'].to_i(10),
+    content_type:  data['content type'],
+    block: data['genesis height'].to_i(10),
+    fee: data['genesis fee'].to_i(10),
+    tx: data['genesis transaction'],
+    address: data['address'],
+    output: data['output'],
+    value: data['output value'].to_i(10),
+    offset: data['offset'].to_i(10),
+    # "2023-06-01 05:00:57 UTC"
+    date:  DateTime.strptime( data['timestamp'], 
+                              '%Y-%m-%d %H:%M:%S %z')
+  }
+
+  attributes
+end
+
+
+
+    ##  "title": "Inscription 9992615",
+TITLE_RX = /^Inscription (?<num>[0-9]+)$/i
+
+def _title_to_num( str )
+   if m=TITLE_RX.match( str )
+      m[:num].to_i(10)    ## use base 10
+   else
+     puts "!! ERROR - no inscribe num found in title >#{str}<"
+     exit 1   ## not found - raise exception - why? why not?
+   end
+end
+
+CONTENT_LENGTH_RX = /^(?<num>[0-9]+) bytes$/i
+
+def _content_length_to_bytes( str )
+    if m=CONTENT_LENGTH_RX.match( str )
+       m[:num].to_i(10)    ## use base 10
+    else
+       puts "!! ERROR - bytes found in content lenght >#{str}<"
+       exit 1   ## not found - raise exception - why? why not?
+    end
+end
+ 
+
+
+
+end # class Cache
+end # module OrdDb
+
+
+
+

data/lib/ordlite/models/blob.rb

@@ -0,0 +1,11 @@
+
+module OrdDb
+    module Model
+  
+  class Blob < ActiveRecord::Base
+    belongs_to :inscribe, foreign_key: 'id'
+  end  # class Blob
+  
+    end # module Model
+end # module OrdDb
+  

data/lib/ordlite/models/forward.rb

@@ -0,0 +1,23 @@
+
+### forward references
+##   require first to resolve circular references
+
+module OrdDb
+  module Model
+
+#############
+# ConfDb
+Prop      = ConfDb::Model::Prop
+
+
+class Inscribe    < ActiveRecord::Base ; end
+class Blob        < ActiveRecord::Base ; end
+
+  end
+
+  # note: convenience alias for Model
+  # lets you use include OrdDb::Models
+  Models = Model   
+end # module # OrdDb
+
+

data/lib/ordlite/models/inscribe.rb

@@ -0,0 +1,11 @@
+
+module OrdDb
+    module Model
+  
+  class Inscribe < ActiveRecord::Base
+    has_one :blob, foreign_key: 'id'
+  end  # class Inscribe
+  
+    end # module Model
+end # module OrdDb
+  

data/lib/ordlite/schema.rb

@@ -0,0 +1,112 @@
+
+
+module OrdDb
+
+class CreateDb
+
+def up
+
+ActiveRecord::Schema.define do
+
+
+=begin
+   CREATE TABLE inscribes(
+    id varchar NOT NULL PRIMARY KEY, 
+    num integer NOT NULL, 
+    content_length integer NOT NULL, 
+    content_type varchar NOT NULL, 
+    date datetime(6) NOT NULL, 
+    sat integer NOT NULL, 
+    height integer NOT NULL, 
+    fee integer NOT NULL, 
+    tx varchar NOT NULL, 
+    offset integer NOT NULL, 
+    address varchar NOT NULL, 
+
+    created_at datetime(6) NOT NULL, 
+    updated_at datetime(6) NOT NULL)
+
+  CREATE TABLE blobs(
+    id varchar NOT NULL PRIMARY KEY, 
+    content blob NOT NULL
+    
+    created_at datetime(6) NOT NULL, 
+    updated_at datetime(6) NOT NULL)
+=end
+
+
+
+create_table :inscribes, :id => :string do |t|    
+    ## "id": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5ci0",
+    ## note: change to uuid (universally unique id) - why? why not?
+    ##        id gets used by row_id (internal orm db machinery) and is int
+   ## t.string   :uuid,  null: false, index: { unique: true, name: 'inscribe_uuids' }
+
+   ## "title": "Inscription 10371414",
+   ##   note: use num/no. from title only - why? why not?
+    t.integer  :num, null: false, index: { unique: true, name: 'inscribe_nums' }
+   
+    ##  "content length": "85 bytes",
+    ## note:  extract bytes as integer!!!
+    ##    change to bytes - why? why not?
+    t.integer  :bytes, null: false
+    ## "content type": "text/plain;charset=utf-8",
+    ## note: make sure always lower/down case!!!
+    t.string   :content_type, null: false
+
+    ## "timestamp": "2023-06-01 05:00:57 UTC"
+    ##   or use date_utc ???
+    t.datetime :date, null: false
+
+    ##
+    ## "sat": "967502783701719",
+    t.integer    :sat, null: false
+
+    ##
+    ## "genesis height": "792337",
+    ##   -> change height to block - why? why not?
+    ## "genesis fee": "6118",
+    ## "genesis transaction": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c",
+    ## "offset": "0"
+    t.integer    :block, null: false
+    t.integer    :fee, null: false
+    t.string     :tx, null: false
+    t.integer    :offset, null: false 
+   
+    ###
+    ## "address": "bc1p3h4eecuxjj2g72sq38gyva732866u5w29lhxgeqfe6c0sg8xmagsuau63k",
+    ##    is this minter/inscriber addr??? 
+    t.string     :address, null: false
+
+    ## "output": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c:0",
+    ##  "output value": "546",
+    t.string   :output, null: false
+    t.integer  :value,  null: false
+
+    ## -- ignore for now - why? why not?
+    ##   what is location  ???
+    ## "location": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c:0:0",
+
+  ## timestamp at last
+  t.timestamps
+end
+
+
+create_table :blobs, :id => :string do |t|
+    ## "id": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5ci0",
+    ## note: change to uuid (universally unique id) - why? why not?
+    ##        id gets used by row_id (internal orm db machinery) and is int
+    ## t.string   :id,  null: false, index: { unique: true, name: 'blob_uuids' }
+ 
+    t.binary     :content,   null: false
+
+  ## timestamp at last
+  t.timestamps
+end
+
+
+end # block Schema.define
+
+end # method up
+end # class CreateDb
+end # module OrdDb

data/lib/ordlite/version.rb

@@ -0,0 +1,22 @@
+
+module Ordlite
+
+  # sync version w/ sport.db n friends - why? why not?
+  MAJOR = 0 ## todo: namespace inside version or something - why? why not??
+  MINOR = 1
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "ordlite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in >#{root}<"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end

data/lib/ordlite.rb

@@ -1,3 +1,12 @@
 
-puts "hello, ordlite!"
+require_relative 'ordlite/base'
+
+
+## add convenience helpers
+##  use require 'ordlite/base' if you do NOT want automagic aliases
+
+
+Inscribe = OrdDb::Model::Inscribe
+Blob     = OrdDb::Model::Blob
+
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ordlite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
@@ -24,6 +24,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-utils
+  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: logutils
+  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: logutils-activerecord
+  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: props
+  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: props-activerecord
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +157,13 @@ files:
 - README.md
 - Rakefile
 - lib/ordlite.rb
+- lib/ordlite/base.rb
+- lib/ordlite/cache.rb
+- lib/ordlite/models/blob.rb
+- lib/ordlite/models/forward.rb
+- lib/ordlite/models/inscribe.rb
+- lib/ordlite/schema.rb
+- lib/ordlite/version.rb
 homepage: https://github.com/ordbase/generative-orc-721
 licenses:
 - Public Domain