reading_assignments 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8fafc103ef13984f0ec1d6f81920171cfbbb951
-  data.tar.gz: 62a5d4d6007559218caa1608720bf1607493b774
+  metadata.gz: 7219c134a18c681c390ef7337eb7ed85d4a40de8
+  data.tar.gz: dd24b7183e557011ab6aadba89446220a247336b
 SHA512:
-  metadata.gz: d92d213960bcbdf9442fe94d1a71ade98481128801304623579a427a4fe6182a1828f37a8e92cc0699ab8122a73df0f32528a54e1f98ac711ede58e54d4fe69b
-  data.tar.gz: effaf19c017eac9d5b89bc017f4f619546f9078a65c9f2187ba52daae103c906bbbbd63dca320b631fd7065f33f52712e53c69eec89250c4311b2b93b40342e7
+  metadata.gz: 0195c38aff58e5e3a4bc612bc6951c5069c05fa1bcef5f9f1b07d6ffc76a99dd1d511640e577035d0fae15c7602a06247274b550e24cedb5a1aebc86d6041916
+  data.tar.gz: 13d9ed91413c7add440bdec52538832c468ad13afaa2f226b57e8cf242bcb255e698de3ff8d3baf23c7c3e1065cb99f31656052a147e408e7e10c92abbb13656

data/README.md

@@ -1,38 +1,40 @@
-# ReadingAssignments
+# Reading Assignments Gem
 
-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/reading_assignments`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem allows you to assign your readings to your mentees. As an Experience
+Engineer at Launch, I'd find myself spending unnecessary energy assigning 
+students to readings in the morning. Instead of having to choose people every
+morning, I wanted a tool to automate the process and just make my morning a
+_little_ bit easier.
 
 ## Installation
+You can install the gem simply by executing the command:
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'reading_assignments'
+```
+$ gem install reading_assignments
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install reading_assignments
-
-## Usage
+In order to use the reading_assignments gem, you simply have to run the command:
 
-TODO: Write usage instructions here
+```
+$ reading_assignments
+```
 
-## Development
+This gem has an executable script, so you can run it from anywhere. Upon running
+this command, you'll be asked to setup your group and given three options on
+how to randomize your selection: 
 
-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.
+* Number: uses this number to seed the random generator
+* String: converts the string to a number and uses that as the seed
+* Random: no seed number, just uses the random generator
 
-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).
+Following that you will be asked how many articles you need to assign and you
+should be able to see your assignments!
 
-## Contributing
+Upon using the gem again, you'll have the option to keep your group as is, or
+to create a new group to select from. This will be especially useful for EEs who
+cover multiple mentor groups.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/reading_assignments.
+Enjoy and hopefully this will make your morning just a little bit easier!
 
 ## License
 

data/lib/mentor_group.rb

@@ -31,10 +31,6 @@ class MentorGroup
       mentees = self.create_persisted_mentees(store)
       return mentees
     else
-      store.transaction do
-        mentees = store["mentees"]
-        return mentees
-      end
     end
   end
 end

data/lib/reading_assignments/version.rb

@@ -1,3 +1,3 @@
 module ReadingAssignments
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/members.yaml

@@ -0,0 +1,8 @@
+---
+mentees:
+- !ruby/object:Student
+  name: Mike
+- !ruby/object:Student
+  name: Greg
+- !ruby/object:Student
+  name: Tori

data/reading_assignments.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["michaelgt04@gmail.com\n"]
 
   spec.summary       = "Assign Launch Readings"
-  spec.description   = "You can use this gem to assign your readings to your mentees"
-  spec.homepage      = "https://github.com/michaelgt04/debugging-clinic"
+  spec.description   = "You can use this gem to assign your readings to your mentees. You have multiple different ways to select the reading. It should make your morning a little easier!"
+  spec.homepage      = "https://github.com/michaelgt04/reading_assignments"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reading_assignments
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mike Thomson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: You can use this gem to assign your readings to your mentees
+description: You can use this gem to assign your readings to your mentees. You have
+  multiple different ways to select the reading. It should make your morning a little
+  easier!
 email:
 - 'michaelgt04@gmail.com
 
@@ -95,7 +97,7 @@ files:
 - lib/student_randomizer.rb
 - members.yaml
 - reading_assignments.gemspec
-homepage: https://github.com/michaelgt04/debugging-clinic
+homepage: https://github.com/michaelgt04/reading_assignments
 licenses:
 - MIT
 metadata: {}