dedup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 021b0183f99ad0cc33215d7162fc85eab71c399c1c13fd80db913c5fa80a2667
+  data.tar.gz: a708b1ae9f1333b4efad03efedad3a292568f881ba13796619ee1b7df24f1967
+SHA512:
+  metadata.gz: 4db7a0a4be18afdd7458d06d330087f015fd05425bad1a4be0832029d6ef038066a2f0fc8128e99b5b923cdd555e2e5fb15d14b5f7cd89dc723292dca53da043
+  data.tar.gz: 5f74f2056de6d70128ce87c4a124844d677dbbe7bddd550f6f0de7554d1a495b185419797f25c0a4af250b9ad99d3a775a744ef1ffad64ac6d7b4eb0acb7f41b

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ ruby-head, 2.7, 2.6, 2.5 ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run test
+        run: rake
+      - name: Install gem
+        run: rake install

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+.byebug_history

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dedup.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rake-compiler"
+gem "minitest", "~> 5.0"
+gem "byebug"
+gem "rubocop-shopify", require: false
+gem "benchmark-ips"
+gem "stackprof"
+gem "bootsnap"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    dedup (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    benchmark-ips (2.8.2)
+    bootsnap (1.4.8)
+      msgpack (~> 1.0)
+    byebug (11.1.3)
+    minitest (5.14.2)
+    msgpack (1.3.3)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rake-compiler (1.1.1)
+      rake
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-shopify (1.0.4)
+      rubocop (>= 0.85, < 0.87)
+    ruby-progressbar (1.10.1)
+    stackprof (0.2.15)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bootsnap
+  byebug
+  dedup!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rake-compiler
+  rubocop-shopify
+  stackprof
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jean Boussier
+
+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,49 @@
+# Dedup
+
+Deep object deduplication.
+
+If your app keeps lots of static data in memory, such as i18n data or large configurations,
+this can reduce memory retention.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dedup'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dedup
+
+## Usage
+
+This library is meant to be called on large static data structures loaded during boot:
+
+```ruby
+SOME_DATA = Dedup.deep_intern!(YAML.load_file('path.yml'))
+```
+
+Keep in mind that it trades CPU during boot reduced for memory retention.
+It isn't meant to be applied on runtime data with reduced lifetime, but on
+static data loaded during boot.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/[USERNAME]/dedup.
+
+
+## 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,22 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '2.7'
+  require "rake/extensiontask"
+
+  Rake::ExtensionTask.new("dedup") do |ext|
+    ext.ext_dir = 'ext/dedup'
+    ext.lib_dir = "lib/dedup"
+  end
+
+  task default: %i(compile test)
+else
+  task default: %i(test)
+end

data/benchmark/deep_intern.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'yaml'
+require 'bootsnap'
+require 'benchmark/ips'
+require 'bundler/setup'
+require 'dedup'
+
+Bootsnap.setup(
+  cache_dir: Dir.mktmpdir,
+  development_mode: false,
+  compile_cache_yaml: true,
+  autoload_paths_cache: false,
+)
+
+YAML_PATH = ARGV.fetch(0)
+
+Benchmark.ips do |x|
+  x.time = 30
+  x.report('baseline') { YAML.load_file(YAML_PATH) }
+  x.report('ruby') { Dedup::Ruby.deep_intern!(YAML.load_file(YAML_PATH)) }
+  x.report('native') { Dedup::Native.deep_intern!(YAML.load_file(YAML_PATH)) }
+  x.compare!
+end

data/bin/console

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dedup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dedup"
+  spec.version       = Dedup::VERSION
+  spec.authors       = ["Jean Boussier"]
+  spec.email         = ["jean.boussier@gmail.com"]
+
+  spec.summary       = %q{Fast object deduplication}
+  spec.description   = %q{If your app keeps lots of static data in memory, such as i18n data or large configurations, this can reduce memory retention.}
+  spec.homepage      = "https://github.com/Shopify/dedup"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '2.7'
+    spec.platform   = Gem::Platform::RUBY
+    spec.extensions = ['ext/dedup/extconf.rb']
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/dev.yml

@@ -0,0 +1,20 @@
+name: dedup
+
+type: ruby
+
+up:
+  - ruby: 2.7.1
+  - bundler
+
+commands:
+  console:
+    desc:   'start a console'
+    run:    bin/console
+  run:
+    desc:   'start the application'
+    run:    bin/run
+  test:
+    syntax:
+      argument: file
+      optional: args...
+    run: bin/testunit

data/ext/dedup/dedup.c

@@ -0,0 +1,111 @@
+#include <ruby.h>
+#include <ruby/st.h>
+#include <stdbool.h>
+
+#define RHASH_AR_TABLE_MAX_SIZE SIZEOF_VALUE
+
+static ID id_uminus;
+static VALUE empty_array, empty_hash;
+
+static VALUE deep_intern(VALUE);
+
+typedef struct {
+    bool changed;
+    long index;
+    VALUE *pairs;
+} hash_iter_arg;
+
+int
+dedup_hash_iter_callback(VALUE key, VALUE value, VALUE arg)
+{
+    hash_iter_arg *iter_arg = (hash_iter_arg *)arg;
+
+    VALUE new_key = deep_intern(key);
+    iter_arg->pairs[iter_arg->index] = new_key;
+    iter_arg->index++;
+    iter_arg->changed |= new_key != key;
+
+    VALUE new_value = deep_intern(value);
+    iter_arg->pairs[iter_arg->index] = new_value;
+    iter_arg->index++;
+    iter_arg->changed |= new_value != value;
+
+    return ST_CONTINUE;
+}
+
+static VALUE
+deep_intern(VALUE data)
+{
+    if (RB_SPECIAL_CONST_P(data)) {
+        return data;
+    }
+
+    int type = BUILTIN_TYPE(data);
+
+    if (RB_OBJ_FROZEN(data) && (type != T_STRING || FL_TEST(data, RSTRING_FSTR))) {
+        return data;
+    }
+
+    switch (type) {
+      case T_STRING:
+        return rb_funcall(rb_str_freeze(data), id_uminus, 0);
+        break;
+      case T_HASH:
+        {
+            long size = RHASH_SIZE(data);
+            if (size == 0) {
+                return empty_hash;
+            }
+
+            hash_iter_arg arg;
+            arg.changed = false;
+            arg.index = 0;
+            arg.pairs = alloca(sizeof(VALUE) * 2 * size);
+            rb_hash_foreach(data, dedup_hash_iter_callback, (VALUE)&arg);
+            if (arg.changed) {
+                rb_hash_clear(data);
+                rb_hash_bulk_insert(arg.index, arg.pairs, data);
+            }
+
+            rb_obj_freeze(data);
+        }
+        break;
+      case T_ARRAY:
+        {
+            long size = RARRAY_LEN(data);
+            if (size == 0) {
+                return empty_array;
+            }
+            for (long index = 0; index < size; index++) {
+                RARRAY_ASET(data, index, deep_intern(RARRAY_AREF(data, index)));
+            }
+            rb_obj_freeze(data);
+        }
+        break;
+      default:
+        rb_obj_freeze(data);
+    }
+    return data;
+}
+
+static VALUE
+dedup_deep_intern_bang(VALUE self, VALUE data)
+{
+
+    return deep_intern(data);
+}
+
+void
+Init_dedup()
+{
+    id_uminus = rb_intern("-@");
+
+    VALUE rb_mDedup = rb_const_get(rb_cObject, rb_intern("Dedup"));
+    empty_hash = rb_const_get(rb_mDedup, rb_intern("EMPTY_HASH"));
+    rb_global_variable(&empty_hash);
+    empty_array = rb_const_get(rb_mDedup, rb_intern("EMPTY_ARRAY"));
+    rb_global_variable(&empty_array);
+
+    VALUE rb_mNative = rb_define_module_under(rb_mDedup, "Native");
+    rb_define_method(rb_mNative, "deep_intern!", dedup_deep_intern_bang, 1);
+}

data/ext/dedup/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+$CFLAGS = "-O3 -Wall"
+
+create_makefile('dedup/dedup')

data/lib/dedup.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "dedup/version"
+
+module Dedup
+  EMPTY_HASH = {}.freeze
+  EMPTY_ARRAY = [].freeze
+  class Error < StandardError; end
+
+  module Ruby
+    extend self
+
+    if DEDUP_FROZEN_STRINGS
+      def deep_intern!(data)
+        case data
+        when Hash
+          return EMPTY_HASH if data.empty?
+          return data if data.frozen?
+
+          data.transform_keys! { |k| deep_intern!(k) }
+          data.transform_values! { |v| deep_intern!(v) }
+          data.freeze
+        when Array
+          return EMPTY_ARRAY if data.empty?
+          return data if data.frozen?
+
+          data.map! { |d| deep_intern!(d) }.freeze
+        when String
+          -data.freeze
+        else
+          data.freeze
+        end
+      end
+    else
+      def deep_intern!(data)
+        case data
+        when Hash
+          return data if data.frozen?
+
+          data.transform_keys! { |k| deep_intern!(k) }
+          data.transform_values! { |v| deep_intern!(v) }
+          data.freeze
+        when Array
+          return data if data.frozen?
+
+          data.map! { |d| deep_intern!(d) }.freeze
+        when String
+          -(+data)
+        else
+          data.freeze
+        end
+      end
+    end
+  end
+end
+
+begin
+  require "dedup/dedup"
+  Dedup::Native.extend(Dedup::Native)
+  Dedup.extend(Dedup::Native)
+rescue LoadError
+  Dedup.extend(Dedup::Ruby)
+end

data/lib/dedup/version.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Dedup
+  VERSION = "0.1.0"
+
+  DEDUP_FROZEN_STRINGS = begin
+    rand_string = rand.to_s
+    (-rand_string.freeze).equal?(-(+rand_string))
+  end
+
+  DEDUP_HASH_ASET = begin
+    h = {}
+    x = {}
+    r = rand.to_s
+    h[%W(#{r}).join('')] = 1
+    x[%W(#{r}).join('')] = 1
+    x.keys[0].equal?(h.keys[0])
+  end
+
+  DEDUP_HASH_ASET_FROZEN = begin
+    h = {}
+    x = {}
+    r = rand.to_s
+    h[%W(#{r}).join('').freeze] = 1
+    x[%W(#{r}).join('').freeze] = 1
+    x.keys[0].equal?(h.keys[0])
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: dedup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-08 00:00:00.000000000 Z
+dependencies: []
+description: If your app keeps lots of static data in memory, such as i18n data or
+  large configurations, this can reduce memory retention.
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/deep_intern.rb
+- bin/console
+- bin/setup
+- dedup.gemspec
+- dev.yml
+- ext/dedup/dedup.c
+- ext/dedup/extconf.rb
+- lib/dedup.rb
+- lib/dedup/version.rb
+homepage: https://github.com/Shopify/dedup
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/dedup
+  source_code_uri: https://github.com/Shopify/dedup
+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.0.2
+signing_key:
+specification_version: 4
+summary: Fast object deduplication
+test_files: []