scenic-mysql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: debd8d685f6a17303ba3e74957e47141ff982d4c
+  data.tar.gz: bfd9d028e50e0d9cff8cd38d91cc905cd0611a32
+SHA512:
+  metadata.gz: 831e1a2a86c4b3fe8e757ea53aab615c94b4925e0387ae66b29e016e0c9430935c4ad8afb188510fcaf29bad52cb40ba5f17e1d331c877704f21b9251376dd5f
+  data.tar.gz: d4d56f4e47135475af9f7aa4a7d0e8b3b38c6a1c7f9cc4fa1524cb2f9dbbed292cc9c2b6b6669408fdf1397676cd45e50911dfcd7962a2278c61cad842724b24

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

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 Rennan Oliveira
+
+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 @@
+# Scenic::Mysql
+
+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 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 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,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :dummy do
+  require_relative 'spec/dummy/config/application'
+  Dummy::Application.load_tasks
+end
+
+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/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -e
+
+gem install bundler --conservative
+bundle check || bundle install
+
+bundle exec rake dummy:db:create

data/lib/scenic-mysql.rb

@@ -0,0 +1,2 @@
+require 'scenic'
+require 'scenic/adapters/mysql'

data/lib/scenic/adapters/mysql.rb

@@ -0,0 +1,163 @@
+require_relative 'mysql/connection'
+require_relative 'mysql/errors'
+require_relative 'mysql/indexes'
+require_relative 'mysql/views'
+
+module Scenic
+  # Scenic database adapters.
+  #
+  # Scenic ships with a Postgres adapter only but can be extended with
+  # additional adapters. This adapter {Adapters::Mysql} implements the
+  # interface described on {Adapters::Postgres}.
+  module Adapters
+    # An adapter for managing Mysql views.
+    #
+    # These methods are used internally 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 Mysql and the responsibilities of {Adapters}.
+    class Mysql
+      # Creates an instance of the Scenic Mysql adapter.
+      #
+      # Postgres is the default adapter for Scenic. To use this Mysql adapter,
+      # follow the example bellow
+      #
+      # @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::Mysql.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
+
+      # Replaces a view in the database using `CREATE OR REPLACE VIEW`.
+      #
+      # This results in a `CREATE OR REPLACE VIEW`. Most of the time the
+      # explicitness of the two step process used in {#update_view} 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.
+      #
+      # However, when there is a tangled dependency tree
+      # `CREATE OR REPLACE VIEW` can be preferable.
+      #
+      # This is typically called in a migration via
+      # {Statements#replace_view}.
+      #
+      # @param name The name of the view to update
+      # @param sql_definition The SQL schema for the updated view.
+      #
+      # @return [void]
+      def replace_view(name, sql_definition)
+        execute "CREATE OR REPLACE VIEW #{quote_table_name(name)} AS #{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
+
+      # @raise [MaterializedViewsNotSupportedError] as Mysql does not support
+      # materialized views.
+      #
+      # @return [void]
+      def create_materialized_view(_name, _sql_definition)
+        raise MaterializedViewsNotSupportedError
+      end
+
+      # @raise [MaterializedViewsNotSupportedError] as Mysql does not support
+      # materialized views.
+      #
+      # @return [void]
+      def update_materialized_view(_name, _sql_definition)
+        raise MaterializedViewsNotSupportedError
+      end
+
+
+      # @raise [MaterializedViewsNotSupportedError] as Mysql does not support
+      # materialized views.
+      #
+      # @return [void]
+      def drop_materialized_view(_name)
+        raise MaterializedViewsNotSupportedError
+      end
+
+
+      # @raise [MaterializedViewsNotSupportedError] as Mysql does not support
+      # materialized views.
+      #
+      # @return [void]
+      def refresh_materialized_view(_name, _concurrently: false)
+        raise MaterializedViewsNotSupportedError
+      end
+
+      private
+
+      attr_reader :connectable
+      delegate :execute, :quote_table_name, to: :connection
+
+      def connection
+        connectable.connection
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Scenic
+  module Adapters
+    class Mysql
+      # Decorates an ActiveRecord connection with methods that help determine
+      # the connections capabilities.
+      #
+      # As Mysql does not support materialized views, this class is a no-op
+      #
+      # @api private
+      class Connection < SimpleDelegator
+        # False always for Mysql
+        #
+        # @return [Boolean]
+        def supports_materialized_views?; false; end
+
+        # False always for Mysql
+        #
+        # @return [Boolean]
+        def supports_concurrent_refreshes?; false; 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.
+      #
+      # Materialized views are not supported on Mysql.
+      class MaterializedViewsNotSupportedError < StandardError
+        def initialize
+          super('Materialized views not supported in Mysql')
+        end
+      end
+
+      # Raised when attempting a concurrent materialized view refresh on a
+      # database version that does not support that.
+      #
+      # Materialized views are not supported on Mysql.
+      class ConcurrentRefreshesNotSupportedError < MaterializedViewsNotSupportedError
+        def initialize
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Scenic
+  module Adapters
+    class Mysql
+      # Fetches indexes on objects from the Mysql connection.
+      #
+      # @api private
+      class Indexes
+        def initialize(connection:)
+          @connection = connection
+        end
+
+        # Indexes on the provided object.
+        #
+        # @param name [String] The name of the object we want indexes from.
+        # @return [Array<Scenic::Index>]
+        def on(name)
+          indexes_on(name).map.(&method(:index_from_database))
+        end
+
+        private
+
+        attr_reader :connection
+        delegate :quote_table_name, to: :connection
+
+        def indexes_on(name)
+          connection.exec_query(<<-SQL)
+            SHOW INDEX FROM '#{name}'
+            WHERE Key_name <> 'PRIMARY'
+          SQL
+        end
+
+        def index_from_database(result)
+          Scenic::Index.new(
+            object_name: result['Table'],
+            index_name: result['Key_name'],
+            definition: index_definition_for(result)
+          )
+        end
+
+        def index_definition_for(result)
+          <<-SQL
+            CREATE INDEX '#{result["Key_name"]}'
+            ON '#{result["Table"]}' ('#{result["Column_name"]}')
+            USING '#{result["Index_type"]}'
+          SQL
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Scenic
+  module Adapters
+    class Mysql
+      # Fetches defined views from the mysql connection.
+      # @api private
+      class Views
+        def initialize(connection)
+          @connection = connection
+        end
+
+        # All of the views that this connection has defined.
+        # Mysql will return these views ordered by name.
+        # Difference from the original Postgres adapter:
+        #   Mysql2 gem only watches one schema at a time.
+        #
+        # This will not include materialized views as these are not
+        # supported by mysql.
+        #
+        # @return [Array<Scenic::View>]
+        def all
+          views_from_mysql.map(&method(:to_scenic_view))
+        end
+
+        private
+
+        attr_reader :connection
+
+        def views_from_mysql
+          ActiveRecord::Base.connection.exec_query(<<-SQL)
+		        SELECT TABLE_NAME, VIEW_DEFINITION, TABLE_SCHEMA
+  			    FROM information_schema.VIEWS
+			      WHERE TABLE_SCHEMA = DATABASE();
+          SQL
+        end
+
+        def to_scenic_view(result)
+          Scenic::View.new(
+            name: result['TABLE_NAME'],
+            definition: result['VIEW_DEFINITION'].strip,
+            materialized: false
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/scenic/mysql.rb

@@ -0,0 +1,3 @@
+require 'scenic/mysql/version'
+require 'scenic/adapters/mysql'
+

data/lib/scenic/mysql/version.rb

@@ -0,0 +1,5 @@
+module Scenic
+  module Mysql
+    VERSION = '0.1.0'
+  end
+end

data/scenic-mysql.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scenic/mysql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'scenic-mysql'
+  spec.version       = Scenic::Mysql::VERSION
+  spec.authors       = ['Rennan Oliveira', 'Abraão Miranda']
+  spec.email         = ['renmcoliver@gmail.com', 'abraaomirandar@gmail.com']
+
+  spec.summary       = %q{Mysql adapter for the scenic gem}
+  spec.description   = %q{Adds Mysql adapter to the scenic gem}
+  spec.homepage      = 'https://github.com/rennanoliveira/scenic-mysql'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.5'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.3'
+  spec.add_development_dependency 'mysql2', '>= 0.4.4'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'scenic', '>= 1.3'
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: scenic-mysql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rennan Oliveira
+- Abraão Miranda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: scenic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Adds Mysql adapter to the scenic gem
+email:
+- renmcoliver@gmail.com
+- abraaomirandar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/scenic-mysql.rb
+- lib/scenic/adapters/mysql.rb
+- lib/scenic/adapters/mysql/connection.rb
+- lib/scenic/adapters/mysql/errors.rb
+- lib/scenic/adapters/mysql/indexes.rb
+- lib/scenic/adapters/mysql/views.rb
+- lib/scenic/mysql.rb
+- lib/scenic/mysql/version.rb
+- scenic-mysql.gemspec
+homepage: https://github.com/rennanoliveira/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.5.1
+signing_key: 
+specification_version: 4
+summary: Mysql adapter for the scenic gem
+test_files: []