twfilter 0.1.0

data/lib/twfilter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "twfilter/version"
+require_relative "twfilter/errors"
+require_relative "twfilter/han"
+require_relative "twfilter/tables"
+require_relative "twfilter/punctuation"
+require_relative "twfilter/policy"
+require_relative "twfilter/finding"
+require_relative "twfilter/subject"
+require_relative "twfilter/sentences"
+require_relative "twfilter/evidence"
+require_relative "twfilter/checks/shape"
+require_relative "twfilter/checks/script"
+require_relative "twfilter/checks/lexicon"
+require_relative "twfilter/checks/erhua"
+require_relative "twfilter/checks/wenyan"
+require_relative "twfilter/block"
+
+module TWFilter
+  CHECKS = [Checks::Shape, Checks::Script, Checks::Lexicon, Checks::Erhua, Checks::Wenyan].freeze
+
+  class << self
+    def examine(text, policy: Policy.corpus, checks: CHECKS)
+      subject = Subject.new(text, policy: policy)
+      findings = checks.flat_map { |check| check.call(subject) }
+
+      Report.new(
+        text: subject.text,
+        findings: findings.freeze,
+        tier: Checks::Script.tier_of(subject.text),
+        han: subject.han,
+        evidence: Evidence.count(subject.text)
+      )
+    end
+
+    def keep?(text, policy: Policy.corpus) = examine(text, policy: policy).ok?
+
+    def normalize(text, **options) = Punctuation.normalize(text, **options)
+
+    def sentences(text, **options) = Sentences.split(text, **options)
+
+    def tier(text) = Checks::Script.tier_of(text)
+
+    def provenance = Tables.provenance
+
+    def reset!
+      Tables.reset!
+      Evidence.reset!
+      Checks::Script.reset!
+      Checks::Lexicon.reset!
+      self
+    end
+  end
+end

data/licenses/APACHE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/sig/twfilter.rbs

@@ -0,0 +1,215 @@
+module TWFilter
+  VERSION: String
+  TIERS: ::Hash[::Symbol, ::Integer]
+  DETAIL_SAMPLE: ::Integer
+  CHECKS: ::Array[_Check]
+
+  type severity = :reject | :mark
+  type inventory = :strict | :wide
+  type tier = :common | :secondary | :rare
+
+  interface _Check
+    def call: (Subject) -> ::Array[Finding]
+  end
+
+  class Error < ::StandardError
+  end
+
+  class MissingTableError < Error
+  end
+
+  class InvalidTableError < Error
+  end
+
+  def self.examine: (untyped, ?policy: Policy, ?checks: ::Array[_Check]) -> Report
+  def self.keep?: (untyped, ?policy: Policy) -> bool
+  def self.normalize: (untyped, ?collapse_repeats: bool) -> ::String
+  def self.sentences: (untyped, ?clause: bool) -> ::Array[::String]
+  def self.tier: (::String) -> ::Integer?
+  def self.provenance: () -> ::Hash[::Symbol, untyped]
+
+  class Finding
+    attr_reader check: ::Symbol
+    attr_reader code: ::Symbol
+    attr_reader severity: severity
+    attr_reader detail: ::String?
+
+    def initialize: (check: ::Symbol, code: ::Symbol, ?severity: severity, ?detail: ::String?) -> void
+    def reject?: () -> bool
+    def mark?: () -> bool
+    def to_h: () -> ::Hash[::Symbol, untyped]
+  end
+
+  class Report
+    attr_reader text: ::String
+    attr_reader findings: ::Array[Finding]
+    attr_reader tier: ::Integer?
+    attr_reader han: ::Integer
+    attr_reader evidence: ::Integer
+
+    def ok?: () -> bool
+    def rejects: () -> ::Array[Finding]
+    def marks: () -> ::Array[Finding]
+    def codes: () -> ::Array[::Symbol]
+    def reasons: () -> ::Array[::String]
+    def to_h: () -> ::Hash[::Symbol, untyped]
+  end
+
+  class Policy
+    attr_reader han_range: ::Range[::Numeric]
+    attr_reader min_han_ratio: ::Float
+    attr_reader max_tier: tier
+    attr_reader allow_latin: bool
+    attr_reader orthography_rejects: bool
+    attr_reader foreign_topics_reject: bool
+    attr_reader punctuation: inventory
+    attr_reader soft_lexicon_rejects: bool
+    attr_reader wenyan_min_han: ::Integer
+    attr_reader wenyan_min_hits: ::Integer
+    attr_reader wenyan_max_density: ::Float
+    attr_reader block_tolerance: ::Float
+    attr_reader evidence_per_100: ::Float
+
+    def self.corpus: () -> Policy
+    def self.publishable: () -> Policy
+    def self.permissive: () -> Policy
+    def tier_limit: () -> ::Integer
+    def with: (**untyped) -> Policy
+  end
+
+  class Subject
+    attr_reader text: ::String
+    attr_reader policy: Policy
+
+    def initialize: (untyped, ?policy: Policy) -> void
+    def chars: () -> ::Array[::String]
+    def han_chars: () -> ::Array[::String]
+    def han: () -> ::Integer
+    def ratio: () -> ::Float
+    def empty?: () -> bool
+    def include?: (::String) -> bool
+    def masked: (::Array[::String]) -> ::String
+  end
+
+  module Han
+    CHAR: ::Regexp
+    RUN: ::Regexp
+
+    def self.char?: (::String) -> bool
+    def self.count: (::String) -> ::Integer
+    def self.runs: (::String) -> ::Array[::String]
+    def self.ratio: (::String) -> ::Float
+    def self.basic?: (::String) -> bool
+  end
+
+  module Punctuation
+    TAIWAN: ::Set[::String]
+    LATIN: ::Set[::String]
+    SPACE: ::Set[::String]
+    STRICT: ::Set[::String]
+    WIDE: ::Set[::String]
+    SETS: ::Hash[inventory, ::Set[::String]]
+
+    def self.normalize: (untyped, ?collapse_repeats: bool) -> ::String
+    def self.acceptable?: (::String, ?set: ::Set[::String]) -> bool
+    def self.offenders: (::String, ?punctuation: inventory) -> ::Array[::String]
+  end
+
+  module Sentences
+    TERMINATORS: ::String
+    CLAUSE: ::String
+    CLOSERS: ::String
+
+    def self.split: (untyped, ?clause: bool) -> ::Array[::String]
+    def self.terminal?: (::String) -> bool
+    def self.shaped?: (::String, ?policy: Policy) -> bool
+  end
+
+  module Evidence
+    NEGATED: ::String
+
+    def self.count: (::String) -> ::Integer
+    def self.per_100: (::String) -> ::Float
+    def self.hits: (::String) -> ::Array[::String]
+    def self.markers: (::String) -> ::Array[::String]
+    def self.terms: () -> ::Array[::String]
+    def self.scanners: () -> ::Array[::String | ::Regexp]
+    def self.reset!: () -> void
+  end
+
+  module Block
+    SIZE: ::Integer
+
+    def self.judge: (::Array[::String], ?policy: Policy) -> ::Array[::String]
+    def self.each_kept: (::Enumerable[::String], ?size: ::Integer, ?policy: Policy) ?{ (::String) -> void } -> untyped
+  end
+
+  module Tables
+    BUNDLED: ::Pathname
+    MANIFEST: ::String
+    ADD: ::String
+    REMOVE: ::String
+    SCHEMA: ::Hash[::String, ::Symbol]
+
+    def self.dir: () -> ::Pathname
+    def self.dir=: (untyped) -> void
+    def self.overlay: () -> ::Pathname?
+    def self.overlay=: (untyped) -> void
+    def self.rows: (::String) -> ::Array[::String]
+    def self.set: (::String) -> ::Set[::String]
+    def self.pairs: (::String) -> ::Hash[::String, ::String]
+    def self.columns: (::String) -> ::Array[::Array[::String]]
+    def self.groups: (::String) -> ::Hash[::String, ::Array[::String]]
+    def self.names: () -> ::Array[::String]
+    def self.manifest: () -> ::Hash[::String, untyped]
+    def self.provenance: () -> ::Hash[::Symbol, untyped]
+    def self.reset!: () -> void
+  end
+
+  module Checks
+    module Shape
+      NAME: ::Symbol
+      def self.call: (Subject) -> ::Array[Finding]
+    end
+
+    module Script
+      NAME: ::Symbol
+      def self.call: (Subject) -> ::Array[Finding]
+      def self.tier: (::String) -> ::Integer?
+      def self.tier_of: (::String) -> ::Integer?
+      def self.tiers: () -> ::Hash[::String, ::Integer]
+      def self.simplified_only: () -> ::Set[::String]
+      def self.converted_orthography: () -> ::Set[::String]
+    end
+
+    module Lexicon
+      NAME: ::Symbol
+      ADDRESS: ::Regexp
+      def self.call: (Subject) -> ::Array[Finding]
+      def self.taiwan_form: (::String) -> ::String?
+      def self.hard_terms: () -> ::Hash[::String, ::String]
+      def self.soft_terms: () -> ::Hash[::String, ::String]
+      def self.exceptions: () -> ::Hash[::String, ::Array[::String]]
+      def self.regional_terms: () -> ::Hash[::String, ::String]
+      def self.cantonese_chars: () -> ::Array[::String]
+      def self.foreign_topics: () -> ::Array[::String]
+      def self.topic?: (::String, ::String) -> bool
+    end
+
+    module Erhua
+      NAME: ::Symbol
+      MARK: ::String
+      def self.call: (Subject) -> ::Array[Finding]
+      def self.offender: (::String) -> ::String?
+      def self.headed: () -> ::Set[::String]
+      def self.tailed: () -> ::Set[::String]
+    end
+
+    module Wenyan
+      NAME: ::Symbol
+      def self.call: (Subject) -> ::Array[Finding]
+      def self.density: (Subject) -> ::Float
+      def self.markers: () -> ::Array[::String]
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: twfilter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Den Patin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: 'Provenance analysis of Chinese text in pure Ruby: MOE character-chart
+  tiering, OpenCC-derived simplified round-trip detection, mainland traditional orthography,
+  corpus-verified lexical origin markers graded by attestation ratio, Cantonese particles,
+  erhua windowing, literary Chinese density, and positive Taiwan evidence over lexicon,
+  particles, institutions and the 有 + V perfective. Punctuation normalization to 教育部《重訂標點符號手冊》
+  and sentence segmentation over terminator-closer classes. Every rejection is reported
+  as a typed finding. No dependencies, no native extensions, deterministic output.'
+email: hi@dpat.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- NOTICES.md
+- README.md
+- lib/twfilter.rb
+- lib/twfilter/block.rb
+- lib/twfilter/checks/erhua.rb
+- lib/twfilter/checks/lexicon.rb
+- lib/twfilter/checks/script.rb
+- lib/twfilter/checks/shape.rb
+- lib/twfilter/checks/wenyan.rb
+- lib/twfilter/data/MANIFEST.json
+- lib/twfilter/data/cantonese.txt
+- lib/twfilter/data/converted_orthography.txt
+- lib/twfilter/data/erhua_headed.txt
+- lib/twfilter/data/erhua_tailed.txt
+- lib/twfilter/data/foreign_topics.txt
+- lib/twfilter/data/mainland_exceptions.tsv
+- lib/twfilter/data/mainland_hard.tsv
+- lib/twfilter/data/mainland_soft.tsv
+- lib/twfilter/data/moe_common.txt
+- lib/twfilter/data/moe_exception.txt
+- lib/twfilter/data/moe_rare.txt
+- lib/twfilter/data/moe_secondary.txt
+- lib/twfilter/data/regional_hard.tsv
+- lib/twfilter/data/simplified_only.txt
+- lib/twfilter/data/taiwan_grammar.txt
+- lib/twfilter/data/taiwan_lexicon.txt
+- lib/twfilter/data/taiwan_markers.txt
+- lib/twfilter/data/taiwan_particles.txt
+- lib/twfilter/data/variants_used_in_taiwan.txt
+- lib/twfilter/data/wenyan.txt
+- lib/twfilter/errors.rb
+- lib/twfilter/evidence.rb
+- lib/twfilter/finding.rb
+- lib/twfilter/han.rb
+- lib/twfilter/policy.rb
+- lib/twfilter/punctuation.rb
+- lib/twfilter/sentences.rb
+- lib/twfilter/subject.rb
+- lib/twfilter/tables.rb
+- lib/twfilter/version.rb
+- licenses/APACHE-2.0.txt
+- sig/twfilter.rbs
+homepage: https://github.com/taiwan-corpora/twfilter
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/taiwan-corpora/twfilter
+  changelog_uri: https://github.com/taiwan-corpora/twfilter/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/taiwan-corpora/twfilter/issues
+  documentation_uri: https://huggingface.co/datasets/taiwan-corpora/twfilter-tables
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: 'Taiwan Mandarin text filter: script inventory, orthography, lexical origin,
+  punctuation'
+test_files: []