hashtag_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c7d5f6c5c41e2d5963e60b8a8491267a0cff44ec509c4e9f0613f002adee10c
+  data.tar.gz: 67347bfead8c1283f28c72853f799315f310aea950e2b35e150a50c3e91feebb
+SHA512:
+  metadata.gz: 7d58badaaac7976181e3c41491363941c030ef8a8892364f300985684653bc13a422bbdcafcc3753c2b80c986ffb0771106171aebbe8af3e6c1a3df1c4822d0e
+  data.tar.gz: 997f35e7ceb0f9b057a292ad3680b92a844fea9efebb99a08ab9ba7545b3f62c28b42802c037d0156084ef6f92d0e62aa9a4be9820ebf82d4a4a586a6f6b1a05

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hashtag_parser.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    hashtag_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.1)
+    minitest (5.14.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  hashtag_parser!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mariano Vallés
+
+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

@@ -0,0 +1,67 @@
+# HashtagParser
+
+[![Build Status](https://travis-ci.org/zucaritask/hashtag_parser.svg?branch=master)](https://travis-ci.org/zucaritask/hashtag_parser)
+
+A hashtag parser that brings the behavior of [hashtag-rs](https://github.com/tonsser/hashtag-rs)
+to ruby and the work of using an Finite State Machine to do the parsing by [davidpdrsn](https://github.com/davidpdrsn)
+
+Given a string as `"#ruby is #awesome"`, this gem returns an array with an object with `text`, `start` and `end`
+for each of the two hashtags in the string.
+
+Its goal is to match Instagram's parsing of hashtags.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hashtag_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hashtag_parser
+
+## Usage
+
+```ruby
+hashtags = HashtagParser.parse("#ruby is #awesome")
+```
+
+`hashtags` is going to be:
+
+```
+[
+  {
+    text: "ruby",
+    start: 0,
+    end: 4
+  },
+  {
+    text: "awesome",
+    start: 9,
+    end: 16
+  }
+]
+```
+## Contact 
+
+Twitter: [@zucaritask](http://twitter.com/zucaritask)
+
+Github: [@zucaritask](http://github.com/zucaritask)
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hashtag_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hashtag_parser.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/hashtag_parser.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hashtag_parser"
+  spec.version       = HashtagParser::VERSION
+  spec.authors       = ["Mariano Vallés"]
+  spec.email         = ["zucaritas@gmail.com"]
+
+  spec.summary       = "Hashtag parser returning start, end and text of each hashtag"
+  spec.description   = "Hashtag parser inspired by https://github.com/tonsser/hashtag-rs/\n"\
+    "Given a string, this gem returns an array with an object with `text`, `start` and `end`.\n"\
+    "Its goal is to match Instagram's parsing of hashtags."
+  spec.homepage      = "https://github.com/zucaritask/hashtag_parser"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/zucaritask/hashtag_parser"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "byebug"
+end

data/lib/hashtag_parser.rb

@@ -0,0 +1,51 @@
+require_relative "./state_machine"
+require_relative "./tokenizer"
+require_relative "./token"
+
+class HashtagParser
+
+  VERSION = "0.1.0"
+
+  def self.parse(text)
+    tokens = Tokenizer.tokenize(text)
+    state_machine = StateMachine.new
+    tokens.each_with_index do |token, index|
+      next_token = tokens[index + 1]
+      index = index - 1 unless token.type == :sos
+
+      case token.type
+      when :sos
+        state_machine.hashtag_incoming if next_token.hashtag?
+      when :hashtag
+        if state_machine.parsing_hashtag?
+          if next_token.end_of_hashtag?
+            state_machine.reset_state
+          else
+            state_machine.hashtag_seen_at(index)
+          end
+        end
+      when :char
+        if state_machine.parsing_hashtag?
+          if token.end_of_hashtag?
+            state_machine.hashtag_finishes_at(index - 1)
+          else
+            state_machine.consume_char(token.char)
+          end
+
+          if next_token.hashtag?
+            state_machine.hashtag_finishes_at(index)
+            state_machine.hashtag_incoming
+          end
+        end
+      when :whitespace
+        state_machine.hashtag_finishes_at(index - 1) if state_machine.parsing_hashtag?
+        state_machine.hashtag_incoming if next_token.hashtag?
+      when :eos
+        if state_machine.parsing_hashtag?
+          state_machine.hashtag_finishes_at(index - 1)
+        end
+      end
+    end
+    state_machine.hashtags
+  end
+end

data/lib/state_machine.rb

@@ -0,0 +1,55 @@
+class StateMachine
+  attr_accessor(
+    :start_index,
+    :parsing_hashtag,
+    :buffer,
+    :hashtags,
+    :consumed_anything
+  )
+
+  def initialize
+    set_initial_defaults
+    @hashtags = []
+  end
+
+  def set_initial_defaults
+    @parsing_hashtag = false
+    @start_index = 0
+    @buffer = []
+    @consumed_anything = false
+  end
+
+  def consume_char(char)
+    buffer << char
+    @consumed_anything = true
+  end
+
+  def hashtag_seen_at(index)
+    @start_index = index
+  end
+
+  def hashtag_incoming
+    @parsing_hashtag = true
+  end
+
+  def hashtag_finishes_at(index)
+    if consumed_anything
+      hashtags.push(
+        {
+          text: buffer.join,
+          start: start_index,
+          end: index
+        }
+      )
+    end
+    reset_state
+  end
+
+  def parsing_hashtag?
+    parsing_hashtag
+  end
+
+  def reset_state
+    set_initial_defaults
+  end
+end

data/lib/token.rb

@@ -0,0 +1,59 @@
+class Token
+  END_OF_HASHTAG_REGEX = /[\\¿¡&%#\s!@$'^&*().,\-<>\/|\[\]{}`~=+;?£€•´:]/
+
+  attr_reader :char, :type, :index
+
+  def initialize(char, index)
+    @index = index
+    case char
+    when "#"
+      @type = :hashtag
+    when " ", "\n", "\r", "\t"
+      @type = :whitespace
+    else
+      @type = :char
+      @char = char
+    end
+  end
+
+  def hashtag?
+    @type == :hashtag
+  end
+
+  def end_of_hashtag?
+    case type
+    when :char
+      END_OF_HASHTAG_REGEX.match?(char)
+    when :hashtag
+      false
+    else
+      true
+    end
+  end
+
+  def as_json
+    {
+      type: type,
+      index: index,
+      char: char
+    }
+  end
+end
+
+class StartOfString < Token
+  def initialize(index)
+    @type = :sos
+    @index = index
+  end
+
+  def end_of_hashtag?
+    false
+  end
+end
+
+class EndOfStringToken < Token
+  def initialize(index)
+    @type = :eos
+    @index = index
+  end
+end

data/lib/tokenizer.rb

@@ -0,0 +1,9 @@
+class Tokenizer
+  def self.tokenize(text)
+    tokens = [StartOfString.new(-1)]
+    text.split("").each_with_index do |char, index|
+      tokens << Token.new(char, index)
+    end
+    tokens << EndOfStringToken.new(text.size)
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: hashtag_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mariano Vallés
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+description: |-
+  Hashtag parser inspired by https://github.com/tonsser/hashtag-rs/
+  Given a string, this gem returns an array with an object with `text`, `start` and `end`.
+  Its goal is to match Instagram's parsing of hashtags.
+email:
+- zucaritas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hashtag_parser.gemspec
+- lib/hashtag_parser.rb
+- lib/state_machine.rb
+- lib/token.rb
+- lib/tokenizer.rb
+homepage: https://github.com/zucaritask/hashtag_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zucaritask/hashtag_parser
+  source_code_uri: https://github.com/zucaritask/hashtag_parser
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Hashtag parser returning start, end and text of each hashtag
+test_files: []