eunomia_gen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53072ce6f110e4e2c4750839e4cd632831b102a4b1d22cc407cbb681be6a1c28
+  data.tar.gz: b9cf7bcb05f3c5fb4b8db1bebc8f04d6a35b52bfb5520d3ef87b7756812b8675
+SHA512:
+  metadata.gz: e3ef8833a30649a1666f2328b131ebbf59e20137e1afed01d24ae2687b040aa26c706e3e97b0b522e77e997bf1a5eef5a56ccb6405fd4961474e644bb309e5dc
+  data.tar.gz: 161a8d306af2e98859663126a4e35889c417e80f66377329b2d3d30ef59f17033d9f031c7f5368b574dee7f3d21f0011252964f7b6540424ea434142aee160e6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.zed/settings.json

@@ -0,0 +1,11 @@
+// Folder-specific settings
+//
+// For a full list of overridable settings, and general information on folder-specific settings,
+// see the documentation: https://zed.dev/docs/configuring-zed#settings-files
+{
+  "languages": {
+    "Ruby": {
+      "language_servers": ["solargraph", "rubocop", "!ruby-lsp"]
+    }
+  }
+}

data/.zed/tasks.json

@@ -0,0 +1,43 @@
+// Static tasks configuration.
+//
+// Example:
+[
+  {
+    "label": "Example task",
+    "command": "for i in {1..5}; do echo \"Hello $i/5\"; sleep 1; done",
+    //"args": [],
+    // Env overrides for the command, will be appended to the terminal's environment from the settings.
+    "env": { "foo": "bar" },
+    // Current working directory to spawn the command into, defaults to current project root.
+    //"cwd": "/path/to/working/directory",
+    // Whether to use a new terminal tab or reuse the existing one to spawn the process, defaults to `false`.
+    "use_new_terminal": false,
+    // Whether to allow multiple instances of the same task to be run, or rather wait for the existing ones to finish, defaults to `false`.
+    "allow_concurrent_runs": false,
+    // What to do with the terminal pane and tab, after the command was started:
+    // * `always` — always show the terminal pane, add and focus the corresponding task's tab in it (default)
+    // * `never` — avoid changing current terminal pane focus, but still add/reuse the task's tab there
+    "reveal": "always",
+    // What to do with the terminal pane and tab, after the command had finished:
+    // * `never` — Do nothing when the command finishes (default)
+    // * `always` — always hide the terminal tab, hide the pane also if it was the last tab in it
+    // * `on_success` — hide the terminal tab on task success only, otherwise behaves similar to `always`
+    "hide": "never",
+    // Which shell to use when running a task inside the terminal.
+    // May take 3 values:
+    // 1. (default) Use the system's default terminal configuration in /etc/passwd
+    //      "shell": "system"
+    // 2. A program:
+    //      "shell": {
+    //        "program": "sh"
+    //      }
+    // 3. A program with arguments:
+    //     "shell": {
+    //         "with_arguments": {
+    //           "program": "/bin/bash",
+    //           "arguments": ["--login"]
+    //         }
+    //     }
+    "shell": "system"
+  }
+]

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-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) 2024 G Palmer
+
+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,157 @@
+# Eunomia
+
+This gem is a text generator; a cross between mad-libs and Faker. The focus is on
+generating text that is appropriate for games, stories, and other creative works.
+
+Why does this exist? In the age of generatve text using LLMs, there's probably not
+a good reason other than it's more understandable and possibly easier to fine tune.
+
+Why Eunomia? Eunomia is a minor Greek goddess of law and order and since the generator
+is set up using a series of rules, it seemed appropriate.
+
+## 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:
+
+    $ 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:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+The gem is used by loading JSON (or ruby hashes) into a store, building a request context,
+and then selecting a generator to use.
+
+There are three main concepts:
+* Segments are elements in a sequence that can be combined to form a string.
+Segments in square brackets have a special meaning. Dice notation (e.g. `[d4]`)
+generates a random number. A segment that is a key (e.g. `[thing]`) will be replaced
+with a value chosen by the generator.
+* Items are selected at random from the generator that they are nested in. Items
+can have metadata about the generated string such as value (an arbitrary integer),
+ruby hash, or a weight (the likihood of being selected)
+* Generators are the top level of the JSON. They contain a list of items that are
+selected at random.
+
+```ruby
+require 'eunomia_gen'
+
+data = [
+  {
+    key: "random-fruit",
+    items: [
+      functions: %w[pluralize capitalize],
+      segments: "[d4] [fruit]"
+    ]
+  },
+  {
+    key: "fruit",
+    items: %w[apple banana orange pear kiwi]
+  }
+]
+
+Eunomia.add(data)
+p Eunomia.generate("random-fruit").to_s # => "3 Bananas"
+```
+
+### Translations
+
+A request may have a key to translate a generated text into a different language.
+A translation hash may also be added to the request itself. If a translation is set
+on the item, then it needs a key to look up the translation. On the request any matching
+string is replaced with the value.
+
+```ruby
+require 'eunomia_gen'
+
+data = [
+  { key: "fruit", items: %w[apple banana orange pear kiwi], alts: { "apple" => { "es" => "manzana" } } }
+]
+
+Eunomia.add(data)
+request = Eunomia::Request.new("fruit", alt_key: "es", unique: true, alts: { "kiwi" => "a small flightless bird" })
+arr = []
+5.times { arr << request.generate.to_s }
+p arr.join(", ") # => "manzana, banana, orange, pear, a small flightless bird"
+```
+
+### Functions
+
+A function is a method that can be called on the generated segments in a sequence. There are few
+built-in functions, but it is possible to add custom functions by passing in a proc that
+takes an array of strings and returns an array of strings.
+
+Functions are called in the order that they are listed in the request. Functions defined on the
+request are applied to the final generated string. Functions defined on a generator or item
+are applied to the segments generated by that entity.
+
+```ruby
+require 'eunomia_gen'
+
+data = [
+  { key: "fruit", items: %w[apple banana orange pear kiwi] },
+  { key: "random-fruit", items: [{ segments: "[d4] [fruit]" }] }
+]
+
+Eunomia.add(data)
+Eunomia.add_function(:reverse, proc { |arr| arr.map(&:reverse) })
+request = Eunomia::Request.new("random-fruit", functions: %w[pluralize reverse])
+p request.generate.to_s # => "3 sananab"
+
+request = Eunomia::Request.new("random-fruit", functions: %w[reverse pluralize])
+p request.generate.to_s # => "3 ikiks"
+```
+
+### Weights
+
+Items can have a weight that determines the likelihood of being selected. The default weight is 1.
+
+### Unique
+
+A request has a unique flag, if set to true the request will add all generated strings to an internal
+set and will discard a string if it is already in the set. It will make up to 100 attempts to
+generate a unique string before raising an error.
+
+### Values
+
+Items can have a value that is an arbitrary integer. This is multiplied by the first segment in the
+generated string if it a number (e.g. a constant or randomly generated from a dice segment).
+If the first segment is not a number the multiplier defaults to 1.
+
+### Constants
+
+A constant hash can be added to the request. A string that matches the hash key will be replaced by the
+constant value.
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/palmergs/eunomia_gen.
+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]/eunomia_gen/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 EunomiaGen project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the
+[code of conduct](https://github.com/[USERNAME]/eunomia_gen/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("eunomia_gen.gemspec")
+
+RbSys::ExtensionTask.new("eunomia_gen", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/eunomia_gen"
+end
+
+task default: %i[compile spec rubocop]

data/exe/eunomia_gen

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "eunomia_gen"

data/lib/eunomia/element.rb

@@ -0,0 +1,30 @@
+module Eunomia
+  class Element
+    attr_reader :orig, :str, :value, :multiplier, :meta, :children
+
+    def initialize(str, value: 0, multiplier: 1, children: nil)
+      @orig = str
+      @str = str
+      @value = value
+      @multiplier = multiplier
+      @meta = {}
+      @children = children
+    end
+
+    def children?
+      !children.nil? && !children.empty?
+    end
+
+    def to_s
+      str
+    end
+
+    def to_h
+      if children?
+        { orig:, str:, value:, multiplier:, children: children.map(&:to_h) }
+      else
+        { orig:, str:, value:, multiplier: }
+      end
+    end
+  end
+end

data/lib/eunomia/function/capitalize.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Eunomia
+  module Function
+    # Capitalize each string in the array
+    class Capitalize
+      def apply(arr)
+        to_proc.call(arr)
+      end
+
+      def to_proc
+        proc do |arr|
+          arr.map(&:capitalize)
+        end
+      end
+    end
+  end
+end

data/lib/eunomia/function/downcase.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Eunomia
+  module Function
+    # Downcase each string in the array
+    class Downcase
+      def apply(arr)
+        to_proc.call(arr)
+      end
+
+      def to_proc
+        proc do |arr|
+          arr.map(&:downcase)
+        end
+      end
+    end
+  end
+end

data/lib/eunomia/function/pluralize.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Eunomia
+  module Function
+    # Pluralize attempts to pluralize the last word in the array
+    # if the first word is a number and not equal to 1. This is
+    # mostly useful for phrases in the form "number adjective? noun"
+    class Pluralize
+      EXCEPTIONS = {
+        "foot" => "feet",
+        "axis" => "axes",
+        "child" => "children",
+        "codex" => "codices",
+        "die" => "dice",
+        "dwarf" => "dwarves",
+        "goose" => "geese",
+        "elf" => "elves",
+        "man" => "men",
+        "ox" => "oxen",
+        "thief" => "thieves",
+        "tooth" => "teeth",
+        "wolf" => "wolves",
+        "woman" => "women"
+      }.freeze
+
+      SINGLE = Set.new(%w[a an the this that my your his her its our their])
+
+      def apply(arr)
+        to_proc.call(arr)
+      end
+
+      def to_proc
+        proc do |arr|
+          num = to_num(arr[0])
+          if num && num > 1
+            dc = arr[-1].downcase
+            arr[-1] = exceptions(dc) || others(dc) || ends_with_y(dc) || simple(dc)
+          end
+          arr
+        end
+      end
+
+      def to_num(str)
+        return 1 if SINGLE.include?(str.downcase)
+
+        str =~ /\d+/ ? str.to_i : nil
+      end
+
+      def exceptions(str)
+        EXCEPTIONS[str]
+      end
+
+      def others(str)
+        if str.end_with?("s") || str.end_with?("x") || str.end_with?("z") || str.end_with?("ch") || str.end_with?("sh")
+          "#{str}es"
+        end
+      end
+
+      def ends_with_y(str)
+        "#{str[0..-2]}ies" if str.end_with?("y")
+      end
+
+      def simple(str)
+        "#{str}s"
+      end
+    end
+  end
+end

data/lib/eunomia/function/quote.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Eunomia
+  module Function
+    # Quote add a quote to the beginning of the first string and the end of the last string
+    class Quote
+      def apply(arr)
+        to_proc.call(arr)
+      end
+
+      def to_proc
+        proc do |arr|
+          arr[0] = "\"#{arr[0]}"
+          arr[-1] = "#{arr[-1]}\""
+          arr
+        end
+      end
+    end
+  end
+end

data/lib/eunomia/function/titleize.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Eunomia
+  module Function
+    # Titleize capitalizes each string in the array unless it's a word that
+    # is not normally capitalized in a title.
+    class Titleize
+      SKIP_WORDS = Set.new(%w[a an and as at but by for if in of on or the to v via vs])
+
+      def apply(arr)
+        to_proc.call(arr)
+      end
+
+      def to_proc
+        proc do |arr|
+          idx = 0
+          len = arr.length
+          while idx < len
+            arr[idx] = arr[idx].capitalize if capitalize?(arr[idx], idx, len)
+            idx += 1
+          end
+          arr
+        end
+      end
+
+      def capitalize?(str, idx, len)
+        idx.zero? || idx == len - 1 || !SKIP_WORDS.include?(str.downcase)
+      end
+    end
+  end
+end

data/lib/eunomia/function/upcase.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Eunomia
+  module Function
+    # Upcase each string in the array
+    class Upcase
+      def apply(arr)
+        to_proc.call(arr)
+      end
+
+      def to_proc
+        proc do |arr|
+          arr.map(&:upcase)
+        end
+      end
+    end
+  end
+end

data/lib/eunomia/functions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "function/capitalize"
+require_relative "function/downcase"
+require_relative "function/pluralize"
+require_relative "function/quote"
+require_relative "function/titleize"
+require_relative "function/upcase"
+
+module Eunomia
+  # Function module contains functions that can be applied to an array of strings.
+  class Functions
+    def initialize
+      @functions = {
+        "capitalize" => Eunomia::Function::Capitalize.new.to_proc,
+        "downcase" => Eunomia::Function::Downcase.new.to_proc,
+        "pluralize" => Eunomia::Function::Pluralize.new.to_proc,
+        "quote" => Eunomia::Function::Quote.new.to_proc,
+        "titleize" => Eunomia::Function::Titleize.new.to_proc,
+        "upcase" => Eunomia::Function::Upcase.new.to_proc
+      }
+    end
+
+    def apply(arr, funcs)
+      funcs.each do |function|
+        arr = @functions[function].call(arr)
+      end
+      arr
+    end
+
+    def add(name, proc)
+      @functions[name.to_s] = proc
+    end
+  end
+end