activerecord-viewmatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 133bff3848fe0b250115e32cae7733867d018903
+  data.tar.gz: 7c128e357ef568478c0a48c67e8a269592e2375b
+SHA512:
+  metadata.gz: 44389971cb0a3024360b92601d3c21deae97760f9d8ff03d645ae847be82b0fc1ef4ee5566274c3641617f92906bdaf1f8f1c0bdced0dd282b504862a433a3ba
+  data.tar.gz: 9c35803b88d5b73de127965d44866e027bf7c3cf30c30543441523fa87e683dca9a3f5157bc8a73a5368b8e691337995decafcbbdab337506becd3c27892ff82

data/README.md

@@ -0,0 +1,90 @@
+# Viewmatic
+
+Helpers for ActiveRecord apps that want to use database views easily. Both live and materialized views are supported. Easy to use:
+
+1. Add `activerecord-viewmatic` to your Gemfile.
+2. Define your views in `db/views.rb` or `db/views/*.rb`.
+3. Use migrations to create or drop the defined views. (Your views will be automatically created when you run commands like `rake db:setup` and `rake db:test:prepare`.)
+4. Define ActiveRecord models to access your views.
+
+## Define your views
+
+**db/views.rb**
+
+```ruby
+Viewmatic::Schema.define do
+  view :reticulated_splines do |v|
+    v.query "SELECT * FROM splines WHERE reticulated = 't'"
+  end
+
+  view :pending_orders do |v|
+    v.query "SELECT * FROM orders WHERE status = 'Pending'"
+    v.materialized true # only available in Postgres
+  end
+end
+```
+
+## Create your migrations
+```ruby
+class AddMyNewViews < ActiveRecord::Migration
+  include Viewmatic::Migration
+
+  def up
+    create_view :reticulated_splines
+    create_view :pending_orders
+  end
+
+  def down
+    drop_view :reticulated_splines
+    drop_view :pending_orders
+  end
+end
+```
+
+## Create your models
+
+**app/models/views/reticulated_spline.rb**
+
+```ruby
+class Views::ReticulatedSpline < ActiveRecord::Base
+  include Viewmatic::Model
+
+  belongs_to :category
+end
+```
+
+**app/models/views/pending_order.rb**
+
+```ruby
+class Views::PendingOrder < ActiveRecord::Base
+  include Viewmatic::Model
+
+  has_many :line_items
+end
+```
+
+You can access your view just like any other ActiveRecord model. Note that they are all read-only.
+
+```ruby
+spline = Views::ReticulatedSpline.find(42)
+spline.readonly?
+=> true
+
+Views::PendingOrder.where(created_on: Date.today).preload(:line_items).find_each do |order|
+  # do stuff with each order
+end
+```
+
+For materialized views, you can refresh the data simply by calling `refresh!` on the model:
+
+```ruby
+PendingOrder.refresh!
+```
+
+## Using ActiveRecord without Rails?
+
+No problem! Everything will work fine - just add this line near the top of your `Rakefile`:
+
+```ruby
+load 'tasks/viewmatic.rake'
+```

data/lib/activerecord-viewmatic.rb

@@ -0,0 +1,29 @@
+require 'active_record'
+
+# Container module for all Viewmatic features.
+module Viewmatic
+  autoload :View, 'viewmatic/view'
+  autoload :Model, 'viewmatic/model'
+  autoload :Schema, 'viewmatic/schema'
+  autoload :SchemaStatements, 'viewmatic/schema_statements'
+  autoload :Migration, 'viewmatic/migration'
+  autoload :VERSION, 'viewmatic/version'
+
+  class << self
+    # @return [Array<Viewmatic::Schema] all schemas loaded from file(s)
+    attr_reader :schemas
+  end
+  @schemas = []
+
+  #
+  # Fetch the first view named "name" from all schemas. If it can't be found an exception is raised.
+  #
+  # @return [Viewmatic::View]
+  #
+  def self.view(name)
+    schema = schemas.detect { |s| s.views.has_key? name }
+    schema ? schema.views[name] : raise(ArgumentError, "Could not find view named `#{name}`")
+  end
+end
+
+require 'viewmatic/railtie' if defined? Rails

data/lib/tasks/viewmatic.rake

@@ -0,0 +1,23 @@
+Dir.glob(Viewmatic::Schema.paths).each { |f| require f }
+
+namespace :db do
+  namespace :views do
+    desc "Load all database views"
+    task :load => :environment do
+      Viewmatic.schemas.each(&:load!)
+    end
+
+    desc "Drop all database views"
+    task :drop => :environment do
+      Viewmatic.schemas.each(&:drop!)
+    end
+  end
+end
+
+Rake::Task['db:schema:load'].enhance do
+  Rake::Task['db:views:load'].invoke
+end
+
+Rake::Task['db:test:prepare'].enhance do
+  Rake::Task['db:views:load'].invoke
+end

data/lib/viewmatic/migration.rb

@@ -0,0 +1,24 @@
+module Viewmatic
+  #
+  # Helpers for creating and dropping views in ActiveRecord migrations.
+  #
+  module Migration
+    #
+    # Create the view named in "name". It must be defined in the view definitions file.
+    #
+    # @param [Symbol] name
+    #
+    def create_view(name)
+      execute SchemaStatements.create_view Viewmatic.view name
+    end
+
+    #
+    # Drop the view named in "name". It must be defined in the view definitions file.
+    #
+    # @param [Symbol] name
+    #
+    def drop_view(name)
+      execute SchemaStatements.drop_view Viewmatic.view name
+    end
+  end
+end

data/lib/viewmatic/model.rb

@@ -0,0 +1,31 @@
+module Viewmatic
+  #
+  # Helpers for view-based ActiveRecord models.
+  #
+  module Model
+    def self.included(model)
+      model.extend ClassMethods
+    end
+
+    #
+    # All view record are read-only.
+    #
+    # @return [Boolea] will always be true
+    #
+    def readonly?
+      true
+    end
+
+    #
+    # Class-level helper methods.
+    #
+    module ClassMethods
+      #
+      # Refresh the underlying materialized view.
+      #
+      def refresh!
+        connection.execute "REFRESH MATERIALIZED VIEW #{table_name}"
+      end
+    end
+  end
+end

data/lib/viewmatic/railtie.rb

@@ -0,0 +1,9 @@
+module Viewmatic
+  class Railtie < Rails::Railtie
+    railtie_name :viewmatic
+
+    rake_tasks do
+      load 'tasks/viewmatic.rake'
+    end
+  end
+end

data/lib/viewmatic/schema.rb

@@ -0,0 +1,78 @@
+module Viewmatic
+  #
+  # Represents a schema of views to be built.
+  #
+  class Schema
+    class << self
+      # @return [Array<String>] Array of globs matching view definition files. default: ['db/views.rb', 'db/views/*.rb']
+      attr_reader :paths
+    end
+
+    @paths = [
+      File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, 'views.rb'),
+      File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, 'views', '*.rb'),
+    ]
+
+    #
+    # Define a new schema. If you pass a block, it will be eval'd inside the Schema instance.
+    #
+    # @return [Viewmatic::Schema]
+    #
+    def self.define(&block)
+      schema = new(&block)
+      Viewmatic.schemas << schema
+      schema
+    end
+
+    # @return [Array<Viewmatic::View] all defined views in this schema
+    attr_reader :views
+
+    #
+    # Initialize a new schema. If you pass a block it will be eval'd inside the instance.
+    #
+    def initialize(&block)
+      @views = {}
+      @conn_proc = -> { ActiveRecord::Base.connection }
+      instance_exec(&block) if block
+    end
+
+    #
+    # Define a new view.
+    #
+    # @param name [Symbol] what to call the view
+    #
+    def view(name)
+      view = views[name] = View.new(name)
+      yield view if block_given?
+      view
+    end
+
+    #
+    # Override the default connection to use.
+    #
+    def connection(&block)
+      @conn_proc = block if block
+      @conn_proc
+    end
+
+    #
+    # Create all views defined in this schema.
+    #
+    def load!
+      conn = @conn_proc.call
+      views.each do |_name, view|
+        conn.execute SchemaStatements.create_view view
+      end
+    end
+
+    #
+    # Drop all views defined in this schema.
+    #
+    def drop!
+      conn = @conn_proc.call
+      views.each do |_name, view|
+        conn.execute SchemaStatements.drop_view view
+      end
+    end
+  end
+end

data/lib/viewmatic/schema_statements.rb

@@ -0,0 +1,14 @@
+module Viewmatic
+  module SchemaStatements
+    def self.create_view(v)
+      mat = v.materialized ? 'MATERIALIZED' : nil
+      cols = v.column_names ? "(#{v.column_names.join ', '})" : nil
+      %Q(CREATE #{mat} VIEW #{v.name} #{cols} AS #{v.query})
+    end
+
+    def self.drop_view(v)
+      mat = v.materialized ? 'MATERIALIZED' : nil
+      %Q(DROP #{mat} VIEW IF EXISTS #{v.name})
+    end
+  end
+end

data/lib/viewmatic/version.rb

@@ -0,0 +1,4 @@
+module Viewmatic
+  # Library version
+  VERSION = '0.1.0'.freeze
+end

data/lib/viewmatic/view.rb

@@ -0,0 +1,40 @@
+module Viewmatic
+  #
+  # Represents a view to be built.
+  #
+  class View
+    #
+    # Initialize a new view.
+    #
+    # @param name [Symbol] name of the view as it will appear in the database
+    #
+    def initialize(name)
+      @name = name
+      @materialized = false
+    end
+
+    # Get/set the view name
+    def name(val = nil)
+      @name = val unless val.nil?
+      @name
+    end
+
+    # Get/set the query backing the view
+    def query(val = nil)
+      @query = val unless val.nil?
+      @query
+    end
+
+    # Get/set the query column name overrides
+    def column_names(val = nil)
+      @column_names = val unless val.nil?
+      @column_names
+    end
+
+    # Get/set the materialized status
+    def materialized(val = nil)
+      @materialized = val unless val.nil?
+      @materialized
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-viewmatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Hollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Helpers for using live and materialized views ActiveRecord
+email: jordan.hollinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/activerecord-viewmatic.rb
+- lib/tasks/viewmatic.rake
+- lib/viewmatic/migration.rb
+- lib/viewmatic/model.rb
+- lib/viewmatic/railtie.rb
+- lib/viewmatic/schema.rb
+- lib/viewmatic/schema_statements.rb
+- lib/viewmatic/version.rb
+- lib/viewmatic/view.rb
+homepage: https://github.com/jhollinger/activerecord-viewmatic
+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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: An easy way to use database views in ActiveRecord
+test_files: []