collatz 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac3403918c8be4b788fdfab2ec298d657c29eb05437c01652f9dd91387a61290
+  data.tar.gz: 67c1ad526601163e3356d0b2318710ff9e2b7691696e08c511fe71e029d83d16
+SHA512:
+  metadata.gz: 5987d1636fb13b32ab6f886b4c9223eb747584e43bae7476d5ec69d7ee5515d2d38ff658ccb902690fd87442f6c7ec608c4c02d078feb134a196bd2b43d101fb
+  data.tar.gz: e0ff96c1119cc04ec3cd9c235830436e6b1dabb80b1188b731bd90eee5168d31fb3aedfa136dfdfe3b5e554a0b8afd5c80c9f1c7c81b0727f90ef5c046b01a8b

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,156 @@
+AllCops:
+  TargetRubyVersion: 2.7.0
+  UseCache: false
+  # NewCops: enable # would silence the recommendation
+  # # to enable new, but would hide which ones were run
+  # SuggestExtensions: false # would silence the tips
+  # # for recommended suggested gems.
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+Gemspec/RequireMFA:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: true
+
+Security/CompoundHash:
+  Enabled: true
+Security/IoMethods:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+Layout/LineContinuationLeadingSpace:
+  Enabled: true
+Layout/LineContinuationSpacing:
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/ConstantOverwrittenInRescue:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NonAtomicFileOperation:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RefinementImportMethods:
+  Enabled: true
+Lint/RequireRangeParentheses:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/ScriptPermission:
+  Enabled: false
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UselessRuby2Keywords:
+  Enabled: true
+
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/EmptyHeredoc:
+  Enabled: true
+Style/EndlessMethod:
+  Enabled: true
+Style/EnvHome:
+  Enabled: true
+Style/FetchEnvVar:
+  Enabled: true
+Style/FileRead:
+  Enabled: true
+Style/FileWrite:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/MagicCommentFormat:
+  Enabled: true
+Style/MapCompactWithConditionalBlock:
+  Enabled: true
+Style/MapToHash:
+  Enabled: true
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NestedFileDirname:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/ObjectThen:
+  Enabled: true
+Style/OpenStructUse:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantInitialize:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/SelectByRegexp:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

data/BUNDLER.md

@@ -0,0 +1,33 @@
+# Collatz
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/collatz`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add collatz
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install collatz
+
+## 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/[USERNAME]/collatz. 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/[USERNAME]/collatz/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Collatz project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/collatz/blob/master/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in collatz.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    collatz (0.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  collatz!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.22

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Nathan Levett
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,39 @@
+.PHONY: setup setup_github clean test build install push_rubygems push_github
+SHELL:=/bin/bash
+
+# Assumes `gem install bundler`
+setup:
+	bundle install
+
+setup_github:
+	gem install keycutter
+
+clean:
+	bundle exec rake clean
+	rm -f collatz-*.gem
+	rm -f pkg/collatz-*.gem
+
+test: clean
+	bundle exec rake
+
+# We can choose from `gem build collatz.gemspec` or `bundle exec rake build`.
+# The gem build command creates a ./collatz-$VER.gem file, and the rake build
+# (within bundle context) creates a ./pkg/collatz-$VER.gem file.
+build: test
+	bundle exec rake build
+
+# --user-install means no need for sudo or expectation of
+# changing the folder permissions or access but will need
+# "gem environment"'s "USER INSTALLATION DIRECTORY" (+ "/bin")
+# in the PATH to then use any gem executables that it may contain.
+install: build
+	gem install ./pkg/collatz-$$(grep lib/collatz/version.rb -e "VERSION" | cut -d \" -f 2).gem --user-install
+
+# Will be run with one "pkg/collatz-*.gem" file
+# rubygems_api_key and the rubygems host are the default
+push_rubygems:
+	gem push $$(find . | grep pkg/collatz-*.gem)
+
+# Will be run with one "pkg/collatz-*.gem" file
+push_github:
+	gem push --key github --host https://rubygems.pkg.github.com/Skenvy $$(find . | grep pkg/collatz-*.gem)

data/README.md

@@ -0,0 +1,20 @@
+# [Collatz](https://github.com/Skenvy/Collatz): [Ruby](https://github.com/Skenvy/Collatz/tree/main/ruby) 🔻💎🔻
+Functions related to [the Collatz/Syracuse/3N+1 problem](https://en.wikipedia.org/wiki/Collatz_conjecture), implemented in [Ruby](https://www.ruby-lang.org/).
+## Getting Started
+[To install the latest from RubyGems](https://rubygems.org/); ([empty search results for collatz](https://rubygems.org/search?query=collatz))
+```sh
+gem install collatz
+```
+## Usage
+Provides the basic functionality to interact with the Collatz conjecture.
+The parameterisation uses the same `(P,a,b)` notation as Conway's generalisations.
+Besides the function and reverse function, there is also functionality to retrieve the hailstone sequence, the "stopping time"/"total stopping time", or tree-graph. 
+The only restriction placed on parameters is that both `P` and `a` can't be `0`.
+## [<lang-docs-name> generated docs](https://skenvy.github.io/Collatz/ruby)
+## Developing
+### The first time setup
+```sh
+git clone https://github.com/Skenvy/Collatz.git && cd Collatz/ruby && <localised-setup-command>
+```
+### Iterative development
+* <list-worthwhile-recipes>

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/collatz.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/collatz/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "collatz"
+  spec.version = Collatz::VERSION
+  spec.license = "Apache-2.0"
+  spec.authors = ["Nathan Levett"]
+  spec.email   = ["nathan.a.z.levett@gmail.com"]
+  spec.summary = "Functions Related to the Collatz/Syracuse/3n+1 Problem"
+  spec.description = "Provides the basic functionality to interact with the Collatz conjecture.
+  The parameterisation uses the same (P,a,b) notation as Conway's generalisations.
+  Besides the function and reverse function, there is also functionality to retrieve
+  the hailstone sequence, the \"stopping time\"/\"total stopping time\", or tree-graph.
+  The only restriction placed on parameters is that both P and a can't be 0."
+  spec.homepage = "https://github.com/Skenvy/Collatz/tree/main/ruby"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Skenvy/Collatz/tree/main/ruby"
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/devlog.md

@@ -0,0 +1,55 @@
+# Devlog
+[Ruby](https://www.ruby-lang.org/) and gems (packages) at [rubygems](https://rubygems.org/). For as established and wide spread a language as ruby is, especially with [Ruby on Rails](https://rubyonrails.org/), I'm surprised to see that the ruby [community](https://www.ruby-lang.org/en/community/) page includes a link to a [discord](https://discord.gg/EnSevaRfct). There's a [ruby version manager](http://rvm.io/), [guides on gem creation](https://guides.rubygems.org/), and [bundler](https://bundler.io/). We can install ruby on ubuntu with `sudo apt install ruby-full` and on windows with [rubyinstaller](https://rubyinstaller.org/), although the [documentation/installation](https://www.ruby-lang.org/en/documentation/installation/) lists a lot of other alternatives!
+
+In terms of "trending ruby repos" on github, there's quite a few. We'll have a look through these examples;
+* [ruby/ruby](https://github.com/ruby/ruby)
+* [rubygems/rubygems](https://github.com/rubygems/rubygems)
+* [rails/rails](https://github.com/rails/rails)
+* [jekyll/jekyll](https://github.com/jekyll/jekyll)
+* [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core)
+* [github/linguist](https://github.com/github/linguist)
+* [discourse/discourse](https://github.com/discourse/discourse)
+* [mastodon/mastodon](https://github.com/mastodon/mastodon)
+* [sorbet/sorbet](https://github.com/sorbet/sorbet)
+* [Shopify/shopify_app](https://github.com/Shopify/shopify_app)
+
+We can follow [Make your own Gem](https://guides.rubygems.org/make-your-own-gem/). 
+
+There are some useful looking github actions; [ruby/setup-ruby](https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby) and [ruby/setup-ruby-pkgs](https://github.com/marketplace/actions/setup-ruby-pkgs). And also have a look at the GitHub [Working with the RubyGems registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry). The github page makes mention of bundler as well, so it's worth more so having a look at [How to create a Ruby gem with Bundler](https://bundler.io/guides/creating_gem.html), which itself links to [Common practices for developing gems](https://guides.rubygems.org/patterns/). First, we'll need to install it; [`gem install bundler`](https://rubygems.org/gems/bundler). Having run it in my WSL (with sudo), it seems the same issue that happened with maven in WSL and windows has happened with `bundler`, as `which bundle` yields `/usr/local/bin/bundle`, but trying to `bundle --version` yields `/mnt/c/Ruby/3.1/bin/bundle: line 6: /mnt/c/Ruby/3.1/bin/ruby: No such file or directory`. As expected, `type bundle` comes back with `bundle is hashed (/mnt/c/Ruby/3.1/bin/bundle)`. A quick `hash -r bundle` and `bundle --version` now correctly returns `Bundler version 2.3.21`.
+
+We should now be able to follow the [How to create a Ruby gem with Bundler](https://bundler.io/guides/creating_gem.html) page and run `bundle gem collatz`. Running it asked a bunch of questions that I wasn't necessarily ready to answer with any particular intention, so my choice of `rspec` for `bundle config gem.test` (out of `rspec/minitest/test-unit/(none)`), and `rubocop` for `bundle config gem.linter` (out of `rubocop/standard/(none)`) weren't informed, although the choice of `github` for `bundle config gem.ci` (out of `github/travis/gitlab/circle/(none)`) obviously was. Having already chosen the Apache License v2, I obviously said `n` to adding the MIT license, although selected `y` to adding a code of conduct and changelog to see what it would generate for the output of these. Running it generated all the output files in a `collatz` subdirectory from where I already was in the `~/Collatz/ruby/` folder, so I'll have to merge stuff down a folder.
+
+In terms of what it added, post merging down a folder, besides all the other decorating files, we have (besides the README instructions);
+* `~/.rspec` (RSpec testing)
+* `~/.rubocop.yml` (RuboCop linter)
+* `~/collatz.gemspec` (description file of the gem)
+* `~/Gemfile` (Bundler declarative dependencies)
+* `~/Gemfile.lock` (Bundler imperative dependencies)
+* `~/Rakefile` (Ruby's official task running makefile)
+* `~/bin/console` (Bundler script)
+* `~/bin/setup` (Bundler script)
+* `~/lib/collatz.rb` (what is loaded from a `require "collatz"` invocation)
+* `~/lib/collatz/version.rb` (project's version as an object instance _in-code_)
+* `~/sig/collatz.rbs` (Signature)
+* `~/spec/collatz_spec.rb` (RSpec testing)
+* `~/spec/spec_helper.rb` (RSpec testing)
+
+From the [Make your own Gem](https://guides.rubygems.org/make-your-own-gem/) guide, we can see that the `~/collatz.gemspec` (description file of the gem) and `~/lib/collatz.rb` (what is loaded from a `require "collatz"` invocation) are the most fundamental pieces of the package. Anything else under `~/lib/` is just the normal code of the package, and it seems `~/lib/collatz/version.rb` is just a convenient way of only writing it in one place, similar to the python version file. The `~/Rakefile` is a "Ruby Makefile" to run [`rake`](https://github.com/ruby/rake) commands, with `rake` being a general task runner for Ruby. The [`~/Gemfile`](https://bundler.io/man/gemfile.5.html) is a bundler file for listing the declarative dependencies, mostly in the form of required gems. The `~/Gemfile.lock` is an imperative stateful instantiation of the [`~/Gemfile`](https://bundler.io/man/gemfile.5.html).
+
+Both files in the `~/spec/` folder and the `~/.rspec` file are RSpec testing files, which was what we chose in `bundle config gem.test` (out of `rspec/minitest/test-unit/(none)`) where `minitest` is the ruby default OotB testing framework. From looking at the examples on the guide using minitest versus what bundler generated for the choice of rspec, it seems that the choice impacts what is required in the rakefile, how it sets up the "test task" and how it knows where to look for the files to interpret under which ever testing framework was chosen. I'm not immediately a huge fan of the "acceptance testing" style of the rspec testing over the "expect"-esque style of the minitest framework, so I might swap to that later. Both `~/bin/` files are ignored by the `~/collatz.gemspec` dynamic determination of the `spec.files` field. The guide for creating a gem mentions bin files being included, so it seems the bundler default is to ignore the potential of wanting to add a binary file over what it considers the most beneficial way of setting itself up with the bin scripts. I'm not sure how easily they could be removed, i.e. how that would break bundler commands, but I imagine there'd be no way to keep them if wanting to remove the bin exclusion from the `spec.files` to actually include an executable with the gem.
+
+The `~/.rubocop.yml` is a config for the `rubocop` choice we made for `bundle config gem.linter` (out of `rubocop/standard/(none)`), and there is an entry for a task in the rakefile to run this linter. I'm not sure yet what requires or expects the `~/sig/collatz.rbs` file, but its [`rbs`](https://github.com/ruby/rbs) extension is ruby official. Asking the ruby discord reveals that it's a pretty new feature and entirely optional. Although signature / type interfacing has been provided by gems like sorbet for a long time, the ruby official rbs itself is new.
+
+Now that we have a small understanding of what is going on with the files, let's try and set up a "Hello World" package with v0.0.1 to release to GitHub packages to get that part of the workflow set up. After trying to run `bundle exec rake` a few times to test the output and verify that it works, I've realised how grossly verbose RuboCop is, and it might be worthwhile switching to standard instead. As much as I don't like [Black](https://black.readthedocs.io/en/stable/) (the python strict linter), I wonder if [standard](https://github.com/testdouble/standard), which is also strict, would be passable. Well, either way, I had to explicitly disable the `Lint/ScriptPermission` cop, as it was not recommended as a missing cop locally or in github, but was still causing the workflow to fail with `bin/console:1:1: w: lint/scriptpermission: script file console doesn't have execute permission.`, which was _NOT_ fixed by following [this rubocop issue](https://github.com/rubocop/rubocop/issues/4526). We've got to manually add the `spec.license = "Apache-2.0"` in the gempsec.
+
+[Publishing your gem](https://guides.rubygems.org/publishing/) makes mention of "PUBLISHING TO RUBYGEMS.ORG" which includes signing up at [rubygems](https://rubygems.org/users/new), then running `gem push <pkgame-version.gem>`, which will generate a `~/.gem/credentials` the first time it's run after asking for your credentials that were used to sign up. As we obviously can't commit that sort of file, we'll need to run [`gem signin`](https://guides.rubygems.org/command-reference/#gem-signin) to get the right credentials file. If you're like me and using an older version of ruby, then an email to your account may prompt you to run `gem update --system`, but it's also then worth visiting [profile/api_keys](https://rubygems.org/profile/api_keys) to restrict the scopes of the key that's just been generated. The contents of the `~/.gem/credentials` file look like;
+```yaml
+---
+:rubygems_api_key: rubygems_0123456789abcdef0123456789abcdef0123456789abcdef
+```
+While the [GitHub: Working with the RubyGems registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry) guide includes mention of the expecation for the file to look like;
+```yaml
+---
+:github: Bearer <PAT|TOKEN>
+```
+We can `base64 ~/.gem/credentials` the rubygems_api_key we got from the `gem signin`, add the string (without the newlines) to our github secrets, and then do something like `echo -n "$RUBYGEMS_API_KEY_BASE64" | base64 --decode > ~/.gem/credentials` to recreate the credentials. GitHub's credentials should be passable with a `echo -e "---\n:github: Bearer <PAT|TOKEN>" > ~/.gem/credentials`.

data/lib/collatz/version.rb

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

data/lib/collatz.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "collatz/version"
+
+module Collatz
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/collatz.rbs

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: collatz
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Nathan Levett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-14 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Provides the basic functionality to interact with the Collatz conjecture.
+    The parameterisation uses the same (P,a,b) notation as Conway's generalisations.
+    Besides the function and reverse function, there is also functionality to retrieve
+    the hailstone sequence, the "stopping time"/"total stopping time", or tree-graph.
+    The only restriction placed on parameters is that both P and a can't be 0.
+email:
+- nathan.a.z.levett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- BUNDLER.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- collatz.gemspec
+- devlog.md
+- lib/collatz.rb
+- lib/collatz/version.rb
+- sig/collatz.rbs
+homepage: https://github.com/Skenvy/Collatz/tree/main/ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/Skenvy/Collatz/tree/main/ruby
+  source_code_uri: https://github.com/Skenvy/Collatz/tree/main/ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Functions Related to the Collatz/Syracuse/3n+1 Problem
+test_files: []