verifiable_view 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8a982a6eff95584ff03dabe667bd7ad548aa523
+  data.tar.gz: 65bea1f3a80b9eb5891681de82d5bfb8bf0f7823
+SHA512:
+  metadata.gz: 7ba43c9d9fd53c831609618a66385ee3d600c1e22b298ee999f23f5209b2cce9e848a229737f347c1fdf4fca723d61c29ff6108508c0b4ce26539e2cfe62f86e
+  data.tar.gz: 2fa2d18cf62b8b587553134bf4ef9a70c34d17bc5acd1bced3362b2e92a001818ebe9d33695b7801619772cdab0927e29940f32338fe248eb69be0a499ea30b6

data/.gems

@@ -0,0 +1,3 @@
+cutest -v 1.2.3
+activerecord -v 5.2.1.1
+pg -v 1.1.3

data/Readme.md

@@ -0,0 +1,45 @@
+# Verifiable View
+
+Keep your view definitions in sync with your named scopes and associations'
+definitions.
+
+## Installation
+
+`gem install verifiable_view`
+
+## Usage
+
+```rb
+class RegularProduct
+  extend VerifiableView
+
+  definition do
+    Product.not_deprecated.where(..)
+  end
+end
+```
+
+Then in your tests you'll have a
+```rb
+RegularProduct.verify
+```
+
+That will check that you have a `regular_products` view defined in your database
+and that the query matches with your definition (Products that are not
+deprecated, etc)
+
+## Why
+
+Named scopes and named associations are easy to write with Arel and easy to
+maintain. Every time you write a view by crafting your SQL by hand you risk
+forgetting a condition. If you already have a definition of your associations,
+why to violate DRYness and duplicate them?
+
+Also when updating the definition of a named scope, you will notice immediately
+that your view got out of your sync.
+
+## Testing
+
+`gem install dep`
+`dep install`
+`cutest test/*.rb`

data/lib/verifiable_view.rb

@@ -0,0 +1,56 @@
+require 'securerandom'
+
+module VerifiableView
+  def verify
+    VerifiableView.verification_method.call(
+      code_view_definition,
+      db_view_definition
+    )
+  end
+
+  def definition(&block)
+    @definition ||= block or raise "Missing view definition"
+  end
+
+  def self.verification_method=(some_proc)
+    @verification_method = some_proc
+  end
+
+  private
+
+  def code_view_definition
+    view_name = "view_#{SecureRandom.hex(10)}"
+    result = ""
+    transaction do
+      create_view(view_name)
+      result = get_view_sql(view_name)
+      raise ActiveRecord::Rollback
+    end
+
+    result
+  end
+
+  def db_view_definition
+    get_view_sql(table_name)
+  end
+
+  def self.verification_method
+    @verification_method || (lambda do |code_def, db_def|
+      return true if db_def == code_def
+      raise "The view definition in your DB doesn't match with your code" 
+    end)
+  end
+
+  def create_view(name)
+    definition_sql = definition.call.to_sql
+    connection.execute("create view #{name} as #{definition_sql}")
+  end
+  
+  def get_view_sql(view_name)
+    connection.
+      execute("select view_definition from information_schema.views
+              where table_name = '#{view_name}'").
+      first&.
+      fetch("view_definition")
+  end
+end

data/test/support/setup_database_helper.rb

@@ -0,0 +1,31 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection(
+  adapter:  "postgresql",
+  database: "verifiable_view",
+  encoding: "utf8",
+  host: "localhost",
+  min_messages: "warning"
+)
+
+class CreateSchema < ActiveRecord::Migration[5.2]
+  def self.up
+    execute <<~SQL
+      DROP VIEW IF EXISTS regular_products
+    SQL
+
+    create_table :products, force: true do |table|
+      table.string :product_category, null: false
+      table.boolean :deprecated, null: false
+    end
+
+    execute <<-SQL
+      CREATE VIEW regular_products AS
+      SELECT "products".* FROM "products" WHERE "products"."product_category" = 'regular' AND "products"."deprecated" = FALSE
+    SQL
+  end
+end
+
+CreateSchema.suppress_messages do
+  CreateSchema.migrate(:up)
+end

data/test/verifiable_view_test.rb

@@ -0,0 +1,72 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+require_relative "support/setup_database_helper"
+require 'verifiable_view'
+
+class Product < ActiveRecord::Base
+  scope :regular, -> { where(product_category: :regular) }
+  scope :active, -> { where(deprecated: false) }
+end
+
+class RegularProduct < ActiveRecord::Base
+  extend VerifiableView
+
+  definition do
+    Product.regular.active
+  end
+end
+
+test ".verify" do
+  VerifiableView.verification_method = (lambda do |expected, actual|
+    assert_equal(expected, actual)
+  end)
+
+  RegularProduct.verify
+end
+
+test ".verify raises exception when missing code definition" do
+  class NoDefinitionView < ActiveRecord::Base
+    extend VerifiableView
+
+    self.table_name = :regular_products
+  end
+
+  error = assert_raise do
+    NoDefinitionView.verify
+  end
+  assert_equal("Missing view definition", error.message)
+end
+
+test ".verify with unmatched db definition" do
+  class DeprecatedRegularProduct < ActiveRecord::Base
+    extend VerifiableView
+    self.table_name = :regular_products
+
+    definition do
+      Product.regular.where(deprecated: true)
+    end
+  end
+
+  assert_raise do
+    DeprecatedRegularProduct.verify
+  end
+end
+
+test ".verify compares with nil when missing db view" do
+  class NoView < ActiveRecord::Base
+    extend VerifiableView
+
+    definition do
+      Product.regular
+    end
+  end
+
+  values = {}
+  VerifiableView.verification_method = (lambda do |expected, actual|
+    values[:actual] = actual
+    values[:expected] = expected
+  end)
+
+  NoView.verify
+  assert values[:expected].downcase.include?("select")
+  assert_equal(nil, values[:actual])
+end

data/verifiable_view.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name              = "verifiable_view"
+  s.version           = "0.0.1"
+  s.summary           = "Database Views that don't break"
+  s.description       = "Easier way to mantain Database Views with ActiveRecord"
+  s.authors           = ["CarlosIPe"]
+  s.email             = ["carlos2@compendium.com.ar"]
+  s.homepage          = "https://github.com/carlosipe/verifiable_view"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest", '~> 1'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: verifiable_view
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- CarlosIPe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Easier way to mantain Database Views with ActiveRecord
+email:
+- carlos2@compendium.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- Readme.md
+- lib/verifiable_view.rb
+- test/support/setup_database_helper.rb
+- test/verifiable_view_test.rb
+- verifiable_view.gemspec
+homepage: https://github.com/carlosipe/verifiable_view
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Database Views that don't break
+test_files: []