nt-fingerprint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9def9ac1a0781ac26a8de4ec3c045419d32b04914d9017b24b24bc05406eff69
+  data.tar.gz: e8e53e0a6378ab8153eefecf1f837a73bb2472e77f6761f65ef6eda365740165
+SHA512:
+  metadata.gz: '08462d0f676c1ffee6d223b90c466b065db3e4923c808d4d65d784ade79623c19a64a49326bedc806e23d6d818b66594754305dfd0bcb68500353202b31c213e'
+  data.tar.gz: ee10cb0ad7700e195fe5a692be2b5c8a4e72316cf740748a1456fc69858cf272684e8fd58cd519e1bac4e17771a6af08a8361b1f2c1a3800e18d9935571ae9e5

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  run_rspec:
+    name: Run Rspec on ${{ matrix.os }} with ${{ matrix.ruby-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2021-02-12
+
+* Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, Nayuta Yanagisawa
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Makefile

@@ -0,0 +1,12 @@
+build: go/libfp.go
+	xgo --targets="linux/amd64,darwin/amd64" \
+		--buildmode=c-shared \
+		--out=libfp \
+		--dest=go/build \
+		github.com/nayuta-yanagisawa/nt-fingerprint/go
+
+test:
+	bundle exec rspec
+
+format:
+	bundle exec rubocop --auto-correct

data/README.md

@@ -0,0 +1,53 @@
+# nt-fingerprint
+
+![test](https://github.com/nayuta-yanagisawa/nt-fingerprint/workflows/test/badge.svg)
+
+## Synopsis
+
+nt-fingerprint is a Ruby gem for converting queries into fingerprints.
+
+```ruby
+require 'nt/fingerprint'
+
+class Sample
+  include Nt::Fingerprint
+end
+
+puts Sample.new.fingerprint("SELECT a, b, 'c' FROM t WEHERE a = 1 AND b IN (1, 2, 3)")
+# => select a, b, ? from t wehere a = ? and b in(?+)
+```
+
+nt-fingerprint exposes a single method `fingerprint`. What the method does is just calling a function `query.Fingerprint` of [percona/go-mysql](https://github.com/percona/go-mysql) via FFI. Thus, the behavior of `fingerprint` completely follows that of `query.Fingerprint`. We quote the description of `query.Fingerprint` from the [documentation](https://pkg.go.dev/github.com/percona/go-mysql@v0.0.0-20200630114833-b77f37c0bfa2/query#Fingerprint) of go-mysql.
+
+> ```
+> func Fingerprint(q string) string
+> ```
+> Fingerprint returns the canonical form of q. The primary transformations are:
+> ```
+> - Replace values with ?
+> - Collapse whitespace
+> - Remove comments
+> - Lowercase everything
+> ```
+> Additional trasnformations are performed which change the syntax of the original query without affecting its performance characteristics. For example, "ORDER BY col ASC" is the same as "ORDER BY col", so "ASC" in the fingerprint is removed.
+
+## Examples
+
+A typical use case of nt-fingerprint is query logging. Using nt-fingerprint, one can exclude sensitive information from queries. This makes it possible to log production queries while maintaining security.
+
+For example, one can capture arbitrary ActiveRecord queries by combining [Arproxy](https://github.com/cookpad/arproxy) and nt-fingerprint.
+
+```ruby
+class QueryLogger < Arproxy::Base
+  include Nt::Fingerprint
+
+  def execute(sql, name=nil)
+    Rails.logger.info(fingerprint(sql))
+    super(sql, name)
+  end
+end
+
+Arproxy.configure do |config|
+  config.use QueryLogger
+end
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/go/build/libfp-darwin-10.6-amd64.h

@@ -0,0 +1,76 @@
+/* Code generated by cmd/cgo; DO NOT EDIT. */
+
+/* package github.com/nayuta-yanagisawa/nt-fingerprint/go */
+
+
+#line 1 "cgo-builtin-export-prolog"
+
+#include <stddef.h> /* for ptrdiff_t below */
+
+#ifndef GO_CGO_EXPORT_PROLOGUE_H
+#define GO_CGO_EXPORT_PROLOGUE_H
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef struct { const char *p; ptrdiff_t n; } _GoString_;
+#endif
+
+#endif
+
+/* Start of preamble from import "C" comments.  */
+
+
+
+
+/* End of preamble from import "C" comments.  */
+
+
+/* Start of boilerplate cgo prologue.  */
+#line 1 "cgo-gcc-export-header-prolog"
+
+#ifndef GO_CGO_PROLOGUE_H
+#define GO_CGO_PROLOGUE_H
+
+typedef signed char GoInt8;
+typedef unsigned char GoUint8;
+typedef short GoInt16;
+typedef unsigned short GoUint16;
+typedef int GoInt32;
+typedef unsigned int GoUint32;
+typedef long long GoInt64;
+typedef unsigned long long GoUint64;
+typedef GoInt64 GoInt;
+typedef GoUint64 GoUint;
+typedef __SIZE_TYPE__ GoUintptr;
+typedef float GoFloat32;
+typedef double GoFloat64;
+typedef float _Complex GoComplex64;
+typedef double _Complex GoComplex128;
+
+/*
+  static assertion to make sure the file is being used on architecture
+  at least with matching size of GoInt.
+*/
+typedef char _check_for_64_bit_pointer_matching_GoInt[sizeof(void*)==64/8 ? 1:-1];
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef _GoString_ GoString;
+#endif
+typedef void *GoMap;
+typedef void *GoChan;
+typedef struct { void *t; void *v; } GoInterface;
+typedef struct { void *data; GoInt len; GoInt cap; } GoSlice;
+
+#endif
+
+/* End of boilerplate cgo prologue.  */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+extern char* fingerprint(char* p0);
+
+#ifdef __cplusplus
+}
+#endif

data/go/build/libfp-linux-amd64.h

@@ -0,0 +1,76 @@
+/* Code generated by cmd/cgo; DO NOT EDIT. */
+
+/* package github.com/nayuta-yanagisawa/nt-fingerprint/go */
+
+
+#line 1 "cgo-builtin-export-prolog"
+
+#include <stddef.h> /* for ptrdiff_t below */
+
+#ifndef GO_CGO_EXPORT_PROLOGUE_H
+#define GO_CGO_EXPORT_PROLOGUE_H
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef struct { const char *p; ptrdiff_t n; } _GoString_;
+#endif
+
+#endif
+
+/* Start of preamble from import "C" comments.  */
+
+
+
+
+/* End of preamble from import "C" comments.  */
+
+
+/* Start of boilerplate cgo prologue.  */
+#line 1 "cgo-gcc-export-header-prolog"
+
+#ifndef GO_CGO_PROLOGUE_H
+#define GO_CGO_PROLOGUE_H
+
+typedef signed char GoInt8;
+typedef unsigned char GoUint8;
+typedef short GoInt16;
+typedef unsigned short GoUint16;
+typedef int GoInt32;
+typedef unsigned int GoUint32;
+typedef long long GoInt64;
+typedef unsigned long long GoUint64;
+typedef GoInt64 GoInt;
+typedef GoUint64 GoUint;
+typedef __SIZE_TYPE__ GoUintptr;
+typedef float GoFloat32;
+typedef double GoFloat64;
+typedef float _Complex GoComplex64;
+typedef double _Complex GoComplex128;
+
+/*
+  static assertion to make sure the file is being used on architecture
+  at least with matching size of GoInt.
+*/
+typedef char _check_for_64_bit_pointer_matching_GoInt[sizeof(void*)==64/8 ? 1:-1];
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef _GoString_ GoString;
+#endif
+typedef void *GoMap;
+typedef void *GoChan;
+typedef struct { void *t; void *v; } GoInterface;
+typedef struct { void *data; GoInt len; GoInt cap; } GoSlice;
+
+#endif
+
+/* End of boilerplate cgo prologue.  */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+extern char* fingerprint(char* p0);
+
+#ifdef __cplusplus
+}
+#endif

data/go/go.mod

@@ -0,0 +1,5 @@
+module github.com/nayuta-yanagisawa/nt-fingerprint/go
+
+go 1.15
+
+require github.com/percona/go-mysql v0.0.0-20200511222729-cd2547baca36

data/go/go.sum

@@ -0,0 +1,2 @@
+github.com/percona/go-mysql v0.0.0-20200511222729-cd2547baca36 h1:j1o9HyH+5QLfKONVNRp6LCSYBJnIVKzSGrzTsrWXxsQ=
+github.com/percona/go-mysql v0.0.0-20200511222729-cd2547baca36/go.mod h1:/SGLf9OMxlnK6jq4mkFiImBcJXXk5jwD+lDrwDaGXcw=

data/go/libfp.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"C"
+
+	"github.com/percona/go-mysql/query"
+)
+
+//export fingerprint
+func fingerprint(q *C.char) *C.char {
+	return C.CString(query.Fingerprint(C.GoString(q)))
+}
+
+func main() {}

data/lib/nt/fingerprint.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'fingerprint/version'
+require_relative 'fingerprint/fingerprint'

data/lib/nt/fingerprint/fingerprint.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module Nt
+  # Fingerprint converts queries to fingerprints.
+  module Fingerprint
+    extend FFI::Library
+
+    platform = `uname -sm`
+
+    file = case platform
+           when /^Linux.*64/
+             'libfp-linux-amd64.so'
+           when /^Darwin.*64/
+             'libfp-darwin-10.6-amd64.dylib'
+           else
+             abort 'nt-fingerprint does not support your platform.'
+           end
+
+    ffi_lib File.expand_path("../../../go/build/#{file}", __dir__)
+    attach_function :fingerprint, [:string], :string
+  end
+end

data/lib/nt/fingerprint/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Nt
+  module Fingerprint
+    VERSION = '0.1.0'
+  end
+end

data/nt-fingerprint.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/nt/fingerprint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nt-fingerprint'
+  spec.version       = Nt::Fingerprint::VERSION
+  spec.authors       = ['Nayuta Yanagisawa']
+  spec.email         = ['nayuta.yanagisawa@hey.com']
+
+  spec.summary       = 'nt-fingerprint convert queries into fingerprints.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/nayuta-yanagisawa/nt-fingerprint'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'ffi'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: nt-fingerprint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nayuta Yanagisawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: nt-fingerprint convert queries into fingerprints.
+email:
+- nayuta.yanagisawa@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- go/build/libfp-darwin-10.6-amd64.dylib
+- go/build/libfp-darwin-10.6-amd64.h
+- go/build/libfp-linux-amd64.h
+- go/build/libfp-linux-amd64.so
+- go/go.mod
+- go/go.sum
+- go/libfp.go
+- lib/nt/fingerprint.rb
+- lib/nt/fingerprint/fingerprint.rb
+- lib/nt/fingerprint/version.rb
+- nt-fingerprint.gemspec
+homepage: https://github.com/nayuta-yanagisawa/nt-fingerprint
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nayuta-yanagisawa/nt-fingerprint
+  source_code_uri: https://github.com/nayuta-yanagisawa/nt-fingerprint
+  changelog_uri: https://github.com/nayuta-yanagisawa/nt-fingerprint
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: nt-fingerprint convert queries into fingerprints.
+test_files: []