haj 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 219dc1783cac1e87594e1cb9c035ebe1a9ece7636a35511d4184aca468e9e3f0
+  data.tar.gz: b560ac65c1cb1d7b262c9a73801038740edf4b0d3461166fbdfd9b5ae85ce8d0
+SHA512:
+  metadata.gz: 509ec3899d10345067f6a54dde60aec8a837ca7fbb91f8a9990c97495fe862d3c7eed1ac3d39d447238090f3bec5abc9ede818cb10833ba405d79c1417b7ceff
+  data.tar.gz: a42dcddc1b23cf7f0f2417f1cd835b023f9218a9a77a8ed5d824f5764b58a1989ceee4c07730abcf720cf2e7a4e375bd4f8eb0d4bed7f58a206649a915aaa21c

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.env
+/.mvn/
+/.yardoc
+/_yardoc/
+/coverage/
+/data/redis/*
+/docker-compose.override.yml
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.2.0.0

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - jruby-9.2.0.0
+before_install: gem install bundler -v 1.16.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - jruby -G bin/rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Dockerfile

@@ -0,0 +1,63 @@
+FROM jruby:9.2.0.0
+
+# Bundler options
+#
+# The default value is taken from Travis's build options, so they should be
+# good enough for most cases. For development, be sure to set a blank default
+# in docker-compose.override.yml.
+ARG BUNDLER_OPTS="--jobs=3 \
+                  --retry=3 \
+                  --deployment"
+
+# The home directory of the gem.
+#
+# During development, make sure that the APP_DIR environment variable is
+# identical to the variable in your docker-compose.override.yml file,
+# otherwise things might not work as expected.
+ENV APP_DIR="/opt/haj-rb"
+
+# The jruby image doesn't include git but the general pattern used in
+# the gemspec is to shell out to git to figure out which files are specs.
+# See this line in the gemspec:
+#
+#   `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+#
+# This will make the image slightly bigger but it should be fine as it's
+# meant to be mainly a development aid.
+RUN apt-get update -y \
+      && apt-get install -y --no-install-recommends \
+        git-core \
+      && rm -rf /var/lib/apt/lists/*
+
+# Create a non-root user
+RUN groupadd -r travis \
+    && useradd -m -r -g travis travis
+RUN mkdir -p ${APP_DIR} \
+    && chown -R travis:travis ${APP_DIR}
+
+# Move the the application folder to perform all the following tasks.
+WORKDIR ${APP_DIR}
+# Use the non-root user to perform any commands from this point forward.
+#
+# NOTE: The COPY command requires the --chown flag set otherwise it will
+#       copy things as root.
+USER travis
+
+# Copy the gem's gemspec file so `bundle install` can run when the
+# container is initialized.
+#
+# The added benefit is that Docker will cache this file and will not trigger
+# the bundle install unless the gemspec changed on the filesystem.
+#
+# NOTE: If the command fails because of the --chown flag, make sure you have a
+#       recent stable version of Docker.
+COPY --chown=travis:travis . ./
+
+RUN bundle install ${BUNDLER_OPTS}
+
+# Copy over the files, in case the Docker Compose file does not specify a
+# mount point.
+COPY --chown=travis:travis . ./
+
+ENTRYPOINT ["jruby", "-G"]
+CMD ["bin/rspec"]

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in haj.gemspec
+gemspec
+
+# A bunch of gems required for benchmarking, so we're sure we're on the right
+# track and actually providing a performance gain.
+gem 'benchmark-ips', '~> 2.7'
+
+gem 'faker'
+gem 'sequel', '~> 5.12'
+gem 'jdbc-postgres', '~> 42.1'
+gem 'redis', '~> 4.0'
+gem 'jedis_rb', '~> 2.7'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrei Maxim
+
+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,86 @@
+# Highly-Advanced Jedis client for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/haj.svg)](https://badge.fury.io/rb/haj)
+[![Build Status](https://travis-ci.org/andreimaxim/haj-rb.svg?branch=master)](https://travis-ci.org/andreimaxim/haj-rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/40b89512493cb5356076/maintainability)](https://codeclimate.com/github/andreimaxim/haj-rb/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/40b89512493cb5356076/test_coverage)](https://codeclimate.com/github/andreimaxim/haj-rb/test_coverage)
+
+The raison d'être of this project can be pretty much described in one single
+table:
+
+```bash
+Warming up --------------------------------------
+            Postgres     1.000  i/100ms
+               Redis     1.000  i/100ms
+               Jedis     1.000  i/100ms
+           Ruby hash     5.000  i/100ms
+Calculating -------------------------------------
+            Postgres      2.289  (± 0.0%) i/s -     12.000  in   5.248779s
+               Redis      0.016  (± 0.0%) i/s -      1.000  in  60.470617s
+               Jedis      0.047  (± 0.0%) i/s -      1.000  in  21.109477s
+           Ruby hash     52.735  (±13.3%) i/s -    260.000  in   5.042344s
+```
+
+It looks slightly odd, but let's explain it a bit.
+
+This is the result of a plain benchmark done on a Mac OS X development
+machine using JRuby 9.2.0.0 and several libraries:
+
+* [Sequel][sequel] with [jdbc-postgres][jdbc-pg] for the `Postgres` row
+* Plain [redis-rb][redis-rb] for the `Redis` row
+* For the `Jedis` row the [jedis_rb][jedis_rb] gem was used, which is a simple wrapper over the [jedis][jedis] Java library
+* Finally, `Memory` meant using a plain Ruby hash
+
+[sequel]: https://github.com/jeremyevans/sequel/
+[jdbc-pg]: https://github.com/jruby/activerecord-jdbc-adapter/tree/master/jdbc-postgres
+[redis-rb]: https://github.com/redis/redis-rb
+[jedis_rb]:https://github.com/asmallworldsite/jedis_rb/tree/master/lib/jedis_rb
+[jedis]: https://github.com/xetorthio/jedis
+
+For the test, a table was created in a Postgres database that looked like a key-value store, something along the lines of:
+
+```sql
+SQL
+  CREATE TABLE IF NOT EXISTS things (
+    k text,
+    v text,
+    PRIMARY KEY (k)
+  );
+  TRUNCATE TABLE things;
+SQL
+```
+
+The SQL query used:
+
+```sql
+SELECT v FROM things WHERE k='#{random_key}';
+```
+
+The Redis query used:
+
+```ruby
+redis.get(random_key)
+```
+
+Redis should be faster, especially when used as a key-value store, but Postgres actually blew it out of the water in this little test, which seemed odd.
+
+First, let's talk about the elephant in the room, in this case the significant amount of time required by [redis-rb][redis-rb]: it's a plain Ruby application and a lot of time is spent in userland (280 seconds out of the 298 seconds), while the other libraries use faster languages (Java bindings for both the JDBC driver and Jedis and JRuby optimizes the hash quite nicely).
+
+So, in this case, the language was the bottleneck and maybe some gains can be achieved if the JRuby team will look into the redis-rb gem and suggest some optimizations.
+
+However, it's not so obvious why [jedis_rb][jedis_rb] was so slow compared to [Sequel][sequel] + [jdbc-postgres][jdbc-pg], especially since it's relying on the pretty fast [jedis][jedis] Java library (which is also one of the recommended libraries by Redis).
+
+In this case, the answer lies in the smaller `real` time than the `total` time, which probably means that there are things happening in parallel. So the answer is probably in the connection pool.
+
+There are two things you can do with a connection pool:
+
+1. Create a limited set of connections that can be reused by the application when needed.
+2. Parallelize the requests, when possible.
+
+The [Sequel][sequel] gem was doing both, while [jedis_rb][jedis_rb] didn't even an option to set the number of concurrent connections. Actually, when digging a bit through [Sequel][sequel] but also through [jedis][jedis], it becomes rather obvious that the [Sequel][sequel] developers spent a lot of time and effort to maximize the output of the library by using as many of the connections in the connection pool as possible.
+
+This is where HAJ comes in.
+
+The goal of this project is to have __a more advanced connection pool__ for Jedis which can take advantage of __multiple parallel connections__ to Redis and *dramatically* increase the output.
+
+Obviously, this is a work in progress so please don't use it in production.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'jars/installer'
+
+desc 'Download and vendor the jars needed'
+task :setup do
+  Jars::Installer.vendor_jars!
+end
+
+task :default => :spec

data/bin/benchmark

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+# require 'haj'
+
+require 'faker'
+require 'benchmark/ips'
+require 'sequel'
+require 'jdbc/postgres'
+require 'redis'
+require 'jedis_rb'
+
+
+Jdbc::Postgres.load_driver
+
+redis = Redis.new(host: 'redis')
+redis.flushall
+
+pool = JedisRb::Pool.new(host: 'redis')
+
+conn = Sequel.connect('jdbc:postgresql://pg/hajrb', user: 'hajrb', password: 'hajrb')
+
+conn.run <<-SQL
+  CREATE TABLE IF NOT EXISTS things (
+    k text,
+    v text,
+    PRIMARY KEY (k)
+  );
+  TRUNCATE TABLE things;
+SQL
+
+memory = {}
+
+(1..1000).each do |k|
+  v = Faker::Lorem.paragraph(rand 1..10)
+  conn.run("insert into things (k, v) values ('#{k}', '#{v}')")
+  redis.set(k, v)
+  memory[k]=v
+end
+
+n = 100_000
+random_keys = []
+n.times { random_keys << rand(1..1000) }
+
+Benchmark.ips do |x|
+  x.report('Postgres') do
+    n.times do |i|
+      conn.fetch("select v from things where k='#{random_keys[i]}'")
+    end
+  end
+  x.report('Redis') do
+    n.times do |i|
+      redis.get(random_keys[i])
+    end
+  end
+  x.report('Jedis') do
+    n.times do |i|
+      pool.execute(:get, random_keys[i].to_s)
+    end
+  end
+  x.report('Ruby hash') do
+    n.times do |i|
+      memory[random_keys[i]]
+    end
+  end
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'haj'
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env jruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env jruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/docker-compose.yml

@@ -0,0 +1,20 @@
+version: '3'
+
+services:
+
+  # Required for manual testing against a real Redis process.
+  redis:
+    image: "redis:3.2"
+    command: redis-server --appendonly yes
+
+  # The project was started due to the high performance of the
+  # Sequel + jdbc-postgres combo when compared with the performance
+  # of the existing Redis libraries on JRuby.
+  pg:
+    image: "postgres:9.6.10"
+
+  gem:
+    build: .
+    links:
+      - "redis:redis"
+      - "pg:pg"

data/haj.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haj/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'haj'
+  spec.version       = HAJ::VERSION
+  spec.authors       = ['Andrei Maxim']
+  spec.email         = ['andrei@andreimaxim.ro']
+
+  spec.summary       = 'Highly-Advanced Jedis client for Ruby'
+  spec.homepage      = 'https://github.com/andreimaxim/haj-rb'
+  spec.license       = 'MIT'
+
+  # 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('..', __FILE__)) 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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  
+  spec.add_development_dependency 'jar-dependencies', '~> 0.3'
+
+  # The Jedis JAR
+  spec.requirements << "jar redis.clients:jedis, '~> 2.9.0'"
+end

data/lib/haj.rb

@@ -0,0 +1,10 @@
+require 'singleton'
+
+require 'haj_jars'
+
+require 'haj/version'
+require 'haj/pool'
+
+module HAJ
+
+end

data/lib/haj/pool.rb

@@ -0,0 +1,6 @@
+module HAJ
+  # Class to provide a POC for better pooling.
+  class Pool
+
+  end
+end

data/lib/haj/version.rb

@@ -0,0 +1,3 @@
+module HAJ
+    VERSION = '0.0.1'.freeze
+end

data/lib/haj_jars.rb

@@ -0,0 +1,12 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+begin
+  require 'jar_dependencies'
+rescue LoadError
+  require 'redis/clients/jedis/2.9.0/jedis-2.9.0.jar'
+  require 'org/apache/commons/commons-pool2/2.4.2/commons-pool2-2.4.2.jar'
+end
+
+if defined? Jars
+  require_jar 'redis.clients', 'jedis', '2.9.0'
+  require_jar 'org.apache.commons', 'commons-pool2', '2.4.2'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: haj
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Maxim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2018-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  name: simplecov
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  name: jar-dependencies
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email:
+- andrei@andreimaxim.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- data/redis/.gitkeep
+- docker-compose.yml
+- haj.gemspec
+- lib/haj.rb
+- lib/haj/pool.rb
+- lib/haj/version.rb
+- lib/haj_jars.rb
+- lib/org/apache/commons/commons-pool2/2.4.2/commons-pool2-2.4.2.jar
+- lib/redis/clients/jedis/2.9.0/jedis-2.9.0.jar
+homepage: https://github.com/andreimaxim/haj-rb
+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:
+- jar redis.clients:jedis, '~> 2.9.0'
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Highly-Advanced Jedis client for Ruby
+test_files: []