comicinfo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f66dfb29761ad9d67b58cb229eeb3806205ecc417162830fa7688075b7886fba
+  data.tar.gz: bec2db8b6b877f0f6b35a7e3123653a7216dc653d847bcd16fa1112b5fe896a2
+SHA512:
+  metadata.gz: f3094240a2e409a5dd41834ba35c2a4cc3ce73ad0e834b14db06d93dd344629dc318dba0760d1a1f8e56a7e6876832d9422b9d34264caca489ea2561f05eda37
+  data.tar.gz: 9de5a0f9c1f14a79139fa6837051a290deb5a1fb43eaa0dc2631153466daf2659d9914befae597669a5fd7c7198496ef5245f28a9554b957aada6ace71d4589e

data/.ruby-version

@@ -0,0 +1 @@
+3.4.6

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-10-05
+
+### Added
+- Complete ComicInfo v2.0 XML schema support
+- `ComicInfo.load()` method for loading from file paths or XML strings
+- `ComicInfo::Issue` class with full field access via Ruby method names
+- `ComicInfo::Page` objects with complete ComicPageInfo attribute support
+- Multi-value field support with both string and array access methods
+- Comprehensive enum validation for BlackAndWhite, Manga, AgeRating fields
+- Range validation for CommunityRating (0.0-5.0)
+- Unicode and international character support
+- Manga-specific features (right-to-left detection, language handling)
+- JSON export via `#to_json` method
+- YAML export via `#to_yaml` method
+- Hash export via `#to_h` method with symbol keys
+- Convenience predicate methods (`#manga?`, `#right_to_left?`, `#black_and_white?`)
+- Page filtering methods (`#cover_pages`, `#story_pages`)
+- Custom exception classes with detailed error messages
+- Comprehensive test suite
+
+### Features
+- **Reading**: Load and parse ComicInfo.xml files with full schema compliance
+- **Validation**: Strict enum and range validation with helpful error messages
+- **Export**: Multiple export formats (JSON, YAML, Hash) for data interchange
+- **Unicode**: Full support for international characters and XML entities
+- **Pages**: Complete page object model with type predicates and attributes
+- **Multi-value**: Smart handling of comma/space-separated field values
+
+## [0.1.0] - 2025-01-XX
+
+### Added
+- Initial project structure
+- Basic gem skeleton
+- Development dependencies setup

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
+veganstraightedge@gmail.com.
+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/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shane Becker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,295 @@
+# ComicInfo Ruby Gem
+
+A Ruby gem that provides an idiomatic interface for reading and writing ComicInfo.xml files,
+following the official ComicInfo schema specifications from the
+[Anansi Project](https://github.com/anansi-project/comicinfo).
+
+![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.4.6-ruby.svg)
+![Gem Version](https://badge.fury.io/rb/comicinfo.svg)
+![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
+
+## Features
+
+- 📚 **Complete Schema Support**: Full ComicInfo v2.0 schema implementation
+- 🔧 **Idiomatic Ruby API**: Ruby-style interface with proper method naming
+- 📁 **Flexible Loading**: Load from file paths or XML strings
+- 🌍 **Unicode Support**: Full Unicode and special character handling
+- 📖 **Manga Support**: Right-to-left reading direction and manga-specific fields
+- ✅ **Comprehensive Validation**: Schema-compliant enum validation and type coercion
+- 🚨 **Detailed Error Handling**: Custom exception classes with helpful error messages
+- 📊 **Export Support**: JSON and YAML serialization with hash representation (in progress)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comicinfo'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install comicinfo
+```
+
+## Usage
+
+### Loading ComicInfo Files
+
+```ruby
+require 'comicinfo'
+
+# Load from file path
+comic = ComicInfo.load 'path/to/ComicInfo.xml'
+
+# Load from XML string
+xml_content = File.read 'ComicInfo.xml'
+comic       = ComicInfo.load xml_content
+```
+
+### Accessing Comic Information
+
+```ruby
+# Basic information
+puts comic.title  #=> "The Amazing Spider-Man"
+puts comic.series #=> "The Amazing Spider-Man"
+puts comic.number #=> "1"
+puts comic.count  #=> 600
+puts comic.volume #=> 3
+
+# Publication details
+puts comic.publisher #=> "Marvel Comics"
+puts comic.year      #=> 2018
+puts comic.month     #=> 3
+puts comic.day       #=> 15
+
+# Creator information
+puts comic.writer       #=> "Dan Slott, Christos Gage"
+puts comic.penciller    #=> "Ryan Ottley"
+puts comic.cover_artist #=> "Ryan Ottley"
+
+# Content details
+puts comic.page_count   #=> 20
+puts comic.genre        #=> "Superhero, Action, Adventure"
+puts comic.language_iso #=> "en-US"
+puts comic.format       #=> "Digital"
+
+# Ratings and reviews
+puts comic.age_rating       #=> "Teen"
+puts comic.community_rating #=> 4.25
+```
+
+### Convenience Methods
+
+```ruby
+# Boolean helpers
+puts comic.manga?           #=> false
+puts comic.right_to_left?   #=> false
+puts comic.black_and_white? #=> false
+
+# Page information
+puts comic.pages?       #=> true
+puts comic.pages.length #=> 12
+
+# Get specific page types
+covers  = comic.cover_pages
+stories = comic.story_pages
+
+# Multi-value fields as arrays
+characters = comic.characters #=> ["Spider-Man", "Peter Parker", ...]
+teams      = comic.teams      #=> ["Avengers"]
+locations  = comic.locations  #=> ["New York City", "Manhattan", ...]
+genres     = comic.genres     #=> ["Superhero", "Action", "Adventure"]
+web_urls   = comic.web_urls   #=> ["https://marvel.com/...", "https://comicvine.com/..."]
+```
+
+### Working with Pages
+
+```ruby
+comic.pages.each do |page|
+  puts "Page #{page.image}: #{page.type}"
+  puts "  Double page: #{page.double_page?}"                    if page.double_page?
+  puts "  Bookmark: #{page.bookmark}"                           if page.bookmarked?
+  puts "  Dimensions: #{page.image_width}x#{page.image_height}" if page.dimensions_available?
+end
+
+# Page type checks
+page = comic.pages.first
+puts page.cover?   #=> true for FrontCover, BackCover, InnerCover
+puts page.story?   #=> true for Story pages
+puts page.deleted? #=> true for Deleted pages
+```
+
+### Manga Support
+
+```ruby
+# Load a manga ComicInfo file
+manga = ComicInfo.load 'path/to/manga/ComicInfo.xml')
+
+puts manga.title            #=> "進撃の巨人"
+puts manga.series           #=> "Attack on Titan"
+puts manga.manga            #=> "YesAndRightToLeft"
+puts manga.right_to_left?   #=> true
+puts manga.language_iso     #=> "ja-JP"
+puts manga.black_and_white? #=> true
+puts manga.black_and_white  #=> "Yes"
+```
+
+### Error Handling
+
+```ruby
+begin
+  comic = ComicInfo.load('nonexistent.xml')
+rescue ComicInfo::Errors::FileError => e
+  puts "File error: #{e.message}"
+rescue ComicInfo::Errors::ParseError => e
+  puts "Parse error: #{e.message}"
+rescue ComicInfo::Errors::InvalidEnumError => e
+  puts "Invalid enum: #{e.field} = '#{e.value}', valid: #{e.valid_values}"
+rescue ComicInfo::Errors::RangeError => e
+  puts "Out of range: #{e.field} = #{e.value}, range: #{e.min}..#{e.max}"
+rescue ComicInfo::Errors::TypeCoercionError => e
+  puts "Type coercion error: #{e.message}"
+end
+```
+
+## Schema Support
+
+This gem fully supports the ComicInfo v2.0 XSD schema with all field types:
+
+### String Fields
+- Title, Series, Number, Summary, Notes
+- Creator fields (Writer, Penciller, Inker, Colorist, Letterer, CoverArtist, Editor, Translator)
+- Publication fields (Publisher, Imprint, Genre, Web, LanguageISO, Format)
+- Character/Location fields (Characters, Teams, Locations, MainCharacterOrTeam)
+- Story fields (StoryArc, StoryArcNumber, SeriesGroup, ScanInformation, Review)
+
+### Integer Fields
+- Count, Volume, AlternateCount, PageCount
+- Date fields (Year, Month, Day)
+
+### Enum Fields
+- BlackAndWhite: "Unknown", "No", "Yes"
+- Manga: "Unknown", "No", "Yes", "YesAndRightToLeft"
+- AgeRating: Various ESRB and international ratings
+
+### Decimal Fields
+- CommunityRating: 0.0 to 5.0 range with validation
+
+### Complex Fields
+- Pages: Array of ComicPageInfo objects with full attribute support
+- Page types: FrontCover, BackCover, InnerCover, Roundup, Story, Advertisement, Editorial, Letters, Preview, Other, Deleted
+
+### Export Formats
+- **JSON**: Complete serialization with all fields
+- **YAML**: Human-readable format with array structures
+- **Hash**: Ruby hash representation with symbol keys
+
+### Data Export
+
+```ruby
+comic = ComicInfo.load 'path/to/ComicInfo.xml'
+
+# Export as JSON
+json_string = comic.to_json
+puts JSON.pretty_generate(JSON.parse(json_string))
+
+# Export as YAML
+yaml_string = comic.to_yaml
+puts yaml_string
+
+# Export as Hash
+hash = comic.to_h
+puts hash[:title]        #=> "The Amazing Spider-Man"
+puts hash[:characters]   #=> ["Spider-Man", "Peter Parker", ...]
+puts hash[:pages].length #=> 12
+```
+
+## 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 `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`,
+which will create a git tag for the version,
+push git commits and the created tag,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Running Tests
+
+```sh
+# Run all tests
+bundle exec rspec
+
+# Run with documentation format
+bundle exec rspec --format documentation
+
+# Run specific test file
+bundle exec rspec spec/comic_info_spec.rb
+```
+
+### Code Quality
+
+```sh
+# Run RuboCop linter
+bundle exec rubocop
+
+# Auto-fix correctable issues
+bundle exec rubocop --autocorrect
+```
+
+## Implementation Status
+
+### Current Features ✅
+- **Core Reading**: Complete ComicInfo.xml parsing
+- **Schema Compliance**: Full ComicInfo v2.0 support
+- **Field Types**: String, Integer, Decimal, Enum, Boolean, Arrays
+- **Multi-value Fields**: Both string and array access methods
+- **Issue &Page Support**: Complete Issue and nested Page objects
+- **Error Handling**: Custom exceptions with detailed messages
+- **Data Export**: JSON and YAML serialization
+- **Validation**: Enum values, ranges, type coercion
+- **Unicode Support**: International characters and special symbols
+- **Test Coverage**: 156 comprehensive test cases
+
+### Planned Features 🚧
+- **XML Generation**: Writing ComicInfo.xml files
+- **CLI Tool**: Command-line interface for file manipulation
+- **Schema Migration**: Support for multiple ComicInfo versions
+
+### Schema Versions
+- ✅ **ComicInfo v2.0**: Full support (current)
+- 🚧 **ComicInfo v2.1**: Planned
+- 🚧 **ComicInfo v1.0**: Planned
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/veganstraightedge/comicinfo.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[code of conduct](https://github.com/veganstraightedge/comicinfo/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ComicInfo project's codebases,
+issue trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/veganstraightedge/comicinfo/blob/main/CODE_OF_CONDUCT.md).
+
+## Acknowledgments
+
+- [Anansi Project](https://github.com/anansi-project/comicinfo) for the ComicInfo schema specification
+- [Nokogiri](https://nokogiri.org/) for XML parsing capabilities

data/Rakefile

@@ -0,0 +1,10 @@
+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]