farsi_processor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14caf0cd116b2df5f3c3dec3266733e2356d8a3b
+  data.tar.gz: 231eb73eda6fd8d035ab607f81128a1179eaf756
+SHA512:
+  metadata.gz: 5d50d1e956b6a582c37de9a62fa122f652a0ae2b036ef7303df142d4ae4317feb8961986b7f62c0e2603e682c487b3cfe9cd5fe6a5b936d6fe92bc108198a582
+  data.tar.gz: a7dd822e3a43d8ea0c3855fed403aa7b3972185e0bfe4cd0b8e9ed7ba4c6d9b3a9849ce4cf2d3457da3a97275d9cfd02d2c6c6049b783ab6081b6f942f09c14a

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec --out /tmp/test-results/rspec.xml --format progress 
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mark.jad@live.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 mark jad
+
+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 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,68 @@
+# Farsi Normalizer [![CircleCI](https://circleci.com/gh/mshka/farsi_processor.svg?style=svg)](https://circleci.com/gh/mshka/farsi_processor)
+
+FarsiProcessor is a ruby gem to normalize and stem Persian/Farsi text
+
+Normalization is defined as:
+ - Normalization of [arabic kaf](https://unicode-table.com/en/0643/) to [farsi keheh](https://unicode-table.com/en/06A9/)
+ - Normalization of [arabic yeh](https://unicode-table.com/en/064A/) and [arabic alef maksoura](https://unicode-table.com/en/0649/) to [farsi yeh](https://unicode-table.com/en/06CC/)
+ - Normalization of [alef mada](https://unicode-table.com/en/0622/), [alef with hamza below](https://unicode-table.com/en/0625/) and [alef with hamza above](https://unicode-table.com/en/0623/) to [alef](https://unicode-table.com/en/0627/)
+ - Removing [TATWIL](https://unicode-table.com/en/0640/)
+ - Removing [DIACRITICS](https://github.com/mshka/farsi_processor/blob/master/lib/farsi_normalizer.rb#L18-L25)
+
+Stemming is defined as removing these [suffixes (+ suffixes of plural form)](https://github.com/mshka/farsi_processor/blob/master/lib/farsi_stemmer.rb#L19-L28)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "farsi_processor"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install farsi_processor
+
+## Usage
+
+```ruby
+require 'farsi_processor'
+
+[1] pry(main)> FarsiProcessor.process("ك")
+=> "ک"
+
+[2] pry(main)> FarsiProcessor.process("کتاب‌ ها")
+=> "کتاب"
+
+# it supports only and except options
+[3] pry(main)> FarsiProcessor.process("ك ي", only: ["ك"])
+=> "ک ي"
+
+[4] pry(main)> FarsiProcessor.process("ك ي", except: ["ك"])
+=> "ك ی"
+
+[5] pry(main)> FarsiProcessor.process('دخترهای', except: ['های'])
+=> "دختره"
+
+# you can choose to just normalize or stem a word,
+# they also support an only and except option
+[6] pry(main)> FarsiProcessor.normalize("ك")
+=> "ک"
+
+[7] pry(main)> FarsiProcessor.stem("کتاب‌ ها")
+=> "کتاب"
+
+```
+
+### Questions or Problems?
+
+If you have any issues with farsi_processor which you cannot find the solution, please add an [issue on GitHub](https://github.com/mshka/farsi_processor/issues) or fork the project and send a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'farsi_processor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "farsi_processor"
+  spec.version       = FarsiProcessor::VERSION
+  spec.authors       = ["mark jad"]
+  spec.email         = ["mark.jad@live.com"]
+
+  spec.summary       = %q{farsi_processor is a Ruby gem to process (stem and normalize) persian/farsi text}
+  spec.description   = %q{farsi_processor is a Ruby gem to process (stem and normalize) persian/farsi text}
+  spec.homepage      = "https://github.com/mshka/farsi_processor"
+  spec.license       = "MIT"
+
+  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.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/farsi_normalizer.rb

@@ -0,0 +1,97 @@
+require 'farsi_processor/version'
+
+class FarsiNormalizer
+  ARABIC_KAF = "\u0643".freeze # ك
+  FARSI_KEHEH = "\u06a9".freeze # ک
+
+  ARABIC_YEH = "\u064a".freeze # ي
+  ARABIC_ALEF_MAKSOURA = "\u0649".freeze # ى
+  FARSI_YEH = "\u06cc".freeze # ی
+
+  ALEF_MADDA = "\u0622".freeze # آ
+  ALEF_WITH_HAMZA_BELOW = "\u0625".freeze # إ
+  ALEF_WITH_HAMZA_ABOVE = "\u0623".freeze # أ
+  ALEF = "\u0627".freeze # ا
+
+  TATWIL = "\u0640".freeze # ـ
+
+  FATHATAN = "\u064b".freeze
+  DAMMATAN = "\u064c".freeze
+  KASRATAN = "\u064d".freeze
+  FATHA = "\u064e".freeze
+  DAMMA = "\u064f".freeze
+  KASRA = "\u0650".freeze
+  SHADDA = "\u0651".freeze
+  SUKUN = "\u0652".freeze
+
+  CHARACTERS_MAPPINGS = {
+    ARABIC_KAF => FARSI_KEHEH,
+    ARABIC_YEH => FARSI_YEH,
+    ARABIC_ALEF_MAKSOURA => FARSI_YEH,
+    ALEF_MADDA => ALEF,
+    ALEF_WITH_HAMZA_BELOW => ALEF,
+    ALEF_WITH_HAMZA_ABOVE => ALEF,
+    TATWIL => ''
+  }.freeze
+
+  DIACRITICS = [
+    FATHATAN,
+    DAMMATAN,
+    KASRATAN,
+    FATHA,
+    DAMMA,
+    KASRA,
+    SHADDA,
+    SUKUN
+  ].freeze
+
+  def self.process(word, options = {})
+    new(word, options).process
+  end
+
+  attr_reader :word, :excepts, :onlys
+
+  def initialize(word, options = {})
+    @word = word.dup
+
+    @onlys = []
+    @excepts = []
+    if options[:only]
+      @onlys = options[:only]
+    elsif options[:except]
+      @excepts = options[:except]
+    end
+  end
+
+  def process
+    map_charachters
+    remove_diacritics
+    word
+  end
+
+  private
+
+  def filter_rules(group)
+    if excepts.any?
+      group.reject { |k, _v| excepts.include?(k) }
+    elsif onlys.any?
+      group.select { |k, _v| onlys.include?(k) }
+    else
+      group
+    end
+  end
+
+  def map_charachters
+    rules = filter_rules(CHARACTERS_MAPPINGS)
+    return if rules.empty?
+
+    word.gsub!(/[#{rules.keys.join}]/, rules)
+  end
+
+  def remove_diacritics
+    rules = filter_rules(DIACRITICS)
+    return if rules.empty?
+
+    word.gsub!(/[#{rules.join}]/, '')
+  end
+end

data/lib/farsi_processor/version.rb

@@ -0,0 +1,3 @@
+class FarsiProcessor
+  VERSION = "0.2.0"
+end

data/lib/farsi_processor.rb

@@ -0,0 +1,37 @@
+require 'farsi_processor/version'
+require_relative 'farsi_normalizer'
+require_relative 'farsi_stemmer'
+
+class FarsiProcessor
+  def self.process(word, options = {})
+    new(word, options).process
+  end
+
+  def self.normalize(word, options = {})
+    new(word, options).normalize
+  end
+
+  def self.stem(word, options = {})
+    new(word, options).stem
+  end
+
+  attr_reader :word, :options
+
+  def initialize(word, options = {})
+    @word = word
+    @options = options
+  end
+
+  def process
+    normalize
+    stem
+  end
+
+  def normalize
+    @word = FarsiNormalizer.process(word, options)
+  end
+
+  def stem
+    @word = FarsiStemmer.process(word, options)
+  end
+end

data/lib/farsi_stemmer.rb

@@ -0,0 +1,73 @@
+require 'farsi_processor/version'
+
+class FarsiStemmer
+  ALEF = "\u0627".freeze # ا
+  YEH = "\u06cc".freeze # ی
+  HEH = "\u0647".freeze # ه
+  TET = "\u062a".freeze # ت
+  REH = "\u0631".freeze # ر
+  NOON = "\u0646".freeze # ن
+  GAF = "\u06af".freeze # گ
+  MEEM = "\u0645".freeze # م
+
+  PLURAL_FORMS = [
+    ALEF + NOON,
+    ALEF + TET,
+    HEH + ALEF
+  ].freeze
+
+  SUFFIXES = [
+    TET + REH + YEH + NOON,
+    TET + REH + YEH,
+    GAF + REH + YEH,
+    HEH + ALEF + YEH,
+    ALEF + MEEM,
+    GAF + REH,
+    TET + REH,
+    ALEF + YEH
+  ] + PLURAL_FORMS
+
+  def self.process(word, options = {})
+    new(word, options).process
+  end
+
+  attr_reader :word, :excepts, :onlys
+
+  def initialize(word, options = {})
+    @word = word.dup
+
+    @onlys = []
+    @excepts = []
+    if options[:only]
+      @onlys = options[:only]
+    elsif options[:except]
+      @excepts = options[:except]
+    end
+  end
+
+  def process
+    stem_suffix
+    word.strip
+  end
+
+  private
+
+  def filter_rules(group)
+    if excepts.any?
+      group.reject { |k, _v| excepts.include?(k) }
+    elsif onlys.any?
+      group.select { |k, _v| onlys.include?(k) }
+    else
+      group
+    end
+  end
+
+  def stem_suffix
+    filter_rules(SUFFIXES).each do |suffix|
+      if word.end_with?(suffix)
+        @word = word[0..-(suffix.length + 1)]
+        break
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: farsi_processor
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- mark jad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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: farsi_processor is a Ruby gem to process (stem and normalize) persian/farsi
+  text
+email:
+- mark.jad@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- farsi_processor.gemspec
+- lib/farsi_normalizer.rb
+- lib/farsi_processor.rb
+- lib/farsi_processor/version.rb
+- lib/farsi_stemmer.rb
+homepage: https://github.com/mshka/farsi_processor
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: farsi_processor is a Ruby gem to process (stem and normalize) persian/farsi
+  text
+test_files: []