scenic 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1617d9008cabf9f0117f71f812735e8f89bf932
-  data.tar.gz: 31babdfa7c8fc2bc200f9457bc6f8fcab9f16a8e
+  metadata.gz: d319d2791defb8c1025c78605b3003c0275664ba
+  data.tar.gz: 0c79eb3cb32bf171ec085987b83ac89df8bd4ffe
 SHA512:
-  metadata.gz: aebbd7f6d99c20b35420a68977a4231849543393c01d2a37487cfcde775cc26b33af792d13b61a4618db12dfe4eef0fc0a581ad27a5b76842d4701c0452302db
-  data.tar.gz: 05ea1809e4c4777903a297a9ee1e8c83d59ac3550aa455a82ef2d0e52f0a5f715211ed721e1f425aa87f4d08e7f04c7e7c9b1bec284861ab667e555eefe226c0
+  metadata.gz: f858662b6d60d851a0aa402401c750da7a9c482d018e49e6fcdde39cd5672bd4d8cbd5593f422afa7541c0867805f28e0a73cb1add550c0742552851f67359a3
+  data.tar.gz: 81c7ec7accf60272ff77476c73b31ed7b332334874d150b655b5933a4546be4a009a75c9dcd4a2d93a623de702c34c6e6f80bb76d5f3f8665ff65a56dc2ca896

data/README.md

@@ -78,6 +78,49 @@ Scenic detected that we already had an existing `search_results` view at version
 update to the version 2 schema. All that's left for you to do is tweak the
 schema in the new definition and run the `update_view` migration.
 
+## What if I want to change a view without dropping it?
+
+The `update_view` statement used by default will drop your view then create
+a new version of it.
+
+This is not desirable when you have complicated hierarchies of views, especially
+when some of those views may be materialized and take a long time to recreate.
+
+You can use `replace_view` to generate a CREATE OR REPLACE VIEW SQL statement.
+
+See postgresql documentation on how this works:
+http://www.postgresql.org/docs/current/static/sql-createview.html
+
+To start replacing a view run the generator like for a regular change:
+
+```sh
+$ rails generate scenic:view search_results
+      create  db/views/search_results_v02.sql
+      create  db/migrate/[TIMESTAMP]_update_search_results_to_version_2.rb
+```
+
+Now, edit the migration. It should look something like:
+
+```ruby
+class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
+  def change
+    update_view :search_results, version: 2, revert_to_version: 1
+  end
+end
+```
+
+Update it to use replace view:
+
+```ruby
+class UpdateSearchResultsToVersion2 < ActiveRecord::Migration
+  def change
+    replace_view :search_results, version: 2, revert_to_version: 1
+  end
+end
+```
+
+Now you can run the migration like normal.
+
 ## Can I use this view to back a model?
 
 You bet! Using view-backed models can help promote concepts hidden in your

data/Rakefile

@@ -12,4 +12,18 @@ namespace :dummy do
   Dummy::Application.load_tasks
 end
 
-task default: [:spec, :smoke]
+task(:spec).clear
+desc "Run specs other than spec/acceptance"
+RSpec::Core::RakeTask.new("spec") do |task|
+  task.exclude_pattern = "spec/acceptance/**/*_spec.rb"
+  task.verbose = false
+end
+
+desc "Run acceptance specs in spec/acceptance"
+RSpec::Core::RakeTask.new("spec:acceptance") do |task|
+  task.pattern = "spec/acceptance/**/*_spec.rb"
+  task.verbose = false
+end
+
+desc "Run the specs and acceptance tests"
+task default: %w(spec spec:acceptance)

data/lib/generators/scenic/model/model_generator.rb

@@ -11,12 +11,12 @@ module Scenic
       source_root File.expand_path("../templates", __FILE__)
 
       def invoke_rails_model_generator
-        invoke "model", [name], options.merge(migration: false)
+        invoke "model", [file_path.singularize], options.merge(migration: false)
       end
 
       def inject_model_methods
         if materialized? && generating?
-          inject_into_class "app/models/#{file_path}.rb", class_name do
+          inject_into_class "app/models/#{file_path.singularize}.rb", class_name do
             evaluate_template("model.erb")
           end
         end

data/lib/scenic/adapters/postgres.rb

@@ -81,6 +81,31 @@ module Scenic
         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}.

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

@@ -27,7 +27,8 @@ module Scenic
             SELECT
               c.relname as viewname,
               pg_get_viewdef(c.oid) AS definition,
-              c.relkind AS kind
+              c.relkind AS kind,
+              n.nspname AS namespace
             FROM pg_class c
               LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
             WHERE
@@ -39,8 +40,16 @@ module Scenic
         end
 
         def to_scenic_view(result)
+          namespace, viewname = result.values_at "namespace", "viewname"
+
+          if namespace != "public"
+            namespaced_viewname = "#{namespace}.#{viewname}"
+          else
+            namespaced_viewname = viewname
+          end
+
           Scenic::View.new(
-            name: result["viewname"],
+            name: namespaced_viewname,
             definition: result["definition"].strip,
             materialized: result["kind"] == "m",
           )

data/lib/scenic/command_recorder.rb

@@ -15,6 +15,10 @@ module Scenic
       record(:update_view, args)
     end
 
+    def replace_view(*args)
+      record(:replace_view, args)
+    end
+
     def invert_create_view(args)
       [:drop_view, args]
     end
@@ -27,6 +31,10 @@ module Scenic
       perform_scenic_inversion(:update_view, args)
     end
 
+    def invert_replace_view(args)
+      perform_scenic_inversion(:replace_view, args)
+    end
+
     private
 
     def perform_scenic_inversion(method, args)

data/lib/scenic/statements.rb

@@ -89,6 +89,36 @@ module Scenic
       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)

data/lib/scenic/version.rb

@@ -1,3 +1,3 @@
 module Scenic
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 end

data/lib/scenic/view.rb

@@ -43,8 +43,10 @@ module Scenic
     # @api private
     def to_schema
       materialized_option = materialized ? "materialized: true, " : ""
+      safe_to_symbolize_name = name.include?(".") ? "'#{name}'" : name
+
       <<-DEFINITION
-  create_view :#{name}, #{materialized_option} sql_definition: <<-\SQL
+  create_view :#{safe_to_symbolize_name}, #{materialized_option} sql_definition: <<-\SQL
     #{definition.indent(2)}
   SQL
 

data/spec/acceptance/user_manages_views_spec.rb

@@ -0,0 +1,86 @@
+require "acceptance_helper"
+
+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"
+  end
+
+  def successfully(command)
+    `RAILS_ENV=test #{command}`
+    expect($?.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,32 @@
+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
+        rake 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/scenic/adapters/postgres_spec.rb

@@ -38,6 +38,22 @@ module Scenic
         end
       end
 
+      describe "#replace_view" do
+        it "successfully replaces a view" do
+          adapter = Postgres.new
+
+          adapter.create_view("greetings", "SELECT text 'hi' AS greeting")
+
+          view = adapter.views.first.definition
+          expect(view).to eql "SELECT 'hi'::text AS greeting;"
+
+          adapter.replace_view("greetings", "SELECT text 'hello' AS greeting")
+
+          view = adapter.views.first.definition
+          expect(view).to eql "SELECT 'hello'::text AS greeting;"
+        end
+      end
+
       describe "#drop_view" do
         it "successfully drops a view" do
           adapter = Postgres.new
@@ -137,6 +153,27 @@ module Scenic
             "people_with_names",
           ]
         end
+
+        context "with views in non public schemas" do
+          it "returns also the non public views" do
+            adapter = Postgres.new
+
+            ActiveRecord::Base.connection.execute <<-SQL
+              CREATE VIEW parents AS SELECT text 'Joe' AS name
+            SQL
+
+            ActiveRecord::Base.connection.execute <<-SQL
+              CREATE SCHEMA scenic;
+              CREATE VIEW scenic.parents AS SELECT text 'Maarten' AS name;
+              SET search_path TO scenic, public;
+            SQL
+
+            expect(adapter.views.map(&:name)).to eq [
+              "parents",
+              "scenic.parents",
+            ]
+          end
+        end
       end
     end
   end

data/spec/scenic/command_recorder_spec.rb

@@ -65,6 +65,32 @@ describe Scenic::CommandRecorder do
     end
   end
 
+  describe "#replace_view" do
+    it "records the replaced view" do
+      args = [:users, { version: 2 }]
+
+      recorder.replace_view(*args)
+
+      expect(recorder.commands).to eq [[:replace_view, args, nil]]
+    end
+
+    it "reverts to replace_view with the specified revert_to_version" do
+      args = [:users, { version: 2, revert_to_version: 1 }]
+      revert_args = [:users, { version: 1 }]
+
+      recorder.revert { recorder.replace_view(*args) }
+
+      expect(recorder.commands).to eq [[:replace_view, revert_args]]
+    end
+
+    it "raises when reverting without revert_to_version set" do
+      args = [:users, { version: 42, another_argument: 1 }]
+
+      expect { recorder.revert { recorder.replace_view(*args) } }
+        .to raise_error(ActiveRecord::IrreversibleMigration)
+    end
+  end
+
   def recorder
     @recorder ||= ActiveRecord::Migration::CommandRecorder.new
   end

data/spec/scenic/schema_dumper_spec.rb

@@ -20,4 +20,20 @@ describe Scenic::SchemaDumper, :db do
 
     expect(Search.first.haystack).to eq "needle"
   end
+
+  context "with views in non public schemas" do
+    it "dumps a create_view including namespace for a view in the database" do
+      view_definition = "SELECT 'needle'::text AS haystack"
+      Search.connection.execute "CREATE SCHEMA scenic; SET search_path TO scenic, public"
+      Search.connection.create_view :"scenic.searches", sql_definition: view_definition
+      stream = StringIO.new
+
+      ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+
+      output = stream.string
+      expect(output).to include "create_view :'scenic.searches',"
+
+      Search.connection.drop_view :'scenic.searches'
+    end
+  end
 end

data/spec/scenic/statements_spec.rb

@@ -95,6 +95,36 @@ module Scenic
       end
     end
 
+    describe "replace_view" do
+      it "replaces the view in the database" do
+        definition = instance_double("Definition", to_sql: "definition")
+        allow(Definition).to receive(:new)
+          .with(:name, 3)
+          .and_return(definition)
+
+        connection.replace_view(:name, version: 3)
+
+        expect(Scenic.database).to have_received(:replace_view)
+          .with(:name, definition.to_sql)
+      end
+
+      it "fails to replace the materialized view in the database" do
+        definition = instance_double("Definition", to_sql: "definition")
+        allow(Definition).to receive(:new)
+          .with(:name, 3)
+          .and_return(definition)
+
+        expect do
+          connection.replace_view(:name, version: 3, materialized: true)
+        end.to raise_error(ArgumentError, /Cannot replace materialized views/)
+      end
+
+      it "raises an error if not supplied a version" do
+        expect { connection.replace_view :views }
+          .to raise_error(ArgumentError, /version is required/)
+      end
+    end
+
     def connection
       Class.new { extend Statements }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Derek Prior
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -234,6 +234,8 @@ files:
 - lib/scenic/version.rb
 - lib/scenic/view.rb
 - scenic.gemspec
+- spec/acceptance/user_manages_views_spec.rb
+- spec/acceptance_helper.rb
 - spec/dummy/.gitignore
 - spec/dummy/Rakefile
 - spec/dummy/bin/bundle
@@ -258,7 +260,6 @@ files:
 - spec/scenic/definition_spec.rb
 - spec/scenic/schema_dumper_spec.rb
 - spec/scenic/statements_spec.rb
-- spec/smoke
 - spec/spec_helper.rb
 - spec/support/generator_spec_setup.rb
 - spec/support/view_definition_helpers.rb
@@ -282,11 +283,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Support for database views in Rails migrations
 test_files:
+- spec/acceptance/user_manages_views_spec.rb
+- spec/acceptance_helper.rb
 - spec/dummy/.gitignore
 - spec/dummy/Rakefile
 - spec/dummy/bin/bundle
@@ -311,7 +314,6 @@ test_files:
 - spec/scenic/definition_spec.rb
 - spec/scenic/schema_dumper_spec.rb
 - spec/scenic/statements_spec.rb
-- spec/smoke
 - spec/spec_helper.rb
 - spec/support/generator_spec_setup.rb
 - spec/support/view_definition_helpers.rb

data/spec/smoke

@@ -1,135 +0,0 @@
-#!/bin/bash
-
-set -euo pipefail
-
-setup() {
-  cd spec/dummy
-  git init
-  git add -A
-  git commit --no-gpg-sign --message "initial"
-}
-
-teardown() {
-  git add -A
-  git reset --hard HEAD
-  rm -rf .git/
-  rake db:drop db:create
-}
-
-trap teardown EXIT
-
-verifySearchResults() {
-  echo "verify search results"
-  local expectedResult=$1
-  local actualResult=$(rails runner "puts Search.take.results")
-  [[ "$actualResult" == "$expectedResult" ]] || exit 1
-  echo "[success]"
-}
-
-verifySchemaContains() {
-  local expectedString=$1
-  echo "verify schema contains '$expectedString'"
-  grep -q "$expectedString" db/schema.rb || exit 1
-  echo "[success]"
-}
-
-writeToFileAndMigrateAndVerifySearchResults() {
-  echo "write search definition and migrate"
-  local version=$1
-  local expectedResult=$2
-  local filePath=db/views/searches_v$version\.sql
-  cp /dev/null $filePath
-  echo "SELECT '$expectedResult'::text AS results, 1 AS user_id" >> $filePath
-  rake db:migrate
-  echo "[success]"
-  verifySearchResults $expectedResult
-}
-
-main() {
-  setup
-  echo "rails generate scenic:model search"
-  rails generate scenic:model search
-  [[ -f db/views/searches_v01.sql ]] || exit 1
-  [[ -f app/models/search.rb ]] || exit 1
-  [[ -n "$(find db/migrate -maxdepth 1 -name "*create_searches.rb" -print -quit)" ]] || exit 1
-  echo "[success]"
-
-  writeToFileAndMigrateAndVerifySearchResults "01" "search-results"
-
-  echo "rails generate scenic:view search (to get updates search view)"
-  rails generate scenic:view search
-  [[ -f db/views/searches_v02.sql ]] || exit 1
-  cmp db/views/searches_v01.sql db/views/searches_v02.sql || exit 1
-  [[ -n "$(find db/migrate -maxdepth 1 -name "*update_searches_to_version_2.rb" -print -quit)" ]] || exit 1
-  echo "[success]"
-
-  writeToFileAndMigrateAndVerifySearchResults "02" "different-results"
-
-  echo "rake db:rollback"
-  rake db:rollback
-  echo "[success]"
-
-  verifySearchResults "search-results"
-
-  echo "rails destroy scenic:view search"
-  rails destroy scenic:view search
-  [[ ! -f db/views/searches_v02.sql ]] || exit 1
-  [[ -z "$(find db/migrate -maxdepth 1 -name "*update_searches_to_version_2.rb" -print -quit)" ]] || exit 1
-  [[ -f db/views/searches_v01.sql ]] || exit 1
-  [[ -f app/models/search.rb ]] || exit 1
-  [[ -n "$(find db/migrate -maxdepth 1 -name "*create_searches.rb" -print -quit)" ]] || exit 1
-  echo "[success]"
-
-  echo "rake db:rollback"
-  rake db:rollback
-  echo "[success]"
-
-  echo "rails destroy scenic:view search"
-  rails destroy scenic:model search
-  [[ ! -f db/views/searches_v01.sql ]] || exit 1
-  [[ ! -f app/models/search.rb ]] || exit 1
-  [[ -z "$(find db/migrate -maxdepth 1 -name "*create_searches.rb" -print -quit)" ]] || exit 1
-  echo "[success]"
-
-  echo "rails generate scenic:model search (materialized)"
-  rails generate scenic:model search --materialized
-  [[ -f db/views/searches_v01.sql ]] || exit 1
-  [[ -f app/models/search.rb ]] || exit 1
-  [[ -n "$(find db/migrate -maxdepth 1 -name "*create_searches.rb" -print -quit)" ]] || exit 1
-  echo "[success]"
-
-  writeToFileAndMigrateAndVerifySearchResults "01" "search-results"
-
-  echo "refresh materialized view"
-  rails runner "Search.refresh" || exit 1
-  echo "[success]"
-
-  echo "add indexes to materialized view"
-  rails runner 'ActiveRecord::Migration.add_index :searches, :results' || exit 1
-  rails runner 'ActiveRecord::Migration.add_index :searches, :user_id' || exit 1
-  echo "[success]"
-
-  echo "update materialized view"
-  rails generate scenic:view search --materialized
-  echo "SELECT 'test'::text AS results" > db/views/searches_v02.sql
-  rake db:migrate
-  verifySearchResults 'test'
-  verifySchemaContains 'add_index "searches"'
-
-  echo "rake db:rollback"
-  rake db:rollback
-  rake db:rollback
-  echo "[success]"
-
-  echo "rails destroy scenic:model search --materialized"
-  rails destroy scenic:view search --materialized
-  rails destroy scenic:model search --materialized
-  [[ ! -f app/models/search.rb ]] || exit 1
-  [[ ! -f db/views/searches_v01.sql ]] || exit 1
-  [[ -z "$(find db/migrate -maxdepth 1 -name "*create_searches.rb" -print -quit)" ]] || exit 1
-  echo "[success]"
-
-  echo "[done]"
-}
-
-main $*