sentimental 1.0.4 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGEzZGRjMmQ3NDk2Y2NlMzYwNWRkZWU2OTZmNzI1YTlmNmRiMGFiOQ==
+    NTM5MTBkMzdiNWY0NzdiYzliOWJlZWNmZDIyMzVjMDM1ZWJjNDYxYw==
   data.tar.gz: !binary |-
-    NDAxMDFmNzZlMTQ3M2RmZGMzN2U4MjQwOGIzYTYyNDg0NzYzZWNjYQ==
+    NTVlYWNhNDIxZmE3ZDUyZjQ4N2ZlMGYxYWY0NzYxYmIxYWY2ZDZjNg==
 SHA512:
   metadata.gz: !binary |-
-    MjgzZDQ0MTFjOGM0Y2ZjZjAwYjg1NTlhOTRjMTZlZTM2ODkwMjY2MDFjYWU0
-    ZjNlNDA4NGM3NThiZmEwNjRkYWQ5YWZiZDE1YjM2OGZjYzJiMTM2NDMxZmNl
-    OTdmNGNhOTBjMjFmZjkxNmRhYjc4MDg5YWZmZjY1YjdjMDczOGI=
+    YjM0OTc1MzYyMDdlMmYyMWIyOTgwNmYyYThiMDhjZjkzMDFkYmFiNGNjYjBl
+    OWY3Zjg1NmFkZTgxY2YzY2I2OGMxZjBhNzhlZjEwNjkzNDQxNTRhNTQxYzFj
+    Yjc2NDBmZjk0OWZkYTc3ODMyMjFjN2RlY2FjMDFlNWMzMjRhM2M=
   data.tar.gz: !binary |-
-    YjRhNzA3ZmJhOTdmMzIzMTU1MzcyM2ZlYThhOTM4MzdmYThhYzc0NDUxNTNm
-    ZjM4MzBjMmE3Y2E2YTlmOTgyZjc3N2E2MTcxOTgxOWQ5ZmE4MTlhNTkwYzI5
-    NTI0ZmVjNGY3MTFhNmFjMmUyYmQwOWVkZjcwYzg0NGM2NWQwNWU=
+    Nzg5YzMwMjM3MjU3YzJhOTU4NGIzN2NkZTY4ZjhkMGVmOWY5ZjcyNmMxYzdm
+    YzlkOGM5MDNhMzBiMjhkMmIyZThiMzAxYzA3Y2UxYTc2N2JlYmMzODE3MDFk
+    MDhhZjkwYTNmMGU1NDE1MTY0ZDUzNGZkYmRmM2JkMzVjM2M3Y2Y=

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    sentimental (1.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  rspec (>= 3.0.0)
+  sentimental!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+Copyright © 2015 Jeff Emminger <jeff@7compass.com>
+
+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

@@ -73,6 +73,10 @@ scores and tokens, e.g.:
 
     gem install sentimental
 
+## License
+
+MIT License
+
 ## Credits
 
 Based largely on Christopher MacLellan's script:

data/Rakefile

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

data/lib/sentimental.rb

@@ -1,116 +1,52 @@
-
-# Based on code from https://github.com/cmaclell/Basic-Tweet-Sentiment-Analyzer
-
-
-#############################################################################
-# Copyright: Christopher MacLellan 2010
-# Description: This code adds functions to the string class for calculating
-#              the sentivalue of strings. It is not called directly by the
-#              tweet-search-sentiment.rb program but is included for possible
-#              future use.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#############################################################################
-
-#
-# In an initializer, you can initialize some global defaults:
-#
-#   Sentimental.load_defaults
-#   Sentimental.threshold = 0.1
-#
-# Then create an instance for usage:
-#
-#   analyzer = Sentimental.new
-#   analyzer.get_sentiment('I love your service')
-#   => :positive
-#
-# You can make new analyzers with individual thresholds:
-#
-#   analyzer = Sentimental.new(0.9)
-#   analyzer.get_sentiment('I love your service')
-#   => :positive
-#   analyzer.get_sentiment('I like your service')
-#   => :neutral
-#
 class Sentimental
-  @@sentihash = Hash.new(0.0)
-  @@threshold = 0.0
+  attr_accessor :threshold, :word_scores, :neutral_regexps
 
-  def initialize(threshold = nil)
-    @threshold = threshold || @@threshold
+  def initialize(threshold: 0, word_scores: nil, neutral_regexps: [])
+    @word_scores = Hash.new(0.0) || word_scores
+    @threshold = threshold
+    @neutral_regexps = neutral_regexps
   end
 
-  #####################################################################
-  # Function that returns the sentiment value for a given string.
-  # This value is the sum of the sentiment values of each of the words.
-  # Stop words are NOT removed.
-  #
-  # return:float -- sentiment value of the current string
-  #####################################################################
-  def get_score(string)
-    sentiment_total = 0.0
+  def score(string)
+    return 0 if neutral_regexps.any? {|regexp| string =~ regexp}
 
-    #tokenize the string, also throw away some punctuation
-    tokens = string.to_s.downcase.split(/\W*\s+\W*|^\W+|\W+$/)
-
-    tokens.each do |token|
-      sentiment_total += @@sentihash[token]
+    extract_words(string).inject(0) do |score, token| 
+      score += word_scores[token]
     end
-    sentiment_total
   end
 
-  def get_sentiment(string)
-    score = get_score(string)
+  def sentiment(string)
+    score = score(string)
 
-    # if less then the negative threshold classify negative
-    if score < (-1 * @threshold)
+    if score < (-1 * threshold)
       :negative
-    # if greater then the positive threshold classify positive
-    elsif score > @threshold
+    elsif score > threshold
       :positive
     else
       :neutral
     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')
+  def load_defaults
+    ['sentiwords', 'sentislang'].each do |filename|
+      load_senti_file(File.dirname(__FILE__) + "/../data/#{filename}.txt")
+    end
   end
 
-  #####################################################################
-  # load the specified sentiment file into a hash
-  #
-  # filename:string -- name of file to load
-  # sentihash:hash -- hash to load data into
-  # return:hash -- hash with data loaded
-  #####################################################################
-  def self.load_senti_file(filename)
-    # load the word file
-    file = File.new(filename)
-    while (line = file.gets)
-      parsedline = line.chomp.split(/\s/)
-      sentiscore = parsedline[0]
-      text = parsedline[1]
-      @@sentihash[text] = sentiscore.to_f
+  def load_senti_file(filename)
+    File.open(filename) do |file|
+      file.each_line do |line|
+        parsed_line = line.chomp.split(/\s+/)
+        sentiscore = parsed_line[0]
+        text = parsed_line[1]
+        word_scores[text] = sentiscore.to_f
+      end
     end
-    file.close
   end
 
-  def self.threshold=(threshold)
-    @@threshold = threshold
-  end
+  private
 
+  def extract_words(string)
+    string.to_s.downcase.scan(/([\w']+|\S{2,})/).flatten
+  end
 end

data/sentimental.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name         = 'sentimental'
+  spec.version      = '1.1.0'
+  spec.summary      = 'Simple sentiment analysis'
+  spec.description  = 'A simple sentiment analysis gem'
+  spec.authors      = ['Jeff Emminger', 'Christopher MacLellan', 'Denis Pasin']
+  spec.email        = ['jeff@7compass.com', 'denis@hellojam.fr']
+  spec.homepage     = 'https://github.com/7compass/sentimental'
+  spec.license      = 'MIT'
+  
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/spec/sentimental_spec.rb

@@ -0,0 +1,72 @@
+require_relative "../lib/sentimental"
+
+describe Sentimental do
+
+  before :each do
+    analyzer.load_defaults
+  end
+
+  let(:analyzer) { Sentimental.new(threshold: 0.1) }
+
+  describe "#score" do
+    subject do
+      analyzer.score(text)
+    end
+
+    context "when the text is postive" do
+      let(:text) {'I love ruby'}
+
+      it 'returns a positive score' do
+        expect(subject).to be > 0
+      end
+    end
+
+    context "when the text is neutral" do
+      let(:text) {'I like ruby'}
+
+      it 'returns a neutral score' do
+        expect(subject).to eq 0
+      end
+    end
+
+    context "when the text is negative" do
+      let(:text) {'I hate ruby'}
+
+      it 'returns a negative score' do
+        expect(subject).to be < 0
+      end
+    end
+
+    context "when the text has smiley" do
+      let(:text) {'I love ruby'}
+      let(:text_with_smiley) {'I love ruby :-)'}
+
+      it 'scores it' do
+        expect(analyzer.score(text_with_smiley)).to be > analyzer.score(text)
+      end
+    end
+
+    context "when the text has punctuation" do
+      let(:text) {'I love ruby'}
+      let(:text_with_punctuation) {'I love, ruby'}
+
+      it 'removes it' do
+        expect(analyzer.score(text_with_punctuation)).to eq analyzer.score(text)
+      end
+    end
+
+    context "when there is some neutral regexp" do
+      let(:text_neutral) {"Do you love ruby?"}
+      let(:text) {"I love ruby"}
+
+      before do
+        analyzer.neutral_regexps << /\?\s*$/
+      end
+
+      it "scores it to 0" do
+        expect(analyzer.score(text_neutral)).to eq 0
+        expect(analyzer.score(text)).not_to eq 0
+      end
+    end
+  end
+end

metadata

@@ -1,26 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: sentimental
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeff Emminger
 - Christopher MacLellan
+- Denis Pasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
-dependencies: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A simple sentiment analysis gem
-email: jeff@7compass.com
+email:
+- jeff@7compass.com
+- denis@hellojam.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- data/sentislang.txt
+- data/sentiwords.txt
 - lib/sentimental.rb
-- lib/sentislang.txt
-- lib/sentiwords.txt
+- sentimental.gemspec
+- spec/sentimental_spec.rb
 homepage: https://github.com/7compass/sentimental
 licenses:
 - MIT
@@ -28,7 +80,6 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- .
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
@@ -46,4 +97,5 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple sentiment analysis
-test_files: []
+test_files:
+- spec/sentimental_spec.rb