artemo 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b14cd389857ce36b0935981f62c4a19f4a80c1b7
-  data.tar.gz: 24418d8508b9a790d0ec148a62d21c3ea1d15a17
+  metadata.gz: bf26e4f0d7cb45edef5b71c09ce29ebac9714ea3
+  data.tar.gz: bfd683dc37102896cb1638a3f8a3110f2e40c226
 SHA512:
-  metadata.gz: '0149c68d210643046ea48edfdeedec0b82c49ea4bf14129e4abf3d7b562443bc34e92a3e0ab74fe30a4f0274a850f953a728cd2062bb75e49f4417795cdfd24a'
-  data.tar.gz: 662fc2decc820ed164a674460c7853c04cda8c363b9f8de75671d0229c29bcf8cbc3c539a1cb64597909cff1170ec3e59cb98f4b03ed1f2a62a7925089360c9c
+  metadata.gz: 0b40379ec380e9717ddc9493a113ed61f1e18161b7a108a3e6c841d9ba9bfa25089b74a836c4ad915ce25a3e3525a540e86ea3b3d9a730f5947017e48c8d4bfd
+  data.tar.gz: 34eb3c2c2fb6af3b8c6c81ab06a0079dd377de99a38923706cdcbd12a34cae8c3c2f0d928984d12431c009fea8cb7949cb89f04257233f5f95c4ea8ab6e0c5a4

data/CHANGELOG

@@ -41,4 +41,7 @@ Version 3.1.1
 Last small fixes.
 
 Version 3.1.2
-Marshal binary database for faster work. 
+Marshal binary database for faster work. 
+
+Version 3.1.3
+Full documentation is added. Faster comparing word with keyword.

data/README.md

@@ -64,6 +64,10 @@ Version 3.1.2
 
 * Marshal binary database for faster work. 
 
+Version 3.1.3
+
+* Full documentation is added. Faster comparing word with keyword.
+
 ## Examples:
 
 ### Adam Mickiewicz - Świtezianka

data/lib/artemo/basic_emotions.rb

@@ -4,6 +4,8 @@ class BasicEmotions < Common
   attr_reader :keywords
   attr_reader :text
 
+  # @note This method initializes class
+
   def self.call(keywords, text)
     @keywords = keywords
     @text = text
@@ -14,18 +16,21 @@ class BasicEmotions < Common
     expand(scaled_array)
   end
 
+  # @note This method compare two words, if word is in array text then add one.
+
   def self.compare
     sum_array = Array.new(8).fill(0)
     @keywords.each.with_index do |line, index|
       line.each do |keyword|
-        @text.each do |word|
-          sum_array[index] += 1 if keyword == word
-        end
+        sum_array[index] += 1 if @text.include?(keyword)
       end
     end
     sum_array
   end
 
+  # @note This method is after inherited method comparing values in gradient,
+  #   and it's checking which value is greater, if it's greater then it is true.
+
   def self.check(array_one)
     values_array = Array.new(8).fill(0)
     array_one.each_index do |index|
@@ -42,6 +47,9 @@ class BasicEmotions < Common
     values_array
   end
 
+  # @note This method check which value is true and if it's true add two,
+  #   else add one.
+
   def self.weigh(array_one, array_two)
     weighed_array = Array.new(8).fill(0)
     array_one.each.with_index do |item, index|
@@ -56,6 +64,8 @@ class BasicEmotions < Common
     weighed_array
   end
 
+  # @note This method is expanding 8 element array to 24 element array in ranges.
+
   def self.expand(array_one)
     expanded_array = Array.new(24).fill(0)
     array_one.each.with_index do |item, index|

data/lib/artemo/common.rb

@@ -1,6 +1,9 @@
 # @note This class have all common classes for all program
-# @return [Array] of scaled emotions in range 0-100
+# @return [Array] of scaled emotions in range 0..100
 class Common
+
+  # @note This method is scaling values in range 1..100
+
   def self.scale(array_one)
     min, max = array_one.minmax
     array_one.each.with_index do |item, index|

data/lib/artemo/complex_emotions.rb

@@ -1,12 +1,17 @@
 # @note This class analyze complex emotions
 # @return [Array] of sum of sorted complex emotions
 class ComplexEmotions < Common
+
+  # @note This method initializes class
+
   def self.call(array_one)
     scaled_array = scale(array_one)
     sorted_array = sort(scaled_array)
     sum(sorted_array)
   end
 
+  # @note This method is sorting values by pattern x+0, x+8, x+16 then (x*3), (x*3)+1, (x*3)+2.
+
   def self.sort(array_one)
     sorted_array = Array.new(24)
     tmp_array = Array.new(3)
@@ -22,6 +27,8 @@ class ComplexEmotions < Common
     sorted_array
   end
 
+  # @note This method is summing values if they are greater than 25.
+
   def self.sum(array_one)
     sum_array = Array.new(24).fill(0)
     index = 0

data/lib/artemo/keywords.rb

@@ -1,7 +1,10 @@
 # @note This class create database of keywords
 # @return [Array] of keywords
 class Keywords
-  # Databases of emotions (source: http://saifmohammad.com/WebPages/NRC-Emotion-Lexicon.htm)
+
+# @note This method is loading database of emotions (source: http://saifmohammad.com)
+#   in binary format.
+  
   def self.call
     include = File.expand_path('../../../include/database.db', __FILE__)
     f = File.open(include, "rb")

data/lib/artemo/loader.rb

@@ -1,6 +1,10 @@
 # @note This class loads file with text to analyze
 # @return [Array] of whole text
 class Loader
+
+# @note This method is loading text, next is removing special characters,
+#   next is splitting it to Array.
+
   def self.call(path)
     begin
       File.read(File.expand_path(path)).gsub!(/[^a-zA-Z ]/, '').downcase!.split(' ')

data/lib/artemo/result.rb

@@ -1,18 +1,25 @@
-# @note This class show result
+# @note This class show results
 # @return [Hash] of sorted complex emotions
 class Result
+
+  # @note This method initializes all class
+
   def self.call(array_one)
     show(array_one)
   end
 
+  # @note This method is showing results.
+
   def self.show(array_one)
     results = {}
     array_one.each_index do |index|
       results[titles[index]] = array_one[index]
     end
-    results = results.sort_by { |_k, v| v }.to_h
+    results.sort_by { |_k, v| v }.to_h
   end
 
+  # @note This method is storing titles of emotions in Array.
+
   def self.titles
     ['love', 'guilt', 'delight', 'submission', 'curiosity', 'sentimentality', 'awe', 'despair', 'shame', 'disappointment', 'revulsion', 'outrage', 'remorse', 'envy', 'pessimism', 'contempt', 'cynicism', 'morbidness', 'aggressiveness', 'pride', 'dominance', 'optimism', 'fatalism', 'anxiety']
   end

data/lib/artemo/version.rb

@@ -1,4 +1,4 @@
 # @note This module returns version
 module ArtEmo
-  VERSION = "3.1.2"
+  VERSION = "3.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artemo
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Łukasz Fuszara