https://github.com/phrogz/liqrrdmetal

Calculate scoring of autocomplete-style substring matches, identifying which portions of the string were matched.
https://github.com/phrogz/liqrrdmetal

Last synced: 12 days ago
JSON representation

Calculate scoring of autocomplete-style substring matches, identifying which portions of the string were matched.

• Host: GitHub
• URL: https://github.com/phrogz/liqrrdmetal
• Owner: Phrogz
• Created: 2011-04-19T21:38:43.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2011-04-20T17:38:31.000Z (over 13 years ago)
• Last Synced: 2024-10-26T12:32:39.147Z (13 days ago)
• Language: Ruby
• Homepage: http://rubygems.org/gems/liqrrdmetal
• Size: 104 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## About LiqrrdMetal

Derived from the [LiquidMetal](https://github.com/rmm5t/liquidmetal)

JavaScript library, LiqrrdMetal brings substring scoring to Ruby.

Similar to [Quicksilver](http://qsapp.com/), LiqrrdMetal gives users the ability

to quickly find the most relevant items by typing in portions of the string, while

seeing the portions of the substring that are being matched.

To facilitate common sorting, lower scores are _better_;

a score of 0.0 indicates a perfect match, while a score of 1.0 indicates no match.

## Usage

Starting with the basics, here is how to find the score for a possible match:

    score = LiqrrdMetal.score( "re", "regards.txt" )

    #=> 0.082

    

    score = LiqrrdMetal.score( "re", "preview.jpg" )

    #=> 0.236

    score = LiqrrdMetal.score( "re", "no" )

    #=> 1.0

Want to know which letters were matched?

    score,parts = LiqrrdMetal.score_with_parts( "re", "Preview.jpg" )

    puts "%.02f" % score

    #=> 0.24

    p parts

    #=> [#,

    #=>  #,

    #=>  #]]

    puts parts.join

    #=> Preview.jpg

    puts parts.map(&:to_html).join

    #=> Preview.jpg

    require 'json'

    puts parts.to_json

    #=> [{"t":"P","m":false},{"t":"re","m":true},{"t":"view.jpg","m":false}]

Sort an array of possible matches by score, removing low-scoring items:

    def best_matches( search, strings )

      strings.map{ |s|

        [LiqrrdMetal.score(search,s),s]

      }.select{ |score,string|

        score < 0.3

      }.sort.map{ |score,string|

        string

      }

    end

    p best_matches( "re", various_filenames )

    #=> ["resizing-text.svg", "PreviewIcon.psd" ]

Given an array of possible matches, return the matching parts sorted by score:

    hits = LiqrrdMetal.parts_by_score( "re", various_filenames )

    p hits.map(&:join)

    #=> ["resizing-text.svg", "PreviewIcon.psd", "prime-finder.rb" ]

    p hits.map{ |parts| parts.map(&:to_ascii).join }

    #=> ["_re_sizing-text.svg", "P_re_viewIcon.psd", "p_r_im_e_-finder.rb" ]

    require 'json'

    puts hits[1].to_json

    #=> [{"t":"P","m":false},{"t":"re","m":true},{"t":"viewIcon.psd","m":false}]

You can also specify the threshold for the `parts_by_score` method:

    good_hits = LiqrrdMetal.parts_by_score( "re", various_filenames, 0.3 )

Finally, you probably have additional information you want to go along with each string,

such as a database row id or tooltip you want to display along with it. For this, pass a block

to `results_by_score` that accepts one of the objects in your array and returns the string to

filter against:

    User = Struct.new :name, :email, :id

    users = [ User.new( "Gavin Kistner",   "[email protected]",          42 ),

              User.new( "David Letterman", "[email protected]", 17 ),

              User.new( "Scott Adams",     "[email protected]",    82 ) ]

    

    scom = LiqrrdMetal.results_by_score( "s.com", users ){ |user| user.email }

    #=> [#,

    #=>  #]

    

    p scom.map{ |user| user.liqrrd_score }

    #=> [0.7222222222222222, 0.7619047619047619]

    

    p scom.map{ |user| user.liqrrd_parts.map(&:to_html).join }

    #=> ["scottadams@aol.com",

    #=>  "lateshow@pipeline.com"]

## License & Contact

LiqrrdMetal is released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

Copyright (c) 2011, Gavin Kistner ([email protected])