Review my gem(saft (standard audit format Tax)) using dry-struct

stoivo · December 30, 2022, 9:53am

Hi,

I have just created a gem for exporting SAF-T standard audit format Tax for norway. The gem takes an xml and converts it into struct, and it can take structs and create xml from it.

rubygem link saft | RubyGems.org | your community gem host
source code GitHub - dodoas/ruby-saft: gem for assist working with SAF-T (Standard Audit File for Tax)

I wondered if any of you would like to take a look at the gem and give me some ideas to what I can do to improve the code?

I have craed tree types of Audit filed which is root object. I have Strict, Relaxed and Sliced. The idea here was that if you want it to low up as soon as possible you use the Strict version and if you want to have all the errors from the xs, there are quite a lot of validations in the xsd which I havn’t copied, and then Sliced, which just sliced all strings down to max length so if you have a name or address which is too long I would cust cut it.

github.com

dodoas/ruby-saft/blob/a4b2d0c93815a13e1ee1e5f7ff44feabf3ff47cd/lib/saft/v2/types.rb#L427-L487


      
          module Relaxed
            ISOCurrencyCode = Types::String
            ISOCountryCode = Types::String
            SAFcodeType = Types::String
            SAFshorttextType = Types::String
            SAFmiddle1textType = Types::String
            SAFmiddle2textType = Types::String
            SAFlongtextType = Types::String
            SAFmonetaryType = Types::Decimal
            SAFexchangerateType = Types::Decimal
            SAFquantityType = Types::Decimal
            SAFweightType = Types::Decimal
            AddressType = Types::String
          
          
  extend ObjectStrutures
          end
          
          
module Strict
            ISOCurrencyCode = Types::String.constrained(size: 3)
            ISOCountryCode = Types::String.constrained(size: 2)

This file has been truncated. show original

I thing this might have been a stupid idea to have three root types. I am thinking: maybe I should only have created Relaxed and then created validator with dry validator to ensure the length is propperly, if so I would propbably get better errormessaged then what I do today, as well Is I could introduce more rules which goes across multiple attributes.

Anouther other question I have is: Is it bad to define my own Predicated with Dry::Logic::Predicates.predicate ? What would my alternative solution be?

github.com

dodoas/ruby-saft/blob/a4b2d0c93815a13e1ee1e5f7ff44feabf3ff47cd/lib/saft/v2/types.rb#L26-L35


      
          Dry::Logic::Predicates.predicate(:digits?) do |num, input|
            _sign, significant_digits, _base, exponent = input.split
            n_significant_digits = significant_digits.length
            n_significant_digits += -exponent if exponent.negative?
            n_significant_digits <= num
          end
          
          
Dry::Logic::Predicates.predicate(:fraction_digits?) do |num, input|
            digits?(num, input.frac)
          end

alassek · January 4, 2023, 6:49pm

At first glance, I would suggest not using dry-struct for validation. That seems to be where a lot of your complexity is coming from here; I would provide standard struct constants and use dry-validation to do the validation.

So your structs would look like the Relaxed types and the validation could add more strictness to the inputs. Then just provide a public interface for validation + struct instantiation.

stoivo · January 5, 2023, 7:08am

yeah, what about this slicing for strings if they are too long?

Is there some easy say to take my struct and convert in into schema?p

Topic		Replies	Views
Best practices for using Dry-Types, Dry-Schema, Dry-Validation, and Dry-Struct together in our apps	1	112	August 7, 2024
Steps on integrating dry into an existing Rails app?	0	708	March 7, 2018
Nested dry-struct serialization Support	2	516	September 5, 2023
DRY.rb + Sorbet - Can we unite? Ideas	8	3230	October 17, 2022
Transactable 0.0.0 - A DSL for function composition Announcements	2	476	September 17, 2022

Review my gem(saft (standard audit format Tax)) using dry-struct

Related topics