scenic 0.3.0 → 1.0.0

data/scenic.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1.5'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec', '>= 3.3'
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'ammeter'
+  spec.add_development_dependency 'ammeter', '>= 1.1.3'
 
   spec.add_dependency 'activerecord', '>= 4.0.0'
   spec.add_dependency 'railties', '>= 4.0.0'

data/spec/generators/scenic/model/model_generator_spec.rb

@@ -20,6 +20,17 @@ module Scenic::Generators
       run_generator ["current_customer"]
       model_definition = file("app/models/current_customer.rb")
       expect(model_definition).to exist
+      expect(model_definition).to have_correct_syntax
+      expect(model_definition).not_to contain("self.refresh")
+      expect(model_definition).to have_correct_syntax
+    end
+
+    it "adds a refresh method to materialized models" do
+      run_generator ["active_user", "--materialized"]
+      model_definition = file("app/models/active_user.rb")
+
+      expect(model_definition).to contain("self.refresh")
+      expect(model_definition).to have_correct_syntax
     end
   end
 end

data/spec/generators/scenic/view/view_generator_spec.rb

@@ -16,6 +16,7 @@ describe Scenic::Generators::ViewGenerator, :generator do
     with_view_definition("searches", 1, "hello") do
       migration = file("db/migrate/update_searches_to_version_2.rb")
       view_definition = file("db/views/searches_v02.sql")
+      allow(Dir).to receive(:entries).and_return(["searches_v01.sql"])
 
       run_generator ["search"]
 
@@ -23,4 +24,16 @@ describe Scenic::Generators::ViewGenerator, :generator do
       expect(view_definition).to exist
     end
   end
+
+  it "adds 'materialized: true' to the migration if view is materialized" do
+    with_view_definition("aired_episodes", 1, "hello") do
+      allow(Dir).to receive(:entries).and_return(["aired_episodes_v01.sql"])
+
+      run_generator ["aired_episode", "--materialized"]
+      migration = migration_file(
+        "db/migrate/update_aired_episodes_to_version_2.rb"
+      )
+      expect(migration).to contain "materialized: true"
+    end
+  end
 end

data/spec/scenic/adapters/postgres_spec.rb

@@ -5,34 +5,77 @@ module Scenic
     describe Postgres, :db do
       describe "create_view" do
         it "successfully creates a view" do
-          Postgres.create_view("greetings", "SELECT text 'hi' AS greeting")
+          adapter = Postgres.new
 
-          expect(Postgres.views.map(&:name)).to include("greetings")
+          adapter.create_view("greetings", "SELECT text 'hi' AS greeting")
+
+          expect(adapter.views.map(&:name)).to include("greetings")
+        end
+      end
+
+      describe "create_materialized_view" do
+        it "successfully creates a materialized view" do
+          adapter = Postgres.new
+
+          adapter.create_materialized_view(
+            "greetings",
+            "SELECT text 'hi' AS greeting",
+          )
+
+          view = adapter.views.first
+          expect(view.name).to eq("greetings")
+          expect(view.materialized).to eq true
         end
       end
 
       describe "drop_view" do
         it "successfully drops a view" do
-          Postgres.create_view("greetings", "SELECT text 'hi' AS greeting")
+          adapter = Postgres.new
 
-          Postgres.drop_view("greetings")
+          adapter.create_view("greetings", "SELECT text 'hi' AS greeting")
+          adapter.drop_view("greetings")
 
-          expect(Postgres.views.map(&:name)).not_to include("greetings")
+          expect(adapter.views.map(&:name)).not_to include("greetings")
         end
       end
 
-      describe "views" do
-        it "finds views and builds Scenic::View objects" do
-          ActiveRecord::Base.connection.execute "CREATE VIEW greetings AS SELECT text 'hi' AS greeting"
+      describe "drop_materialized_view" do
+        it "successfully drops a materialized view" do
+          adapter = Postgres.new
 
-          expect(Postgres.views).to eq([
-            View.new(
-              "viewname" => "greetings",
-              "definition" => "SELECT 'hi'::text AS greeting;",
-            ),
-          ])
+          adapter.create_materialized_view(
+            "greetings",
+            "SELECT text 'hi' AS greeting",
+          )
+          adapter.drop_materialized_view("greetings")
+
+          expect(adapter.views.map(&:name)).not_to include("greetings")
         end
       end
+
+      it "finds views and builds Scenic::View objects" do
+        adapter = Postgres.new
+
+        ActiveRecord::Base.connection.execute(
+          "CREATE VIEW greetings AS SELECT text 'hi' AS greeting"
+        )
+        ActiveRecord::Base.connection.execute(
+          "CREATE MATERIALIZED VIEW farewells AS SELECT text 'bye' AS farewell"
+        )
+
+        expect(adapter.views).to eq([
+          Scenic::View.new(
+            name: "farewells",
+            definition: "SELECT 'bye'::text AS farewell;",
+            materialized: true,
+          ),
+          Scenic::View.new(
+            name: "greetings",
+            definition: "SELECT 'hi'::text AS greeting;",
+            materialized: false,
+          ),
+        ])
+      end
     end
   end
 end

data/spec/scenic/configuration_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+module Scenic
+  describe Configuration do
+    after { restore_default_config }
+
+    it "defaults the database adapter to postgres" do
+      expect(Scenic.configuration.database).to be_a Adapters::Postgres
+      expect(Scenic.database).to be_a Adapters::Postgres
+    end
+
+    it "allows the database adapter to be set" do
+      adapter = double("Scenic Adapter")
+
+      Scenic.configure do |config|
+        config.database = adapter
+      end
+
+      expect(Scenic.configuration.database).to eq adapter
+      expect(Scenic.database).to eq adapter
+    end
+
+    def restore_default_config
+      Scenic.configuration = Configuration.new
+    end
+  end
+end

data/spec/scenic/statements_spec.rb

@@ -3,8 +3,8 @@ require "spec_helper"
 module Scenic
   describe Scenic::Statements do
     before do
-      allow(Scenic).to receive(:database)
-        .and_return(class_double("Scenic::Adapters::Postgres").as_null_object)
+      adapter = instance_double("Scenic::Adapaters::Postgres").as_null_object
+      allow(Scenic).to receive(:database).and_return(adapter)
     end
 
     describe "create_view" do
@@ -37,6 +37,17 @@ module Scenic
       end
     end
 
+    describe "create_view :materialized" do
+      it "sends the create_materialized_view message" do
+        allow(Definition).to receive(:new)
+          .and_return(instance_double("Scenic::Definition").as_null_object)
+
+        connection.create_view(:views, version: 1, materialized: true)
+
+        expect(Scenic.database).to have_received(:create_materialized_view)
+      end
+    end
+
     describe "drop_view" do
       it "removes a view from the database" do
         connection.drop_view :name
@@ -45,6 +56,14 @@ module Scenic
       end
     end
 
+    describe "drop_view :materialized" do
+      it "removes a materialized view from the database" do
+        connection.drop_view :name, materialized: true
+
+        expect(Scenic.database).to have_received(:drop_materialized_view)
+      end
+    end
+
     describe "update_view" do
       it "drops the existing version and creates the new" do
         definition = instance_double("Definition", to_sql: "definition")
@@ -65,6 +84,18 @@ module Scenic
       end
     end
 
+    describe "update_view :materialized" do
+      it "raises an error because this is not supported" do
+        definition = instance_double("Definition").as_null_object
+        allow(Definition).to receive(:new).and_return(definition)
+
+        expect { connection.update_view(:name, version: 3, materialized: true) }.
+          to raise_error(/not supported/)
+        expect(Scenic.database).not_to have_received(:drop_materialized_view)
+        expect(Scenic.database).not_to have_received(:create_materialized_view)
+      end
+    end
+
     def connection
       Class.new { extend Statements }
     end

data/spec/smoke

@@ -3,87 +3,112 @@
 set -euo pipefail
 
 setup() {
-	cd spec/dummy
-	git init
-	git add -A
-	git commit --no-gpg-sign --message "initial"
+  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
+  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.first.results")
-	[[ "$actualResult" == "$expectedResult" ]] || exit 1
-	echo "[success]"
+  echo "verify search results"
+  local expectedResult=$1
+  local actualResult=$(rails runner "puts Search.first.results")
+  [[ "$actualResult" == "$expectedResult" ]] || 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" >> $filePath
-	rake db:migrate
-	echo "[success]"
-	verifySearchResults $expectedResult
+  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" >> $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 "[done]"
+  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 "rake db:rollback"
+  rake db:rollback
+  echo "[success]"
+
+  echo "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 $*

data/spec/support/generator_spec_setup.rb

@@ -1,3 +1,4 @@
+require "rspec/rails"
 require "ammeter/rspec/generator/example.rb"
 require "ammeter/rspec/generator/matchers.rb"
 require "ammeter/init"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Derek Prior
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,16 +57,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -150,11 +150,16 @@ files:
 - ".gitignore"
 - ".hound.yml"
 - ".travis.yml"
+- ".yardopts"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - NEWS.md
 - README.md
 - Rakefile
+- bin/setup
+- lib/generators/scenic/generators.rb
+- lib/generators/scenic/materializable.rb
 - lib/generators/scenic/model/USAGE
 - lib/generators/scenic/model/model_generator.rb
 - lib/generators/scenic/model/templates/model.erb
@@ -166,6 +171,7 @@ files:
 - lib/scenic/adapters/postgres.rb
 - lib/scenic/command_recorder.rb
 - lib/scenic/command_recorder/statement_arguments.rb
+- lib/scenic/configuration.rb
 - lib/scenic/definition.rb
 - lib/scenic/railtie.rb
 - lib/scenic/schema_dumper.rb
@@ -186,12 +192,14 @@ files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/test.rb
 - spec/dummy/db/migrate/.keep
+- spec/dummy/db/views/.keep
 - spec/generators/scenic/model/model_generator_spec.rb
 - spec/generators/scenic/view/view_generator_spec.rb
 - spec/integration/revert_spec.rb
 - spec/scenic/adapters/postgres_spec.rb
 - spec/scenic/command_recorder/statement_arguments_spec.rb
 - spec/scenic/command_recorder_spec.rb
+- spec/scenic/configuration_spec.rb
 - spec/scenic/definition_spec.rb
 - spec/scenic/schema_dumper_spec.rb
 - spec/scenic/statements_spec.rb
@@ -219,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Support for database views in Rails migrations
@@ -237,12 +245,14 @@ test_files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/test.rb
 - spec/dummy/db/migrate/.keep
+- spec/dummy/db/views/.keep
 - spec/generators/scenic/model/model_generator_spec.rb
 - spec/generators/scenic/view/view_generator_spec.rb
 - spec/integration/revert_spec.rb
 - spec/scenic/adapters/postgres_spec.rb
 - spec/scenic/command_recorder/statement_arguments_spec.rb
 - spec/scenic/command_recorder_spec.rb
+- spec/scenic/configuration_spec.rb
 - spec/scenic/definition_spec.rb
 - spec/scenic/schema_dumper_spec.rb
 - spec/scenic/statements_spec.rb
@@ -250,4 +260,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/generator_spec_setup.rb
 - spec/support/view_definition_helpers.rb
-has_rdoc: