xml2json-rb 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3136f4ff83c6e8851b4fbfcb2bc343f3cf4a453a27dc566c63f3b3d661364c84
-  data.tar.gz: 8a98b15dacac13a9fea305985e74325eeb173fe7d8d1ce19ce4e8114d98c15a2
+  metadata.gz: 894ff6fe88c1e4a0e7bbb426419954f98413f568f8ac361784e60537074033fd
+  data.tar.gz: face561e86ac59fb767535689377e361f171574b77722ba55a55056c96630767
 SHA512:
-  metadata.gz: 96c29af1693eb23580ac8f42bca2627b8b46aa57d5fe776e4b7171263e17f1b92fee00bec36668816bdca5f9a24a34e5440c8ad4ca24032a737173c5bbda591a
-  data.tar.gz: 05d2d14fe2c6195eb8d5c00a9e5c0e4b2f875c6f4f119f0c0e12257299b8ece2dbecbaa22102474081cc3a1d18fa7ebb991f5e47781ac9b77e49b0a8d0adfba2
+  metadata.gz: 2d3917434cd6824082cb8256ef752e10af0153d29da3b00365f0ed5ceebcef5626e422998b52a7f1a3c63b44ab2b49586f079557e1cb4888a08cf2d4f128c9bc
+  data.tar.gz: 36cf6993a5ca3f586357b8d46b9a038ad53cab83eae759fa1506ab58989cdd3c97dad69fe15a44f3ecea49eb3ac7287f35a75a01582e3bd13d493e58029a523a

data/Cargo.lock

@@ -344,7 +344,7 @@ checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
 
 [[package]]
 name = "xml2json"
-version = "0.1.0"
+version = "0.2.1"
 dependencies = [
  "magnus",
  "xml2json-rs",

data/ext/xml2json/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "xml2json"
-version = "0.1.0"
+version = "0.2.1"
 edition = "2021"
 authors = ["uvlad7 <uvlad7@gmail.com>"]
 license = "MIT"

data/ext/xml2json/src/lib.rs

@@ -1,47 +1,182 @@
-use magnus::{define_module, function, prelude::*, Error};
-use xml2json_rs::{XmlBuilder, JsonBuilder};
+use magnus::{define_module, function, prelude::*, Error, Value};
+use magnus::scan_args::{scan_args};
+use xml2json_rs::{XmlBuilder, JsonBuilder, JsonConfig, XmlConfig, Declaration, Version, Encoding, Indentation};
 
 // fn hello(subject: String) -> String {
 //     format!("Hello from Rust, {}!", subject)
 // }
 
-// struct RbXmlConfig {
-//     val: XmlConfig,
-// }
+#[macro_export]
+macro_rules! set_arg {
+    ($config:expr, $opts_hash:expr, $arg:ident, $arg_type:ident) => (
+        let arg_value = $opts_hash.lookup::<_, Option<$arg_type>>(magnus::Symbol::new(stringify!($arg)))?;
+        if arg_value.is_some() {
+            $config.$arg(arg_value.unwrap());
+        }
+    );
+}
 
-// impl RbXmlConfig {
-//     fn root_name(&mut self, key: Option<String>) -> &mut RbXmlConfig {
-//         self.val.root_name(key);
-//         self
-//     }
-//
-//     fn build(self, json_s: String) -> Result<String, Error> {
-//         build_xml_impl(json_s, Some(self))
-//     }
-// }
+fn map_xml2json_err(error: xml2json_rs::X2JError) -> Error {
+    Error::new(magnus::exception::runtime_error(), error.details())
+}
 
-// fn build_xml(json_s: String) -> Result<String, Error> {
-//     build_xml_impl(json_s, None)
-// }
+fn build_xml(args: &[Value]) -> Result<String, Error> {
+    let args = scan_args::<_, _, (), (), _, ()>(args)?;
+    let (json_s, ): (String, ) = args.required;
+    let (opts, ): (Option<magnus::RHash>, ) = args.optional;
+    let _: () = args.keywords;
 
-// fn build_xml_impl(json_s: String, config: Option<RbXmlConfig>) -> Result<String, Error> {
-//     let mut xml_builder = config.map_or_else(|| XmlBuilder::default(), |conf| conf.val.finalize());
-//     xml_builder.build_from_json_string(&json_s).or_else(|error| {
-//         Err(Error::new(magnus::exception::arg_error(), error.to_string()))
-//     })
-// }
+    let mut xml_builder: XmlBuilder;
+    if opts.is_some() { // yep, even if it's an empty hash
+        // println!("{}", opts.unwrap().to_string());
+        let opts_hash = opts.unwrap();
+        let mut config = XmlConfig::new();
+        set_arg!(config, opts_hash, root_name, String);
+        set_arg!(config, opts_hash, attrkey, String);
+        set_arg!(config, opts_hash, charkey, String);
+
+        let decl_version = opts_hash.lookup::<_, Option<Value>>(magnus::Symbol::new("version"))?;
+        let decl_encoding = opts_hash.lookup::<_, Option<Value>>(magnus::Symbol::new("encoding"))?;
+        let decl_standalone = opts_hash.lookup::<_, Option<bool>>(magnus::Symbol::new("standalone"))?;
+        if decl_version.is_some()
+            || decl_encoding.is_some()
+            || decl_standalone.is_some()
+        { // something is specified
+            // I didn't find a way to get defaults without copying them
+            let decl_version_val;
+            if decl_version.is_some() {
+                let decl_version_str = unsafe { decl_version.unwrap().to_s() }?.into_owned();
+                decl_version_val = Version::try_from(decl_version_str.as_str())
+                    .map_err(map_xml2json_err)?;
+            } else { decl_version_val = Version::XML10; }
+            let decl_encoding_val;
+            if decl_encoding.is_some() {
+                let decl_encoding_str = unsafe { decl_encoding.unwrap().to_s() }?.into_owned();
+                decl_encoding_val = Some(Encoding::try_from(decl_encoding_str.as_str())
+                    .map_err(map_xml2json_err)?);
+            } else { decl_encoding_val = None; }
+
+            let decl = Declaration::new(
+                decl_version_val,
+                decl_encoding_val,
+                decl_standalone,
+            );
+            config.decl(decl);
+        }
+
+        let indent = opts_hash.lookup::<_, Option<bool>>(magnus::Symbol::new("indent"))?;
+        if indent.unwrap_or(true) {
+            let indent_char = opts_hash.lookup::<_, Option<char>>(magnus::Symbol::new("indent_char"))?;
+            let indent_size = opts_hash.lookup::<_, Option<usize>>(magnus::Symbol::new("indent_size"))?;
+            if indent_char.is_some()
+                || indent_size.is_some()
+            {
+                let indent_char_val: u8;
+                if indent_char.is_some() {
+                    indent_char_val = u8::try_from(indent_char.unwrap()).map_err(|error| Error::new(magnus::exception::type_error(), error.to_string()))?;
+                } else { indent_char_val = b' '; }
+
+                let intent = Indentation::new(
+                    indent_char_val,
+                    indent_size.unwrap_or(2),
+                );
+                config.rendering(intent);
+            } else if indent.unwrap_or(false) {
+                // because Indentation::default is not the same as not calling config.rendering at all;
+                config.rendering(Indentation::default());
+            }
+        }
+        xml_builder = config.finalize();
+    } else { xml_builder = XmlBuilder::default(); }
 
-fn build_xml(json_s: String) -> Result<String, Error> {
-    let mut xml_builder = XmlBuilder::default();
     xml_builder.build_from_json_string(&json_s).or_else(|error| {
-        Err(Error::new(magnus::exception::runtime_error(), error.details()))
+        Err(map_xml2json_err(error))
     })
 }
 
-fn build_json(xml: String) -> Result<String, Error> {
-    let json_builder = JsonBuilder::default();
+fn build_json(args: &[Value]) -> Result<String, Error> {
+    // https://docs.rs/magnus/latest/magnus/scan_args/fn.scan_args.html
+    let args = scan_args::<_, _, (), (), _, ()>(args)?;
+    let (xml, ): (String, ) = args.required;
+    let (opts, ): (Option<magnus::RHash>, ) = args.optional;
+    // let _: () = args.optional;
+    let _: () = args.keywords;
+
+    // Impossible, too long
+    // let kw = get_kwargs::<_, (), (
+    //     Option<String>, // charkey
+    //     Option<String>, // attrkey
+    //     Option<String>, // empty_tag
+    //     Option<bool>, // explicit_root
+    //     Option<bool>, // trim
+    //     Option<bool>, // ignore_attrs
+    //     Option<bool>, // merge_attrs
+    //     Option<bool>, // normalize_text
+    //     Option<bool>, // lowercase_tags
+    //     Option<bool>, // explicit_array
+    //     Option<bool>, // explicit_charkey
+    // ), ()>(args.keywords, &[], &[
+    //     "charkey",
+    //     "attrkey",
+    //     "empty_tag",
+    //     "explicit_root",
+    //     "trim",
+    //     "ignore_attrs",
+    //     "merge_attrs",
+    //     "normalize_text",
+    //     "lowercase_tags",
+    //     "explicit_array",
+    //     "explicit_charkey",
+    // ])?;
+    // let (
+    //     charkey,
+    //     attrkey,
+    //     empty_tag,
+    //     explicit_root,
+    //     trim,
+    //     ignore_attrs,
+    //     merge_attrs,
+    //     normalize_text,
+    //     lowercase_tags,
+    //     explicit_array,
+    //     explicit_charkey,
+    // ) = kw.optional;
+    // if charkey.is_some()
+    //     || attrkey.is_some()
+    //     || empty_tag.is_some()
+    //     || explicit_root.is_some()
+    //     || trim.is_some()
+    //     || ignore_attrs.is_some()
+    //     || merge_attrs.is_some()
+    //     || normalize_text.is_some()
+    //     || lowercase_tags.is_some()
+    //     || explicit_array.is_some()
+    //     || explicit_charkey.is_some()
+    // {
+    //     println!("any")
+    // } else { println!("none") }
+
+    let json_builder: JsonBuilder;
+    if opts.is_some() { // yep, even if it's an empty hash
+        // println!("{}", opts.unwrap().to_string());
+        let opts_hash = opts.unwrap();
+        let mut config = JsonConfig::new();
+        set_arg!(config, opts_hash, charkey, String);
+        set_arg!(config, opts_hash, attrkey, String);
+        set_arg!(config, opts_hash, empty_tag, String);
+        set_arg!(config, opts_hash, explicit_root, bool);
+        set_arg!(config, opts_hash, trim, bool);
+        set_arg!(config, opts_hash, ignore_attrs, bool);
+        set_arg!(config, opts_hash, merge_attrs, bool);
+        set_arg!(config, opts_hash, normalize_text, bool);
+        set_arg!(config, opts_hash, lowercase_tags, bool);
+        set_arg!(config, opts_hash, explicit_array, bool);
+        set_arg!(config, opts_hash, explicit_charkey, bool);
+        json_builder = config.finalize();
+    } else { json_builder = JsonBuilder::default(); }
+
     json_builder.build_string_from_xml(&xml).or_else(|error| {
-        Err(Error::new(magnus::exception::runtime_error(), error.details()))
+        Err(map_xml2json_err(error))
     })
 }
 
@@ -51,9 +186,13 @@ fn init() -> Result<(), Error> {
     // module.define_singleton_method("hello", function!(hello, 1))?;
     // It's not possible to wrap XmlBuilder
     let xml = module.define_module("Xml")?;
-    xml.define_singleton_method("build", function!(build_xml, 1))?;
-    // xml.define_class("Config", magnus::class::object())?;
+    let xml_version = xml.define_module("Version")?;
+    xml_version.const_set("XML10", Version::XML10.to_string())?;
+    xml_version.const_set("XML11", Version::XML11.to_string())?;
+    let xml_encoding = xml.define_module("Encoding")?;
+    xml_encoding.const_set("UTF8", Encoding::UTF8.to_string())?;
+    xml.define_singleton_method("build", function!(build_xml, -1))?;
     let json = module.define_module("Json")?;
-    json.define_singleton_method("build", function!(build_json, 1))?;
+    json.define_singleton_method("build", function!(build_json, -1))?;
     Ok(())
 }

data/lib/xml2json/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xml2Json
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/xml2json.rb

@@ -3,7 +3,32 @@
 require_relative "xml2json/version"
 require_relative "xml2json/xml2json"
 
+# @see https://github.com/novcn/xml2json-rs docs for the wrapped library
 module Xml2Json
-  class Error < StandardError; end
-  # Your code goes here...
+  # @!parse [ruby]
+  #    module Xml
+  #      module Version
+  #        XML10 = "1.0"
+  #        XML11 = "1.1"
+  #      end
+  #      module Encoding
+  #        UTF8 = "UTF-8"
+  #      end
+  #
+  #      # @param json_s [String, #to_str] JSON string
+  #      # @param opts [Hash<Symbol, Object>] config params
+  #      # @see https://docs.rs/xml2json-rs/1.0.1/xml2json_rs/struct.XmlConfig.html rust doc
+  #      # @return [String] XML string
+  #      # @raise [RuntimeError] if the input string is invalid
+  #      def self.build(json_s, opts: nil); end
+  #    end
+  #
+  #    module Json
+  #      # @param xml [String, #to_str] XML string
+  #      # @param opts [Hash<Symbol, Object>] config params
+  #      # @see https://docs.rs/xml2json-rs/1.0.1/xml2json_rs/struct.JsonConfig.html rust doc
+  #      # @return [String] JSON string
+  #      # @raise [RuntimeError] if the input string is invalid
+  #      def self.build(xml, opts: nil); end
+  #    end
 end

data/sig/xml2_json/json.rbs

@@ -0,0 +1,5 @@
+module Xml2Json
+  module Json
+    def self.build: (xml: String, opts: Hash[Symbol, Object]?) -> String
+  end
+end

data/sig/xml2_json/xml/encoding.rbs

@@ -0,0 +1,7 @@
+module Xml2Json
+  module Xml
+    module Encoding
+      UTF8: String
+    end
+  end
+end

data/sig/xml2_json/xml/version.rbs

@@ -0,0 +1,8 @@
+module Xml2Json
+  module Xml
+    module Version
+      XML10: String
+      XML11: String
+    end
+  end
+end

data/sig/xml2_json/xml.rbs

@@ -0,0 +1,5 @@
+module Xml2Json
+  module Xml
+    def self.build: (json_s: String, opts: Hash[Symbol, Object]?) -> String
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml2json-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - uvlad7
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-09 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard-rustdoc
@@ -24,7 +24,91 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem helps to convert xml strings to json and vise versa
 email:
 - uvlad7@gmail.com
 executables: []
@@ -40,6 +124,10 @@ files:
 - lib/xml2json.rb
 - lib/xml2json/version.rb
 - lib/xml2json/xml2json.so
+- sig/xml2_json/json.rbs
+- sig/xml2_json/xml.rbs
+- sig/xml2_json/xml/encoding.rbs
+- sig/xml2_json/xml/version.rbs
 - sig/xml2json.rbs
 homepage: https://github.com/uvlad7/xml2json-rb
 licenses:
@@ -48,6 +136,7 @@ metadata:
   homepage_uri: https://github.com/uvlad7/xml2json-rb
   source_code_uri: https://github.com/uvlad7/xml2json-rb
   changelog_uri: https://github.com/uvlad7/xml2json-rb/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/xml2json-rb/0.2.1
 post_install_message:
 rdoc_options: []
 require_paths: