sastrawi 0.1.0.pre → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85c8c97313e9ebf76008045f30bec9a9eaca39dd
-  data.tar.gz: f4353fd69f5a722fd8003c37e8c0a61c43ce8c34
+SHA256:
+  metadata.gz: 76f20957cffd660eeb6afefa58352d16e55e8f259f22fe31e65a800cea5372e2
+  data.tar.gz: 47a45adb1dd5aec42614ffaf5ab716ca591a3747222a05c61d8f26df8676a18b
 SHA512:
-  metadata.gz: 86ac9f0de919863b86bc7e41b2428f958c43d921453fc34336282996352005bde335c5790ac509a894251b79fa9c79685a638c1ca97469921493fc54f91cad7a
-  data.tar.gz: 826cef4036c182fd855b399c0db1f7a417b43950f8ac9e710a4e8bb335880369f589196bc947162ccb664e427b6ea7e79d014a6ee9cbf0053084665c6df82fa9
+  metadata.gz: '0822820839bf44e8605d11b430551e55b93094704b7b3b82098510a2809df3984864388d73dfc4bed07d0989591fb4772f3e25c47192a257d02de23361b71a01'
+  data.tar.gz: a5980e90c5de75fb3d1d7c2137148ee4f93710e0d02a4341910b33156638df93b4cd0ee55f722abee072a52420550f918c813bda8bccdbda541994da6e5d358b

data/.gitignore

@@ -42,7 +42,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/.travis.yml

@@ -1,8 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.2.6
-  - 2.3.1
-  - 2.4.0
-before_install: gem install bundler -v 1.12.5
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+before_install: gem install bundler -v 2.2.14 --no-document
+notifications:
+  email:
+    on_success: never

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to sastrawi-ruby
+
+If you find a bug, please report it to [issue tracker][issue]. You can also
+contribute by writing codes.
+
+## How to contribute
+
+There are some steps you must follow:
+
+1. Fork this repository and clone it to your local environment
+2. Create a named brached that contains your change
+3. Install the development dependencies by running `bundle install`
+4. Code
+5. Add or adjust unit tests and make sure everything passes by running `bundle
+   exec rake`
+6. Push your branch to GitHub
+7. Send a pull request for your branch
+
+Use `dev` branch as a target of your branch for pull request. Both issue and pull
+request details must be written in English.
+
+[issue]: https://github.com/meisyal/sastrawi-ruby/issues

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2017 Andrias Meisyal
+Copyright (c) 2016-2021 Andrias Meisyal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-# Sastrawi Bindings for Ruby [![Build Status](https://travis-ci.org/meisyal/sastrawi-ruby.svg?branch=master)](https://travis-ci.org/meisyal/sastrawi-ruby)
+# Sastrawi Bindings for Ruby [![Build Status](https://travis-ci.org/meisyal/sastrawi-ruby.svg?branch=master)](https://travis-ci.org/meisyal/sastrawi-ruby) [![Gem Version](https://badge.fury.io/rb/sastrawi.svg)](https://badge.fury.io/rb/sastrawi)
 
 sastrawi-ruby is Ruby bindings for [Sastrawi][sastrawi], a library which allows you
 to stem words in Bahasa Indonesia. The original implementation of Sastrawi was
@@ -6,12 +6,18 @@ written in PHP and this library is written in Ruby language.
 
 Taken from [Wikipedia][stemmingwiki], stemming is the process of reducing
 inflected (or sometimes derived) words to their word stem, base or root form.
-For instance, "menahan" has "tahan" as its base form.
+For instance, "menahan" has "tahan" as its base form. If you want to know how
+stemming works, please read this [page][howstemmingworks] (in Bahasa Indonesia)
+for further details.
+
+## Demo
+
+The demo version of sastrawi-ruby can be accessed [here][demo].
 
 ## Documentation
 
-Documentation for this library is not available at this moment. But, you can
-check [sastrawi-ruby GitHub Wiki][documentation] that contains TODO list.
+Documentation for this library is available on [here][documentation]. You can
+also check [sastrawi-ruby GitHub Wiki][wiki] that contains TODO list.
 
 ## Installation
 
@@ -22,38 +28,61 @@ Ruby bindings for Sastrawi, add this line to your application's Gemfile:
 
 and then execute:
 
-    bundle install
+    $ bundle install
 
 or you can install directly:
 
-    gem install sastrawi
+    $ gem install sastrawi
 
-Note that, this library requires Ruby. Ruby 1.9.3 or above should be installed
-on your system. I would recommend to choose the stable versions.
+Note that, this library requires Ruby. Ruby 2.3 series or above should be
+installed on your system. I would recommend to use the stable versions.
 
 ## Usage
 
-Currently, this library supports stemming words with provided base forms. You
-can't add or remove any base form. This feature will be implemented for next
-release.
+This library supports stemming words with provided base forms.
 
 ```ruby
 require 'sastrawi'
 
+# create stemmer
+stemmer_factory = Sastrawi::Stemmer::StemmerFactory.new
+stemmer = stemmer_factory.create_stemmer
+
 # prepare a sentence or words to be stemmed and call the stem API
 sentence = 'Perekonomian Indonesia sedang dalam pertumbuhan yang membanggakan.'
-stemming_result = Sastrawi.stem(sentence)
+stemming_result = stemmer.stem(sentence)
 
-# the stemming result should be "ekonomi indonesia sedang dalam tumbuh yang
-bangga"
+# the stemming result should be "ekonomi indonesia sedang dalam tumbuh yang bangga"
 puts stemming_result
 ```
 
+Beside that, you can add or remove any base form.
+
+```ruby
+require 'sastrawi'
+
+# create stemmer
+stemmer_factory = Sastrawi::Stemmer::StemmerFactory.new
+
+# create default dictionary and add a text file that contains words into it
+dictionary = stemmer_factory.create_default_dictionary
+dictionary.add_words_from_text_file('my-dictionary.txt')
+
+# add or remove words
+dictionary.add('internet')
+dictionary.remove('desa')
+
+# stem a word, "internetan", for example
+stemmer = Sastrawi::Stemmer::Stemmer.new(dictionary)
+
+# the stemming result should be "internet"
+puts stemmer.stem('internetan')
+```
+
 ## Contributing
 
-Contributions are welcome. If you find a bug, please report it to issue
-tracker. Use `dev` branch as a target of your feature branch for pull request.
-Both issue and pull request details should be written in English.
+Contributions are welcome. Please, read [CONTRIBUTING][contributing]
+guidelines.
 
 ## License
 
@@ -62,9 +91,14 @@ This library is released under the terms of MIT License. See the
 words from [Kateglo][kateglo] and it is licensed under a [Creative Commons
 Attribution-NonCommercial-ShareAlike 3.0 Unported License][kateglolicense].
 
+
 [sastrawi]: https://github.com/sastrawi/sastrawi
 [stemmingwiki]: https://en.wikipedia.org/wiki/Stemming
-[documentation]: https://github.com/meisyal/sastrawi-ruby/wiki
+[howstemmingworks]: https://github.com/sastrawi/sastrawi/wiki/Stemming-Bahasa-Indonesia
+[demo]: https://sastrawi-ruby-demo.herokuapp.com
+[documentation]: https://www.rubydoc.info/gems/sastrawi/
+[contributing]: https://github.com/meisyal/sastrawi-ruby/blob/master/CONTRIBUTING.md
 [license]: https://github.com/meisyal/sastrawi-ruby/blob/master/LICENSE.txt
-[kateglo]: http://kateglo.com
+[kateglo]: https://kateglo.com
 [kateglolicense]: https://creativecommons.org/licenses/by-nc-sa/3.0/
+[wiki]: https://github.com/meisyal/sastrawi-ruby/wiki

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/bin/sastrawi

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'sastrawi'
+
+# usage: $ sastrawi word/sentence
+if ARGV.empty?
+  puts '--------------- sastrawi: ERROR ---------------'
+  puts 'Usage: Please specify a word or sentence to be stemmed.'
+  puts '       sastrawi word/sentence'
+  puts 'Example:'
+  puts '       sastrawi mengundang'
+  puts '       sastrawi Perekonomian Indonesia sedang dalam pertumbuhan yang membanggakan.'
+else
+  stemmer_factory = Sastrawi::Stemmer::StemmerFactory.new
+  stemmer = stemmer_factory.create_stemmer
+
+  words = []
+
+  ARGV.each { |arg| words << arg }
+
+  sentence = words.join(' ')
+
+  puts stemmer.stem(sentence)
+end

data/lib/sastrawi.rb

@@ -1,12 +1,4 @@
 require 'sastrawi/version'
 
 require 'sastrawi/stemmer/stemmer_factory'
-
-module Sastrawi
-  def self.stem(sentence)
-    stemmer_factory = Sastrawi::Stemmer::StemmerFactory.new
-    stemmer = stemmer_factory.create_stemmer
-
-    stemmer.stem(sentence)
-  end
-end
+require 'sastrawi/stop_word_remover/stop_word_remover_factory'

data/lib/sastrawi/dictionary/array_dictionary.rb

@@ -1,7 +1,7 @@
 module Sastrawi
   module Dictionary
     class ArrayDictionary
-      attr_accessor :words
+      attr_reader :words
 
       def initialize(words = [])
         @words = []
@@ -9,25 +9,59 @@ module Sastrawi
         add_words(words)
       end
 
+      ##
+      # Check whether a word is contained in the dictionary
+
       def contains?(word)
         @words.include?(word)
       end
 
+      ##
+      # Count how many words in the dictionary
+
       def count
         @words.length
       end
 
+      ##
+      # Add multiple words to the dictionary
+
       def add_words(new_words)
         new_words.each do |word|
           add(word)
         end
       end
 
+      ##
+      # Add a word to the dictionary
+
       def add(word)
-        return if word == ''
+        return if word.nil? || word.strip == ''
 
         @words.push(word)
       end
+
+      ##
+      # Add words from a text file to the dictionary
+
+      def add_words_from_text_file(file_path)
+        words = []
+
+        File.open(file_path, 'r') do |file|
+          file.each do |line|
+            words.push(line.chomp)
+          end
+        end
+
+        add_words(words)
+      end
+
+      ##
+      # Remove a word from the dictionary
+
+      def remove(word)
+        @words.delete(word)
+      end
     end
   end
 end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule10.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return matches[0] << matches[1] << matches[2]
+            return "#{matches[0]}#{matches[1]}#{matches[2]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule11.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return matches[0] << matches[1]
+            return "#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule12.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 'pe' << matches[0]
+            return "pe#{matches[0]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule13a.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 'm' << matches[0] << matches[1]
+            return "m#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule13b.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 'p' << matches[0] << matches[1]
+            return "p#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule14.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return matches[0] << matches[1]
+            return "#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule15a.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 'n' << matches[0] << matches[1]
+            return "n#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule15b.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 't' << matches[0] << matches[1]
+            return "t#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule16.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return matches[0] << matches[1]
+            return "#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule17a.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return matches[0] << matches[1]
+            return "#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule17b.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 'k' << matches[0] << matches[1]
+            return "k#{matches[0]}#{matches[1]}"
           end
         end
       end

data/lib/sastrawi/morphology/disambiguator/disambiguator_prefix_rule17d.rb

@@ -8,7 +8,7 @@ module Sastrawi
           if contains
             matches = contains.captures
 
-            return 'ng' << matches[0] << matches[1]
+            return "ng#{matches[0]}#{matches[1]}"
           end
         end
       end