scenic_mysql 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4803974ec78680b939418294f691a3c6bf5d340f
+  data.tar.gz: 921ff1ef7337d24c7d1adf7727553d72d00bbc2a
+SHA512:
+  metadata.gz: 1b072cd90d226465543254d2feb30e9a8624d21ca8f43d5844a3dc8d6a275a7a15132406cca0b60bd2f5ed769ea1940b48823e81409a114edfccd49492a55f97
+  data.tar.gz: 7907d25b17e8495d22ceb1972f389b17af3bbd061440365e603d64fd41052fbb6bb60ee1053d6cbc9b0082a807eb2c959772f0bbb124d575dd05709fb084ee8c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scenic_mysql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Elpizo Choi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# ScenicMysql
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/scenic_mysql`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scenic_mysql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scenic_mysql
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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 tags, 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/[USERNAME]/scenic_mysql.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scenic_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

data/bin/setup

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

data/lib/scenic/adapters/mysql.rb

@@ -0,0 +1,192 @@
+require_relative "mysql/connection"
+require_relative "mysql/errors"
+require_relative "mysql/views"
+require_relative "mysql/tables_definition"
+require_relative "mysql/version"
+
+module Scenic
+  # Scenic database adapters.
+  #
+  # Scenic ships with a Postgres adapter only but can be extended with
+  # additional adapters. The {Adapters::Postgres} adapter provides the
+  # interface.
+  module Adapters
+    # An adapter for managing MySQL views.
+    #
+    # These methods are used interally by Scenic and are not intended for direct
+    # use. Methods that alter database schema are intended to be called via
+    # {Statements}, while {#refresh_materialized_view} is called via
+    # {Scenic.database}.
+    #
+    # The methods are documented here for insight into specifics of how Scenic
+    # integrates with Postgres and the responsibilities of {Adapters}.
+    class Mysql
+      # Creates an instance of the Scenic Postgres adapter.
+      #
+      # This is the default adapter for Scenic. Configuring it via
+      # {Scenic.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 Scenic to use. Defaults to `ActiveRecord::Base`.
+      #
+      # @example
+      #  Scenic.configure do |config|
+      #    config.adapter = Scenic::Adapters::Postgres.new
+      #  end
+      def initialize(connectable = ActiveRecord::Base)
+        @connectable = connectable
+      end
+
+      # Returns an array of views in the database.
+      #
+      # This collection of views is used by the [Scenic::SchemaDumper] to
+      # populate the `schema.rb` file.
+      #
+      # @return [Array<Scenic::View>]
+      def views
+        Views.new(connection).all
+      end
+
+      # Creates a view in the database.
+      #
+      # This is typically called in a migration via {Statements#create_view}.
+      #
+      # @param name The name of the view to create
+      # @param sql_definition The SQL schema for the view.
+      #
+      # @return [void]
+      def create_view(name, sql_definition)
+        execute "CREATE VIEW #{quote_table_name(name)} AS #{sql_definition};"
+      end
+
+      # Updates a view in the database.
+      #
+      # This results in a {#drop_view} followed by a {#create_view}. The
+      # explicitness of that two step process is preferred to `CREATE OR
+      # REPLACE VIEW` because the former ensures that the view you are trying to
+      # update did, in fact, already exist. Additionally, `CREATE OR REPLACE
+      # VIEW` is allowed only to add new columns to the end of an existing
+      # view schema. Existing columns cannot be re-ordered, removed, or have
+      # their types changed. Drop and create overcomes this limitation as well.
+      #
+      # This is typically called in a migration via {Statements#update_view}.
+      #
+      # @param name The name of the view to update
+      # @param sql_definition The SQL schema for the updated view.
+      #
+      # @return [void]
+      def update_view(name, sql_definition)
+        drop_view(name)
+        create_view(name, sql_definition)
+      end
+
+      # Drops the named view from the database
+      #
+      # This is typically called in a migration via {Statements#drop_view}.
+      #
+      # @param name The name of the view to drop
+      #
+      # @return [void]
+      def drop_view(name)
+        execute "DROP VIEW #{quote_table_name(name)};"
+      end
+
+      # Creates a materialized view in the database
+      #
+      # @param name The name of the materialized view to create
+      # @param sql_definition The SQL schema that defines the materialized view.
+      #
+      # This is typically called in a migration via {Statements#create_view}.
+      #
+      # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
+      #   in use does not support materialized views.
+      #
+      # @return [void]
+      def create_materialized_view(name, sql_definition)
+        raise_unless_materialized_views_supported
+      end
+
+      # Updates a materialized view in the database.
+      #
+      # Drops and recreates the materialized view. Attempts to maintain all
+      # previously existing and still applicable indexes on the materialized
+      # view after the view is recreated.
+      #
+      # This is typically called in a migration via {Statements#update_view}.
+      #
+      # @param name The name of the view to update
+      # @param sql_definition The SQL schema for the updated view.
+      #
+      # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
+      #   in use does not support materialized views.
+      #
+      # @return [void]
+      def update_materialized_view(name, sql_definition)
+        raise_unless_materialized_views_supported
+      end
+
+      # Drops a materialized view in the database
+      #
+      # This is typically called in a migration via {Statements#update_view}.
+      #
+      # @param name The name of the materialized view to drop.
+      # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
+      #   in use does not support materialized views.
+      #
+      # @return [void]
+      def drop_materialized_view(name)
+        raise_unless_materialized_views_supported
+      end
+
+      # Refreshes a materialized view from its SQL schema.
+      #
+      # This is typically called from application code via {Scenic.database}.
+      #
+      # @param name The name of the materialized view to refresh.
+      # @param concurrently [Boolean] Whether the refreshs hould happen
+      #   concurrently or not. A concurrent refresh allows the view to be
+      #   refreshed without locking the view for select but requires that the
+      #   table have at least one unique index that covers all rows. Attempts to
+      #   refresh concurrently without a unique index will raise a descriptive
+      #   error.
+      #
+      # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
+      #   in use does not support materialized views.
+      # @raise [ConcurrentRefreshesNotSupportedError] when attempting a
+      #   concurrent refresh on version of Postgres that does not support
+      #   concurrent materialized view refreshes.
+      #
+      # @example Non-concurrent refresh
+      #   Scenic.database.refresh_materialized_view(:search_results)
+      # @example Concurrent refresh
+      #   Scenic.database.refresh_materialized_view(:posts, concurrent: true)
+      #
+      # @return [void]
+      def refresh_materialized_view(name, concurrently: false)
+        raise_unless_materialized_views_supported
+      end
+
+      private
+
+      attr_reader :connectable
+      delegate :execute, :quote_table_name, to: :connection
+
+      def connection
+        Connection.new(connectable.connection)
+      end
+
+      def raise_unless_materialized_views_supported
+        unless connection.supports_materialized_views?
+          raise MaterializedViewsNotSupportedError
+        end
+      end
+
+      def raise_unless_concurrent_refresh_supported
+        unless connection.supports_concurrent_refreshes?
+          raise ConcurrentRefreshesNotSupportedError
+        end
+      end
+    end
+  end
+end

data/lib/scenic/adapters/mysql/connection.rb

@@ -0,0 +1,39 @@
+module Scenic
+  module Adapters
+    class Mysql
+      # Decorates an ActiveRecord connection with methods that help determine
+      # the connections capabilities.
+      #
+      # Every attempt is made to use the versions of these methods defined by
+      # Rails where they are available and public before falling back to our own
+      # implementations for older Rails versions.
+      #
+      # @api private
+      class Connection < SimpleDelegator
+        # True if the connection supports materialized views.
+        #
+        # Delegates to the method of the same name if it is already defined on
+        # the connection. This is the case for Rails 4.2 or higher.
+        #
+        # @return [Boolean]
+        def supports_materialized_views?
+          false
+        end
+
+        # True if the connection supports concurrent refreshes of materialized
+        # views.
+        #
+        # @return [Boolean]
+        def supports_concurrent_refreshes?
+          false
+        end
+
+        private
+
+        def undecorated_connection
+          __getobj__
+        end
+      end
+    end
+  end
+end

data/lib/scenic/adapters/mysql/errors.rb

@@ -0,0 +1,25 @@
+module Scenic
+  module Adapters
+    class Mysql
+      # Raised when a materialized view operation is attempted on a database
+      # version that does not support materialized views.
+      #
+      class MaterializedViewsNotSupportedError < StandardError
+        def initialize
+          super("Materialized views not yet supported for MySQL")
+        end
+      end
+
+      # Raised when attempting a concurrent materialized view refresh on a
+      # database version that does not support that.
+      #
+      # Concurrent materialized view refreshes are supported on Postgres 9.4 or
+      # newer.
+      class ConcurrentRefreshesNotSupportedError < StandardError
+        def initialize
+          super("Concurrent refreshes not yet supported for MySQL")
+        end
+      end
+    end
+  end
+end

data/lib/scenic/adapters/mysql/tables_definition.rb

@@ -0,0 +1,28 @@
+module Scenic
+  module Adapters
+    class Mysql
+
+      module TablesDefinition
+
+        def tables(name = nil, database = nil, like = nil)
+          sql = "SELECT table_name FROM information_schema.tables"
+
+          wheres = ["table_type = 'BASE TABLE'"]
+
+          if database
+            wheres << "table_schema = #{quote_table_name(database)}"
+          else
+            wheres << "table_schema = SCHEMA()"
+          end
+          wheres << "table_name LIKE #{quote(like)}" if like
+
+          sql << " WHERE #{wheres.join(' AND ')}" if wheres.present?
+
+          execute_and_free(sql, 'SCHEMA') do |result|
+            result.collect { |field| field.first }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Scenic
+  module Adapters
+    class Mysql
+      VERSION = "0.1.2"
+    end
+  end
+end

data/lib/scenic/adapters/mysql/views.rb

@@ -0,0 +1,56 @@
+module Scenic
+  module Adapters
+    class Mysql
+
+      # Fetches defined views from the mysql connection.
+      # @api private
+      class Views
+        def initialize(connection)
+          @connection = connection
+        end
+
+        def current_database
+          @connection.current_database
+        end
+
+        # All of the views that this connection has defined.
+        #
+        # This will include materialized views if those are supported by the
+        # connection.
+        #
+        # @return [Array<Scenic::View>]
+        def all
+          views_from_mysql.map(&method(:to_scenic_view))
+        end
+
+        private
+
+        attr_reader :connection
+
+        def views_from_mysql
+          connection.select_rows(<<-SQL)
+            SELECT table_name, view_definition
+            FROM information_schema.views
+            WHERE table_schema = SCHEMA()
+          SQL
+        end
+
+        def to_scenic_view(result)
+          table_name, view_def = result
+
+          Scenic::View.new(
+            name: table_name,
+            definition: scrub_view_def(view_def)
+          )
+        end
+
+        # Sometimes MySQL will include the database name
+        # in view definitions.  This scrubs it out.
+        #
+        def scrub_view_def(view_def)
+          view_def.strip.gsub(/([\`]*#{current_database}[\`]*\.)/i, '')
+        end
+      end
+    end
+  end
+end

data/lib/scenic_mysql.rb

@@ -0,0 +1 @@
+require "scenic/adapters/mysql"

data/scenic_mysql.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scenic/adapters/mysql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scenic_mysql"
+  spec.version       = Scenic::Adapters::Mysql::VERSION
+  spec.authors       = ["Elpizo Choi"]
+  spec.email         = ["fu7iin@gmail.com"]
+
+  spec.summary       = %q{Adds MySQL support for Scenic gem}
+  spec.description   = %q{Adds support for MySQL views in ActiveRecord via the Scenic gem}
+  spec.homepage      = "http://github.com/startweaving/scenic_mysql"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "scenic", "~> 1.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: scenic_mysql
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Elpizo Choi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scenic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Adds support for MySQL views in ActiveRecord via the Scenic gem
+email:
+- fu7iin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scenic/adapters/mysql.rb
+- lib/scenic/adapters/mysql/connection.rb
+- lib/scenic/adapters/mysql/errors.rb
+- lib/scenic/adapters/mysql/tables_definition.rb
+- lib/scenic/adapters/mysql/version.rb
+- lib/scenic/adapters/mysql/views.rb
+- lib/scenic_mysql.rb
+- scenic_mysql.gemspec
+homepage: http://github.com/startweaving/scenic_mysql
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds MySQL support for Scenic gem
+test_files: []