smiley 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e53eb3600742e6708e0987d6954b862148881b3
+  data.tar.gz: b8d7c96b8f6f06bd42e27fc2da96fd7f436e2a59
+SHA512:
+  metadata.gz: 54597c0a81fc9a507d34c775e95a794915599a6b7c32d0423ed98dd4331809220670a8e60866b72abc28608f02135e358ed29b2696bb6a63d5044111a9193e75
+  data.tar.gz: 7cb39ed9a5dddb841ec5ed71ee6aaf14feca8ab9036dec878cd6ed9c3a5a4496dfa4a3dd7c7e899a839761cc90261717bca3cb96e0323aa4961be98e85690143

data/Gemfile

@@ -1,6 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-group :development, :test do
-  gem 'rspec'
-  gem 'rake'
-end
+gemspec

data/Gemfile.lock

@@ -1,20 +1,27 @@
+PATH
+  remote: .
+  specs:
+    smiley (0.1.0)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
-    rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    diff-lcs (1.2.1)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  rake
-  rspec
+  rake (~> 10.0)
+  rspec (~> 2.13.0)
+  smiley!

data/README.md

@@ -0,0 +1,91 @@
+[![Code Climate](https://codeclimate.com/github/iGEL/smiley.png)](https://codeclimate.com/github/iGEL/smiley) 
+[![Build Status](https://travis-ci.org/iGEL/smiley.png?branch=master)](https://travis-ci.org/iGEL/smiley) 
+(Tested: Ruby 2.0.0, 1.9.3, 1.9.2, 1.8.7, Rubinius, Jruby)
+
+Smiley
+======
+
+This is a small library to pass text emoticons like into cute smiley images your users will like. To be more accurate,
+this lib will parse them into `<em class="smiley smiley-grin></em>`, which you can style with css to show the smiley
+image. This way, you can use [CSS sprites](http://css-tricks.com/css-sprites/) to make them load faster.
+
+Usage
+=====
+
+First, configure the smileys you want to have converted in a yml file. If you use this lib with Ruby on Rails, the 
+default position for this file is in `config/smileys.yml`.
+
+```yml
+cool:
+  tokens: ':cool: 8-) 8)'
+cry:
+  tokens: ":&#x27;( ;( :&#x27;-(" # HTML escaped, since we work in the escaped form
+grin:
+  tokens: ':-D :D'
+```
+
+You can configure multiple forms for the same smiley. In this example, `:cool:`, `8-)` and `8)` will all produce
+the same smiley.
+
+Next, pass your string through `smiley`. If you're inside of Rails, `smiley` will escape html unsafe Strings and
+mark the result as html safe. Remember to do it yourself if you use the lib outside of Rails.
+
+Helper:
+```ruby
+def smileys(str)
+  Smiley.new.parse(str)
+end
+```
+Haml:
+```haml
+.post
+  = smileys("Wow, they're alive :cool: :D")
+```
+
+The last step is to setup the CSS, so the images will be displayed.
+
+SCSS:
+```scss
+.smiley { // All smileys have this class
+  display: inline-block;
+  width: 15px;
+  height: 15px;
+  background: image-url('smileys/sprite.png');
+}
+.smiley-cool {
+  background: image-url('smileys/cool.gif'); // animated
+}
+.smiley-cry {
+  background-position: 0 0;
+}
+.smiley-grin {
+  width: 20px;
+  background-position: 0 -15px;
+}
+```
+
+Configuration
+=============
+
+So far, `smiley` has these configuration options:
+
+```ruby
+# The prefix for the CSS class, e.g. smiley in smiley-grin, defaults to smiley
+Smiley.each_class_prefix = 'icons'
+
+# The CSS class that is added to all smileys, defaults to smiley
+Smiley.all_class = 'emoji'
+
+# defaults to :dashed, meaning class names like smiley-big-grin
+# :camel-case will generate class names like smileyBigGrin, :snake_case like smiley_big_grin
+Smiley.css_class_style = :camel_case
+
+# YAML file with the smiley definition. Default in Rails is config/smileys.yml
+# No default if not used with Rails
+Smiley.smiley_file = 'data/smileys.yml'
+```
+
+License
+=======
+
+MIT (see `MIT-LICENSE`)

data/lib/smiley.rb

@@ -1,37 +1,102 @@
 require 'yaml'
 
 class Smiley
+  VALID_CSS_CLASS_STYLES = [:dashed, :snake_case, :camel_case]
+
+  def self.all_class
+    defined?(@@all_class) ? @@all_class : 'smiley'
+  end
+
+  def self.all_class=(klass)
+    @@all_class = klass
+  end
+
+  def self.each_class_prefix
+    defined?(@@each_class_prefix) ? @@each_class_prefix : 'smiley'
+  end
+
+  def self.each_class_prefix=(klass)
+    @@each_class_prefix = klass
+  end
+
   def self.smiley_file=(file)
     @@smiley_file = file
   end
 
+  def self.css_class_style
+    defined?(@@css_class_style) ? @@css_class_style : :dashed
+  end
+
+  def self.css_class_style=(style)
+    unless VALID_CSS_CLASS_STYLES.include?(style.to_sym)
+      raise "Invalid css class style #{style}. You can choose between :dashed, :snake_case and :camel_case"
+    end
+    @@css_class_style = style.to_sym
+  end
+
   def self.smiley_file
-    return @@smiley_file if defined?(@@smiley_file)
-    return File.join(Rails.root, "config", "smileys.yml") if defined?(Rails) && Rails.respond_to?(:root)
-    nil
+    if defined?(@@smiley_file)
+      return @@smiley_file
+    elsif defined?(Rails) && Rails.respond_to?(:root)
+      return File.join(Rails.root, 'config', 'smileys.yml')
+    end
   end
 
   def parse(text)
-    load_smileys
-
-    text.gsub(@@regex) do
-      %(#{$1}<em class="smiley smiley-#{@@smileys[$2].downcase}"></em>#{$3})
+    text = h(text).gsub(self.class.regex) do
+      %(#{$1}<em class="#{css_class(self.class.smileys[$2])}"></em>#{$3})
     end
+
+    text.respond_to?(:html_safe) ? text.html_safe : text
   end
 
   private
-  def load_smileys
-    unless defined?(@@smileys) && defined?(@@regex)
-      @@smileys = {}
-      @@regex = []
-      YAML.load(File.read(Smiley.smiley_file)).each do |smiley, options|
-        options["tokens"].split(/\s+/).each do |token|
-          @@smileys[token] = smiley
-          @@regex << Regexp.escape(token)
-        end
+  def h(str)
+    if defined?(ERB::Utils) && ERB::Utils.respond_to?(:html_escape)
+      ERB::Utils.html_escape(str).to_str
+    else
+      str.to_str
+    end
+  end
+
+  def css_class(smiley)
+    out = "#{self.class.all_class} #{self.class.each_class_prefix}-#{smiley}"
+    case self.class.css_class_style
+    when :camel_case
+      camelize(out)
+    when :snake_case
+      underscore(out)
+    else
+      out
+    end
+  end
+
+  def camelize(str)
+    str.gsub(/-([a-z])/) { $1.upcase }
+  end
+
+  def underscore(str)
+    str.gsub('-', '_')
+  end
+
+  def self.smileys
+    return @@smileys if  defined?(@@smileys)
+
+    @@smileys = {}
+    YAML.load(File.read(Smiley.smiley_file)).each do |smiley, options|
+      options['tokens'].split(/\s+/).each do |token|
+        @@smileys[token] = smiley
       end
-      before_and_after = "[.,;:!\\?\\(\\[\\{\\)\\]\\}\\-]|\\s"
-      @@regex = Regexp.compile "(^|#{before_and_after})(" + @@regex.join("|") + ")(#{before_and_after}|$)"
     end
+    @@smileys
+  end
+
+  def self.regex
+    return @@regex if defined?(@@regex)
+
+    before_and_after = "[.,;:!\\?\\(\\[\\{\\)\\]\\}\\-]|\\s"
+    @@regex = Regexp.compile("(^|#{before_and_after})(" +
+            smileys.keys.map { |token| Regexp.escape(token) }.join("|") +
+            ")($|#{before_and_after})", Regexp::MULTILINE)
   end
 end

data/spec/smiley_spec.rb

@@ -2,66 +2,157 @@ require 'spec_helper'
 require 'smiley'
 
 describe Smiley do
-  describe '.smiley_file' do
+  subject(:smiley) { described_class.new }
+
+
+  after do
+    described_class.class_eval do
+      remove_class_variable :@@all_class if class_variable_defined?(:@@all_class)
+      remove_class_variable :@@each_class_prefix if class_variable_defined?(:@@each_class_prefix)
+      remove_class_variable :@@css_class_style if class_variable_defined?(:@@css_class_style)
+      remove_class_variable :@@smiley_file if class_variable_defined?(:@@smiley_file)
+    end
+  end
+
+  describe '.all_class' do
     before do
-      Smiley.class_eval do
-        remove_class_variable :@@smiley_file if class_variable_defined?(:@@smiley_file)
-      end
+      described_class.smiley_file = File.join(File.dirname(__FILE__), "smileys.yml")
+    end
+
+    it 'defaults to smiley' do
+      expect(described_class.all_class).to eq('smiley')
+    end
+
+    it 'returns the configured value' do
+      described_class.all_class = 'funnyIcon'
+
+      expect(described_class.all_class).to eq('funnyIcon')
+    end
+  end
+
+  describe '.each_class_prefix' do
+    it 'defaults to smiley' do
+      expect(described_class.each_class_prefix).to eq('smiley')
     end
 
-    after do
-      Object.send(:remove_const, :Rails) if defined?(Rails)
+    it 'returns the configured value' do
+      described_class.each_class_prefix = 'funnyIcon'
+
+      expect(described_class.each_class_prefix).to eq('funnyIcon')
     end
+  end
 
-    it "should return the value configured" do
-      Smiley.smiley_file = "/etc/smileys.yml"
+  describe '.smiley_file' do
+    it 'returns the configured value' do
+      described_class.smiley_file = '/etc/smileys.yml'
 
-      Smiley.smiley_file.should == "/etc/smileys.yml"
+      expect(described_class.smiley_file).to eq('/etc/smileys.yml')
     end
 
-    it "should return nil, if not configured" do
-      Smiley.smiley_file.should be_nil
+    it 'returns nil, if not configured' do
+      expect(described_class.smiley_file).to be_nil
     end
 
-    it "should return \#{Rails.root}/config/smileys.yml, if Rails.root is defined" do
-      Rails = double("Rails")
-      Rails.stub(:root) { "/home/igel/dev/example.com/" }
+    it 'return \#{Rails.root}/config/smileys.yml, if Rails.root is defined"' do
+      rails = double('Rails')
+      stub_const('Rails', rails)
+      rails.stub(:root) { '/home/igel/dev/example.com/' }
 
-      Smiley.smiley_file.should == "/home/igel/dev/example.com/config/smileys.yml"
+      expect(described_class.smiley_file).to eq('/home/igel/dev/example.com/config/smileys.yml')
+    end
+  end
+
+  describe '.css_class_style' do
+    it 'defaults to dashed' do
+      expect(described_class.css_class_style).to eq(:dashed)
+    end
+
+    it 'returns :snake_case if configured' do
+      described_class.css_class_style = :snake_case
+
+      expect(described_class.css_class_style).to eq(:snake_case)
+    end
+
+    it 'returns :camel_case if configured' do
+      described_class.css_class_style = :camel_case
+
+      expect(described_class.css_class_style).to eq(:camel_case)
+    end
+
+    it 'raises an error if an invalid value is given' do
+      expect { described_class.css_class_style = :strike_through }.to raise_error
     end
   end
 
   describe '#parse' do
     before do
-      Smiley.smiley_file = File.join(File.dirname(__FILE__), "smileys.yml")
+      described_class.smiley_file = File.join(File.dirname(__FILE__), 'smileys.yml')
     end
 
-    it "should parse a smiley" do
-      Smiley.new.parse('That is so funny! :-) Will tell my grandma about that!').should == 'That is so funny! <em class="smiley smiley-smile"></em> Will tell my grandma about that!'
+    it 'parses a smiley' do
+      expect(smiley.parse('That is so funny! :-) Will tell my grandma about that!')).to eq('That is so funny! <em class="smiley smiley-smile"></em> Will tell my grandma about that!')
     end
 
-    it "should work with alternative forms" do
-      Smiley.new.parse("That's so funny! :P Will tell my grandma about that :rolleyes: ").should == %(That's so funny! <em class="smiley smiley-razz"></em> Will tell my grandma about that <em class="smiley smiley-rolleyes"></em> )
+    it 'works with alternative forms' do
+      expect(smiley.parse("That's so funny! :P Will tell my grandma about that :rolleyes: ")).to eq(%(That's so funny! <em class="smiley smiley-razz"></em> Will tell my grandma about that <em class="smiley smiley-rolleyes"></em> ))
     end
 
-    it "should parse smileys at the beginning and end of a string" do
-      Smiley.new.parse(":D So funny! ;-)").should == %(<em class="smiley smiley-grin"></em> So funny! <em class="smiley smiley-wink"></em>)
+    it 'parses smileys at the beginning and end of a string' do
+      expect(smiley.parse(':D So funny! ;-)')).to eq(%(<em class="smiley smiley-grin"></em> So funny! <em class="smiley smiley-wink"></em>))
     end
 
-    it "should parse smileys at the beginning and end of a line" do
-      Smiley.new.parse("\n:D So funny! ;-)\n").should == %(\n<em class="smiley smiley-grin"></em> So funny! <em class="smiley smiley-wink"></em>\n)
+    it 'parses smileys at the beginning and end of a line' do
+      expect(smiley.parse("\n:D So funny! ;-)\n")).to eq(%(\n<em class="smiley smiley-grin"></em> So funny! <em class="smiley smiley-wink"></em>\n))
     end
 
-    it "should parse smileys after and before a comma, a dot, a question or exclamation mark, a semicolon, a colon, or a dash" do
-      Smiley.new.parse("before: ,;-) .:-) ?:-) !;-) ;:D ::rolleyes: -:P\nafter: ;-), :-). :-)? ;-)! :D; :rolleyes:: :P-").should == %(before: ,<em class="smiley smiley-wink"></em> .<em class="smiley smiley-smile"></em> ?<em class="smiley smiley-smile"></em> !<em class="smiley smiley-wink"></em> ;<em class="smiley smiley-grin"></em> :<em class="smiley smiley-rolleyes"></em> -<em class="smiley smiley-razz"></em>\nafter: <em class="smiley smiley-wink"></em>, <em class="smiley smiley-smile"></em>. <em class="smiley smiley-smile"></em>? <em class="smiley smiley-wink"></em>! <em class="smiley smiley-grin"></em>; <em class="smiley smiley-rolleyes"></em>: <em class="smiley smiley-razz"></em>-)
+    it 'parses smileys after and before a comma, a dot, a question or exclamation mark, a semicolon, a colon, or a dash' do
+      expect(smiley.parse("before: ,;-) .:-) ?:-) !;-) ;:D ::rolleyes: -:P\nafter: ;-), :-). :-)? ;-)! :D; :rolleyes:: :P-")).to eq(%(before: ,<em class="smiley smiley-wink"></em> .<em class="smiley smiley-smile"></em> ?<em class="smiley smiley-smile"></em> !<em class="smiley smiley-wink"></em> ;<em class="smiley smiley-grin"></em> :<em class="smiley smiley-rolleyes"></em> -<em class="smiley smiley-razz"></em>\nafter: <em class="smiley smiley-wink"></em>, <em class="smiley smiley-smile"></em>. <em class="smiley smiley-smile"></em>? <em class="smiley smiley-wink"></em>! <em class="smiley smiley-grin"></em>; <em class="smiley smiley-rolleyes"></em>: <em class="smiley smiley-razz"></em>-))
     end
 
-    it "should parse smileys after and before round, box or curly brackets" do
-      Smiley.new.parse(%! (:-)) [:-)] {:-)} !).should == %! (<em class="smiley smiley-smile"></em>) [<em class="smiley smiley-smile"></em>] {<em class="smiley smiley-smile"></em>} !
+    it 'parses smileys after and before round, box or curly brackets' do
+      expect(smiley.parse(' (:-)) [:-)] {:-)} ')).to eq(' (<em class="smiley smiley-smile"></em>) [<em class="smiley smiley-smile"></em>] {<em class="smiley smiley-smile"></em>} ')
+    end
+
+    it "doesn't parse smileys directly before or after a word" do
+      expect(smiley.parse(' :-)word:-) ')).to eq(' :-)word:-) ')
+    end
+
+    it 'uses the configured all_class and each_class_prefix' do
+      described_class.all_class = 'funny-icon'
+      described_class.each_class_prefix = 'smiley-image'
+
+      expect(smiley.parse(':-)')).to eq('<em class="funny-icon smiley-image-smile"></em>')
     end
 
-    it "should not parse smileys directly before or after a word" do
-      Smiley.new.parse(" :-)word:-) ").should == " :-)word:-) "
+    it 'uses snake_case for the CSS class if configured' do
+      described_class.css_class_style = :snake_case
+      described_class.all_class = 'funny_icon'
+      described_class.each_class_prefix = 'smiley_image'
+
+      expect(smiley.parse(':-)')).to eq('<em class="funny_icon smiley_image_smile"></em>')
+    end
+
+    it 'uses CamelCase for the CSS class if configured' do
+      described_class.css_class_style = :camel_case
+      described_class.all_class = 'funnyIcon'
+      described_class.each_class_prefix = 'smileyImage'
+
+      expect(smiley.parse(':-)')).to eq('<em class="funnyIcon smileyImageSmile"></em>')
+    end
+
+    it 'uses ERB::Utils.html_escape if available' do
+      erb_utils = double('ERB::Utils')
+      stub_const('ERB::Utils', erb_utils)
+
+      erb_utils.should_receive(:html_escape).with('<script>alert("Hacked!")</script>').and_return('&lt;script&gt;alert(&quot;Hacked!&quot;)&lt;/script&gt;')
+      
+      smiley.parse('<script>alert("Hacked!")</script>')
+    end
+
+    it 'marks the String as HTML safe, if that method is available' do
+      String.any_instance.should_receive(:html_safe)
+
+      smiley.parse(':-)')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,62 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: smiley
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Johannes Barre
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 2
-        - 10
-        - 0
-        version: 2.10.0
+      - !ruby/object:Gem::Version
+        version: 2.13.0
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 description: 
 email: igel@igels.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- README.md
 - MIT-LICENSE
 - Rakefile
 - Gemfile
@@ -66,39 +54,27 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/igel/smiley
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A small lib to parse smileys. Use CSS to display them!
-test_files: 
+test_files:
 - spec/smiley_spec.rb
 - spec/spec_helper.rb