scenic 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f9265748cd49c4ab094b3cb7110b61e0bef6b35
-  data.tar.gz: c3bd33b0d1ee11d1d807b1a12046839bb8fce53c
+  metadata.gz: a764a03ca4024bdd13deea0c9a18251b91e664e1
+  data.tar.gz: be3c32867baca5e7c3887372d25f3a40d1f93dd3
 SHA512:
-  metadata.gz: 6dd62a29b6991a7c21283764d64c38851ca550a1fa690d8496ee56a6fd0448c81f66c9aaa78e2c9ebabcc430ea1be2b0213f5b7315e05e2c55d4911f5cfb9115
-  data.tar.gz: 8248642a38d1c583b6883af55a186bea5d2926faa8dcf790996c082ad8d110da74f785db50b4a33bd948fbe6f4b4ea99e7214fdd1afc4641f17d6d2f600b06ec
+  metadata.gz: 9afab6aedec2d7167737a4879e8a7f79f3511dc10d0d0b980790cd827035ccec6697c0fb61c401305190f353e72d21543ad2699552ea5eafe7ae0e33877bff68
+  data.tar.gz: da72e6957c563eca8c01601ac99a1876d7b48f1767d55d327b5c60ae8acf53853cda13a4b6b1c8d99af72ec9864fa2d90425afc71e41cd5bdb481cebbe251cc9

data/.hound.yml

@@ -1,2 +1,4 @@
 DotPosition:
   EnforcedStyle: leading
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation

data/.travis.yml

@@ -1,6 +1,8 @@
 before_install:
   - "echo '--colour' > ~/.rspec"
   - "echo 'gem: --no-document' > ~/.gemrc"
+  - git config --global user.name 'Travis CI'
+  - git config --global user.email 'travis-ci@example.com'
 before_script:
   - pushd spec/dummy && bundle exec rake db:create && popd
 branches:

data/NEWS.md

@@ -0,0 +1,8 @@
+* Teach view generator to update existing views [683361d](https://github.com/thoughtbot/scenic/commit/683361d59410f46aba508a3ceb850161dd0be027)
+
+
+  *Caleb Thompson*
+
+* Raise an error if view definition is empty. [PR #38](https://github.com/thoughtbot/scenic/issues/38)
+
+  *Caleb Thompson*

data/Rakefile

@@ -3,4 +3,8 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :smoke do
+  exec "spec/smoke"
+end
+
+task default: [:spec, :smoke]

data/lib/generators/scenic/view/USAGE

@@ -2,8 +2,16 @@ Description:
   Create a new database view for your application. This will create a new
   view definition file and the accompanying migration.
 
+  If a view of the given name already exists, create a new version of the view
+  and a migration to replace the old version with the new.
+
 Examples:
     rails generate scenic:view searches
 
-      create: db/views/searches_v1.sql
+      create: db/views/searches_v01.sql
       create: db/migrate/20140803191158_create_searches.rb
+
+    rails generate scenic:view searches
+
+      create: db/views/searches_v02.sql
+      create: db/migrate/20140804191158_update_searches_to_version_2.rb

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

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

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

@@ -8,19 +8,69 @@ module Scenic
       source_root File.expand_path("../templates", __FILE__)
 
       def create_view_definition
-        create_file "db/views/#{plural_name}_v1.sql"
+        create_file definition.path
       end
 
       def create_migration_file
-        migration_template(
-          "db/migrate/create_view.erb",
-          "db/migrate/create_#{plural_name}.rb"
-        )
+        if creating_new_view? || destroying_initial_view?
+          migration_template(
+            "db/migrate/create_view.erb",
+            "db/migrate/create_#{plural_file_name}.rb"
+          )
+        else
+          migration_template(
+            "db/migrate/update_view.erb",
+            "db/migrate/update_#{plural_file_name}_to_version_#{version}.rb"
+          )
+        end
       end
 
       def self.next_migration_number(dir)
         ::ActiveRecord::Generators::Base.next_migration_number(dir)
       end
+
+      no_tasks do
+        def previous_version
+          @previous_version ||=
+            Dir.entries(Rails.root.join(*%w(db views)))
+              .map { |name| version_regex.match(name).try(:[], "version").to_i }
+              .max
+        end
+
+        def version
+          @version ||= destroying? ? previous_version : previous_version.next
+        end
+
+        def migration_class_name
+          if creating_new_view?
+            super
+          else
+            "Update#{class_name.pluralize}ToVersion#{version}"
+          end
+        end
+      end
+
+      private
+
+      def version_regex
+        /\A#{plural_file_name}_v(?<version>\d+)\.sql\z/
+      end
+
+      def creating_new_view?
+        previous_version == 0
+      end
+
+      def definition
+        Scenic::Definition.new(plural_file_name, version)
+      end
+
+      def destroying?
+        behavior == :revoke
+      end
+
+      def destroying_initial_view?
+        destroying? && version == 1
+      end
     end
   end
 end

data/lib/scenic.rb

@@ -1,21 +1,20 @@
-require "scenic/version"
+require "scenic/adapters/postgres"
+require "scenic/command_recorder"
+require "scenic/definition"
 require "scenic/railtie"
-require "scenic/active_record/command_recorder"
-require "scenic/active_record/schema_dumper"
-require "scenic/active_record/statements"
+require "scenic/schema_dumper"
+require "scenic/statements"
+require "scenic/version"
+require "scenic/view"
 
 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::ConnectionAdapters::AbstractAdapter.include Scenic::Statements
+    ActiveRecord::Migration::CommandRecorder.include Scenic::CommandRecorder
+    ActiveRecord::SchemaDumper.include Scenic::SchemaDumper
+  end
 
-    ::ActiveRecord::SchemaDumper.class_eval do
-      include Scenic::ActiveRecord::SchemaDumper
-    end
+  def self.database
+    Scenic::Adapters::Postgres
   end
 end

data/lib/scenic/adapters/postgres.rb

@@ -0,0 +1,27 @@
+module Scenic
+  module Adapters
+    module Postgres
+      def self.views
+        execute(<<-SQL).map { |result| Scenic::View.new(result) }
+          SELECT viewname, definition
+          FROM pg_views
+          WHERE schemaname = ANY (current_schemas(false))
+        SQL
+      end
+
+      def self.create_view(name, sql_definition)
+        execute "CREATE VIEW #{name} AS #{sql_definition};"
+      end
+
+      def self.drop_view(name)
+        execute "DROP VIEW #{name};"
+      end
+
+      private
+
+      def self.execute(sql, base = ActiveRecord::Base)
+        base.connection.execute sql
+      end
+    end
+  end
+end

data/lib/scenic/command_recorder.rb

@@ -0,0 +1,42 @@
+require "scenic/command_recorder/statement_arguments"
+
+module Scenic
+  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

data/lib/scenic/command_recorder/statement_arguments.rb

@@ -0,0 +1,42 @@
+module Scenic
+  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

data/lib/scenic/definition.rb

@@ -0,0 +1,34 @@
+module Scenic
+  class Definition
+    def initialize(name, version)
+      @name = name
+      @version = version.to_i
+    end
+
+    def to_sql
+      File.read(full_path).tap do |content|
+        if content.empty?
+          raise "Define view query in #{@path} before migrating."
+        end
+      end
+    end
+
+    def full_path
+      Rails.root.join(path)
+    end
+
+    def path
+      File.join("db", "views", filename)
+    end
+
+    def version
+      @version.to_s.rjust(2, "0")
+    end
+
+    private
+
+    def filename
+      "#{@name}_v#{version}.sql"
+    end
+  end
+end

data/lib/scenic/schema_dumper.rb

@@ -0,0 +1,40 @@
+require "rails"
+
+module Scenic
+  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)
+      views_in_database.select { |view| !ignored?(view.name) }.each do |view|
+        stream.puts(view.to_schema)
+      end
+    end
+
+    def views_in_database
+      @views_in_database ||= Scenic.database.views.sort
+    end
+
+    private
+
+    unless ActiveRecord::SchemaDumper.instance_methods(false).include?(:ignored?)
+      # This method will be present in Rails 4.2.0 and can be removed then.
+      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
+          else
+            raise StandardError, "ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scenic/statements.rb

@@ -0,0 +1,84 @@
+module Scenic
+  module Statements
+    # Public: Create a new database view.
+    #
+    # name - A string or symbol containing the singular name of the database
+    #        view. Cannot conflict with any other view or table names.
+    # version - The version number of the view. If present, will be used to find
+    #           the definition file in db/views in the form db/views/[pluralized
+    #           name]_v[2 digit zero padded version].sql.
+    #           Example: db/views/searches_v02.sql.
+    # sql_definition - A string containing the SQL definition of the view. If
+    #                  both sql_definition and version are provided,
+    #                  sql_definition takes prescedence.
+    #
+    # Examples
+    #
+    #   create_view(:searches, version: 2)
+    #
+    #   create_view(:active_users, sql_definition: <<-SQL)
+    #     SELECT * FROM users WHERE users.active = 't'
+    #   SQL
+    #
+    # Returns the database response from executing the CREATE VIEW statement.
+    def create_view(name, version: 1, sql_definition: nil)
+      if version.blank? && sql_definition.nil?
+        raise(
+          ArgumentError,
+          "view_definition or version_number must be specified"
+        )
+      end
+
+      sql_definition ||= definition(name, version)
+
+      Scenic.database.create_view(name, sql_definition)
+    end
+
+    # Public: Drop a database view by name.
+    #
+    # name - A string or symbol containing the singular name of the database
+    #        view. Must be an existing view.
+    # revert_to_version - Used to revert the drop_view command in the
+    #                     db:rollback rake task, which would pass the version
+    #                     number to create_view. Usually the most recent
+    #                     version.
+    #
+    # Example
+    #
+    #   drop_view(:users_who_recently_logged_in, 3)
+    #
+    # Returns the database response from executing the DROP VIEW statement.
+    def drop_view(name, revert_to_version: nil)
+      Scenic.database.drop_view(name)
+    end
+
+    # Public: Update a database view to a new version by first dropping the
+    # previous version then creating the new version.
+    #
+    # name - A string or symbol containing the singular name of the database
+    #        view. Must be an existing view.
+    # version - The version number of the view. See create_view for details.
+    # revert_to_version - The version to revert to for db:rollback. Usually the
+    #                     previous version. See drop_view for details.
+    #
+    # Example
+    #
+    #   update_view(:engagement_reports, version: 3, revert_to_version: 2)
+    #
+    # Returns the database response from executing the CREATE VIEW statement.
+    def update_view(name, version: nil, revert_to_version: nil)
+      if version.blank?
+        raise ArgumentError, "version is required"
+      end
+
+      drop_view(name, revert_to_version: revert_to_version)
+      create_view(name, version: version)
+    end
+
+    private
+
+    def definition(name, version)
+      Scenic::Definition.new(name, version).to_sql
+    end
+  end
+end

data/lib/scenic/version.rb

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

data/lib/scenic/view.rb

@@ -0,0 +1,24 @@
+module Scenic
+  class View
+    attr_reader :name, :definition
+    delegate :<=>, to: :name
+
+    def initialize(view_row)
+      @name = view_row["viewname"]
+      @definition = view_row["definition"].strip
+    end
+
+    def ==(other)
+      name == other.name &&
+        definition == other.definition
+    end
+
+    def to_schema
+      <<-DEFINITION.strip_heredoc
+        create_view :#{name}, sql_definition:<<-\SQL
+          #{definition}
+        SQL
+      DEFINITION
+    end
+  end
+end

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

@@ -1,23 +1,25 @@
 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
+module Scenic::Generators
+  describe ModelGenerator, :generator do
+    before do
+      allow(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"]
+    it "invokes the view generator" do
+      run_generator ["current_customer"]
 
-    expect(Scenic::Generators::ViewGenerator).to have_received(:new)
-  end
+      expect(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
+    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
 end

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

@@ -2,15 +2,25 @@ require "spec_helper"
 require "generators/scenic/view/view_generator"
 
 describe Scenic::Generators::ViewGenerator, :generator do
-  it "creates a view definition file" do
+  it "creates view definition and migration files" do
+    migration = file("db/migrate/create_searches.rb")
+    view_definition = file("db/views/searches_v01.sql")
+
     run_generator ["search"]
-    view_definition = file("db/views/searches_v1.sql")
+
+    expect(migration).to be_a_migration
     expect(view_definition).to exist
   end
 
-  it "creates a migration to create the view" do
+  it "updates an existing view" 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"]
-    migration = file("db/migrate/create_searches.rb")
+
     expect(migration).to be_a_migration
+    expect(view_definition).to exist
   end
 end

data/spec/scenic/adapters/postgres_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres, :db do
+      describe "create_view" do
+        it "successfully creates a view" do
+          Postgres.create_view("greetings", "SELECT text 'hi' AS greeting")
+
+          expect(Postgres.views.map(&:name)).to include("greetings")
+        end
+      end
+
+      describe "drop_view" do
+        it "successfully drops a view" do
+          Postgres.create_view("greetings", "SELECT text 'hi' AS greeting")
+
+          Postgres.drop_view("greetings")
+
+          expect(Postgres.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"
+
+          expect(Postgres.views).to eq([
+            View.new(
+              "viewname" => "greetings",
+              "definition" => "SELECT 'hi'::text AS greeting;",
+            ),
+          ])
+        end
+      end
+    end
+  end
+end

data/spec/scenic/{active_record/command_recorder → command_recorder}/statement_arguments_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-module Scenic::ActiveRecord::CommandRecorder
+module Scenic::CommandRecorder
   describe StatementArguments do
     describe "#view" do
       it "is the view name" do

data/spec/scenic/{active_record/command_recorder_spec.rb → command_recorder_spec.rb}

@@ -1,18 +1,14 @@
 require "spec_helper"
 
-describe Scenic::ActiveRecord::CommandRecorder do
+describe Scenic::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]]]
@@ -21,15 +17,12 @@ describe Scenic::ActiveRecord::CommandRecorder do
 
   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 }]
 
@@ -39,7 +32,6 @@ describe Scenic::ActiveRecord::CommandRecorder do
     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) } }
@@ -49,7 +41,6 @@ describe Scenic::ActiveRecord::CommandRecorder do
 
   describe "#update_view" do
     it "records the updated view" do
-      recorder = ActiveRecord::Migration::CommandRecorder.new
       args = [:users, { version: 2 }]
 
       recorder.update_view(*args)
@@ -58,7 +49,6 @@ describe Scenic::ActiveRecord::CommandRecorder do
     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 }]
 
@@ -68,11 +58,14 @@ describe Scenic::ActiveRecord::CommandRecorder do
     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
+
+  def recorder
+    @recorder ||= ActiveRecord::Migration::CommandRecorder.new
+  end
 end

data/spec/scenic/definition_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+module Scenic
+  describe Definition do
+    describe "to_sql" do
+      it "returns the content of a view definition" do
+        sql_definition = "SELECT text 'Hi' as greeting"
+        allow(File).to receive(:read).and_return(sql_definition)
+
+        definition = Definition.new("searches", 1)
+
+        expect(definition.to_sql).to eq sql_definition
+      end
+
+      it "raises an error if the file is empty" do
+        allow(File).to receive(:read).and_return("")
+
+        expect do
+          Definition.new("searches", 1).to_sql
+        end.to raise_error RuntimeError
+      end
+    end
+
+    describe "path" do
+      it "returns a sql file in db/views with padded version and view name"  do
+        expected = "db/views/searches_v01.sql"
+
+        definition = Definition.new("searches", 1)
+
+        expect(definition.path).to eq expected
+      end
+    end
+
+    describe "full_path" do
+      it "joins the path with Rails.root" do
+        definition = Definition.new("searches", 15)
+
+        expect(definition.full_path).to eq Rails.root.join(definition.path)
+      end
+    end
+
+    describe "version" do
+      it "pads the version number with 0" do
+        definition = Definition.new(:_, 1)
+
+        expect(definition.version).to eq "01"
+      end
+
+      it "doesn't pad more than 2 characters" do
+        definition = Definition.new(:_, 15)
+
+        expect(definition.version).to eq "15"
+      end
+    end
+  end
+end

data/spec/scenic/{active_record/schema_dumper_spec.rb → schema_dumper_spec.rb}

@@ -2,7 +2,7 @@ require "spec_helper"
 
 class Search < ActiveRecord::Base; end
 
-describe Scenic::ActiveRecord::SchemaDumper, :db do
+describe Scenic::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

data/spec/scenic/statements_spec.rb

@@ -0,0 +1,72 @@
+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)
+    end
+
+    describe "create_view" do
+      it "creates a view from a file" do
+        version = 15
+        definition_stub = instance_double("Definition", to_sql: "foo")
+        allow(Definition).to receive(:new)
+          .with(:views, version)
+          .and_return(definition_stub)
+
+        connection.create_view :views, version: version
+
+        expect(Scenic.database).to have_received(:create_view)
+          .with(:views, definition_stub.to_sql)
+      end
+
+      it "creates a view from a text definition" do
+        sql_definition = "a defintion"
+
+        connection.create_view(:views, sql_definition: sql_definition)
+
+        expect(Scenic.database).to have_received(:create_view)
+          .with(:views, sql_definition)
+      end
+
+      it "raises an error if neither version nor sql_defintion are provided" do
+        expect do
+          connection.create_view :foo, version: nil, sql_definition: nil
+        end.to raise_error ArgumentError
+      end
+    end
+
+    describe "drop_view" do
+      it "removes a view from the database" do
+        connection.drop_view :name
+
+        expect(Scenic.database).to have_received(:drop_view).with(:name)
+      end
+    end
+
+    describe "update_view" do
+      it "drops the existing version and creates the new" do
+        definition = instance_double("Definition", to_sql: "definition")
+        allow(Definition).to receive(:new)
+          .with(:name, 3)
+          .and_return(definition)
+
+        connection.update_view(:name, version: 3)
+
+        expect(Scenic.database).to have_received(:drop_view).with(:name)
+        expect(Scenic.database).to have_received(:create_view)
+          .with(:name, definition.to_sql)
+      end
+
+      it "raises an error if not supplied a version" do
+        expect { connection.update_view :views }
+          .to raise_error(ArgumentError, /version is required/)
+      end
+    end
+
+    def connection
+      Class.new { extend Statements }
+    end
+  end
+end

data/spec/smoke

@@ -0,0 +1,86 @@
+#!/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.first.results")
+	[[ "$actualResult" == "$expectedResult" ]] || exit 1
+	echo "[success]"
+}
+
+writeToFileAndMigrateAndVerifySearchResults() {
+	echo "write search definition and migrate"
+	local version=$1
+	local expectedResult=$2
+	echo "SELECT '$expectedResult'::text AS results" >> db/views/searches_v$version\.sql
+	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
+	[[ -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]"
+}
+
+main $*

data/spec/support/view_definition_helpers.rb

@@ -1,9 +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) }
+    definition = Scenic::Definition.new(name, version)
+    File.open(definition.full_path, "w") { |f| f.write(schema) }
     yield
   ensure
-    File.delete view_file
+    File.delete definition.full_path
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scenic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Derek Prior
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,6 +152,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
+- NEWS.md
 - README.md
 - Rakefile
 - lib/generators/scenic/model/USAGE
@@ -159,14 +160,18 @@ files:
 - 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/templates/db/migrate/update_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/adapters/postgres.rb
+- lib/scenic/command_recorder.rb
+- lib/scenic/command_recorder/statement_arguments.rb
+- lib/scenic/definition.rb
 - lib/scenic/railtie.rb
+- lib/scenic/schema_dumper.rb
+- lib/scenic/statements.rb
 - lib/scenic/version.rb
+- lib/scenic/view.rb
 - scenic.gemspec
 - spec/dummy/.gitignore
 - spec/dummy/Rakefile
@@ -180,14 +185,18 @@ files:
 - spec/dummy/config/environment.rb
 - 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/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/scenic/adapters/postgres_spec.rb
+- spec/scenic/command_recorder/statement_arguments_spec.rb
+- spec/scenic/command_recorder_spec.rb
+- 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
@@ -228,14 +237,18 @@ test_files:
 - spec/dummy/config/environment.rb
 - 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/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/scenic/adapters/postgres_spec.rb
+- spec/scenic/command_recorder/statement_arguments_spec.rb
+- spec/scenic/command_recorder_spec.rb
+- 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/lib/scenic/active_record/command_recorder.rb

@@ -1,44 +0,0 @@
-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/command_recorder/statement_arguments.rb

@@ -1,44 +0,0 @@
-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/schema_dumper.rb

@@ -1,52 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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/spec/scenic/active_record/statements_spec.rb

@@ -1,82 +0,0 @@
-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