curricula 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f700e9d06de3b9b64c75d964b2fa9a85d04db982
-  data.tar.gz: c612076d8d9be2b6f5c8b7e5a89640a4d446a69b
+  metadata.gz: 863a71fc9ec248e590f4547141a0b45d50b9add5
+  data.tar.gz: fa5d9dd1bf8e358283fdf1530eb4f3f4d3e9d62e
 SHA512:
-  metadata.gz: 435028986507de7c05ea62a188c2c5b3f9283699b5e9109c8f99a0e592119efb058056ce3a6ebe0523109d57f20f44f50068049107a4062bcc2b30d3539ae1ff
-  data.tar.gz: b173b0556770f7beffda62b398ffeee34476f0bc2696fb602a7fe74954d78f039f97915df297c8e4a29e70483037a76cd2b38534ff067351b8017b5200772c35
+  metadata.gz: 57a9f4a9e105232abcd1946b4da42af625bc51d58d1b9762b7ca2ce33efd5dc9073ca87655d3bf0d2c7f5e80f891ef49ded01f2fbaa90296af38ad7e6b2f554a
+  data.tar.gz: d3b5812b29a0c9fbd191439f6a0f88daeb591c1a14e580ef40c790d747de8b0e7482ae9ec5483a21827d95e4d861669d5ebdf1b4e81d38ed04eae89e84a815b6

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.gem

data/README.md

@@ -20,7 +20,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, create your excel spreadsheet with the following format (NO HEADER). This
+is two things in a single worksheet, this may be worked out later, but for now,
+do this. Here's an example to get you going (leave out the header):
+
+|Course|Prereq?|Hours|
+|:----:|:-----:|:---:|
+|MATH 162| |4|
+|MATH 163| |4|
+|MATH 264| |3|
+|MATH 162|prereq|MATH 163|
+|MATH 163|prereq|MATH 264|
+
+Add an Excel spreadsheet to this:
+
+```ruby
+my_plan = Curricula::DegreePlan.new "worksheet.xls"
+```
+
+Then, compute the efficiency. Lower is better:
+
+```ruby
+my_plan.efficiency
+```
+
+If you need a list of courses (as a hash), use `course_list`:
+
+```ruby
+my_plan.course_list
+```
+
+To use this as part of a graph, use the following two methods:
+
+```ruby
+my_plan.graph_nodes
+my_plan.graph_edges
+```
+
+`graph_nodes` returns a list of strings, `graph_edges` returns a hash of edges,
+with `:source` and `:destination` to mark the directionality of the
+prerequisites.
 
 ## Contributing
 

data/curricula.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "spreadsheet"
 end

data/lib/curricula/version.rb

@@ -1,3 +1,3 @@
 module Curricula
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curricula
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ricardo Piro-Rael
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Determines curricular efficiency of a degree plan.
 email:
 - fdisk@fdisk.co