chansu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f4ba8ed2317017e71a0eb192f19947a7792fcb6eb43eb12107a803d69d7a62b
+  data.tar.gz: 88b4ad19c077b7d43b3a87f72ab4ccc35fc566d02e14fd7f5eca26d28904d8b6
+SHA512:
+  metadata.gz: 67558f2e8bb41692107016f049488e0b4e417f2f84aac4fba67837f7165528b4711998f8a99a35319fea898f46799e7f12f876291f1a72e3792f8a01ce90698d
+  data.tar.gz: 491b9dd2d5ec2a1566febfc4a3a87a98f53d7bfd1f10c7c9fc267fd71e5901c64e44f3000646ee278e50ffb1cc8adf4b48f6f37c4e4f79ebbaa05cb1ab96c324

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-25
+
+- 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 Santiago Calderon
+
+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,43 @@
+# Chansu
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chansu`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/chansu. 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]/chansu/blob/master/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 Chansu project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chansu/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/chansu/dsl.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# DSL for the table of common probability words.
+# If you are cronically online you will get this
+module Chansu
+  def always
+    chance(1.0) { yield if block_given? }
+  end
+
+  def certainly
+    chance(0.9) { yield if block_given? }
+  end
+
+  def almost_always
+    chance(0.85) { yield if block_given? }
+  end
+
+  def usually
+    chance(0.8) { yield if block_given? }
+  end
+
+  def often
+    chance(0.75) { yield if block_given? }
+  end
+
+  def likely
+    chance(0.7) { yield if block_given? }
+  end
+
+  def frequently
+    chance(0.65) { yield if block_given? }
+  end
+
+  def probably
+    chance(0.6) { yield if block_given? }
+  end
+
+  def more_often_than_not
+    chance(0.6) { yield if block_given? }
+  end
+
+  def maybe
+    chance(0.5) { yield if block_given? }
+  end
+
+  def possibly
+    chance(0.4) { yield if block_given? }
+  end
+
+  def not_often
+    chance(0.35) { yield if block_given? }
+  end
+
+  def unlikely
+    chance(0.25) { yield if block_given? }
+  end
+
+  def with_low_probability
+    chance(0.15) { yield if block_given? }
+  end
+
+  def rarely
+    chance(0.1) { yield if block_given? }
+  end
+
+  def never
+    chance(0.00001) { yield if block_given? } # never say never
+  end
+end

data/lib/chansu/loops.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Block runner with probability stops
+module Chansu
+  def self.until_success(chance: 0.5, max_attempts: 10)
+    raise ArgumentError, 'max_attempts must be greater than 0' unless max_attempts.positive?
+    raise ArgumentError, 'chance must be between 0.0 and 1.0' unless chance.between?(0.0, 1.0)
+    raise ArgumentError, 'A block must be provided' unless block_given?
+
+    attempts = 0
+    until chance(chance)
+      attempts += 1
+      yield attempts
+      break if attempts >= max_attempts
+    end
+    attempts
+  end
+
+  def self.until_failure(chance: 0.5, max_attempts: 10)
+    raise ArgumentError, 'max_attempts must be greater than 0' unless max_attempts.positive?
+    raise ArgumentError, 'chance must be between 0.0 and 1.0' unless chance.between?(0.0, 1.0)
+    raise ArgumentError, 'A block must be provided' unless block_given?
+
+    attempts = 0
+    while chance(chance)
+      attempts += 1
+      yield attempts
+      break if attempts >= max_attempts
+    end
+    attempts
+  end
+end

data/lib/chansu/toss.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# For everything that is throwed in the air expecting a result
+module Chansu
+  def self.coin
+    chance(0.5) ? :heads : :tails
+  end
+
+  def self.dice(sides = 6, times = 1) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    case sides
+    when String
+      expr = sides
+      match = expr.match(/(\d+)d(\d+)([+-]\d+)?/)
+      raise ArgumentError, "Invalid dice expression: #{expr}" unless match
+
+      times, sides, modifier = match.captures
+      rolls = Array.new(times.to_i) { rand(1..sides.to_i) }
+      total = rolls.sum + (modifier ? modifier.to_i : 0)
+
+      { rolls: rolls, total: total }
+
+    when Integer
+      raise ArgumentError, 'Die must have at least 1 side' if sides < 1
+
+      if times == 1
+        rand(1..sides)
+      else
+        Array.new(times) { rand(1..sides) }
+      end
+
+    else
+      raise ArgumentError, "Unsupported dice argument: #{sides.inspect}"
+    end
+  end
+
+  class << self
+    alias roll dice
+  end
+end

data/lib/chansu/version.rb

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

data/lib/chansu.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative 'chansu/version'
+require_relative 'chansu/dsl'
+require_relative 'chansu/loops'
+require_relative 'chansu/toss'
+
+# DSL for chance, probability, randomness
+module Chansu
+  @globals_enabled = false
+
+  @dsl_methods = %i[chance
+                    always
+                    certainly
+                    almost_always
+                    usually
+                    often
+                    likely
+                    frequently
+                    probably
+                    more_often_than_not
+                    maybe
+                    possibly
+                    not_often
+                    unlikely
+                    with_low_probability
+                    rarely
+                    never
+                    until_success
+                    until_failure]
+
+  @dice_methods = %i[coin
+                     dice
+                     roll]
+
+  def self.enable_globals! # rubocop:disable Metrics/MethodLength
+    return if @globals_enabled
+
+    (@dsl_methods + @dice_methods).each do |method|
+      Kernel.define_method(method) do |*args, &block|
+        Chansu.send(method, *args, &block)
+      end
+    end
+
+    [4, 6, 8, 10, 12, 20, 100].each do |sides|
+      Kernel.define_method("d#{sides}") do |times = 1|
+        Chansu.dice(sides, times)
+      end
+    end
+
+    @globals_enabled = true
+  end
+
+  def self.disable_globals!
+    return unless @globals_enabled
+
+    (@dsl_methods + @dice_methods).each do |method|
+      Kernel.send(:remove_method, method) if Kernel.method_defined?(method)
+    end
+
+    [4, 6, 8, 10, 12, 20, 100].each do |sides|
+      Kernel.send(:remove_method, "d#{sides}".to_sym) if Kernel.method_defined?("d#{sides}".to_sym)
+    end
+
+    @globals_enabled = false
+  end
+
+  def self.chance(prob = 0.5) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    probability =
+      case prob
+      when String
+        raise ArgumentError, 'Invalid string format for probability' unless prob.end_with?('%')
+
+        prob.to_f / 100.0
+
+      when Integer
+        raise ArgumentError, 'Integer probability must be between 0 and 100' unless prob.between?(0, 100)
+
+        prob.to_f / 100.0
+
+      when Float
+        raise ArgumentError, 'Float probability must be between 0.0 and 1.0' unless prob.between?(0.0, 1.0)
+
+        prob
+
+      end
+
+    passed = rand < probability
+
+    yield if passed && block_given?
+
+    passed
+  end
+end
+
+Chansu.enable_globals!
+
+module Kernel
+  include Chansu
+end

data/sig/chansu.rbs

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

data/spec/chansu_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# spec/chansu_spec.rb
+require 'chansu'
+
+RSpec.describe Chansu do # rubocop:disable Metrics/BlockLength
+  describe '.chance' do
+    it 'accepts percentage strings' do
+      100.times do
+        expect([true, false]).to include(Chansu.chance('50%'))
+      end
+    end
+
+    it 'accepts decimal floats' do
+      100.times do
+        expect([true, false]).to include(Chansu.chance(0.5))
+      end
+    end
+
+    it 'accepts integers as percents' do
+      100.times do
+        expect([true, false]).to include(Chansu.chance(25))
+      end
+    end
+  end
+
+  describe '.dice' do
+    it 'rolls a single die' do
+      50.times do
+        expect(Chansu.dice(6)).to be_between(1, 6)
+      end
+    end
+
+    it 'rolls multiple dice' do
+      rolls = Chansu.dice(6, 3)
+      expect(rolls.size).to eq(3)
+      expect(rolls).to all(be_between(1, 6))
+    end
+  end
+
+  describe '.roll (alias of .dice)' do
+    it 'parses dice expressions' do
+      result = Chansu.roll('2d6+3')
+      expect(result[:rolls].size).to eq(2)
+      expect(result[:total]).to be >= 5
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: chansu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santiago Calderon
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  \
+      Chansu is a Ruby DSL for working with randomness and probability.
+      It provides helpers like `chance("35%")`, `dice(6, 3)`, and RPG-style
+      aliases such as `d20` and `d100`. It also includes higher-level
+      constructs like `often { ... }`, `rarely { ... }`, and `until_success`
+      for expressive probabilistic logic. Useful for games, simulations,
+      and playful Ruby experiments.
+email:
+- escalderongv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chansu.rb
+- lib/chansu/dsl.rb
+- lib/chansu/loops.rb
+- lib/chansu/toss.rb
+- lib/chansu/version.rb
+- sig/chansu.rbs
+- spec/chansu_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/escalderong/chansu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/escalderong/chansu
+  source_code_uri: https://github.com/escalderong/chansu
+  changelog_uri: https://github.com/escalderong/chansu/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: A Ruby DSL for probabilities, randomness, and dice.
+test_files: []