easy_rr 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7762e4842972c0d777c4e3c83ccdedee62bf3dab
-  data.tar.gz: 6e12abd320223332cb5dba010e7d11ff8fae7428
+  metadata.gz: cd22717eefebca5d6593a89445e7430f93aa33be
+  data.tar.gz: f029d4489b183a05e84ce289f82398dd0a70eee9
 SHA512:
-  metadata.gz: e12cc37f144cab915f1b82830ce3c21351863c7d3413fbc429c7ca52e884b49d7747392719015395da6026e796d4ce2bc70db66626b549907cafbed443f0eed8
-  data.tar.gz: 20df0898201decaacc30aa31bb4c3570d5ef654a7f1893d53b93c89f830e64962b0252a1b04fe592b1d6fd79974125452c3273eb2c263ce2ad5aaf9b41774057
+  metadata.gz: 54af9b307a564a7ee858f1da68a0f99e7f79c5665cec6e9b712da367ea902e1c06189009a04370f5f4a01d1ff37b554033eff0f7c0cc3c5f63b8b3f3a1da8238
+  data.tar.gz: 618707a155eb57f167fd9bad63e7cda0f0cdfac92e2587e2f8ce19ec98d6d9a6d1951fa0b02fd19c80a03fe20948879f05446a56f1e036f24b837e37c88757ae

data/README.md

@@ -1,9 +1,3 @@
-# EasyRr
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/easy_rr`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,17 +16,89 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Using easy_rr is very easy, as its name suggests. You just need to pass it an array and an integer to specify the amount of times that each participant will face each other.
+
+It receives two parameters: an array and an integer.
+
+The array consists of the users, teams, or participants that will be matched.
+The integer is the amount of times each participant will face each other participant. This defaults to 1.
+
+Here's a little example:
+
+```ruby
+
+	#You can pass an array
+	teams = [ "Colombia", "Peru", "Venezuela", "Brazil" ]
+
+	#Then you can call EasyRr to generate the matches
+	games = EasyRr.matches(teams)
+
+	#=> [[["Venezuela", "Brazil"], ["Peru", "Colombia"]], [["Peru", "Brazil"], ["Colombia", "Venezuela"]], [["Colombia", "Brazil"], ["Venezuela", "Peru"]]] 
+```
+
+By passing a second parameter you can specify the amount of times each participant will face each other participant, as said before.
+
+So, in another little example:
+
+```ruby
+
+	#The array
+
+	teams = [ "Real Madrid", "Bayern Munchen", "Juventus", "F.C. Barcelona" ]
+
+	#Generate the matches, this time you pass 2 as the number of times they will face each other
+	games = EasyRr.matches(teams,2)
+
+	#=> [[["Bayern Munchen", "F.C. Barcelona"], ["Juventus", "Real Madrid"]], [["Juventus", "F.C. Barcelona"], ["Real Madrid", "Bayern Munchen"]], [["Real Madrid", "F.C. Barcelona"], ["Bayern Munchen", "Juventus"]], [["Bayern Munchen", "F.C. Barcelona"], ["Juventus", "Real Madrid"]], [["Juventus", "F.C. Barcelona"], ["Real Madrid", "Bayern Munchen"]], [["Real Madrid", "F.C. Barcelona"], ["Bayern Munchen", "Juventus"]]] 
+```
+
+If you want, you can also pass an ActiveRecord object, for instance:
+
+```ruby
+
+	#This can be the collection of participants
+
+	participants = Model.teams
+
+	#As this can also be passed
+
+	participants = User.all
+```
+
+Either way, an array of integers can also be passed if you don't have the names of each participant but the ids.
+
+```ruby
 
-## Development
+	#Array of ids
+	teams = [ 1,2,3,4 ]
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+	games = EasyRr.matches(teams)
+	=> [[[2, 4], [3, 1]], [[3, 4], [1, 2]], [[1, 4], [2, 3]]] 
+```
+
+If the array passed is odd, the generated array will have one match where one of the teams is nil.
+
+```ruby
+
+	#Array of ids
+	teams = [ 1,2,3,4,5 ]
+
+	games = EasyRr.matches(teams)
+	=> [[[2, nil], [3, 1], [4, 5]], [[3, nil], [4, 2], [5, 1]], [[4, nil], [5, 3], [1, 2]], [[5, nil], [1, 4], [2, 3]]] 
+```
+
+Finally, you can loop through the generated array and create each match in your database according to the model you have.
+
+```ruby
 
-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).
+	teams = [ "Italy", "France", "Argentina", "Ghana" ]
 
-## Contributing
+	teams.each do |j|
+		j.map { |x| Model.create("params_here") }
+	end
+``` 
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_rr.
+Enjoy.
 
 
 ## License

data/lib/easy_rr/version.rb

@@ -1,3 +1,3 @@
 module EasyRr
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/easy_rr.rb

@@ -3,20 +3,28 @@ require "easy_rr/version"
 module EasyRr
   def self.matches(participants,*facingMatches)
 
+  	if participants.class != Array
+		participants = participants.to_a
+  	end
+
     fMatches = !facingMatches[0].nil? ? facingMatches[0] : 1
 
     if participants.size%2 != 0
     	participants.push nil
     end
+
     length = participants.size
     last_e = participants.pop
+
     matches = ( ( ( fMatches*length )/2 ) + fMatches ).times.map do
       participants.rotate!
       [[participants.first, last_e]] + (1...(length / 2)).map { |j| [participants[j], participants[length - 1 - j]] }
     end
+
     unless last_e.nil?
     	participants.push last_e
     end
+    
     return matches
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_rr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - David Rosillo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler