emotidragon 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+.rspec

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    emotidragon (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  emotidragon!
+  rspec

data/README.md

@@ -0,0 +1,88 @@
+# Emotidragon: Emoticons! ROAR!
+
+Emotidragon acts on String objects to help ruby devs work with emoticons, what can you do: 
+
+ * get an array of all emoticons
+ * get an array of just positive/negative emoticons
+ * get sentiment of the text based on emoticons
+ * determine if string contains an emoticon
+ * determine if string contains just positive/negative emoticon
+ * get number of emoticons
+ * get number of positive/negative emoitcons
+ * get sentiment of text based on sentiment of emoticons
+ * get an informative hash of sentiment, number of positive emoticons, number of negative emoticons,and difference between the number of emoticons
+
+## I always wanted to ride a dragon myself, so I decided to do this for a year in my imagination.
+
+Use RubyGems to install emotidragon
+
+    $ gem install emotidragon 
+
+## What can I do? Remember, emotidragon gets included into String class, so you can call methods on an instance of String
+
+## Method List
+### emoticons - get array of all emoticons
+    "I love science :). I hate nickelback :(".emoticions
+    -> [":)", ":("]
+
+### positive_emoticons - get array of positive emoticons
+    "I love science :). I hate nickelback :(".positive_emoticions
+    -> [":)"]
+
+### negative_emoticons - get array of negative emoticons
+    "I love science :). I hate nickelback :(".positive_emoticions
+    -> [":("]
+    
+### emoticon? - determine if string contains an emoticon
+    "i love science :). i hate nickelback :(".emoticion?
+    -> true
+
+### positive_emoticon? - determine if string contains positive emoticon
+    "I love science :)".positive_emoticion?
+    -> true
+
+    "I hate nickelback :(".positive_emoticion?
+    -> false
+
+### negative_emoticon? - determine if string contains negative emoticon
+    "I hate nickelback :(".negative_emoticion?
+    -> true
+
+    "I love science :)".negative_emoticion?
+    -> false
+
+### number_of_emoticon - get total number of emoticonss
+    "i love science :). i hate nickelback :(".number_of_emoticons
+    -> 2
+
+### positive_count - get number of positive emoticons
+    "i love science :). i hate nickelback :(".positive_count
+    -> 1
+
+### negative_count - get number of negative emoticons
+    "i love science :). i hate nickelback :(".negative_count
+    -> 1
+
+### text_sentiment - get sentiment of text
+    "I love science :). I hate nickelback :(".text_sentiment
+    -> "neutral
+
+    "I love science :)".text_sentiment
+    -> "positive"
+
+    "I hate nickelback :(".text_sentiment
+    -> "negative"
+
+### sentiment_info - get a hash of information about the text (sentiment, # of positive emoticons, # of negative emoticons, difference)
+    "I love science :). I hate nickelback :(".sentiment_info
+    -> { :sentiment => "neutral", :positive_count => 1, :negative_count => 1, :difference => 0 }
+
+    "I love science :)".sentiment_info
+    -> { :sentiment => "neutral", :positive_count => 1, :negative_count => 0, :difference => 1 }
+
+    "I hate nickelback :(".sentiment_info
+    -> { :sentiment => "neutral", :positive_count => 0, :negative_count => 1, :difference => 1 }
+
+### Dependencies
+
+Just rspec, for science and testing!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/emotidragon.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "emotidragon/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'emotidragon'
+  s.version     = Emotidragon::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Nixon"]
+  s.email       = ['chris@liamneesonsarm.com']
+  s.homepage    = ""
+  s.summary     = %q{Emoticons! ROAR!}
+  s.description = %q{A simple gem to collect an array of, get sentiment about a string based on, determine if a string contains...emoticons}
+
+  s.add_development_dependency "rspec"
+
+  s.rubyforge_project = "emotidragon"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/emotidragon.rb

@@ -0,0 +1,84 @@
+module Emotidragon #http://en.wikipedia.org/wiki/List_of_emoticons
+  POSITIVE_EMOTICONS = /\|?>?[:*;Xx8=]-?o?\^?[DPpb3)}\]>]\)?/
+  NEGATIVE_EMOTICONS = /([:><].?-?[@><cC(\[{\|]\|?|[D][:8;=X]<?|v.v)/
+
+  #gets an array of all matching emoticons in the text
+  def emoticons
+    (positive_emoticons + negative_emoticons)
+  end
+
+  #gets an array of the matching positive emoticons in the text
+  def positive_emoticons
+    self.scan(POSITIVE_EMOTICONS).flatten
+  end
+
+  #gets an array of the matching negative emoticons in the text
+  def negative_emoticons
+    self.scan(NEGATIVE_EMOTICONS).flatten
+  end
+
+  #contains any emoticon?
+  def emoticon?
+    (positive_emoticon? || negative_emoticon?)
+  end
+
+  #checks if the text has a positive emoticon
+  def positive_emoticon?
+    self =~ POSITIVE_EMOTICONS
+  end
+
+  #checks if the text has a negative emoticon
+  def negative_emoticon?
+    self =~ NEGATIVE_EMOTICONS
+  end
+
+  #get total number of emoticons
+  def number_of_emoticons
+    positive_count + negative_count
+  end
+
+  #number of positive emoticons
+  def positive_count
+    positive_emoticons.count
+  end
+
+  #number of negative emoticons
+  def negative_count
+    negative_emoticons.count
+  end
+
+  #sentiment based on emoticons
+  def text_sentiment
+    count = positive_emoticons.count - negative_emoticons.count
+    if count > 0
+      "positive"
+    elsif count < 0
+      "negative"
+    else
+      "neutral"
+    end
+  end
+
+  #gets more info regarding the sentiment of the text
+  def sentiment_info
+    pos_count, neg_count = positive_count, negative_count
+    count = pos_count - neg_count
+    if count > 0
+      Emotidragon.score_hash("positive", pos_count, neg_count, count)
+    elsif count < 0
+      Emotidragon.score_hash("negative", pos_count, neg_count, count)
+    else
+      Emotidragon.score_hash("neutral", pos_count, neg_count, count)
+    end
+  end
+
+  #include Emotidragon into String class
+  String.send(:include, Emotidragon)
+
+  private
+
+  #hash returned that contains information regarding text
+  def self.score_hash(sentiment, pos_count, neg_count, count)
+    { sentiment: sentiment, positive_count: pos_count, negative_count: neg_count, difference: count.abs }
+  end
+end

data/lib/emotidragon/version.rb

@@ -0,0 +1,3 @@
+module Emotidragon
+  VERSION = "1.0.0"
+end

data/spec/emotidragon_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe Emotidragon do
+  let(:positive_string) { 'This is a positive :) string' }
+  let(:negative_string) { 'This is a negative :( string' }
+  let(:neutral_string)  { 'This is a neutral string' }
+  let(:emoticon_string) { 'This contains :) and :( emoticons. :o) :*(' }
+
+  describe '#emoticons' do
+    context 'emoticons present' do
+      it('returns all positive and negative emoticons') { emoticon_string.emoticons.should =~ [':)', ':(', ':o)', ':*('] }
+    end
+    context 'no emoticons' do
+      it('returns empty array') { neutral_string.emoticons.should == [] }
+    end
+  end
+
+  describe '#positive_emoticons' do
+    context 'positive emoticons' do
+      it('returns all positive') { emoticon_string.positive_emoticons.should =~ [':)', ':o)'] }
+    end
+    context 'no positive emoticons, just negative' do
+      it('should not return any negative') { emoticon_string.positive_emoticons.should_not == [':(', ':*('] }
+    end
+    context 'no emoticons' do
+      it('returns empty array') { neutral_string.positive_emoticons.should == [] }
+    end
+  end
+
+  describe '#negative_emoticons' do
+    context 'negative emoticons' do
+      it('returns all negative') { emoticon_string.negative_emoticons.should =~ [':(', ':*('] }
+    end
+    context 'no negative emoticons, just positive' do
+      it('should not return any positive') { emoticon_string.negative_emoticons.should_not == [':)', ':o)'] }
+    end
+    context 'no emoticons' do
+      it('returns empty array') { neutral_string.negative_emoticons.should == [] }
+    end
+  end
+
+  describe '#emoticon?' do
+    context 'both' do
+      it('returns true') { emoticon_string.emoticon?.should be_true }
+    end
+    context 'just positive' do
+      it('returns true') { positive_string.emoticon?.should be_true }
+    end
+    context 'just negative' do
+      it('returns true') { negative_string.emoticon?.should be_true }
+    end
+    context 'neither' do
+      it('returns false') { neutral_string.emoticon?.should be_false }
+    end
+  end
+
+  describe '#positive_emoticon?' do
+    context 'text contains a positive emoticon' do
+      it('returns true') { positive_string.positive_emoticon?.should be_true }
+    end
+    context 'text does not contain a positive emoticon' do
+      it('returns true') { negative_string.positive_emoticon?.should be_false }
+    end
+    context 'neither' do
+      it('returns false') { neutral_string.positive_emoticon?.should be_false }
+    end
+  end
+
+  describe '#negative_emoticon?' do
+    context 'text contains a negative emoticon' do
+      it('returns true') { negative_string.negative_emoticon?.should be_true }
+    end
+    context 'text does not contain a negative emoticon' do
+      it('returns true') { positive_string.negative_emoticon?.should be_false }
+    end
+    context 'neither' do
+      it('returns false') { neutral_string.negative_emoticon?.should be_false }
+    end
+  end
+
+  describe '#number_of_emoticons' do
+    it('returns the count') { emoticon_string.number_of_emoticons.should == 4 }
+    it('returns the count') { positive_string.number_of_emoticons.should == 1 }
+    it('returns the count') { negative_string.number_of_emoticons.should == 1 }
+    it('returns the count') { neutral_string.number_of_emoticons.should == 0 }
+  end
+
+  describe '#positive_count' do
+    context 'text contains positive emoticon' do
+      it('returns the count') { positive_string.positive_count.should == 1 }
+      it('returns the count') { emoticon_string.positive_count.should == 2 }
+    end
+    context 'text does not contain a positive emoticon' do
+      it('returns the count') { neutral_string.positive_count.should == 0 }
+    end
+  end
+
+  describe '#negative_count' do
+    context 'text contains positive emoticon' do
+      it('returns the count') { negative_string.negative_count.should == 1 }
+      it('returns the count') { emoticon_string.negative_count.should == 2 }
+    end
+    context 'text does not contain a positive emoticon' do
+      it('returns the count') { neutral_string.negative_count.should == 0 }
+    end
+  end
+
+  describe '#text_sentiment' do
+    context 'positive' do
+      it('returns "positive"') { positive_string.text_sentiment.should == "positive" }
+    end
+    context 'negative' do
+      it('returns "negative"') { negative_string.text_sentiment.should == "negative" }
+    end
+    context 'neutral' do
+      it('returns "neutral"') { emoticon_string.text_sentiment.should == "neutral" }
+    end
+  end
+
+  describe '#sentiment_info' do
+    context 'positive count' do
+      it 'returns hash containing positive' do
+        positive_string.sentiment_info.should == { sentiment: "positive", positive_count: 1, negative_count: 0, difference: 1 }
+      end
+    end
+    context 'negative count' do
+      it 'returns hash containing negative' do
+        negative_string.sentiment_info.should == { sentiment: "negative", positive_count: 0, negative_count: 1, difference: 1 }
+      end
+    end
+    context 'neutral count' do
+      it 'returns hash containing neutral' do
+        neutral_string.sentiment_info.should == { sentiment: "neutral", positive_count: 0, negative_count: 0, difference: 0 }
+      end
+    end
+  end
+
+  describe '#score_hash' do
+    let(:sentiment)  { "sentiment" }
+    let(:pos_count)  { Random.rand(0...10) }
+    let(:neg_count)  { Random.rand(0...10) }
+    let(:difference) { (pos_count - neg_count).abs }
+    it 'returns hash of what is passed in' do
+      Emotidragon.score_hash(sentiment, pos_count, neg_count, difference).should == { sentiment: sentiment, positive_count: pos_count, negative_count: neg_count, difference: difference }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'emotidragon'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: emotidragon
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Nixon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem to collect an array of, get sentiment about a string based
+  on, determine if a string contains...emoticons
+email:
+- chris@liamneesonsarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- emotidragon.gemspec
+- lib/emotidragon.rb
+- lib/emotidragon/version.rb
+- spec/emotidragon_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: emotidragon
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Emoticons! ROAR!
+test_files:
+- spec/emotidragon_spec.rb
+- spec/spec_helper.rb