keyword_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29a4c1699353c42ea411fed1cdb41f1843837ca9
+  data.tar.gz: cd21e32c7d24ba704d01093d968e2dda3a9e0a5a
+SHA512:
+  metadata.gz: c6fa048442a34fd8e5d75bccf2d21cdb388c54f3fa6582e9f280b748b630aa79ae2aa1cb423dc2eee1a763198dc8c1097ff26f4bcd3ba023f2779db34f613129
+  data.tar.gz: 52ee884cbe1cc475e09884beea43acf28a172f9c485d774153347263f38542083b70d54257da447e426dfe1e54626fe43436bc441de934c71d1683465f3c6876

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keyword_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 murb
+
+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,69 @@
+# KeywordFinder
+
+We were dealing with the following situation:
+
+Given a set of the following keywords: "aardappelen", "zachtkokende aardappelen", "zout", "schimmelkaas", "kaas", "oude harde kaas", "kikkererwten", "maïs", "bruine bonen", "shiitake", "boter"
+
+Can you recognize:
+
+    "een grote pan zachtkokende aardappelen met een snufje zout"=>["zachtkokende aardappelen", "zout"],
+    "schimmelkaas" => ["schimmelkaas"],
+    "(schimmel)kaas" => ["schimmelkaas"],
+    "old amsterdam (maar een andere oude harde kaas kan natuurlijk ook)" => ["oude harde kaas"],
+    "g (verse) shiitake in bitesize stukjes gesneden" => ["shiitake"],
+    "pot hak bonenmix (kikkererwten maïs kidney en bruine bonen) afgespoeld en uitgelekt" => ["kikkerwerwten", "maïs", "bruine bonen"],
+    "g boter gesmolten en licht afgekoeld" => ["boter"]
+
+Well, this gem helps you do this. It isn't rocket science, but if you need the functionality, go ahead (and submit improvements)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keyword_finder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyword_finder
+
+## Usage
+
+Since above I wrote a small 'spec', here is the formal rspec:
+
+    a = KeywordFinder::Keywords.new(["aardappelen", "zachtkokende aardappelen", "zout",
+      "schimmelkaas", "kaas", "oude harde kaas", "kikkererwten", "maïs",
+      "bruine bonen", "shiitake", "boter", "kidney bonen"])
+
+    examples = {"een grote pan zachtkokende aardappelen met een snufje zout"=>["zachtkokende aardappelen", "zout"],
+      "schimmelkaas" => ["schimmelkaas"],
+      "(schimmel)kaas" => ["schimmelkaas"],
+      "old amsterdam (maar een andere oude harde kaas kan natuurlijk ook)" => ["oude harde kaas"],
+      "g (verse) shiitake in bitesize stukjes gesneden" => ["shiitake"],
+      "pot hak bonenmix (kikkererwten, maïs, kidney en bruine bonen) afgespoeld en uitgelekt" => ["kikkererwten", "maïs", "bruine bonen"],
+      "g boter gesmolten en licht afgekoeld" => ["boter"]}
+
+    examples.each do |sentence, expected|
+      expect( a.find_in(sentence) ).to eq(expected)
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/murb/keyword_finder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keyword_finder"
+
+# 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

data/bin/setup

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

data/keyword_finder.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyword_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyword_finder"
+  spec.version       = KeywordFinder::VERSION
+  spec.authors       = ["murb"]
+  spec.email         = ["info@murb.nl"]
+
+  spec.summary       = "Find given set of keywords in a sentence."
+  spec.description   = "Find given set of keywords in a sentence based on simple regex (nothing fuzzy), although some cleaning is being done"
+  spec.homepage      = "https://murb.nl/blog?tags=keyword_finder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/keyword_finder/keywords.rb

@@ -0,0 +1,57 @@
+module KeywordFinder
+  class Keywords < Array
+    def to_regex
+      @to_regex ||= Regexp.new("(#{self.collect{|a| "\\s#{a}\\s"}.join("|")})")
+    end
+
+    def scan_in sentence
+      " #{sentence} ".scan(self.to_regex)
+    end
+
+    def clean_sentence sentence
+      sentence.gsub(/(\.|\?|\,|\;)/," $1 ")
+    end
+
+    def combine_more_specifics sentence
+      sentence.gsub(/([A-Za-z]*\([A-Za-z]*\)[A-Za-z]*)/) { |s| s.gsub(/(\(|\))/,'') }
+    end
+
+    def scan_part sentence
+      scan_results = self.scan_in(self.clean_sentence(sentence))
+      scan_results.flatten!
+      scan_results.uniq!
+      results = []
+      scan_results.each do |result|
+        results << result.strip unless result.strip.empty?
+      end
+      results
+    end
+
+    def find_in sentence, options={}
+      options = {
+        subsentences_strategy: :none # :none, :ignore_if_found_in_main, :always_ignore
+      }.merge(options)
+
+      sentence = self.combine_more_specifics(sentence)
+      main_and_subs = self.separate_main_and_sub_sentences(sentence)
+      main_results = self.scan_part(main_and_subs[:main])
+      sub_results = []
+      unless (
+        options[:subsentences_strategy] == :always_ignore or
+        (main_results.count > 0 and options[:subsentences_strategy] == :ignore_if_found_in_main)
+        )
+        sub_results = main_and_subs[:subs].collect{|subsentence| self.scan_part(subsentence)}.flatten
+      end
+      return main_results + sub_results
+    end
+
+    def separate_main_and_sub_sentences sentence
+      subs = sentence.scan(/(\(.*\))/).flatten
+      subs.each do |subsentence|
+        sentence = sentence.gsub(subsentence,"")
+      end
+      {main:sentence,subs:subs.collect{|a| a[1..(a.length-2)]}}
+    end
+
+  end
+end

data/lib/keyword_finder/version.rb

@@ -0,0 +1,3 @@
+module KeywordFinder
+  VERSION = "0.1.0"
+end

data/lib/keyword_finder.rb

@@ -0,0 +1,6 @@
+require "keyword_finder/version"
+require "keyword_finder/keywords"
+
+module KeywordFinder
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: keyword_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- murb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  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
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Find given set of keywords in a sentence based on simple regex (nothing
+  fuzzy), although some cleaning is being done
+email:
+- info@murb.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keyword_finder.gemspec
+- lib/keyword_finder.rb
+- lib/keyword_finder/keywords.rb
+- lib/keyword_finder/version.rb
+homepage: https://murb.nl/blog?tags=keyword_finder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Find given set of keywords in a sentence.
+test_files: []
+has_rdoc: