mini_sql 0.3 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea4564f53848c314c76c45db0c2af652c1e128ebfc1ba52d6ae11b3799149f4
-  data.tar.gz: ecdfdc07fdf11e60338bc2ceb0415cbcc027720c5bba645281217a51befc2402
+  metadata.gz: 3d668e0b456e27a572040825399ca9477d6c4404bfc09e6e87b1330a106491a0
+  data.tar.gz: 3fb2027b34d3837e06f6c92b7075f8811296c0750c5c4c3ae48d6053189a4000
 SHA512:
-  metadata.gz: 76a040187f4932dc9fbc80ae3323633a38462753caec47233dbfad3e276e90d8eeb0fbddcbfe974ade3b0b99c18a487d5ef865ebdb1effc67048352ecd35d99d
-  data.tar.gz: 73c3519bf51a7934af89827830e3e7c45366eec01b1d65dc0c61afb2b87c12b093e9f3db99b1c4db081e6a6a1e983fd24d88db3aa13f63b9e546af0dce36beae
+  metadata.gz: 60449b0a92a13aa471dbc1dd6db2b8ba0571bca67f81bd46644bf8678ab794b5447e59cd3ea7a24d4732bcdb8eca44c9dfec748c57418d826444305395f62190
+  data.tar.gz: a249f769da221d659d1b4dceaf3dd153578fbda3f0951bdac938d178923a54ad852106629d76be38b5c4ad83c4175592b9971223f8e0aab49e91a48747ad7148

data/.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: Mini SQL Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  PGHOST: localhost
+  PGPORT: 5432
+  PGPASSWORD: postgres
+  PGUSER: postgres
+  MINI_SQL_MYSQL_HOST: 127.0.0.1
+  MINI_SQL_MYSQL_PORT: 3306
+  MINI_SQL_MYSQL_PASSWORD: mysql
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    services:
+      postgres:
+        image: postgres:9.6
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: mysql
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+    strategy:
+      matrix:
+        ruby: ["2.7", "2.6", "2.5"]
+        experimental: [false]
+        include:
+          - ruby: ruby-head
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundler cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - name: Create Databases
+        run: |
+          createdb test_mini_sql
+          mysql --host=127.0.0.1 --port=3306 --user=root --password=mysql -e 'CREATE DATABASE test_mini_sql'
+      - name: Setup gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4
+      - name: Tests
+        run: bundle exec rake test
+      - name: Rubocop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -1,5 +1,8 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
-
+inherit_gem:
+  rubocop-discourse: default.yml
+inherit_mode:
+  merge:
+    - Exclude
 AllCops:
   Exclude:
     - 'bench/**/*'

data/CHANGELOG

@@ -1,3 +1,9 @@
+2020-12-30 - 1.0
+
+- Added serialization support using MiniSql::Serializer.to_json / .from_json
+- Fixed minor issue with cache poisoning when using query_decorator
+- Version 1.0 to reflect the stability of the interfaces and project, used in productions for almost 2 years now
+
 2020-06-25 - 0.3
 
 - Added support for query_each and query_each_hash, which lazily queries rows and enables selecting large result sets by streaming

data/lib/mini_sql.rb

@@ -8,6 +8,9 @@ require_relative "mini_sql/connection"
 require_relative "mini_sql/deserializer_cache"
 require_relative "mini_sql/builder"
 require_relative "mini_sql/inline_param_encoder"
+require_relative "mini_sql/decoratable"
+require_relative "mini_sql/serializer"
+require_relative "mini_sql/result"
 
 module MiniSql
   if RUBY_ENGINE == 'jruby'

data/lib/mini_sql/builder.rb

@@ -66,4 +66,14 @@ class MiniSql::Builder
     RUBY
   end
 
+  def query_decorator(decorator, hash_args = nil)
+    hash_args = @args.merge(hash_args) if hash_args && @args
+    hash_args ||= @args
+    if hash_args
+      @connection.query_decorator(decorator, to_sql, hash_args)
+    else
+      @connection.query_decorator(decorator, to_sql)
+    end
+  end
+
 end

data/lib/mini_sql/decoratable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MiniSql
+  module Decoratable
+    def decorated(mod)
+      @decoratorated_classes ||= {}
+      @decoratorated_classes[mod] ||=
+        Class.new(self) do
+          include(mod)
+          instance_eval <<~RUBY
+            def decorator
+              #{mod}
+            end
+          RUBY
+        end
+    end
+
+    def decorator
+      nil
+    end
+  end
+end

data/lib/mini_sql/mysql/connection.rb

@@ -50,9 +50,7 @@ module MiniSql
       private
 
       def run(sql, as, params)
-        if params && params.length > 0
-          sql = param_encoder.encode(sql, *params)
-        end
+        sql = param_encoder.encode(sql, *params)
         raw_connection.query(
           sql,
           as: as,

data/lib/mini_sql/mysql/deserializer_cache.rb

@@ -23,7 +23,9 @@ module MiniSql
           @cache.shift if @cache.length > @max_size
         end
 
-        materializer.include(decorator_module) if decorator_module
+        if decorator_module
+          materializer = materializer.decorated(decorator_module)
+        end
 
         result.map do |data|
           materializer.materialize(data)
@@ -36,18 +38,10 @@ module MiniSql
         fields = result.fields
 
         Class.new do
-          attr_accessor(*fields)
-
-          # AM serializer support
-          alias :read_attribute_for_serialization :send
+          extend MiniSql::Decoratable
+          include MiniSql::Result
 
-          def to_h
-            r = {}
-            instance_variables.each do |f|
-              r[f.to_s.sub('@', '').to_sym] = instance_variable_get(f)
-            end
-            r
-          end
+          attr_accessor(*fields)
 
           instance_eval <<~RUBY
             def materialize(data)

data/lib/mini_sql/postgres/connection.rb

@@ -84,7 +84,7 @@ module MiniSql
         result.type_map = type_map
         result.values
       ensure
-         result.clear if result
+        result.clear if result
       end
 
       def query(sql, *params)
@@ -97,9 +97,7 @@ module MiniSql
 
       def query_each(sql, *params)
         raise StandardError, "Please supply a block when calling query_each" if !block_given?
-        if params && params.length > 0
-          sql = param_encoder.encode(sql, *params)
-        end
+        sql = param_encoder.encode(sql, *params)
 
         raw_connection.send_query(sql)
         raw_connection.set_single_row_mode
@@ -130,9 +128,7 @@ module MiniSql
 
       def query_each_hash(sql, *params)
         raise StandardError, "Please supply a block when calling query_each_hash" if !block_given?
-        if params && params.length > 0
-          sql = param_encoder.encode(sql, *params)
-        end
+        sql = param_encoder.encode(sql, *params)
 
         raw_connection.send_query(sql)
         raw_connection.set_single_row_mode
@@ -195,9 +191,7 @@ module MiniSql
       private
 
       def run(sql, params)
-        if params && params.length > 0
-          sql = param_encoder.encode(sql, *params)
-        end
+        sql = param_encoder.encode(sql, *params)
         raw_connection.async_exec(sql)
       end
 

data/lib/mini_sql/postgres/deserializer_cache.rb

@@ -39,7 +39,9 @@ module MiniSql
           @cache.shift if @cache.length > @max_size
         end
 
-        materializer.include(decorator_module) if decorator_module
+        if decorator_module
+          materializer = materializer.decorated(decorator_module)
+        end
 
         i = 0
         r = []
@@ -66,18 +68,10 @@ module MiniSql
         end
 
         Class.new do
-          attr_accessor(*fields)
-
-          # AM serializer support
-          alias :read_attribute_for_serialization :send
+          extend MiniSql::Decoratable
+          include MiniSql::Result
 
-          def to_h
-            r = {}
-            instance_variables.each do |f|
-              r[f.to_s.sub('@', '').to_sym] = instance_variable_get(f)
-            end
-            r
-          end
+          attr_accessor(*fields)
 
           instance_eval <<~RUBY
             def materialize(pg_result, index)

data/lib/mini_sql/postgres_jdbc/connection.rb

@@ -89,7 +89,7 @@ module MiniSql
       private
 
       def run(sql, params)
-        sql = param_encoder.encode(sql, *params) if params && params.length > 0
+        sql = param_encoder.encode(sql, *params)
         conn = raw_connection
         conn.typemap = self.class.typemap
         conn.execute(sql)

data/lib/mini_sql/postgres_jdbc/deserializer_cache.rb

@@ -28,6 +28,10 @@ module MiniSql
 
         materializer.include(decorator_module) if decorator_module
 
+        if decorator_module
+          materializer = materializer.decorated(decorator_module)
+        end
+
         i = 0
         r = []
         # quicker loop
@@ -44,18 +48,10 @@ module MiniSql
         fields = result.fields
 
         Class.new do
-          attr_accessor(*fields)
+          extend MiniSql::Decoratable
+          include MiniSql::Result
 
-          # AM serializer support
-          alias :read_attribute_for_serialization :send
-
-          def to_h
-            r = {}
-            instance_variables.each do |f|
-              r[f.to_s.sub('@', '').to_sym] = instance_variable_get(f)
-            end
-            r
-          end
+          attr_accessor(*fields)
 
           instance_eval <<~RUBY
             def materialize(pg_result, index)

data/lib/mini_sql/result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MiniSql
+  module Result
+    # AM serializer support
+    alias :read_attribute_for_serialization :send
+
+    def to_h
+      r = {}
+      instance_variables.each do |f|
+        r[f.to_s.delete_prefix('@').to_sym] = instance_variable_get(f)
+      end
+      r
+    end
+
+    def values
+      instance_variables.map { |f| instance_variable_get(f) }
+    end
+  end
+end

data/lib/mini_sql/serializer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MiniSql
+  module Serializer
+    MAX_CACHE_SIZE = 500
+
+    def self.to_json(result)
+      wrapper =
+        if result.length == 0
+          {}
+        else
+          {
+            "decorator" => result[0].class.decorator.to_s,
+            "fields" => result[0].to_h.keys,
+            "data" => result.map(&:values),
+          }
+        end
+
+      JSON.generate(wrapper)
+    end
+
+    def self.from_json(json)
+      wrapper = JSON.parse(json)
+      if !wrapper["data"]
+        []
+      else
+        materializer = cached_materializer(wrapper['fields'], wrapper['decorator'])
+        wrapper["data"].map do |row|
+          materializer.materialize(row)
+        end
+      end
+    end
+
+    def self.cached_materializer(fields, decorator_module = nil)
+      @cache ||= {}
+      key = fields
+      m = @cache.delete(key)
+      if m
+        @cache[key] = m
+      else
+        m = @cache[key] = materializer(fields)
+        @cache.shift if @cache.length > MAX_CACHE_SIZE
+      end
+
+      if decorator_module && decorator_module.length > 0
+        decorator = Kernel.const_get(decorator_module)
+        m = m.decorated(decorator)
+      end
+
+      m
+    end
+
+    def self.materializer(fields)
+      Class.new do
+        extend MiniSql::Decoratable
+        include MiniSql::Result
+
+        attr_accessor(*fields)
+
+        instance_eval <<~RUBY
+          def materialize(values)
+            r = self.new
+            #{col = -1; fields.map { |f| "r.#{f} = values[#{col += 1}]" }.join("; ")}
+            r
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/mini_sql/sqlite/connection.rb

@@ -63,9 +63,7 @@ module MiniSql
       private
 
       def run(sql, *params)
-        if params && params.length > 0
-          sql = param_encoder.encode(sql, *params)
-        end
+        sql = param_encoder.encode(sql, *params)
         if block_given?
           stmt = SQLite3::Statement.new(raw_connection, sql)
           yield stmt.execute

data/lib/mini_sql/sqlite/deserializer_cache.rb

@@ -24,7 +24,9 @@ module MiniSql
           @cache.shift if @cache.length > @max_size
         end
 
-        materializer.include(decorator_module) if decorator_module
+        if decorator_module
+          materializer = materializer.decorated(decorator_module)
+        end
 
         r = []
         # quicker loop
@@ -43,18 +45,10 @@ module MiniSql
         fields = result.columns
 
         Class.new do
-          attr_accessor(*fields)
-
-          # AM serializer support
-          alias :read_attribute_for_serialization :send
+          extend MiniSql::Decoratable
+          include MiniSql::Result
 
-          def to_h
-            r = {}
-            instance_variables.each do |f|
-              r[f.to_s.sub('@', '').to_sym] = instance_variable_get(f)
-            end
-            r
-          end
+          attr_accessor(*fields)
 
           instance_eval <<~RUBY
             def materialize(data)

data/lib/mini_sql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MiniSql
-  VERSION = "0.3"
+  VERSION = "1.0"
 end

data/mini_sql.gemspec

@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
 
   # 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.
-  # rubocop:disable DiscoruseCops/NoChdir
+  # rubocop:disable Discourse/NoChdir
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  # rubocop:enable DiscoruseCops/NoChdir
+  # rubocop:enable Discourse/NoChdir
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "> 1.16"
@@ -38,8 +38,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-minitest", "~> 2.4"
   spec.add_development_dependency "activesupport", "~> 5.2"
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
-  spec.add_development_dependency 'rubocop-discourse', '~> 1.0.2'
+  spec.add_development_dependency 'rubocop', '~> 1.4.0'
+  spec.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
+  spec.add_development_dependency 'm', '~> 1.5.1'
 
   if RUBY_ENGINE == 'jruby'
     spec.add_development_dependency "activerecord-jdbcpostgresql-adapter", "~> 52.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_sql
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '1.0'
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,28 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -171,10 +185,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -190,6 +204,7 @@ files:
 - lib/mini_sql.rb
 - lib/mini_sql/builder.rb
 - lib/mini_sql/connection.rb
+- lib/mini_sql/decoratable.rb
 - lib/mini_sql/deserializer_cache.rb
 - lib/mini_sql/inline_param_encoder.rb
 - lib/mini_sql/mysql/connection.rb
@@ -199,6 +214,8 @@ files:
 - lib/mini_sql/postgres/deserializer_cache.rb
 - lib/mini_sql/postgres_jdbc/connection.rb
 - lib/mini_sql/postgres_jdbc/deserializer_cache.rb
+- lib/mini_sql/result.rb
+- lib/mini_sql/serializer.rb
 - lib/mini_sql/sqlite/connection.rb
 - lib/mini_sql/sqlite/deserializer_cache.rb
 - lib/mini_sql/version.rb
@@ -225,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A fast, safe, simple direct SQL executor

data/.travis.yml

@@ -1,28 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - ruby-head
-
-before_install:
-  - gem install bundler
-
-cache: bundler
-sudo: false
-
-services:
-  - mysql
-
-addons:
-  postgresql: 9.6
-  mysql: 5.7
-
-install:
-  - createdb test_mini_sql
-  - mysql -e 'CREATE DATABASE test_mini_sql;'
-  - bundle install
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head