code_ape 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f4950121e8fd3953ee799d787ea5ed7ba556bf1e2072aeec3afe2516d7d7e19
-  data.tar.gz: dcb4d480021614c13ad3132b0b4378e7524dc32c04531bc9b77dd2b1e777ef8a
+  metadata.gz: e09df670abbb4f129bfd0d7863ae2b7a18e0465fe1430ba6fa0dfa1257f7e1f0
+  data.tar.gz: 65c006c76b7cc4cf8a7eea854399a656341ef50bfabb15ceb1bf0d0b9c8aedbd
 SHA512:
-  metadata.gz: 817c44e5f430f0368aa94e6c81c732171b3c952bb6b54c6e77f235d57f077ff2bdb1c7a39a93ebf5fdc9041b3ade9d3868745897dccaa40f1fe3a849479ab590
-  data.tar.gz: 68788da4f284b4dc8dc37a5c1639e453718cfc20f58d77c8ececb6815038cee5ed6ccbbac8e10d856b26a837ea1265fc7166da659b220af6e0fa050be85f3c91
+  metadata.gz: cec0f4acc73693ca049d9ee78056c868cdb85091e71be78f4b8ee81fea8347885dba5bd6007571d32f36ba240ab855919d2de6c1c77468494c8f3d73f62d5f3d
+  data.tar.gz: ee3058ecd2cd103ada9c53a340b48a6708d921531175dc39ea9a70e8e678b1e0cfd1b58c83e486ecab382f65e3eddbaedc28027686c15b2725811a7f363aee32

data/lib/code_ape/class.rb

@@ -0,0 +1,54 @@
+module CodeApe
+  # Regex to parse ape code class (notably in {CodeApe#ape})
+  REGEX_CLASS = /\A(\d{2})\.?(\d{2})([A-Z])\z/i
+
+  # Represent final ape code (all digits + letter)
+  class Class
+    attr_reader :key, :label
+    attr_reader :group_key, :division_key, :subsection_key, :section_key
+
+    # Creates a new {Class}
+    # @param key [Symbol, String] The class key of ape code
+    # @param label [String] The class label of ape code
+    # @param section_key [Symbol, String] The section key of ape code
+    # @param subsection_key [Symbol, String] The subsection key of ape code
+    # @param division_key [Symbol, String] The division key of ape code
+    # @param group_key [Symbol, String] The group key of ape code
+    def initialize(key, label, section_key, subsection_key, division_key, group_key)
+      @key = key.to_s
+      @label = label
+      @section_key = section_key.to_s
+      @subsection_key = subsection_key.to_s
+      @division_key = division_key.to_s
+      @group_key = group_key.to_s
+    end
+
+    # @return [CodeApe::Group] the group of this ape code
+    def group
+      @group ||= GROUPS.find { |e| e.key == @group_key }
+    end
+
+    # @return [CodeApe::Division] the division of this ape code
+    def division
+      @division ||= DIVISIONS.find { |e| e.key == @division_key }
+    end
+
+    # @return [CodeApe::Subsection] the subsection of this ape code
+    def subsection
+      @subsection ||= SUBSECTIONS.find { |e| e.key == @subsection_key }
+    end
+
+    # @return [CodeApe::Section] the section of this ape code
+    def section
+      @section ||= SECTIONS.find { |e| e.key == @section_key }
+    end
+
+    # @return [Hash] the hash representation of class label
+    def to_h
+      {label: @label}
+    end
+  end
+
+  # List of ape code classes
+  CLASSES = NAF_REV2[:classes].map { |k, v| Class.new(k, v[:label], v[:section], v[:subsection], v[:division], v[:group]) }.freeze
+end

data/lib/code_ape/constants.rb

@@ -0,0 +1,6 @@
+module CodeApe
+  require "json"
+
+  # The content of naf_rev2.json (all ape code data)
+  NAF_REV2 = JSON.parse(File.read(File.join(File.dirname(__FILE__), "../naf_rev2.json")), symbolize_names: true)
+end

data/lib/code_ape/division.rb

@@ -0,0 +1,45 @@
+module CodeApe
+  # Regex to parse ape code division (notably in {CodeApe#ape})
+  REGEX_DIVISION = /\A(\d{2})\.?(\d{1})\z/i
+
+  # Represent division of ape code (first 3 digits)
+  class Division
+    attr_reader :key, :label
+
+    # Creates a new {Division}
+    # @param key [Symbol, String] The division key of ape code
+    # @param label [String] The division label of ape code
+    def initialize(key, label)
+      @key = key.to_s
+      @label = label
+    end
+
+    # @return [Array<CodeApe::Class>] the classes associated with division of this ape code
+    def classes
+      @classes ||= CLASSES.select { |e| e.division_key == @key }
+    end
+
+    # @return [Array<CodeApe::Group>] the groups associated with division of this ape code
+    def groups
+      @groups ||= GROUPS.select { |e| classes.map(&:group_key).include?(e.key) }
+    end
+
+    # @return [CodeApe::Subsection] the subsection of this ape code
+    def subsection
+      @subsection ||= SUBSECTIONS.find { |e| e.key == classes[0]&.subsection_key }
+    end
+
+    # @return [CodeApe::Section] the section of this ape code
+    def section
+      @section ||= SECTIONS.find { |e| e.key == classes[0]&.section_key }
+    end
+
+    # @return [Hash] the hash representation of division label
+    def to_h
+      {label: @label}
+    end
+  end
+
+  # List of ape code divisions
+  DIVISIONS = NAF_REV2[:divisions].map { |k, v| Division.new(k, v) }.freeze
+end

data/lib/code_ape/group.rb

@@ -0,0 +1,45 @@
+module CodeApe
+  # Regex to parse ape code group (notably in {CodeApe#ape})
+  REGEX_GROUP = /\A(\d{2})\.?(\d{2})\z/i
+
+  # Represent group of ape code (all digits)
+  class Group
+    attr_reader :key, :label
+
+    # Creates a new {Group}
+    # @param key [Symbol, String] The group key of ape code
+    # @param label [String] The group label of ape code
+    def initialize(key, label)
+      @key = key.to_s
+      @label = label
+    end
+
+    # @return [Array<CodeApe::Class>] the classes associated with group of this ape code
+    def classes
+      @classes ||= CLASSES.select { |e| e.group_key == @key }
+    end
+
+    # @return [CodeApe::Division] the division of this ape code
+    def division
+      @division ||= DIVISIONS.find { |e| e.key == classes[0]&.division_key }
+    end
+
+    # @return [CodeApe::Subsection] the subsection of this ape code
+    def subsection
+      @subsection ||= SUBSECTIONS.find { |e| e.key == classes[0]&.subsection_key }
+    end
+
+    # @return [CodeApe::Section] the section of this ape code
+    def section
+      @section ||= SECTIONS.find { |e| e.key == classes[0]&.section_key }
+    end
+
+    # @return [Hash] the hash representation of group label
+    def to_h
+      {label: @label}
+    end
+  end
+
+  # List of ape code groups
+  GROUPS = NAF_REV2[:groups].map { |k, v| Group.new(k, v) }.freeze
+end

data/lib/code_ape/section.rb

@@ -0,0 +1,42 @@
+module CodeApe
+  # Represent section of ape code (A letter assigned to a subdivision grouping not represented in the final ape code)
+  class Section
+    attr_reader :key, :label
+
+    # Creates a new {Section}
+    # @param key [Symbol, String] The section key of ape code
+    # @param label [String] The section label of ape code
+    def initialize(key, label)
+      @key = key.to_s
+      @label = label
+    end
+
+    # @return [Array<CodeApe::Class>] the classes associated with section of this ape code
+    def classes
+      @classes ||= CLASSES.select { |e| e.section_key == @key }
+    end
+
+    # @return [Array<CodeApe::Group>] the groups associated with section of this ape code
+    def groups
+      @groups ||= GROUPS.select { |e| classes.map(&:group_key).include?(e.key) }
+    end
+
+    # @return [Array<CodeApe::Division>] the divisions associated with section of this ape code
+    def divisions
+      @divisions ||= DIVISIONS.select { |e| classes.map(&:division_key).include?(e.key) }
+    end
+
+    # @return [Array<CodeApe::Subsection>] the subsections associated with section of this ape code
+    def subsections
+      @subsections ||= SUBSECTIONS.select { |e| classes.map(&:subsection_key).include?(e.key) }
+    end
+
+    # @return [Hash] the hash representation of section label
+    def to_h
+      {label: @label}
+    end
+  end
+
+  # List of ape code sections
+  SECTIONS = NAF_REV2[:sections].map { |k, v| Section.new(k, v) }.freeze
+end

data/lib/code_ape/subsection.rb

@@ -0,0 +1,45 @@
+module CodeApe
+  # Regex to parse ape code subsection (notably in {CodeApe#ape})
+  REGEX_SUBSECTION = /\A(\d{2})\z/i
+
+  # Represent subsection of ape code (first 2 digits)
+  class Subsection
+    attr_reader :key, :label
+
+    # Creates a new {Subsection}
+    # @param key [Symbol, String] The subsection key of ape code
+    # @param label [String] The subsection label of ape code
+    def initialize(key, label)
+      @key = key.to_s
+      @label = label
+    end
+
+    # @return [Array<CodeApe::Class>] the classes associated with subsection of this ape code
+    def classes
+      @classes ||= CLASSES.select { |e| e.subsection_key == @key }
+    end
+
+    # @return [Array<CodeApe::Group>] the groups associated with subsection of this ape code
+    def groups
+      @groups ||= GROUPS.select { |e| classes.map(&:group_key).include?(e.key) }
+    end
+
+    # @return [Array<CodeApe::Division>] the divisions associated with subsection of this ape code
+    def divisions
+      @divisions ||= DIVISIONS.select { |e| classes.map(&:division_key).include?(e.key) }
+    end
+
+    # @return [CodeApe::Section] the section of this ape code
+    def section
+      @section ||= SECTIONS.find { |e| e.key == classes[0]&.section_key }
+    end
+
+    # @return [Hash] the hash representation of subsection label
+    def to_h
+      {label: @label}
+    end
+  end
+
+  # List of ape code subsections
+  SUBSECTIONS = NAF_REV2[:subsections].map { |k, v| Subsection.new(k, v) }.freeze
+end

data/lib/code_ape/version.rb

@@ -1,3 +1,4 @@
 module CodeApe
-  VERSION = '2.0.2'.freeze
+  # The current version of code_ape
+  VERSION = "3.0.0".freeze unless const_defined?(:VERSION)
 end

data/lib/code_ape.rb

@@ -1,38 +1,37 @@
-require 'code_ape/version'
+require "code_ape/version"
 
-require 'yaml'
+require "code_ape/constants"
 
-module CodeApe
-  NAF_REV2     ||= YAML.load_file(File.join(File.dirname(__FILE__), 'naf_rev2.yml'))
-
-  #DEPRECATED
-  DIVISION_APE ||= YAML.load_file(File.join(File.dirname(__FILE__), 'division_ape.yml'))
-  CODE_APE     ||= YAML.load_file(File.join(File.dirname(__FILE__), 'code_ape.yml'))
+require "code_ape/section"
+require "code_ape/subsection"
+require "code_ape/division"
+require "code_ape/group"
+require "code_ape/class"
 
+# All CodeApe functionality
+module CodeApe
+  # Takes a ape code and returns data if possible
+  # @param code [String] The ape code to search
+  # @return [CodeApe::Subsection, CodeApe::Division, CodeApe::Group, CodeApe::Class, nil] the ape code data
   def self.ape(code)
-    if NAF_REV2.key?(code.to_s)
-      NAF_REV2[code.to_s]
-    else
-      nil
-    end
-  end
+    upcased_code = code&.upcase
 
-  # DEPRECATED
-  def self.division(code)
-    if DIVISION_APE.key?(code)
-      DIVISION_APE[code]
-    else
-      nil
+    case upcased_code
+    when REGEX_SUBSECTION
+      SUBSECTIONS.find { |e| e.key == upcased_code }
+    when REGEX_DIVISION
+      DIVISIONS.find { |e| e.key == upcased_code || e.key.delete(".") == upcased_code }
+    when REGEX_GROUP
+      GROUPS.find { |e| e.key == upcased_code || e.key.delete(".") == upcased_code }
+    when REGEX_CLASS
+      CLASSES.find { |e| e.key == upcased_code || e.key.delete(".") == upcased_code }
     end
   end
 
-  #DEPRECATED
-  def self.activity(code)
-    if CODE_APE.key?(code)
-      CODE_APE[code]
-    else
-      nil
-    end
+  # Takes a section code and returns data if possible
+  # @param code [String] The section code to search
+  # @return [CodeApe::Section, nil] the section code data
+  def self.section(code)
+    SECTIONS.find { |e| e.key == code&.upcase }
   end
-
 end