curl_escape 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e245dcbc587665d607975ad25ca806804c28458
+  data.tar.gz: 88e34847057a483229fef9a6887d2065ebc8ef69
+SHA512:
+  metadata.gz: 414c3cca07d563b8bf429692080f4b5c2b89e3810e2a8bb47c44964400777ec7f64a73c42729f1ce777d364ac87442022d079a9f9b6a68fe5973f9a875e7585f
+  data.tar.gz: 7b503b475257be37c14fe80daf5f0615f0f6bca774dfbb61d70f34ede40605f0dbbc95ad6eb52c5eef2c252f290d0dd828a4b2c7acf7b30ca647571362cc0c33

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Makefile
+mkmf.log
+*.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,118 @@
+# CurlEscape
+[![Build Status](https://travis-ci.org/joker1007/curl_escape.svg?branch=master)](https://travis-ci.org/joker1007/curl_escape)
+
+Fast URL escape by libcurl.
+
+`CurlEscape.escape` is 5x faster or more than `CGI.escape`.
+
+The spec of escaping is `CGI.escape` compatible, and this gem has core extension for `CGI.escape`.
+
+## Motivation
+`CGI.escape` is used by `#to_query` method that is defined by activesupport.
+
+And `#to_query` is used by `url_for` helper of Rails.
+
+I want to speed up `url_for`.
+
+## Benchmark
+
+```ruby
+require 'benchmark/ips'
+require 'cgi'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require_relative './lib/curl_escape'
+
+Benchmark.ips do |x|
+  x.config(time: 15, warmup: 5)
+  x.report("cgi_escape") { CGI.escape("'Stop!' said Fred") }
+  x.report("curl_escape") { CurlEscape.escape("'Stop!' said Fred") }
+  x.compare!
+end
+```
+
+```
+Calculating -------------------------------------
+          cgi_escape    13.791k i/100ms
+         curl_escape    52.251k i/100ms
+-------------------------------------------------
+          cgi_escape    130.471k (±17.8%) i/s -      1.889M
+         curl_escape    832.501k (± 5.6%) i/s -     12.488M
+
+Comparison:
+         curl_escape:   832501.4 i/s
+          cgi_escape:   130470.6 i/s - 6.38x slower
+```
+
+### `url_for` benchmark
+```
+irb(main):005:0> app.dashboard_app_path("hogehoge", {foo: "bar", hoge: "aa", aaa: "aaa", bbb: "bbb", hogehoge: "%&[12]"})
+=> "/apps/hogehoge/dashboard?aaa=aaa&bbb=bbb&foo=bar&hoge=aa&hogehoge=%25%26%5B12%5D"
+irb(main):006:0> Benchmark.ips do |x|
+irb(main):007:1*   x.config(time: 15, warmup: 5)
+irb(main):008:1>   x.report("url_for") { app.dashboard_app_path("hogehoge", {foo: "bar", hoge: "aa", aaa: "aaa", bbb: "bbb", hogehoge: "%&[12]"}) }
+irb(main):009:1> end
+Calculating -------------------------------------
+             url_for   922.000  i/100ms
+-------------------------------------------------
+             url_for      9.038k (±19.5%) i/s -    129.080k
+=> #<Benchmark::IPS::Report:0x007fe017c73a68 @entries=[#<Benchmark::IPS::Report::Entry:0x007fe01b53b9b8 @label="url_for", @microseconds=15008895.1587677, @iterations=129080, @ips=9037.936272156061, @ips_sd=1764, @measurement_cycle=922, @show_total_time=false>], @data=nil>
+irb(main):010:0> require 'curl_escape/core_ext/cgi'
+=> true
+irb(main):011:0> app.dashboard_app_path("hogehoge", {foo: "bar", hoge: "aa", aaa: "aaa", bbb: "bbb", hogehoge: "%&[12]"})
+=> "/apps/hogehoge/dashboard?aaa=aaa&bbb=bbb&foo=bar&hoge=aa&hogehoge=%25%26%5B12%5D"
+irb(main):012:0>
+irb(main):013:0* Benchmark.ips do |x|
+irb(main):014:1*   x.config(time: 15, warmup: 5)
+irb(main):015:1>   x.report("url_for") { app.dashboard_app_path("hogehoge", {foo: "bar", hoge: "aa", aaa: "aaa", bbb: "bbb", hogehoge: "%&[12]"}) }
+irb(main):016:1> end
+Calculating -------------------------------------
+             url_for     1.192k i/100ms
+-------------------------------------------------
+             url_for     12.170k (±14.2%) i/s -    177.608k
+=> #<Benchmark::IPS::Report:0x007fe01b4c8da0 @entries=[#<Benchmark::IPS::Report::Entry:0x007fe015863560 @label="url_for", @microseconds=15003959.655761719, @iterations=177608, @ips=12170.236970422775, @ips_sd=1723, @measurement_cycle=1192, @show_total_time=false>], @data=nil>
+```
+
+about 34% faster.
+
+But the fewer parameters, the less difference.
+
+## Requirements
+- curl
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'curl_escape'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install curl_escape
+
+## Usage
+
+```ruby
+CurlEscape.escape('Escape target string % あいうえお')
+# => "Escape+target+string+%25+%E3%81%82%E3%81%84%E3%81%86%E3%81%88%E3%81%8A"
+
+require 'curl_escape/core_ext/cgi'
+CGI.escape('Escape target string % あいうえお') # replace implementation
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/joker1007/curl_escape.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rspec/core/rake_task"
+
+Rake::ExtensionTask.new('curl_escape') do |ext|
+  ext.lib_dir = 'lib/curl_escape'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:compile, :spec]

data/bench.rb

@@ -0,0 +1,18 @@
+require 'benchmark/ips'
+require 'cgi'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require_relative './lib/curl_escape'
+
+Benchmark.ips do |x|
+  x.config(time: 15, warmup: 5)
+  x.report("cgi_escape") { CGI.escape("'Stop!' said Fred") }
+  x.report("curl_escape") { CurlEscape.escape("'Stop!' said Fred") }
+  x.compare!
+end
+
+p CGI.escape("'Stop!' said~Fred foo~~hoge")
+p CurlEscape.escape("'Stop!' said~Fred foo~~hoge")
+
+p CGI.escape("'日本語あいうえお")
+p CurlEscape.escape("'日本語あいうえお")

data/bin/console

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

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/curl_escape.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'curl_escape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "curl_escape"
+  spec.version       = CurlEscape::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Fast url escaping by libcurl}
+  spec.description   = %q{Fast url escaping by libcurl}
+  spec.homepage      = "https://github.com/joker1007/curl_escape"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/curl_escape/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/ext/curl_escape/curl_escape.c

@@ -0,0 +1,44 @@
+#include <string.h>
+#include <curl/curl.h>
+#include <ruby.h>
+
+VALUE ruby_curl_escape(VALUE self, VALUE str) {
+  int rest, cnt;
+  VALUE output;
+
+  static CURL *curl;
+  if (!curl) {
+    curl = curl_easy_init();
+  }
+
+  char *cStr = StringValueCStr(str);
+  char *cOutput = curl_easy_escape(curl, cStr, strlen(cStr));
+
+  if (cOutput) {
+    for (cnt = 0; *(cOutput + cnt) != '\0'; cnt++) {
+      if (strncmp(cOutput + cnt, "%20", 3) == 0) {
+        *(cOutput + cnt) = '+';
+        rest = strlen(cOutput + cnt + 3);
+        memmove(cOutput + cnt + 1, cOutput + cnt + 3, rest);
+        *(cOutput + cnt + 1 + rest) = '\0';
+      } else if (*(cOutput + cnt) == '~') {
+        cOutput = realloc(cOutput, strlen(cOutput) + 2);
+        rest = strlen(cOutput + cnt + 1);
+        memmove(cOutput + cnt + 3, cOutput + cnt + 1, rest);
+        *(cOutput + cnt + 3 + rest) = '\0';
+        memcpy(cOutput + cnt, "%7E", 3);
+      }
+    }
+
+    output = rb_str_new2(cOutput);
+    curl_free(cOutput);
+    return output;
+  } else {
+    return Qnil;
+  }
+}
+
+void Init_curl_escape(void) {
+  VALUE module = rb_define_module("CurlEscape");
+  rb_define_singleton_method(module, "escape", ruby_curl_escape, 1);
+}

data/ext/curl_escape/extconf.rb

@@ -0,0 +1,11 @@
+require 'mkmf'
+
+$CFLAGS << ' -Wall'
+
+dir_config('curl').any? || pkg_config('libcurl')
+
+if have_header('curl/curl.h') && have_library('curl', 'curl_easy_init')
+  create_makefile 'curl_escape/curl_escape'
+else
+  abort 'libcurl is not found'
+end

data/lib/curl_escape.rb

@@ -0,0 +1,2 @@
+require "curl_escape/version"
+require 'curl_escape/curl_escape'

data/lib/curl_escape/core_ext/cgi.rb

@@ -0,0 +1,10 @@
+require 'cgi'
+require 'curl_escape/curl_escape'
+
+module CGI::Util
+  alias :origin_escape :escape
+
+  def escape(string)
+    CurlEscape.escape(string)
+  end
+end

data/lib/curl_escape/version.rb

@@ -0,0 +1,3 @@
+module CurlEscape
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: curl_escape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Fast url escaping by libcurl
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions:
+- ext/curl_escape/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bench.rb
+- bin/console
+- bin/setup
+- curl_escape.gemspec
+- ext/curl_escape/curl_escape.c
+- ext/curl_escape/extconf.rb
+- lib/curl_escape.rb
+- lib/curl_escape/core_ext/cgi.rb
+- lib/curl_escape/version.rb
+homepage: https://github.com/joker1007/curl_escape
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Fast url escaping by libcurl
+test_files: []