academic_benchmarks 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b5ab7ec49f0432d39ca8e694515ba35b46e1893
-  data.tar.gz: 0f54223ad276f77badc5b05c336aab2108b1a199
+  metadata.gz: 5d61a80eca5cb7536525e3359da6693d928d24d4
+  data.tar.gz: 254a3dc74b516c970eb2ec49fb160ef6f285ebbf
 SHA512:
-  metadata.gz: 0eebb41e7bf31faec07dd7d985cba41e95db2551ba0b2602a4ad53621798f92b656b1017bcc308aea037e1eeac6cfb729804c3e35d921ffa2817ec0054007ae9
-  data.tar.gz: 3be9d15c88ad4b18c84d691c2bda4c9c3c080881f7557483a15094f14e117b9edde0c51653ba90d361a9aa4bef7584d3d3f288127d8f2152a3a744c69f1b180b
+  metadata.gz: 69667639168d5e6fb7c90f6fe927a0fedfe21675820432182b0f88776b453ee530fd477f6ae0b35aaa8bd85e8780c0a794e86628ba08a98619a4be5146dbcf2d
+  data.tar.gz: 09e2bacc1aae34f23180c0f0e313e2c49e918f61cbbe4fdc2ce01e65adf8e4b9fd262840fc9a83869fa87360e4d0b861824662cbc62520c0200340ef002c191a

data/lib/academic_benchmarks/api/standards.rb

@@ -50,15 +50,50 @@ module AcademicBenchmarks
       end
 
       def authorities
-        raw_search(list: "authority").map{|a| a["data"]["authority"]}.map{|a| AcademicBenchmarks::Standards::Authority.from_hash(a)}
+        raw_search(list: "authority").map do |a|
+          AcademicBenchmarks::Standards::Authority.from_hash(a["data"]["authority"])
+        end
       end
 
       def documents
-        raw_search(list: "document").map{|a| a["data"]["document"]}.map{|a| AcademicBenchmarks::Standards::Document.from_hash(a)}
+        raw_search(list: "document").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
+        auth_children = search(authority: authority.code)
+        StandardsForest.new(auth_children).consolidate_under_root(authority)
       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,
+            "Authority code, guid, or description matched more than one authority.  " \
+            "matched '#{auths.map(&:to_json).join('; ')}'"
+        end
+        auths.first
+      end
+
+      def match_authority(authority_code_guid_or_desc)
+        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
+        end
+      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,14 +1,50 @@
 
+#
+# This module will allow you to properly to_s, to_h, and to_json
+# on classes in which it is included.
+#
+# It is not intended to be general purpose, but rather should
+# be used only with standards and standards-related data
+# structures, which themselves are mirrors of the JSON
+# definitions used by Academic Benchmarks
+#
+
 module InstVarsToHash
-  def to_s
-    to_h.to_s
+  def to_s(omit_parent: true)
+    to_h(omit_parent: omit_parent).to_s
   end
 
-  def to_h
+  def to_h(omit_parent: true)
     retval = {}
     instance_variables.each do |iv|
-      retval[iv.to_s.gsub('@', '').to_sym] = instance_variable_get(iv)
+      unless omit_parent && (iv =~ /^@?parent$/i)
+        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
+  end
+
+  private
+
+  def expandable_classes
+    [ Hash, InstVarsToHash ]
+  end
+
+  def expandable_to_hash(klass)
+    expandable_classes.any?{ |k| klass == k || klass < k }
+  end
+
+  def elem_to_h(elem)
+    if elem.class == Array
+      elem.map { |el| elem_to_h(el) }
+    elsif expandable_to_hash(elem.class)
+      elem.to_h
+    else
+      elem
+    end
+  end
 end

data/lib/academic_benchmarks/standards/authority.rb

@@ -5,7 +5,7 @@ module AcademicBenchmarks
     class Authority
       include InstVarsToHash
 
-      attr_accessor :code, :guid, :description
+      attr_accessor :code, :guid, :description, :children
 
       alias_method :descr, :description
 
@@ -13,10 +13,11 @@ module AcademicBenchmarks
         self.new(code: hash["code"], guid: hash["guid"], description: hash["descr"])
       end
 
-      def initialize(code:, guid:, description:)
+      def initialize(code:, guid:, description:, children: [])
         @code = code
         @guid = guid
         @description = description
+        @children = children
       end
     end
   end

data/lib/academic_benchmarks/standards/standards_forest.rb

@@ -30,6 +30,15 @@ module AcademicBenchmarks
         end
       end
 
+      def consolidate_under_root(root)
+        trees.each do |tree|
+          tree.root.parent = root
+          tree.root.parent_guid = root.guid
+          root.children.push(tree.root)
+        end
+        StandardsTree.new(root)
+      end
+
       def add_standard(standard)
         if standard.is_a?(Standard)
           raise StandardError.new(
@@ -53,6 +62,18 @@ module AcademicBenchmarks
         @trees.empty?
       end
 
+      def to_s
+        trees.map{|tree| tree.to_s}
+      end
+
+      def to_h
+        trees.map{|tree| tree.to_h}
+      end
+
+      def to_json
+        trees.map{|tree| tree.to_json}
+      end
+
       private
 
       def to_standard(item)

data/lib/academic_benchmarks/standards/standards_tree.rb

@@ -1,14 +1,17 @@
+require 'active_support/core_ext/module'
+
 module AcademicBenchmarks
   module Standards
     class StandardsTree
-      attr_reader :root_standard
+      attr_reader :root
+      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_standard, build_item_hash: true)
-        @root_standard = root_standard
+      def initialize(root, build_item_hash: true)
+        @root = root
         if build_item_hash
           @item_hash = {}
           go_ahead_and_build_item_hash
@@ -39,8 +42,8 @@ module AcademicBenchmarks
       private
 
       def go_ahead_and_build_item_hash
-        @item_hash[@root_standard.guid] = @root_standard
-        add_children_to_item_hash(@root_standard)
+        @item_hash[@root.guid] = @root
+        add_children_to_item_hash(@root)
       end
 
       def add_children_to_item_hash(parent)
@@ -51,8 +54,8 @@ module AcademicBenchmarks
       end
 
       def find_parent(standard)
-        return @root_standard if @root_standard.guid == standard.parent_guid
-        check_children_for_parent(standard.parent_guid, @root_standard)
+        return @root if @root.guid == standard.parent_guid
+        check_children_for_parent(standard.parent_guid, @root)
       end
 
       # does a depth-first search

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: academic_benchmarks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Benjamin Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement