symbol-fstring 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7123e21ed5c05290855b7c2e5602352722b41165d7b310c7d0bfa7d84ad48421
+  data.tar.gz: 1e7086d700e9d677f83762d4afa603a466abf294a7844398c532fd7b8dd1538c
+SHA512:
+  metadata.gz: 9b097ad93b7ed268ae854038730e66606bb6da56798e04928fddb39d7393c4180efed6398b8b2f4afb8561c945d8163d84ea879d6971e36205d9205c7c40b21b
+  data.tar.gz: 9013fbf56f8f3c3c1aa6a7a45ceab36cdf83e2ba0539baefde05d27df5eecaf490ea50a2d125eb964c098908d589d797d76b17b373c0ba655d88d9cda78dd48f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,80 @@
+# symbol-fstring
+
+`symbol-fstring` is a Ruby extension that provide access to symbols internal string representations.
+
+## Why?
+
+In Ruby many APIs tend to accept symbols, but regularly convert them to string internally. The typical example is
+`ActiveSupport::HashWithIndifferentAccess`, but there are plenty more.
+
+The problem with this is that `Symbol#to_s` creates a new string every time it is invoked, and since it often happens
+in hotspots, it causes a lot of work for the garbage collector, and cause many identical strings to be kept in memory.
+
+There was [an attempt to make `Symbol#to_s` return it's internal fstring for Ruby 2.7](https://bugs.ruby-lang.org/issues/16150),
+but unfortunately it got reverted, and probably won't happen before a while.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'symbol-fstring'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install symbol-fstring
+
+## Usage
+
+`FString` can be used in two ways. 
+
+### `FString.patch_symbol!`
+
+If your application and your dependencies are compatible with it, you can change `Symbol#to_s` behavior globally with:
+
+```ruby
+FString.patch_symbol!
+```
+
+Or you can also add it this way in your Gemfile:
+
+```ruby
+gem 'fstring', require: 'fstring/all'
+```
+
+### `FString.to_s`
+
+If you don't want to patch the core `Symbol` class, you can alternatively substitute `some_symbol.to_s` for
+`FString.to_s(some_symbol)` in your own code.
+
+### Benchmark
+
+From `benchmark/symbol-to_s`
+
+```
+ Symbol#to_s (orig)     12.786M (± 1.5%) i/s -     64.032M in   5.009020s
+FString#symbol_to_s     20.371M (± 1.7%) i/s -    101.981M in   5.007706s
+       FString#to_s     19.086M (± 1.5%) i/s -     95.410M in   5.000016s
+Symbol#to_s (patch)     21.669M (± 1.9%) i/s -    108.591M in   5.013331s
+```
+
+But there's also a reduced pressure on the garbage collector.
+
+## 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/Shopify/symbol-fstring.
+
+## 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,18 @@
+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
+
+task :default => [:build, :test]
+
+require 'rake/extensiontask'
+GEMSPEC = eval(File.read('fstring.gemspec'))
+Rake::ExtensionTask.new('fstring', GEMSPEC) do |ext|
+  ext.ext_dir = 'ext/fstring'
+  ext.lib_dir = 'lib/fstring'
+end
+task build: :compile

data/benchmark/hash-with-indifferent-access

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require "fstring"
+require "active_support/hash_with_indifferent_access"
+require 'benchmark/ips'
+
+class PatchedHash < ActiveSupport::HashWithIndifferentAccess
+  private
+
+  def convert_key(key)
+    key.is_a?(Symbol) ? FString.symbol_to_s(key) : key
+  end
+end
+
+BASE = ActiveSupport::HashWithIndifferentAccess.new(foo: 42)
+PATCHED = PatchedHash.new(foo: 42)
+
+Benchmark.ips do |bench|
+  bench.report("HWIA#[:foo]") { BASE[:foo] }
+  bench.report("PatchedHash#[:foo]") { PATCHED[:foo] }
+end

data/benchmark/symbol-to-s

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require "fstring"
+require 'benchmark/ips'
+
+FString.patch_symbol!
+
+Benchmark.ips do |bench|
+  bench.report("Symbol#to_s (orig)") { :foo.id2name }
+  bench.report("FString#symbol_to_s") { FString.symbol_to_s(:foo) }
+  bench.report("FString#to_s") { FString.to_s(:foo) }
+  bench.report("Symbol#to_s (patch)") { :foo.to_s }
+end

data/bin/console

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

@@ -0,0 +1,22 @@
+name: fstring
+
+type: ruby
+
+up:
+  - homebrew:
+    - openssl
+  - ruby: 2.6.3
+  - 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/fstring/extconf.rb

@@ -0,0 +1,10 @@
+require 'mkmf'
+
+$CFLAGS = "-D_GNU_SOURCE -Werror -Wall "
+if ENV.key?('DEBUG')
+  $CFLAGS << "-O0 -g -DDEBUG"
+else
+  $CFLAGS << "-O3"
+end
+
+create_makefile('fstring/fstring')

data/ext/fstring/fstring.c

@@ -0,0 +1,54 @@
+#include "fstring.h"
+
+VALUE
+rb_symbol_to_fstring(VALUE symbol)
+{
+    return rb_sym2str(symbol);
+}
+
+VALUE
+rb_fstring_to_s(VALUE rb_mFString, VALUE object)
+{
+    if (RB_TYPE_P(object, T_SYMBOL)) {
+        return rb_sym2str(object);
+    } else {
+        return rb_funcall(object, rb_intern("to_s"), 0);
+    }
+}
+
+VALUE
+rb_fstring_symbol_to_s(VALUE rb_mFString, VALUE symbol)
+{
+    return rb_sym2str(symbol);
+}
+
+VALUE
+rb_fstring_patch_symbol(VALUE rb_mFString)
+{
+    VALUE rb_cSymbol;
+    rb_cSymbol = rb_const_get(rb_cObject, rb_intern("Symbol"));
+    rb_undef(rb_cSymbol, rb_intern("to_s"));
+    rb_define_method(rb_cSymbol, "to_s", rb_symbol_to_fstring, 0);
+    return Qnil;
+}
+
+VALUE
+rb_fstring_unpatch_symbol(VALUE rb_mFString)
+{
+    VALUE rb_cSymbol;
+    rb_cSymbol = rb_const_get(rb_cObject, rb_intern("Symbol"));
+    rb_undef(rb_cSymbol, rb_intern("to_s"));
+    rb_define_method(rb_cSymbol, "to_s", rb_sym_to_s, 0);
+    return Qnil;
+}
+
+void Init_fstring()
+{
+    VALUE rb_mFString;
+
+    rb_mFString = rb_const_get(rb_cObject, rb_intern("FString"));
+    rb_define_singleton_method(rb_mFString, "symbol_to_s", rb_fstring_symbol_to_s, 1);
+    rb_define_singleton_method(rb_mFString, "to_s", rb_fstring_to_s, 1);
+    rb_define_singleton_method(rb_mFString, "patch_symbol!", rb_fstring_patch_symbol, 0);
+    rb_define_singleton_method(rb_mFString, "unpatch_symbol!", rb_fstring_unpatch_symbol, 0);
+}

data/ext/fstring/fstring.h

@@ -0,0 +1,9 @@
+#ifndef FSTRING_H
+#define FSTRING_H
+
+#include "ruby.h"
+#include "ruby/intern.h"
+
+void Init_fstring();
+
+#endif //FSTRING_H

data/fstring.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fstring/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "symbol-fstring"
+  spec.version       = FString::VERSION
+  spec.authors       = ["Jean Boussier"]
+  spec.email         = ["jean.boussier@gmail.com"]
+
+  spec.summary       = %q{Allow fast access to internal fstring of symbols and modules}
+  spec.homepage      = "https://github.com/Shopify/symbol-fstring"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.extensions    = ['ext/fstring/extconf.rb']
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "benchmark-ips", "~> 2.7"
+  spec.add_development_dependency "activesupport"
+end

data/lib/fstring.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "fstring/version"
+
+module FString
+end
+
+require "fstring/fstring"

data/lib/fstring/all.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "fstring"
+FString.patch_symbol!

data/lib/fstring/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FString
+  VERSION = "0.1.0"
+end

data/lib/symbol-fstring.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "fstring"

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: symbol-fstring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-05 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions:
+- ext/fstring/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/hash-with-indifferent-access
+- benchmark/symbol-to-s
+- bin/console
+- bin/setup
+- dev.yml
+- ext/fstring/extconf.rb
+- ext/fstring/fstring.c
+- ext/fstring/fstring.h
+- fstring.gemspec
+- lib/fstring.rb
+- lib/fstring/all.rb
+- lib/fstring/version.rb
+- lib/symbol-fstring.rb
+homepage: https://github.com/Shopify/symbol-fstring
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/symbol-fstring
+  source_code_uri: https://github.com/Shopify/symbol-fstring
+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.3
+signing_key: 
+specification_version: 4
+summary: Allow fast access to internal fstring of symbols and modules
+test_files: []