ouroboros 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 040b53849fd78ac0d7ba8d56d540a90d5ae3ebc99890bf5283d228a6db6a3b45
+  data.tar.gz: 831116ffaff26ce393ba9348661f1eb4d839e3e53b8588d0ca23141223bf3e15
+SHA512:
+  metadata.gz: 6cbaff34ebe40a0e072c9fd4a6a6250d9a9e5ea87d6ed0091d2a022922de76764e473ea33ce8a5a4d2cd46a8e1ff615047254bed5e4c9321a0c554f51e83115d
+  data.tar.gz: 21ed67fa4579b7e5e36cacb04851a38f029e4e29067a897c8fa0e396bf2a675f1f0b1f117e3e5ebdd1c3a785ad579dbb44775d202db3c02d16af40b26a62fe40

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-25
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,113 @@
+# Ouroboros
+
+Ouroboros is an experimental implementation of an infinite circular Array. An Array eating it's own tail. 
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ouroboros
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ouroboros
+
+## Motivation
+
+Supporting an application which had rota patterns with a format like D (Day), N (Night), O (Day off), L (Long day). This pattern needed to be allocated to each Junior Doctor in turn `rota[0]` on week 1 through to `rota[19]` on week 20. What became apparant is that this pattern needed to be exploded
+
+```
+rota = [
+    # Mon  Tue  Wed  Thu  Fri  Sat  Sun
+    [ 'L', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 1
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 2
+    [ 'D', 'D', 'D', 'D', 'L', 'O', 'O' ], # week 3
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'L' ], # week 4
+    [ 'D', 'D', 'D', 'L', 'D', 'O', 'O' ], # week 5
+    [ 'D', 'L', 'D', 'D', 'D', 'O', 'O' ], # week 6
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 7
+    [ 'N', 'N', 'N', 'N', 'O', 'O', 'O' ], # week 8
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 9
+    [ 'D', 'D', 'D', 'D', 'D', 'L', 'O' ], # week 10
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 11
+    [ 'D', 'D', 'L', 'D', 'D', 'O', 'O' ], # week 12
+    [ 'D', 'D', 'D', 'D', 'N', 'N', 'N' ], # week 13
+    [ 'O', 'O', 'D', 'D', 'D', 'O', 'O' ], # week 14
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 15
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 16
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 17
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 18
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ], # week 19
+    [ 'D', 'D', 'D', 'D', 'D', 'O', 'O' ]  # week 20
+]
+```
+
+Into one series of shifts and this pattern could then run in a cycle for 20 weeks, or 52 weeks or even 60 weeks. The pattern just repeats. And then it might even start on the Wednesday so this pattern would have to be rotated.
+
+```
+[ 'L', 'D', 'D', 'D', 'D', 'O', 'O', 'D', 'D', 'D', 'D', 'D', 'O', 'O'] # etc.
+```
+
+In order to manage these potentially infinite cyclic patterns an `Ouroboros::Array` can be used to simplify accessing shifts for a particular Doctor on day 999 of a recurring pattern.
+
+## Usage
+
+Instantiate an `Ouroboros::Array`
+
+```ruby
+[1, 2, 3, 4, 5].to_ouroboros
+# or
+Ouroboros::Array.new([1, 2, 3, 4, 5])
+```
+
+Using the usual suspects `at`
+
+```
+o = [1, 2, 3, 4, 5].to_ouroboros
+o.at(0)    #=> 1
+o.at(5)    #=> 1
+o.at(298)  #=> 4
+o.at(-218) #=> 3
+```
+
+or `[]`
+
+```
+o = [1, 2, 3, 4, 5].to_ouroboros
+
+# with index
+o[0]    #=> 1
+o[5]    #=> 1
+o[298]  #=> 4
+o[-418] #=> 3
+
+# with index, size
+o[1, 12] #=> Ouroboros::Array[2, 3, 4, 5, 1, 2, 3, 4, 5, 1, 2, 3]
+o[4, 9]  #=> Ouroboros::Array[5, 1, 2, 3, 4, 5, 1, 2, 3]
+
+# with range
+o[1..12] #=> Ouroboros::Array[2, 3, 4, 5, 1, 2, 3, 4, 5, 1, 2, 3]
+o[4..9]  #=> Ouroboros::Array[5, 1, 2, 3, 4, 5]
+```
+
+Other `Array` methods are available
+
+```
+o = [1, 2, 3, 4, 5].to_ouroboros
+o.rotate(2) #=> Ouroboros::Array[3, 4, 5, 1, 2]
+
+```
+
+## 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/braindeaf/ouroboros.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/ouroboros/array.rb

@@ -0,0 +1,50 @@
+module Ouroboros
+  class Array
+
+    attr_reader :store
+
+    def initialize(args = [])
+      @store = ::Array.new(args)
+    end
+
+    def inspect
+      "#{self.class.name}#{store}"
+    end
+
+    def [](*args)
+      case args
+      in ::Array[Range => range]
+        send(:[], range.begin, range.size)
+
+      in ::Array[Integer => start, Integer => length]
+        base = store.rotate(start % store.size)
+        times, remainder = length.divmod(store.size)
+        Array.new([*(base * times), *base[0, remainder]])
+
+      in ::Array[Integer => index]
+        at(index)
+
+      else
+        store.send(:[], *args).then { |o| o.is_a?(::Array) ? Array.new(o) : o }
+      end
+    end
+
+    def ==(other)
+      other == store
+    end
+
+    def at(index)
+      store.at(index % store.size)
+    end
+
+    private
+
+    def method_missing(m, *args, &block)
+      store.send(m, *args, &block).then { |o| o.is_a?(::Array) ? Array.new(o) : o }
+    end
+
+    def respond_to_missing?(m, include_private=false)
+      data.respond_to?(m, include_private)
+    end
+  end
+end

data/lib/ouroboros/core_ext/array.rb

@@ -0,0 +1,11 @@
+module Ouroboros
+  module CoreExt
+    module Array
+      def to_ouroboros
+        Ouroboros::Array.new(self)
+      end
+    end
+  end
+end
+
+::Array.include(Ouroboros::CoreExt::Array)

data/lib/ouroboros/version.rb

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

data/lib/ouroboros.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "ouroboros/core_ext/array"
+require_relative "ouroboros/array"
+require_relative "ouroboros/version"

data/ouroboros.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/ouroboros/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ouroboros"
+  spec.version = Ouroboros::VERSION
+  spec.authors = ["RobL"]
+  spec.email = ["contact@robl.me"]
+
+  spec.summary = "Circular, Infinite Arrays in Ruby"
+  spec.description = "Ouroboros is an experimental implementation of an infinite circular Array. An Array eating it's own tail. "
+  spec.homepage = "https://github.com/braindeaf/ouroboros"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/braindeaf/ouroboros"
+  spec.metadata["changelog_uri"] = "https://github.com/braindeaf/ouroboros/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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+
+  spec.require_paths = ["lib"]
+end

data/sig/ouroboros.rbs

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

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ouroboros
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RobL
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'Ouroboros is an experimental implementation of an infinite circular
+  Array. An Array eating it''s own tail. '
+email:
+- contact@robl.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ouroboros.rb
+- lib/ouroboros/array.rb
+- lib/ouroboros/core_ext/array.rb
+- lib/ouroboros/version.rb
+- ouroboros.gemspec
+- sig/ouroboros.rbs
+homepage: https://github.com/braindeaf/ouroboros
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/braindeaf/ouroboros
+  source_code_uri: https://github.com/braindeaf/ouroboros
+  changelog_uri: https://github.com/braindeaf/ouroboros/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Circular, Infinite Arrays in Ruby
+test_files: []