fuzzyfinder 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 017b1cdc9a590e44e4792766e57e9dfe8ab248b3
-  data.tar.gz: 430498df1dac01bb7e97da23eda1ad19b933c914
+  metadata.gz: dac4c542aeef6ae42e264734f146267e6c14e562
+  data.tar.gz: cf62f980a3dc364563a16890bba7b5cc607bc685
 SHA512:
-  metadata.gz: 4b52dde5a4fe59b97983960db2353113b18ecb890c9965443b250a71997b9ed8032fe1a9581dfd011e316760799bc9030452ec47ffd892064588b9f5d4b21034
-  data.tar.gz: b748689fc24d7132b75a3c0ce8840c56a280aa7b814b4358339e9402dbc3d8899e64c8e4d8de9851efcfd924b4e79de0a6c72f6f8e1289d2e6989d264d91eca7
+  metadata.gz: 54c002829d62b7268ae2fbb1a64efd8a26947fb285477ac27df4a5da819570cafcef8d68de93d2a110a84a2c1398adf07827aaee985b0ca96e1194e508f9fab7
+  data.tar.gz: 8457cc19625c29c28ab202721738462c666a5834e3744f028f9ab33b1366679a62fa2a74172ea87ee39d363fed0f7774bb6366833b20466ec4309cb81488bb1b

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+before_install:
+  - gem install bundler -v '~> 1.5'
+rvm:
+  - 1.9.3
+  - 2.2.1
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matheus Rosa
+
+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,50 @@
+# fuzzyfinder
+[![Build Status](https://travis-ci.org/mdsrosa/fuzzyfinder.svg?branch=master)](https://travis-ci.org/mdsrosa/fuzzyfinder)
+
+Fuzzy Finder implemented in Ruby. Matches partial string entries from a list of strings. Works similar to fuzzy finder in SublimeText, Atom and Vim's Ctrl-P plugin.
+
+
+## How does it work
+See Amjith Ramanujam's blog post describing the algorithm: [http://blog.amjith.com/fuzzyfinder-in-10-lines-of-python](http://blog.amjith.com/fuzzyfinder-in-10-lines-of-python)
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# Add to your Gemfile
+gem 'fuzzyfinder'
+
+# or install manually
+gem install fuzzyfinder
+```
+
+## Usage
+```ruby
+2.2.1 :001 > require 'fuzzyfinder'
+ => true
+
+2.2.1 :002 > Fuzzyfinder::Fuzzyfinder.find('user', ['api_user.doc', 'user_doc.doc', 'django_migrations.py', 'migrations.py'])
+ => ["user_doc.doc", "api_user.doc"]
+
+2.2.1 :003 > Fuzzyfinder::Fuzzyfinder.find('djm', ['api_user.doc', 'user_doc.doc', 'django_migrations.py', 'migrations.py'])
+ => ["django_migrations.py"]
+
+2.2.1 :004 > Fuzzyfinder::Fuzzyfinder.find('mig', ['api_user.doc', 'user_doc.doc', 'django_migrations.py', 'migrations.py'])
+ => ["migrations.py", "django_migrations.py"]
+```
+
+# Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fuzzyfinder/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+# Inspired by
+Amjith Ramanujam's implementation: [https://github.com/amjith/fuzzyfinder](https://github.com/amjith/fuzzyfinder)
+
+
+# License
+See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

data/fuzzyfinder.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzyfinder"
+  spec.version       = "0.0.3"
+  spec.date          = "2015-10-06"
+  spec.summary       = "Fuzzy Finder"
+  spec.description   = "Matches partial string entries from a list of strings."
+  spec.authors       = ["Matheus Rosa"]
+  spec.email         = "matheusdsrosa@gmail.com"
+  spec.homepage      = "https://rubygems.org/gems/fuzzyfinder"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler",   "~> 1.7"
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+end

data/lib/fuzzyfinder.rb

@@ -1,15 +1,4 @@
-class Fuzzyfinder
-  def self.find(user_input, collection)
-    user_input = user_input.to_s if user_input.is_a? Numeric
-    temporary_suggestions, suggestions = [], []
-    pattern = user_input.split('').join('.*?')
-    collection.each do |item|
-      matches = item.scan(/#{pattern}/)
-      if matches.any?
-        temporary_suggestions.push([matches.last.length, Regexp.last_match.begin(0), item])
-      end
-    end
-    temporary_suggestions.sort!.each { |e| suggestions.push(e.last) }
-    suggestions
-  end
-end
+require 'fuzzyfinder/fuzzyfinder'
+
+module Fuzzyfinder
+end

data/lib/fuzzyfinder/fuzzyfinder.rb

@@ -0,0 +1,17 @@
+module Fuzzyfinder
+  class Fuzzyfinder
+    def self.find(user_input, collection)
+      user_input = user_input.to_s if user_input.is_a? Numeric
+      temporary_suggestions, suggestions = [], []
+      pattern = user_input.split('').join('.*?')
+      collection.each do |item|
+        matches = item.scan(/#{pattern}/)
+        if matches.any?
+          temporary_suggestions.push([matches.last.length, Regexp.last_match.begin(0), item])
+        end
+      end
+      temporary_suggestions.sort!.each { |e| suggestions.push(e.last) }
+      suggestions
+    end
+  end
+end

data/lib/fuzzyfinder/version.rb

@@ -0,0 +1,3 @@
+module Fuzzyfinder
+  version = "0.0.3"
+end

data/spec/fuzzyfinder/fuzzyfinder_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Fuzzyfinder::Fuzzyfinder do
+  let(:fuzzyfinder) { described_class }
+
+  before :all do
+    @collection =  [
+      "django_migration.py",
+      "main_group.rb",
+      "api_user.rb",
+      "user_doc.rb",
+      "migration.rb",
+      "admin.rb",
+      "admin22.rb"
+    ]
+  end
+
+  describe ".find" do
+    let(:user_input) { "mig" }
+
+    it "returns a list with matching results" do
+      result = fuzzyfinder.find(user_input, @collection)
+      expect(result).to be_a(Array)
+      expect(result).not_to be_empty
+    end
+
+    context "the closest matching result" do
+      let(:user_input_one) { "djm" }
+      let(:user_input_two) { "user" }
+
+      it "and returns a list with the first item as the closest result" do
+        result = fuzzyfinder.find(user_input_one, @collection)
+        expect(result[0]).to eq("django_migration.py")
+
+        result = fuzzyfinder.find(user_input_two, @collection)
+        expect(result[0]).to eq("user_doc.rb")
+      end
+    end
+
+    context "receives a integer from user input" do
+      let(:user_input_number) { 22 }
+
+      it "returns a list with matching results" do
+        result = fuzzyfinder.find(user_input_number, @collection)
+        expect(result).to be_a(Array)
+        expect(result).not_to be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative '../lib/fuzzyfinder'
+require 'yaml'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuzzyfinder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Matheus Rosa
@@ -9,17 +9,61 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-10-06 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Matches partial string entries from a list of strings.
 email: matheusdsrosa@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- fuzzyfinder.gemspec
 - lib/fuzzyfinder.rb
+- lib/fuzzyfinder/fuzzyfinder.rb
+- lib/fuzzyfinder/version.rb
+- spec/fuzzyfinder/fuzzyfinder_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/fuzzyfinder
 licenses:
-- mit
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -41,4 +85,6 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Fuzzy Finder
-test_files: []
+test_files:
+- spec/fuzzyfinder/fuzzyfinder_spec.rb
+- spec/spec_helper.rb