ooze-parser 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f2257b16610a5145ae081447aef22941fa85ec6bdb923992c8892262cde223
-  data.tar.gz: 43dbea66a84a5d4ade5508a605e2ca25f1198f64b5bee03e125d684ebaa34837
+  metadata.gz: 5a67c203d84a3a2890d20f2a2c7da655bc7fb521a8c92f7101b882535800ba92
+  data.tar.gz: 999a154e5ff6088ce1e022496087b5012c90ca25937432c9b1951eeb91bb83de
 SHA512:
-  metadata.gz: eef8cf42922b94246efcefd475a56582666816d148ea7bf0ef3fc9dca591e4490a9b9aff0175dbd9ddab856b84fa04a96b0ff553d7a67219feabefa00169b8e2
-  data.tar.gz: d586b55a165bad8d781b7c85755aad8ef6f8f46932c34ad4ba372221d7a3f6c0af2d54959c10fd67eae2cb895f834ed35accc37d5505acc568b54239ae811b13
+  metadata.gz: 7563820fe8469c75f646fbd88883a308e8f000cb14b57fc23dbaa18b1dd81122ba3d9eb6d167610b01a215e9b3cde26524d41fa65621817a3d2f1a176ecea736
+  data.tar.gz: 334f759ba653339d2c1001fd759ff6d8f699b70f9b73fc214d785804bc9e74fc19ef6beb87d2ce6955c7629903a138d3119d609a0f7ef7c77af1ae1b364d6e5b

data/.gitignore

@@ -1 +1,23 @@
+# it's a gem, ignore the lockfile
+Gemfile.lock
+
+# build artifacts
 *.gem
+/.bundle
+/.vscode
+.solargraph.yml
+/vendor/bundle
+/spec/reports/
+/tmp/
+/pkg/
+
+# docs
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+
+# rspec failure tracking
+.rspec_status
+scratch.rb
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,102 @@
+AllCops:
+  TargetRubyVersion: 3.2.2
+  Exclude:
+    - 'config/routes.rb'
+  NewCops: enable
+
+Metrics/ClassLength:
+  Max: 500
+Metrics/ModuleLength:
+  Max: 300
+Metrics/MethodLength:
+  Max: 50
+Metrics/AbcSize:
+  Max: 30
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+Metrics/BlockLength:
+  CountAsOne: ['array', 'heredoc', 'method_call']
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 30
+
+Style/AccessorGrouping:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/BlockDelimiters:
+  BracesRequiredMethods: ['log']
+  AllowedPatterns: ['proc', 'new']
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+  EnforcedStyle: no_mixed_keys
+Style/ArgumentsForwarding:
+  UseAnonymousForwarding: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/FetchEnvVar:
+  Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+Layout/LeadingCommentSpace:
+  Enabled: false
+  AllowGemfileRubyComment: true
+Layout/ParameterAlignment:
+  Enabled: false
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: symmetrical
+Layout/LineLength:
+  Enabled: true
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+  AllowBeforeTrailingComments: true
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+  CheckSymbols: false
+Naming/MethodParameterName:
+  AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io', 'to']
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+Naming/BlockForwarding:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/.yardopts

@@ -0,0 +1,10 @@
+--readme README.md
+--charset utf-8
+--markup-provider=redcarpet
+--markup=markdown
+--no-private
+--output-dir ./doc
+'lib/**/*.rb'
+CHANGELOG.md
+-
+LICENSE

data/README.md

@@ -0,0 +1,23 @@
+# Ooze Parser (ooze-parser)
+
+JSON parser for ecoPortal Ooze.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ooze-parser'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install ooze-parser
+```

data/lib/ooz/base/evolution.rb

@@ -2,8 +2,9 @@ module Ooz
   module Base
     class Evolution < Base::Model
       overridable_const :stage_class, Base::Stage
+
       passthrough :_id, :patch_ver, to: :doc
-      passthrough_arr :stages, to: :doc, klass: :stage_class
+      embedding_many :stages, to: :doc, klass: :stage_class
     end
   end
 end

data/lib/ooz/base/field/actions_list.rb

@@ -0,0 +1,10 @@
+module Ooz
+  module Base
+    class Field
+      class ActionsList < Field
+        passthrough :action_ids, to: :doc
+        passthrough :action_recurrence_ids, to: :doc
+      end
+    end
+  end
+end

data/lib/ooz/base/field/checklist.rb

@@ -7,15 +7,16 @@ module Ooz
   end
 end
 
-require_relative "checklist/item"
+require_relative 'checklist/item'
 
 module Ooz
   module Base
     class Field
       class Checklist
         overridable_const :checklist_item_class, Base::Field::Checklist::Item
+
         passthrough :complete, to: :doc
-        passthrough_arr :items, to: :doc, klass: :checklist_item_class
+        embedding_many :items, to: :doc, klass: :checklist_item_class
       end
     end
   end

data/lib/ooz/base/field/contractor_entities.rb

@@ -0,0 +1,15 @@
+module Ooz
+  module Base
+    class Field
+      class ContractorEntities < Field
+        passthrough :contractor_entities_ids, to: :doc
+        passthrough :singular, :is_me_button, :show_approval_status, to: :doc
+        passthrough :apply_attached_contractors_permissions_to, :grant_permissions_enabled, to: :doc
+        passthrough :attached_contractors_permissions_flags, to: :doc
+        passthrough :attached_contractors_admin_permissions_flags, to: :doc
+        passthrough :admin_access, to: :doc
+        passthrough :regular_access, to: :doc
+      end
+    end
+  end
+end

data/lib/ooz/base/field/cross_reference.rb

@@ -2,8 +2,9 @@ module Ooz
   module Base
     class Field
       class CrossReference < Field
-        passthrough :reference_ids, :register_id, :hide_create, :hide_attach, :hide_metadata, :hide_dashboards,
-          :display_fields, :display_fields_in_lookup, to: :doc
+        passthrough :reference_ids, :register_id, to: :doc
+        passthrough :hide_create, :hide_attach, :hide_metadata, :hide_dashboards, to: :doc
+        passthrough :display_fields, :display_fields_in_lookup, to: :doc
       end
     end
   end

data/lib/ooz/base/field/date.rb

@@ -2,9 +2,10 @@ module Ooz
   module Base
     class Field
       class Date < Field
-        passthrough :show_time, :past_only, :today_button, :create_event, :event_id,
-          :remind_me_in, :value, :renews, :renews_unit, :renews_every, :renews_until,
-          to: :doc
+        passthrough :value, to: :doc
+        passthrough :show_time, :past_only, :today_button, to: :doc
+        passthrough :create_event, :event_id, to: :doc
+        passthrough :remind_me_in, :renews, :renews_unit, :renews_every, :renews_until, to: :doc
       end
     end
   end

data/lib/ooz/base/field/file.rb

@@ -7,14 +7,15 @@ module Ooz
   end
 end
 
-require_relative "file/file"
+require_relative 'file/file'
 
 module Ooz
   module Base
     class Field
       class File
         overridable_const :file_class, Base::Field::File::File
-        passthrough_arr :items, to: :doc, klass: :file_class
+
+        embedding_many :items, to: :doc, klass: :file_class
       end
     end
   end

data/lib/ooz/base/field/gauge.rb

@@ -7,15 +7,16 @@ module Ooz
   end
 end
 
-require_relative "gauge/stop"
+require_relative 'gauge/stop'
 
 module Ooz
   module Base
     class Field
       class Gauge
         overridable_const :gauge_stop_class, Base::Field::Gauge::Stop
+
         passthrough :value, :max, to: :doc
-        passthrough_arr :stops, to: :doc, klass: :gauge_stop_class
+        embedding_many :stops, to: :doc, klass: :gauge_stop_class
       end
     end
   end

data/lib/ooz/base/field/geo.rb

@@ -0,0 +1,10 @@
+module Ooz
+  module Base
+    class Field
+      class Geo < Field
+        passthrough :coordinates, to: :doc
+        passthrough :address, to: :doc
+      end
+    end
+  end
+end

data/lib/ooz/base/field/image_gallery.rb

@@ -7,15 +7,16 @@ module Ooz
   end
 end
 
-require_relative "image_gallery/image"
+require_relative 'image_gallery/image'
 
 module Ooz
   module Base
     class Field
       class ImageGallery
         overridable_const :image_class, Base::Field::ImageGallery::Image
+
         passthrough :stretch, :no_popup, :hide_options, :layout, to: :doc
-        passthrough_arr :images, to: :doc, klass: :image_class
+        embedding_many :images, to: :doc, klass: :image_class
       end
     end
   end

data/lib/ooz/base/field/mailbox.rb

@@ -0,0 +1,10 @@
+module Ooz
+  module Base
+    class Field
+      class Mailbox < Field
+        passthrough :email_ids, to: :doc
+        passthrough :address_id, to: :doc
+      end
+    end
+  end
+end

data/lib/ooz/base/field/people.rb

@@ -2,9 +2,11 @@ module Ooz
   module Base
     class Field
       class People < Field
-        passthrough :people_ids, :singular, :attach_mode, :is_me_button, :person_schema_id, :viewable_fields,
-          :attached_people_permissions_enabled, :attached_people_permissions_editable,
-          to: :doc
+        passthrough :people_ids, to: :doc
+        passthrough :singular, :attach_mode, :is_me_button, to: :doc
+        passthrough :person_schema_id, to: :doc
+        passthrough :viewable_fields, to: :doc
+        passthrough :attached_people_permissions_enabled, :attached_people_permissions_editable, to: :doc
       end
     end
   end

data/lib/ooz/base/field/select.rb

@@ -7,7 +7,7 @@ module Ooz
   end
 end
 
-require_relative "select/option"
+require_relative 'select/option'
 
 module Ooz
   module Base
@@ -18,36 +18,41 @@ module Ooz
           # @param master [Ooz::Model::Field::Select]
           # @param more [Ooz::Model::Field::Select, Array<Hash>]
           # @note it prevents douplicated values
-          def merge_options(master, more, silent: false)
+          def merge_options(master, more, silent: false) # rubocop:disable Metrics/AbcSize
             if !master.is_a?(Ooz::Model::Field::Select)
-              raise ArgumentError.new("Expecting 'master' to be Ooz::Model::Field::Select. Given: #{master.class}")
+              msg = "Expecting 'master' to be Ooz::Model::Field::Select. Given: #{master.class}"
+              raise ArgumentError, msg
             elsif !more.is_a?(Ooz::Model::Field::Select) && !more.is_a?(Array)
-              raise ArgumentError.new("Expecting 'more' to be Ooz::Model::Field::Select or Array<Hash>. Given: #{more.class}")
+              msg = "Expecting 'more' to be Ooz::Model::Field::Select or Array<Hash>. Given: #{more.class}"
+              raise ArgumentError, msg
             end
-            opts1 = master.doc["options"]
-            opts2 = more.is_a?(Array)? more : more.doc["options"]
 
-            to_add = opts2.reject do |opt|
-              opts1.any? {|o| o["value"] == opt["value"]}
+            opts_1 = master.doc['options']
+            opts_2 = more.is_a?(Array)? more : more.doc['options']
+
+            to_add = opts_2.reject do |opt|
+              opts_1.any? { |o| o['value'] == opt['value'] }
             end
 
             # Some feedback
             if !silent && more.is_a?(Ooz::Model::Field::Select) && !to_add.empty?
               puts "Merging more options to the field '#{more.label}':\n"
+
               str_opts = to_add.map do |opt|
-                "'#{opt["value"]}' => '#{opt["name"]}'"
+                "'#{opt['value']}' => '#{opt['name']}'"
               end.join("\n  • ")
 
-              puts "  • " + str_opts + "\n"
+              puts "  • #{str_opts}\n"
             end
 
-            opts1.push(*to_add)
+            opts_1.push(*to_add)
           end
         end
-        
+
         overridable_const :select_option, Base::Field::Select::Option
+
         passthrough :multiple, :flat, :data_type, :other, :other_desc, to: :doc
-        passthrough_arr :options, to: :doc, klass: :select_option
+        embedding_many :options, to: :doc, klass: :select_option
       end
     end
   end

data/lib/ooz/base/field.rb

@@ -1,24 +1,41 @@
 module Ooz
   module Base
     class Field < Base::Model
+      overridable_const :geome_class, Base::Genome
+
       passthrough  :_id, :_type, :label, :tooltip, :patch_ver, to: :doc
       passthrough  :global_binding, to: :doc
       passthrough  :hidden, :deindex, :accent, to: :doc
       passthrough  :required, :hide_view, :hidden_on_reports, to: :doc
+
+      passthrough :label_translations, :tooltip_translations, to: :doc
+      passthrough :content_translations, to: :doc
+
+      embedding_one :genome, to: :doc, klass: :genome_class
+
+      def ref
+        return unless (gen = genome)
+
+        gen.ref
+      end
     end
   end
 end
 
-require_relative "field/undefined"
-require_relative "field/select"
-require_relative "field/date"
-require_relative "field/plain_text"
-require_relative "field/rich_text"
-require_relative "field/number"
-require_relative "field/gauge"
-require_relative "field/people"
-require_relative "field/tag_field"
-require_relative "field/cross_reference"
-require_relative "field/file"
-require_relative "field/image_gallery"
-require_relative "field/checklist"
+require_relative 'field/undefined'
+require_relative 'field/select'
+require_relative 'field/date'
+require_relative 'field/plain_text'
+require_relative 'field/rich_text'
+require_relative 'field/number'
+require_relative 'field/gauge'
+require_relative 'field/people'
+require_relative 'field/tag_field'
+require_relative 'field/cross_reference'
+require_relative 'field/file'
+require_relative 'field/image_gallery'
+require_relative 'field/checklist'
+require_relative 'field/contractor_entities'
+require_relative 'field/geo'
+require_relative 'field/actions_list'
+require_relative 'field/mailbox'

data/lib/ooz/base/field_factory.rb

@@ -1,9 +1,15 @@
 module Ooz
   module Base
     class FieldFactory < ModelFactory
-      def_parent_class Base::Field
-      def_white_classes "Select", "TagField", "Date", "PlainText", "RichText",
-        "Number", "Gauge", "People", "CrossReference", "File", "ImageGallery", "Checklist"
+      parent_class_is Base::Field
+
+      WHITE_CLASS = %w[
+        Select TagField Date PlainText RichText
+        Number Gauge People CrossReference File
+        ImageGallery Checklist
+      ].freeze
+
+      white_classes_are(*WHITE_CLASS)
     end
   end
 end

data/lib/ooz/base/force.rb

@@ -5,16 +5,16 @@ module Ooz
   end
 end
 
-require_relative "force/binding"
+require_relative 'force/binding'
 
 module Ooz
   module Base
     class Force
       overridable_const :binding_class, Base::Force::Binding
+
       passthrough :_id, :name, :weight, :patch_ver, to: :doc
       passthrough :script, to: :doc
-      passthrough_arr :binings, to: :doc, klass: :binding_class
+      embedding_many :binings, to: :doc, klass: :binding_class
     end
-
   end
 end

data/lib/ooz/base/genome.rb

@@ -0,0 +1,14 @@
+module Ooz
+  module Base
+    class Genome < Base::Model
+      passthrough  :_id, to: :doc
+      passthrough  :signature, :type, to: :doc
+
+      def ref
+        return unless type && signature
+
+        [type, signature].join('.')
+      end
+    end
+  end
+end

data/lib/ooz/base/model.rb

@@ -1,37 +1,44 @@
 module Ooz
   module Base
     class Model < Common::BaseModel
-
       attr_reader :root
 
       def initialize(*args, root: nil)
         super(*args)
+
         @root = root
       end
 
       def ooze
-        self.is_a?(Ooze)? self : root && root.ooze
+        is_a?(Ooze)? self : root&.ooze
       end
 
       private
 
       def to_hash(arr, key: "_id")
-        raise "Sorry, expected Array, given: #{arr.class.name}" if !arr.is_a?(Array)
-        arr.map do |e|
+        msg = "Sorry, expected Array, given: #{arr.class.name}"
+        raise msg unless arr.is_a?(Array)
+
+        arr.to_h do |e|
           [e.send(key), e]
-        end.to_h
+        end
       end
 
       def collect_from(ids, elements_hash)
-        raise "Sorry, 'ids' expected to be Array, given: #{arr.class.name}" if !ids.is_a?(Array)
-        raise "Expected hash, given: #{elements_hash.class.name}" if !elements_hash.is_a?(Hash)
+        msg = "Sorry, 'ids' expected to be Array, given: #{arr.class.name}"
+        raise msg unless ids.is_a?(Array)
+
+        msg = "Expected hash, given: #{elements_hash.class.name}"
+        raise msg unless elements_hash.is_a?(Hash)
+
         ids.map do |id|
           elements_hash[id].tap do |e|
-            puts "Warning: there is no element with id '#{id}'" if !e
+            next if e
+
+            puts "Warning: there is no element with id '#{id}'"
           end
         end
       end
-
     end
   end
 end

data/lib/ooz/base/model_factory.rb

@@ -2,7 +2,7 @@ module Ooz
   module Base
     class ModelFactory < Common::BaseFactory
       class << self
-        def def_white_classes (*str_classes)
+        def white_classes_are(*str_classes)
           str_classes = str_classes.map do |cls|
             case cls
             when cls.respond_to?(:name)
@@ -13,12 +13,14 @@ module Ooz
               cls
             end
           end.compact
+
           overridable_const :white_classes, str_classes
         end
 
-        def def_parent_class (parent_class)
-          msg = "Expected a valid parent class for you factory, from which the other classes inherit. Given #{parent_class}"
-          valid_class = parent_class && parent_class.is_a?(Class)
+        def parent_class_is(parent_class)
+          msg  = 'Expected a valid parent class for you factory, from which the other classes inherit.'
+          msg << " Given #{parent_class}"
+          valid_class = parent_class.is_a?(Class)
           raise msg unless valid_class
 
           overridable_const :parent_class, parent_class
@@ -26,14 +28,17 @@ module Ooz
         end
 
         def new(*args, **kargs)
-          raise "You must use 'def_parent_class' to initialize your Factory class" if !defined?(parent_class)
+          msg = "You must use 'parent_class_is' to initialize your Factory class"
+          raise msg unless defined?(parent_class)
 
-          type = args.first&.dig("_type")&.split("::")&.last
-          raise "Your object should have field '_type' defined" if !type
+          raw_type = args.first&.dig('_type')
+          type     = raw_type&.split('::')&.last
+          raise "Your object should have field '_type' defined" unless type
 
           if white_classes.include?(type)
             str_class = "#{base_namespace}::#{type}"
-            raise "This class does not exist: #{str_class}" if !Object.const_defined?(str_class)
+            raise "This class does not exist: #{str_class}" unless Object.const_defined?(str_class)
+
             klass = Object.const_get(str_class)
           else
             str_class = "#{base_namespace}::Undefined"
@@ -42,7 +47,6 @@ module Ooz
 
           klass.new(*args, **kargs)
         end
-
       end
     end
   end