academic_benchmarks 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05582989c51ab88e71317ed23866a5dd9c34a956b96791faa86f775c8c09e227'
-  data.tar.gz: c5a713f96b930b2b914674fd57390dd68d0cc8fc9269e3b3503514637d07d746
+  metadata.gz: 50df986c030289fb9f248460b600eebc30b059c7386fa6c5cdeba4d39bbe714a
+  data.tar.gz: 4421c98acc7fbe617d2a8b1b3a8c9a4eb736d7ea65016c4ba5933a52b6f28d35
 SHA512:
-  metadata.gz: a1cf494c1bde537ad7c8f6f6755ad71196b8946b2087479cefe4c9d5c0fee7c7f4657c14853fd8d26b01c2cd864ed8bb99e931404bd1b7c12ee1d8786b30f087
-  data.tar.gz: bb5bfe960f0182139852c1bc27ccda0cce0ae150e81aa8682c1090390d0412b6326f0000a587d948acee8d05363a9233b5466d7c9686cf27ce6fb7e8ecf66ad0
+  metadata.gz: 6f777d12e41775ac0cac11b9a76922b5b10c2957e480f16c0a5ff3c61328b92abfa409389cc6e116d4d41503c8821fce2cb99e0d401bdee09ce2daea2561ab8a
+  data.tar.gz: cf26bcd052ff8b71be7a360ba095580f3c6993dfd235d39e57a378a846bffbfc50790654c285a829e943c638a6f069492211c4c6fe1ec3f91a2e5cc93e040970

data/lib/academic_benchmarks/api/standards.rb

@@ -26,6 +26,7 @@ module AcademicBenchmarks
         document.publication.guid
         document.publication.authorities
         statement.descr
+        utilizations.type
         parent
       ]
 
@@ -57,17 +58,17 @@ module AcademicBenchmarks
         publications(authority_guid: authority.guid)
       end
 
-      def authority_tree(authority_or_auth_code_guid_or_desc, include_obsolete_standards: true)
+      def authority_tree(authority_or_auth_code_guid_or_desc, include_obsolete_standards: true, exclude_examples: false)
         authority = auth_from_code_guid_or_desc(authority_or_auth_code_guid_or_desc)
-        auth_children = raw_search(authority: authority.guid, include_obsoletes: include_obsolete_standards)
+        auth_children = raw_search(authority: authority.guid, include_obsoletes: include_obsolete_standards, exclude_examples: exclude_examples)
         AcademicBenchmarks::Standards::StandardsForest.new(
           auth_children
         ).consolidate_under_root(authority)
       end
 
-      def publication_tree(publication_or_pub_code_guid_or_desc, include_obsolete_standards: true)
+      def publication_tree(publication_or_pub_code_guid_or_desc, include_obsolete_standards: true, exclude_examples: false)
         publication = pub_from_guid(publication_or_pub_code_guid_or_desc)
-        pub_children = raw_search(publication: publication.guid, include_obsoletes: include_obsolete_standards)
+        pub_children = raw_search(publication: publication.guid, include_obsoletes: include_obsolete_standards, exclude_examples: exclude_examples)
         AcademicBenchmarks::Standards::StandardsForest.new(
           pub_children
         ).consolidate_under_root(publication)
@@ -158,6 +159,14 @@ module AcademicBenchmarks
             end
           end
         end
+
+        if query_params.delete :exclude_examples
+          if query_params.key? 'filter[standards]'
+            query_params['filter[standards]'] += " and utilizations.type not eq 'example'"
+          else
+            query_params['filter[standards]'] = "utilizations.type not eq 'example'"
+          end
+        end
       end
 
       def request_facet(query_params)

data/lib/academic_benchmarks/standards/document.rb

@@ -6,6 +6,7 @@ module AcademicBenchmarks
       include InstVarsToHash
 
       attr_accessor :guid, :descr, :publication, :adopt_year, :children
+      alias_method :description, :descr
 
       def self.from_hash(hash)
         self.new(guid: hash["guid"], descr: hash["descr"], publication: hash["publication"], adopt_year: hash["adopt_year"])

data/lib/academic_benchmarks/standards/standard.rb

@@ -1,8 +1,10 @@
+require 'academic_benchmarks/lib/attr_to_vals'
 require 'academic_benchmarks/lib/inst_vars_to_hash'
 
 module AcademicBenchmarks
   module Standards
     class Standard
+      include AttrToVals
       include InstVarsToHash
 
       attr_reader :status, :children
@@ -13,6 +15,7 @@ module AcademicBenchmarks
                     :seq,
                     :section,
                     :document, :disciplines,
+                    :utilizations,
                     :parent, :parent_guid
 
       # Before standards are rebranched in Authority#rebranch_children
@@ -37,6 +40,7 @@ module AcademicBenchmarks
         @children = []
         @document = attr_to_val_or_nil(Document, attributes, "document")
         @statement = attr_to_val_or_nil(Statement, attributes, "statement")
+        @utilizations = attr_to_vals(Utilizations, attributes["utilizations"])
         @parent_guid = data.dig("relationships", "parent", "data", "id")
       end
 

data/lib/academic_benchmarks/standards/utilizations.rb

@@ -0,0 +1,19 @@
+require 'academic_benchmarks/lib/inst_vars_to_hash'
+
+module AcademicBenchmarks
+  module Standards
+    class Utilizations
+      include InstVarsToHash
+
+      attr_accessor :type
+
+      def self.from_hash(hash)
+        self.new(type: hash["type"])
+      end
+
+      def initialize(type:)
+        @type = type
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: academic_benchmarks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Benjamin Porter
@@ -200,6 +200,7 @@ files:
 - lib/academic_benchmarks/standards/standards_tree.rb
 - lib/academic_benchmarks/standards/statement.rb
 - lib/academic_benchmarks/standards/subject.rb
+- lib/academic_benchmarks/standards/utilizations.rb
 homepage: https://github.com/instructure/academic_benchmarks
 licenses:
 - AGPL-3.0