englishest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efd066ca7b2c8c2116db5c43fbdaed3dd5956bc070a13c386966137a4e9cf8ad
-  data.tar.gz: 8798a76c67d031cd0752dec1a69ddf793aa598f7f983681b63c1e3dbd8ebe616
+  metadata.gz: 8cb8a05f6ac1a1025318971a8a2f675f254d79bc1f091ae6a99260033d1a466d
+  data.tar.gz: e074cf3227bdbf671a56259987a42537e3d81e2ff46bc3b7938805a368899c97
 SHA512:
-  metadata.gz: 7fd035b052c0a79ace0fbbb4a0e3a2702bdccd6d55d382e010915b0510f8f0ae21d503cd4b9ee8bc9e9b628159947cebe32718329b9fa419b429447de16473a8
-  data.tar.gz: 42a16846944d701a3e73d718d65a82a510dcb03654f51b37d9c1594c81ec330dcd5bcde72f5435fb8629e7014f3cdd48216befb6d3b88375506e0c160fee328e
+  metadata.gz: e293b83300d6683c9475ae4c178df7402a56a364c78e6b7f0164e860e6a7f0d252342e7611f46db2c4136bb6f52ccc6321c94bab4b05dc393f67f8da7a32446d
+  data.tar.gz: 6eea047202cde2f2ee184db2270b9f69877faa79f39d0ea43f563d83e47c2adb28f615ca48d72f3d819384c013d75a9e13a34cf1cf5cd40360b4da8dfcdffa03

data/.rubocop.yml

@@ -14,6 +14,9 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
+Lint/EmptyClass:
+  AllowComments: true
+
 Style/GlobalVars:
   AllowedVariables:
     - $LAST_PUT_LINE

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-11-17
+## [0.2.0] - 2022-03-05
+
+- Move alises previously defined in Object to Kernel, as all aimed methods belong
+  to it.
+- Add methods
+  - `String#subshell`: allow to execute a command without using backticks
+- Add aliases for
+  - `Array::[]`: create engender generate gig
+  - `BasicObject#!`: bad? con? negative? ko?
+  - `BasicObject#__id__`: badge bib emblem identifier insigne insignia
+  - `BasicObject#!=`: inæqual? inequal? unequal? unlike? wry?
+  - `BasicObject#instance_eval`: contextually so tho wis
+  - `BasicObject#instance_exec`: aptly pat plumb suitably
+  - `BasicObject#method_missing`: gap lake vacant on_vacancy way_off
+  - `BasicObject#__send__`: address fax hop pst transmit
+  - `BasicObject#singleton_method_added`: hail hey hi on_attachment
+  - `BasicObject#singleton_method_removed`: ban ciao leave_taking on_detachment
+  - `BasicObject#singleton_method_undefined`: farewell nix on_unattachment]
+  - `Dir::[]`: conform native_global_match orb suit
+  - ``Kernel#```: subshell run
+  - `String#subshell`: run
+  - `SystemCallError::===`: encompass? fit? gird?
+
+
+## [0.1.0] - 2021-12-01
 
 - Initial release
+- All provided identifiers have at least one three letter synonymous,
+  except `negative?` and `positive?`
+- Incorporate a first set of mere aliases plus a few methods
+- Covered types include BasicObject, Comparable, Object, Regexp, String
+- introduced fully qualified methods are:
+  - `BasicObject#consent?(topic = true)`
+  - `BasicObject#dissent?(topic = true)`
+  - `BasicObject#positive?`
+  - `BasicObject#spot(pattern)`
+- Target/synonymous aliases are:
+  - `BasicObject#==`: apt? congruent? equipotent? equiquantal? equivalue? worth?
+  - `BasicObject#consent?`: nod?
+  - `BasicObject#dissent?`: axe? deny?
+  - `BasicObject#!=`: dissent? inæqual inequal unequal? unlike? wry?
+  - `BasicObject#equal?`: equireferent? peg? univocal?
+  - `BasicObject#!`: negative?
+  - `BasicObject#spot`: reach win
+  - `Comparable#>=`: above? accede? at_least? comprise? on? onward? prosupercede? upward? upon?
+  - `Comparable#<`: afore? ahead? antecede? before? ere? inferior_to? less_than?
+  - `Comparable#>`: after? beyond? excede? exceed? greater_than? higher_than? over? outdo? outstrip? postcede? supercede?
+  - `Comparable#==`: apt? concede? # also has other aliases through BasicObject
+  - `Comparable#<=`: at_most? behind? ben? below? beneath? comprised? proconcede?
+  - `Object#!~`: absent? devoid? off? miss?
+  - `Object#===`: encompass? fit? gird?
+  - `Object#eql?`: akin? equisummable? isoepitomizable? like? tie?
+  - `Object#=~`: hit
+  - `Object#<=>`: trichotomise trichotomize spy wye
+  - `Regexp#=~`: hit index_of_first_matching
+  - `Regexp#~`: hit_tacitely index_of_first_hot_matching hot
+  - `String#=~`: hit index_of_first_matching

data/Gemfile

@@ -4,11 +4,3 @@ 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

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    englishest (0.1.0)
+    englishest (0.2.0)
+      rake (~> 13.0)
 
 GEM
   remote: https://rubygems.org/
@@ -49,8 +50,7 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1)
   englishest!
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (~> 3.2)
   rubocop (~> 1.7)
 
 BUNDLED WITH

data/README.md

@@ -8,7 +8,7 @@ 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
+to utter code 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
@@ -48,14 +48,21 @@ The gem is available as open source under the terms of the [MIT License](https:/
 # 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://en.wikipedia.org/wiki/Three-way_comparison#Spaceship_operator
+- https://en.wikipedia.org/wiki/Trichotomy_(mathematics)
+- https://github.com/banister/binding_of_caller
 - https://guides.rubygems.org/patterns/
-- http://www.rubyinside.com/rubys-unary-operators-and-how-to-redefine-their-functionality-5610.html
+- https://guides.rubygems.org/patterns/
+- https://ruby-doc.org/core-2.5.0/Comparable.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.includehelp.com/ruby/alias-vs-alias_method-in-ruby.aspx
 - https://www.toptal.com/ruby/ruby-metaprogramming-cooler-than-it-sounds
+- http://www.rubyinside.com/rubys-unary-operators-and-how-to-redefine-their-functionality-5610.html
+- https://www.saturnflyer.com/blog/the-difference-between-instanceeval-and-instanceexec/
+- https://dejimata.com/2017/5/20/the-ruby-module-builder-pattern
+- https://stackoverflow.com/questions/51138274/list-all-ruby-classes-and-methods
+- https://stackoverflow.com/questions/12274652/what-is-argf-class-in-ruby-1-9
+- https://c-for-dummies.com/blog/?p=4813
+- https://en.wikipedia.org/wiki/Glob_(programming)

data/englishest.gemspec

@@ -37,7 +37,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "byebug", "~> 11.1"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rubocop", "~> 1.7"
   spec.metadata = {
     "rubygems_mfa_required" => "true"
   }

data/lib/documentation.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class Dir
+  ##
+  # :singleton-method: []
+  # Dir has a singleton method <tt>[](*args, base: nil, sort: true)</tt>
+  # which is equivalent to call <tt>Dir.glob([string, ...], 0)</tt>
+  #
+  # The +0+ passed as last argument is a flag that indicates case sensitivity.
+  # Given that +File::FNM_SYSCASE+ is defined as system default case
+  # insensitiveness, equals to +FNM_CASEFOLD+ or 0, it means that the expansion
+  # will match file name depending on how system consider case sensitivity.
+  #
+  # For information, FNM stands for "filename match". Indeed, from an historical
+  # perspective, the +glob+ UNIX command is usually based on the +fnmatch+
+  # function, which tests for whether a string matches a given pattern.
+  #
+  # In other word this method allows to access files matching the expansion of a
+  # string including wildcard characters while using system case conformity.
+
+  ##
+  # :singleton-method: conform
+  # Alias for +[]+ with alignment on semantic: a thing conforms to a set of
+  # rules, with a norm or standard, that is a system.
+
+  ##
+  # :singleton-method: native_global_match
+  # Alias for +[]+ with alignment on the original lexic
+
+  ##
+  # :singleton-method: orb
+  # Alias for +[]+ with alignment on the notion of *global*, moreover as a
+  # poetic singleton-metaphor, the verb means to encircle; to surround; to enclose.
+
+  ##
+  # :singleton-method: suit
+  # Alias for +[]+ shorter synonym of conform, with the same justifying semantic.
+end

data/lib/englishest/version.rb

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

data/lib/englishest.rb

@@ -8,32 +8,45 @@ require "English"
 module Englishest
   class Error < StandardError; end
 
+  module Array
+    # List of aliases provided for each class method indexed by its identifier
+    SINGLETON_METHOD_ALIASES = {
+      # create a new instance encompassing parameters
+      "[]": %i[create engender generate gig]
+    }.freeze
+  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-],
-      # !
+      "!=": %i[inæqual? inequal? unequal? unlike? wry?],
+      "!": %i[bad? con? negative? ko?],
+      __id__: %i[badge bib emblem identifier insigne insignia],
+      __send__: %i[address fax hop pst transmit],
+      instance_eval: %i[contextually so tho wis],
+      instance_exec: %i[aptly pat plumb suitably],
+      method_missing: %i[gap lake vacant on_vacancy way_off],
+      singleton_method_added: %i[hail hey hi on_attachment],
+      singleton_method_removed: %i[ban ciao leave_taking on_detachment],
+      singleton_method_undefined: %i[farewell nix on_unattachment]
     }.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]
+  module Dir
+    SINGLETON_METHOD_ALIASES = {
+      "[]": %i[conform native_global_match orb suit]
     }.freeze
   end
 
   module Regexp
+    # List of aliases provided for each instance method indexed by its identifier
     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
+      # As a reminder the tilde implicitely match against +$LAST_READ_LINE+
+      # (aka +$_+).
+      #
+      # Ruby allows 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
@@ -50,6 +63,13 @@ module Englishest
     }.freeze
   end
 
+  module SystemCallError
+    # List of aliases provided for each class method indexed by its identifier
+    SINGLETON_METHOD_ALIASES = {
+      "===": %i[encompass? fit? gird?]
+    }.freeze
+  end
+
   module Comparable
     ALIASES = {
       "<": %i[afore? ahead? antecede? before? ere? inferior_to? less_than?
@@ -63,8 +83,16 @@ module Englishest
     }.freeze
   end
 
-  # TODO
-  # Kernel#` which allow shell execution
+  module Kernel
+    ALIASES = {
+      eql?: %i[akin? equisummable? isoepitomizable? like? tie?],
+      "!~": %i[absent? devoid? off? miss?],
+      "===": %i[encompass? fit? gird?],
+      "=~": %i[hit],
+      "<=>": %i[trichotomise trichotomize spy wye],
+      "`": %i[subshell run]
+    }.freeze
+  end
 
   # TODO
   # '=': %i[assign fix peg set],
@@ -75,23 +103,43 @@ module Englishest
     Englishest.constants.grep_v(/VERSION|Error/)
   end
 
+  # This make the bulk of the work of actually setting aliases, using ALIASES
+  # constant in submodules of Englishest
   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 }
+      # Define aliases of instance methods if such a list is provided
+      begin
+        Object.const_get("::Englishest::#{self}::ALIASES").each do |operator, monikers|
+          monikers.each { alias_method _1, operator }
+        end
+      rescue NameError
+        # No instance method defined for this class, it's fine.
+      end
+
+      # Define aliases of singleton methods if such a list is provided
+      begin
+        class << self
+          aim = "::Englishest::#{to_s.split(":").last.chomp(">")}::SINGLETON_METHOD_ALIASES"
+          Object.const_get(aim).each do |operator, monikers|
+            monikers.each { alias_method _1, operator }
+          end
+        end
+      rescue NameError
+        # No singleton/instance method defined for this class, it's fine.
       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
+    alias good? positive?
+    alias ok? positive?
+    alias pro? positive?
 
     # Consent tacitely mean "compared to truth" when no topic is given
     def consent?(topic = true)
@@ -108,13 +156,13 @@ module Englishest
     # 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
+    ##
+    #
+    # $LAST_READ_LINE is locally binded, to define a 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
     })
@@ -125,4 +173,20 @@ module Englishest
     alias win spot
     alias reach spot
   end
+
+  # A String object has an arbitrary sequence of bytes, typically representing
+  # text or binary data. Extensions provided by this library focus on making
+  # more specific features around String usable with more classic lexical calls.
+  class ::String
+    # Allow to method-pipeline strings toward a subshell execution, in more
+    # subject-verb oriented manner than the default backtilt +``. Subjectively
+    # that can also be considered more aligned with the "everything is object"
+    # spirit
+    def subshell
+      `#{self}`
+    end
+    # Trigraph which, albeit a bit less precise on what it undercover than its
+    # aliased version, is fully alligned with regular use of the word.
+    alias run subshell
+  end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: englishest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mathieu Lovato Stumpf Guntz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description: |
   This gem aims to provides alternative ways to utter Ruby code, simply defining
   synonyms for miscellaneous terms, especially offering full word counterpart
@@ -52,6 +94,7 @@ files:
 - bin/console
 - bin/setup
 - englishest.gemspec
+- lib/documentation.rb
 - lib/englishest.rb
 - lib/englishest/version.rb
 homepage: https://github.com/psychoslave/englishest