rspec-have_readonly_query_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f405bdfe7b9168719524dcc3ec3031243c63110ec8aba5f0d1df7537917a172
+  data.tar.gz: a1e2d3d3f877c2e61d83ccdf0cf4ebce23433630e0df7a76a8176dd9d4a53063
+SHA512:
+  metadata.gz: 9ea6e41e03b52525af0a5c69992586a026e917d8810fe0939e83cb0c3bac241b417ba6c2d342eeede8b35a8a603c59a0f64a137bd21cc31e3d44b21b7ddcb131
+  data.tar.gz: ad337d7044a0b86514c1f5e97731b751931db88e7914acd5d13167b505d9afc207456b332b3a8602dfc723a21e99f5e0b765400b9dfc95e711edc3a1892f17d2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rspec-have_readonly_query_matcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Takatoshi Ono
+
+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,60 @@
+# Rspec::HaveReadonlyQueryMatcher
+
+This library provides an rspec matcher that tests the code issues only read queries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-have_readonly_query_matcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-have_readonly_query_matcher
+
+## Usage
+
+### Configuration
+
+spec/spec_helper.rb:
+```ruby
+require 'rspec/have_readonly_query_matcher'
+
+RSpec::HaveReadonlyQueryMatcher.configure do |config|
+  config.adapter = ActiveRecord::ConnectionAdapters::Mysql2Adapter
+end
+
+RSpec.configuration.include RSpec::HaveReadonlyQueryMatcher
+```
+
+### Matchers
+
+- have_readonly_query
+- have_only_read_query
+
+```ruby
+expect { do_something }.to have_readonly_query
+
+# same thing
+expect { do_something }.to have_only_read_query
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/takatoshiono/rspec-have_readonly_query_matcher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/have_readonly_query_matcher"
+
+# 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(__FILE__)

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/lib/rspec/have_readonly_query_matcher/config.rb

@@ -0,0 +1,27 @@
+module RSpec
+  module HaveReadonlyQueryMatcher
+    class Config
+      attr_reader :adapter
+
+      def adapter=(adapter)
+        @adapter = adapter
+        prepend_readonlyable
+      end
+
+      private
+
+      def prepend_readonlyable
+        adapter_class.prepend(RSpec::HaveReadonlyQueryMatcher::Readonlyable)
+      end
+
+      def adapter_class
+        case @adapter
+        when Class
+          @adapter
+        else
+          raise RSpec::HaveReadonlyQueryMatcher::Error, "Unexpected adapter: #{@adapter}"
+        end
+      end
+    end
+  end
+end  

data/lib/rspec/have_readonly_query_matcher/have_readonly_query.rb

@@ -0,0 +1,33 @@
+module RSpec
+  module HaveReadonlyQueryMatcher
+    class HaveReadonlyQuery
+      def matches?(given_proc)
+        begin
+          RSpec::HaveReadonlyQueryMatcher.enable!
+          given_proc.call
+        rescue RSpec::HaveReadonlyQueryMatcher::Readonlyable::NotReadonlyError => e
+          return false
+        ensure
+          RSpec::HaveReadonlyQueryMatcher.disable!
+        end
+        true
+      end
+
+      def description
+        "have only read queries"
+      end
+
+      def failure_message
+        "expected have only read queries"
+      end
+
+      def failure_message_when_negated
+        "expected not have only read queries"
+      end
+
+      def supports_block_expectations?
+        true
+      end
+    end
+  end
+end

data/lib/rspec/have_readonly_query_matcher/readonlyable.rb

@@ -0,0 +1,19 @@
+module RSpec
+  module HaveReadonlyQueryMatcher
+    module Readonlyable
+      class NotReadonlyError < StandardError; end
+
+      def execute(sql, name = nil)
+        if RSpec::HaveReadonlyQueryMatcher.enable?
+            if sql =~ /^(SELECT|SET|SHOW|DESCRIBE)\b/
+              super sql, name
+            else
+              raise NotReadonlyError.new("#{name}: #{sql}")
+            end
+        else
+            super sql, name
+        end
+      end
+    end
+  end
+end

data/lib/rspec/have_readonly_query_matcher/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module HaveReadonlyQueryMatcher
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/have_readonly_query_matcher.rb

@@ -0,0 +1,32 @@
+require "rspec/have_readonly_query_matcher/version"
+require "rspec/have_readonly_query_matcher/config"
+require "rspec/have_readonly_query_matcher/have_readonly_query"
+require "rspec/have_readonly_query_matcher/readonlyable"
+
+module RSpec
+  module HaveReadonlyQueryMatcher
+    def have_readonly_query
+      HaveReadonlyQuery.new
+    end
+    alias_method :have_only_read_query, :have_readonly_query
+
+    module_function
+
+    def configure
+      @config = Config.new
+      yield @config
+    end
+
+    def enable!
+      @enabled = true
+    end
+
+    def disable!
+      @enabled = false
+    end
+
+    def enable?
+      @enabled || false
+    end
+  end
+end

data/rspec-have_readonly_query_matcher.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/have_readonly_query_matcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-have_readonly_query_matcher"
+  spec.version       = RSpec::HaveReadonlyQueryMatcher::VERSION
+  spec.authors       = ["Takatoshi Ono"]
+  spec.email         = ["takatoshi.ono@gmail.com"]
+
+  spec.summary       = %q{RSpec matcher for testing readonly queries}
+  spec.description   = %q{RSpec matcher for testing readonly queries}
+  spec.homepage      = "https://github.com/takatoshiono/rspec-have_readonly_query_matcher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rspec-have_readonly_query_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takatoshi Ono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RSpec matcher for testing readonly queries
+email:
+- takatoshi.ono@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/have_readonly_query_matcher.rb
+- lib/rspec/have_readonly_query_matcher/config.rb
+- lib/rspec/have_readonly_query_matcher/have_readonly_query.rb
+- lib/rspec/have_readonly_query_matcher/readonlyable.rb
+- lib/rspec/have_readonly_query_matcher/version.rb
+- rspec-have_readonly_query_matcher.gemspec
+homepage: https://github.com/takatoshiono/rspec-have_readonly_query_matcher
+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.7.6
+signing_key: 
+specification_version: 4
+summary: RSpec matcher for testing readonly queries
+test_files: []