doublecheck_view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f70b4558ff3f16e09f69bb716938ec3cddbfa76d
+  data.tar.gz: 9c0de1e45a2c8b4fa2250a4e3f8ffe3b675909f5
+SHA512:
+  metadata.gz: f5d67d1176af84bf269387de52f47687e6e0e1af526f625c1ec96759ca132703e4a218a6b4a06e600be1087f4e0ff9c088c60faf3b85b21dc3bf65d74b383e2c
+  data.tar.gz: 56b9967d522729a35836b22fa6f249f05b16aa7457b374bbd3231af450e778b5c2dc389fbc2d9e830c154faf2f537eb0a1dcdc9c74fe582f69a8807682795da8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jack Christensen
+
+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,68 @@
+# Doublecheck View
+
+doublecheck_view is a Ruby gem that makes it easy to validate doublecheck views
+during automated tests. See https://github.com/jackc/doublecheck for more
+information about the doublecheck view pattern.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doublecheck_view'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doublecheck_view
+
+## Usage
+
+You can check for errors manually at any time. The following code will select from every view in the `doublecheck` schema and `check_result` will only be valid if no rows are returned from any view.
+
+```ruby
+doublecheck = DoublecheckView::Doublecheck.new
+check_result = doublecheck.check
+assert check_result.valid?, check_result.errors
+```
+
+However, the preferred approach is to run doublecheck after every test that uses
+the database.
+
+```ruby
+# Inside a MiniTest or ActiveSupport::TestCase class body
+
+  def before_teardown
+    doublecheck = DoublecheckView::Doublecheck.new
+    check_result = doublecheck.check
+    assert check_result.valid?, check_result.errors
+    super
+  end
+```
+
+Or for RSpec:
+
+```ruby
+RSpec.configure do |config|
+  # ...
+  config.before(:each) do
+    doublecheck = DoublecheckView::Doublecheck.new
+    check_result = doublecheck.check
+    expect(check_result).to be_valid, "doublecheck views: #{check_result.errors}"
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jackc/doublecheck.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doublecheck_view"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doublecheck_view.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doublecheck_view/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doublecheck_view"
+  spec.version       = DoublecheckView::VERSION
+  spec.authors       = ["Jack Christensen"]
+  spec.email         = ["jack@jackchristensen.com"]
+
+  spec.summary       = %q{Test doublecheck views with ActiveRecord}
+  spec.homepage      = "https://github.com/jackc/doublecheck_view"
+  spec.license       = "MIT"
+
+  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.add_dependency 'activerecord', "> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/doublecheck_view/doublecheck.rb

@@ -0,0 +1,71 @@
+module DoublecheckView
+  class ViewResult
+    attr_reader :name, :rows
+
+    def initialize(name, rows)
+      @name = name
+      @rows = rows
+    end
+
+    def valid?
+      rows.empty?
+    end
+  end
+
+  class CheckResult
+    attr_reader :view_results
+
+    def initialize(view_results)
+      @view_results = view_results
+    end
+
+    def valid?
+      view_results.all?(&:valid?)
+    end
+
+    def errors
+      view_results.reject(&:valid?).each_with_object({}) do |vr, hash|
+        hash[vr.name] = vr.rows
+      end
+    end
+  end
+
+  class Doublecheck
+    attr_reader :schema
+    attr_reader :views
+
+    def initialize(schema: "doublecheck")
+      @schema = schema
+      @views = get_views
+    end
+
+    def check(views: self.views)
+      view_results = views.map do |v|
+        rows = conn.select_all("select * from #{quote_identifier schema}.#{quote_identifier v}").to_a
+        ViewResult.new v, rows
+      end
+
+      CheckResult.new view_results
+    end
+
+    private
+
+    def get_views
+      conn.select_values <<-SQL
+        select table_name from information_schema.views where table_schema=#{quote_value schema} order by 1
+      SQL
+    end
+
+    def conn
+      ActiveRecord::Base.connection
+    end
+
+    def quote_value(value)
+      conn.quote value
+    end
+
+    def quote_identifier(ident)
+      conn.quote_column_name ident
+    end
+  end
+end

data/lib/doublecheck_view/version.rb

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

data/lib/doublecheck_view.rb

@@ -0,0 +1,6 @@
+require "doublecheck_view/version"
+require "doublecheck_view/doublecheck"
+
+module DoublecheckView
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: doublecheck_view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Christensen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- jack@jackchristensen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doublecheck_view.gemspec
+- lib/doublecheck_view.rb
+- lib/doublecheck_view/doublecheck.rb
+- lib/doublecheck_view/version.rb
+homepage: https://github.com/jackc/doublecheck_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.5.1
+signing_key: 
+specification_version: 4
+summary: Test doublecheck views with ActiveRecord
+test_files: []