scenic-jets 1.5.4

data/lib/scenic/statements.rb

@@ -0,0 +1,163 @@
+module Scenic
+  # Methods that are made available in migrations for managing Scenic views.
+  module Statements
+    # Create a new database view.
+    #
+    # @param name [String, Symbol] The name of the database view.
+    # @param version [Fixnum] The version number of the view, used to find the
+    #   definition file in `db/views`. This defaults to `1` if not provided.
+    # @param sql_definition [String] The SQL query for the view schema. An error
+    #   will be raised if `sql_definition` and `version` are both set,
+    #   as they are mutually exclusive.
+    # @param materialized [Boolean, Hash] Set to true to create a materialized
+    #   view. Set to { no_data: true } to create materialized view without
+    #   loading data. Defaults to false.
+    # @return The database response from executing the create statement.
+    #
+    # @example Create from `db/views/searches_v02.sql`
+    #   create_view(:searches, version: 2)
+    #
+    # @example Create from provided SQL string
+    #   create_view(:active_users, sql_definition: <<-SQL)
+    #     SELECT * FROM users WHERE users.active = 't'
+    #   SQL
+    #
+    def create_view(name, version: nil, sql_definition: nil, materialized: false)
+      if version.present? && sql_definition.present?
+        raise(
+          ArgumentError,
+          "sql_definition and version cannot both be set",
+        )
+      end
+
+      if version.blank? && sql_definition.blank?
+        version = 1
+      end
+
+      sql_definition ||= definition(name, version)
+
+      if materialized
+        Scenic.database.create_materialized_view(
+          name,
+          sql_definition,
+          no_data: no_data(materialized),
+        )
+      else
+        Scenic.database.create_view(name, sql_definition)
+      end
+    end
+
+    # Drop a database view by name.
+    #
+    # @param name [String, Symbol] The name of the database view.
+    # @param revert_to_version [Fixnum] Used to reverse the `drop_view` command
+    #   on `rake db:rollback`. The provided version will be passed as the
+    #   `version` argument to {#create_view}.
+    # @param materialized [Boolean] Set to true if dropping a meterialized view.
+    #   defaults to false.
+    # @return The database response from executing the drop statement.
+    #
+    # @example Drop a view, rolling back to version 3 on rollback
+    #   drop_view(:users_who_recently_logged_in, revert_to_version: 3)
+    #
+    def drop_view(name, revert_to_version: nil, materialized: false)
+      if materialized
+        Scenic.database.drop_materialized_view(name)
+      else
+        Scenic.database.drop_view(name)
+      end
+    end
+
+    # Update a database view to a new version.
+    #
+    # The existing view is dropped and recreated using the supplied `version`
+    # parameter.
+    #
+    # @param name [String, Symbol] The name of the database view.
+    # @param version [Fixnum] The version number of the view.
+    # @param sql_definition [String] The SQL query for the view schema. An error
+    #   will be raised if `sql_definition` and `version` are both set,
+    #   as they are mutually exclusive.
+    # @param revert_to_version [Fixnum] The version number to rollback to on
+    #   `rake db rollback`
+    # @param materialized [Boolean, Hash] True if updating a materialized view.
+    #   Set to { no_data: true } to update materialized view without loading
+    #   data. Defaults to false.
+    # @return The database response from executing the create statement.
+    #
+    # @example
+    #   update_view :engagement_reports, version: 3, revert_to_version: 2
+    #
+    def update_view(name, version: nil, sql_definition: nil, revert_to_version: nil, materialized: false)
+      if version.blank? && sql_definition.blank?
+        raise(
+          ArgumentError,
+          "sql_definition or version must be specified",
+        )
+      end
+
+      if version.present? && sql_definition.present?
+        raise(
+          ArgumentError,
+          "sql_definition and version cannot both be set",
+        )
+      end
+
+      sql_definition ||= definition(name, version)
+
+      if materialized
+        Scenic.database.update_materialized_view(
+          name,
+          sql_definition,
+          no_data: no_data(materialized),
+        )
+      else
+        Scenic.database.update_view(name, sql_definition)
+      end
+    end
+
+    # Update a database view to a new version using `CREATE OR REPLACE VIEW`.
+    #
+    # The existing view is replaced using the supplied `version`
+    # parameter.
+    #
+    # Does not work with materialized views due to lack of database support.
+    #
+    # @param name [String, Symbol] The name of the database view.
+    # @param version [Fixnum] The version number of the view.
+    # @param revert_to_version [Fixnum] The version number to rollback to on
+    #   `rake db rollback`
+    # @return The database response from executing the create statement.
+    #
+    # @example
+    #   replace_view :engagement_reports, version: 3, revert_to_version: 2
+    #
+    def replace_view(name, version: nil, revert_to_version: nil, materialized: false)
+      if version.blank?
+        raise ArgumentError, "version is required"
+      end
+
+      if materialized
+        raise ArgumentError, "Cannot replace materialized views"
+      end
+
+      sql_definition = definition(name, version)
+
+      Scenic.database.replace_view(name, sql_definition)
+    end
+
+    private
+
+    def definition(name, version)
+      Scenic::Definition.new(name, version).to_sql
+    end
+
+    def no_data(materialized)
+      if materialized.is_a?(Hash)
+        materialized.fetch(:no_data, false)
+      else
+        false
+      end
+    end
+  end
+end

data/lib/scenic/version.rb

@@ -0,0 +1,3 @@
+module Scenic
+  VERSION = "1.5.4".freeze
+end

data/lib/scenic/view.rb

@@ -0,0 +1,54 @@
+module Scenic
+  # The in-memory representation of a view definition.
+  #
+  # **This object is used internally by adapters and the schema dumper and is
+  # not intended to be used by application code. It is documented here for
+  # use by adapter gems.**
+  #
+  # @api extension
+  class View
+    # The name of the view
+    # @return [String]
+    attr_reader :name
+
+    # The SQL schema for the query that defines the view
+    # @return [String]
+    #
+    # @example
+    #   "SELECT name, email FROM users UNION SELECT name, email FROM contacts"
+    attr_reader :definition
+
+    # True if the view is materialized
+    # @return [Boolean]
+    attr_reader :materialized
+
+    # Returns a new instance of View.
+    #
+    # @param name [String] The name of the view.
+    # @param definition [String] The SQL for the query that defines the view.
+    # @param materialized [String] `true` if the view is materialized.
+    def initialize(name:, definition:, materialized:)
+      @name = name
+      @definition = definition
+      @materialized = materialized
+    end
+
+    # @api private
+    def ==(other)
+      name == other.name &&
+        definition == other.definition &&
+        materialized == other.materialized
+    end
+
+    # @api private
+    def to_schema
+      materialized_option = materialized ? "materialized: true, " : ""
+
+      <<-DEFINITION
+  create_view #{name.inspect}, #{materialized_option}sql_definition: <<-\SQL
+    #{definition.indent(2)}
+  SQL
+      DEFINITION
+    end
+  end
+end

data/scenic.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scenic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scenic-jets"
+  spec.version       = Scenic::VERSION
+  spec.authors       = ["Derek Prior", "Caleb Hearth"]
+  spec.email         = ["derekprior@gmail.com", "caleb@calebhearth.com"]
+  spec.summary       = "Support for database views in Rails migrations"
+  spec.description   = <<-DESCRIPTION
+    Adds methods to ActiveRecord::Migration to create and manage database views
+    in Rails
+  DESCRIPTION
+  spec.homepage      = "https://github.com/scenic-views/scenic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  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 "pg", "~> 0.19"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "ammeter", ">= 1.1.3"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+
+  spec.add_dependency "activerecord", ">= 4.0.0"
+  spec.add_dependency "railties", ">= 4.0.0"
+
+  spec.required_ruby_version = ">= 2.3.0"
+end

data/spec/acceptance/user_manages_views_spec.rb

@@ -0,0 +1,88 @@
+require "acceptance_helper"
+require "English"
+
+describe "User manages views" do
+  it "handles simple views" do
+    successfully "rails generate scenic:model search_result"
+    write_definition "search_results_v01", "SELECT 'needle'::text AS term"
+
+    successfully "rake db:migrate"
+    verify_result "SearchResult.take.term", "needle"
+
+    successfully "rails generate scenic:view search_results"
+    verify_identical_view_definitions "search_results_v01", "search_results_v02"
+
+    write_definition "search_results_v02", "SELECT 'haystack'::text AS term"
+    successfully "rake db:migrate"
+
+    successfully "rake db:reset"
+    verify_result "SearchResult.take.term", "haystack"
+
+    successfully "rake db:rollback"
+    successfully "rake db:rollback"
+    successfully "rails destroy scenic:model search_result"
+  end
+
+  it "handles materialized views" do
+    successfully "rails generate scenic:model child --materialized"
+    write_definition "children_v01", "SELECT 'Owen'::text AS name, 5 AS age"
+
+    successfully "rake db:migrate"
+    verify_result "Child.take.name", "Owen"
+
+    add_index "children", "name"
+    add_index "children", "age"
+
+    successfully "rails runner 'Child.refresh'"
+
+    successfully "rails generate scenic:view child --materialized"
+    verify_identical_view_definitions "children_v01", "children_v02"
+
+    write_definition "children_v02", "SELECT 'Elliot'::text AS name"
+    successfully "rake db:migrate"
+
+    successfully "rake db:reset"
+    verify_result "Child.take.name", "Elliot"
+    verify_schema_contains 'add_index "children"'
+
+    successfully "rake db:rollback"
+    successfully "rake db:rollback"
+    successfully "rails destroy scenic:model child"
+  end
+
+  it "handles plural view names gracefully during generation" do
+    successfully "rails generate scenic:model search_results --materialized"
+    successfully "rails destroy scenic:model search_results --materialized"
+  end
+
+  def successfully(command)
+    `RAILS_ENV=test #{command}`
+    expect($CHILD_STATUS.exitstatus).to eq(0), "'#{command}' was unsuccessful"
+  end
+
+  def write_definition(file, contents)
+    File.open("db/views/#{file}.sql", File::WRONLY) do |definition|
+      definition.truncate(0)
+      definition.write(contents)
+    end
+  end
+
+  def verify_result(command, expected_output)
+    successfully %{rails runner "#{command} == '#{expected_output}' || exit(1)"}
+  end
+
+  def verify_identical_view_definitions(def_a, def_b)
+    successfully "cmp db/views/#{def_a}.sql db/views/#{def_b}.sql"
+  end
+
+  def add_index(table, column)
+    successfully(<<-CMD.strip)
+      rails runner 'ActiveRecord::Migration.add_index "#{table}", "#{column}"'
+    CMD
+  end
+
+  def verify_schema_contains(statement)
+    expect(File.readlines("db/schema.rb").grep(/#{statement}/))
+      .not_to be_empty, "Schema does not contain '#{statement}'"
+  end
+end

data/spec/acceptance_helper.rb

@@ -0,0 +1,33 @@
+require "bundler"
+
+ENV["RAILS_ENV"] = "test"
+
+RSpec.configure do |config|
+  config.around(:each) do |example|
+    Dir.chdir("spec/dummy") do
+      example.run
+    end
+  end
+
+  config.before(:suite) do
+    Dir.chdir("spec/dummy") do
+      system <<-CMD
+        git init 1>/dev/null &&
+        git add -A &&
+        git commit --no-gpg-sign --message 'initial' 1>/dev/null
+      CMD
+    end
+  end
+
+  config.after(:suite) do
+    Dir.chdir("spec/dummy") do
+      system <<-CMD
+        echo &&
+        rake db:environment:set db:drop db:create &&
+        git add -A &&
+        git reset --hard HEAD 1>/dev/null &&
+        rm -rf .git/ 1>/dev/null
+      CMD
+    end
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Rakefile

@@ -0,0 +1,13 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks
+
+unless Rake::Task.task_defined?('db:environment:set')
+  desc 'dummy task for rails versions where this task does not exist'
+  task 'db:environment:set' do
+    #no op
+  end
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,5 @@
+if Rails::VERSION::STRING >= "5.0.0"
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application