rasn1 0.16.2 → 0.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1e2001517b21898280f0c865be1f0ca74c350d536d2cf80253291819e4536b
-  data.tar.gz: 2becfcf1810e777d9a4dc2f497f1a6fdd67e2dae319f3d15100d66a4566ce410
+  metadata.gz: 56e418f5906034865b82fd6dd271da80be89d601e4298230b3e36919d13dae22
+  data.tar.gz: d1f5d699c1e88e10b82a43fd3b9e0105041cb16ab11701751a6183088c2cca33
 SHA512:
-  metadata.gz: 2671492ba54d676699a6238ecfd95703b8f2ebbe5cf40adea249f3ef394b1476d4a03bb6da419349753b5ffe05d25c93bdc25aa6614ec5676f2de9b8147dea78
-  data.tar.gz: 3524a58800943b251980b78e5935f1af88a3e5d84ee209bfd910447c00142661f07d4067ffd48892dd767409a92b0dcaca5598e0078520e6b8996d7ab466e909
+  metadata.gz: a0efd01e244b3e61260eb50ab1317e2f200a2d2a311ae51293f2e409f20086857ff334edd2019358f7929cc14ae657124733848c99abdce80ad67b91c1377a15
+  data.tar.gz: 83ae40e970a4c185fe9652d10e38ac9cd1effa4c28a0362172cf619c675ce400be4bf2935e889b35ace98f3cfb0cee7ce8923d0dc571e5cc6df0cca829036f4e

data/lib/rasn1/errors.rb

@@ -26,7 +26,7 @@ module RASN1
 
   # CHOICE error: {Types::Choice#chosen} not set
   class ChoiceError < RASN1::Error
-    # @param [Types::Base] object
+    # @param object [Types::Base]
     def initialize(object)
       @object = object
       super()
@@ -42,7 +42,7 @@ module RASN1
   # @version 0.11.0
   # @author Sylvain Daubert
   class ConstraintError < Error
-    # @param [Types::Base] object
+    # @param object [Types::Base]
     def initialize(object)
       @object = object
       super()

data/lib/rasn1/model.rb

@@ -70,9 +70,9 @@ module RASN1
   class Model # rubocop:disable Metrics/ClassLength
     # @private Base Element
     BaseElem = Struct.new(:name, :proc, :content) do
-      # @param [String,Symbol] name
-      # @param [Proc] proc
-      # @param [Array,nil] content
+      # @param name [String,Symbol]
+      # @param proc [Proc]
+      # @param content [Array,nil]
       def initialize(name, proc, content)
         check_duplicates(content.map(&:name) + [name]) unless content.nil?
         super
@@ -80,13 +80,17 @@ module RASN1
 
       private
 
-      # @return [Array<String>] The duplicate names found in the array
+      # @param names [Array<String, Symbol>]
+      # @return [Array<String,Symbol>] The duplicate names found in the array
       def find_all_duplicate_names(names)
         names.group_by { |name| name }
              .select { |_name, values| values.length > 1 }
              .keys
       end
 
+      # @param names [Array<String, Symbol>]
+      # @return [void]
+      # @raise [ModelValidationError] duplicate names in model definition
       def check_duplicates(names)
         duplicates = find_all_duplicate_names(names)
         raise ModelValidationError, "Duplicate name #{duplicates.first} found" if duplicates.any?
@@ -113,16 +117,16 @@ module RASN1
       attr_reader :options
 
       # Use another model in this model
-      # @param [String,Symbol] name
-      # @param [Class] model_klass
+      # @param name [String,Symbol]
+      # @param model_klass [Class]
       # @return [Elem]
       def model(name, model_klass)
         @root = ModelElem.new(name, model_klass)
       end
 
       # Use a {Wrapper} around a {Types::Base} or a {Model} object
-      # @param [Types::Base,Model] element
-      # @param [Hash] options
+      # @param element [Types::Base,Model]
+      # @param options [Hash]
       # @return [WrapElem]
       # @since 0.12
       def wrapper(element, options={})
@@ -140,7 +144,7 @@ module RASN1
       #  class Model2 < Model1
       #    root_options implicit: 1
       #  end
-      # @param [Hash] options
+      # @param options [Hash]
       # @return [void]
       # @since 0.12.0 may change name through +:name+
       def root_options(options)
@@ -152,7 +156,7 @@ module RASN1
       end
 
       # On inheritance, create +@root+ class variable
-      # @param [Class] klass
+      # @param klass [Class]
       # @return [void]
       def inherited(klass)
         super
@@ -161,8 +165,8 @@ module RASN1
       end
 
       # @private
-      # @param [String,Symbol] accel_name
-      # @param [Class] klass
+      # @param accel_name [String,Symbol]
+      # @param klass [Class]
       # @since 0.11.0
       # @since 0.12.0 track source location on error (adfoster-r7)
       def define_type_accel_base(accel_name, klass)
@@ -178,8 +182,8 @@ module RASN1
       end
 
       # @private
-      # @param [String,Symbol] accel_name
-      # @param [Class] klass
+      # @param accel_name [String,Symbol]
+      # @param klass [Class]
       # @since 0.11.0
       # @since 0.12.0 track source location on error (adfoster-r7)
       def define_type_accel_of(accel_name, klass)
@@ -195,8 +199,8 @@ module RASN1
       end
 
       # Define an accelarator to access a type in a model definition
-      # @param [String] accel_name
-      # @param [Class] klass class to instanciate
+      # @param accel_name [String]
+      # @param klass [Class] class to instanciate
       # @since 0.11.0
       # @since 0.12.0 track source location on error (adfoster-r7)
       def define_type_accel(accel_name, klass)
@@ -207,8 +211,8 @@ module RASN1
         end
       end
 
-      # @param [Symbol,String] name name of object in model
-      # @param [Hash] options
+      # @param name [Symbol,String] name of object in model
+      # @param options [Hash]
       # @return [Elem]
       # @note This method is named +objectid+ and not +object_id+ to not override
       #   +Object#object_id+.
@@ -219,8 +223,8 @@ module RASN1
         @root = BaseElem.new(name, proc, nil)
       end
 
-      # @param [Symbol,String] name name of object in model
-      # @param [Hash] options
+      # @param name [Symbol,String] name of object in model
+      # @param options [Hash]
       # @return [Elem]
       # @see Types::Any#initialize
       def any(name, options={})
@@ -238,8 +242,8 @@ module RASN1
       end
 
       # Parse a DER/BER encoded string
-      # @param [String] str
-      # @param [Boolean] ber accept BER encoding or not
+      # @param str [String]
+      # @param ber [Boolean] accept BER encoding or not
       # @return [Model]
       # @raise [ASN1Error] error on parsing
       def parse(str, ber: false)
@@ -253,20 +257,20 @@ module RASN1
 
     # @!method sequence(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Sequence#initialize
     # @!method set(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Set#initialize
     # @!method choice(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Choice#initialize
     %w[sequence set choice].each do |type|
@@ -275,16 +279,16 @@ module RASN1
 
     # @!method sequence_of(name, type, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Model, Types::Base] type type for SEQUENCE OF
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param type [Model, Types::Base] type for SEQUENCE OF
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::SequenceOf#initialize
     # @!method set_of(name, type, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Model, Types::Base] type type for SET OF
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param type [Model, Types::Base] type for SET OF
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::SetOf#initialize
     %w[sequence set].each do |type|
@@ -293,80 +297,80 @@ module RASN1
 
     # @!method boolean(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Boolean#initialize
     # @!method integer(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Integer#initialize
     # @!method bit_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::BitString#initialize
     # @!method bmp_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::BmpString#initialize
     # @!method octet_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::OctetString#initialize
     # @!method null(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Null#initialize
     # @!method enumerated(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Enumerated#initialize
     # @!method universal_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::UniversalString#initialize
     # @!method utf8_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::Utf8String#initialize
     # @!method numeric_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::NumericString#initialize
     # @!method printable_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::PrintableString#initialize
     # @!method visible_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::VisibleString#initialize
     # @!method ia5_string(name, options)
     #  @!scope class
-    #  @param [Symbol,String] name name of object in model
-    #  @param [Hash] options
+    #  @param name [Symbol,String] name of object in model
+    #  @param options [Hash]
     #  @return [Elem]
     #  @see Types::IA5String#initialize
     Types.primitives.each do |prim|
@@ -380,7 +384,7 @@ module RASN1
     attr_reader :root
 
     # Create a new instance of a {Model}
-    # @param [Hash] args
+    # @param args [Hash]
     def initialize(args={})
       @elements = {}
       generate_root(args)
@@ -390,11 +394,11 @@ module RASN1
 
     # @overload [](name)
     #  Access an element of the model by its name
-    #  @param [Symbol] name
+    #  @param name [Symbol]
     #  @return [Model, Types::Base, Wrapper]
     # @overload [](idx)
     #  Access an element of root element by its index. Root element must be a {Types::Sequence} or {Types::SequenceOf}.
-    #  @param [Integer] idx
+    #  @param idx [Integer]
     #  @return [Model, Types::Base, Wrapper]
     def [](name_or_idx)
       case name_or_idx
@@ -409,8 +413,8 @@ module RASN1
     end
 
     # Set value of element +name+. Element should be a {Types::Base}.
-    # @param [String,Symbol] name
-    # @param [Object] value
+    # @param name [String,Symbol]
+    # @param value [Object]
     # @return [Object] value
     def []=(name, value)
       # Here, use #[] to force generation for lazy elements
@@ -420,7 +424,8 @@ module RASN1
     end
 
     # clone @elements and initialize @root from this new @element.
-    def initialize_copy(_other)
+    # @return [void]
+    def initialize_copy(*)
       @elements = @elements.clone
       @root = @elements[@root_name]
     end
@@ -455,8 +460,8 @@ module RASN1
     end
 
     # Parse a DER/BER encoded string, and modify object in-place.
-    # @param [String] der
-    # @param [Boolean] ber accept BER encoding or not
+    # @param der [String]
+    # @param ber [Boolean] accept BER encoding or not
     # @return [Integer] number of parsed bytes
     # @raise [ASN1Error] error on parsing
     def parse!(der, ber: false)
@@ -464,6 +469,7 @@ module RASN1
     end
 
     # @private
+    # @!macro do_parse
     # @see Types::Base#do_parse
     def do_parse(der, ber: false)
       root.do_parse(der, ber: ber)
@@ -474,8 +480,8 @@ module RASN1
     #  @return [Object,nil]
     # @overload value(name, *args)
     #  Direct access to the value of +name+ (nested) element of model.
-    #  @param [String,Symbol] name
-    #  @param [Array<Integer,String,Symbol>] args more argument to access element. May be
+    #  @param name [String,Symbol]
+    #  @param args [Array<Integer,String,Symbol>] more argument to access element. May be
     #     used to access content of a SequenceOf or a SetOf
     #  @return [Object,nil]
     # @return [Object,nil]
@@ -508,10 +514,11 @@ module RASN1
       end
     end
 
-    # Return a hash image of model
-    # @return [Hash]
     # Delegate some methods to root element
-    # @param [Symbol] meth
+    # @param meth [Symbol]
+    # @param args [Array]
+    # @param kwargs [Hash]
+    # @return [Object]
     def method_missing(meth, *args, **kwargs)
       if root.respond_to?(meth)
         root.send(meth, *args, **kwargs)
@@ -520,18 +527,20 @@ module RASN1
       end
     end
 
+    # @param meth [Symbol]
     # @return [Boolean]
     def respond_to_missing?(meth, *)
       root.respond_to?(meth) || super
     end
 
+    # @param level [Integer]
     # @return [String]
     def inspect(level=0)
       "#{'  ' * level}(#{type}) #{root.inspect(-level)}"
     end
 
     # Objects are equal if they have same class AND same DER
-    # @param [Base] other
+    # @param other [Base]
     # @return [Boolean]
     def ==(other)
       (other.class == self.class) && (other.to_der == self.to_der)
@@ -540,7 +549,7 @@ module RASN1
     protected
 
     # Initialize model elements from +args+
-    # @param [Hash,Array] args
+    # @param args [Hash,Array]
     # @return [void]
     def lazy_initialize(args)
       case args
@@ -552,7 +561,7 @@ module RASN1
     end
 
     # Initialize an element from a hash
-    # @param [Hash] args
+    # @param args [Hash]
     # @return [void]
     def lazy_initialize_hash(args)
       args.each do |name, value|
@@ -568,7 +577,7 @@ module RASN1
     end
 
     # Initialize an sequence element from an array
-    # @param [Array] ary
+    # @param ary [Array]
     # @return [void]
     def lazy_initialize_array(ary)
       raise Error, 'Only sequence types may be initialized with an array' unless SEQUENCE_TYPES.any? { |klass| root.is_a?(klass) }
@@ -579,7 +588,7 @@ module RASN1
     end
 
     # Give a (nested) element from its name
-    # @param [String, Symbol] name
+    # @param name [String, Symbol]
     # @return [Model, Types::Base, nil]
     def by_name(name)
       elt = self[name]
@@ -597,6 +606,8 @@ module RASN1
 
     private
 
+    # @param args [Hash]
+    # @return [void]
     def generate_root(args)
       opts = args.slice(:name, :explicit, :implicit, :optional, :class, :default, :constructed, :tag_value)
       root = self.class.class_eval { @root }
@@ -607,6 +618,9 @@ module RASN1
       @elements[@root_name] = @root
     end
 
+    # @param elt [BaseElem, ModelElem,WrapElem]
+    # @param opts [Hash]
+    # @return[Types::Base,Model,Wrapper]
     def generate_element(elt, opts={})
       case elt
       when BaseElem
@@ -619,6 +633,9 @@ module RASN1
       end
     end
 
+    # @param elt [WrapElem]
+    # @param opts [Hash]
+    # @return[Wrapper]
     def generate_wrapper_element(elt, opts)
       wrapped = elt.element.is_a?(ModelElem) ? elt.element.klass : generate_element(elt.element)
       options = elt.options.merge(opts)
@@ -629,6 +646,9 @@ module RASN1
       wrapper
     end
 
+    # @param elt [BaseElem]
+    # @param opts [Hash]
+    # @return[Types::Base]
     def generate_base_element(elt, opts)
       element = elt.proc.call(opts)
       return element if elt.content.nil?
@@ -643,6 +663,8 @@ module RASN1
     # @author sdaubert
     # @author lemontree55
     # @author adfoster-r7
+    # @param element [Model, Types::Base, Wrapper,nil]
+    # @return [Hash]
     def private_to_h(element=nil) # rubocop:disable Metrics/CyclomaticComplexity
       my_element = element || root
       value = case my_element
@@ -666,6 +688,8 @@ module RASN1
       end
     end
 
+    # @param elt [Model]
+    # @return [Hash]
     def model_to_h(elt)
       hsh = elt.to_h
       if root.is_a?(Types::Choice)
@@ -675,6 +699,8 @@ module RASN1
       end
     end
 
+    # @param elt [Types::SequenceOf]
+    # @return [Array<Hash>]
     def sequence_of_to_h(elt)
       if elt.of_type < Model
         elt.value&.map { |el| el.to_h.values.first }
@@ -683,6 +709,8 @@ module RASN1
       end
     end
 
+    # @param seq [Types::Sequence]
+    # @return [Hash]
     def sequence_to_h(seq)
       ary = seq.value&.map do |el|
         next if el.optional? && el.value.nil?
@@ -699,6 +727,9 @@ module RASN1
       ary.compact.to_h
     end
 
+    # @param elt [Types::Choice]
+    # @return [Hash]
+    # @raise [ChoiceError] no chosen element
     def choice_to_h(elt)
       raise ChoiceError.new(elt) if elt.chosen.nil?
 
@@ -706,10 +737,14 @@ module RASN1
       { chosen.name => private_to_h(chosen) }
     end
 
+    # @param key [String,Symbol]
+    # @return [Symbol]
     def unwrap_keyname(key)
       key.to_s.delete_suffix('_wrapper').to_sym
     end
 
+    # @param wrap [Wrapper]
+    # @return [Hash]
     def wrapper_to_h(wrap)
       el = wrap.element
       case el