fx-adapters-mysql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ebc6f1cf1c463fa4aadb3614d33eb131d97342af331471f6969d8d1e7989de4
+  data.tar.gz: d92c5e1feda2fab057b9c4afd4714be97419d2565c9e72c86358afd9276c8c8e
+SHA512:
+  metadata.gz: 9c390290b0fb7960229cec8885665dec1306a5d99d68feb0c746d1793c33e422ad5e86830f600f1f9e587d5f14af62d571eb43776ca1e0a0fa9ad6524199c175
+  data.tar.gz: df7f6e448852499022e1a4acb1ab9b803e66322e719358c8165ca0a77ebbebcc50f2c6042422e1488a26d466276e5b8b181978f0cefb44b93a9e72e2a557ec8f

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (2022-02-03)
+
+
+### Features
+
+* Initial implementation ([872d647](https://www.github.com/f-mer/fx-adapters-mysql/commit/872d64745dd3f6d1c9fba61485f4a27ce6d4c948))

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fx-adapters-mysql.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,39 @@
+# Fx::Adapters::Mysql
+
+MySQL adapter for [fx](https://github.com/teoljungberg/fx).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fx-adapters-mysql'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fx-adapters-mysql
+
+## Usage
+
+```rb
+#  config/initializers/fx.rb
+
+Fx.configure do |config|
+ config.adapter = Fx::Adapters::MySQL.new
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/f-mer/fx-adapters-mysql.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load("rails/tasks/engine.rake")
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: ["db:create", "spec", "standard"]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fx/adapters/mysql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/fx/adapters/mysql/functions.rb

@@ -0,0 +1,63 @@
+module Fx
+  module Adapters
+    class MySQL
+      # Fetches defined functions from the mysql connection.
+      # @api private
+      class Functions
+        # Wraps #all as a static facade.
+        #
+        # @return [Array<Fx::Function>]
+        def self.all(*args)
+          new(*args).all
+        end
+
+        def initialize(connection)
+          @connection = connection
+        end
+
+        # All of the functions that this connection has defined.
+        #
+        # @return [Array<Fx::Function>]
+        def all
+          functions_from_mysql.map { |function| to_fx_function(function) }
+        end
+
+        private
+
+        attr_reader :connection
+
+        def functions_from_mysql
+          connection.exec_query(<<-SQL)
+            SELECT
+              ROUTINE_NAME AS name,
+              ROUTINE_DEFINITION AS definition
+            FROM INFORMATION_SCHEMA.ROUTINES
+            WHERE ROUTINE_SCHEMA NOT IN ('sys', 'information_schema', 'mysql', 'performance_schema')
+            AND ROUTINE_SCHEMA = '#{connection.current_database}'
+            AND ROUTINE_TYPE = 'FUNCTION'
+          SQL
+        end
+
+        def to_fx_function(result)
+          name = result.fetch("name")
+          definition = "DELIMITER $$\n#{delete_definer(find_definition(name))}$$\nDELIMITER ;"
+          Fx::Function.new(
+            "name" => name,
+            "definition" => definition
+          )
+        end
+
+        def delete_definer(string)
+          string.gsub(/ DEFINER=`[^`]+`@`[^`]+`/, "")
+        end
+
+        def find_definition(name)
+          connection
+            .exec_query("SHOW CREATE FUNCTION `#{name}`")
+            .first
+            .fetch("Create Function")
+        end
+      end
+    end
+  end
+end

data/lib/fx/adapters/mysql/triggers.rb

@@ -0,0 +1,57 @@
+module Fx
+  module Adapters
+    class MySQL
+      # Fetches defined triggers from the mysql connection.
+      # @api private
+      class Triggers
+        # Wraps #all as a static facade.
+        #
+        # @return [Array<Fx::Adapters::MySQL::Trigger>]
+        def self.all(*args)
+          new(*args).all
+        end
+
+        def initialize(connection)
+          @connection = connection
+        end
+
+        # All of the triggers that this connection has defined.
+        #
+        # @return [Array<Fx::Trigger>]
+        def all
+          triggers_from_mysql.map { |trigger| to_fx_trigger(trigger) }
+        end
+
+        private
+
+        attr_reader :connection
+
+        def triggers_from_mysql
+          connection.exec_query(<<-SQL)
+            SELECT
+              TRIGGER_NAME AS name,
+              ACTION_STATEMENT AS definition,
+              EVENT_MANIPULATION AS event,
+              EVENT_OBJECT_TABLE AS table_name,
+              ACTION_TIMING AS timing
+            FROM INFORMATION_SCHEMA.TRIGGERS
+            WHERE TRIGGER_SCHEMA = '#{connection.current_database}'
+          SQL
+        end
+
+        def to_fx_trigger(result)
+          name = result.fetch("name")
+          definition = <<~SQL
+            CREATE TRIGGER #{name} #{result.fetch("timing")} #{result.fetch("event")} ON #{result.fetch("table_name")}
+            FOR EACH ROW
+            #{result.fetch("definition")}
+          SQL
+          Fx::Trigger.new(
+            "name" => name,
+            "definition" => definition
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fx/adapters/mysql/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Fx
+  module Adapters
+    module Mysql
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/fx/adapters/mysql.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "fx"
+
+require_relative "mysql/version"
+require_relative "mysql/functions"
+require_relative "mysql/triggers"
+
+module Fx
+  module Adapters
+    # Creates an instance of the F(x) MySQL adapter.
+    #
+    # @param [#connection] connectable An object that returns the connection
+    #   for F(x) to use. Defaults to `ActiveRecord::Base`.
+    #
+    # @example
+    #  Fx.configure do |config|
+    #    config.adapter = Fx::Adapters::MySQL.new
+    #  end
+    class MySQL
+      # Creates an instance of the F(x) MySQL adapter.
+      #
+      # This is the default adapter for F(x). Configuring it via
+      # {Fx.configure} is not required, but the example below shows how one
+      # would explicitly set it.
+      #
+      # @param [#connection] connectable An object that returns the connection
+      #   for F(x) to use. Defaults to `ActiveRecord::Base`.
+      #
+      # @example
+      #  Fx.configure do |config|
+      #    config.adapter = Fx::Adapters::MySQL.new
+      #  end
+      def initialize(connectable = ActiveRecord::Base)
+        @connectable = connectable
+      end
+
+      # Returns an array of functions in the database.
+      #
+      # This collection of functions is used by the [Fx::SchemaDumper] to
+      # populate the `schema.rb` file.
+      #
+      # @return [Array<Fx::Function>]
+      def functions
+        Functions.all(connection)
+      end
+
+      # Returns an array of triggers in the database.
+      #
+      # This collection of triggers is used by the [Fx::SchemaDumper] to
+      # populate the `schema.rb` file.
+      #
+      # @return [Array<Fx::Trigger>]
+      def triggers
+        Triggers.all(connection)
+      end
+
+      # Creates a function in the database.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#create_function}.
+      #
+      # @param sql_definition The SQL schema for the function.
+      #
+      # @return [void]
+      def create_function(sql_definition)
+        execute sql_definition
+      end
+
+      # Creates a trigger in the database.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Trigger#create_trigger}.
+      #
+      # @param sql_definition The SQL schema for the trigger.
+      #
+      # @return [void]
+      def create_trigger(sql_definition)
+        execute sql_definition
+      end
+
+      # Updates a function in the database.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#update_function}.
+      #
+      # @param name The name of the function.
+      # @param sql_definition The SQL schema for the function.
+      #
+      # @return [void]
+      def update_function(name, sql_definition)
+        drop_function(name)
+        create_function(sql_definition)
+      end
+
+      # Updates a trigger in the database.
+      #
+      # The existing trigger is dropped and recreated using the supplied `on`
+      # and `version` parameter.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#update_trigger}.
+      #
+      # @param name The name of the trigger.
+      # @param on The associated table for the trigger to drop
+      # @param sql_definition The SQL schema for the function.
+      #
+      # @return [void]
+      def update_trigger(name, on:, sql_definition:)
+        drop_trigger(name, on: on)
+        create_trigger(sql_definition)
+      end
+
+      # Drops the function from the database
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#drop_function}.
+      #
+      # @param name The name of the function to drop
+      #
+      # @return [void]
+      def drop_function(name)
+        execute "DROP FUNCTION #{name};"
+      end
+
+      # Drops the trigger from the database
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Trigger#drop_trigger}.
+      #
+      # @param name The name of the trigger to drop
+      # @param on The associated table for the trigger to drop
+      #
+      # @return [void]
+      def drop_trigger(name, on:)
+        execute "DROP TRIGGER #{name} ON #{on};"
+      end
+
+      private
+
+      attr_reader :connectable
+
+      delegate :connection, to: :connectable
+      delegate :execute, to: :connection
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: fx-adapters-mysql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabian Mersch
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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'
+- !ruby/object:Gem::Dependency
+  name: fx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description:
+email:
+- fabianmersch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/fx/adapters/mysql.rb
+- lib/fx/adapters/mysql/functions.rb
+- lib/fx/adapters/mysql/triggers.rb
+- lib/fx/adapters/mysql/version.rb
+homepage: https://github.com/f-mer/fx-adapters-mysql
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: MySQL adapter for fx
+test_files: []