codexparser 0.3.1 → 0.4.0

package/REFACTORING.md

@@ -1,214 +0,0 @@
-# CodexParser Refactoring Summary
-
-## Overview
-
-The CodexParser codebase has been modernized and refactored to follow current JavaScript best practices and improve code maintainability through separation of concerns.
-
-## Key Improvements
-
-### 1. **Modern ES6+ Features**
-- **Private fields** using `#` syntax for true encapsulation
-- **Class-based architecture** with clear separation of responsibilities
-- **Getter/setter** accessors for backward compatibility
-- **Arrow functions** where appropriate
-- **Const/let** instead of var
-- **Template literals** for string formatting
-- **Destructuring** for cleaner code
-- **Static methods** for utility functions
-
-### 2. **Separation of Concerns**
-
-The monolithic 1,658-line `CodexParser.js` file has been split into focused, single-responsibility modules:
-
-#### **ScriptureScanner.js** (~230 lines)
-- Handles text scanning for scripture references
-- Private methods for validation and detection
-- Uses ES6+ private fields (`#`)
-- Focused solely on finding references in text
-
-#### **ReferenceParser.js** (~450 lines)
-- Parses found references into structured objects
-- Handles all reference types (single verse, ranges, multi-chapter, etc.)
-- Private helper methods for each parsing scenario
-- Clean API for passage population
-
-#### **PassageUtils.js** (~120 lines)
-- Static utility class for passage manipulation
-- Handles verse expansion, range merging
-- Chapter/verse formatting
-- Reusable across the codebase
-
-#### **PassageValidator.js** (~100 lines)
-- Validates scripture passages
-- Error code constants
-- Clear validation logic
-- Separate from parsing concerns
-
-#### **VersionHandler.js** (~75 lines)
-- Manages Bible version logic
-- Version normalization
-- Version object creation
-- Clean version constants
-
-#### **VersificationHandler.js** (~140 lines)
-- Handles versification differences between versions
-- LXX/MT/English version mapping
-- Separate from core parsing logic
-
-#### **PassageCollection.js** (~300 lines)
-- Extends Array with scripture-specific methods
-- Chainable utility methods (`first()`, `oldTestament()`, `newTestament()`)
-- Version conversion (`getVersion()`)
-- Passage combination logic
-- Immutable operations
-
-#### **CodexParser.js** (Now ~340 lines, down from 1,658!)
-- Orchestrates all the components
-- Clean, focused public API
-- Private fields for internal state
-- Legacy compatibility maintained
-
-## Architecture Benefits
-
-### Before
-```
-CodexParser.js (1,658 lines)
-├── Scanning logic
-├── Parsing logic
-├── Validation logic
-├── Versification logic
-├── Utility methods
-├── Version handling
-└── Collection methods
-```
-
-### After
-```
-CodexParser.js (340 lines) - Orchestrator
-├── ScriptureScanner.js - Text scanning
-├── ReferenceParser.js - Reference parsing
-├── PassageValidator.js - Validation
-├── VersificationHandler.js - Version differences
-├── VersionHandler.js - Version management
-├── PassageUtils.js - Utility functions
-└── PassageCollection.js - Collection operations
-```
-
-## Backward Compatibility
-
-All existing public APIs have been preserved:
-- ✅ `scan(text)` - Still works
-- ✅ `parse(reference)` - Still works
-- ✅ `getPassages()` - Still works
-- ✅ `combine()` - Still works
-- ✅ `first()` - Still works
-- ✅ `bookify()` - Still works
-- ✅ Legacy getters/setters maintained
-- ✅ Public properties maintained for compatibility
-
-## Code Quality Improvements
-
-### Encapsulation
-- Private fields (`#scanner`, `#parser`, etc.) prevent external modification
-- Internal state is properly hidden
-- Clear public vs private API distinction
-
-### Single Responsibility
-- Each class has one clear purpose
-- Easier to test individual components
-- Easier to maintain and update
-
-### Reusability
-- Utility classes can be used independently
-- Static methods for common operations
-- Modular design allows component reuse
-
-### Testability
-- Each module can be tested in isolation
-- Smaller, focused units are easier to test
-- Clear dependencies make mocking easier
-
-### Maintainability
-- Smaller files are easier to navigate
-- Clear file organization
-- Better code discoverability
-- Easier onboarding for new developers
-
-## File Structure
-
-```
-src/
-├── CodexParser.js           # Main orchestrator class (340 lines)
-├── ScriptureScanner.js      # Text scanning (230 lines)
-├── ReferenceParser.js       # Reference parsing (450 lines)
-├── PassageValidator.js      # Validation logic (100 lines)
-├── VersificationHandler.js  # Versification handling (140 lines)
-├── VersionHandler.js        # Version management (75 lines)
-├── PassageUtils.js          # Utility functions (120 lines)
-├── PassageCollection.js     # Collection class (300 lines)
-├── abbr.js                  # Abbreviations data
-├── bible.js                 # Bible book data
-├── functions.js             # Legacy functions
-├── regex.js                 # Regex patterns
-├── toc.js                   # Table of contents
-└── versified.js             # Versification data
-```
-
-## Performance Considerations
-
-- No performance degradation from refactoring
-- Same algorithms, better organized
-- Lazy initialization where appropriate
-- Efficient use of private fields
-
-## Migration Guide
-
-### For Developers Using CodexParser
-
-**No changes needed!** The refactoring maintains 100% backward compatibility.
-
-```javascript
-// All existing code continues to work
-const CodexParser = require('./src/core/CodexParser');
-const parser = new CodexParser();
-parser.parse('John 3:16').getPassages();
-```
-
-### For Developers Extending CodexParser
-
-New modular structure makes it easier to:
-- Add new reference types (extend ReferenceParser)
-- Add new validation rules (extend PassageValidator)
-- Add new utility methods (add to PassageUtils)
-- Support new versions (extend VersionHandler)
-
-## Testing
-
-All existing tests pass without modification:
-- ✅ quicktest.js
-- ✅ single.js
-- ✅ combine.js
-- ✅ All other existing tests
-
-## Future Enhancements Made Easier
-
-The new structure makes these enhancements straightforward:
-
-1. **Add TypeScript support** - Clear interfaces from class structure
-2. **Add more Bible versions** - Isolated in VersionHandler
-3. **Improve validation** - Isolated in PassageValidator
-4. **Add new reference formats** - Extend ReferenceParser
-5. **Performance optimization** - Target specific modules
-6. **Add caching** - Can be added to specific components
-
-## Summary
-
-This refactoring transforms a large, monolithic class into a well-organized, modern JavaScript codebase that:
-- ✅ Follows SOLID principles
-- ✅ Uses modern ES6+ features
-- ✅ Maintains complete backward compatibility
-- ✅ Improves code organization and maintainability
-- ✅ Makes future enhancements easier
-- ✅ Provides better developer experience
-
-The codebase is now easier to understand, test, maintain, and extend while preserving all existing functionality.

package/RELEASE_NOTES_v0.2.0.md

@@ -1,5 +0,0 @@
-# CodexParser 0.2.0
-
-Refactor into core/utils/format/data; OSIS textual hashes (e.g., John.3.16); pythonbible-style integer verse IDs for `osisNumeric`; per-passage version helpers (`getVersion/getLXX/getMT/getBHS/getEnglish`); dependency cleanup and audit fix; published to npm as `codexparser@0.2.0`.
-
-See detailed notes in README under "Release Notes" → 0.2.0.

package/RELEASE_NOTES_v0.3.0.md

@@ -1,32 +0,0 @@
-# CodexParser 0.3.0
-
-Added `convertVersion(targetVersion)` method on passage objects for versification conversion.
-
-## Features
-
-- **New Method**: `passage.convertVersion(targetVersion)` accepts version string (`"eng"`, `"lxx"`, `"mt"`, or `"bhs"`).
-- **Smart Conversion**: Automatically converts chapter/verse references between versifications when versification data exists (e.g., Psalms, Zechariah).
-- **Fallback Behavior**: Returns same reference with updated version metadata if no versification exists (e.g., NT passages).
-- **Tested**: Verified with Psalms, Zechariah, and NT passages.
-
-## Usage Example
-
-```javascript
-const CodexParser = require("codexparser")
-const parser = new CodexParser()
-
-// Convert English reference to LXX
-const [p] = parser.parse("Psalm 4:5").getPassages()
-console.log(p.scripture.hash) // "Ps.4.5"
-
-const lxx = p.convertVersion("lxx")
-console.log(lxx.scripture.hash) // "Ps.4.6"
-
-// No versification (NT) - returns same reference
-const [j] = parser.parse("John 3:16").getPassages()
-const jLxx = j.convertVersion("lxx")
-console.log(jLxx.scripture.hash) // "John.3.16" (same)
-console.log(jLxx.version.abbreviation) // "lxx" (version updated)
-```
-
-See full CHANGELOG: https://github.com/jeremyam/CodexParser/blob/main/CHANGELOG.md