claricle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 817d379b186d43637928f0a12bdabb9d773320c458be04085d31c4eb1bbfaa7f
+  data.tar.gz: 75e2d671d3b02e716a44c4a56a7d6b1ecb54126f8592be6be497e445dcb77668
+SHA512:
+  metadata.gz: 041c3ad2a73d507c2189fd4b62d12a317c377eef5b75c9e6a97b4dacde8f45c4cec0f2a7d356528510f4ec83ad8035879720b30f922d6edb5159269c8e881a1b
+  data.tar.gz: 292fc0f4beb01a074b98437c512e8f49f16511d0e6a24ec997b68d8a482d5e5bff87858034b8a798f66ef818cd5209754959ebb1785b1e95a007a991b31f8b71

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in claricle.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/README.adoc

@@ -0,0 +1,291 @@
+= Claricle
+
+image:https://img.shields.io/gem/v/claricle.svg[RubyGems Version]
+image:https://img.shields.io/github/license/ribose/claricle.svg[License]
+image:https://github.com/ribose/claricle/actions/workflows/test.yml/badge.svg["Build Status", link="https://github.com/ribose/claricle/actions/workflows/test.yml"]
+
+== Purpose
+
+Claricle is a comprehensive image utility gem that provides tools for image
+validation, format conversion, compression, and vector graphics processing.
+
+The gem integrates functionality from multiple specialized tools including
+pngconform, svgconform, and vectory into a unified interface, making it easier
+to work with various image formats in Ruby applications.
+
+This library is particularly useful for applications that need to:
+
+* Validate image files for conformance to standards
+* Convert between different image formats
+* Compress images while maintaining quality
+* Process vector graphics programmatically
+
+== Etymology & Symbolism
+
+[cols="1,2,3",options="header"]
+|===
+|Part
+|Root
+|Meaning
+
+|clari-
+|Latin _clārus_
+|"clear, bright, famous" -- root of clarity, clarify
+
+|-cle
+|Latin _cle_ (from _particula_)
+|"small particle" -- like particle, fascicle
+|===
+
+*Combined:* "Clear particle" or "Bright essence"
+
+Perfect metaphor:
+
+* *Validation* → clarify every pixel/particle
+* *Conversion* → preserve the clear essence
+* *Compression* → bright clarity in every bit
+* *Ruby* → gem-like, small but brilliant
+
+== Features
+
+[NOTE]
+====
+This is currently a minimal shim release to reserve the gem name.
+Full functionality will be implemented in future versions.
+====
+
+Planned features:
+
+* PNG validation and conformance checking (via pngconform)
+* SVG validation and processing (via svgconform)
+* Vector graphics manipulation (via vectory)
+* Image format conversion utilities
+* Image compression with quality preservation
+* Command-line interface for all operations
+* Ruby API for programmatic access
+* Batch processing capabilities
+* Comprehensive error reporting
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'claricle'
+----
+
+And then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,sh]
+----
+$ gem install claricle
+----
+
+== Command Line Interface
+
+The `claricle` command provides utilities for working with image files.
+
+=== Available Commands
+
+Get help on available commands:
+
+[source,sh]
+----
+$ claricle help
+Commands:
+  claricle compress FILE_PATTERN  # Compress image files (placeholder)
+  claricle convert SOURCE DEST    # Convert image formats (placeholder)
+  claricle help [COMMAND]         # Describe available commands or one specific command
+  claricle validate FILE_PATTERN  # Validate image files (placeholder)
+  claricle version                # Display Claricle version
+----
+
+=== Version Information
+
+Display the installed version:
+
+[source,sh]
+----
+$ claricle version
+Claricle version 0.1.0
+----
+
+=== Validation (Placeholder)
+
+[NOTE]
+====
+This functionality is not yet implemented in this shim release.
+====
+
+Future usage:
+
+[source,sh]
+----
+# Validate a single image file
+$ claricle validate image.png
+
+# Validate multiple files
+$ claricle validate *.svg
+
+# Validate files using patterns
+$ claricle validate "images/*.png"
+----
+
+=== Conversion (Placeholder)
+
+[NOTE]
+====
+This functionality is not yet implemented in this shim release.
+====
+
+Future usage:
+
+[source,sh]
+----
+# Convert between formats
+$ claricle convert image.png image.svg
+$ claricle convert logo.svg logo.png
+----
+
+=== Compression (Placeholder)
+
+[NOTE]
+====
+This functionality is not yet implemented in this shim release.
+====
+
+Future usage:
+
+[source,sh]
+----
+# Compress image files
+$ claricle compress image.png
+$ claricle compress *.jpg
+----
+
+== Usage
+
+=== Basic Example (Future)
+
+[source,ruby]
+----
+require 'claricle'
+
+# Validate an image
+validator = Claricle::Validator.new
+result = validator.validate('image.png')
+
+if result.valid?
+  puts "Image is valid!"
+else
+  puts "Validation errors:"
+  result.errors.each { |error| puts "  - #{error}" }
+end
+
+# Convert image format
+converter = Claricle::Converter.new
+converter.convert('image.png', 'image.svg')
+
+# Compress image
+compressor = Claricle::Compressor.new
+compressor.compress('image.png', quality: 85)
+----
+
+== Architecture
+
+=== Current Structure
+
+[source]
+----
+Claricle (Gem)
+    │
+    ├── CLI (Thor-based command-line interface)
+    │   ├── validate command (placeholder)
+    │   ├── convert command (placeholder)
+    │   ├── compress command (placeholder)
+    │   └── version command (implemented)
+    │
+    └── Core Module (placeholder for future components)
+        ├── Validator (future: PNG, SVG validation)
+        ├── Converter (future: format conversion)
+        ├── Compressor (future: image compression)
+        └── VectorProcessor (future: vector graphics)
+----
+
+=== Future Architecture
+
+The planned architecture will integrate specialized tools:
+
+[source]
+----
+┌─────────────────────────────────────────────────────────┐
+│                    Claricle Gem                         │
+│                                                         │
+│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐ │
+│  │  PNG Module  │  │  SVG Module  │  │Vector Module │ │
+│  │              │  │              │  │              │ │
+│  │ pngconform   │  │ svgconform   │  │   vectory    │ │
+│  └──────────────┘  └──────────────┘  └──────────────┘ │
+│                                                         │
+│  ┌────────────────────────────────────────────────┐   │
+│  │         Unified API & CLI Interface             │   │
+│  └────────────────────────────────────────────────┘   │
+└─────────────────────────────────────────────────────────┘
+----
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you
+to experiment.
+
+To install this gem onto your local machine, run:
+
+[source,sh]
+----
+$ bundle exec rake install
+----
+
+To release a new version, update the version number in `version.rb`, and then
+run:
+
+[source,sh]
+----
+$ bundle exec rake release
+----
+
+This will create a git tag for the version, push git commits and the created
+tag, and push the `.gem` file to https://rubygems.org[RubyGems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/ribose/claricle.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+https://github.com/ribose/claricle/blob/main/CODE_OF_CONDUCT.md[code of conduct].
+
+== Copyright
+
+Copyright https://www.ribose.com[Ribose Inc.]
+
+== License
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/BSD-2-Clause[BSD 2-Clause License].
+
+== Code of Conduct
+
+Everyone interacting in the Claricle project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+https://github.com/ribose/claricle/blob/main/CODE_OF_CONDUCT.md[code of conduct].

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/claricle.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/claricle/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "claricle"
+  spec.version = Claricle::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "Claricle is a comprehensive image utility gem for validation, conversion, and compression."
+  spec.description = <<~HEREDOC
+    Claricle provides a Ruby library for working with images, offering tools for
+    image validation (PNG, SVG), format conversion, compression, and vector
+    graphics processing. The name combines "clarity" and "particle", representing
+    the clear validation of every pixel. It is built to integrate functionality
+    from pngconform, svgconform, vectory, and other image processing tools into
+    a unified interface.
+  HEREDOC
+
+  spec.homepage = "https://github.com/ribose/claricle"
+  spec.license = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ribose/claricle"
+  spec.metadata["changelog_uri"] = "https://github.com/ribose/claricle"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 1.0"
+end

data/exe/claricle

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "claricle"
+
+Claricle::Cli.start(ARGV)

data/lib/claricle/cli.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Claricle
+  # Command-line interface for Claricle
+  class Cli < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "version", "Display Claricle version"
+    def version
+      puts "Claricle version #{Claricle::VERSION}"
+    end
+
+    desc "validate FILE_PATTERN", "Validate image files (placeholder)"
+    long_desc <<~LONGDESC
+      Validate image files against their respective standards.
+
+      This command will validate PNG, SVG, and other image formats
+      for conformance and correctness.
+
+      Note: This is a placeholder command. Functionality will be
+      implemented in future versions.
+
+      Examples:
+        claricle validate image.png
+        claricle validate *.svg
+        claricle validate "images/*.png"
+    LONGDESC
+    def validate(_pattern)
+      puts "Image validation functionality coming soon!"
+      puts "This gem is currently a placeholder to reserve the name."
+    end
+
+    desc "convert SOURCE DEST", "Convert image formats (placeholder)"
+    long_desc <<~LONGDESC
+      Convert images between different formats.
+
+      Note: This is a placeholder command. Functionality will be
+      implemented in future versions.
+
+      Examples:
+        claricle convert image.png image.svg
+        claricle convert logo.svg logo.png
+    LONGDESC
+    def convert(_source, _dest)
+      puts "Image conversion functionality coming soon!"
+      puts "This gem is currently a placeholder to reserve the name."
+    end
+
+    desc "compress FILE_PATTERN", "Compress image files (placeholder)"
+    long_desc <<~LONGDESC
+      Compress image files while maintaining quality.
+
+      Note: This is a placeholder command. Functionality will be
+      implemented in future versions.
+
+      Examples:
+        claricle compress image.png
+        claricle compress *.jpg
+    LONGDESC
+    def compress(_pattern)
+      puts "Image compression functionality coming soon!"
+      puts "This gem is currently a placeholder to reserve the name."
+    end
+  end
+end

data/lib/claricle/version.rb

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

data/lib/claricle.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "claricle/version"
+
+module Claricle
+  class Error < StandardError; end
+
+  # Future component loading will go here:
+  # require_relative "claricle/png_validator"
+  # require_relative "claricle/svg_processor"
+  # require_relative "claricle/vector_converter"
+  # require_relative "claricle/image_compressor"
+
+  require_relative "claricle/cli"
+end

data/sig/claricle.rbs

@@ -0,0 +1,4 @@
+module Claricle
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: claricle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  Claricle provides a Ruby library for working with images, offering tools for
+  image validation (PNG, SVG), format conversion, compression, and vector
+  graphics processing. The name combines "clarity" and "particle", representing
+  the clear validation of every pixel. It is built to integrate functionality
+  from pngconform, svgconform, vectory, and other image processing tools into
+  a unified interface.
+email:
+- open.source@ribose.com
+executables:
+- claricle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- claricle.gemspec
+- exe/claricle
+- lib/claricle.rb
+- lib/claricle/cli.rb
+- lib/claricle/version.rb
+- sig/claricle.rbs
+homepage: https://github.com/ribose/claricle
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/ribose/claricle
+  source_code_uri: https://github.com/ribose/claricle
+  changelog_uri: https://github.com/ribose/claricle
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Claricle is a comprehensive image utility gem for validation, conversion,
+  and compression.
+test_files: []