wordmonger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67912799c0fb8adb04ca9a91d049c600adcc1918062b27305add71923f3acac9
+  data.tar.gz: 47bda97e3bf2261726c0400f4c171140936ec3275244aee47fbd1cb1914761f6
+SHA512:
+  metadata.gz: 571b6ae975eedc08f8f9e6374810d5f9b20b94ae7f06570b16d590e9f1eb6d19358a0562de958627294a7d60a0edc4f61eb45702d616ac1a8401be6958c41e3f
+  data.tar.gz: c480c4c7f0c45be27a1c2f69f87aa30596e81e4a64de800b5412005f8352c273e6f6d6304e79dd1d5ceaa38e3e6edc1299f02adfb710094990579559707665c9

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/1

@@ -0,0 +1,2 @@
+direnv: unloading
+direnv: unloading

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at richard.leber@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2020 Richard LeBer
+
+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,69 @@
+# wordmonger
+
+This is a collection of tools to work with LEGO colors.
+
+## Installation
+
+### From Git
+
+If installing for the system in general:
+
+```bash
+git clone \<git repository url\> wordmonger
+cd wordmonger
+gem build wordmonger.gemspec
+gem install wordmonger-\<version\>.gem # e.g. gem install wordmonger-1.0.0.gem
+
+```
+
+If installing for a specific application, built with bundler, then replace the last command above with:
+
+```bash
+cd \<your application root\>
+bundle add wordmonger
+bundle build
+```
+
+### From RubyGems
+
+This gem has not been released to RubyGems. Maybe I will do that when I feel it's mature enough.
+
+<!-- 
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem phrase 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
+
+```wordmonger <command> <options>```
+
+Type ```wordmonger help``` for a list of commands, or ```wordmonger help <command>``` for help with a specific command.
+
+## 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/rleber/model. 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/rleber/model/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 Model project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rleber/model/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/wordmonger/dictionary.rb

@@ -0,0 +1,60 @@
+module WordMonger
+  class Dictionary
+    attr_reader :name, :phrases, :words
+    attr_accessor :abbreviations
+    def initialize(name, abbreviations: {}, scanner: nil)
+      @name = name
+      self.scanner = scanner
+      @phrases = {}
+      @words = {}
+      @abbreviations = abbreviations
+      WordMonger.add_dictionary(self)
+    end
+
+    def scanner
+      unless @scanner
+        self.scanner = WordMonger.default_scanner
+      end
+      @scanner
+    end
+
+    def scanner=(scanner)
+      @scanner = scanner.dup
+      @scanner.dictionary = self if @scanner
+    end
+
+    def activate
+      WordMonger.activate(self)
+    end
+
+    def add(phrase)
+      @phrases[phrase.text] = phrase
+    end
+
+    def delete(phrase)
+      text = phrase.is_a?(WordMonger::Phrase) ? phrase.text : phrase
+      @phrases.delete(text)
+    end
+
+    def serialize
+      @phrases.values.map { |value| value.serialize }
+    end
+
+    def add_abbreviation(abbreviation, abbreviates)
+      @abbreviations[abbreviation] = abbreviates
+    end
+
+    def delete_abbreviation(abbreviation)
+      @abbreviations.delete(abbreviation)
+    end
+
+    def add_word(word)
+      @words[word.text] = word
+    end
+
+    def delete_word(word)
+      text = word.is_a?(WordMonger::Word) ? word.text : word
+      @words.delete(text)
+    end
+  end
+end

data/lib/wordmonger/phrase.rb

@@ -0,0 +1,74 @@
+module WordMonger
+  class Phrase
+
+    attr_reader :text, :dictionary
+    def initialize(text, dictionary: nil)
+      self.text = text
+      @dictionary = dictionary || WordMonger.active_dictionary
+      @dictionary.add(self)
+    end
+
+    def to_s
+      @text
+    end
+
+    def serialize
+      to_s
+    end
+
+    def scanner
+      @dictionary.scanner
+    end
+
+    def text=(text)
+      @text = text
+      @words = nil
+      @expanded = nil
+    end
+
+    # TODO Make words first-class objects?
+    private def get_words
+      return [] unless @text
+      self.scanner.scan(@text)
+    end
+
+    def words
+      @words ||= get_words
+    end
+
+    private def case_preserving_sub(text, from, to)
+      match_regexp = Regexp.new(Regexp.escape(from), Regexp::IGNORECASE)
+      from_text = text[match_regexp]
+      to_text = to.downcase
+      first_from_char = from_text[0]
+      if first_from_char == first_from_char.upcase
+        to_text = (to_text[0].upcase) + to_text[1..]
+      end
+      text.sub(from_text, to_text)
+    end
+
+    private def get_expanded
+      expanded_name = self.text
+      self.words.each do |word|
+        lowercase_word = word.text.downcase
+        substitute = dictionary.abbreviations[lowercase_word]
+        if substitute
+          expanded_name = case_preserving_sub(expanded_name, word.text, substitute)
+        end
+      end
+      expanded_name
+    end
+
+    def expanded
+      @expanded ||= self.class.new(get_expanded)
+    end
+
+    def expanded_name
+      expanded.phrase
+    end
+
+    def expanded_words
+      self.expanded.words
+    end
+  end
+end

data/lib/wordmonger/scanner.rb

@@ -0,0 +1,47 @@
+module WordMonger
+  class Scanner
+    @@scanners = {}
+
+    class ScannerFailure < WordMonger::Error; end
+
+    class << self
+      def scanners
+        @@scanners
+      end
+
+      def add_scanner(name, scanner)
+        @@scanners[name] = scanner
+      end
+
+      def default
+        @@default ||= self.new(nil, /\w+/)
+        @@default
+      end
+    end
+
+    attr_reader :name, :definition
+    attr_accessor :dictionary
+    def initialize(name, definition, dictionary: nil)
+      @name = name
+      @definition = definition
+      @dictionary ||= WordMonger.active_dictionary
+      self.class.add_scanner(name, self)
+    end
+
+    # TODO For future development: Compound words
+
+    def scan(string)
+      words = case @definition
+      when Regexp
+        string.scan(@definition)
+      when Proc
+        Proc.call(string)
+      when nil
+        single_scan(string, self.class.default)
+      else
+        raise ScannerFailure, "Unknow scanner type: #{scanner.inspect}"
+      end
+      words.map { |word| WordMonger::Word.new(word, dictionary: self.dictionary) }
+    end
+  end
+end

data/lib/wordmonger/version.rb

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

data/lib/wordmonger/word.rb

@@ -0,0 +1,70 @@
+module WordMonger
+  class Word
+
+    attr_reader :text, :dictionary
+    def initialize(text, dictionary: nil)
+      self.text = text
+      @dictionary = dictionary || WordMonger.active_dictionary
+      @dictionary.add_word(self)
+    end
+
+    def serialize
+      @text
+    end
+
+    def scanner
+      @dictionary.scanner
+    end
+
+    def text=(text)
+      @text = text
+      @words = nil
+      @expanded = nil
+    end
+
+    # TODO Make words first-class objects?
+    private def get_words
+      return [] unless @text
+      @scanner.scan(@text)
+    end
+
+    def words
+      @words ||= get_words
+    end
+
+    private def case_preserving_sub(text, from, to)
+      match_regexp = Regexp.new(Regexp.escape(from), Regexp::IGNORECASE)
+      from_text = text[match_regexp]
+      to_text = to.downcase
+      first_from_char = from_text[0]
+      if first_from_char == first_from_char.upcase
+        to_text = (to_text[0].upcase) + to_text[1..]
+      end
+      text.sub(from_text, to_text)
+    end
+
+    private def get_expanded
+      expanded_name = self.text
+      self.words.each do |word|
+        lowercase_word = word.downcase
+        substitute = dictionary.abbreviations[lowercase_word]
+        if substitute
+          expanded_name = case_preserving_sub(expanded_name, word, substitute)
+        end
+      end
+      expanded_name
+    end
+
+    def expanded
+      @expanded ||= self.class.new(get_expanded)
+    end
+
+    def expanded_name
+      expanded.phrase
+    end
+
+    def expanded_words
+      self.expanded.words
+    end
+  end
+end

data/lib/wordmonger.rb

@@ -0,0 +1,62 @@
+module WordMonger
+
+  class Error < StandardError; end
+  class DuplicateDictionary < Error; end
+  class UndefinedDictionary < Error; end
+
+  class << self
+    def dictionaries
+      @@dictionaries ||= {}
+    end
+
+    def dictionary(name=nil)
+      self.dictionaries[name]
+    end
+
+    def add_dictionary(dictionary)
+      raise Error, "Can't add a nil dictionary" unless dictionary
+      name = dictionary.name
+      raise DuplicateDictionary if self.dictionary(name)
+      @@dictionaries[name] = dictionary
+    end
+  end
+
+end
+
+require_relative 'wordmonger/version'
+require_relative 'wordmonger/phrase'
+require_relative 'wordmonger/word'
+require_relative 'wordmonger/dictionary'
+require_relative 'wordmonger/scanner'
+
+module WordMonger
+
+  DEFAULT_VENDOR = :lego
+
+  @@active_dictionary = WordMonger::Dictionary.new(nil)
+
+  class << self
+
+    def default_scanner
+      @@default_scanner
+    end
+
+    def active_dictionary
+      @@active_dictionary
+    end
+
+    def active_scanner
+      @@active_dictionary.scanner
+    end
+
+    def default_scanner
+      @@default_scanner ||= WordMonger::Scanner.default
+    end
+
+    def activate(name=nil)
+      dictionary = dictionary(name)
+      raise UndefinedDictionary unless dictionary
+      @@active_dictionary = dictionary
+    end
+  end
+end

data/sig/wordmonger.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: wordmonger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard LeBer
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- richard.leber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- '1'
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/.gitkeep
+- lib/wordmonger.rb
+- lib/wordmonger/dictionary.rb
+- lib/wordmonger/phrase.rb
+- lib/wordmonger/scanner.rb
+- lib/wordmonger/version.rb
+- lib/wordmonger/word.rb
+- output/.gitkeep
+- sig/wordmonger.rbs
+homepage: https://github.com/rleber/wordmonger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rleber/wordmonger
+  changelog_uri: https://github.com/rleber/wordmonger/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Work with words, synonyms, and abbreviations
+test_files: []