sentimental 1.0.0 → 1.0.1

data/README.md

@@ -0,0 +1,79 @@
+# sentimental
+
+Simple sentiment analysis with Ruby
+
+## How it works
+
+Sentences are tokenized, tokens are assigned a numerical score
+for their average sentiment.  The total score is then used to 
+determine the overall sentiment in relation to the thresold.
+
+For example, the default threshold is 0.0.  If a sentence has
+a score of 0, it is deemed "neutral".  Higher than the thresold
+is "positive", lower is "negative".  
+
+If you set the threshold to a non-zero amount, e.g. 0.25:
+
+- Positive scores are > 0.25
+- Neutral scores are -0.25 - 0.25
+- Negative scores are < -0.25
+
+
+## Usage
+
+```ruby
+
+# Load the default sentiment dictionaries
+Sentimental.load_defaults
+
+# And/or load your own dictionaries
+Sentimental.load_senti_file('path/to/your/file.txt')
+
+# Set a global threshold
+Sentimental.threshold = 0.1
+
+# Create an instance for usage:
+analyzer = Sentimental.new
+analyzer.get_sentiment 'I love ruby'
+#=> :positive
+
+analyzer.get_sentiment 'I like ruby'
+#=> :neutral
+
+analyzer.get_sentiment 'I really like ruby'
+#=> :positive
+
+# You can make new analyzers with individual thresholds:
+analyzer = Sentimental.new(0.9)
+analyzer.get_sentiment 'I love ruby'
+#=> :positive
+
+analyzer.get_sentiment 'I like ruby'
+#=> :neutral
+ 
+analyzer.get_sentiment 'I really like ruby'
+#=> :neutral
+
+# Get the numerical score of a string:
+analyzer.get_score 'I love ruby'
+#=> 0.925
+
+```
+
+## Sentiment dictionaries
+
+These are currently plain-text files containing whitespace-separated
+scores and tokens, e.g.:
+
+    1.0 Awesome
+    0.0 Meh
+    -1.0 Horrible
+
+## Installation 
+
+    gem install sentimental
+
+## Credits
+
+Based largely on Christopher MacLellan's script:
+https://github.com/cmaclell/Basic-Tweet-Sentiment-Analyzer

data/lib/sentimental.rb

@@ -64,18 +64,10 @@ class Sentimental
     #tokenize the string, also throw away some punctuation
     tokens = string.to_s.downcase.split(/[\s\!\?\.]+/)
     
-    for token in tokens do
+    tokens.each do |token|
       sentiment_value = @@sentihash[token]
-      
-      if sentiment_value
-        
-        # for debugging purposes
-        #puts "#{token} => #{sentiment_value}"
-        
-        sentiment_total += sentiment_value
-      end
+      sentiment_total += sentiment_value if sentiment_value
     end
-
     sentiment_total
   end
 
@@ -93,6 +85,7 @@ class Sentimental
     end
   end
   
+  # Loads the default sentiment files
   def self.load_defaults
     load_senti_file(File.dirname(__FILE__) + '/sentiwords.txt')
     load_senti_file(File.dirname(__FILE__) + '/sentislang.txt')
@@ -109,7 +102,7 @@ class Sentimental
     # load the word file
     file = File.new(filename)
     while (line = file.gets)
-      parsedline = line.chomp.split("\t")
+      parsedline = line.chomp.split(/\s/)
       sentiscore = parsedline[0]
       text = parsedline[1]
       @@sentihash[text] = sentiscore.to_f

data/lib/sentislang.txt

@@ -26,7 +26,7 @@
 -1.0	D:
 -1.0	sux
 1.0	(o;
-1.00	8-)
+1.0	8-)
 1.0	;)
 1.0	;o)
 1.0	%-)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentimental
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -21,11 +21,13 @@ files:
 - lib/sentimental.rb
 - lib/sentislang.txt
 - lib/sentiwords.txt
+- README.md
 homepage: https://github.com/7compass/sentimental
 licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
+- .
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false