Ruuuby

flavored modifications & extensions for increased quality of Ruby coding life

Usage

for	use
`Gemfile`	`gem 'ruuuby', '~> 0.0.37'`
ruby scripts	`require 'ruuuby'`
gem url	https://rubygems.org/gems/ruuuby
changelog	https://github.com/utarsuno/ruuuby/blob/master/CHANGELOG.md

Example

# true, true
√(1787569)      == 1337
√(√(-1337.0^⁴)) == 1337

# true, true, true
𝚽 == 1 + (𝚽^⁻¹)
𝚽 == 2 * sin(θ°(54))
𝚽 == (θ𝞽(1) - Ⴔ) / Ⴔ

# true, true
θ°(180) == θ𝞽(0.5)
θᵍ(200) == θʳ(π)

# true, true, false
'b'.∈? 'abc'
'abc'.∌? 'd'
'd'.∈? 'abc'

# true, false
elements_a = [1, 'a', 2, nil, [], 2]
elements_b = [nil, 2, 2, 'a', 1, []]
[elements_a.≈≈(elements_b), elements_a == elements_b]

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

# [false, true, false, true]
[ℕ.∋?(-5), ℤ.∋?(7.0), ℝ.∋?(∞), ℚ.∋?(Rational(2, 3))]

# [1, 4, 2]
[1, 2, 3].⊕ [3, 4]

# [4]
[2, 3, 4].∖ [1, 2, 3] 

# [true, false]
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.❄️?}

⚠️: documentation & test-coverage not fully synced atm

Language Changes:

Operations Supported (patched in)

(⚠️ wip): raising to powers(via-superscripts: ⁻⁹...⁻¹, ⁰, ¹...⁹) with operator(^)

class(es)/obj	example	(at least partially) utilizing C-extension? (java-wip)	notes
`Integer`	`1337^²`	✅	-coexists with `Integer`'s pre-existing `bitwise XOR` functionality -`performance penalties`: up to `80%` `slower` than using operator(`**`)
`Float`	`1337.1337^²`	✅	`performance penalties`: up to `90%` `slower` than using operator(`**`)
`Rational`	`3/4r^²`	✅	`performance penalties`: up to `105% slower` than using operator(`**`)
`Complex`	`1337i^²`	✅	`performance penalties`: up to `85% slower` than using operator(`**`)
`BigDecimal`	`inc`	`inc`	`inc`
`ThetaAngle`	`inc`	`inc`	outputs to unit: `steradian` (depending on input)
`Quaternion`	`inc`	`inc`
`℮`	`inc`	`inc`

TOPLEVEL_BINDING Modifications:

(`global`) func(s) added	notes	as C-extension? (java-wip)
`℮`, `logₑ`, `log₂`, `log₁₀` `√`, `∛`, `π`, `Ⴔ` `¼`, `½`, `¾`, `⅓`, `⅕`, `⅕`,`⅖`,`⅗`,`⅘`,`⅙`,`⅐`, `⅛`, `⅜`, `⅝`, `⅞`, `⅑`, `⅒` `∞`, `∞ℂ`, `γ` `sin`, `cos`, `tan`, `arcsin`, `arccos`, `arctan`, `cot`, `csc`, `sec`, `sin²`, `cos²`	(`f10`, `f17`)	❌/✅
`🌽`	(`f10`): aliases `Kernel`	❌
`📁`, `📂`, `🗄️`	- (`f12`) aliases to: `File`, `Dir`	❌
`📅`, `🕒`, `📅🕒`	- (`f26`) aliases to: `Date`, `Time`, `DateTime`	❌
`θ°`, `θʳ`, `θᵍ`, `θ𝞽`	`f27`	✅

Module Modifications:

instance methods for Kernel will act as 'globally-scoped functions'; meaning they can essentially can be called from anywhere with caller of the method ignored for all contextes

module(s)	func(s) added	as C-extension? (java-wip)	notes
`Kernel`	`𝔠`	❌	(`f03`)
`Kernel`	`🌽_previous_⨍`	❌	(`f10`)
`Kernel`	`∃module?`, `∃class?` {`static`}`∃⨍_alias?`, `∃⨍?`	❌
`Module`	{`static`}`⨍_add_aliases`	✅
`Math`	{`static`}`relative_Δ`, `τ³_is_pythagorean?`, `τ²_in_golden_ratio?`, `τ²_in_super_golden_ratio?`	❌	(`f17`)
`Math`	{`static`} `cot`, `csc`, `sec`, `sin²`, `cos²`	❌	(`f17`)

Class Modifications:

class(es)	func(s) added	as C-extension? (java-wip)	notes
`File`, `Dir`	{`static`}`∃?`	❌	(`f12`)
`File`	{`static`} `dirname²`, `dirname³`, `dirname⁴` `replace_expr_with`, `replace_expr_with!`, `insert_line_before_expr`	❌	(`f12`)
`Dir`	`η̂_paths`	❌	(`f12`)
`File`, `Dir`, `ENV`	`∅?`	❌	(`f04`)
`Object`	`ary?`, `bool?`, `hsh?`, `int?`, `flt?`, `num?`, `str?`, `chr?`, `sym?`, `θ?` `class?`, `module?`, `nucleotide?`	✅	(`f06`)
`Object`	`singleton?`, `Ⓣ` `🛑bool❓`, `🛑int❓`, `🛑ary❓`, `🛑str❓`, `🛑sym❓`, `🛑θ❓`	❌	(`f06`)
`Array`, `Set`	`remove_empty!`	❌/✅	(`f07`)
`String`	`♻️⟵`, `♻️⟶`, `♻️⟶∞` `downcase?`{`⬇?`} `upcase?`{`⬆?`}	❌	(`f08`)
`String`	`🐫?`, `🐫⬇?`, `to_🐫` `🐍⬆?`, `🐍?`, `to_🐍`	❌	(`f24`)
`String`	`as_utf8`, `iso8601?`, `to_iso8601`, `as_iso8601`	❌
`Array`, `String`	`η̂!`	❌	(`f08`)
`Array`	[`frequency_counts`, `📊`] [`equal_contents?`, `≈≈`] [`disjunctive_union`, `⊕`] `∖`	✅	(`f09`)
`Module`, `String`	`∋?`, `∌?`, `∈?`, `∉?`	❌	(`f09`)
`Enumerable`	`∌?`, `∀τ²∈λ𝑓₍ᵢ،ᵢ₊₁₎`	❌	(`f09`, `f10`)
`Array`, `String`	`>>`	✅	(`f05`)
`String`	`digit?`, `to_num`, `to_num?`	❌	(`f21`)
`Array`	`end_with?`, `start_with?`	❌	(`f08`)
`String`, `Array`	`ensure_start!`, `ensure_ending!`	❌	(`f08`)
`NilClass`	`empty?`	✅	- ⚠️: philosophically debatable - (`f04`)
`Integer`	`finite?`, `infinite?`	✅	(`f11`)
`Numeric`	`∞?`	❌	(`f11`)
`Float`	`≈≈`, `∞ℂ?`	❌	(`f17`)

Aliases:

for	base method(s) reference(s)	alias(es)	notes
`Kernel`	`raise`, `rand`	`🛑`, `🎲`	(`f10`)
`Object`	`object_id`, `ⓣ`, `freeze`, `frozen?`, `define_singleton_function`	`🆔`, `class`, [`❄️`, `❄`], [`❄️?`, `❄?`], `define_singleton_⨍`	(`f10`)
`Class`	`new`	`🆕`	(`f10`)
`Array`, `Set`	`remove_empty!`	`♻️∅!`	(`f10`)
`String`, `Symbol`	`upcase`, `downcase`	`⬆`, `⬇`	(`f10`)
`String`	`upcase!`, `downcase!`	`⬆!`, `⬇!`	(`f10`)
`Object`	`protected_instance_methods`, `private_methods`	`🛡️funcs`, `🙈funcs`	(`f01`,`f02`)
`Array`	`frequency_counts`, `disjunctive_union`, `equal_contents?` `↩∀`	`📊`, `⊕`, `≈≈` `reverse_each`	(`f10`)
`Module`	`const_defined?`, `private_method_defined?`	`∃const?`, `∃🙈func?`
`Module`	`private`, `private_constant` `protected`, `protected_method_defined?`	`🙈`, `🙈constants⟶` `🛡️`, `∃🛡️func?`	(`f01`) (`f02`)
`Array`, `Hash`, `Set`	`each`	`∀`	(`f10`)
`Array`, `String`	`reverse`, `reverse!`	`↩`, `↩!`	(`f10`)
`Enumerable`	`map`, `each_with_index`	`⨍`, `∀ₓᵢ`	(`f10`)
`Hash`	`key?`	`∃🔑?`	(`f10`)
`NilClass`, `Hash`, `Array`, `String`, `Set`	`empty?`	`∅?`	(`f04`)
`String`, `Array`, `Set`, `Hash`	`length`	`𝔠`	(`f03`)
`Proc`	`arity`	`𝔠`	(`f03`)

Code Base Statistics:

category	attribute	value	desc.
QA	unit	1009	# of tests (solely relating to core functionality)
QA	performance	233	# of tests (solely relating to performance)
QA	DB	176	# of tests (solely relating to the database)
CI	audits	114	# of tests (solely relating to non-functionality based audits)
CI	locale	28	# of tests (solely relating to local-dev-setup)
structure	features	~35	# of distinct features (that are categorized & tracked) `wip`
coverage	LOCs	???	`wip`
coverage	runtime	???	`wip`
coverage	documentation	???	`wip`

Gems:

gem	version	:development, :runtime	category
`tty-command`	`0.9.0`	✅, ✅	`CLI`
`rugged`	`1.0.0`	✅, ❌	`GIT`
`rdoc`	`6.2.1`	✅, ❌	`DOC`
`bundler`	`2.1.4`	✅, ❌	`CI`
`rspec`	`3.9.0`	✅, ❌	`QA`
`rspec-benchmark`	`0.5.1`	✅, ❌	`QA`
`rake`	`13.0.1`	✅, ❌	`EXT`
`rake-compiler`	`1.1.0`	✅, ❌	`EXT`
`sqlite3`	`1.4.2`	✅, ❌	`DB`
`activerecord`	`5.2.4.1`	✅, ❌	`DB`
`schema_plus_foreign_keys`	`0.1.8`	✅, ❌	`DB`

Commands

General Tasks:

preface	cmd	description
`bundle exec rake`	`rdoc`	generate documentation coverage report
`bundle exec rake`	`install`	install gem onto local machine
`bundle exec rake`	`compile`	compile any native C-extensions with code changes
`bundle exec rake`	`release`	push git version tags and publish gem to Rubygems
`bin/`	`audit`	general all-around build & health check
`bin/`	`audit_db` `audit_quick` `audit_quickest` `audit_all_but_performance`	similar to above but for targeted portions
`bin/`	`setup`	install dependencies
`bin/`	`console`	interactive console for easier experimenting
`gem`	`server`	host interactive web-page at `http://0.0.0.0:8808` to see documentation for currently installed gems

Testing Tasks:

preface	cmd	w/ warnings?	description
`bundle exec rake`	`rspec_unit`	❌	run all unit-tests except tags: {audit, performance, db}
`bundle exec rake`	`rspec_db`	❌	run only db based unit-tests
`bundle exec rake`	`rspec_audit`	❌	run only audit based unit-tests
`bundle exec rake`	`rspec_performance`	❌	run only performance based unit-tests
`bundle exec rake`	`rspec_all`	✅	run all unit-tests

Project Layout:

directory	description of contents
`app`	currently only holds `ORM` definitions
`bin`	`executable` files
`db`	database `schema`, `seed`, and `migrations`
`ext`	`C` portion of this Gem's code (and future location for `JRuby-extensions`)
`help`	any helpful `documentation & notes`
`lib`	`Ruuuby` portion of this `Gem's code`
`spec`	`RSpecs` (unit tests + other `QA` and `Audits`)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/utarsuno/ruuuby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ruuuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

ruuuby
Release 0.1.0.pre.5

Release 0.1.0.pre.5

0.1.0.pre.5

0.1.0.pre.4

0.1.0.pre.3

0.1.0.pre.2

0.1.0.pre.1

0.1.0.pre.0

0.0.49

0.0.48

0.0.47

0.0.46

Documentation

Ruuuby

Usage

Example

⚠️: documentation & test-coverage not fully synced atm

Language Changes:

Operations Supported (patched in)

TOPLEVEL_BINDING Modifications:

Module Modifications:

Class Modifications:

Aliases:

Code Base Statistics:

Gems:

Commands

General Tasks:

Testing Tasks:

Project Layout:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/utarsuno/ruuuby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ruuuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Stats

Development practices

Releases

Maintainers

Contributors

ruuuby Release 0.1.0.pre.5

Release 0.1.0.pre.5 Toggle Dropdown 0.1.0.pre.5 0.1.0.pre.4 0.1.0.pre.3 0.1.0.pre.2 0.1.0.pre.1 0.1.0.pre.0 0.0.49 0.0.48 0.0.47 0.0.46

Documentation

Ruuuby

Usage

Example

⚠️: documentation & test-coverage not fully synced atm

Language Changes:

Operations Supported (patched in)

TOPLEVEL_BINDING Modifications:

Module Modifications:

Class Modifications:

Aliases:

Code Base Statistics:

Gems:

Commands

General Tasks:

Testing Tasks:

Project Layout:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/utarsuno/ruuuby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ruuuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Stats

Development practices

Releases

Maintainers

Contributors

ruuuby
Release 0.1.0.pre.5

Release 0.1.0.pre.5

0.1.0.pre.5

0.1.0.pre.4

0.1.0.pre.3

0.1.0.pre.2

0.1.0.pre.1

0.1.0.pre.0

0.0.49

0.0.48

0.0.47

0.0.46