scenic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f9265748cd49c4ab094b3cb7110b61e0bef6b35
+  data.tar.gz: c3bd33b0d1ee11d1d807b1a12046839bb8fce53c
+SHA512:
+  metadata.gz: 6dd62a29b6991a7c21283764d64c38851ca550a1fa690d8496ee56a6fd0448c81f66c9aaa78e2c9ebabcc430ea1be2b0213f5b7315e05e2c55d4911f5cfb9115
+  data.tar.gz: 8248642a38d1c583b6883af55a186bea5d2926faa8dcf790996c082ad8d110da74f785db50b4a33bd948fbe6f4b4ea99e7214fdd1afc4641f17d6d2f600b06ec

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.hound.yml

@@ -0,0 +1,2 @@
+DotPosition:
+  EnforcedStyle: leading

data/.travis.yml

@@ -0,0 +1,17 @@
+before_install:
+  - "echo '--colour' > ~/.rspec"
+  - "echo 'gem: --no-document' > ~/.gemrc"
+before_script:
+  - pushd spec/dummy && bundle exec rake db:create && popd
+branches:
+  only:
+    - master
+cache:
+  - bundler
+language:
+  - ruby
+notifications:
+  email:
+    - false
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scenic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Derek Prior
+
+MIT License
+
+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,96 @@
+# Scenic
+
+![Boston cityscape - it's scenic](http://www.california-tour.com/blog/wp-content/uploads/2011/11/skyline-boats-shutterstock-superreduced.jpg)
+
+## Description
+
+Scenic adds methods to ActiveRecord::Migration to create and manage database
+views in Rails.
+
+Using Scenic, you can use the power of SQL views in your Rails application
+without having to switch your schema format to SQL. Scenic also handles
+versioning your views in a way that eliminates duplication across migrations. As
+an added bonus, you define the structure of your view in a SQL file, meaning you
+get full SQL syntax highlighting support in the editor of your choice.
+
+## Great, how do I create a view?
+
+You've got this great idea for a view you'd like to call `searches`. Create a
+definition file at `db/views/searches_v1.sql` which contains the query you'd
+like to build your view with. Perhaps that looks something like this:
+
+```sql
+SELECT
+  statuses.id AS searchable_id,
+  'Status' AS searchable_type,
+  comments.body AS term
+FROM statuses
+JOIN comments ON statuses.id = comments.status_id
+
+UNION
+
+SELECT
+  statuses.id AS searchable_id,
+  'Status' AS searchable_type,
+  statuses.body AS term
+FROM statuses
+```
+
+Generate a new migration with the following `change` method:
+
+```ruby
+def change
+  create_view :searches
+end
+```
+
+Run that migration and congrats, you've got yourself a view. The migration is
+reversible and it will be dumped into your `schema.rb` file.
+
+## Cool, but what if I need to change that view?
+
+Add the new query to `db/views/searches_v2.sql` and generate a new migration with
+the following `change` method:
+
+```ruby
+def change
+  update_view :searches, version: 2, revert_to_version: 1
+end
+```
+
+When you run that migration, your view will be updated. The `revert_to_version`
+option makes that migration reversible.
+
+## Can I use this view to back a model?
+
+You bet!
+
+```ruby
+class Search < ActiveRecord::Base
+  private
+
+  # this isn't strictly necessary, but it will prevent
+  # rails from calling save, which would fail anyway.
+  def readonly?
+    true
+  end
+end
+```
+
+## I don't need this view anymore. Make it go away.
+
+We give you `drop_view` too:
+
+```ruby
+def change
+  drop_view :searches, revert_to_version: 2
+end
+```
+
+## Can you make this easier?
+
+Yeah, we're working on it. We're going to provide some generators that will take
+some of the busy work of file creation away. We'll create the SQL file, the
+migration, and optionally the model for you.
+
+Check out the issue tracker for our other plans.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/scenic/model/USAGE

@@ -0,0 +1,10 @@
+Description:
+  Create a new database view and ActiveRecord::Base subclass for your
+  application.
+
+Examples:
+    rails generate scenic:model search
+
+      create: app/models/search.rb
+      create: db/views/searches_v1.sql
+      create: db/migrate/20140803191158_create_searches.rb

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

@@ -0,0 +1,20 @@
+require "rails/generators"
+require "generators/scenic/view/view_generator"
+
+module Scenic
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      check_class_collision
+
+      def create_model_file
+        template("model.erb", "app/models/#{file_name}.rb")
+      end
+
+      def invoke_view_generator
+        invoke "scenic:view", [singular_name]
+      end
+    end
+  end
+end

data/lib/generators/scenic/model/templates/model.erb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/lib/generators/scenic/view/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Create a new database view for your application. This will create a new
+  view definition file and the accompanying migration.
+
+Examples:
+    rails generate scenic:view searches
+
+      create: db/views/searches_v1.sql
+      create: db/migrate/20140803191158_create_searches.rb

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

@@ -0,0 +1,5 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_view :<%= plural_name %>
+  end
+end

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

@@ -0,0 +1,26 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Scenic
+  module Generators
+    class ViewGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_view_definition
+        create_file "db/views/#{plural_name}_v1.sql"
+      end
+
+      def create_migration_file
+        migration_template(
+          "db/migrate/create_view.erb",
+          "db/migrate/create_#{plural_name}.rb"
+        )
+      end
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+    end
+  end
+end

data/lib/scenic/active_record/command_recorder/statement_arguments.rb

@@ -0,0 +1,44 @@
+module Scenic
+  module ActiveRecord
+    module CommandRecorder
+      class StatementArguments
+        def initialize(args)
+          @args = args.freeze
+        end
+
+        def view
+          @args[0]
+        end
+
+        def version
+          options[:version]
+        end
+
+        def revert_to_version
+          options[:revert_to_version]
+        end
+
+        def invert_version
+          StatementArguments.new([view, options_for_revert])
+        end
+
+        def to_a
+          @args.to_a
+        end
+
+        private
+
+        def options
+          @options ||= @args[1] || {}
+        end
+
+        def options_for_revert
+          options.clone.tap do |revert_options|
+            revert_options[:version] = revert_to_version
+            revert_options.delete(:revert_to_version)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scenic/active_record/command_recorder.rb

@@ -0,0 +1,44 @@
+require "scenic/active_record/command_recorder/statement_arguments"
+
+module Scenic
+  module ActiveRecord
+    module CommandRecorder
+      def create_view(*args)
+        record(:create_view, args)
+      end
+
+      def drop_view(*args)
+        record(:drop_view, args)
+      end
+
+      def update_view(*args)
+        record(:update_view, args)
+      end
+
+      def invert_create_view(args)
+        [:drop_view, args]
+      end
+
+      def invert_drop_view(args)
+        perform_scenic_inversion(:create_view, args)
+      end
+
+      def invert_update_view(args)
+        perform_scenic_inversion(:update_view, args)
+      end
+
+      private
+
+      def perform_scenic_inversion(method, args)
+        scenic_args = StatementArguments.new(args)
+
+        if scenic_args.revert_to_version.nil?
+          message = "#{method} is reversible only if given a revert_to_version"
+          raise ::ActiveRecord::IrreversibleMigration, message
+        end
+
+        [method, scenic_args.invert_version.to_a]
+      end
+    end
+  end
+end

data/lib/scenic/active_record/schema_dumper.rb

@@ -0,0 +1,52 @@
+require "rails"
+
+module Scenic
+  module ActiveRecord
+    module SchemaDumper
+      extend ActiveSupport::Concern
+
+      included { alias_method_chain :tables, :views }
+
+      def tables_with_views(stream)
+        tables_without_views(stream)
+        views(stream)
+      end
+
+      def views(stream)
+        defined_views.sort.each do |view_name|
+          next if ["schema_migrations", ignore_tables].flatten.any? do |ignored|
+            case ignored
+            when String; remove_prefix_and_suffix(view_name) == ignored
+            when Regexp; remove_prefix_and_suffix(view_name) =~ ignored
+            else
+              raise StandardError, "ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values."
+            end
+          end
+          view(view_name, stream)
+        end
+      end
+
+      def view(name, stream)
+        stream.puts(<<-DEFINITION)
+  create_view :#{name}, sql_definition:<<-\SQL
+#{views_with_definitions[name]}
+  SQL
+        DEFINITION
+        stream
+      end
+
+      def defined_views
+        views_with_definitions.keys
+      end
+
+      def views_with_definitions
+        @views_with_definitions ||=
+          Hash[@connection.execute(<<-SQL, 'SCHEMA').values]
+            SELECT viewname, definition
+            FROM pg_views
+            WHERE schemaname = ANY (current_schemas(false))
+          SQL
+      end
+    end
+  end
+end

data/lib/scenic/active_record/statements.rb

@@ -0,0 +1,37 @@
+module Scenic
+  module ActiveRecord
+    module Statements
+      def create_view(name, version: 1, sql_definition: nil)
+        if version.nil? && sql_definition.nil?
+          raise(
+            ArgumentError,
+            "view_definition or version_number must be specified"
+          )
+        end
+
+        sql_definition ||= definition(name, version)
+
+        execute "CREATE VIEW #{name} AS #{sql_definition};"
+      end
+
+      def drop_view(name, revert_to_version: nil)
+        execute "DROP VIEW #{name};"
+      end
+
+      def update_view(name, version: nil, revert_to_version: nil)
+        if version.nil?
+          raise ArgumentError, "version is required"
+        end
+
+        drop_view(name)
+        create_view(name, version: version)
+      end
+
+      private
+
+      def definition(name, version)
+        File.read(::Rails.root.join("db", "views", "#{name}_v#{version}.sql"))
+      end
+    end
+  end
+end

data/lib/scenic/railtie.rb

@@ -0,0 +1,11 @@
+require "rails/railtie"
+
+module Scenic
+  class Railtie < Rails::Railtie
+    initializer "scenic.load" do
+      ActiveSupport.on_load :active_record do
+        Scenic.load
+      end
+    end
+  end
+end

data/lib/scenic/version.rb

@@ -0,0 +1,3 @@
+module Scenic
+  VERSION = "0.1.0"
+end

data/lib/scenic.rb

@@ -0,0 +1,21 @@
+require "scenic/version"
+require "scenic/railtie"
+require "scenic/active_record/command_recorder"
+require "scenic/active_record/schema_dumper"
+require "scenic/active_record/statements"
+
+module Scenic
+  def self.load
+    ::ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+      include Scenic::ActiveRecord::Statements
+    end
+
+    ::ActiveRecord::Migration::CommandRecorder.class_eval do
+      include Scenic::ActiveRecord::CommandRecorder
+    end
+
+    ::ActiveRecord::SchemaDumper.class_eval do
+      include Scenic::ActiveRecord::SchemaDumper
+    end
+  end
+end

data/scenic.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scenic/version'
+
+Gem::Specification.new do |spec|
+  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.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.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.0'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'ammeter'
+
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'railties', '>= 4.0.0'
+
+  spec.required_ruby_version = '~> 2.0'
+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,6 @@
+# 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

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/application.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../boot", __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+
+Bundler.require(*Rails.groups)
+require "scenic"
+
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../../Gemfile", __FILE__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,9 @@
+development: &default
+  adapter: postgresql
+  database: dummy_development
+  encoding: unicode
+  pool: 5
+
+test:
+  <<: *default
+  database: dummy_test

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path("../application", __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,6 @@
+Rails.application.configure do
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,5 @@
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = false
+  config.active_support.deprecation = :stderr
+end

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

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

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "generators/scenic/model/model_generator"
+
+describe Scenic::Generators::ModelGenerator, :generator do
+  before do
+    allow(Scenic::Generators::ViewGenerator).to receive(:new)
+      .and_return(
+        instance_double("Scenic::Generators::ViewGenerator").as_null_object
+      )
+  end
+
+  it "invokes the view generator" do
+    run_generator ["current_customer"]
+
+    expect(Scenic::Generators::ViewGenerator).to have_received(:new)
+  end
+
+  it "creates a migration to create the view" do
+    run_generator ["current_customer"]
+    model_definition = file("app/models/current_customer.rb")
+    expect(model_definition).to exist
+  end
+end

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

@@ -0,0 +1,16 @@
+require "spec_helper"
+require "generators/scenic/view/view_generator"
+
+describe Scenic::Generators::ViewGenerator, :generator do
+  it "creates a view definition file" do
+    run_generator ["search"]
+    view_definition = file("db/views/searches_v1.sql")
+    expect(view_definition).to exist
+  end
+
+  it "creates a migration to create the view" do
+    run_generator ["search"]
+    migration = file("db/migrate/create_searches.rb")
+    expect(migration).to be_a_migration
+  end
+end

data/spec/integration/revert_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe "Reverting scenic schema statements", :db do
+  around do |example|
+    with_view_definition :greetings, 1, "SELECT text 'hola' AS greeting" do
+      example.run
+    end
+  end
+
+  it "reverts dropped view to specified version" do
+    run_migration(migration_for_create, :up)
+    run_migration(migration_for_drop, :up)
+    run_migration(migration_for_drop, :down)
+
+    expect { execute("SELECT * from greetings") }
+      .not_to raise_error
+  end
+
+  it "reverts updated view to specified version" do
+    with_view_definition :greetings, 2, "SELECT text 'good day' AS greeting" do
+      run_migration(migration_for_create, :up)
+      run_migration(migration_for_update, :up)
+      run_migration(migration_for_update, :down)
+
+      greeting = execute("SELECT * from greetings")[0]["greeting"]
+
+      expect(greeting).to eq "hola"
+    end
+  end
+
+  def migration_for_create
+    Class.new(::ActiveRecord::Migration) do
+      def change
+        create_view :greetings
+      end
+    end
+  end
+
+  def migration_for_drop
+    Class.new(::ActiveRecord::Migration) do
+      def change
+        drop_view :greetings, revert_to_version: 1
+      end
+    end
+  end
+
+  def migration_for_update
+    Class.new(::ActiveRecord::Migration) do
+      def change
+        update_view :greetings, version: 2, revert_to_version: 1
+      end
+    end
+  end
+
+  def run_migration(migration, directions)
+    silence_stream(STDOUT) do
+      Array.wrap(directions).each do |direction|
+        migration.migrate(direction)
+      end
+    end
+  end
+
+  def execute(sql)
+    ActiveRecord::Base.connection.execute(sql)
+  end
+end

data/spec/scenic/active_record/command_recorder/statement_arguments_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+module Scenic::ActiveRecord::CommandRecorder
+  describe StatementArguments do
+    describe "#view" do
+      it "is the view name" do
+        raw_args = [:spaceships, { foo: :bar }]
+        args = StatementArguments.new(raw_args)
+
+        expect(args.view).to eq :spaceships
+      end
+    end
+
+    describe "#revert_to_version" do
+      it "is the revert_to_version from the keyword arguments" do
+        raw_args = [:spaceships, { revert_to_version: 42 }]
+        args = StatementArguments.new(raw_args)
+
+        expect(args.revert_to_version).to eq 42
+      end
+
+      it "is nil if the revert_to_version was not supplied" do
+        raw_args = [:spaceships, { foo: :bar }]
+        args = StatementArguments.new(raw_args)
+
+        expect(args.revert_to_version).to be nil
+      end
+    end
+
+    describe "#invert_version" do
+      it "returns object with version set to revert_to_version" do
+        raw_args = [:meatballs, { version: 42, revert_to_version: 15 }]
+
+        inverted_args = StatementArguments.new(raw_args).invert_version
+
+        expect(inverted_args.version).to eq 15
+        expect(inverted_args.revert_to_version).to be nil
+      end
+    end
+  end
+end

data/spec/scenic/active_record/command_recorder_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe Scenic::ActiveRecord::CommandRecorder do
+  describe "#create_view" do
+    it "records the created view" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+
+      recorder.create_view :greetings
+
+      expect(recorder.commands).to eq [[:create_view, [:greetings], nil]]
+    end
+
+    it "reverts to drop_view" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+
+      recorder.revert { recorder.create_view :greetings }
+
+      expect(recorder.commands).to eq [[:drop_view, [:greetings]]]
+    end
+  end
+
+  describe "#drop_view" do
+    it "records the dropped view" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+
+      recorder.drop_view :users
+
+      expect(recorder.commands).to eq [[:drop_view, [:users], nil]]
+    end
+
+    it "reverts to create_view with specified revert_to_version" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+      args = [:users, { revert_to_version: 3 }]
+      revert_args = [:users, { version: 3 }]
+
+      recorder.revert { recorder.drop_view(*args) }
+
+      expect(recorder.commands).to eq [[:create_view, revert_args]]
+    end
+
+    it "raises when reverting without revert_to_version set" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+      args = [:users, { another_argument: 1 }]
+
+      expect { recorder.revert { recorder.drop_view(*args) } }
+        .to raise_error(ActiveRecord::IrreversibleMigration)
+    end
+  end
+
+  describe "#update_view" do
+    it "records the updated view" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+      args = [:users, { version: 2 }]
+
+      recorder.update_view(*args)
+
+      expect(recorder.commands).to eq [[:update_view, args, nil]]
+    end
+
+    it "reverts to update_view with the specified revert_to_version" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+      args = [:users, { version: 2, revert_to_version: 1 }]
+      revert_args = [:users, { version: 1 }]
+
+      recorder.revert { recorder.update_view(*args) }
+
+      expect(recorder.commands).to eq [[:update_view, revert_args]]
+    end
+
+    it "raises when reverting without revert_to_version set" do
+      recorder = ActiveRecord::Migration::CommandRecorder.new
+      args = [:users, { version: 42, another_argument: 1 }]
+
+      expect { recorder.revert { recorder.update_view(*args) } }
+        .to raise_error(ActiveRecord::IrreversibleMigration)
+    end
+  end
+end

data/spec/scenic/active_record/schema_dumper_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+class Search < ActiveRecord::Base; end
+
+describe Scenic::ActiveRecord::SchemaDumper, :db do
+  it "dumps a create_view for a view in the database" do
+    view_definition = "SELECT 'needle'::text AS haystack"
+    Search.connection.create_view :searches, sql_definition: view_definition
+    stream = StringIO.new
+
+    ActiveRecord::SchemaDumper.dump(Search.connection, stream)
+
+    output = stream.string
+    expect(output).to include "create_view :searches"
+    expect(output).to include view_definition
+
+    Search.connection.drop_view :searches
+
+    silence_stream(STDOUT) { eval(output) }
+
+    expect(Search.first.haystack).to eq "needle"
+  end
+end

data/spec/scenic/active_record/statements_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+class View < ActiveRecord::Base
+end
+
+describe Scenic::ActiveRecord::Statements, :db do
+  describe "create_view" do
+    it "creates a view from a file" do
+      with_view_definition :views, 1, "SELECT text 'Hello World' AS hello" do
+        View.connection.create_view :views
+
+        expect(View.all.pluck(:hello)).to eq ["Hello World"]
+      end
+    end
+
+    it "creates a view from a text definition" do
+      View.connection.create_view :views,
+        sql_definition: "SELECT text 'Goodbye' AS hello"
+
+      expect(View.all.pluck(:hello)).to eq ["Goodbye"]
+    end
+
+    it "creates a view from a specific version" do
+      with_view_definition :views, 15, "SELECT text 'Hello Earth East 15' AS hello" do
+        View.connection.create_view :views, version: 15
+
+        expect(View.all.pluck(:hello)).to eq ["Hello Earth East 15"]
+      end
+    end
+
+    it "raises an error if both arguments are nil" do
+      expect do
+        View.connection.create_view :whatever,
+          version: nil,
+          sql_definition: nil
+      end.to raise_error ArgumentError
+    end
+  end
+
+  describe "drop_view" do
+    it "removes a view from the database" do
+      with_view_definition :things, 1, "SELECT text 'Hi' AS greeting" do
+        View.connection.create_view :things
+
+        View.connection.drop_view :things
+
+        expect(views).not_to include "things"
+      end
+    end
+  end
+
+  describe "update_view" do
+    it "updates an existing view in the database" do
+      with_view_definition :views, 1, "SELECT text 'Hi' AS greeting" do
+        View.connection.create_view :views
+        with_view_definition :views, 2, "SELECT text 'Hello' AS greeting" do
+          View.connection.update_view :views, version: 2
+
+          expect(View.all.pluck(:greeting)).to eq ['Hello']
+        end
+      end
+    end
+
+    it "raises an error if not supplied a version" do
+      expect { View.connection.update_view :views }
+        .to raise_error(ArgumentError, /version is required/)
+    end
+
+    it "raises an error if the view to be updated does not exist" do
+      with_view_definition :views, 2, "SELECT text 'Hi' as greeting" do
+        expect { View.connection.update_view :views, version: 2 }
+          .to raise_error(ActiveRecord::StatementInvalid, /does not exist/)
+      end
+    end
+  end
+
+  def views
+    ActiveRecord::Base.connection
+      .execute("SELECT table_name FROM INFORMATION_SCHEMA.views")
+      .map(&:values).flatten
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+ENV["RAILS_ENV"] = "test"
+require "database_cleaner"
+
+require File.expand_path("../dummy/config/environment", __FILE__)
+require "support/generator_spec_setup"
+require "support/view_definition_helpers"
+
+RSpec.configure do |config|
+  config.order = "random"
+  config.include ViewDefinitionHelpers
+  DatabaseCleaner.strategy = :transaction
+
+  config.around(:each, db: true) do |example|
+    DatabaseCleaner.start
+    example.run
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/generator_spec_setup.rb

@@ -0,0 +1,9 @@
+require "ammeter/rspec/generator/example.rb"
+require "ammeter/rspec/generator/matchers.rb"
+
+RSpec.configure do |config|
+  config.before(:example, :generator) do
+    destination File.expand_path("../../../tmp", __FILE__)
+    prepare_destination
+  end
+end

data/spec/support/view_definition_helpers.rb

@@ -0,0 +1,9 @@
+module ViewDefinitionHelpers
+  def with_view_definition(name, version, schema)
+    view_file = ::Rails.root.join("db", "views", "#{name}_v#{version}.sql")
+    File.open(view_file, "w") { |f| f.write(schema) }
+    yield
+  ensure
+    File.delete view_file
+  end
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: scenic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Prior
+- Caleb Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: railties
+  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
+description: |2
+      Adds methods to ActiveRecord::Migration to create and manage database views
+      in Rails
+email:
+- derekprior@gmail.com
+- caleb@calebthompson.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/scenic/model/USAGE
+- lib/generators/scenic/model/model_generator.rb
+- lib/generators/scenic/model/templates/model.erb
+- lib/generators/scenic/view/USAGE
+- lib/generators/scenic/view/templates/db/migrate/create_view.erb
+- lib/generators/scenic/view/view_generator.rb
+- lib/scenic.rb
+- lib/scenic/active_record/command_recorder.rb
+- lib/scenic/active_record/command_recorder/statement_arguments.rb
+- lib/scenic/active_record/schema_dumper.rb
+- lib/scenic/active_record/statements.rb
+- lib/scenic/railtie.rb
+- lib/scenic/version.rb
+- scenic.gemspec
+- spec/dummy/.gitignore
+- spec/dummy/Rakefile
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- 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/active_record/command_recorder/statement_arguments_spec.rb
+- spec/scenic/active_record/command_recorder_spec.rb
+- spec/scenic/active_record/schema_dumper_spec.rb
+- spec/scenic/active_record/statements_spec.rb
+- spec/spec_helper.rb
+- spec/support/generator_spec_setup.rb
+- spec/support/view_definition_helpers.rb
+homepage: https://github.com/thoughtbot/scenic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Support for database views in Rails migrations
+test_files:
+- spec/dummy/.gitignore
+- spec/dummy/Rakefile
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- 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/active_record/command_recorder/statement_arguments_spec.rb
+- spec/scenic/active_record/command_recorder_spec.rb
+- spec/scenic/active_record/schema_dumper_spec.rb
+- spec/scenic/active_record/statements_spec.rb
+- spec/spec_helper.rb
+- spec/support/generator_spec_setup.rb
+- spec/support/view_definition_helpers.rb