rasn1 0.16.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e418f5906034865b82fd6dd271da80be89d601e4298230b3e36919d13dae22
-  data.tar.gz: d1f5d699c1e88e10b82a43fd3b9e0105041cb16ab11701751a6183088c2cca33
+  metadata.gz: 67e24db40c3ec0a8e7d7ad23211549c1aadda9511ea73f632034a4cdefa97ae0
+  data.tar.gz: d8847b0b52cce0014f02772077da519df146c14a1f65ffebc72cc206e888b0cd
 SHA512:
-  metadata.gz: a0efd01e244b3e61260eb50ab1317e2f200a2d2a311ae51293f2e409f20086857ff334edd2019358f7929cc14ae657124733848c99abdce80ad67b91c1377a15
-  data.tar.gz: 83ae40e970a4c185fe9652d10e38ac9cd1effa4c28a0362172cf619c675ce400be4bf2935e889b35ace98f3cfb0cee7ce8923d0dc571e5cc6df0cca829036f4e
+  metadata.gz: 12da7b29112a40073dd64e3eb949412cd941932d63fb87e2cf36cf020c1df784cdd85e6e2cd04113f8bf74e7b16c630fad2346b885933874f86dcd329f42511b
+  data.tar.gz: a5294cfc1a3ebc0430c1be31558ed1e33ac97e5d87ad8ff3c14d6c8633b251d53b33e7818762f46bb6272c4f71da439a42aa86f79413c3af405b5b3d076777a3

data/README.md

@@ -52,7 +52,9 @@ ComplexRecord ::= SEQUENCE {
 }
 ```
 
-### Create a ASN.1 model
+### Create an ASN.1 model
+
+A model is created this way:
 
 ```ruby
 class Record < RASN1::Model
@@ -63,14 +65,31 @@ class Record < RASN1::Model
 end
 ```
 
+or, this ways in a more rubyish style:
+
+```ruby
+# This Record class is defined as a sequence conaining:
+# * an ID (integer)
+# * a room number (integer, with explicit tag, optional)
+# * a house if (integer, with explicit tag and a default value)
+class Record < RASN1::Model
+  sequence :record do
+    integer(:id)
+    integer(:room, implicit: 0, optional: true)
+    integer(:house, implicit: 1, default: 0)
+  end
+end
+```
+
 More comple classes may be designed by nesting simple classes. For example:
 
 ```ruby
 class ComplexRecord < RASN1::Model
-  sequence :cplx_record,
-           content: [boolean(:bool),
-                     octet_string(:data, explicit: 0),
-                     model(:a_record, Record)]
+  sequence :cplx_record do
+    boolean(:bool)
+    octet_string(:data, explicit: 0)
+    model(:a_record, Record)          # Use another model in model
+  end
 end
 ```
 
@@ -115,10 +134,6 @@ record.set id: 124, house: 155
 record.to_der         # => String
 ```
 
-### More information
-
-see <https://github.com/sdaubert/rasn1/wiki>
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/sdaubert/rasn1>.
+Bug reports and pull requests are welcome on GitHub at <https://codeberg.org/lemontree55/rasn1>.

data/lib/rasn1/model/accel.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# This file is part of RASN1
+# See https://codeberg.org/lemontree55/rasn1 for more informations
+# Copyright (C) 2016-2024 Sylvain Daubert <sylvain.daubert@laposte.net>
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
+# This program is published under MIT license.
+
+module RASN1
+  class Model
+    # Define helper methods to define models
+    # @author Sylvain Daubert
+    module Accel
+      # @return [Hash]
+      attr_reader :options
+
+      # On inheritance, create +@elements+ class variable
+      # @param klass [Class]
+      # @return [void]
+      def inherited(klass)
+        super
+        current_elements = @elements
+        klass.class_eval { @elements = current_elements.dup }
+      end
+
+      # @since 0.17.0
+      def elements
+        return @elements unless @elements.nil?
+
+        @elements = []
+      end
+
+      # Use another model in this model
+      # @param name [String,Symbol]
+      # @param model_klass [Class]
+      # @return [Elem]
+      def model(name, model_klass)
+        push_element(ModelElem.new(name, model_klass))
+      end
+
+      # @since 0.17.0
+      # @param [BaseElem, WrapElem, ModelElem] elem
+      # @return [BaseElem, WrapElem, ModelElem] elem
+      def push_element(elem)
+        elements << elem
+        elem
+      end
+
+      # @since 0.17.0
+      def root
+        elements.last
+      end
+
+      # @since 0.17.0
+      def root=(elem)
+        if elements.empty?
+          elements << elem
+        else
+          elements[-1] = elem
+        end
+      end
+
+      # @overload wrapper(element, options={})
+      #   Use a {Wrapper} around a {Types::Base} or a {Model} object
+      #   @param element [Types::Base,Model]
+      #   @param options [Hash]
+      #   @return [WrapElem]
+      #   @since 0.12
+      # @overload(options={})
+      #   @param options [Hash]
+      #   @return [WrapElem]
+      #   @yieldreturn [BaseElem, ModelElem] element to wrapp
+      #   @since 0.17.0
+      def wrapper(element_or_options={}, options={}, &)
+        case element_or_options
+        when Hash
+          element = generate_content(&).last
+          options = element_or_options
+        else
+          element = element_or_options
+        end
+        push_element(WrapElem.new(element, options))
+      end
+
+      # Update options of root element.
+      # May be used when subclassing.
+      #  class Model1 < RASN1::Model
+      #    sequence :seq, implicit: 0,
+      #             content: [bool(:bool), integer(:int)]
+      #  end
+      #
+      #  # same as Model1 but with implicit tag set to 1
+      #  class Model2 < Model1
+      #    root_options implicit: 1
+      #  end
+      # @param options [Hash]
+      # @return [void]
+      # @since 0.12.0 may change name through +:name+
+      def root_options(options)
+        @options = options
+        return unless options.key?(:name)
+
+        self.root = root.dup
+        root.name = options[:name]
+      end
+
+      # @private
+      # @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)
+        singleton_class.class_eval <<-EVAL, __FILE__, __LINE__ + 1
+          def #{accel_name}(name, options={}) # def sequence(name, type, options)
+            options[:name] = name
+            proc = proc do |opts|
+              #{klass}.new(options.merge(opts)) # Sequence.new(options.merge(opts))
+            end
+            push_element(BaseElem.new(name, proc, nil))
+          end
+        EVAL
+      end
+
+      # @private
+      # @param accel_name [String,Symbol]
+      # @param klass [Class]
+      # @since 0.17.0
+      def define_type_accel_container(accel_name, klass)
+        singleton_class.class_eval <<-EVAL, __FILE__, __LINE__ + 1
+          def #{accel_name}(name, options={}, &block) # def sequence(name, type, options, &block)
+            options[:name] = name
+            proc = proc do |opts|
+              #{klass}.new(options.merge(opts)) # Sequence.new(options.merge(opts))
+            end
+            options[:content] ||= []
+            options[:content] += generate_content(&block)
+            push_element(BaseElem.new(name, proc, options[:content]))
+          end
+        EVAL
+      end
+
+      # @private
+      # @since 0.17.0
+      def generate_content
+        return [] unless block_given?
+
+        previous_elements = @elements
+        @elements = []
+        yield
+        content = @elements
+        @elements = previous_elements
+        content
+      end
+
+      # @private
+      # @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)
+        singleton_class.class_eval <<-EVAL, __FILE__, __LINE__ + 1
+          def #{accel_name}_of(name, type, options={}) # def sequence_of(name, type, options)
+            options[:name] = name
+            proc = proc do |opts|
+              #{klass}.new(type, options.merge(opts)) # SequenceOf.new(type, options.merge(opts))
+            end
+            push_element(BaseElem.new(name, proc, nil))
+          end
+        EVAL
+      end
+
+      # Define an accelarator to access a type in a model definition
+      # @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)
+        if klass <= Types::SequenceOf
+          define_type_accel_of(accel_name, klass)
+        elsif (klass <= Types::Sequence) || (klass <= Types::Choice)
+          define_type_accel_container(accel_name, klass)
+        else
+          define_type_accel_base(accel_name, klass)
+        end
+      end
+
+      # @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+.
+      # @see Types::ObjectId#initialize
+      def objectid(name, options={})
+        options[:name] = name
+        proc = proc { |opts| Types::ObjectId.new(options.merge(opts)) }
+        push_element(BaseElem.new(name, proc, nil))
+      end
+
+      # @param name [Symbol,String] name of object in model
+      # @param options [Hash]
+      # @return [Elem]
+      # @see Types::Any#initialize
+      def any(name, options={})
+        options[:name] = name
+        proc = proc { |opts| Types::Any.new(options.merge(opts)) }
+        push_element(BaseElem.new(name, proc, nil))
+      end
+
+      # Give type name (aka class name)
+      # @return [String]
+      def type
+        return @type if defined? @type
+
+        @type = self.to_s.gsub(/.*::/, '')
+      end
+
+      # Parse a DER/BER encoded string
+      # @param str [String]
+      # @param ber [Boolean] accept BER encoding or not
+      # @return [Model]
+      # @raise [ASN1Error] error on parsing
+      def parse(str, ber: false)
+        model = new
+        model.parse!(str, ber: ber)
+        model
+      end
+    end
+  end
+end

data/lib/rasn1/model.rb

@@ -6,6 +6,8 @@
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
+require_relative 'model/accel'
+
 module RASN1
   # @abstract
   # {Model} class is a base class to define ASN.1 models.
@@ -16,7 +18,8 @@ module RASN1
   #    room  [0] IMPLICIT INTEGER OPTIONAL,
   #    house [1] EXPLICIT INTEGER DEFAULT 0
   #  }
-  # you may create your model like this:
+  #
+  # You may create your model like this:
   #  class Record < RASN1::Model
   #    sequence(:record,
   #             content: [integer(:id),
@@ -24,6 +27,15 @@ module RASN1
   #                       integer(:house, explicit: 1, default: 0)])
   #  end
   #
+  # You may also use block style definition:
+  #  class Record < RASN1::Model
+  #    sequence :record do
+  #      integer :id
+  #      integer :room, implicit: 0, optional: true
+  #      integer :house, explicit: 1, default: 0
+  #    end
+  #  end
+  #
   # In a model, each element must have a unique name.
   #
   # === Parse a DER-encoded string
@@ -47,10 +59,12 @@ module RASN1
   # == Create a more complex model
   # Models may be nested. For example:
   #  class Record2 < RASN1::Model
-  #    sequence(:record2,
-  #             content: [boolean(:rented, default: false),
-  #                       model(:a_record, Record)])
+  #    sequence :record2 do
+  #      boolean :rented, default: false)
+  #      model :a_record, Record
+  #    end
   #  end
+  #
   # Set values like this:
   #  record2 = Record2.new
   #  record2[:rented] = true
@@ -67,15 +81,22 @@ module RASN1
   # this method.
   # @author Sylvain Daubert
   # @author adfoster-r7 ModelValidationError, track source location for dynamic class methods
+  # @since 0.17 block notation
   class Model # rubocop:disable Metrics/ClassLength
     # @private Base Element
-    BaseElem = Struct.new(:name, :proc, :content) do
+    class BaseElem
+      attr_accessor :name
+      attr_reader :proc, :content, :block
+
       # @param name [String,Symbol]
       # @param proc [Proc]
       # @param content [Array,nil]
-      def initialize(name, proc, content)
+      def initialize(name, proc, content, &block)
+        @name = name
+        @proc = proc
+        @content = content
+        @block = block
         check_duplicates(content.map(&:name) + [name]) unless content.nil?
-        super
       end
 
       private
@@ -111,148 +132,6 @@ module RASN1
     # @private Sequence types
     SEQUENCE_TYPES = [Types::Sequence, Types::SequenceOf, Types::Set, Types::SetOf].freeze
 
-    # Define helper methods to define models
-    module Accel
-      # @return [Hash]
-      attr_reader :options
-
-      # Use another model in this model
-      # @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 element [Types::Base,Model]
-      # @param options [Hash]
-      # @return [WrapElem]
-      # @since 0.12
-      def wrapper(element, options={})
-        @root = WrapElem.new(element, options)
-      end
-
-      # Update options of root element.
-      # May be used when subclassing.
-      #  class Model1 < RASN1::Model
-      #    sequence :seq, implicit: 0,
-      #             content: [bool(:bool), integer(:int)]
-      #  end
-      #
-      #  # same as Model1 but with implicit tag set to 1
-      #  class Model2 < Model1
-      #    root_options implicit: 1
-      #  end
-      # @param options [Hash]
-      # @return [void]
-      # @since 0.12.0 may change name through +:name+
-      def root_options(options)
-        @options = options
-        return unless options.key?(:name)
-
-        @root = @root.dup
-        @root.name = options[:name]
-      end
-
-      # On inheritance, create +@root+ class variable
-      # @param klass [Class]
-      # @return [void]
-      def inherited(klass)
-        super
-        root = @root
-        klass.class_eval { @root = root }
-      end
-
-      # @private
-      # @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)
-        singleton_class.class_eval <<-EVAL, __FILE__, __LINE__ + 1
-          def #{accel_name}(name, options={}) # def sequence(name, type, options)
-            options[:name] = name
-            proc = proc do |opts|
-              #{klass}.new(options.merge(opts)) # Sequence.new(options.merge(opts))
-            end
-            @root = BaseElem.new(name, proc, options[:content])
-          end
-        EVAL
-      end
-
-      # @private
-      # @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)
-        singleton_class.class_eval <<-EVAL, __FILE__, __LINE__ + 1
-          def #{accel_name}_of(name, type, options={}) # def sequence_of(name, type, options)
-            options[:name] = name
-            proc = proc do |opts|
-              #{klass}.new(type, options.merge(opts)) # SequenceOf.new(type, options.merge(opts))
-            end
-            @root = BaseElem.new(name, proc, nil)
-          end
-        EVAL
-      end
-
-      # Define an accelarator to access a type in a model definition
-      # @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)
-        if klass < Types::SequenceOf
-          define_type_accel_of(accel_name, klass)
-        else
-          define_type_accel_base(accel_name, klass)
-        end
-      end
-
-      # @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+.
-      # @see Types::ObjectId#initialize
-      def objectid(name, options={})
-        options[:name] = name
-        proc = proc { |opts| Types::ObjectId.new(options.merge(opts)) }
-        @root = BaseElem.new(name, proc, nil)
-      end
-
-      # @param name [Symbol,String] name of object in model
-      # @param options [Hash]
-      # @return [Elem]
-      # @see Types::Any#initialize
-      def any(name, options={})
-        options[:name] = name
-        proc = proc { |opts| Types::Any.new(options.merge(opts)) }
-        @root = BaseElem.new(name, proc, nil)
-      end
-
-      # Give type name (aka class name)
-      # @return [String]
-      def type
-        return @type if defined? @type
-
-        @type = self.to_s.gsub(/.*::/, '')
-      end
-
-      # Parse a DER/BER encoded string
-      # @param str [String]
-      # @param ber [Boolean] accept BER encoding or not
-      # @return [Model]
-      # @raise [ASN1Error] error on parsing
-      def parse(str, ber: false)
-        model = new
-        model.parse!(str, ber: ber)
-        model
-      end
-    end
-
     extend Accel
 
     # @!method sequence(name, options)
@@ -274,7 +153,7 @@ module RASN1
     #  @return [Elem]
     #  @see Types::Choice#initialize
     %w[sequence set choice].each do |type|
-      self.define_type_accel_base(type, Types.const_get(type.capitalize))
+      self.define_type_accel_container(type, Types.const_get(type.capitalize))
     end
 
     # @!method sequence_of(name, type, options)
@@ -610,7 +489,7 @@ module RASN1
     # @return [void]
     def generate_root(args)
       opts = args.slice(:name, :explicit, :implicit, :optional, :class, :default, :constructed, :tag_value)
-      root = self.class.class_eval { @root }
+      root = self.class.root
       root_options = self.class.options || {}
       root_options.merge!(opts)
       @root_name = args[:name] || root.name

data/lib/rasn1/tracer.rb

@@ -38,6 +38,12 @@ module RASN1
       level ||= @tracing_level
       '  ' * level
     end
+
+    def higher_tracing_level
+      self.tracing_level += 1
+      yield
+      self.tracing_level -= 1
+    end
   end
 
   # Trace RASN1 parsing to +io+.
@@ -107,9 +113,7 @@ module RASN1
       # @return [void]
       # @see #parse!
       def do_parse_explicit_with_tracing(data)
-        RASN1.tracer.tracing_level += 1
-        do_parse_explicit_without_tracing(data)
-        RASN1.tracer.tracing_level -= 1
+        RASN1.tracer.higher_tracing_level { do_parse_explicit_without_tracing(data) }
       end
     end
 
@@ -163,9 +167,7 @@ module RASN1
       # der_to_value +der+ with tracing abillity
       # @!macro do_parse
       def der_to_value_with_tracing(der, ber: false)
-        RASN1.tracer.tracing_level += 1
-        der_to_value_without_tracing(der, ber: ber)
-        RASN1.tracer.tracing_level -= 1
+        RASN1.tracer.higher_tracing_level { der_to_value_without_tracing(der, ber: ber) }
       end
     end
 
@@ -191,9 +193,7 @@ module RASN1
       # der_to_value +der+ with tracing abillity
       # @!macro do_parse
       def der_to_value_with_tracing(der, ber: false)
-        RASN1.tracer.tracing_level += 1
-        der_to_value_without_tracing(der, ber: ber)
-        RASN1.tracer.tracing_level -= 1
+        RASN1.tracer.higher_tracing_level { der_to_value_without_tracing(der, ber: ber) }
       end
     end
   end

data/lib/rasn1/types/generalized_time.rb

@@ -101,19 +101,11 @@ module RASN1
       # Compute TZ from +date_hour+ string
       # @param date_hour [String]
       # @return [String]
-      # @note
-      #   Ruby 3.0: special handle for timezone
-      #     * From 3.1: "Z" and "-0100" are supported
-      #     * Below 3.1: should be "-01:00" or "+00:00"
       def compute_tz(date_hour)
         if date_hour.end_with?('Z')
           date_hour.slice!(-1, 1)
-          '+00:00' # Ruby 3.0: to remove after end-of support of ruby 3.0
         elsif date_hour.match?(/[+-]\d+$/)
-          # Ruby 3.0
-          # date_hour.slice!(-5, 5)
-          zone = date_hour.slice!(-5, 5).to_s
-          "#{zone[0, 3]}:#{zone[3, 2]}"
+          date_hour.slice!(-5, 5)
         end
       end
 

data/lib/rasn1/version.rb

@@ -8,5 +8,5 @@
 
 module RASN1
   # RASN1 version number
-  VERSION = '0.16.3'
+  VERSION = '0.17.0'
 end

data/lib/rasn1.rb

@@ -41,16 +41,16 @@ module RASN1
       size = type.parse!(der, ber: ber)
 
       if CONTAINER_CLASSES.include?(type.class)
-        RASN1.tracer.tracing_level += 1 unless RASN1.tracer.nil?
+        RASN1.tracer&.tracing_level += 1
         content = self.parse(type.value)
-        type.value = content.is_a?(Array) ? content : [content]
-        RASN1.tracer.tracing_level -= 1 unless RASN1.tracer.nil?
+        type.value = Array(content)
+        RASN1.tracer&.tracing_level -= 1
       end
 
       result << type
       der = der[size..]
     end
 
-    result.size == 1 ? result[0] : result
+    result.size == 1 ? result.first : result
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasn1
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.17.0
 platform: ruby
 authors:
 - LemonTree55
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-21 00:00:00.000000000 Z
+date: 2026-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strptime
@@ -40,6 +40,7 @@ files:
 - lib/rasn1.rb
 - lib/rasn1/errors.rb
 - lib/rasn1/model.rb
+- lib/rasn1/model/accel.rb
 - lib/rasn1/tracer.rb
 - lib/rasn1/types.rb
 - lib/rasn1/types/any.rb
@@ -91,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Ruby ASN.1 library