autocorrect-rb 2.5.6.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cce0a1e0dd62d0ef9a97657984677104995e639e5a2c7768723d618ba489fde9
+  data.tar.gz: 4c64a5b4b47da9cd0f057352cace7f978270552446c0a670a9ac18acfe88d5be
+SHA512:
+  metadata.gz: 6bfbdd16fcf9edb4948bf90f55eacdd19825c72520a1bb9707220100c8a64539e78acd049eea0468018cf3a0d5933155dafdb49d519cb03dd7c7b6f678f58e41
+  data.tar.gz: a288c7a90aa65672f28ee3aab3b047d760f969fe223607940cc99a269744c80eeabb294de9a63d2941b44a21982e302ace227405878c49c27759e354b7e041be

data/README.md

@@ -0,0 +1,125 @@
+# AutoCorrect for Ruby
+
+<a href="https://rubygems.org/gems/autocorrect-rb"><img src="https://img.shields.io/gem/v/autocorrect-rb?color=1&label=Gem" alt="Gem Version"></a>
+
+The Native Ruby version of [AutoCorrect](https://github.com/huacnlee/autocorrect).
+
+- Rust - [autocorrect](https://github.com/huacnlee/autocorrect)
+- Ruby - [autocorrect-rb](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-rb)
+- Go - [autocorrect-go](https://github.com/longbridgeapp/autocorrect)
+- Python - [autocorrect-py](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-py)
+- Node.js - [autocorrect-node](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-node)
+- JavaScript (Browser) - [autocorrect-wasm](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-wasm)
+- Java - [autocorrect-java](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-java)
+
+## Installation
+
+```bash
+$ bundle add autocorrect-rb
+```
+
+## Usage
+
+```rb
+require('autocorrect-rb')
+
+out = AutoCorrect.format('Hello你好.')
+puts out
+# Hello 你好。
+
+out = AutoCorrect.format_for("title = 'Hello你好。'", 'rb')
+puts out
+# title = 'Hello 你好。'
+
+result = AutoCorrect.lint_for("title = 'Hello你好。'", 'rb')
+puts result
+# {
+#   filepath: 'rb',
+#   lines: [
+#     { l: 1, c: 13, new: "'Hello 你好。'", old: "'Hello你好。'", severity: 1 }
+#   ],
+#   error: ''
+# }
+
+config_str = %({ textRules: { "你好hello": 0 } })
+AutoCorrect.load_config(config_str)
+out = AutoCorrect.format('Hello你好.')
+puts out
+# Hello 你好。
+out = AutoCorrect.format('你好hello')
+puts out
+# 你好hello
+
+# Ignorer, if /path/to/workdir contains .autocorrectignore or .gitignore
+ignorer = AutoCorrect::Ignorer.new("/path/to/")
+ignorer.ignored?("README.md")
+```
+
+## Benchmarks
+
+🎊 Rust version is ~3.5x faster than the Ruby (pure) version.
+
+> NOTE: In this case Rust version has more complex rules.
+
+### Rust version
+
+```bash
+Warming up --------------------------------------
+     format 50 chars    11.348k i/100ms
+    format 100 chars     6.033k i/100ms
+    format 400 chars     1.772k i/100ms
+         format_html   545.000  i/100ms
+Calculating -------------------------------------
+     format 50 chars    111.904k (± 3.1%) i/s -    567.400k in   5.075674s
+    format 100 chars     58.684k (± 2.1%) i/s -    295.617k in   5.039837s
+    format 400 chars     17.266k (± 2.9%) i/s -     86.828k in   5.033234s
+         format_html      5.448k (± 1.5%) i/s -     27.250k in   5.002853s
+```
+
+```
+1000 ms / 111904 i/s = 0.008 ms
+```
+
+### Pure [Ruby version](https://rubygems.org/gems/auto-correct/versions/1.0.0) result:
+
+```bash
+Warming up --------------------------------------
+     format 50 chars     3.167k i/100ms
+    format 100 chars     1.588k i/100ms
+    format 400 chars   496.000  i/100ms
+         format_html   166.000  i/100ms
+Calculating -------------------------------------
+     format 50 chars     31.589k (± 2.5%) i/s -    158.350k in   5.016131s
+    format 100 chars     16.122k (± 1.2%) i/s -     80.988k in   5.024082s
+    format 400 chars      4.946k (± 2.6%) i/s -     24.800k in   5.017711s
+         format_html      1.659k (± 1.7%) i/s -      8.300k in   5.003164s
+```
+
+### Rust version VS Purge Ruby Version
+
+| Test Case   | Duration (Rust) | Duration (Pure Ruby) | Speedup |
+| ----------- | --------------- | -------------------- | ------- |
+| Foramt 50   | 0.008ms         | 0.031ms              | ~3.8x   |
+| Format 100  | 0.017ms         | 0.062ms              | ~3.6x   |
+| Format 400  | 0.052ms         | 0.2ms                | ~3.8x   |
+| Format HTML | 0.183ms         | 0.67ms               | ~3.6x   |
+
+> 🎈 Rust version about 3.5 ~ 3.8x fast then Ruby (pure version).
+> 
+> By this result, we can see the Ruby version is also fast, but the Rust version is more better.
+
+## Know issues
+
+Bundler install error:
+
+```
+Could not find gem 'autocorrect-rb' with platform 'ruby' in rubygems repository https://rubygems.org/ or installed locally.
+```
+
+To fix this you can run:
+
+```bash
+$ bundle lock --remove-platform ruby
+```
+
+Because of autocorrect-rb not release the gem for `platform: ruby`, but your `Gemfile.lock` specialed that. This command will remove `ruby` platform from your `Gemfile.lock`

data/Rakefile

@@ -0,0 +1,97 @@
+# autocorrect: false
+require "rubygems"
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "bundler/gem_tasks"
+require "rubygems/package_task"
+require "rake/testtask"
+require "rake/extensiontask"
+require "bundler"
+
+CROSS_PLATFORMS = %w[
+  aarch64-linux
+  arm64-darwin
+  x64-mingw32
+  x86_64-darwin
+  x86_64-linux
+]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+spec = Bundler.load_gemspec("autocorrect-rb.gemspec")
+
+# Make a autocorrect-rb-0.0.0.gem
+# Disable release gem for platform: ruby, because autocorrect rust source build is complex.
+# Gem::PackageTask.new(spec).define
+
+# Make a native gem, eg. autocorrect-rb-0.0.0-x86_64-linux.gem
+Rake::ExtensionTask.new("autocorrect", spec) do |ext|
+  # Compile output autocorrect.so into lib/autocorrect/autocorrect.so
+  ext.lib_dir = "lib/autocorrect"
+  ext.source_pattern = "*.{rs,toml}"
+  ext.cross_compile = true
+  ext.cross_platform = CROSS_PLATFORMS
+end
+
+task :bench do
+  require "benchmark/ips"
+  require "./lib/autocorrect-rb"
+
+  html = open("./test/fixtures/example.txt").read
+
+  Benchmark.ips do |x|
+    x.report("format 50 chars") do |n|
+      n.times do
+        AutoCorrect.format("【野村：重申吉利汽车(00175)“买入”评级 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称")
+      end
+    end
+    x.report("format 100 chars") do |n|
+      n.times do
+        AutoCorrect.format("【野村：重申吉利汽车(00175)“买入”评级 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称，【野村：重申吉利汽车(00175)“买入”评�� 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称")
+      end
+    end
+    x.report("format 400 chars") do |n|
+      n.times do
+        AutoCorrect.format("【野村：重申吉利汽车(00175)“买入”评级 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称，上调吉利汽车(00175)目标价12.58%，由15.9港元升至17.9港元，并维持吉汽为行业首选股，重申对其“买入”评级，坚信吉汽长远可成为行业赢家。 该行称，随着公司销量持续复苏及产品组合改善，预计今年销量可达148万辆，同比升9%，较公司原定目标销量141万辆为高。 该行又称称，上调公司今明两年每股盈利预测各13%及升毛利率0.1个百分点，以反映销量较预期高2%及产品组合改善，主要是由领克品牌带动。公司自去年8月开始已持续投资领克品牌及进行市场推广，带动领克销量环比有所改变，��期今明两年领克将占整体销量的11%及14%。 该行表示，由于低端国产车品牌在欠缺新车款及科技下，行业整合度将提升。另外，公司从去年第二季到12月为止，一��都积极推动经销商去库存，这将有利公司今年利润率复苏。")
+      end
+    end
+
+    x.report("format_html") do |n|
+      n.times do
+        AutoCorrect.format_for(html, "text.html")
+      end
+    end
+  end
+end
+
+task :memory do
+  require "memory_profiler"
+  require "./lib/autocorrect-rb"
+
+  html = open("./test/fixtures/example.txt").read
+
+  report = MemoryProfiler.report do
+    20_000.times do
+      AutoCorrect.format("【野村：重申吉利汽车(00175)“买入”评级 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称，【野村：重申吉利汽车(00175)“买入”评�� 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称")
+      AutoCorrect.format_for(html, "text.html")
+    end
+  end
+
+  GC.start
+  report.pretty_print
+
+  puts "------------------------- Result Guide -------------------------"
+  puts "If [Total retained] have any bytes, there will have memory leak."
+end
+
+task test: :compile
+task default: %i[test]