scenic_oracle_enhanced_adapter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bcdb570493bef7acba3abf039b26ba4cabed959feb2f4a3a136511dd9a406ea
+  data.tar.gz: 2da1484c10b74d90bddc038ef5f119b564cc59713c51a08617dea94e27a3f96d
+SHA512:
+  metadata.gz: c9ff80955d26f8c73bfe6990283a8eb44835d358185cffd1831d9460bc0b511083a8079af16f57387764b4113a661b5d98d26b4b64b93813a6a03e0d8e3d5b41
+  data.tar.gz: 405cb5cbcfba01e3df57d37d609d86ae9742b2d02e479887dd396ccac19f2ee8b81493927b8b4a11312bbe3671a714e814a0aab5fd1d8052201adae0adc64ea3

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea/*

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.15.4

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.0.2
+  - Make `create_view` and `create_materialized_view` reversible

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in scenic_oracle_enhanced_adapter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stephen Margheim
+
+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,46 @@
+# ScenicOracleEnhancedAdapter
+
+This gem provides an adapter for the [Scenic gem](https://github.com/thoughtbot/scenic) for use with the [Oracle Enhanced Adapter](https://github.com/rsim/oracle-enhanced/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scenic_oracle_enhanced_adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Then add a Scenic initializer (or modify your existing initializer) to make Scenic use this adapter:
+
+```
+# config/initializers/scenic.rb
+
+Scenic.configure do |config|
+  config.database = Scenic::Adapters::OracleEnhanced.new
+end
+```
+
+## Switching from rails_sql_views to Scenic
+
+In Oracle 12, replacing a view has issues when the view refers to objects outside its own schema; use update_view, which will drop and create. The replace_view method can still be used for views referring to objects in their own schema.
+
+1. Run `bundle exec rails g scenic:view <full_view_name>` (if you use a prefix for the view, include it).
+1. Move the view's SQL definition from the original migration into the newly-created file in db/views.
+1. In the original migration, delete any drop_view call.
+1. Copy the create_view or update_view line from the scenic migration and substitute it for the old create_view method and block.
+1. Delete the scenic migration file
+1. For the down method, copy the update_view line into the down (replacing any drop_ and create_view methods) and make the version: argument to the same number as the revert_to_version: argument (e.g. `update_view :complex_data_view, version: 2, revert_to_version: 1` becomes `update_view :complex_data_view, version: 1, revert_to_version: 1`)
+
+## 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/PMACS/scenic_oracle_enhanced_adapter.

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_oracle_enhanced_adapter'
+
+# 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/scenic/adapters/oracle_enhanced/views.rb

@@ -0,0 +1,80 @@
+module Scenic
+  module Adapters
+    class OracleEnhanced
+      class Views
+        def initialize(connection)
+          @connection = connection
+          @current_schema = fetch_current_schema
+        end
+
+        def all
+          views_from_oracle.map(&method(:to_scenic_view))
+        end
+
+        private
+
+        attr_reader :connection,
+                    :current_schema
+
+        def fetch_current_schema
+          ActiveRecord::Base.connection
+                            .execute("select sys_context('userenv', 'current_schema') from dual")
+                            .fetch
+                            .first
+        end
+
+        def views_from_oracle
+          # NOTE: Oracle cannot `UNION` on `LONG` fields,
+          # and the `all_mviews.query` field and `all_views.text` field
+          # are both `LONG` fields. Thus, we must use `UNION ALL`.
+          # Luckily, we are not here concerned about duplicates.
+          cursor = ActiveRecord::Base.connection.select_all(<<-SQL)
+            SELECT 'm'        AS KIND,
+                   mview_name AS VIEWNAME,
+                   owner      AS NAMESPACE,
+                   query      AS DEFINITION
+            FROM   all_mviews
+            WHERE owner = '#{@current_schema}'
+            UNION ALL
+            SELECT 'v'       AS KIND,
+                   view_name AS VIEWNAME,
+                   owner     AS NAMESPACE,
+                   text      AS DEFINITION
+            FROM   all_views
+            WHERE owner = '#{@current_schema}'
+          SQL
+        end
+
+        def to_scenic_view(result)
+          namespace, viewname = result['namespace'], result['viewname']
+
+          if namespace != 'SYS'
+            namespaced_viewname = "#{oracle_identifier(namespace)}.#{oracle_identifier(viewname)}"
+          else
+            namespaced_viewname = oracle_identifier(viewname)
+          end
+
+          Scenic::View.new(
+            name: namespaced_viewname,
+            definition: result['definition'].strip,
+            materialized: result['kind'] == 'm'
+          )
+        end
+
+        def oracle_identifier(name)
+          # We've copied this method from the PostgreSQL Scenic adapter.
+          # If the name makes it past the guard clause, the quoted Oracle identifiers
+          # will end up causing the OEA's `describe` method to generate
+          # invalid, improperly quoted object names.
+          #
+          # We don't know where this return value is used so, until we have
+          # an actual use case for a name that makes it past this guard, we
+          # are going to leave this as it is.
+          return name if name =~ /^[a-zA-Z_][a-zA-Z0-9_]*$/
+
+          connection.quote_column_name_or_expression(name)
+        end
+      end
+    end
+  end
+end

data/lib/scenic/adapters/oracle_enhanced.rb

@@ -0,0 +1,69 @@
+require_relative 'oracle_enhanced/views'
+
+module Scenic
+  module Adapters
+    # An adapter for managing Oracle views.
+    class OracleEnhanced
+      def initialize(connectable = ActiveRecord::Base)
+        @connectable = connectable
+      end
+
+      def views
+        Views.new(connection).all
+      end
+
+      def create_view(name, sql_definition)
+        execute "CREATE VIEW #{quote_table_name(name)} AS #{sql_definition}"
+      end
+
+      def update_view(name, sql_definition)
+        drop_view(name)
+        create_view(name, sql_definition)
+      end
+
+      def replace_view(name, sql_definition)
+        execute "CREATE OR REPLACE VIEW #{quote_table_name(name)} AS #{sql_definition}"
+      end
+
+      # `_sql_definition` argument allows `create_view` to be reversed in a migration rollback
+      def drop_view(name, _sql_definition = nil)
+        execute "DROP VIEW #{quote_table_name(name)}"
+      end
+
+      def create_materialized_view(name, sql_definition)
+        execute "CREATE MATERIALIZED VIEW #{quote_table_name(name)} AS #{sql_definition}"
+      end
+
+      def update_materialized_view(name, sql_definition)
+        # IndexReapplication.new(connection: connection).on(name) do
+          drop_materialized_view(name)
+          create_materialized_view(name, sql_definition)
+        # end
+      end
+
+      # `_sql_definition` argument allows `create_materialized_view` to be reversed in a migration rollback
+      def drop_materialized_view(name, _sql_definition = nil)
+        execute "DROP MATERIALIZED VIEW #{quote_table_name(name)}"
+      end
+
+      def refresh_materialized_view(name, concurrently: false, cascade: false)
+        # refresh_dependencies_for(name) if cascade
+
+        if concurrently
+          execute "REFRESH MATERIALIZED VIEW CONCURRENTLY #{quote_table_name(name)}"
+        else
+          execute "REFRESH MATERIALIZED VIEW #{quote_table_name(name)}"
+        end
+      end
+
+      private
+
+      attr_reader :connectable
+      delegate :execute, :quote_table_name, to: :connection
+
+      def connection
+        connectable.connection
+      end
+    end
+  end
+end

data/lib/scenic_oracle_enhanced_adapter.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+require 'scenic'
+require 'scenic/adapters/oracle_enhanced'

data/scenic_oracle_enhanced_adapter.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'scenic_oracle_enhanced_adapter'
+  spec.version       = '0.0.2'
+  spec.authors       = ['Stephen Margheim']
+  spec.email         = ['margheim@mail.med.upenn.edu']
+
+  spec.summary       = 'OracleEnhanced adapter for Scenic gem.'
+  spec.homepage      = 'https://github.com/PMACS/scenic_oracle_enhanced_adapter'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'scenic', '>= 1.4.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: scenic_oracle_enhanced_adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stephen Margheim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: scenic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: 
+email:
+- margheim@mail.med.upenn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scenic/adapters/oracle_enhanced.rb
+- lib/scenic/adapters/oracle_enhanced/views.rb
+- lib/scenic_oracle_enhanced_adapter.rb
+- scenic_oracle_enhanced_adapter.gemspec
+homepage: https://github.com/PMACS/scenic_oracle_enhanced_adapter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: OracleEnhanced adapter for Scenic gem.
+test_files: []