canon 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a8c9da045b6e04e129d80c19a1ff7a3437841c28b5e3036913259eb3dc9fc7d
-  data.tar.gz: c0a871782a39c618ac5f947f748b6d2674f6c18c574d94a7526cdfc32bf58238
+  metadata.gz: 8731c16240a9a73c7596318b4ff10ba07041f5ad781b035e3cd09c4939e82cee
+  data.tar.gz: d78fa0d273ef2cad336cec103443b00c7ee41dcd0d5289a30059804b13e5fa43
 SHA512:
-  metadata.gz: 7351aa91465f71a18cadb390b58fe9f39563822f9333f3d1e80a88538561c42518bb597873ac70d23ada797f39a3d9f2019e450cb498329aff4eeda32dd1c1a7
-  data.tar.gz: 05fee78316eebc60ebe29c99c755933a4c96e3cb463dabbffa07929505eb400e5c7a1aeb8cbf608e01cbaeaa859e4c4864ee4a415ddd379136d47fc70090ccc4
+  metadata.gz: 5e5412a35878e93a86f678d836b723a3ae02f5adc4b5bd1be9b1f1dff4d8ed8f83c6838665ca7d20e8adf3adb1d502d4a97e0c09b4988082fdd20c3cc9c3988f
+  data.tar.gz: 477ddf5857421cc2eff7444faee2f9becd8afc1e759bed1de6c4e8e657f3a5b8a6e34b573b5f0b347ae401c93cb70d70479db3b0f51ea32f0d8b7a9da91ad460

data/.rubocop.yml

@@ -2,10 +2,10 @@
 # See https://github.com/metanorma/cimas
 inherit_from:
   - .rubocop_todo.yml
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
 
 # local repo-specific modifications
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -1,11 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-07-29 05:56:24 UTC using RuboCop version 1.79.0.
+# on 2025-07-29 13:58:20 UTC using RuboCop version 1.79.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'canon.gemspec'
+
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
@@ -14,27 +21,3 @@ Layout/LineLength:
   Exclude:
     - 'canon.gemspec'
     - 'spec/canon/xml/formatter_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
-  Exclude:
-    - 'lib/canon/rspec_matchers.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'lib/canon/rspec_matchers.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/canon/rspec_matchers.rb'

data/README.adoc

@@ -67,6 +67,26 @@ The `format` method is used to pretty-print and canonicalize the input data,
 with the arguments of the method taking the content and the format type as
 arguments.
 
+Syntax:
+
+[source,ruby]
+----
+# Generic method
+Canon.format({content}, {format})
+
+# Format-specific method
+Canon.format_{format}({content})
+----
+
+Where,
+
+`{content}`:: is the input string
+`{format}`:: is the format type, which can be `:xml`, `:yaml`, or `:json`.
+
+
+.Demonstration of formatting methods
+[example]
+====
 [source,ruby]
 ----
 require 'canon'
@@ -75,17 +95,24 @@ require 'canon'
 xml_input = '<root><b>2</b><a>1</a></root>'
 formatted_xml = Canon.format(xml_input, :xml)
 # => Pretty-printed XML with consistent formatting
+# or
+formatted_xml = Canon.format_xml(xml_input)
 
 # YAML formatting
 yaml_input = "---\nz: 3\na: 1\nb: 2\n"
 formatted_yaml = Canon.format(yaml_input, :yaml)
 # => YAML with keys sorted alphabetically
+# or
+formatted_yaml = Canon.format_yaml(yaml_input)
 
 # JSON formatting
 json_input = '{"z":3,"a":1,"b":2}'
 formatted_json = Canon.format(json_input, :json)
 # => Pretty-printed JSON with keys sorted alphabetically
+# or
+formatted_json = Canon.format_json(json_input)
 ----
+====
 
 
 === Parsing
@@ -94,20 +121,44 @@ Canon can also parse XML, YAML, and JSON strings into Ruby objects. The `parse`
 method takes the content and the format type as arguments, returning a Ruby
 object (Hash, Array, etc.) for YAML and JSON, or a Nokogiri XML document for XML.
 
+Syntax:
+
+[source,ruby]
+----
+# Generic method
+Canon.parse({content}, {format})
+
+# Format-specific method
+Canon.parse_{format}({content})
+----
+
+Where,
+
+`{content}`:: is the input string
+`{format}`:: is the format type, which can be `:xml`, `:yaml`, or `:json`.
+
+.Demonstration of parsing methods
+[example]
+====
 [source,ruby]
 ----
 # Parse XML
 xml_doc = Canon.parse(xml_input, :xml)
+xml_doc = Canon.parse_xml(xml_input)
 # => Nokogiri::XML::Document
 
 # Parse YAML
 yaml_obj = Canon.parse(yaml_input, :yaml)
+yaml_obj = Canon.parse_yaml(yaml_input)
 # => Ruby object (Hash, Array, etc.)
 
 # Parse JSON
 json_obj = Canon.parse(json_input, :json)
+json_obj = Canon.parse_json(json_input)
 # => Ruby object (Hash, Array, etc.)
 ----
+====
+
 
 === RSpec matchers
 
@@ -166,4 +217,3 @@ https://github.com/lutaml/canon.
 == Copyright and license
 
 Copyright Ribose. https://opensource.org/licenses/BSD-2-Clause[BSD-2-Clause License].
-

data/lib/canon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Canon
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/canon.rb

@@ -8,6 +8,8 @@ require_relative "canon/formatters/json_formatter"
 require_relative "canon/rspec_matchers" if defined?(::RSpec)
 
 module Canon
+  SUPPORTED_FORMATS = %i[xml yaml json].freeze
+
   # Format content based on the specified format type
   # @param content [String] The content to format
   # @param format [Symbol] The format type (:xml, :yaml, :json)
@@ -37,5 +39,17 @@ module Canon
     end
   end
 
+  # Define shorthand methods for each supported format
+  # Creates parse_{format} and format_{format} methods
+  SUPPORTED_FORMATS.each do |format|
+    define_singleton_method("parse_#{format}") do |content|
+      parse(content, format)
+    end
+
+    define_singleton_method("format_#{format}") do |content|
+      format(content, format)
+    end
+  end
+
   class Error < StandardError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canon
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ribose Inc.