symbol-fstring 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7123e21ed5c05290855b7c2e5602352722b41165d7b310c7d0bfa7d84ad48421
-  data.tar.gz: 1e7086d700e9d677f83762d4afa603a466abf294a7844398c532fd7b8dd1538c
+  metadata.gz: cfc550b2d94bcbd9fb144b2541a0bdac0591aabe7d34875f9eb7f026ee383d78
+  data.tar.gz: 04c7d8abd9e9d6eea5ccddf84cae1ab219b6bf6926380766145329648336193e
 SHA512:
-  metadata.gz: 9b097ad93b7ed268ae854038730e66606bb6da56798e04928fddb39d7393c4180efed6398b8b2f4afb8561c945d8163d84ea879d6971e36205d9205c7c40b21b
-  data.tar.gz: 9013fbf56f8f3c3c1aa6a7a45ceab36cdf83e2ba0539baefde05d27df5eecaf490ea50a2d125eb964c098908d589d797d76b17b373c0ba655d88d9cda78dd48f
+  metadata.gz: 7e9b887c028e4abdaf1a6fc08b308ae9eb05ca52b23941b6c7495484e7e9f865133629232db9d3fe48fabbd9479bce9636832c5860f963c26c9d2d75e3537a0c
+  data.tar.gz: 178aa618f95c6284115c860c5300e27a0686da90c3708a36bdfcb246ed0891ef4a5a7588b3d011d9053a60d00b5e2abfd173afd46ec6f1474105d349a4c46e5c

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/README.md

@@ -11,7 +11,9 @@ The problem with this is that `Symbol#to_s` creates a new string every time it i
 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.
+but unfortunately it got reverted, instead [Ruby 3.0 should have `Symbol#name`](https://github.com/ruby/ruby/commit/eb67c603ca7e435181684857e650b4633fda5bb6).
+
+This gem backports the `Symbol#name` method for older rubies, and optionally allow to replace `Symbol#to_s` by `Symbol#name`.
 
 ## Installation
 
@@ -33,6 +35,10 @@ Or install it yourself as:
 
 `FString` can be used in two ways. 
 
+### `Symbol.name`
+
+By default this gem backport the Ruby 3.0 `Symbol#name` method.
+
 ### `FString.patch_symbol!`
 
 If your application and your dependencies are compatible with it, you can change `Symbol#to_s` behavior globally with:
@@ -44,23 +50,16 @@ FString.patch_symbol!
 Or you can also add it this way in your Gemfile:
 
 ```ruby
-gem 'fstring', require: 'fstring/all'
+gem 'symbol-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
+  Symbol#to_s (orig)     11.748M (± 1.7%) i/s -     58.786M in   5.005571s
+ Symbol#name (patch)     18.067M (± 1.9%) i/s -     90.510M in   5.011549s
 ```
 
 But there's also a reduced pressure on the garbage collector.

data/benchmark/hash-with-indifferent-access

@@ -10,7 +10,7 @@ class PatchedHash < ActiveSupport::HashWithIndifferentAccess
   private
 
   def convert_key(key)
-    key.is_a?(Symbol) ? FString.symbol_to_s(key) : key
+    key.is_a?(Symbol) ? key.name : key
   end
 end
 

data/benchmark/symbol-to-s

@@ -5,11 +5,7 @@ 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 }
+  bench.report("Symbol#to_s (orig)") { :foo.to_s }
+  bench.report("Symbol#name (patch)") { :foo.name }
 end

data/ext/fstring/fstring.c

@@ -1,54 +1,6 @@
-#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;
-}
+#include "ruby.h"
 
 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);
+    rb_define_method(rb_cSymbol, "name", rb_sym2str, 0);
 }

data/fstring.gemspec

@@ -30,7 +30,11 @@ Gem::Specification.new do |spec|
   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']
+
+  unless Symbol.method_defined?(:name)
+    spec.extensions    = ['ext/fstring/extconf.rb']
+  end
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -40,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "benchmark-ips", "~> 2.7"
   spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rake-compiler"
 end

data/lib/fstring.rb

@@ -3,6 +3,18 @@
 require "fstring/version"
 
 module FString
-end
+  require "fstring/fstring" unless Symbol.method_defined?(:name)
+
+  class << self
+    def patch_symbol!
+      unless Symbol.method_defined?(:_original_to_s)
+        Symbol.alias_method(:_original_to_s, :to_s)
+      end
+      Symbol.alias_method(:to_s, :name)
+    end
 
-require "fstring/fstring"
+    def unpatch_symbol!
+      Symbol.alias_method(:to_s, :_original_to_s)
+    end
+  end
+end

data/lib/fstring/all.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
-require "fstring"
-FString.patch_symbol!
+if Symbol.method_defined?(:name)
+  Symbol.alias_method(:to_s, :name)
+else
+  require "fstring"
+  FString.patch_symbol!
+end

data/lib/fstring/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: symbol-fstring
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jean Boussier
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !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:
 email:
 - jean.boussier@gmail.com
 executables: []
@@ -88,8 +102,8 @@ extensions:
 - ext/fstring/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -102,7 +116,6 @@ files:
 - dev.yml
 - ext/fstring/extconf.rb
 - ext/fstring/fstring.c
-- ext/fstring/fstring.h
 - fstring.gemspec
 - lib/fstring.rb
 - lib/fstring/all.rb
@@ -115,7 +128,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -130,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Allow fast access to internal fstring of symbols and modules
 test_files: []

data/.travis.yml

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

data/ext/fstring/fstring.h

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