scenic 1.4.1 → 1.5.0

data/README.md

@@ -1,10 +1,10 @@
 # Scenic
 
-![Scenic Landscape](https://images.thoughtbot.com/announcing-scenic--versioned-database-views-for-rails/MRUcPsxrTGCeWKyE59Zg_landscape.png)
+![Scenic Landscape](https://user-images.githubusercontent.com/152152/49344534-a8817480-f646-11e8-8431-3d95d349c070.png)
 
-[![Build Status](https://travis-ci.org/thoughtbot/scenic.svg)](https://travis-ci.org/thoughtbot/scenic)
-[![Code Climate](https://codeclimate.com/repos/53c9736269568066a3000c35/badges/85aa9b19f3037252c55d/gpa.svg)](https://codeclimate.com/repos/53c9736269568066a3000c35/feed)
-[![Documentation Quality](http://inch-ci.org/github/thoughtbot/scenic.svg?branch=master)](http://inch-ci.org/github/thoughtbot/scenic)
+[![Build Status](https://travis-ci.org/scenic-views/scenic.svg?branch=master)](https://travis-ci.org/scenic-views/scenic)
+[![Documentation Quality](http://inch-ci.org/github/scenic-views/scenic.svg?branch=master)](http://inch-ci.org/github/scenic-views/scenic)
+[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 
 Scenic adds methods to `ActiveRecord::Migration` to create and manage database
 views in Rails.
@@ -21,6 +21,12 @@ Scenic ships with support for PostgreSQL. The adapter is configurable (see
 `Scenic::Configuration`) and has a minimal interface (see
 `Scenic::Adapters::Postgres`) that other gems can provide.
 
+## So how do I install this?
+
+If you're using Postgres, Add `gem "scenic"` to your Gemfile and run `bundle
+install`. If you're using something other than Postgres, check out the available
+[third party adapters](https://github.com/scenic-views/scenic#faqs).
+
 ## Great, how do I create a view?
 
 You've got this great idea for a view you'd like to call `search_results`. You
@@ -247,21 +253,14 @@ We are aware of the following existing adapter libraries for Scenic which may
 meet your needs:
 
 * [scenic_sqlite_adapter](https://github.com/pdebelak/scenic_sqlite_adapter)
-* [scenic-mysql_adapter](https://github.com/EmpaticoOrg/scenic-mysql_adapter.)
+* [scenic-mysql_adapter](https://github.com/EmpaticoOrg/scenic-mysql_adapter)
+* [scenic-sqlserver-adapter](https://github.com/ClickMechanic/scenic_sqlserver_adapter)
+* [scenic-oracle_enhanced_adapter](https://github.com/PMACS/scenic_oracle_enhanced_adapter)
 
 ## About
 
-Scenic is maintained by [Derek Prior] and [Caleb Thompson], funded by
-thoughtbot, inc. The names and logos for thoughtbot are trademarks of
-thoughtbot, inc.
+Scenic is maintained by [Derek Prior], [Caleb Thompson], and you, our
+contributors.
 
 [Derek Prior]: http://prioritized.net
 [Caleb Thompson]: http://calebthompson.io
-
-![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
-
-We love open source software!  See [our other projects][community] or [hire
-us][hire] to help build your product.
-
-[community]: https://thoughtbot.com/community?utm_source=github
-[hire]: https://thoughtbot.com/hire-us?utm_source=github

data/Rakefile

@@ -1,5 +1,5 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/gemfiles/rails42.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "activerecord", "~> 4.2.0"
 gem "railties", "~> 4.2.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails50.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.0.0"
 gem "railties", "~> 5.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.1.0"
 gem "railties", "~> 5.1.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "railties", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", :git => "https://github.com/rails/rails"
-gem "arel", :git => "https://github.com/rails/arel"
+gem "rails", git: "https://github.com/rails/rails"
+gem "arel", git: "https://github.com/rails/arel"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/generators/scenic/materializable.rb

@@ -10,6 +10,11 @@ module Scenic
           required: false,
           desc: "Makes the view materialized",
           default: false
+        class_option :no_data,
+          type: :boolean,
+          required: false,
+          desc: "Adds WITH NO DATA when materialized view creates/updates",
+          default: false
       end
 
       private
@@ -17,6 +22,10 @@ module Scenic
       def materialized?
         options[:materialized]
       end
+
+      def no_data?
+        options[:no_data]
+      end
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Scenic
     # @api private
     class ModelGenerator < Rails::Generators::NamedBase
       include Scenic::Generators::Materializable
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def invoke_rails_model_generator
         invoke "model",
@@ -35,7 +35,7 @@ module Scenic
 
       def evaluate_template(source)
         source  = File.expand_path(find_in_source_paths(source.to_s))
-        context = instance_eval("binding")
+        context = instance_eval("binding", __FILE__, __LINE__)
         ERB.new(
           ::File.binread(source),
           nil,

data/lib/generators/scenic/view/USAGE

@@ -6,6 +6,7 @@ Description:
   and a migration to replace the old version with the new.
 
   To create a materialized view, pass the '--materialized' option.
+  To create a materialized view with NO DATA, pass '--no-data' option.
 
 Examples:
     rails generate scenic:view searches

data/lib/generators/scenic/view/templates/db/migrate/create_view.erb

@@ -1,5 +1,5 @@
 class <%= migration_class_name %> < <%= activerecord_migration_class %>
   def change
-    create_view <%= formatted_plural_name %><%= ", materialized: true" if materialized? %>
+    create_view <%= formatted_plural_name %><%= create_view_options %>
   end
 end

data/lib/generators/scenic/view/templates/db/migrate/update_view.erb

@@ -4,7 +4,7 @@ class <%= migration_class_name %> < <%= activerecord_migration_class %>
     update_view <%= formatted_plural_name %>,
       version: <%= version %>,
       revert_to_version: <%= previous_version %>,
-      materialized: true
+      materialized: <%= no_data? ? "{ no_data: true }" : true %>
   <%- else -%>
     update_view <%= formatted_plural_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
   <%- end -%>

data/lib/generators/scenic/view/view_generator.rb

@@ -8,7 +8,7 @@ module Scenic
     class ViewGenerator < Rails::Generators::NamedBase
       include Rails::Generators::Migration
       include Scenic::Generators::Materializable
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def create_views_directory
         unless views_directory_path.exist?
@@ -56,7 +56,7 @@ module Scenic
 
         def migration_class_name
           if creating_new_view?
-            "Create#{class_name.gsub('.', '').pluralize}"
+            "Create#{class_name.tr('.', '').pluralize}"
           else
             "Update#{class_name.pluralize}ToVersion#{version}"
           end
@@ -74,7 +74,7 @@ module Scenic
       private
 
       def views_directory_path
-        @views_directory_path ||= Rails.root.join(*%w(db views))
+        @views_directory_path ||= Rails.root.join("db", "views")
       end
 
       def version_regex
@@ -82,7 +82,7 @@ module Scenic
       end
 
       def creating_new_view?
-        previous_version == 0
+        previous_version.zero?
       end
 
       def definition
@@ -94,7 +94,7 @@ module Scenic
       end
 
       def plural_file_name
-        @plural_file_name ||= file_name.pluralize.gsub(".", "_")
+        @plural_file_name ||= file_name.pluralize.tr(".", "_")
       end
 
       def destroying?
@@ -109,6 +109,14 @@ module Scenic
         end
       end
 
+      def create_view_options
+        if materialized?
+          ", materialized: #{no_data? ? '{ no_data: true }' : true}"
+        else
+          ""
+        end
+      end
+
       def destroying_initial_view?
         destroying? && version == 1
       end

data/lib/scenic/adapters/postgres.rb

@@ -122,6 +122,9 @@ module Scenic
       #
       # @param name The name of the materialized view to create
       # @param sql_definition The SQL schema that defines the materialized view.
+      # @param no_data [Boolean] Default: false. Set to true to create
+      #   materialized view without running the associated query. You will need
+      #   to perform a non-concurrent refresh to populate with data.
       #
       # This is typically called in a migration via {Statements#create_view}.
       #
@@ -129,9 +132,13 @@ module Scenic
       #   in use does not support materialized views.
       #
       # @return [void]
-      def create_materialized_view(name, sql_definition)
+      def create_materialized_view(name, sql_definition, no_data: false)
         raise_unless_materialized_views_supported
-        execute "CREATE MATERIALIZED VIEW #{quote_table_name(name)} AS #{sql_definition};"
+        execute <<-SQL
+  CREATE MATERIALIZED VIEW #{quote_table_name(name)} AS
+  #{sql_definition}
+  #{'WITH NO DATA' if no_data};
+        SQL
       end
 
       # Updates a materialized view in the database.
@@ -144,17 +151,20 @@ module Scenic
       #
       # @param name The name of the view to update
       # @param sql_definition The SQL schema for the updated view.
+      # @param no_data [Boolean] Default: false. Set to true to create
+      #   materialized view without running the associated query. You will need
+      #   to perform a non-concurrent refresh to populate with data.
       #
       # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
       #   in use does not support materialized views.
       #
       # @return [void]
-      def update_materialized_view(name, sql_definition)
+      def update_materialized_view(name, sql_definition, no_data: false)
         raise_unless_materialized_views_supported
 
         IndexReapplication.new(connection: connection).on(name) do
           drop_materialized_view(name)
-          create_materialized_view(name, sql_definition)
+          create_materialized_view(name, sql_definition, no_data: no_data)
         end
       end
 

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

@@ -46,10 +46,20 @@ module Scenic
           def to_sorted_array
             dependency_hash = parse_to_hash(raw_dependencies)
             sorted_arr = tsort(dependency_hash)
+
             idx = sorted_arr.find_index do |dep|
-              dep.include?(view_to_refresh.to_s)
+              if view_to_refresh.to_s.include?(".")
+                dep == view_to_refresh.to_s
+              else
+                dep.ends_with?(".#{view_to_refresh}")
+              end
+            end
+
+            if idx.present?
+              sorted_arr[0...idx]
+            else
+              []
             end
-            sorted_arr[0...idx]
           end
 
           private

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

@@ -57,7 +57,16 @@ module Scenic
 
         def pg_identifier(name)
           return name if name =~ /^[a-zA-Z_][a-zA-Z0-9_]*$/
-          PGconn.quote_ident(name)
+
+          pgconn.quote_ident(name)
+        end
+
+        def pgconn
+          if defined?(PG::Connection)
+            PG::Connection
+          else
+            PGconn
+          end
         end
       end
     end

data/lib/scenic/schema_dumper.rb

@@ -32,8 +32,8 @@ module Scenic
       def ignored?(table_name)
         ["schema_migrations", ignore_tables].flatten.any? do |ignored|
           case ignored
-          when String; remove_prefix_and_suffix(table_name) == ignored
-          when Regexp; remove_prefix_and_suffix(table_name) =~ ignored
+          when String then remove_prefix_and_suffix(table_name) == ignored
+          when Regexp then remove_prefix_and_suffix(table_name) =~ ignored
           else
             raise StandardError, "ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values."
           end

data/lib/scenic/statements.rb

@@ -9,8 +9,9 @@ module Scenic
     # @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] Set to true to create a materialized view.
-    #   Defaults to false.
+    # @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`
@@ -36,7 +37,11 @@ module Scenic
       sql_definition ||= definition(name, version)
 
       if materialized
-        Scenic.database.create_materialized_view(name, sql_definition)
+        Scenic.database.create_materialized_view(
+          name,
+          sql_definition,
+          no_data: no_data(materialized),
+        )
       else
         Scenic.database.create_view(name, sql_definition)
       end
@@ -75,8 +80,9 @@ module Scenic
     #   as they are mutually exclusive.
     # @param revert_to_version [Fixnum] The version number to rollback to on
     #   `rake db rollback`
-    # @param materialized [Boolean] True if updating a materialized view.
-    #   Defaults to false.
+    # @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
@@ -100,7 +106,11 @@ module Scenic
       sql_definition ||= definition(name, version)
 
       if materialized
-        Scenic.database.update_materialized_view(name, sql_definition)
+        Scenic.database.update_materialized_view(
+          name,
+          sql_definition,
+          no_data: no_data(materialized),
+        )
       else
         Scenic.database.update_view(name, sql_definition)
       end
@@ -141,5 +151,13 @@ module Scenic
     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

@@ -1,3 +1,3 @@
 module Scenic
-  VERSION = "1.4.1".freeze
+  VERSION = "1.5.0".freeze
 end

data/lib/scenic/view.rb

@@ -45,10 +45,9 @@ module Scenic
       materialized_option = materialized ? "materialized: true, " : ""
 
       <<-DEFINITION
-  create_view #{name.inspect}, #{materialized_option} sql_definition: <<-\SQL
+  create_view #{name.inspect}, #{materialized_option}sql_definition: <<-\SQL
     #{definition.indent(2)}
   SQL
-
       DEFINITION
     end
   end

data/scenic.gemspec

@@ -1,38 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'scenic/version'
+require "scenic/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'scenic'
+  spec.name          = "scenic"
   spec.version       = Scenic::VERSION
-  spec.authors       = ['Derek Prior', 'Caleb Thompson']
-  spec.email         = ['derekprior@gmail.com', 'caleb@calebthompson.io']
-  spec.summary       = %q{Support for database views in Rails migrations}
+  spec.authors       = ["Derek Prior", "Caleb Thompson"]
+  spec.email         = ["derekprior@gmail.com", "caleb@calebthompson.io"]
+  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/thoughtbot/scenic'
-  spec.license       = 'MIT'
+  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.require_paths = ["lib"]
 
-  spec.add_development_dependency 'appraisal'
-  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'
-  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_development_dependency "appraisal"
+  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.add_dependency "activerecord", ">= 4.0.0"
+  spec.add_dependency "railties", ">= 4.0.0"
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = ">= 2.3.0"
 end