quesadilla 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46c4870ebc2332f165ba715f3765a9407f22f247
-  data.tar.gz: fc7da4a6eba9dc99ac253abaefe6434f955ec6dd
+  metadata.gz: 70dc2e9472fde307002d6826fc06e0d2d316e00b
+  data.tar.gz: f8ef3bceef62a578e65a846b03cdb4d3348d71ee
 SHA512:
-  metadata.gz: 9dfada0f0d96994a6228a6e416ecb588d77075ea9cf2b5d098d065f130abc390968de9c9e62e7cad94c0f79b809243f54a0a24de2082568461cfc621bbfdd767
-  data.tar.gz: 4609a722036391bec45d1d24590c76a47bd72dc8dbaa76ae788b98dbc888e34ef2b18f30a6fe277e342f90cb5565bed83c550e98fc11aa1e561026842775f875
+  metadata.gz: a325502695825843f55530bc6b61e72b9428103b45a5d75a1a1b098e84b5bdf525a9d330ddc09db60baafa41dd11f912d85dc74f2001eafe01fe6378c8020640
+  data.tar.gz: e9fafa4a7fd9d679e192286beaa837dd9ec9d2c1de64beeebdcada523a3bcf6d5a20135c8f7d50fa1bb72d41eb02abc487d7bb2def1d9d9baeebebb733caa9ca

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 bundler_args: --without development
 rvm:
+  - 1.9.2
   - 1.9.3
   - 2.0.0
   - jruby-19mode
+  - rbx-19mode

data/Readme.markdown

@@ -60,6 +60,7 @@ Option                      | Description
 `:markdown_emphasis`        | Markdown italic
 `:markdown_strikethrough`   | Markdown Extra strikethrough
 `:hashtags`                 | Hashtags
+`:hashtags_validator`           | Callable object to validate hashtags
 `:autolinks`                | Automatically detect links
 `:emoji`                    | GitHub-style named emoji
 `:users`                    | User mentions
@@ -93,7 +94,7 @@ extraction = Quesadilla.extract('Some #awesome text', html_renderer: CustomRende
 extraction[:display_html] #=> 'Some <a href="http://example.com/tags/awesome" class="tag">#awesome</a> text'
 ```
 
-Take a look at [Quesadilla::HTMLRenderer](lib/quesadilla/html_renderer.html) for more details on creating a custom renderer.
+Take a look at [Quesadilla::HTMLRenderer](lib/quesadilla/html_renderer.rb) for more details on creating a custom renderer.
 
 ### Users
 
@@ -112,7 +113,7 @@ Assuming there is a user named `soffes` in your database, it would extract `@sof
 
 ## Supported Ruby Versions
 
-Quesadilla is tested under 1.9.3, 2.0.0, and JRuby (1.9 mode).
+Quesadilla is tested under 1.9.2, 1.9.3, 2.0.0, JRuby 1.7.2 (1.9 mode), and Rubinius 2.0.0 (1.9 mode).
 
 [![Build Status](https://travis-ci.org/soffes/quesadilla.png?branch=master)](https://travis-ci.org/soffes/quesadilla)
 

data/lib/quesadilla.rb

@@ -31,7 +31,7 @@ module Quesadilla
 module_function
 
   # Extract entities from text
-  # @param text the text to extract
+  # @param text [String] the text to extract
   # @option options markdown_code [Boolean] Should extract Markdown code. Defaults to `true`.
   # @option options markdown_links [Boolean] Should extract Markdown links. Defaults to `true`.
   # @option options markdown_triple_emphasis [Boolean] Should extract Markdown triple emphasis (bold italic). Defaults to `true`.
@@ -39,8 +39,11 @@ module_function
   # @option options markdown_emphasis [Boolean] Should extract Markdown emphasis (italic). Defaults to `true`.
   # @option options markdown_strikethrough [Boolean] Should extract Markdown strikethrough. Defaults to `true`.
   # @option options hashtags [Boolean] Should extract hashtags. Defaults to `true`.
+  # @option options hashtag_validator A callable object to validate a hashtag. This should return `true` or `false`. Invalid hashtags will be left as plain text. If the validator is `nil`, all hashtags will be extracted. Defaults to `nil`.
   # @option options autolinks [Boolean] Should automatically detect links. Defaults to `true`.
   # @option options emoji [Boolean] Should extract named emoji. Defaults to `true`.
+  # @option options users [Boolean] Should extract user mentions. Defaults to `false`.
+  # @option options user_validator A callable object to validate a username. This should return the user ID of the user or nil if it is invalid. Invalid users will be left as plain text. If the validator is nil, all usernames will be extracted. Defaults to `nil`.
   # @option options html [Boolean] Should generate HTML. Defaults to `true`.
   # @option options html_renderer [Class] class to use as HTML renderer. Defaults to `Quesadilla::HTMLRenderer`.
   # @return [Hash] hash containing the display text, html text, and entities

data/lib/quesadilla/extractor.rb

@@ -24,6 +24,7 @@ module Quesadilla
         markdown_emphasis: true,
         markdown_strikethrough: true,
         hashtags: true,
+        hashtag_validator: nil,
         autolinks: true,
         emoji: true,
         users: false,
@@ -42,10 +43,11 @@ module Quesadilla
     # @option options markdown_emphasis [Boolean] Should extract Markdown emphasis (italic). Defaults to `true`.
     # @option options markdown_strikethrough [Boolean] Should extract Markdown strikethrough. Defaults to `true`.
     # @option options hashtags [Boolean] Should extract hashtags. Defaults to `true`.
+    # @option options hashtag_validator A callable object to validate a hashtag. This should return `true` or `false`. Invalid hashtags will be left as plain text. If the validator is `nil`, all hashtags will be extracted. Defaults to `nil`.
     # @option options autolinks [Boolean] Should automatically detect links. Defaults to `true`.
     # @option options emoji [Boolean] Should extract named emoji. Defaults to `true`.
     # @option options users [Boolean] Should extract user mentions. Defaults to `false`.
-    # @option options user_validator A callable object to validate a username. This should return the user ID of the user or nil if it is invalid. Invalid users will be left as plain text. If the validator is nil, all usernames will be extracted. Defaults to `nil`.
+    # @option options user_validator A callable object to validate a username. This should return the user ID of the user or nil if it is invalid. Invalid users will be left as plain text. If the validator is `nil`, all usernames will be extracted. Defaults to `nil`.
     # @option options html [Boolean] Should generate HTML. Defaults to `true`.
     # @option options html_renderer [Class] class to use as HTML renderer. Defaults to `Quesadilla::HTMLRenderer`.
     def initialize(options = {})
@@ -54,10 +56,10 @@ module Quesadilla
     end
 
     # Extract entities from text
-    # @param original_text the text to extract from
+    # @param text [String] the text to extract from
     # @return [Hash] hash containing the display text, html text, and entities
-    def extract(original_text)
-      @original_text = original_text.dup
+    def extract(text)
+      @original_text = text.dup
 
       # Emoji colon-syntax
       replace_emoji if @options[:emoji]

data/lib/quesadilla/extractor/hashtags.rb

@@ -12,15 +12,22 @@ module Quesadilla
 
       def extract_hashtags
         Twitter::Extractor::extract_hashtags_with_indices(@working_text).each do |entity|
-          entity_text = "##{entity[:hashtag]}"
+          hashtag = entity[:hashtag]
+
+          # Validate
+          if validator = @options[:hashtag_validator]
+            next unless validator.call(hashtag)
+          end
+
+          display_text = "##{hashtag}"
           @entities << {
             type: ENTITY_TYPE_HASHTAG,
-            text: entity_text,
-            display_text: entity_text,
+            text: display_text,
+            display_text: display_text,
             indices: entity[:indices],
-            hashtag: entity[:hashtag].downcase
+            hashtag: hashtag.downcase
           }
-          @working_text.sub!(entity_text, REPLACE_TOKEN * entity_text.length)
+          @working_text.sub!(display_text, REPLACE_TOKEN * display_text.length)
         end
       end
     end

data/lib/quesadilla/version.rb

@@ -1,4 +1,4 @@
 module Quesadilla
   # Version of the Quesadilla gem
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/quesadilla.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Sam Soffes']
   gem.email         = ['sam@soff.es']
   gem.description   = 'Entity-style text parsing'
-  gem.summary       = gem.description
+  gem.summary       = 'Entity-style text parsing extracted from Cheddar'
   gem.homepage      = 'https://github.com/soffes/quesadilla'
   gem.license       = 'MIT'
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 1.9.2'
 
   # Hashtag and autolink parsing
   gem.add_dependency 'twitter-text', '~> 1.5.0'

data/test/quesadilla/hashtags_test.rb

@@ -48,5 +48,27 @@ module Quesadilla
       }
       assert_equal expected, extraction
     end
+
+    def test_that_it_validates
+      validator = lambda do |hashtag|
+        hashtag == 'awesome'
+      end
+      extraction = extract('A task with some #tags that are #awesome', hashtag_validator: validator)
+      expected = {
+        display_text: 'A task with some #tags that are #awesome',
+        display_html: 'A task with some #tags that are <a href="#hashtag-awesome" class="hashtag">#awesome</a>',
+        entities: [
+          {
+            type: 'hashtag',
+            text: '#awesome',
+            display_text: '#awesome',
+            hashtag: 'awesome',
+            indices: [32, 40],
+            display_indices: [32, 40]
+          }
+        ]
+      }
+      assert_equal expected, extraction
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quesadilla
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter-text
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -96,7 +96,7 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: Entity-style text parsing
+summary: Entity-style text parsing extracted from Cheddar
 test_files:
 - test/quesadilla/autolink_test.rb
 - test/quesadilla/emoji_test.rb