englishest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efd066ca7b2c8c2116db5c43fbdaed3dd5956bc070a13c386966137a4e9cf8ad
+  data.tar.gz: 8798a76c67d031cd0752dec1a69ddf793aa598f7f983681b63c1e3dbd8ebe616
+SHA512:
+  metadata.gz: 7fd035b052c0a79ace0fbbb4a0e3a2702bdccd6d55d382e010915b0510f8f0ae21d503cd4b9ee8bc9e9b628159947cebe32718329b9fa419b429447de16473a8
+  data.tar.gz: 42a16846944d701a3e73d718d65a82a510dcb03654f51b37d9c1594c81ec330dcd5bcde72f5435fb8629e7014f3cdd48216befb6d3b88375506e0c160fee328e

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/GlobalVars:
+  AllowedVariables:
+    - $LAST_PUT_LINE
+
+Style/OptionalBooleanParameter:
+  AllowedMethods:
+    - consent?
+    - dissent?
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/*.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-17
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in englishest.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "byebug", "~> 11.1", groups: %i[development test]

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    englishest (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  englishest!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mathieu Lovato Stumpf Guntz
+
+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,61 @@
+# Englishest
+
+In a nutshell, with this gem enabled you can now spell `<=>` as `trichotomize`,
+and so on.
+
+This gem aims to provides alternative ways to utter Ruby code, simply defining
+synonyms for miscellaneous terms, especially offering full word counterpart
+to ideograms/logograms such as the so called *spaceship operator*.
+
+The name of the gem is of course a pun: a library which provides ability
+to utter coder which is closer to a voiceable English obviously ought to do it
+so through an obvious transgression of this language usual rules on superlatives.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'englishest'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install englishest
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/psychoslave/englishest].
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# References
+
+Resources consulted while hacking this gem:
+- https://www.includehelp.com/ruby/alias-vs-alias_method-in-ruby.aspx
+- https://ruby-doc.org/core-2.5.0/Comparable.html
+- https://en.wikipedia.org/wiki/Trichotomy_(mathematics)
+- https://en.wikipedia.org/wiki/Three-way_comparison#Spaceship_operator
+- https://bundler.io/guides/creating_gem.html
+- https://guides.rubygems.org/patterns/
+- http://www.rubyinside.com/rubys-unary-operators-and-how-to-redefine-their-functionality-5610.html
+- https://stackoverflow.com/questions/1356749/can-you-eval-code-in-the-context-of-a-caller-in-ruby
+- https://github.com/banister/binding_of_caller
+- https://www.geeksforgeeks.org/ruby-pre-define-variables-constants/
+- https://www.toptal.com/ruby/ruby-metaprogramming-cooler-than-it-sounds

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: %i[spec rubocop]

data/Roadmap.md

@@ -0,0 +1,35 @@
+- define English equivalent for each non-letter methods/operators
+  - `=` aliased as `assign`, `fix`, `set`
+  - `==` aliased as `equivalent?`, `equipotent?`, `equiquantal?`, `equivalue?`
+  - `eql?` aliased as `akin?`, `assimilated?`, `equidense?`, `equiepitomize?`,  `equisummable?`, `equivalate?`, `equivocate?`, `like?`, `tie?`
+      true if both operands refer to the same hash key
+  - `equal?` aliased as `equireferent?`, `univocal?`, `nod?`
+      refer to the same object.
+  - `===` aliased as `apt?`, `fit?`, `encompass?`, `gird?`,
+      case-equality,
+  - `!` unary bivalent negation prefix aliasable has `non-`
+  - `!=` aliased as `dissent?`, `inæqual`, `inequal`, `unequal?`, `unlike?`, `wry?`
+  - `<=>` aliased as `trichotomize`, `spy`, `wye`
+  - `=~` aliased as `hit`
+  - `!~` aliased as `absent?`, `devoid?`, `off?`, `miss?`
+- enable to use dash rather than dot as method call operator :
+  that is `object-method` rather than `object.method`
+  - ensure that numeric value still bind dash to minus, that is substraction
+- allow to select a locale rather than defining all alternatives forms
+
+# Notes
+Terms above are to be taken as
+`ben`: (Scotland, Northern England) Inside.
+`spy`: To distinguish something as being different from something else; to differentiate.
+`wye`: a triangular joining arrangement of three rail lines with a railroad switch (set of points) at each corner connecting to each incoming line.
+`ere`: Before; sooner than.
+
+## Terms with `equi-` prefix
+
+# References
+
+- https://www.planetmath.org/equibounded
+- https://en.wiktionary.org/wiki/ searching for terms starting with `equi`
+- https://medium.com/@khalidh64/difference-between-eql-equal-in-ruby-2ffa7f073532
+- https://fr.wiktionary.org/wiki/Utilisateur:Psychoslave/Vocabulaire_utile_pour_l%E2%80%99informatique
+- https://en.wikipedia.org/wiki/Wye_(rail)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "englishest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/englishest.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/englishest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "englishest"
+  spec.version       = Englishest::VERSION
+  spec.authors       = ["Mathieu Lovato Stumpf Guntz"]
+  spec.email         = ["psychoslave@culture-libre.org"]
+
+  spec.summary       = "A Ruby gem which allows a more literate coding style"
+  spec.description   = <<~ABOUT
+    This gem aims to provides alternative ways to utter Ruby code, simply defining
+    synonyms for miscellaneous terms, especially offering full word counterpart
+    to ideograms/logograms such as the so called *spaceship operator*.
+
+    The name of the gem is of course a pun: a library which provides ability
+    to utter coder which is closer to a voiceable English obviously ought to do it
+    so through an obvious transgression of this language usual rules on superlatives.
+  ABOUT
+  spec.homepage      = "https://github.com/psychoslave/englishest"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["allowed_push_host"] = "https://mygemserver.com"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/psychoslave/englishest.git"
+  spec.metadata["changelog_uri"] = "https://github.com/psychoslave/englishest/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
+end

data/lib/englishest/version.rb

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

data/lib/englishest.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative "englishest/version"
+require "English"
+
+# Encapsulate all the contrivances to allow a coding style using more English
+# vocabulary, especially enabling to express ideas without ideographi operators.
+module Englishest
+  class Error < StandardError; end
+
+  module BasicObject
+    ALIASES = {
+      "==": %i[apt? congruent? equipotent? equiquantal? equivalue? worth?],
+      equal?: %i[equireferent? peg? univocal?],
+      "!=": %i[dissent? inæqual inequal unequal? unlike? wry?]
+      # TODO
+      # '!': unary bivalent negation prefix aliasable has non-],
+      # !
+    }.freeze
+  end
+
+  module Object
+    ALIASES = {
+      eql?: %i[akin? equisummable? isoepitomizable? like? tie?],
+      "!~": %i[absent? devoid? off? miss?],
+      "<=>": %i[trichotomise trichotomize spy wye],
+      "===": %i[encompass? fit? gird?],
+      "=~": %i[hit]
+    }.freeze
+  end
+
+  module Regexp
+    ALIASES = {
+      "=~": %i[hit index_of_first_matching],
+      # As a reminder the tilde implicitely match against $LAST_READ_LINE/$_
+      # Ruby allow to call it both in suffixed and prefixed form, that is
+      # +some_regexp.~+ and +~some_regexp+.
+      #
+      # Note that these aliases cover only the case of a method call suffixing a
+      # Regexp object, like +some_regexp.index_of_first_hot_matching+. For a
+      # prefixed method expression form, see +Englishest#spot+ bellow.
+      "~": %i[hit_tacitely index_of_first_hot_matching hot
+              index_of_first_matching_on_last_read_line]
+    }.freeze
+  end
+
+  module String
+    ALIASES = {
+      "=~": %i[hit index_of_first_matching]
+    }.freeze
+  end
+
+  module Comparable
+    ALIASES = {
+      "<": %i[afore? ahead? antecede? before? ere? inferior_to? less_than?
+              lower_than? prior? subcede? subceed? smaller_than? precede?],
+      "<=": %i[at_most? behind? ben? below? beneath? comprised? proconcede?
+               under? underneath? within?],
+      "==": %i[apt? concede?], # also has other aliases through BasicObject
+      ">=": %i[above? accede? at_least? comprise? on? onward? prosupercede? upward? upon?],
+      ">": %i[after? beyond? excede? exceed? greater_than? higher_than? over? outdo? outstrip? postcede? supercede?
+              supersede? superior_to? top? upper_than?]
+    }.freeze
+  end
+
+  # TODO
+  # Kernel#` which allow shell execution
+
+  # TODO
+  # '=': %i[assign fix peg set],
+
+  # Return list of submodules whose name matches a class or module that is
+  # affected by the gem
+  def self.covered_types
+    Englishest.constants.grep_v(/VERSION|Error/)
+  end
+
+  covered_types.each do |type|
+    Object.const_get("::#{type}").class_eval do
+      Object.const_get("::Englishest::#{self}::ALIASES").each do |operator, monikers|
+        monikers.each { alias_method _1, operator }
+      end
+    end
+  end
+
+  # Treating some corner cases specifically
+  class ::BasicObject
+    alias_method :negative?, "!"
+
+    # Alternative to the double bang prefix notation returning the result of
+    # transtyping anything to either +true+ or +false+.
+    def positive?
+      !!self
+    end
+
+    # Consent tacitely mean "compared to truth" when no topic is given
+    def consent?(topic = true)
+      equal? topic
+    end
+    alias nod? consent?
+
+    # Opposite of consent, although this is implemented as a fully automous
+    # determination, which inter alia avoid some technical convonlutions
+    def dissent?(topic = true)
+      !equal?(topic)
+    end
+    alias deny? dissent?
+    # Note that :ban?, :nay?, :nix?, :ort? might also have do the trick as alias
+    alias axe? dissent?
+
+    # $LAST_READ_LINE is locally binded, to define an synonymous method of the
+    # unary prefixal matching operator which implicitely use it, the value it
+    # holds in the calling context must be retrieved by some means. Here the
+    # retained implementation is to stash the value in a global variable each
+    # time its value change.
+    # TODO: see if this could be implemented withou global variable nor class
+    # variable, as both raising Rubocop offenses
+    trace_var(:$LAST_READ_LINE, proc { |nub|
+      $LAST_PUT_LINE = nub
+    })
+
+    def spot(pattern)
+      $LAST_PUT_LINE =~ pattern
+    end
+    alias win spot
+    alias reach spot
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: englishest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mathieu Lovato Stumpf Guntz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |
+  This gem aims to provides alternative ways to utter Ruby code, simply defining
+  synonyms for miscellaneous terms, especially offering full word counterpart
+  to ideograms/logograms such as the so called *spaceship operator*.
+
+  The name of the gem is of course a pun: a library which provides ability
+  to utter coder which is closer to a voiceable English obviously ought to do it
+  so through an obvious transgression of this language usual rules on superlatives.
+email:
+- psychoslave@culture-libre.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Roadmap.md
+- bin/console
+- bin/setup
+- englishest.gemspec
+- lib/englishest.rb
+- lib/englishest/version.rb
+homepage: https://github.com/psychoslave/englishest
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: A Ruby gem which allows a more literate coding style
+test_files: []