corepathing 0.1.0 → 0.2.0

data/.travis.yml

@@ -2,3 +2,7 @@ language: ruby
 rvm:
   - 2.3.0
 before_install: gem install bundler -v 1.11.2
+
+addons:
+    code_climate:
+        repo_token: 0d6a42692e201f67d8a80f194ed70179d696ed5aaec5f16e6d4c356a2e807428

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in corepathing.gemspec
 gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/mdubbs/corepathing.svg?branch=master)](https://travis-ci.org/mdubbs/corepathing) [![Code Climate](https://codeclimate.com/github/mdubbs/corepathing/badges/gpa.svg)](https://codeclimate.com/github/mdubbs/corepathing)
+[![Build Status](https://travis-ci.org/mdubbs/corepathing.svg?branch=master)](https://travis-ci.org/mdubbs/corepathing) [![Code Climate](https://codeclimate.com/github/mdubbs/corepathing/badges/gpa.svg)](https://codeclimate.com/github/mdubbs/corepathing) [![Test Coverage](https://codeclimate.com/github/mdubbs/corepathing/badges/coverage.svg)](https://codeclimate.com/github/mdubbs/corepathing/coverage)
 
 # Corepathing
 
@@ -23,12 +23,23 @@ Or install it yourself as:
 ## Usage
 
 Setup the pathing object with your CSV files
-```
+```ruby
 # setup
-pathing = Corepathing::Pathing.new("spec/data/student_tests.csv", "spec/data/domain_order.csv")
+pathing = Corepathing::Pathing.new("spec/data/stu.csv", "spec/data/ord.csv")
 
 # the parameter is the limit for number of steps to return for each student
 pathing.path_students(5)
+
+# will return an array of strings, each string representing the student's path
+[#<Corepathing::Student:0x007fe8ab8d0568 @name="Albin Stanton", @max_domain_levels={"RF"=>"2", "RL"=>"3", "RI"=>"K", "L"=>"3"}, @path=[{"K"=>"RI"}, {"1"=>"RI"}, {"2"=>"RF"}, {"2"=>"RI"}, {"3"=>"RF"}]>, #<Corepathing::Student:0x007fe8ab8ca550 @name="Erik Purdy", @max_domain_levels={"RF"=>"3", "RL"=>"1", "RI"=>"1", "L"=>"1"}, @path=[{"1"=>"RL"}, {"1"=>"RI"}, {"2"=>"RI"}, {"2"=>"RL"}, {"2"=>"L"}]>]
+
+#if you just want to calculate one student, given their row you can do
+student_obj = pathing.get_path(student_row)
+#<Corepathing::Student:0x007fc92b4f3e30 @name="Albin Stanton", @max_domain_levels={"RF"=>"2", "RL"=>"3", "RI"=>"K", "L"=>"3"}, @path=[{"K"=>"RI"}, {"1"=>"RI"}, {"2"=>"RF"}, {"2"=>"RI"}, {"3"=>"RF"}]>
+
+#to get the string representation of the student's education path
+student_obj.to_s
+# will return "Albin Stanton,K.RI,1.RI,2.RF,2.RI,3.RF"
 ```
 
 ## Development
@@ -39,7 +50,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/corepathing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mdubbs/corepathing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/corepathing.rb

@@ -1,23 +1,41 @@
 require "corepathing/version"
 require 'csv'
+
 module Corepathing
-  class Pathing
+  # Class for Student object
+  class Student
+    attr_accessor :name
+    attr_accessor :max_domain_levels
+    attr_accessor :path
 
-    ##
+    def initialize(name, max_domain_grade_levels, education_path)
+      @name = name
+      @max_domain_levels = max_domain_grade_levels
+      @path = education_path
+    end
+
+    def to_s
+      z = @path.map{|p| p.map{|k,v| "#{k}.#{v}"} }.join(',')
+      return "#{@name},#{z}"
+    end
+  end
+
+  class Pathing
     # Creates a new learning path object from the given domain_ordering and
     # student_tests CSV files
-    #
-
     def initialize(student_tests, domain_order)
       # load up the CSV files and parse
       @STUDENT_TESTS = CSV.read(student_tests, headers: true)
       @DOMAIN_ORDER = CSV.read(domain_order, headers: false)
     end
 
-    def path_students(limit)
+    def path_students(limit = nil)
       # generate each student's learning path and return an array of the
       # students found in the student csv.
       ret = []
+      if limit.nil?
+        limit = 5
+      end
       # iterate through the students
       @STUDENT_TESTS.each do |x|
         ret.push(get_path(x, limit))
@@ -25,46 +43,59 @@ module Corepathing
       ret
     end
 
-    def get_path(student_row, limit)
+    def get_path(student_test_score_row, limit = nil)
       # calculate the path for a given student, and return the number of steps
       # desired.
 
       # grab the students name
-      name = student_row[0]
+      current_student_name = student_test_score_row[0]
       # init some data structures
-      current_levels = {}
-      path = []
+      student_max_grade_levels = {}
+      student_path = []
+      students = []
+
+      if limit.nil?
+        limit = 5
+      end
 
       # iterate through the students excluding the header row
-      student_row.to_a[1..-1].each do |domain, level|
+      student_test_score_row.to_a[1..-1].each do |domain, grade_level|
         # set the max levels for each domain
-        current_levels[domain] = level
+        student_max_grade_levels[domain] = grade_level
       end
 
       # iterate through the domain ordering file
-      @DOMAIN_ORDER.each do |r|
-        # get the current level we are on
-        r_level = r[0]
-        # iterate through the level's ordering (R -> L)
-        r[1..-1].each do |r_domain|
-          # grab the max level for the given domain (RF, RI, etc)
-          max_level = current_levels[r_domain]
-
-          if r_level == "K" && max_level != "K" #if the current level is K and max isn't, ignore it
-          elsif r_level == max_level
+      @DOMAIN_ORDER.each do |domain_row|
+        path_obj = {}
+
+        # get the current row's level (grade) we are on
+        domain_row_grade_level = domain_row[0]
+
+        # iterate through the level's ordering (Right -> Left)
+        domain_row[1..-1].each do |commone_core_domain|
+
+          # grab the max grade level for the given cc domain (RF, RI, etc)
+          max_domain_grade_level = student_max_grade_levels[commone_core_domain]
+
+          #if the current level is K and max isn't, ignore it
+          if domain_row_grade_level == "K" && max_domain_grade_level != "K"
+            #don't add it
+          elsif domain_row_grade_level == max_domain_grade_level
             #if the levels match add it
-            path.push("#{r_level}.#{r_domain}")
+            student_path.push({domain_row_grade_level => commone_core_domain })
           else
-            if max_level < r_level
-              path.push("#{r_level}.#{r_domain}")
-            elsif max_level == "K"
-              path.push("#{r_level}.#{r_domain}")
+            if max_domain_grade_level < domain_row_grade_level
+              student_path.push({domain_row_grade_level => commone_core_domain })
+            elsif max_domain_grade_level == "K"
+              student_path.push({domain_row_grade_level => commone_core_domain })
             end
           end
         end
+
       end
-      # return formatted pathing string based on passed limit
-      return "#{name},#{path[0, limit].join(",")}"
+      student = Student.new(current_student_name, student_max_grade_levels, student_path[0...limit])
+
+      return student
     end
   end
 end

data/lib/corepathing/version.rb

@@ -1,3 +1,3 @@
 module Corepathing
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corepathing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,8 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile