sequel_caller_location 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d845d6dcf0e1c5ede539c4667c39995b9641d09
+  data.tar.gz: baad2437df4715cd35d5dde81c0df0d104fa513f
+SHA512:
+  metadata.gz: c0c683e308e0514d86df3be78d6b6a0974370fc58bf6b1601c9cee59b3dee83a5d6e100879697565fff22329162545bbafb0ec68e2fcad66a6af2c156560a2ec
+  data.tar.gz: a5a9bb6953de4275ca461e41243fee8afbd5d532ac12874d76d569c1d85a94b9ddc97ba8c3a62cf7e1bce93ddd1fc4fcf6a8617883811aaacd399f169ba8e1be

data/.gitignore

@@ -0,0 +1,5 @@
+coverage
+*.gem
+doc/
+.yardoc
+.tags

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-11 19:36:45 -0700 using RuboCop version 0.43.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 152
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/sequel/extensions/comments.rb'

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+sudo: false
+script: bundle exec rspec
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    sequel_comments (0.1.1)
+      sequel (~> 4.39, >= 4.39.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.2)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.43.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sequel (4.39.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.5, >= 3.5.0)
+  rubocop (~> 0.43, >= 0.43.0)
+  sequel_comments!
+  simplecov (~> 0.12.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Timothée Peignier <timothee.peignier@tryphon.org>
+
+MIT License
+
+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,28 @@
+# Sequel Caller Location
+
+Set the caller location as comments to your SQL.
+
+## Installation
+
+Install it directly using gem:
+
+```
+gem install sequel_caller_location
+```
+
+Or adding it to your ``Gemfile``:
+
+```
+gem "sequel_caller_location"
+```
+
+## Usage
+
+## Configure
+
+A straightforward example, this will let sequel_caller_location add the caller location
+automatically:
+
+```ruby
+DB.extension(:caller_location)
+```

data/lib/sequel/extensions/caller_location.rb

@@ -0,0 +1,24 @@
+# frozen-string-literal: true
+require 'sequel'
+
+module Sequel
+  module CallerLocation
+    %w(select insert update delete).each do |type|
+      define_method(:"#{type}_sql") do |*a|
+        sql = super(*a)
+        if (backtrace = caller_locations(1).find { |c| c.path !~ /gems/ })
+          sql += format_sql_comment(backtrace)
+        end
+        sql
+      end
+    end
+
+    private
+
+    def format_sql_comment(comment)
+      " -- #{comment.to_s.gsub(/\s+/, ' ')}\n"
+    end
+  end
+
+  Dataset.register_extension(:caller_location, CallerLocation)
+end

data/sequel_caller_location.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Timothée Peignier']
+  gem.email         = ['timothee.peignier@tryphon.org']
+  gem.description   = 'Add caller location as SQL comments'
+  gem.summary       = 'Add caller location as SQL comments.'
+  gem.homepage      = 'http://rubygems.org/gems/sequel_caller_location'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'sequel_caller_location'
+  gem.require_paths = ['lib']
+  gem.version       = '0.1.1'
+
+  gem.add_runtime_dependency 'sequel', '~> 4.39', '>= 4.39.0'
+
+  gem.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  gem.add_development_dependency 'simplecov', '~> 0.12.0'
+  gem.add_development_dependency 'rubocop', '~> 0.43', '>= 0.43.0'
+end

data/spec/caller_location_spec.rb

@@ -0,0 +1,13 @@
+# frozen-string-literal: true
+require 'spec_helper'
+
+describe Sequel::CallerLocation do
+  let(:ds) { Sequel.mock[:t].extension(:caller_location) }
+
+  it 'add caller location comment' do
+    expect(ds.select_sql).to eq("SELECT * FROM t -- #{caller_locations(0, 1).first}\n")
+    expect(ds.insert_sql(a: 1)).to eq("INSERT INTO t (a) VALUES (1) -- #{caller_locations(0, 1).first}\n")
+    expect(ds.delete_sql).to eq("DELETE FROM t -- #{caller_locations(0, 1).first}\n")
+    expect(ds.update_sql(a: 1)).to eq("UPDATE t SET a = 1 -- #{caller_locations(0, 1).first}\n")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen-string-literal: true
+require 'bundler'
+Bundler.require
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter('spec/')
+end
+
+require 'sequel'
+require 'sequel/extensions/caller_location'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sequel_caller_location
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Timothée Peignier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.39'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.39.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.39'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.39.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+description: Add caller location as SQL comments
+email:
+- timothee.peignier@tryphon.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/sequel/extensions/caller_location.rb
+- sequel_caller_location.gemspec
+- spec/caller_location_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/sequel_caller_location
+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: Add caller location as SQL comments.
+test_files:
+- spec/caller_location_spec.rb
+- spec/spec_helper.rb