academic_benchmarks 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d61a80eca5cb7536525e3359da6693d928d24d4
-  data.tar.gz: 254a3dc74b516c970eb2ec49fb160ef6f285ebbf
+  metadata.gz: 7541ca8bbc79a966e924b5de4bd0cfd407d154c3
+  data.tar.gz: 00c65e4ec6204e68cff41b59db745b5e70982194
 SHA512:
-  metadata.gz: 69667639168d5e6fb7c90f6fe927a0fedfe21675820432182b0f88776b453ee530fd477f6ae0b35aaa8bd85e8780c0a794e86628ba08a98619a4be5146dbcf2d
-  data.tar.gz: 09e2bacc1aae34f23180c0f0e313e2c49e918f61cbbe4fdc2ce01e65adf8e4b9fd262840fc9a83869fa87360e4d0b861824662cbc62520c0200340ef002c191a
+  metadata.gz: 57c6ccc816f6552ae6b5fd5d755ab2bd912660ea73d16c6dc7efaeea89e6c490a1580d0853261735e6f18f5abf3688d8b0b5e05c0b63c5d2d9854cef44213cc9
+  data.tar.gz: 7cb00c099914d545e8011c3a93afd270d1b65440f2c977ac4252e8edfa2fbf08c2865d10a1ef84ecb88052254d94e4e7ff6c77ba9834a85d1a29acf7ceef200f

data/lib/academic_benchmarks/api/standards.rb

@@ -49,51 +49,86 @@ module AcademicBenchmarks
         request_search_pages_and_concat_resources(auth_query_params)
       end
 
-      def authorities
-        raw_search(list: "authority").map do |a|
+      def authorities(query_params = {})
+        raw_search({list: "authority"}.merge(query_params)).map do |a|
           AcademicBenchmarks::Standards::Authority.from_hash(a["data"]["authority"])
         end
       end
 
-      def documents
-        raw_search(list: "document").map do |a|
+      def documents(query_params = {})
+        raw_search({list: "document"}.merge(query_params)).map do |a|
           AcademicBenchmarks::Standards::Document.from_hash(a["data"]["document"])
         end
       end
 
-      def authority_tree(authority_or_authority_code_guid_or_desc)
-        authority = if authority_or_authority_code_guid_or_desc.is_a?(Authority)
-                      authority_or_authority_code_guid_or_desc
-                    else
-                      find_authority(authority_or_authority_code_guid_or_desc)
-                    end
+      def authority_documents(authority_or_auth_code_guid_or_desc)
+        authority = auth_from_code_guid_or_desc(authority_or_auth_code_guid_or_desc)
+        documents(authority: authority.code)
+      end
+
+      def authority_tree(authority_or_auth_code_guid_or_desc, include_obsolete_standards: true)
+        authority = auth_from_code_guid_or_desc(authority_or_auth_code_guid_or_desc)
         auth_children = search(authority: authority.code)
-        StandardsForest.new(auth_children).consolidate_under_root(authority)
+        AcademicBenchmarks::Standards::StandardsForest.new(
+          auth_children,
+          include_obsoletes: include_obsolete_standards
+        ).consolidate_under_root(authority)
+      end
+
+      def document_tree(document_or_guid, include_obsolete_standards: true)
+        document = doc_from_guid(document_or_guid)
+        doc_children = search(document: document.guid)
+        AcademicBenchmarks::Standards::StandardsForest.new(
+          doc_children,
+          include_obsoletes: include_obsolete_standards
+        ).consolidate_under_root(document)
       end
 
       private
 
-      def find_authority(authority_code_guid_or_desc)
-        auths = match_authority(authority_code_guid_or_desc)
-        if auths.empty?
-          raise StandardError,
-            "No authority code, guid, or description matched '#{authority_code_guid_or_desc}'"
-        elsif auths.count > 1
-          raise StandardError,
+      def doc_from_guid(document_or_guid)
+        if document_or_guid.is_a?(AcademicBenchmarks::Standards::Document)
+          document_or_guid
+        else
+          find_type(type: "document", data: document_or_guid)
+        end
+      end
+
+      def auth_from_code_guid_or_desc(authority_or_auth_code_guid_or_desc)
+        if authority_or_auth_code_guid_or_desc.is_a?(AcademicBenchmarks::Standards::Authority)
+          authority_or_auth_code_guid_or_desc
+        else
+          find_type(type: "authority", data: authority_or_auth_code_guid_or_desc)
+        end
+      end
+
+      def find_type(type:, data:)
+        matches = send("match_#{type}", data)
+        if matches.empty?
+          raise StandardError.new(
+            "No #{type} code, guid, or description matched '#{data}'"
+          )
+        elsif matches.count > 1
+          raise StandardError.new(
             "Authority code, guid, or description matched more than one authority.  " \
-            "matched '#{auths.map(&:to_json).join('; ')}'"
+            "matched '#{matches.map(&:to_json).join('; ')}'"
+          )
         end
-        auths.first
+        matches.first
       end
 
-      def match_authority(authority_code_guid_or_desc)
+      def match_authority(data)
         authorities.select do |auth|
-          auth.code  == authority_code_guid_or_desc ||
-          auth.guid  == authority_code_guid_or_desc ||
-          auth.descr == authority_code_guid_or_desc
+          auth.code  == data ||
+          auth.guid  == data ||
+          auth.descr == data
         end
       end
 
+      def match_document(data)
+        documents.select { |doc| doc.guid == data }
+      end
+
       def raw_search(opts = {})
         request_search_pages_and_concat_resources(opts.merge(auth_query_params))
       end

data/lib/academic_benchmarks/lib/inst_vars_to_hash.rb

@@ -1,4 +1,3 @@
-
 #
 # This module will allow you to properly to_s, to_h, and to_json
 # on classes in which it is included.
@@ -10,22 +9,28 @@
 #
 
 module InstVarsToHash
-  def to_s(omit_parent: true)
-    to_h(omit_parent: omit_parent).to_s
+  def to_s(omit_parent: true, omit_empty_children: true)
+    to_h(
+      omit_parent: omit_parent,
+      omit_empty_children: omit_empty_children
+    ).to_s
   end
 
-  def to_h(omit_parent: true)
+  def to_h(omit_parent: true, omit_empty_children: true)
     retval = {}
     instance_variables.each do |iv|
-      unless omit_parent && (iv =~ /^@?parent$/i)
+      if !(skip_parent?(omit_parent, iv) || skip_children?(omit_empty_children, iv))
         retval[iv.to_s.delete('@').to_sym] = elem_to_h(instance_variable_get(iv))
       end
     end
     retval
   end
 
-  def to_json(omit_parent: true)
-    to_h(omit_parent: omit_parent).to_json
+  def to_json(omit_parent: true, omit_empty_children: true)
+    to_h(
+      omit_parent: omit_parent,
+      omit_empty_children: omit_empty_children
+    ).to_json
   end
 
   private
@@ -47,4 +52,12 @@ module InstVarsToHash
       elem
     end
   end
+
+  def skip_parent?(omit_parent, iv)
+    omit_parent && (iv =~ /^@?parent$/i)
+  end
+
+  def skip_children?(omit_empty_children, iv)
+    omit_empty_children && (iv =~ /^@?children$/i) && instance_variable_get(iv).empty?
+  end
 end

data/lib/academic_benchmarks/lib/remove_obsolete_children.rb

@@ -0,0 +1,10 @@
+module RemoveObsoleteChildren
+  def remove_obsolete_children
+    @children.delete_if do |child|
+      unless child.obsolete?
+        child.remove_obsolete_children
+      end
+      child.obsolete?
+    end
+  end
+end

data/lib/academic_benchmarks/standards/authority.rb

@@ -1,9 +1,11 @@
 require_relative '../lib/inst_vars_to_hash'
+require_relative '../lib/remove_obsolete_children'
 
 module AcademicBenchmarks
   module Standards
     class Authority
       include InstVarsToHash
+      include RemoveObsoleteChildren
 
       attr_accessor :code, :guid, :description, :children
 

data/lib/academic_benchmarks/standards/document.rb

@@ -1,19 +1,22 @@
 require_relative '../lib/inst_vars_to_hash'
+require_relative '../lib/remove_obsolete_children'
 
 module AcademicBenchmarks
   module Standards
     class Document
       include InstVarsToHash
+      include RemoveObsoleteChildren
 
-      attr_accessor :title, :guid
+      attr_accessor :title, :guid, :children
 
       def self.from_hash(hash)
         self.new(title: hash["title"], guid: hash["guid"])
       end
 
-      def initialize(title:, guid:)
+      def initialize(title:, guid:, children: [])
         @title = title
         @guid = guid
+        @children = children
       end
     end
   end

data/lib/academic_benchmarks/standards/standard.rb

@@ -1,15 +1,18 @@
 require_relative '../lib/inst_vars_to_hash'
+require_relative '../lib/remove_obsolete_children'
 
 module AcademicBenchmarks
   module Standards
     class Standard
       include InstVarsToHash
+      include RemoveObsoleteChildren
 
       attr_reader :status, :deepest, :children
+      attr_writer :grade
       attr_accessor :guid, :description, :number, :stem, :label, :level,
                     :version, :seq, :adopt_year, :authority, :course,
-                    :document, :grade, :has_relations, :subject,
-                    :subject_doc, :parent, :parent_guid
+                    :document, :has_relations, :subject, :subject_doc,
+                    :parent, :parent_guid
 
       alias_method :descr, :description
 
@@ -34,7 +37,7 @@ module AcademicBenchmarks
         @subject_doc = attr_to_val_or_nil(SubjectDoc, data, "subject_doc")
         @has_relations = attr_to_val_or_nil(HasRelations, data, "has_relations")
 
-        # Parent guid extraction can be a little more complicated. Thanks AB!
+        # Parent guid extraction can be a little more complicated
         if data["parent"] && data["parent"].is_a?(String)
           @parent_guid = data["parent"]
         elsif data["parent"] && data["parent"].is_a?(Hash)
@@ -42,6 +45,8 @@ module AcademicBenchmarks
         end
       end
 
+      alias_method :from_hash, :initialize
+
       def active?
         status == "Active"
       end
@@ -71,13 +76,17 @@ module AcademicBenchmarks
       end
 
       def add_child(child)
+        raise StandardError.new("Tried to add self as a child") if self == child
+
         unless child.is_a?(Standard)
           raise ArgumentError.new("Tried to set child that isn't a Standard")
         end
+        child.parent = self
         @children.push(child)
       end
 
       def remove_child(child)
+        child.parent = nil
         @children.delete(child)
       end
 
@@ -85,10 +94,26 @@ module AcademicBenchmarks
         @children.count > 0
       end
 
+      def leaf?
+        !has_children?
+      end
+
+      def grade
+        return @grade if @grade
+
+        # check to see if one of our parents has a grade.  Use that if so
+        p = parent
+        while p
+          return p.grade if p.grade
+          p = p.parent
+        end
+        nil
+      end
+
       private
 
       def attr_to_val_or_nil(klass, hash, attr)
-        return nil unless hash.has_key?(attr)
+        return nil unless hash.key?(attr)
         klass.from_hash(hash)
       end
     end

data/lib/academic_benchmarks/standards/standards_forest.rb

@@ -1,7 +1,7 @@
 module AcademicBenchmarks
   module Standards
     class StandardsForest
-      attr_reader :trees, :data_hash
+      attr_reader :trees, :data_hash, :orphans
 
       # The guid to standard hash can optionally be saved to permit speedily
       # adding standards to the tree (since the tree is unordered,
@@ -13,21 +13,29 @@ module AcademicBenchmarks
       def initialize(
         data_hash,
         save_guid_to_standard_hash: true,
-        save_initial_data_hash: false
+        save_initial_data_hash: false,
+        include_obsoletes: true
       )
         @data_hash = data_hash.dup.freeze if save_initial_data_hash
         @guid_to_standard = {} # a hash of guids to standards
         @trees = []
+        @orphans = []
         process_items(data_hash)
 
+        @trees.delete_if(&:obsolete?) unless include_obsoletes
+
         # upgrade the hash data to a StandardsTree object
         @trees.map! do |item|
-          StandardsTree.new(item, build_item_hash: save_guid_to_standard_hash)
+          StandardsTree.new(
+            item,
+            build_item_hash: save_guid_to_standard_hash,
+            include_obsoletes: include_obsoletes
+          )
         end
 
-        unless save_guid_to_standard_hash
-          remove_instance_variable('@guid_to_standard')
-        end
+        # We will still have the guid-to-standards saved at the Tree level,
+        # so we can safely remove this variable and let the GC free the memory
+        remove_instance_variable('@guid_to_standard')
       end
 
       def consolidate_under_root(root)
@@ -36,7 +44,7 @@ module AcademicBenchmarks
           tree.root.parent_guid = root.guid
           root.children.push(tree.root)
         end
-        StandardsTree.new(root)
+        StandardsTree.new(root).tap{ |st| st.add_orphans(@orphans) }
       end
 
       def add_standard(standard)
@@ -49,7 +57,7 @@ module AcademicBenchmarks
         else
           raise ArgumentError.new(
             "standard must be an 'AcademicBenchmarks::Standards::Standard' " \
-            "or a 'Hash' but was a #{standard.class.to_s}"
+            "or a 'Hash' but was a #{standard.class}"
           )
         end
       end
@@ -62,16 +70,20 @@ module AcademicBenchmarks
         @trees.empty?
       end
 
+      def has_orphans?
+        @orphans.count > 0
+      end
+
       def to_s
-        trees.map{|tree| tree.to_s}
+        trees.map(&:to_s)
       end
 
       def to_h
-        trees.map{|tree| tree.to_h}
+        trees.map(&:to_h)
       end
 
       def to_json
-        trees.map{|tree| tree.to_json}
+        trees.map(&:to_h).to_json
       end
 
       private
@@ -96,22 +108,21 @@ module AcademicBenchmarks
       def link_parent_and_children
         @guid_to_standard.values.each do |child|
           if child.parent_guid
-            present_in_hash_or_raise(child.parent_guid)
-            parent = @guid_to_standard[child.parent_guid]
-            parent.add_child(child)
-            child.parent = parent
+            parent_in_hash?(child.parent_guid) ? set_parent_and_child(child) : @orphans.push(child)
           else
             @trees.push(child)
           end
         end
       end
 
-      def present_in_hash_or_raise(guid)
-        unless @guid_to_standard.has_key?(guid)
-          raise StandardError.new(
-            "item missing from guid_to_standard hash"
-          )
-        end
+      def set_parent_and_child(child)
+        parent = @guid_to_standard[child.parent_guid]
+        parent.add_child(child)
+        child.parent = parent
+      end
+
+      def parent_in_hash?(guid)
+        @guid_to_standard.key?(guid)
       end
     end
   end

data/lib/academic_benchmarks/standards/standards_tree.rb

@@ -3,15 +3,18 @@ require 'active_support/core_ext/module'
 module AcademicBenchmarks
   module Standards
     class StandardsTree
-      attr_reader :root
+      attr_reader :root, :orphans
       delegate :children, :to_s, :to_h, :to_json, to: :root
 
       # The item hash can optionally be built to permit the speedy
       # addition of standards to the tree. since the tree is unordered,
       # adding to it can be expensive without this
 
-      def initialize(root, build_item_hash: true)
+      def initialize(root, build_item_hash: true, include_obsoletes: true)
+        @orphans = []
         @root = root
+        prune_obsolete_branches unless include_obsoletes
+
         if build_item_hash
           @item_hash = {}
           go_ahead_and_build_item_hash
@@ -34,11 +37,23 @@ module AcademicBenchmarks
         else
           raise ArgumentError.new(
             "standard must be an 'AcademicBenchmarks::Standards::Standard' " \
-            "or a 'Hash' but was a #{standard.class.to_s}"
+            "or a 'Hash' but was a #{standard.class}"
           )
         end
       end
 
+      def add_orphan(orphan)
+        add_orphans([orphan])
+      end
+
+      def add_orphans(orphans)
+        @orphans.concat(orphans)
+      end
+
+      def has_orphans?
+        @orphans.present?
+      end
+
       private
 
       def go_ahead_and_build_item_hash
@@ -65,6 +80,10 @@ module AcademicBenchmarks
           check_children_for_parent(parent_guid, child) if child.has_children?
         end
       end
+
+      def prune_obsolete_branches
+        root.remove_obsolete_children
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: academic_benchmarks
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Benjamin Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -155,6 +155,7 @@ files:
 - lib/academic_benchmarks/api/handle.rb
 - lib/academic_benchmarks/api/standards.rb
 - lib/academic_benchmarks/lib/inst_vars_to_hash.rb
+- lib/academic_benchmarks/lib/remove_obsolete_children.rb
 - lib/academic_benchmarks/standards/authority.rb
 - lib/academic_benchmarks/standards/course.rb
 - lib/academic_benchmarks/standards/document.rb