0.0
No commit activity in last 3 years
No release in over 3 years
Use this gem to match attributes between your object instances. It basically returns the percentage of attributes matched between two instances.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 4.0.0
~> 1.14
>= 0
>= 0
~> 10.0
~> 3.0
 Project Readme

RailsMatchingGem

Codacy Badge Codacy Badge wercker status

Use this gem to match attributes between your object instances. It basically returns the percentage of attributes matched between two instances.

Installation

Add this line to your application's Gemfile:

gem 'rails_matching'

And then execute:

$ bundle install

Usage Examples:

	# Matches all instances from a model with same model
	# Returns object id, object id that id matched against, and percentage of match
	RailsMatching.against_itself(User.all)
	# [ [1, 2, 33.0 ]
	#   [1, 3, 0.0 ]
	#   [1, 4, 88.0 ] ]
	# Matches one instance from a model with all instances from same model
	# Returns object id, object id that id matched against, and percentage of match
	instance = User.create(name: "Test", age: 22, job_title: "writer")
	RailsMatching.instance_against_all(instance, User.all)
	# You can also exclude attributes from match
	RailsMatching.instance_against_all(instance, User.all, exclude_attrs: ["name"])

Development

To Do

  • Use of required fields
  • Finish parametrization method
  • Instance against instance method
  • Specs
  • Use of SQL queries for large data sets
  • Add order method
  • Add max filter to return a max number of instances

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.

gem build rails_matching.gemspec gem install rails_matching-0.1.0.gem

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jonaslsl/rails_matching. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.