learn_party 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc08d3ba51b12c37a9042cda89c818ce2e6704b9
-  data.tar.gz: bfb2f2d2cd7c53cf71c6116ffb34622834cbf46c
+  metadata.gz: 17e48256f6ba2aedec9a22a3463e9e1ac87c9d8e
+  data.tar.gz: f718014e883777ef37e7f1c0f2d5419d82a38374
 SHA512:
-  metadata.gz: 0c3cebe7aa157d14c698fe60ffabd20f06fe1f591b852e3994209677048559626c4e190d15831a609e2be8338b5a2e4d8e0ef3ec6b8b0e9f1f8f2bfe5e270292
-  data.tar.gz: db39bdcdc8ce7befd398858a6887173fc940f41cc11909c4a8deae73010020ad4eb5dfd5be73e57b466ef92eb9838ab8bd5f533fc50f06cdbac4117ed58a019b
+  metadata.gz: 5cac7194ea95e24982f67316d59f6f20ea5ac59338640690e7fd65a911596716152c96cec6b2a53b78446bc955bf64e53bc7881009f963ca8c2cac5c52b6cf50
+  data.tar.gz: 3481f31acdebaf6ef114e0234a4ebcf2bbb0cb78596f74298f535f21facf76c3a634aa1957319af6da801891349bbeb4f2894a79f19b2e10c4c4559a7e69ac5c

data/README.md

@@ -1,13 +1,13 @@
-# LearnTogether
+# LearnParty
 
-This gem is meant to be used to group Learn student batches into groups for tables, labs and projects. 
+This gem is meant to be used to group Learn student batches into groups for tables, labs and projects.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'learn_together'
+gem 'learn_party'
 ```
 
 And then execute:
@@ -16,21 +16,21 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install learn_together
+    $ gem install learn_party
 
 ## Usage
 
-The Learn Together gem is meant to be used from within another project, like a Rails app. The gem can take in any collection of student-like objects, along with a few specifications, and generate groups of students accordingly. 
+The Learn Party gem is meant to be used from within another project, like a Rails app. The gem can take in any collection of student-like objects, along with a few specifications, and generate groups of students accordingly.
 
 #### What's a 'student-like object?'
 
-The Learn Together gem can take in a collection of objects that respond to a `#completed_lesson_count_for_active_track` method *or* a collection of hashes, each of which has a key of `:completed_lesson_count_for_active_track`.
+The Learn Party gem can take in a collection of objects that respond to a `#completed_lesson_count_for_active_track` method *or* a collection of hashes, each of which has a key of `:completed_lesson_count_for_active_track`.
 
-This is because the gem can generate groups based on similar progress. The gem uses the total number of completed lessons for a given student's active track as a metric with which to measure progress and thereby sort students. 
+This is because the gem can generate groups based on similar progress. The gem uses the total number of completed lessons for a given student's active track as a metric with which to measure progress and thereby sort students.
 
 #### These student-like objects sound great! Where can I get some?
 
-You can hit this Learn API endpoint for your batch to retrieve a JSON payload describing Learn students. 
+You can hit this Learn API endpoint for your batch to retrieve a JSON payload describing Learn students.
 
 ```bash
 GET http://leanr.co.api/batches/:batch_id/users
@@ -42,12 +42,12 @@ The payload for each student will include an attribute, `"completed_lesson_count
 
 #### Using the Gem
 
-Once you have your student collection, you can call the gem with a number of different arguments. 
+Once you have your student collection, you can call the gem with a number of different arguments.
 
 **Student groups with n number of students, based on progress**
 
 ```ruby
-LearnTogether::GroupMaker.new.run(collection: <collection of student-like objects>, groups_of: some_number, sort_type: "progress")
+LearnParty::GroupMaker.new.run(collection: <collection of student-like objects>, groups_of: some_number, sort_type: "progress")
 ```
 
 For example:
@@ -55,7 +55,7 @@ For example:
 ```ruby
 students = Student.all # assuming you have a database full of students with the necessary .completed_lesson_for_active_track attribute
 
-LearnTogether::GroupMaker.new.run(collection: students, groups_of: 2, sort_type: "progress")
+LearnParty::GroupMaker.new.run(collection: students, groups_of: 2, sort_type: "progress")
 ```
 
 returns:
@@ -72,7 +72,7 @@ returns:
    @github_username="rowena-larson",
    @last_name=nil>],
  [#<Student:0x007fc0a1344608
-   @completed_lesson_count_for_active_track=2, 
+   @completed_lesson_count_for_active_track=2,
    @first_name=nil, @github_username="nakia", @last_name=nil>,
   #<Student:0x007fc0a1344798
    @completed_lesson_count_for_active_track=3,
@@ -84,37 +84,37 @@ returns:
    @first_name=nil,
    @github_username="francesca-bashirian",
    @last_name=nil>,
-  #<Student:0x007fc0a13448b0 
+  #<Student:0x007fc0a13448b0
    @completed_lesson_count_for_active_track=3,  
-   @first_name=nil, 
+   @first_name=nil,
    @github_username="meaghan", @last_name=nil>],
- [#<Student:0x007fc0a1344c20 
-   @completed_lesson_count_for_active_track=4, 
-   @first_name=nil, @github_username="keeley", 
+ [#<Student:0x007fc0a1344c20
+   @completed_lesson_count_for_active_track=4,
+   @first_name=nil, @github_username="keeley",
    @last_name=nil>,
-  #<Student:0x007fc0a1344478 
-   @completed_lesson_count_for_active_track=4, 
-   @first_name=nil, 
+  #<Student:0x007fc0a1344478
+   @completed_lesson_count_for_active_track=4,
+   @first_name=nil,
    @github_username="german", @last_name=nil>],
  [#<Student:0x007fc0a13447e8
    @completed_lesson_count_for_active_track=4,
    @first_name=nil,
    @github_username="eleazar-beatty",
    @last_name=nil>,
-  #<Student:0x007fc0a1344950 
-   @completed_lesson_count_for_active_track=4, 
+  #<Student:0x007fc0a1344950
+   @completed_lesson_count_for_active_track=4,
    @first_name=nil, @github_username="ivy", @last_name=nil>],
- [#<Student:0x007fc0a13449f0 
-   @completed_lesson_count_for_active_track=4, 
-   @first_name=nil, @github_username="ernestina", 
+ [#<Student:0x007fc0a13449f0
+   @completed_lesson_count_for_active_track=4,
+   @first_name=nil, @github_username="ernestina",
    @last_name=nil>,
-  #<Student:0x007fc0a1344bf8 
-   @completed_lesson_count_for_active_track=5, 
-   @first_name=nil, @github_username="erling", 
+  #<Student:0x007fc0a1344bf8
+   @completed_lesson_count_for_active_track=5,
+   @first_name=nil, @github_username="erling",
    @last_name=nil>],
- [#<Student:0x007fc0a1344a40 
-   @completed_lesson_count_for_active_track=5, 
-   @first_name=nil, @github_username="heloise-toy", 
+ [#<Student:0x007fc0a1344a40
+   @completed_lesson_count_for_active_track=5,
+   @first_name=nil, @github_username="heloise-toy",
    @last_name=nil>,
   #<Student:0x007fc0a13449a0
    @completed_lesson_count_for_active_track=5,
@@ -131,9 +131,9 @@ returns:
    @first_name=nil,
    @github_username="trevor-mcclure",
    @last_name=nil>],
- [#<Student:0x007fc0a1344748 
-   @completed_lesson_count_for_active_track=7, 
-   @first_name=nil, @github_username="maxie-price", 
+ [#<Student:0x007fc0a1344748
+   @completed_lesson_count_for_active_track=7,
+   @first_name=nil, @github_username="maxie-price",
    @last_name=nil>,
   #<Student:0x007fc0a1344b30
    @completed_lesson_count_for_active_track=7,
@@ -145,45 +145,45 @@ returns:
    @first_name=nil,
    @github_username="jailyn-okeefe",
    @last_name=nil>,
-  #<Student:0x007fc0a1344978 
-   @completed_lesson_count_for_active_track=7, 
-   @first_name=nil, @github_username="yvonne", 
+  #<Student:0x007fc0a1344978
+   @completed_lesson_count_for_active_track=7,
+   @first_name=nil, @github_username="yvonne",
    @last_name=nil>],
- [#<Student:0x007fc0a1344888 
-   @completed_lesson_count_for_active_track=7, 
+ [#<Student:0x007fc0a1344888
+   @completed_lesson_count_for_active_track=7,
    @first_name=nil, @github_username="bobby",
    @last_name=nil>,
-  #<Student:0x007fc0a13444f0 
-   @completed_lesson_count_for_active_track=7, 
-   @first_name=nil, @github_username="jerrold", 
+  #<Student:0x007fc0a13444f0
+   @completed_lesson_count_for_active_track=7,
+   @first_name=nil, @github_username="jerrold",
    @last_name=nil>],
- [#<Student:0x007fc0a1344590 
-   @completed_lesson_count_for_active_track=7, 
-   @first_name=nil, @github_username="vivianne", 
+ [#<Student:0x007fc0a1344590
+   @completed_lesson_count_for_active_track=7,
+   @first_name=nil, @github_username="vivianne",
    @last_name=nil>,
   #<Student:0x007fc0a1344428
    @completed_lesson_count_for_active_track=8,
    @first_name=nil,
    @github_username="jaden-wintheiser",
    @last_name=nil>],
- [#<Student:0x007fc0a1344b80 
-   @completed_lesson_count_for_active_track=8, 
+ [#<Student:0x007fc0a1344b80
+   @completed_lesson_count_for_active_track=8,
    @first_name=nil, @github_username="obie", @last_name=nil>,
-  #<Student:0x007fc0a1344860 
-   @completed_lesson_count_for_active_track=8, 
-   @first_name=nil, @github_username="sydnie", 
+  #<Student:0x007fc0a1344860
+   @completed_lesson_count_for_active_track=8,
+   @first_name=nil, @github_username="sydnie",
    @last_name=nil>],
  [#<Student:0x007fc0a1344770
    @completed_lesson_count_for_active_track=8,
    @first_name=nil,
    @github_username="evelyn-corkery",
    @last_name=nil>,
-  #<Student:0x007fc0a1344518 
-   @completed_lesson_count_for_active_track=8, 
-   @first_name=nil, @github_username="ashley", 
+  #<Student:0x007fc0a1344518
+   @completed_lesson_count_for_active_track=8,
+   @first_name=nil, @github_username="ashley",
    @last_name=nil>],
- [#<Student:0x007fc0a1344900 
-   @completed_lesson_count_for_active_track=9, 
+ [#<Student:0x007fc0a1344900
+   @completed_lesson_count_for_active_track=9,
    @first_name=nil, @github_username="carey", @last_name=nil>,
   #<Student:0x007fc0a1344838
    @completed_lesson_count_for_active_track=9,
@@ -210,19 +210,19 @@ returns:
    @first_name=nil,
    @github_username="valentin-langworth",
    @last_name=nil>,
-  #<Student:0x007fc0a13445b8 
-   @completed_lesson_count_for_active_track=10, 
-   @first_name=nil, @github_username="andreanne", 
+  #<Student:0x007fc0a13445b8
+   @completed_lesson_count_for_active_track=10,
+   @first_name=nil, @github_username="andreanne",
    @last_name=nil>]
 ]
 ```
 
-We can see that the return of the `#run` method is an array of arrays, in which each child array represents one group of students and contains the list of the students in that group. In this case, we assume the original student collection contained 35 students. So, `#run` returned an array of 17 arrays, each of which contains two students, except for the last one, which contains 3 students. 
+We can see that the return of the `#run` method is an array of arrays, in which each child array represents one group of students and contains the list of the students in that group. In this case, we assume the original student collection contained 35 students. So, `#run` returned an array of 17 arrays, each of which contains two students, except for the last one, which contains 3 students.
 
 **Student groups with n number of students, sorted randomly**
 
 ```ruby
-LearnTogether::GroupMaker.new.run(collection: <collection of student-like objects>, groups_of: some_number, sort_type: "random")
+LearnParty::GroupMaker.new.run(collection: <collection of student-like objects>, groups_of: some_number, sort_type: "random")
 ```
 
 For example:
@@ -230,16 +230,16 @@ For example:
 ```ruby
 students = Student.all # assuming you have a database full of students with the necessary .completed_lesson_for_active_track attribute
 
-LearnTogether::GroupMaker.new.run(collection: students, groups_of: 3, sort_type: "random")
+LearnParty::GroupMaker.new.run(collection: students, groups_of: 3, sort_type: "random")
 ```
 
 **Students into n number of groups**
 
 ```ruby
-LearnTogether::GroupMaker.new.run(collection: <collection of student-like objects>, number_of_groups: 3)
+LearnParty::GroupMaker.new.run(collection: <collection of student-like objects>, number_of_groups: 3)
 ```
 
-This will return an array of three smaller arrays, each of which contains the appropriate number of students. 
+This will return an array of three smaller arrays, each of which contains the appropriate number of students.
 
 ## Development
 
@@ -250,4 +250,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/learn_party.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["johannkerr@gmail.com"]
 
   spec.summary       = %q{tool for Flatiron School instructors to group students for projects}
-  spec.homepage      = "https://github.com/flatiron-school/learn-together-gem"
+  spec.homepage      = "https://github.com/flatiron-school/learn-party-gem"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

data/lib/learn_party/generator.rb

@@ -1,4 +1,3 @@
-require 'pry'
 class Generator
   attr_accessor :students, :groups_of, :sort_type, :number_of_groups
 

data/lib/learn_party/version.rb

@@ -1,3 +1,3 @@
 module LearnParty
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: learn_party
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - johann kerr
@@ -102,7 +102,7 @@ files:
 - lib/learn_party.rb
 - lib/learn_party/generator.rb
 - lib/learn_party/version.rb
-homepage: https://github.com/flatiron-school/learn-together-gem
+homepage: https://github.com/flatiron-school/learn-party-gem
 licenses:
 - MIT
 metadata: