activerecord-view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3eb9212982e304e55913df73786c1be97e279b3f
+  data.tar.gz: d628d7eddd62a7695dd89d266a624d397fc56e6c
+SHA512:
+  metadata.gz: ca3eb61ad1eea56afed2d3ed734908eef9cc8d13a53c10dbea0f005c6e8fdbebb5b46815a20a17053e58f63e62a97f3302c48a876fe039a774eeff681db4d1c8
+  data.tar.gz: dd061a4d03f69986bd40f81d28e89630a9d262838e231db715f8459013e3775dc64f1635e14a7e968992cacab594174182e18e1fe8ec1a4e8fc9fc6d262940b0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/internal/log/test.log
+spec/internal/db/test.sqlite3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_install: gem install bundler -v '~> 1.9'
+cache: bundler
+rvm:
+  - 2.1.3
+  - 2.2.1
+before_script:
+  - mysql -e 'create database activerecord_view_test'
+  - psql -c 'create database activerecord_view_test' -U postgres
+addons:
+  postgresql: "9.3"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# @markup markdown
+# @title Contributor Code of Conduct
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alexa Grey
+
+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,139 @@
+# Activerecord::View [![Build Status](https://travis-ci.org/scryptmouse/activerecord-view.svg?branch=master)](https://travis-ci.org/scryptmouse/activerecord-view)
+
+Integration for ActiveRecord to facilitate easy use of views in migrations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-view'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-view
+
+## Usage
+
+To create a view in a database migration:
+
+```ruby
+def change
+  # You can provide a string
+  create_view :admins, 'SELECT * FROM users WHERE role = "admin"'
+
+  # Or an object that responds #to_sql
+  users = User.arel_table
+
+  create_view :authors, users.project('*').where(users[:role].eq('author'))
+
+  # Or a block that returns one of the above if that's more convenient
+  create_view :magicians do
+    users.project('*').where(users[:role].eq('magician'))
+  end
+end
+```
+
+Use with `change` is fully supported, commands will revert and do the right thing.
+
+Reverting a `drop_view` requires you to pass the body to restore somehow:
+
+```
+def change
+  drop_view :authors, original_authors_definition_from_elsewhere
+
+  drop_view :admins do
+    original_admins_definition_from_elsewhere
+  end
+
+  # In a change method, this will raise an ActiveRecord::IrreversibleMigration!
+  drop_view :magicians
+end
+```
+
+Then, in your model
+
+```ruby
+class Magician < ActiveRecord::Base
+  is_view!
+end
+```
+
+By default, views are made read-only. [MySQL](https://dev.mysql.com/doc/refman/5.5/en/view-updatability.html) and
+[Postgres](http://www.postgresql.org/docs/9.3/static/sql-createview.html#SQL-CREATEVIEW-UPDATABLE-VIEWS) support
+the notion of updatable views, but this currently isn't tested.
+
+If you want to make a view updatable:
+
+```ruby
+class Magician < ActiveRecord::Base
+  is_view! readonly: false
+end
+```
+
+### Materialized Views
+Postgres supports [materialized views](http://www.postgresql.org/docs/9.3/static/rules-materializedviews.html), and so does this gem.
+
+```ruby
+def change
+  users = User.arel_table
+
+  by_role = ->(role) { users.project('*').where(users[:role].eq('admin')) }
+
+  # The API is basically the same
+  create_materialized_view :admins do
+    by_role.call 'admin'
+  end
+
+  # Except there's the option to pass `with_data: true` to prepopulate the view.
+  create_materialized_view :authors, with_data: true do
+    by_role.call 'author'
+  end
+
+  create_materialized_view :magicians, by_role['magician'], with_data: true
+
+  # Materialized views support indexing
+  add_index :admins, :name
+  add_index :magicians, :name
+  add_index :authors, :email, unique: true
+end
+```
+
+Then, in your model:
+
+```ruby
+class Author < ActiveRecord::Base
+  is_materialized_view!
+end
+```
+
+Like regular views above, materialized views can also be made updatable on MySQL and Postgres
+if the conditions are met, via `is_materialized_view! readonly: false`.
+
+To refresh a materialized view, use `ModelName.refresh_view!`.
+
+Concurrent refresh (PG 9.4) is not yet supported through the gem, but it is on the roadmap.
+
+## Requirements
+
+* Ruby 2.1+
+* ActiveRecord 4.1+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/scryptmouse/activerecord-view/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+rescue LoadError
+end
+
+task :default => :spec

data/activerecord-view.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/view/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-view"
+  spec.version       = ActiveRecord::View::VERSION
+  spec.authors       = ["Alexa Grey"]
+  spec.email         = ["devel@mouse.vc"]
+
+  spec.summary       = %q{SQL views with ActiveRecord}
+  spec.description   = %q{SQL views with ActiveRecord}
+  spec.homepage      = "https://github.com/scryptmouse/activerecord-view"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_dependency "activerecord", "> 4.1", "< 5"
+  spec.add_dependency "dux"
+  spec.add_dependency "virtus", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "simplecov"
+end

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require "bundler/setup"
+require "activerecord/view"
+require "combustion"
+require "pry"
+
+Combustion.initialize! :active_record
+
+begin
+  TEST_MODELS.each(&:create_view!)
+
+  Pry.start
+ensure
+  TEST_MODELS.each(&:drop_view!)
+end

data/bin/setup

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here
+
+createdb -U postgres activerecord_view_test
+mysql -e 'create database activerecord_view_test'

data/lib/activerecord-view.rb

@@ -0,0 +1 @@
+require 'activerecord/view'

data/lib/activerecord/view.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+
+require "active_record"
+require "virtus"
+require "dux"
+require "activerecord/view/error"
+require "activerecord/view/utility"
+require "activerecord/view/version"
+
+require 'activerecord/view/introspection'
+
+require 'activerecord/view/integration'
+
+require 'activerecord/view/read_only'
+require 'activerecord/view/view_methods'
+require 'activerecord/view/materialized_view_methods'
+
+module ActiveRecord
+  module View
+    extend ActiveSupport::Concern
+    extend Integration
+    extend Introspection
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::View.enable!
+end

data/lib/activerecord/view/error.rb

@@ -0,0 +1,19 @@
+module ActiveRecord
+  module View
+    # @api private
+    class Error < StandardError; end
+
+    # @api private
+    class MaterializedViewNotSupported < Error
+      def initialize(adapter)
+        super("Materialized views are not supported by `#{adapter}`")
+      end
+    end
+
+    # @api private
+    class UnsupportedDatabase < Error; end
+
+    # @api private
+    class UnsupportedSyntax < ActiveRecord::View::Error; end
+  end
+end

data/lib/activerecord/view/integration.rb

@@ -0,0 +1,38 @@
+module ActiveRecord
+  module View
+    module Integration
+      AR_INCLUSIONS = {
+        'SchemaMethods' => 'ActiveRecord::ConnectionAdapters::AbstractAdapter',
+        'CommandRecorderMethods' => 'ActiveRecord::Migration::CommandRecorder'
+      }
+
+      AR_EXTENSIONS = {
+        'ModelMethods' => 'ActiveRecord::Base'
+      }
+
+      def enable!
+        AR_INCLUSIONS.each do |mod_name, target|
+          target_klass = target.constantize
+          mod = "ActiveRecord::View::Integration::#{mod_name}".constantize
+
+          target_klass.include mod
+        end
+
+        AR_EXTENSIONS.each do |mod_name, target|
+          target_klass = target.constantize
+          mod = "ActiveRecord::View::Integration::#{mod_name}".constantize
+
+          target_klass.extend mod
+        end
+
+        #ActiveRecord::ConnectionAdapters::AbstractAdapter.include ActiveRecord::View::Integration::SchemaMethods
+        #ActiveRecord::Base.extend ActiveRecord::View::Integration::ModelMethods
+        #ActiveRecord::Migration::CommandRecorder.include ActiveRecord::View::
+      end
+
+      require_relative './integration/command_recorder_methods'
+      require_relative './integration/model_methods'
+      require_relative './integration/schema_methods'
+    end
+  end
+end

data/lib/activerecord/view/integration/command_recorder_methods.rb

@@ -0,0 +1,61 @@
+module ActiveRecord
+  module View
+    module Integration
+      module CommandRecorderMethods
+        CREATE_VIEW_METHODS = %i[create_view create_materialized_view]
+
+        DROP_VIEW_METHODS = %i[drop_view drop_materialized_view]
+
+        VIEW_METHOD_PAIRS = Hash[CREATE_VIEW_METHODS.zip(DROP_VIEW_METHODS)].tap do |hsh|
+          hsh.merge!(hsh.invert)
+        end
+
+        VIEW_METHODS = CREATE_VIEW_METHODS + DROP_VIEW_METHODS
+
+        VIEW_METHODS.each do |method_name|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{method_name}(*args, &block)
+            record(:#{method_name}, args, &block)
+          end
+          RUBY
+        end
+
+        CREATE_VIEW_METHODS.each do |method_name|
+          inverse_method = VIEW_METHOD_PAIRS.fetch method_name
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def invert_#{method_name}(args, &block)
+            view_name = args.first
+
+            [:#{inverse_method}, [view_name]]
+          end
+          RUBY
+        end
+
+        DROP_VIEW_METHODS.each do |method_name|
+          inverse_method = VIEW_METHOD_PAIRS.fetch method_name
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def invert_#{method_name}(args, &block)
+            options = args.extract_options!
+
+            view_name = args.shift
+            view_body = ActiveRecord::View.validate_body(args.shift, &block)
+
+
+            unless view_body.present? || block_given?
+              raise ActiveRecord::IrreversibleMigration, "To avoid mistakes, #{method_name} is only reversible if provided with a view body or a block."
+            end
+
+            args = [view_name]
+            args << view_body if view_body.present?
+            args << options
+
+            [:#{inverse_method}, args, block]
+          end
+          RUBY
+        end
+      end
+    end
+  end
+end