mayan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4dde3f1ffb9448770ca414cc9d9d5af94c845c8f7ad990cead3890a6689041d9
+  data.tar.gz: 6015d4aa0dc3bfff6e85aa5b2a4f74599cd91612e9a96ee83a053a0540aeae5b
+SHA512:
+  metadata.gz: 58cd36d2e619b07537daf25650d8c0ea9eea0937a76d00a2e5878fd1ebcd5fc81e0586e69626f9a0c6bd953ed1059c0ae97196aa6b06f55ba4539913ee2a9f1b
+  data.tar.gz: 70cd213e6e06c38aa720e828359d3f5d66c967b7fb2b41659a94a54129ba493a2e2e13ac38a4c348945e5f178daa20dc773edad8af2c8eed5d4bd450fe0e4b1b

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-12
+
+- Initial release

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 nazamoresco
+
+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,130 @@
+# Mayan
+
+A Ruby gem for performing calculations and conversions with the ancient Mayan calendar system. This gem supports the three main components of the Mayan calendar: the Long Count, Tzolkin (sacred calendar), and Haab (solar calendar).
+
+## Features
+
+- Convert between Gregorian dates and Mayan Long Count dates
+- Calculate Tzolkin dates (260-day sacred calendar)
+- Calculate Haab dates (365-day solar calendar)
+- Full support for Mayan calendar glyphs and day names
+- Accurate conversions using the GMT correlation constant
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add mayan
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install mayan
+```
+
+## Usage
+
+### Long Count Calendar
+
+The Long Count is the Mayan method of tracking long periods of time, represented as five numbers (baktun.katun.tun.winal.kin).
+
+```ruby
+require 'mayan'
+
+# Convert a Gregorian date to Long Count
+gregorian_date = Date.new(2012, 12, 21)
+long_count = Mayan::LongCount::Date.from_gregorian(gregorian_date)
+puts long_count.to_s  # => "13.0.0.0.0"
+
+# Create a Long Count date directly
+long_count = Mayan::LongCount::Date.new(13, 0, 0, 0, 0)
+
+# Convert Long Count back to Gregorian
+gregorian = long_count.to_gregorian
+puts gregorian  # => #<Date: 2012-12-21>
+
+# Get total days since Mayan epoch
+puts long_count.days  # => 1872000
+```
+
+### Tzolkin Calendar
+
+The Tzolkin is a 260-day sacred calendar combining 13 numbers with 20 day names.
+
+```ruby
+# Convert Long Count to Tzolkin
+long_count = Mayan::LongCount::Date.from_gregorian(Date.new(2012, 12, 21))
+tzolkin = long_count.to_tzolkin
+puts tzolkin.to_s  # => "4 Ajaw"
+
+# Access Tzolkin components
+puts tzolkin.number  # => 4
+puts tzolkin.glyph.name  # => "Ajaw"
+
+# Create a Tzolkin date directly
+glyph = Mayan::Tzolkin::Glyph.new("Imix'")
+tzolkin = Mayan::Tzolkin::Date.new(1, glyph)
+puts tzolkin.to_s  # => "1 Imix'"
+```
+
+Available Tzolkin day names: Imix', Ik', Ak'bal, K'an, Chikchan, Kimi, Manik', Lamat, Muluk, Ok, Chuwen, Eb, Ben, Hix, Men, K'ib', Kaban, Etz'nab', Kawak, Ajaw
+
+### Haab Calendar
+
+The Haab is a 365-day solar calendar with 18 months of 20 days plus a 5-day month called Wayeb'.
+
+```ruby
+# Convert Long Count to Haab
+long_count = Mayan::LongCount::Date.from_gregorian(Date.new(2012, 12, 21))
+haab = long_count.to_haab
+puts haab.to_s  # => "3 K'ank'in"
+
+# Access Haab components
+puts haab.number  # => 3
+puts haab.glyph.name  # => "K'ank'in"
+
+# Create a Haab date directly
+glyph = Mayan::Haab::Glyph.new("Pop")
+haab = Mayan::Haab::Date.new(0, glyph)
+puts haab.to_s  # => "0 Pop"
+```
+
+Available Haab month names: Pop, Wo', Sip, Sotz', Sek, Xul, Yaxk'in', Mol, Ch'en, Yax, Sak', Keh, Mak, K'ank'in, Muwan', Pax, K'ayab', Kumk'u, Wayeb'
+
+### Complete Example
+
+```ruby
+require 'mayan'
+require 'date'
+
+# Convert today's date to all three Mayan calendar formats
+gregorian = Date.today
+long_count = Mayan::LongCount::Date.from_gregorian(gregorian)
+tzolkin = long_count.to_tzolkin
+haab = long_count.to_haab
+
+puts "Gregorian: #{gregorian}"
+puts "Long Count: #{long_count}"
+puts "Tzolkin: #{tzolkin}"
+puts "Haab: #{haab}"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mayan_calendar. 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/[USERNAME]/mayan_calendar/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 MayanCalendar project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mayan_calendar/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]
+
+task :console do
+  require "irb"
+  require "mayan"
+  ARGV.clear
+  IRB.start
+end

data/lib/mayan/haab/date.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Mayan
+  class Haab
+    class Date
+      attr_reader :number, :glyph
+
+      def initialize(number, glyph)
+        raise ArgumentError, "glyph must be a Haab::Glyph" unless glyph.is_a?(Glyph)
+
+        max_day = glyph.name == "Wayeb'" ? 4 : 19
+
+        unless number.between?(0, max_day)
+          raise ArgumentError, "number must be between 0 and #{max_day} for #{glyph.name}"
+        end
+
+        @number = number
+        @glyph = glyph
+      end
+
+      def to_s
+        "#{@number} #{@glyph.name}"
+      end
+    end
+  end
+end

data/lib/mayan/haab/glyph.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mayan
+  class Haab
+    class Glyph
+      attr_reader :name
+
+      def initialize(name)
+        unless GLYPHS.include?(name)
+          raise ArgumentError, "name must be one of the 19 Haab month names"
+        end
+
+        @name = name
+      end
+    end
+  end
+end

data/lib/mayan/haab.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mayan
+  class Haab
+    GLYPHS = [
+      "Pop",
+      "Wo'",
+      "Sip",
+      "Sotz'",
+      "Sek",
+      "Xul",
+      "Yaxk'in'",
+      "Mol",
+      "Ch'en",
+      "Yax",
+      "Sak'",
+      "Keh",
+      "Mak",
+      "K'ank'in",
+      "Muwan'",
+      "Pax",
+      "K'ayab'",
+      "Kumk'u",
+      "Wayeb'"
+    ].freeze
+  end
+end
+
+require_relative "haab/glyph"
+require_relative "haab/date"

data/lib/mayan/long_count.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Mayan
+  class LongCount
+    class Date
+      attr_reader :baktun, :katun, :tun, :winal, :kin
+
+      def self.from_gregorian(gregorian_date)
+        # Convert Gregorian date to Julian Day Number
+        jdn = gregorian_date.jd
+
+        # GMT correlation constant: 0.0.0.0.0 = JDN 584283
+        days_since_epoch = jdn - 584_283
+
+        # Convert days to Long Count components
+        baktun = days_since_epoch / 144_000
+        remaining = days_since_epoch % 144_000
+
+        katun = remaining / 7_200
+        remaining = remaining % 7_200
+
+        tun = remaining / 360
+        remaining = remaining % 360
+
+        winal = remaining / 20
+        kin = remaining % 20
+
+        new(baktun, katun, tun, winal, kin)
+      end
+
+      def initialize(baktun, katun, tun, winal, kin)
+        raise ArgumentError, "kin must be between 0 and 19" unless kin.between?(0, 19)
+        raise ArgumentError, "winal must be between 0 and 17" unless winal.between?(0, 17)
+        raise ArgumentError, "tun must be between 0 and 19" unless tun.between?(0, 19)
+        raise ArgumentError, "katun must be between 0 and 19" unless katun.between?(0, 19)
+
+        @baktun = baktun
+        @katun = katun
+        @tun = tun
+        @winal = winal
+        @kin = kin
+      end
+
+      def days
+        (@baktun * 144_000) + (@katun * 7_200) + (@tun * 360) + (@winal * 20) + @kin
+      end
+
+      def to_gregorian
+        # GMT correlation constant: 0.0.0.0.0 = JDN 584283 (September 6, 3114 BCE)
+        julian_day_number = 584_283 + days
+        ::Date.jd(julian_day_number)
+      end
+
+      def to_tzolkin
+        # 0.0.0.0.0 = 4 Ajaw in the Tzolkin calendar
+        # Day number cycles 1-13, starting at 4 for day 0
+        # Glyph cycles through 20 glyphs, starting at Ajaw (index 19) for day 0
+        day_count = days
+
+        tzolkin_number = ((3 + day_count) % 13) + 1
+        glyph_index = (19 + day_count) % 20
+
+        glyph = Tzolkin::Glyph.new(Tzolkin::GLYPHS[glyph_index])
+        Tzolkin::Date.new(tzolkin_number, glyph)
+      end
+
+      def to_haab
+        # 0.0.0.0.0 = 8 Kumk'u in the Haab calendar
+        # Kumk'u is the 18th month (index 17)
+        # 8 Kumk'u is 348 days into the Haab year (17 * 20 + 8)
+        day_count = days
+
+        haab_day_in_cycle = (day_count + 348) % 365
+
+        # Convert day position to month and day
+        month_index = haab_day_in_cycle / 20
+        day_of_month = haab_day_in_cycle % 20
+
+        glyph = Haab::Glyph.new(Haab::GLYPHS[month_index])
+        Haab::Date.new(day_of_month, glyph)
+      end
+
+      def to_s
+        "#{@baktun}.#{@katun}.#{@tun}.#{@winal}.#{@kin}"
+      end
+    end
+  end
+end

data/lib/mayan/tzolkin/date.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mayan
+  class Tzolkin
+    class Date
+      attr_reader :number, :glyph
+
+      def initialize(number, glyph)
+        raise ArgumentError, "number must be between 1 and 13" unless number.between?(1, 13)
+        raise ArgumentError, "glyph must be a Tzolkin::Glyph" unless glyph.is_a?(Glyph)
+
+        @number = number
+        @glyph = glyph
+      end
+
+      def to_s
+        "#{@number} #{@glyph.name}"
+      end
+    end
+  end
+end

data/lib/mayan/tzolkin/glyph.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mayan
+  class Tzolkin
+    class Glyph
+      attr_reader :name
+
+      def initialize(name)
+        unless GLYPHS.include?(name)
+          raise ArgumentError, "name must be one of the 20 Tzolkin day names"
+        end
+
+        @name = name
+      end
+    end
+  end
+end

data/lib/mayan/tzolkin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mayan
+  class Tzolkin
+    GLYPHS = [
+      "Imix'",
+      "Ik'",
+      "Ak'bal",
+      "K'an",
+      "Chikchan",
+      "Kimi",
+      "Manik'",
+      "Lamat",
+      "Muluk",
+      "Ok",
+      "Chuwen",
+      "Eb",
+      "Ben",
+      "Hix",
+      "Men",
+      "K'ib'",
+      "Kaban",
+      "Etz'nab'",
+      "Kawak",
+      "Ajaw"
+    ].freeze
+  end
+end
+
+require_relative "tzolkin/glyph"
+require_relative "tzolkin/date"

data/lib/mayan/version.rb

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

data/lib/mayan.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "mayan/version"
+require_relative "mayan/long_count"
+require_relative "mayan/tzolkin"
+require_relative "mayan/haab"
+
+module Mayan
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/mayan_calendar.rbs

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mayan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nazamoresco
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-15 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem to perform calculations and conversions related to the Mayan
+  calendar.
+email:
+- nazamoresco99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mayan.rb
+- lib/mayan/haab.rb
+- lib/mayan/haab/date.rb
+- lib/mayan/haab/glyph.rb
+- lib/mayan/long_count.rb
+- lib/mayan/tzolkin.rb
+- lib/mayan/tzolkin/date.rb
+- lib/mayan/tzolkin/glyph.rb
+- lib/mayan/version.rb
+- sig/mayan_calendar.rbs
+homepage: https://github.com/nazamoresco/mayan
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nazamoresco/mayan
+  source_code_uri: https://github.com/nazamoresco/mayan
+  changelog_uri: https://github.com/nazamoresco/mayan/blob/main/CHANGELOG.md
+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.2.3
+signing_key:
+specification_version: 4
+summary: A gem for Mayan calendar calculations.
+test_files: []