pakyow-data 1.0.0.rc1

data/lib/pakyow/data/tasks/bootstrap.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "pakyow/data/migrator"
+
+namespace :db do
+  desc "Bootstrap a database"
+  option :adapter, "The adapter to migrate"
+  option :connection, "The connection to migrate"
+  task :bootstrap, [:adapter, :connection] do |_, args|
+    %w[
+      db:create
+      db:migrate
+    ].each do |task|
+      Pakyow.logger.info "[db:bootstrap] running: #{task}"
+      Rake::Task[task].invoke(args[:adapter], args[:connection])
+    end
+  end
+end

data/lib/pakyow/data/tasks/create.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "pakyow/data/migrator"
+
+namespace :db do
+  desc "Create a database"
+  option :adapter, "The adapter to migrate"
+  option :connection, "The connection to migrate"
+  task :create, [:adapter, :connection] do |_, args|
+    unless Pakyow.booted?
+      Pakyow.boot(unsafe: true)
+    end
+
+    migrator = Pakyow::Data::Migrator.connect_global(
+      adapter: args[:adapter],
+      connection: args[:connection]
+    )
+
+    migrator.create!
+    migrator.disconnect!
+  end
+end

data/lib/pakyow/data/tasks/drop.rake

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "pakyow/data/migrator"
+
+namespace :db do
+  desc "Drop a database"
+  option :adapter, "The adapter to migrate"
+  option :connection, "The connection to migrate"
+  task :drop, [:adapter, :connection] do |_, args|
+    unless Pakyow.booted?
+      Pakyow.boot(unsafe: true)
+    end
+
+    begin
+      if connection = Pakyow.connection(args[:adapter], args[:connection])
+        connection.disconnect
+      end
+    # rubocop:disable Lint/HandleExceptions
+    rescue ArgumentError
+      # catch the case where the connection doesn't exist
+    end
+    # rubocop:enable Lint/HandleExceptions
+
+    migrator = Pakyow::Data::Migrator.connect_global(
+      adapter: args[:adapter],
+      connection: args[:connection]
+    )
+
+    migrator.drop!
+    migrator.disconnect!
+  end
+end

data/lib/pakyow/data/tasks/finalize.rake

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "pakyow/data/migrator"
+
+namespace :db do
+  desc "Finalize a database"
+  option :adapter, "The adapter to migrate"
+  option :connection, "The connection to migrate"
+  task :finalize, [:adapter, :connection] do |_, args|
+    unless Pakyow.booted?
+      Pakyow.boot(unsafe: true)
+    end
+
+    opts = {
+      adapter: args[:adapter],
+      connection: args[:connection],
+      connection_overrides: {
+        path: -> (connection_path) {
+          "#{connection_path}-migrator"
+        }
+      }
+    }
+
+    # Use a global connection for creating the database.
+    #
+    global_migrator = Pakyow::Data::Migrator.connect_global(opts)
+
+    # Create the migrator database unless it exists.
+    #
+    global_migrator.create!
+
+    # Use a normal migrator for migrating.
+    #
+    migrator = Pakyow::Data::Migrator.connect(opts)
+
+    # Run the existing migrations on it.
+    #
+    migrator.migrate!
+
+    # Create migrations for unmigrated schema.
+    #
+    migrator.finalize!
+
+    # Disconnect.
+    #
+    migrator.disconnect!
+
+    # Drop the migrator database.
+    #
+    global_migrator.drop!
+
+    # Disconnect the migrator database.
+    #
+    global_migrator.disconnect!
+  end
+end

data/lib/pakyow/data/tasks/migrate.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "pakyow/data/migrator"
+
+namespace :db do
+  desc "Migrate a database"
+  option :adapter, "The adapter to migrate"
+  option :connection, "The connection to migrate"
+  task :migrate, [:adapter, :connection] do |_, args|
+    Pakyow.config.data.auto_migrate = false
+
+    unless Pakyow.booted?
+      Pakyow.boot(unsafe: true)
+    end
+
+    migrator = Pakyow::Data::Migrator.connect(
+      adapter: args[:adapter],
+      connection: args[:connection]
+    )
+
+    migrator.migrate!
+    migrator.disconnect!
+  end
+end

data/lib/pakyow/data/tasks/reset.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "pakyow/data/migrator"
+
+namespace :db do
+  desc "Reset a database"
+  option :adapter, "The adapter to migrate"
+  option :connection, "The connection to migrate"
+  task :reset, [:adapter, :connection] do |_, args|
+    %w[
+      db:drop
+      db:bootstrap
+    ].each do |task|
+      Pakyow.logger.info "[db:reset] running: #{task}"
+      Rake::Task[task].invoke(args[:adapter], args[:connection])
+    end
+  end
+end

data/lib/pakyow/data/types.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "dry-types"
+
+module Pakyow
+  module Data
+    module Types
+      include Dry.Types(default: :nominal)
+
+      MAPPING = {
+        boolean: Bool.meta(mapping: :boolean),
+        date: Date.meta(mapping: :date),
+        datetime: DateTime.meta(mapping: :datetime),
+        decimal: Coercible::Decimal.meta(mapping: :decimal),
+        float: Coercible::Float.meta(mapping: :float),
+        integer: Coercible::Integer.meta(mapping: :integer),
+        string: Coercible::String.meta(mapping: :string),
+        time: Time.meta(mapping: :time)
+      }.freeze
+
+      def self.type_for(type, additional_types = {})
+        if type.is_a?(Dry::Types::Type)
+          type
+        else
+          type = type.to_sym
+          additional_types.to_h.fetch(type) {
+            MAPPING.fetch(type)
+          }
+        end
+      rescue KeyError => error
+        raise UnknownType.build(error, type: type, context: {
+          type: type, types: MAPPING.keys
+        })
+      end
+    end
+  end
+end

data/lib/pakyow/data.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "pakyow"
+require "pakyow/routing"
+
+require "pakyow/data/connection"
+
+Pakyow::Data::Connection.register_adapter :sql
+
+require "pakyow/data/errors"
+require "pakyow/data/framework"
+
+require "pakyow/environment/data/auto_migrate"
+require "pakyow/environment/data/config"
+require "pakyow/environment/data/connections"
+require "pakyow/environment/data/memory_db"
+
+require "pakyow/validations/unique"
+
+module Pakyow
+  config.tasks.paths << File.expand_path("../data/tasks", __FILE__)
+
+  include Environment::Data::AutoMigrate
+  include Environment::Data::Config
+  include Environment::Data::Connections
+  include Environment::Data::MemoryDB
+end

data/lib/pakyow/environment/data/auto_migrate.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "pakyow/support/extension"
+
+module Pakyow
+  module Environment
+    module Data
+      module AutoMigrate
+        extend Support::Extension
+
+        apply_extension do
+          after "boot" do
+            if Pakyow.config.data.auto_migrate || Pakyow.config.data.auto_migrate_always.any?
+              require "pakyow/data/migrator"
+
+              @data_connections.values.flat_map(&:values)
+                .select(&:connected?)
+                .select(&:auto_migrate?)
+                .select { |connection|
+                  Pakyow.config.data.auto_migrate || Pakyow.config.data.auto_migrate_always.include?(connection.name)
+                }.each do |auto_migratable_connection|
+                migrator = Pakyow::Data::Migrator.new(auto_migratable_connection)
+                migrator.auto_migrate!
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pakyow/environment/data/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "pakyow/support/extension"
+
+module Pakyow
+  module Environment
+    module Data
+      module Config
+        extend Support::Extension
+
+        apply_extension do
+          on "configure" do
+            # We have to define these in a before configure hook since new types could be added.
+            #
+            Pakyow.config.data.connections.instance_eval do
+              Pakyow::Data::Connection.adapter_types.each do |type|
+                setting type, {}
+              end
+            end
+          end
+
+          configurable :data do
+            setting :default_adapter, :sql
+            setting :default_connection, :default
+
+            setting :silent, true
+            setting :auto_migrate, true
+            setting :auto_migrate_always, [:memory]
+            setting :migration_path, "./database/migrations"
+
+            defaults :production do
+              setting :auto_migrate, false
+            end
+
+            configurable :subscriptions do
+              setting :adapter, :memory
+              setting :adapter_settings, {}
+
+              defaults :production do
+                setting :adapter, :redis
+                setting :adapter_settings do
+                  Pakyow.config.redis.to_h
+                end
+              end
+            end
+
+            configurable :connections do
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pakyow/environment/data/connections.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "pakyow/support/extension"
+
+require "pakyow/data/connection"
+
+module Pakyow
+  module Environment
+    module Data
+      module Connections
+        extend Support::Extension
+
+        apply_extension do
+          class_state :data_connections, default: {}
+
+          class << self
+            # @api private
+            def connection(adapter, connection)
+              adapter ||= Pakyow.config.data.default_adapter
+              connection ||= Pakyow.config.data.default_connection
+              unless connection_instance = Pakyow.data_connections.dig(adapter.to_sym, connection.to_sym)
+                # TODO: see if this bubbles up to a level the user can see (e.g. specify in the source)
+                #   okay, this is used to fetch a connection through the cli... maybe see if we can reuse when finding the connection for a source too
+                #
+                raise ArgumentError, "`#{connection}' is not a known database connection for the #{adapter} adapter"
+              end
+
+              connection_instance
+            end
+          end
+
+          on "boot", "boot.data.connections" do
+            # Disconnect any existing connections (e.g. booted twice for some reason).
+            #
+            @data_connections.values.flat_map(&:values).each(&:disconnect)
+
+            # Create new connections.
+            #
+            @data_connections = Pakyow::Data::Connection.adapter_types.each_with_object({}) { |connection_type, connections|
+              connections[connection_type] = Pakyow.config.data.connections.public_send(connection_type).each_with_object({}) { |(connection_name, connection_string), adapter_connections|
+                extra_options = {}
+
+                unless Pakyow.config.data.silent
+                  extra_options[:logger] = Pakyow.logger
+                end
+
+                connection = Pakyow::Data::Connection.new(
+                  string: connection_string,
+                  type: connection_type,
+                  name: connection_name,
+                  **extra_options
+                )
+
+                if connection.failed?
+                  raise connection.failure
+                else
+                  adapter_connections[connection_name] = connection
+                end
+              }
+            }
+
+            # Register a prelaunch task to migrate every migratable connection.
+            #
+            @data_connections.each do |adapter, connections|
+              connections.each do |connection_name, connection|
+                if connection.migratable? && connection_name != :memory
+                  config.tasks.prelaunch << ["db:migrate", { adapter: adapter, connection: connection_name }]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pakyow/environment/data/memory_db.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "pakyow/support/extension"
+
+module Pakyow
+  module Environment
+    module Data
+      # Configures an in-memory sqlite database.
+      #
+      module MemoryDB
+        extend Support::Extension
+
+        apply_extension do
+          after "configure" do
+            if defined?(SQLite3)
+              config.data.connections.sql[:memory] = "sqlite::memory"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pakyow/validations/unique.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "pakyow/validator"
+
+module Pakyow
+  module Validations
+    # Validates that the value is unique within its data source.
+    #
+    # @api public
+    module Unique
+      def self.name
+        :unique
+      end
+
+      def self.message(**)
+        "must be unique"
+      end
+
+      def self.valid?(value, source:, **options)
+        options[:context].app.data.public_send(source).public_send(:"by_#{options[:key]}", value).count == 0
+      end
+    end
+
+    Validator.register_validation(Unique)
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: pakyow-data
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Bryan Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pakyow-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pakyow-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+description: Data persistence layer for Pakyow
+email: bryan@metabahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/pakyow/data.rb
+- lib/pakyow/data/adapters/abstract.rb
+- lib/pakyow/data/adapters/sql.rb
+- lib/pakyow/data/adapters/sql/commands.rb
+- lib/pakyow/data/adapters/sql/dataset_methods.rb
+- lib/pakyow/data/adapters/sql/differ.rb
+- lib/pakyow/data/adapters/sql/migrator.rb
+- lib/pakyow/data/adapters/sql/migrator/adapter_methods.rb
+- lib/pakyow/data/adapters/sql/migrators/automator.rb
+- lib/pakyow/data/adapters/sql/migrators/finalizer.rb
+- lib/pakyow/data/adapters/sql/runner.rb
+- lib/pakyow/data/adapters/sql/source_extension.rb
+- lib/pakyow/data/adapters/sql/types.rb
+- lib/pakyow/data/behavior/config.rb
+- lib/pakyow/data/behavior/lookup.rb
+- lib/pakyow/data/behavior/serialization.rb
+- lib/pakyow/data/connection.rb
+- lib/pakyow/data/container.rb
+- lib/pakyow/data/errors.rb
+- lib/pakyow/data/framework.rb
+- lib/pakyow/data/helpers.rb
+- lib/pakyow/data/lookup.rb
+- lib/pakyow/data/migrator.rb
+- lib/pakyow/data/object.rb
+- lib/pakyow/data/proxy.rb
+- lib/pakyow/data/result.rb
+- lib/pakyow/data/sources/abstract.rb
+- lib/pakyow/data/sources/ephemeral.rb
+- lib/pakyow/data/sources/relational.rb
+- lib/pakyow/data/sources/relational/association.rb
+- lib/pakyow/data/sources/relational/associations/belongs_to.rb
+- lib/pakyow/data/sources/relational/associations/has_many.rb
+- lib/pakyow/data/sources/relational/associations/has_one.rb
+- lib/pakyow/data/sources/relational/associations/through.rb
+- lib/pakyow/data/sources/relational/command.rb
+- lib/pakyow/data/sources/relational/migrator.rb
+- lib/pakyow/data/subscribers.rb
+- lib/pakyow/data/subscribers/adapters/memory.rb
+- lib/pakyow/data/subscribers/adapters/redis.rb
+- lib/pakyow/data/subscribers/adapters/redis/pipeliner.rb
+- lib/pakyow/data/subscribers/adapters/redis/scripts/_shared.lua
+- lib/pakyow/data/subscribers/adapters/redis/scripts/expire.lua
+- lib/pakyow/data/subscribers/adapters/redis/scripts/persist.lua
+- lib/pakyow/data/subscribers/adapters/redis/scripts/register.lua
+- lib/pakyow/data/tasks/bootstrap.rake
+- lib/pakyow/data/tasks/create.rake
+- lib/pakyow/data/tasks/drop.rake
+- lib/pakyow/data/tasks/finalize.rake
+- lib/pakyow/data/tasks/migrate.rake
+- lib/pakyow/data/tasks/reset.rake
+- lib/pakyow/data/types.rb
+- lib/pakyow/environment/data/auto_migrate.rb
+- lib/pakyow/environment/data/config.rb
+- lib/pakyow/environment/data/connections.rb
+- lib/pakyow/environment/data/memory_db.rb
+- lib/pakyow/validations/unique.rb
+homepage: https://pakyow.org
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Pakyow Data
+test_files: []