degree_parse 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +47 -0
- data/Rakefile +2 -0
- data/degree_parse.gemspec +23 -0
- data/lib/degree_parse.rb +79 -0
- data/lib/degree_parse/version.rb +3 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 9786e1f9a43d2d4d8180306f5fa6b69198297558
|
4
|
+
data.tar.gz: fdb7b52ec9ed4e6ff87c8cd8ffc4eba3fa551911
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 58e3df8eb1aa9b0c2354e131b2c5face1d932c3ce6b85b3c7253aa594a9db526625d64c74c773efebac46f90108424b2b1d199dfdad088ff5d25eaf8d03496b3
|
7
|
+
data.tar.gz: f296f41ec04681d6a188e9265b2edd8283162232f902ce0f4ea4a93bcc2755be2ca25d5ba2ac62304238c67e4e5b16e61f4eb04cea374e5fb109b372943bf685
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2015 Ricardo Piro-Rael
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# DegreeParse
|
2
|
+
|
3
|
+
TODO: Write a gem description
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'degree_parse'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install degree_parse
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
TODO: Write usage instructions here
|
24
|
+
|
25
|
+
## Contributing
|
26
|
+
|
27
|
+
1. Fork it ( https://github.com/[my-github-username]/degree_parse/fork )
|
28
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
29
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
30
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
31
|
+
5. Create a new Pull Request
|
32
|
+
# YAML Degree Requirements
|
33
|
+
|
34
|
+
This format allows us to specify degree plans in YAML format, and parse a
|
35
|
+
student to check this student against degree requirements. The next phase is to
|
36
|
+
make this parser produce Prolog code, and use that for reasoning.
|
37
|
+
|
38
|
+
# Getting started
|
39
|
+
|
40
|
+
To use this, first install the `yaml` and `erb` gems.
|
41
|
+
|
42
|
+
``` bash
|
43
|
+
gem install yaml
|
44
|
+
gem install erb
|
45
|
+
```
|
46
|
+
|
47
|
+
Next,
|
data/Rakefile
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'degree_parse/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "degree_parse"
|
8
|
+
spec.version = DegreeParse::VERSION
|
9
|
+
spec.authors = ["Ricardo Piro-Rael"]
|
10
|
+
spec.email = ["fdisk@fdisk.co"]
|
11
|
+
spec.summary = %q{A gem to parse degree requirements using YAML}
|
12
|
+
spec.description = %q{This gem allows us to quickly parse degrees using YAML, then translate them to Prolog.}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
22
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
23
|
+
end
|
data/lib/degree_parse.rb
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
require "degree_parse/version"
|
2
|
+
require 'yaml'
|
3
|
+
require 'erb'
|
4
|
+
|
5
|
+
module DegreeParse
|
6
|
+
|
7
|
+
class Student
|
8
|
+
|
9
|
+
attr_reader :courses, :satisfied
|
10
|
+
|
11
|
+
def initialize(courses, requirements)
|
12
|
+
@requirements = Requirements.new(requirements)
|
13
|
+
@courses = courses.map { |name, attr| Course.new(name, hours: @requirements.get_hours(name), grade: attr["grade"]) }
|
14
|
+
end
|
15
|
+
|
16
|
+
def check
|
17
|
+
@satisfied ||= @requirements.check @courses
|
18
|
+
end
|
19
|
+
|
20
|
+
end
|
21
|
+
|
22
|
+
class Requirements
|
23
|
+
|
24
|
+
attr_reader :requirements
|
25
|
+
|
26
|
+
def initialize(filename)
|
27
|
+
@requirements = YAML.load(import filename).merge YAML.load(import "courses.yml")
|
28
|
+
end
|
29
|
+
|
30
|
+
def import *files
|
31
|
+
files.map{ |file| { File.basename(file, File.extname(file)) => YAML.load(ERB.new(File.read file).result(binding)) } }.reduce(:concat).to_yaml
|
32
|
+
end
|
33
|
+
|
34
|
+
def check(taken, requirements = @requirements, name = "main", checked = [])
|
35
|
+
requirements.each do |key, value|
|
36
|
+
if key == "courses"
|
37
|
+
courses = value.map { |name, attr| Course.new(name, hours: get_hours(name), grade: attr["grade"]) }
|
38
|
+
checked << { name => match(taken, courses, hours: requirements["hours"], take: requirements["take"]) }
|
39
|
+
else
|
40
|
+
check(taken, requirements[key], key, checked) unless key == "hours" || key == "take"
|
41
|
+
end
|
42
|
+
end
|
43
|
+
checked
|
44
|
+
end
|
45
|
+
|
46
|
+
def match(taken, required, hours: nil, take: required.length)
|
47
|
+
take ||= required.length
|
48
|
+
courses_in_scope = taken.select { |course| required.map(&:name).include? course.name }
|
49
|
+
passed = courses_in_scope.select { |course| required.find{ |r| r.name == course.name}.check(course.grade) }
|
50
|
+
taken_hours = passed.map(&method(:get_hours)).reduce :+
|
51
|
+
taken_hours.to_i >= hours.to_i && (passed.map(&:name) & required.map(&:name)).length >= take
|
52
|
+
end
|
53
|
+
|
54
|
+
def get_hours(course)
|
55
|
+
name = course.is_a?(Course) ? course.name : course
|
56
|
+
@requirements["courses"][name]["hours"].to_i
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
|
61
|
+
class Course
|
62
|
+
|
63
|
+
attr_reader :name, :hours, :grade
|
64
|
+
|
65
|
+
@@grades = ["I","F","W","D-","D","D+","C-","C","C+","B-","B","B+","A-","A","A+"]
|
66
|
+
|
67
|
+
def initialize(name, hours: nil, grade: "C")
|
68
|
+
@name = name
|
69
|
+
@hours = hours
|
70
|
+
@grade = grade || "C"
|
71
|
+
end
|
72
|
+
|
73
|
+
def check(grade)
|
74
|
+
@@grades.index(grade).to_i >= @@grades.index(@grade).to_i
|
75
|
+
end
|
76
|
+
|
77
|
+
end
|
78
|
+
|
79
|
+
end
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: degree_parse
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ricardo Piro-Rael
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-04-22 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
description: This gem allows us to quickly parse degrees using YAML, then translate
|
42
|
+
them to Prolog.
|
43
|
+
email:
|
44
|
+
- fdisk@fdisk.co
|
45
|
+
executables: []
|
46
|
+
extensions: []
|
47
|
+
extra_rdoc_files: []
|
48
|
+
files:
|
49
|
+
- ".gitignore"
|
50
|
+
- Gemfile
|
51
|
+
- LICENSE.txt
|
52
|
+
- README.md
|
53
|
+
- Rakefile
|
54
|
+
- degree_parse.gemspec
|
55
|
+
- lib/degree_parse.rb
|
56
|
+
- lib/degree_parse/version.rb
|
57
|
+
homepage: ''
|
58
|
+
licenses:
|
59
|
+
- MIT
|
60
|
+
metadata: {}
|
61
|
+
post_install_message:
|
62
|
+
rdoc_options: []
|
63
|
+
require_paths:
|
64
|
+
- lib
|
65
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '0'
|
75
|
+
requirements: []
|
76
|
+
rubyforge_project:
|
77
|
+
rubygems_version: 2.4.5
|
78
|
+
signing_key:
|
79
|
+
specification_version: 4
|
80
|
+
summary: A gem to parse degree requirements using YAML
|
81
|
+
test_files: []
|
82
|
+
has_rdoc:
|