zaxcel 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5af2f7d221d3fb5e8955cd42f4d1e8e33d337786a832965ba35daf37fb7fdcce
+  data.tar.gz: 403fde35db97b0dbb5ee1c333ef9f517e3bc159324c6aba79a9bb1ffa0c77f62
+SHA512:
+  metadata.gz: 214988bd63bf56d06901b168413023fccfce1c0b6230f75b1085035bf57458b8808fc33404ccfdb33b9effb4cabef7f124aa985e1450bc7dcc046009e2baf8e8
+  data.tar.gz: c02164fbca4b8bc3c91036744ba69ea40dc7e527f32d4e3c527d68fe1437f33ec9741005191a4402a488e3e37bf5b2ae685fef8d40cd90003aaeb4725eca9510

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_gem:
+  rubocop-angellist: rubocop.yml
+
+# Local project tweaks can go below. Keep minimal; rely on shared config.
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "sorbet/**/*"
+    - "tmp/**/*"

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# 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).
+
+## [0.1.1] - 2025-10-29
+
+### Changed
+
+- Updated specs
+
+## [0.1.0] - 2025-10-29
+
+### Added
+
+- Initial public release
+- Core DSL for building Excel documents
+- Support for cross-sheet references
+- Formula building with Ruby operators
+- Comprehensive Excel function library (SUM, SUMIF, SUMIFS, XLOOKUP, etc.)
+- Cell styling and formatting
+- Sheet visibility controls
+- Column width configuration
+- Type safety with Sorbet
+
+[0.1.0]: https://github.com/angellist/zaxcel/releases/tag/v0.1.0
+[0.1.1]: https://github.com/angellist/zaxcel/releases/tag/v0.1.1

data/CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing to Zaxcel
+
+Thank you for considering contributing to Zaxcel! This document outlines the process for contributing to this project.
+
+## Code of Conduct
+
+This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to engineering@angellist.com.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check the existing issues to avoid duplicates. When creating a bug report, include:
+
+* A clear and descriptive title
+* Detailed steps to reproduce the problem
+* Expected behavior
+* Actual behavior
+* Ruby version and gem version
+* Any relevant code samples or test cases
+
+### Suggesting Enhancements
+
+Enhancement suggestions are welcome! Please include:
+
+* A clear and descriptive title
+* A detailed description of the proposed functionality
+* Examples of how the feature would be used
+* Any relevant implementation details
+
+### Pull Requests
+
+1. Fork the repo and create your branch from `main`
+2. If you've added code, add tests
+3. If you've changed APIs, update the documentation
+4. Ensure the test suite passes (`bundle exec rspec`)
+5. Ensure type checking passes (`bundle exec srb tc`)
+6. Make sure your code follows the existing style (run `bundle exec rubocop`)
+7. Write a clear commit message
+
+## Development Setup
+
+```bash
+git clone https://github.com/angellist/zaxcel.git
+cd zaxcel
+bundle install
+bundle exec rspec
+```
+
+## Type Checking with Sorbet
+
+This project uses Sorbet for type safety. Please ensure all new code includes type signatures:
+
+```ruby
+extend T::Sig
+
+sig { params(name: String).returns(Integer) }
+def my_method(name)
+  # implementation
+end
+```
+
+Run type checking with:
+
+```bash
+bundle exec srb tc
+```
+
+## Testing Guidelines
+
+* Write RSpec tests for all new functionality
+* Aim for high test coverage
+* Test both success and error cases
+* Include integration tests for complex features
+
+## Style Guide
+
+This project follows standard Ruby style guidelines enforced by RuboCop. Run:
+
+```bash
+bundle exec rubocop
+```
+
+To auto-correct issues:
+
+```bash
+bundle exec rubocop -a
+```
+
+## Documentation
+
+* Update README.md for user-facing changes
+* Add YARD comments for new public methods
+* Update CHANGELOG.md following Keep a Changelog format
+
+## Release Process
+
+(For maintainers)
+
+1. Update version in `lib/zaxcel.rb`
+2. Update CHANGELOG.md with release date
+3. Create a git tag: `git tag -a v1.0.0 -m "Release 1.0.0"`
+4. Push tag: `git push origin v1.0.0`
+5. Build gem: `gem build zaxcel.gemspec`
+6. Push to RubyGems: `gem push zaxcel-1.0.0.gem`
+
+## Questions?
+
+Feel free to open an issue for questions or discussion!
+

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 AngelList
+
+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/QUICK_START.md

@@ -0,0 +1,187 @@
+# Zaxcel Quick Start Guide
+
+Get started with Zaxcel in 5 minutes!
+
+## Installation
+
+```bash
+cd zaxcel_gem
+bundle install
+```
+
+## Your First Spreadsheet
+
+Create a file called `my_first_sheet.rb`:
+
+```ruby
+require 'bundler/setup'
+require 'zaxcel'
+
+# Create a document
+document = Zaxcel::Document.new
+sheet = document.add_sheet!('My Sheet')
+
+# Add columns
+sheet.add_column!(:name)
+sheet.add_column!(:age)
+
+# Add rows
+sheet.add_row!(:person1)
+  .add!(:name, value: 'Alice')
+  .add!(:age, value: 30)
+
+sheet.add_row!(:person2)
+  .add!(:name, value: 'Bob')
+  .add!(:age, value: 25)
+
+# Position and generate sheet (after all content is added)
+sheet.position_rows!
+sheet.generate_sheet!
+File.write('people.xlsx', document.file_contents)
+
+puts "Created people.xlsx!"
+```
+
+Run it:
+
+```bash
+ruby my_first_sheet.rb
+```
+
+Open `people.xlsx` in Excel or LibreOffice!
+
+## Adding Formulas
+
+Let's add some calculations:
+
+```ruby
+require 'bundler/setup'
+require 'zaxcel'
+
+document = Zaxcel::Document.new
+sheet = document.add_sheet!('Math')
+
+sheet.add_column!(:label)
+sheet.add_column!(:value)
+
+# Add some numbers
+row1 = sheet.add_row!(:num1).add!(:label, value: 'First').add!(:value, value: 10)
+row2 = sheet.add_row!(:num2).add!(:label, value: 'Second').add!(:value, value: 20)
+
+# Add a sum formula
+sheet.add_row!(:total)
+  .add!(:label, value: 'Total')
+  .add!(:value, row1.ref(:value) + row2.ref(:value))
+
+# Position and generate sheet (after all content is added)
+sheet.position_rows!
+sheet.generate_sheet!
+File.write('math.xlsx', document.file_contents)
+```
+
+## Styling Cells
+
+Add some color:
+
+```ruby
+require 'bundler/setup'
+require 'zaxcel'
+
+document = Zaxcel::Document.new
+
+# Define a style
+document.add_style!(:header, {
+  bg_color: '0066CC',
+  fg_color: 'FFFFFF',
+  b: true
+})
+
+sheet = document.add_sheet!('Styled')
+sheet.add_column!(:category)
+
+# Use the style
+sheet.add_row!(:header)
+  .add!(:category, value: 'Category', style: :header)
+
+sheet.add_row!(:data)
+  .add!(:category, value: 'Data')
+
+# Position and generate sheet (after all content is added)
+sheet.position_rows!
+sheet.generate_sheet!
+File.write('styled.xlsx', document.file_contents)
+```
+
+## Try the Examples
+
+Check out the `examples/` directory for more:
+
+```bash
+ruby examples/basic_spreadsheet.rb
+ruby examples/cross_sheet_references.rb
+```
+
+## Next Steps
+
+- Read the full [README.md](README.md) for comprehensive documentation
+- Browse example code in `examples/`
+- Check out the test suite in `spec/` for more usage patterns
+- Try building your own spreadsheets!
+
+## Common Patterns
+
+### Building a Report
+
+```ruby
+# Create document
+document = Zaxcel::Document.new
+sheet = document.add_sheet!('Report')
+
+# Set up columns
+[:date, :description, :amount].each { |col| sheet.add_column!(col) }
+
+# Add data
+data = [
+  { date: '2025-01-01', description: 'Sale', amount: 100 },
+  { date: '2025-01-02', description: 'Purchase', amount: -50 }
+]
+
+data.each_with_index do |item, i|
+  sheet.add_row!(:"row_#{i}")
+    .add!(:date, value: item[:date])
+    .add!(:description, value: item[:description])
+    .add!(:amount, value: item[:amount])
+end
+
+# Position and generate sheet (after all content is added)
+sheet.position_rows!
+sheet.generate_sheet!
+```
+
+### Using Functions
+
+```ruby
+# Sum a range
+sum = Zaxcel::Functions.sum_range([first_row.ref(:amount), last_row.ref(:amount)])
+
+# Average
+avg = Zaxcel::Functions::Average.new(values)
+
+# Conditional
+status = Zaxcel::Functions::If.new(
+  condition: row.ref(:amount) > 100,
+  true_value: 'High',
+  false_value: 'Low'
+)
+
+# Round
+rounded = Zaxcel::Functions.round(value, precision: 2)
+```
+
+## Need Help?
+
+- Check [README.md](README.md) for full documentation
+- Look at [examples/](examples/) for working code
+- Open an issue on GitHub
+
+Happy spreadsheet building! 📊