odca 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 562f570cb79b02ab96b7a11c6f420618cd3c492c
-  data.tar.gz: 2ada1a4608bbe3ebc638a48a7930e1c400822833
+  metadata.gz: 2ee133fe221ff06912b00edf86e317ba229e7154
+  data.tar.gz: fc77a7f7a79bc1b914e14838110ca8b0487111a8
 SHA512:
-  metadata.gz: 650781f9962b095d9453df16e1a308e56106efbc9bba6161f7024c3ece4e43433be408defe70e74968cbbb035ad2a3971bf179b469740e6cc8fc28d74f9357d8
-  data.tar.gz: fb3b5e88c8c20294e8c2b702edab6030027694f05123dd1294d0f06eb675ee8b5c4d250830709be5d468eb3ad2d6c20557faf3bd660b6728b1e4cc787697f6f8
+  metadata.gz: 34e413488e8df0de267d2f3a962c57d0576ee1c24bd5ebb27705220bcff6f9b53bbe4569445dc97b82e8e2b6a496003cc0af9d60cbaf5b6ec7ff26d4536e8716
+  data.tar.gz: 3dae720cd4c23a489cbaec68436df826297c459a39d469b5714c89c0da869cc6b20bb4844703acd1c26908c9de64764e070ed8c44d2cf3fe3244f7e5e4f46335

data/.gitignore

@@ -43,7 +43,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/config/overlays_info.yml

@@ -1,35 +1,29 @@
 label:
   type_v1: spec/overlay/label/1.0
-  description: Category and attribute labels for %{schema_name}
 
 format:
   type_v1: spec/overlay/format/1.0
-  description: Attribute formats for %{schema_name}
 
-encode:
-  type_v1: spec/overlay/encode/1.0
-  description: Character set encoding for %{schema_name}
+character_encoding:
+  type_v1: spec/overlay/character_encoding/1.0
 
 entry:
   type_v1: spec/overlay/entry/1.0
-  description: Field entries for %{schema_name}
 
 information:
   type_v1: spec/overlay/information/1.0
-  description: Informational items for %{schema_name}
 
 conditional:
   type_v1: spec/overlay/conditional/1.0
-  description:
 
 source:
   type_v1: spec/overlay/source/1.0
-  description: Source endpoints for %{schema_name}
 
 review:
   type_v1: spec/overlay/review/1.0
-  description: Field entry review comments for %{schema_name}
 
 masking:
   type_v1: spec/overlay/masking/1.0
-  description: Masking attributes for %{schema_name}
+
+mapping:
+  type_v1: spec/overlay/mapping/1.0

data/lib/odca.rb

@@ -3,15 +3,9 @@ require 'odca/parser'
 require 'odca/schema_base'
 require 'odca/headful_overlay'
 require 'odca/parentful_overlay'
-require 'odca/overlays/format_overlay'
-require 'odca/overlays/label_overlay'
-require 'odca/overlays/encode_overlay'
-require 'odca/overlays/entry_overlay'
-require 'odca/overlays/information_overlay'
-require 'odca/overlays/conditional_overlay'
-require 'odca/overlays/source_overlay'
-require 'odca/overlays/review_overlay'
-require 'odca/overlays/masking_overlay'
+Dir[File.expand_path('../odca/overlays/*.rb', __FILE__)].each do |file|
+  require file
+end
 
 module Odca
   ROOT_PATH = File.expand_path('..', File.dirname(__FILE__))

data/lib/odca/hashlink_generator.rb

@@ -1,15 +1,10 @@
-require 'digest/sha2'
-require 'base58'
+require 'hashlink'
 require 'json'
 
 module Odca
   class HashlinkGenerator
     def self.call(schema)
-      Base58.encode(
-        Digest::SHA2.hexdigest(
-          JSON.pretty_generate(schema)
-        ).to_i(16)
-      )
+      Hashlink.encode(data: JSON.generate(schema)).split(':')[1]
     end
   end
 end

data/lib/odca/headful_overlay.rb

@@ -32,11 +32,7 @@ module Odca
         Odca::Overlays::Header.new(
           role: role,
           purpose: purpose,
-          type: overlay_info['type_v1'],
-          description: format(
-            overlay_info['description'],
-            schema_name: parentful_overlay.parent.name
-          )
+          type: overlay_info['type_v1']
         )
     end
 
@@ -48,7 +44,7 @@ module Odca
 
     def overlay_info
       overlay_class_name = overlay.class.name.split('::').last
-      overlay_key = overlay_class_name.gsub('Overlay', '').downcase
+      overlay_key = overlay_class_name.gsub('Overlay', '').gsub(/([^\^])([A-Z])/,'\1_\2').downcase
       overlays_info.fetch(overlay_key) do
         raise "Not found specific information about #{overlay_class_name}"
       end

data/lib/odca/overlays/{encode_overlay.rb → character_encoding_overlay.rb}

@@ -3,15 +3,15 @@ require 'odca/null_value'
 
 module Odca
   module Overlays
-    class EncodeOverlay
+    class CharacterEncodingOverlay
       extend Overlay
 
       DEFAULT_ENCODING = 'utf-8'.freeze
 
       def to_h
         {
-          default_encoding: DEFAULT_ENCODING,
-          attr_encoding: attr_values
+          default_character_encoding: DEFAULT_ENCODING,
+          attr_character_encoding: attr_values
         }
       end
     end

data/lib/odca/overlays/header.rb

@@ -1,13 +1,12 @@
 module Odca
   module Overlays
     class Header
-      attr_reader :issued_by, :role, :purpose, :description, :type
+      attr_reader :issued_by, :role, :purpose, :type
 
-      def initialize(role:, purpose:, description:, type:, issued_by: '')
+      def initialize(role:, purpose:, type:, issued_by: '')
         @issued_by = issued_by
         @role = role
         @purpose = purpose
-        @description = description
         @type = type
       end
 
@@ -15,7 +14,6 @@ module Odca
         {
           '@context' => 'https://odca.tech/overlays/v1',
           type: type,
-          description: description,
           issued_by: issued_by,
           role: role || '',
           purpose: purpose || ''

data/lib/odca/overlays/label_overlay.rb

@@ -3,20 +3,22 @@ require 'odca/null_value'
 module Odca
   module Overlays
     class LabelOverlay
-      attr_reader :attributes, :language
+      attr_reader :attributes, :language, :category_resolver
 
-      def initialize(language:)
+      def initialize(language:, category_resolver: CategoryResolver.new)
         @attributes = []
         @language = language
+        @category_resolver = category_resolver
       end
 
       def to_h
+        resolved_categories = category_resolver.call(attributes)
         {
           language: language,
           attr_labels: attr_labels,
-          attr_categories: attr_categories,
-          category_labels: category_labels,
-          category_attributes: category_attributes
+          attr_categories: resolved_categories.attr_categories,
+          cat_labels: resolved_categories.category_labels,
+          cat_attributes: resolved_categories.category_attributes
         }
       end
 
@@ -35,35 +37,78 @@ module Odca
         end
       end
 
-      private def attr_categories
-        attributes.map(&:category).uniq.map do |cat|
-          next if cat.empty?
-          cat.downcase.gsub(/\s+/, '_').to_sym
-        end.compact
-      end
+      class CategoryResolver
+        attr_reader :attr_categories, :category_labels, :category_attributes
+
+        def initialize
+          @attr_categories = []
+          @category_labels = {}
+          @category_attributes = {}
+        end
 
-      private def category_labels
-        attributes.map(&:category).uniq
-          .each_with_object({}) do |cat, memo|
-            next if cat.empty?
-            memo[cat.downcase.gsub(/\s+/, '_').to_sym] = cat
+        def call(attributes)
+          attributes.each do |attribute|
+            next if attribute.categories.empty?
+            categories = attribute.categories.dup
+            category = categories.pop
+
+            supercategory_numbers = []
+
+            categories.each do |supercategory|
+              supercategory_attr = find_or_create_category_attr(
+                supercategory_numbers, supercategory
+              )
+              supercategory_numbers.push(
+                supercategory_attr.delete('_').split('-').last
+              )
+              unless attr_categories.include? supercategory_attr
+                attr_categories.push(supercategory_attr)
+              end
+              category_labels[supercategory_attr] = supercategory
+            end
+
+            category_attr = find_or_create_category_attr(
+              supercategory_numbers, category
+            )
+            unless attr_categories.include? category_attr
+              attr_categories.push(category_attr)
+            end
+            category_labels[category_attr] = category
+
+            category_attributes[category_attr] = category_attributes
+              .fetch(category_attr) { [] }.push(attribute.attr_name).uniq
           end
-      end
+          self
+        end
 
-      private def category_attributes
-        attributes.each_with_object({}) do |attr, memo|
-          next if attr.category.empty?
-          category_attr = attr.category.downcase.gsub(/\s+/, '_').to_sym
-          (memo[category_attr] ||= []) << attr.attr_name
+        private def find_or_create_category_attr(supercategory_numbers, category)
+          nested_category_numbers =
+            if supercategory_numbers.empty?
+              '-'
+            else
+              "-#{supercategory_numbers.join('-')}-"
+            end
+          category_attr = category_labels.select do |key, value|
+            value == category &&
+              key.match("_cat#{nested_category_numbers}[0-9]*_")
+          end
+          if !category_attr.empty?
+            category_attr.keys.first
+          else
+            subcategory_number = category_labels.select do |key, _v|
+              key.match("_cat#{nested_category_numbers}[0-9]*_")
+            end.size + 1
+            "_cat#{nested_category_numbers}#{subcategory_number}_"
+          end
         end
       end
 
       class LabelAttribute
-        attr_reader :attr_name, :category, :label
+        attr_reader :attr_name, :categories, :label
 
-        def initialize(attr_name:, category:, label:)
+        def initialize(attr_name:, categories:, label:)
           @attr_name = attr_name
-          @category = category
+          @categories = categories
           @label = label
         end
       end
@@ -81,21 +126,14 @@ module Odca
         end
 
         def call
-          category = Odca::NullValue.new
-          label = Odca::NullValue.new
-
-          splited = value.split('|')
-          case splited.length
-          when 1
-            label = value.strip
-          when 2
-            category = splited[0].strip
-            label = splited[1].strip
-          end
+          splited = value.split('|').map(&:strip)
+
+          label = splited.empty? ? Odca::NullValue.new : splited.pop
+          categories = splited
 
           {
             attr_name: attr_name.strip,
-            category: category,
+            categories: categories,
             label: label
           }
         end

data/lib/odca/overlays/mapping_overlay.rb

@@ -0,0 +1,15 @@
+require 'odca/overlay'
+
+module Odca
+  module Overlays
+    class MappingOverlay
+      extend Overlay
+
+      def to_h
+        {
+          attr_mapping: attr_values
+        }
+      end
+    end
+  end
+end

data/lib/odca/parser.rb

@@ -31,6 +31,7 @@ module Odca
       schemas = separate_schemas(records)
       schemas.each do |schema|
         schema_base, overlays = schema.call
+        next unless schema_base && overlays
         save(schema_base: schema_base, overlays: overlays)
       end
     end
@@ -72,7 +73,7 @@ module Odca
     def save_overlay(headful_overlay, path:)
       overlay_class_name = headful_overlay.overlay.class
         .name.split('::').last
-      hl = 'hl:' + HashlinkGenerator.call(headful_overlay)
+      hl = HashlinkGenerator.call(headful_overlay)
 
       File.open("#{path}/#{overlay_class_name}-#{hl}.json", 'w') do |f|
         f.write(JSON.pretty_generate(headful_overlay))

data/lib/odca/schema_parser.rb

@@ -8,6 +8,7 @@ module Odca
     end
 
     def call
+      return unless records.first[0]
       schema_base = Odca::SchemaBase.new(
         Odca::SchemaBase::Header.new(
           name: records.first[0],
@@ -21,10 +22,14 @@ module Odca
 
       records.each do |row|
         attr_name = row[3]
+        attr_type = row[4]
+
+        next unless attr_name && attr_type
+
         schema_base.add_attribute(
           SchemaBase::Attribute.new(
             name: attr_name,
-            type: row[4],
+            type: attr_type,
             pii: row[5]
           )
         )

data/lib/odca/version.rb

@@ -1,3 +1,3 @@
 module Odca
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/odca.gemspec

@@ -5,11 +5,11 @@ require 'odca/version'
 Gem::Specification.new do |spec|
   spec.name          = 'odca'
   spec.version       = Odca::VERSION
-  spec.authors       = ['THCLab']
-  spec.email         = ['olichwiruk@gmail.pl']
+  spec.authors       = ["Robert Mitwicki", "Marcin Olichwiruk", "Michał Pietrus"]
+  spec.email         = ['robert@thclab.online']
 
-  spec.summary       = 'ODCA implementation in ruby'
-  spec.homepage      = 'https://github.com/THCLab/odca-ruby'
+  spec.summary       = 'Overlays Data Capture Architecture (ODCA) objects parser'
+  spec.homepage      = 'https://odca.online'
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'base58', '~> 0.2'
+  spec.add_dependency 'hashlink', '~> 0.0.1'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,29 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: odca
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
-- THCLab
+- Robert Mitwicki
+- Marcin Olichwiruk
+- Michał Pietrus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: base58
+  name: hashlink
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +56,7 @@ dependencies:
         version: '3.0'
 description: 
 email:
-- olichwiruk@gmail.pl
+- robert@thclab.online
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -63,7 +65,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -73,13 +74,14 @@ files:
 - lib/odca/headful_overlay.rb
 - lib/odca/null_value.rb
 - lib/odca/overlay.rb
+- lib/odca/overlays/character_encoding_overlay.rb
 - lib/odca/overlays/conditional_overlay.rb
-- lib/odca/overlays/encode_overlay.rb
 - lib/odca/overlays/entry_overlay.rb
 - lib/odca/overlays/format_overlay.rb
 - lib/odca/overlays/header.rb
 - lib/odca/overlays/information_overlay.rb
 - lib/odca/overlays/label_overlay.rb
+- lib/odca/overlays/mapping_overlay.rb
 - lib/odca/overlays/masking_overlay.rb
 - lib/odca/overlays/review_overlay.rb
 - lib/odca/overlays/source_overlay.rb
@@ -89,7 +91,7 @@ files:
 - lib/odca/schema_parser.rb
 - lib/odca/version.rb
 - odca.gemspec
-homepage: https://github.com/THCLab/odca-ruby
+homepage: https://odca.online
 licenses:
 - MIT
 metadata: {}
@@ -112,5 +114,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: ODCA implementation in ruby
+summary: Overlays Data Capture Architecture (ODCA) objects parser
 test_files: []

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    odca (0.1.2)
-      base58 (~> 0.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    base58 (0.2.3)
-    diff-lcs (1.3)
-    rake (13.0.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  odca!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.2