README.md

Ruuuby

for resource	reference
latest version	0.1.0.pre.5
stable version	0.0.49
copy-paste smiley face	˙ ͜ʟ˙
changelog	CHANGELOG.md with in progress migration to [History.txt format]
JIT testing	RUBYOPT="--jit --jit-warnings --jit-wait --jit-max-cache=1337 --jit-verbose=2 --jit-debug -w" ./bin/console/ruuuby
common non-ascii	∅,∃,∄,∋,∌,∈,∉,ⓣ,Ⓣ,≈,∞,π,℮,𝚽 η̂,μ,𝔠,Λ,λ,∫,⨍,𝑓,∀,τ,χ²,x̃,𝚡,𝛿,σ,𝚪,𝛾 𝔹,ℂ,ℕ,𝕎,ℤ,ℚ,𝔸ᵣ,ℂ,𝕋,𝕀,ℝ,𝕌,𝕊,🅱 ±,Ω,γ,Ψ,ρ,δ,Ⴔ,⨁,⨂,∖,≡,√,∛, ↩,‣,⟶,↘,➚,⬇,⬆,●,◆,▲,▬,▰,♪ 𝞽,θ,°,ʳ,ᵍ,⦜,○,ᵀ,▣,∴,𝔦,𝔣,⌈,⌋ ₑ,₀,₁,₂,₃,ₓ,ᵢ,⁻ⁿ,⁰,¹,²,³,⁴,⁵,⁶,⁷,⁸,⁹ ¼,½,¾,⅓,⅕,⅕,⅖,⅗,⅘,⅙,⅐,⅛,⅜,⅝,⅞,⅑,⅒ 💎,🌐,🆔,🛑,❓,💻,🔑,🐋,🐍,🐫,🙈 📁,🗄️,💾,🕒,🎲,📊,🧟,❄️,⚠️,✏️,📖,🏠 📱,🌎,✅,♻️,🍺,🛡,📅,❌,🧬,🐇,🌽
download source for utilized version of Ruby	Ruby3.0.0-preview1
summary & purpose	in migration until version{0.1.0}

Examples

#  __   ___              ___          ___    ___  __  
# |  \ |__  \  /    |  |  |  | |    |  |  | |__  /__` 
# |__/ |___  \/     \__/  |  | |___ |  |  | |___ .__/ 

# run node.js tests on live container{A}, transfer results as file to live container{B}
qa_results = 🐋['service_js_dev'].cmd!(%w(npm test --check-leaks)).join.as_utf8
🐋['service_nginx_dev'].📁✏️('/example/file/path.txt', qa_results)

# send chat message, triggering execution of background QA tests which involve randomness
#   ‣ allowing relatively ∞ time for tests to complete, as needed
#   ‣ jobs can be scheduled from mobile-phone! 📱
#
# AMQP & REST: Ruuuby ⟶ Discord ⟶ JavaScript ⟶ RabbitMQ ⟶ Ruuuby ⟶ Discord
$discord.msg('!cmd: bundle exec rake qa:rng')

# ‣ A) is the specified path an empty file or not exist?
# ‣ B) is today's average temperature in Chicago below freezing?
# ‣ if yes to (A) and (B), save results of brew update command to file at path specified
path_file = "brew_update_#{📅.today.to_s}.txt"
unless 📁.∃?(path_file) || 📁.∅?(path_file)
  chicago_data     = 🌐.get_json!('https://www.metaweather.com/api/location/2379574/')
  avg_temp_celsius = chicago_data['consolidated_weather'].first['the_temp']
  💻("brew update > #{path_file}") if avg_temp_celsius < 0
end

#  ___  ___      ___       __   ___     __     __   ___  __  ___ 
# |__  |__   /\   |  |  | |__) |__     |  \ | / _` |__  /__`  |  
# |    |___ /~~\  |  \__/ |  \ |___    |__/ | \__> |___ .__/  |  

# | ✔ | ✔ | ✔ | ✔ | ✔ |
𝚽 == 1 + (𝚽^⁻¹)
𝚽 == 2 * sin(θ°(54))
π == 5 * acos(𝚽 / 2) 
θ°(360) == θʳ(π/2) * 4
√(√(-1337.0^⁴)) == 1337

# | ✔ | ✔ | ✘ | ✘ | ✔ |
'b'.∈? 'abc'
'abc'.∌? 'd'
'd'.∈? 'abc'
'xyz'.∉? [1337, 'xyz']
[1337, 'xyz'].∋? 1337

# | ✔ | ✘ |
[1, 'a', 2, nil, [], 2].≈≈ [nil, 2, 2, 'a', 1, []]
[1, 'a', 2, nil, [], 2] == [nil, 2, 2, 'a', 1, []]

# | ✔ | ✔ | ✔ | ✔ |
['snake_case'.🐍?, 'AHHH_CAPITALS'.🐍⬆?, 'UpperCaseCamel'.🐫?, 'lowerCaseCamel'.🐫⬇?]

# | ✘ | ✔ | ✔ | ✘ | ✘ | ✔ |
[ℕ.∋?(-5), 𝕎.∋?(0.0), ℤ.∋?(7.0), ℝ.∋?(∞), ℝ.∋?(3i), ℚ.∋?(2/3r)]

# | ✔ | ✔ | ✔ |
Matrix[[1,3,5],[2,4,6]].ᵀ == Matrix[[1,2],[3,4],[5,6]]
([1, 2, 3].⨁ [3, 4]) == [1, 4, 2]
([2, 3, 4].∖ [1, 2, 3]) == [4]

# | ✔ | ✘ |
data = {haaallo: 'wooorld', ye: 'ee'}
[data.∃🔑?(:haaallo), data.∃🔑?(:👁️👅👁️)]

# stdout ⟶ 'world'
#            'hello'
['world', 1337, 'hello', 'abc'.❄️].∀{|x| puts x if x.str? && !x.❄️?}

# stdout ⟶ 'hello'
#            'world'
['world', 1337, 'hello', 'abc'.❄️].↩∀{|x| puts x if x.str? && !x.❄️?}

Gems:

gem	version	:development, :runtime	notes
tty-command	0.10.0	✅, ✅	always required
finite_machine	0.14.0	✅, ✅	always required
bunny	2.17.0	✅, ❌	toggleable feature
docker-api	2.0.0	✅, ❌	toggleable feature
open3	0.1.0	✅, ❌	toggleable feature
pg	1.2.3	✅, ❌	toggleable feature
activerecord	6.0.3.4	✅, ❌	toggleable feature
keycutter	1.0.2	✅, ❌	development utility
rubocop	1.4.2	✅, ❌	development utility
rdoc	6.2.1	✅, ❌	development utility
rspec	3.10.0	✅, ❌	development utility
rspec-benchmark	0.6.0	✅, ❌	development utility
rake	13.0.1	✅, ❌	development utility
rake-compiler	1.1.1	✅, ❌	development utility
rubygems-update	3.2.0.rc.2	❌, ❌	recommended version
bundler	2.2.0.rc.2	❌, ❌	recommended version
rugged	1.1.0	❌, ❌	to be (re-added) after increasing CICD scope
github-linguist	7.12.0	❌, ❌	to be added after increasing CICD scope
rails	6.0.3.4	❌, ❌	to be added after increasing CICD scope

Overview:

Example Refinements:

base context	sub context	applies to	example of added functions
ThetaAngle	ContextStr	String	ʳ?,ᵍ?,ʳ,ᵍ
ThetaAngle	-ContextRuuuby -ContextParamCheck	Object	-θ°,θʳ,θᵍ,θ𝞽 -θ?,🛑θ❓
Math::Algebra::Tropical	ContextNumeric	Numeric	⨁, ⨂
Math::Algebra::Tropical	ContextMatrix	Matrix	⨁, ⨁!, ⨂, ⨂ⁿ
Heuristics	ContextParsingCommandOutput	-String -Array	clean

Example Math Modules:

(sub) module	sub-module	func(s) added
Math	Ratio	golden?, super_golden?
NumberTheory		semiprime?
NumberTheory	ℕ¹	prime_factors, divisors, proper_divisors, aliquot_sum, perfect?, almost_perfect?, abundant?, abundance, abundancy_index, deficient?, deficiency, composite?
NumberTheory	𝕎¹	nᵗʰ_euler_totient, nᵗʰ_cototient, digit_sum, digital_root, additive_persistence
NumberTheory	ℕ²	coprime?, friendly?
NumberTheory	ℤ³	congruent?
Combinatorics	𝕎¹	len_powerset
Combinatorics	𝕎²	n_choose_k, permutations, len_ordered_with_replacement
Stats		μ⟶arithmetic_mean, x̃⟶median
Stats	TimeSeries	simple_moving_average, weighted_moving_average, exponential_moving_average, aroon_up, aroon_down, aroon_oscillator
Stats	Probability
Stats	Descriptive	𝛿⟶percentage_error, relative_diff
Stats	StatisticalLearning
Stats	Distribution::Normal	cdf

Example Custom Math Classes:

base-context	sub-context	sample functionality
Trigonometry	class: ThetaAngle	°?,°,ʳ?,ʳ,∅?,⦜?,○?,η̂?,η̂!
Statistics	class: TimeSeriesData	μ,x̃,σ,σ²,ρ,mse,mape,λ,Λ,η̂?,η̂! mem_size,free_memory,Q₁,Q₂,Q₃,IQR,outliers_lower,outliers_upper
NumberTheory::𝕎¹	singleton-objs of class: Math::Expr::Sequence	seq_pronic,seq_fibonacci,seq_lucas,seq_square,seq_triangle,seq_hexagonal
Forex	class: CurrencyMatrix
GraphTheory	class: PseudoGraph

Example Class Modifications:

class(es)	func(s) added
File, Dir, ENV, NilClass, Vector	∅?
File	replace_expr_with, replace_expr_with!, insert_line_before_expr
Object	Ⓣ, ary?, bool?, hsh?, int?, flt?, num?, str?, chr?, sym?, matrix?, vec? 🛑bool❓, 🛑int❓, 🛑flt❓, 🛑num❓, 🛑ary❓, 🛑str❓, 🛑sym❓
String	♻️⟵, ♻️⟶, ♻️⟶∞,∋?, ∌?, ∈?, ∉? ⬇?⟶downcase?, ⬆?⟶upcase?, ⬇!⟶downcase!, ⬆!⟶upcase! 🐫?, 🐫⬇?, to_🐫``🐍⬆?, 🐍?, to_🐍 digit?, to_num, to_num?, palindrome? as_utf8, iso8601?, to_iso8601, as_iso8601
Enumerable	∌?, ∀τ²∈λ𝑓₍ᵢ،ᵢ₊₁₎
Array, String	>>, η̂!, ensure_start!, ensure_ending!
Matrix	∀ₓ↘, ∀ₓᵢ↘, ↘_to_a, ∀ₓᵢⱼ

Example Aliases:

for	base method(s) reference(s)	alias(es)
Kernel	raise	🛑
Object	object_id, class, freeze, frozen?	🆔, ⓣ, ❄️, ❄️?
Module	private, protected, const_defined?, private_method_defined?, protected_method_defined?	🙈, 🛡️, ∃const?, ∃🙈⨍, ∃🛡️⨍?
String, Symbol	upcase, downcase	⬆, ⬇
Array, Hash, Set	each	∀
Enumerable	map, each_with_index	⨍, ∀ₓᵢ
Hash	key?	∃🔑?
NilClass, Hash, Array, String, Set	empty?	∅?
String, Array, Set, Hash, Proc	length (arity for Proc) *	𝔠

---

Runnable Commands

documentation to update here prior to version{0.1.0}

---

Code Base Statistics:

Discrete Tests: (relative test weights are estimated, pending formal calculations)

relative weight per test	testing categories	label	count	stable before version{0.1.0}	description
0.01	QA	unit	1203	✅	core functionality
0.01	QA	tech-debt	8	✅	track missing or incorrect functionality
0.01	CICD	audit	83	✅	anything non-functionality based regarding expected code structure
0.01	CICD	preferences	26	✅	verify developer preferred OS & dev configs/values
0.02	QA,DB	DB engine		❌	DB specific unit tests
0.05	QA,DB	ORM		❌	ORM specific unit tests
0.05	CICD	locale	55	✅	verify Ruuuby required (build) configs
0.05	QA	integration	42	✅	state & functionality of grouped unit tests (especially for any set of code involving more than 1 feature)
0.10	QA	rng		❌	verify data distributions (each test allowed relatively ∞ time to complete)
0.15	QA,performance	benchmarks-runtime		❌	verify ideal boundaries and variance of runtime performance
0.15	QA,performance	benchmarks-memory		❌	verify ideal boundaries and variance of memory performance
0.25	QA,performance	benchmark-matrices		❌	verify ideal macro trends through aggregations of data-sets from benchmarks, logs, DB data, etc
0.50	QA,DB	services		❌	integration scaled across groups of ORM & DB tests
0.75	QA,DB	system	7	✅	integration scaled to micro-services w/ randomness added to help encounter niche error-states
1.00	QA,CICD,DB	domain		❌	integration scaled across groups of micro-services

Code Coverage

category	% of code covered	stable before version{0.1.0}
features	?	❌
documentation	?	❌
full test suite	?	❌
configuration as code	?	❌
linter	?	❌