autocorrect-rb 2.4.0-x86_64-darwin → 2.5.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c806da49ac6704ff6f3f2797fcef27a1785d5848219678b94d77404a23f740a2
-  data.tar.gz: 519bd8bd246152a9630fb0cd9c02fa24dc127693a2e56e80adc21487d13f4aed
+  metadata.gz: 1b06e91fbac00e95102d1a0a8a8fd139c0aab35820d82428c3026da3cf4f0683
+  data.tar.gz: a2e74c4c6f6d3532505c644e4d262b9899f53ffcc77bdac6d55e9177df8ecbc3
 SHA512:
-  metadata.gz: 8cbe826e811572d67d6add61124d718af618f1fe3b1f9a49f395469e227a9aef19d096f2be307a735bda8d6bea613ac91b15cc264697012e4e4a68e87193320c
-  data.tar.gz: fd25943924da227f6f99ea90cd6a391eae76cf62d0c9b8c63d83e527f7cc962c6a78ea1094456cb883566bb125b31ee5f26c8a42a2835d5ee65cef5c3c3a6eef
+  metadata.gz: e32c4eeb1f5e307a7c62cb2ca2a611209386af5ba2d0a9457f0b303a524723efdaebe04ae1701e93856ae516d129e125692a33d05066979a2cc42f38ca947cf5
+  data.tar.gz: 819f18584c78867dafa9338d5ff9d8a8faf09b380d3adda87dfbac3fedfdea2a713312ba7a5d5a277c41f64759fc9da20ac0ef4d25608a5990c2b1c5bf52e578

data/README.md

@@ -1,5 +1,7 @@
 # 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)
@@ -38,11 +40,24 @@ puts result
 #   ],
 #   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 3x faster than the Ruby (pure) version.
+🎊 Rust version is ~3.5x faster than the Ruby (pure) version.
 
 > NOTE: In this case Rust version has more complex rules.
 
@@ -61,6 +76,10 @@ Calculating -------------------------------------
          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
@@ -76,6 +95,19 @@ Calculating -------------------------------------
          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:

data/Rakefile

@@ -55,12 +55,12 @@ task :bench do
     end
     x.report("format 100 chars") do |n|
       n.times do
-        AutoCorrect.format("【野村：重申吉利汽车(00175)“买入”评级 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称，【野村：重申吉利汽车(00175)“买入”评级 上调目标价至17.9港元】智通财经APP获悉，野村发布报告称")
+        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月为止，一直都积极推动经销商去库存，这将有利公司今年利润率复苏。")
+        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
 
@@ -72,5 +72,25 @@ task :bench do
   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]

data/ext/autocorrect/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "autocorrect-rb"
-version = "2.4.0"
+version = "2.5.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]

data/ext/autocorrect/src/lib.rs

@@ -1,4 +1,4 @@
-use magnus::{define_class, function, Error, Object};
+use magnus::{define_class, function, method, Error, Module, Object};
 
 #[derive(Debug, Clone)]
 pub struct LineResult {
@@ -84,6 +84,23 @@ impl LintResult {
     }
 }
 
+#[magnus::wrap(class = "AutoCorrect::Ignorer")]
+pub struct Ignorer {
+    core: autocorrect::ignorer::Ignorer,
+}
+
+impl Ignorer {
+    pub fn new(work_dir: String) -> Self {
+        Ignorer {
+            core: autocorrect::ignorer::Ignorer::new(&work_dir),
+        }
+    }
+
+    fn is_ignored(&self, path: String) -> bool {
+        self.core.is_ignored(&path)
+    }
+}
+
 pub fn format(input: String) -> String {
     autocorrect::format(&input)
 }
@@ -105,7 +122,7 @@ pub fn lint_for(input: String, filename_or_ext: String) -> magnus::RHash {
                 col: l.col,
                 new: l.new.clone(),
                 old: l.old.clone(),
-                severity: l.severity.clone() as usize,
+                severity: l.severity as usize,
             })
             .collect::<_>(),
         error: result.error,
@@ -114,12 +131,21 @@ pub fn lint_for(input: String, filename_or_ext: String) -> magnus::RHash {
     .unwrap()
 }
 
+pub fn load_config(config_str: String) {
+    autocorrect::config::load(&config_str).unwrap();
+}
+
 #[magnus::init(name = "autocorrect")]
 fn init() -> Result<(), Error> {
     let class = define_class("AutoCorrect", Default::default())?;
     class.define_singleton_method("format", function!(format, 1))?;
     class.define_singleton_method("format_for", function!(format_for, 2))?;
     class.define_singleton_method("lint_for", function!(lint_for, 2))?;
+    class.define_singleton_method("load_config", function!(load_config, 1))?;
+
+    let ignorer_class = class.define_class("Ignorer", Default::default())?;
+    ignorer_class.define_singleton_method("new", function!(Ignorer::new, 1))?;
+    ignorer_class.define_method("ignored?", method!(Ignorer::is_ignored, 1))?;
 
     Ok(())
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autocorrect-rb
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: x86_64-darwin
 authors:
 - Jason Lee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys