ba-normalizedsearch 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3958f87c10b2fe41d41a4565fc7fef87c5b03c4f3e1b5b4e5809afef6fca2e0e
+  data.tar.gz: 5cd79e45ebe5c988763aa4afa0a703da8c378a11bb1773073047460174f01008
+SHA512:
+  metadata.gz: 7569888a9ba9b2049061eb3e02db6401ac36d3313454fe5a8477eacff12851d095169a052222cfa6d9d29bcfae10ebd062e677173996167053264c554e1c76ad
+  data.tar.gz: e2e7d4ff7111431110060bb137d69c49bff84294ac2351302cd6be9bc3d4a837dc3dee154460e8a8a5bf741e352292c871bb2c0bf414ababdb885be46a5b713c

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# ba-normalizedsearch Gem ChangeLog
+
+## [0.1.2] - 2022-07-19
+
+- Initial release
+- 

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby '>= 2.7'
+
+# Specify your gem's dependencies in ba-normalizedsearch.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    ba-normalizedsearch (0.1.2)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.3)
+    rake (13.0.6)
+    thor (1.2.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ba-normalizedsearch!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+RUBY VERSION
+   ruby 2.7.4p191
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.md

@@ -0,0 +1,10 @@
+# MIT License
+
+Copyright (c) 2023 Sächsische Akademie der Wissenschaften
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,34 @@
+# ba-normalizedsearch
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ba-normalizedsearch --git=https://git.saw-leipzig.de/bibarab/misc/ba-normalizedsearch.git
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ git clone https://git.saw-leipzig.de/bibarab/misc/ba-normalizedsearch.git
+    $ gem install ba-normalizedsearch/*.gem
+
+## Usage
+
+### In your code
+
+```ruby
+require 'ba-normalizedsearch'
+@search = BANormalizedSearch::Search.new
+normalized_string = @search.normalize "some string"
+```
+
+### On the command line
+
+```bash
+normsearch normalize "some string"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 `rake gem` which will create a new .gem file, remove the older ones if any, commit your changes and `git tag name-for-new-release`, then `git push`.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+desc "build a new .gem file"
+task :gem do
+  `gem build *.gemspec`
+end
+
+task default: :test

data/exe/normsearch

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+exe = File.basename __FILE__
+dep = 'ba-normalizedsearch/cli'
+__FILE__.match(/exe\/#{exe}$/) ? require_relative("../lib/#{dep}") : require(dep)
+BANormalizedSearch::CLI.start

data/lib/ba-normalizedsearch/cli.rb

@@ -0,0 +1,12 @@
+require 'thor'
+require_relative '../ba-normalizedsearch'
+
+module BANormalizedSearch
+  class CLI < Thor
+    desc 'normalize <string>', 'output a normalized version of the input string'
+    def normalize s
+      @search = BANormalizedSearch::Search.new
+      puts @search.normalize s
+    end
+  end
+end

data/lib/ba-normalizedsearch/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BANormalizedSearch
+  VERSION = "0.1.2"
+end

data/lib/ba-normalizedsearch.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "ba-normalizedsearch/version"
+
+module BANormalizedSearch
+  class Error < StandardError; end
+
+  class Search 
+    def initialize wordlist=[]
+      @wordlist = wordlist
+                # tatweel  fathatan  dammatan  kasratan  fatha     damma     kasra     shadda    sukun
+      @vocals = ["\u0640", "\u064b", "\u064c", "\u064d", "\u064e", "\u064f", "\u0650", "\u0651", "\u0652"]
+      @re_vocals_delete = "[" + @vocals.join("") + "]"
+      @waw = "و"
+      @abd = "عبد"
+      @din = "الدين"
+      @al = "ال"
+      @lah = "له"
+    end
+
+    def normalize s
+      s = s.unicode_normalize(:nfc)
+      s = s.gsub(/#{@re_vocals_delete}/ , "") # delete vowels
+      s = s.gsub(/[إأٱآ]/ , "ا") # normalise alif
+      s = s.gsub(/[\u0676]/ , "\u0624") # ARABIC LETTER HIGH HAMZA WAW --> ARABIC LETTER WAW WITH HAMZA ABOVE
+      s = s.gsub(/[\u0649\u06CC\u064a]/ , "\u064a") # normalise alif maqsura, farsi yeh, (ARABIC LETTER YEH WITH HAMZA ABOVE not yet! \u0626, see rules below), yeh --> yeh
+      s = s.gsub(/(?<=\b)#{@al}(?!#{@lah})/ , "") # delete "al") after space (could in some cases be part of the word itself  --> false positives)
+      s = s.gsub(/(?<=\b)#{@waw}\s/ , "#{@waw}") # Persian "wa XYZ" --> Arabic "waXYZ")
+      s = s.gsub(/(?<=\b)#{@abd}\s/ , "#{@abd}") # standardise names with abd, e.g. abd allah (etc.) --> abdallah
+      s = s.gsub(/(?<=\B)\u0626(?=\B)/ , "ي") # Arabic letter yeh with hamza above (in the middle of a word) --> Arabic letter yeh, e.g. عقائد --> عقايد
+      s = s.gsub(/(?<=\B)\u0626(?=\b)/ , "يء") # Arabic letter yeh with hamza above (at the end of a word) --> yeh + Hamza, e.g. مبادئ --> مباديء
+
+      # Ta' marbuta (U+0629) (Wortende) im Persischen mit Hah (U+0647) wiedergegeben, z.B. حاشية (ar) vs. حاشيه (fa)
+      # ta' marbuta --> h? (Persian/Mar'ashi) 
+
+      # arabisches Hamza auf Alif maqsura (U+0626) in pers. Onlinedaten als Yah+Hamza (U+0626) wiedergegeben, z.B. مبادئ (ar) vs. مباديء (fa)
+      # Allerdings kommt das ئ (U+0626) im Mar'ashi-Katalog vor (قضائ, مفاتيحئ).
+
+      # s = s.gsub(/\s#{din}(?=\b)/ , "#{din}") # standardise names with al-din, e.g. shihab aldin --> shihabaldin
+
+      # Latin and romanised
+      s = s.downcase
+      s = s.gsub(/š/ , "sh")
+      s = s.gsub(/ḫ/ , "kh")
+      s = s.gsub(/ġ/ , "gh")
+      s = s.gsub(/ḏ/ , "dh")
+      s = s.gsub(/ṯ/ , "th")
+      s = s.gsub(/á/ , "ā")
+
+      # FRAGE THOMAS: ' kann Hamza ODER 'Ayn sein --> Mehrfachindizierung wie?
+      #   Besser: alle Hamzas/Ayns u.ä. löschen 
+      #   --> TE: auf einen Buchstaben abbilden
+      # Frage Thomas: Ehrentitel als Präfix löschen? (außer bei kurzen Suchstrings?) --> vs. substring-Suche
+      # Frage Thomas: Abdallah vs. Abd allah
+      # Suche substring?
+      
+      return s
+    end
+
+    def search searchword
+      @wordlist.select do |listword|
+        normalize(listword) == normalize(searchword)
+      end
+    end
+  end
+end

data/sig/ba-normalizedsearch.rbs

@@ -0,0 +1,4 @@
+module BANormalizedSearch
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: ba-normalizedsearch
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Thomas Efer
+- Daniel Kinitz
+- J. R. Schmid
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  name: thor
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description:
+email:
+- kinitz@saw-leipzig.de
+executables:
+- normsearch
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/normsearch
+- lib/ba-normalizedsearch.rb
+- lib/ba-normalizedsearch/cli.rb
+- lib/ba-normalizedsearch/version.rb
+- sig/ba-normalizedsearch.rbs
+homepage: https://rubygems.org/gems/ba-normalizedsearch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/ba-normalizedsearch
+  source_code_uri: https://rubygems.org/gems/ba-normalizedsearch.git/
+  changelog_uri: https://rubygems.org/gems/ba-normalizedsearch/-/raw/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: Normalize strings containing Arabic script or Romanisations of Arabic
+test_files: []