efficient_join 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0eb0fc1fe97206cfe1fc37b6dcc15904d9ab7276add24337afedc487255bab35
+  data.tar.gz: 98a1732e553cb92eae5c957e34353c79924b6ea8d8fdd23259f20366a02142e2
+SHA512:
+  metadata.gz: 9352ba250499feb06620b23ba816c5ab12dbf91e25f689d78c1a36b842f6767a94d1361a92fc903b1a9bbc4d423fca19d72596ffd270666467e0069791f5620e
+  data.tar.gz: 908e42ce26f867477eabf07f5738d2abd33838c2731c54464130b5e93886e484584f5e1f23cb25bd52202d5fd2a797499115212adc9300c54f3f68e14ceb9977

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in efficient_join.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tom Morton
+
+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,79 @@
+# EfficientJoin
+
+Very fast and memory-efficient way to join a list of ruby numbers.
+
+Joins are performed with a constant number of ruby object allocations,
+compared to `Array#join`, `PG:TextEncoder::Array.new.encode`, etc, where at least `n` object
+allocations are required to join an array of `n` items.
+
+For tests with array sizes of 1 million entries, here are some measured memory
+usage and execution time improvements:
+
+| EfficientJoin function | Equivalent ruby function          | Memory usage | Time         |
+| ---------------------- | --------------------------------- | ------------ | ------------ |
+| join                   | Array#join                        | 30%          | 2.5x faster  |
+| join_pg_array          | PG::TextEncoder::Array.new.encode | 18%          | 2.1x faster  |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'efficient_join'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install efficient_join
+
+## Usage
+
+With ruby #join:
+
+```
+MemoryProfiler.report { (0...1000000).to_a.join(',') }
+  ...
+  @total_allocated=1000003,
+  @total_allocated_memsize=62636393,
+```
+
+With efficient join:
+```
+require 'efficient_join'
+EfficientJoin.join('','',',',(0...1000000).to_a)
+  ...
+  @total_allocated=5,
+  @total_allocated_memsize=18525362
+```
+
+It takes prefix and suffix:
+```
+EfficientJoin.join('(', ',now(),now())', ',', [1,2,3,4])
+ => "(1,now(),now()),(2,now(),now()),(3,now(),now()),(4,now(),now())" 
+```
+
+And has a variant for efficiently building postgres arrays (which is far more
+efficient than `PG::TextEncoder::Array.new.encode`:
+
+```
+EfficientJoin.join_pg_array([1,2,3,4])
+ => "{1,2,3,4}"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/tomm/efficient_join.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("efficient_join") do |ext|
+  ext.lib_dir = "lib/efficient_join"
+end
+
+task :default => [:clobber, :compile, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "efficient_join"
+
+# 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/efficient_join.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "efficient_join/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "efficient_join"
+  spec.version       = EfficientJoin::VERSION
+  spec.authors       = ["Tom Morton"]
+  spec.email         = ["tomm8086@googlemail.com"]
+
+  spec.summary       = %q{.}
+  spec.description   = %q{Very fast and memory-efficient way to join a list of ruby numbers.}
+  spec.homepage      = "https://github.com/tomm/efficient_join"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tomm/efficient_join.git"
+  #spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+
+  # 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.extensions    = ["ext/efficient_join/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+end

data/ext/efficient_join/efficient_join.c

@@ -0,0 +1,51 @@
+#include "efficient_join.h"
+
+static VALUE _join(const char *header, const char *footer, const char *item_prefix, const char *item_suffix, const char *join, VALUE number_array) {
+    VALUE out;
+    const long array_len = RARRAY_LEN(number_array);
+    char *buf;
+    size_t buf_len;
+    FILE *stream = open_memstream(&buf, &buf_len);
+
+    fputs(header, stream);
+
+    for (long i=0; i<array_len; ++i) {
+        fprintf(stream, "%s%ld%s", item_prefix, FIX2LONG(RARRAY_PTR(number_array)[i]), item_suffix);
+
+        if (i < array_len - 1) {
+            fputs(join, stream);
+        } 
+    }
+
+    fputs(footer, stream);
+
+    fclose(stream);
+
+    out = rb_str_new_cstr(buf);
+    free(buf);
+
+    return out;
+}
+
+VALUE rb_efficient_join(VALUE self, VALUE prefix, VALUE suffix, VALUE join, VALUE number_array) {
+    return _join(
+        "", "",
+        StringValueCStr(prefix),
+        StringValueCStr(suffix),
+        StringValueCStr(join),
+        number_array
+    );
+}
+
+VALUE rb_efficient_join_pg_array(VALUE self, VALUE number_array) {
+    return _join("{", "}", "", "", ",", number_array);
+}
+
+void Init_efficient_join()
+{
+    VALUE mod = rb_define_module("EfficientJoinCExt");
+
+    rb_define_method(mod, "join", rb_efficient_join, 4);
+    rb_define_method(mod, "join_pg_array", rb_efficient_join_pg_array, 1);
+}
+

data/ext/efficient_join/efficient_join.h

@@ -0,0 +1,6 @@
+#ifndef EFFICIENT_JOIN_H
+#define EFFICIENT_JOIN_H 1
+
+#include "ruby.h"
+
+#endif /* EFFICIENT_JOIN_H */

data/ext/efficient_join/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("efficient_join/efficient_join")

data/lib/efficient_join/version.rb

@@ -0,0 +1,3 @@
+module EfficientJoin
+  VERSION = "1.2.0"
+end

data/lib/efficient_join.rb

@@ -0,0 +1,10 @@
+require_relative "efficient_join/version"
+require_relative "efficient_join/efficient_join.so"
+
+module EfficientJoin
+  class Error < StandardError; end
+
+  class << self
+    include EfficientJoinCExt
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: efficient_join
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Tom Morton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rake-compiler
+  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: Very fast and memory-efficient way to join a list of ruby numbers.
+email:
+- tomm8086@googlemail.com
+executables: []
+extensions:
+- ext/efficient_join/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- efficient_join.gemspec
+- ext/efficient_join/efficient_join.c
+- ext/efficient_join/efficient_join.h
+- ext/efficient_join/extconf.rb
+- lib/efficient_join.rb
+- lib/efficient_join/version.rb
+homepage: https://github.com/tomm/efficient_join
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tomm/efficient_join
+  source_code_uri: https://github.com/tomm/efficient_join.git
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: "."
+test_files: []