fibonacci_enumerator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c742f135126413ac534f27071379c351368ba40b9d7389469403545f22e6dd71
+  data.tar.gz: c651cd4a032831917fdaebf754c8e61dc3c03925f74587a0da4aabe6c0f37619
+SHA512:
+  metadata.gz: ad938b777156261eace3f66453a217dc6aa806d1ae6e96d7b275b8b9d49b2be3c0d73d58f77e94383536aa8dfd9a5d62a5e270c050ae5aa03790f9cdb24277b5
+  data.tar.gz: 7e4cd0b642db9890ba62d26f33ad659110708f64cfbcb982f24f817ab51926adb4789e3bdf2dc4062fadd791f796f5879a431883262fa2f0a4ce91fd696af24f

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+inherit_gem:
+  rubocop-espago: rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-13
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mateusz Drewniak
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mateusz Drewniak
+
+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,117 @@
+# FibonacciEnumerator
+
+This gems adds `FibonacciEnumerator`, an Enumerable class that makes it possible
+to efficiently calculate elements of the Fibonacci sequence.
+
+It is an Enumerable object so it can be iterated through using `each`
+and implements methods like `first`, `select`, `map` etc.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add fibonacci_enumerator
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fibonacci_enumerator
+
+## Usage
+
+Elements of the Fibonacci sequence are calculated using the dynamic programming approach.
+Instances of `FibonacciEnumerator` contain a cache that accumulates already calculated
+elements of the sequence.
+
+You can use the `FibonacciEnumerator` class directly as an `Enumerable` object for convenience.
+
+### at
+
+The `at` method aliases as `[]` can be used to get a particular element of the sequence.
+
+```rb
+FibonacciEnumerator.at(1) #=> 1
+FibonacciEnumerator.at(2) #=> 1
+FibonacciEnumerator.at(3) #=> 2
+FibonacciEnumerator.at(4) #=> 3
+FibonacciEnumerator.at(5) #=> 5
+FibonacciEnumerator.at(6) #=> 8
+
+FibonacciEnumerator[1] #=> 1
+FibonacciEnumerator[2] #=> 1
+FibonacciEnumerator[3] #=> 2
+FibonacciEnumerator[4] #=> 3
+FibonacciEnumerator[5] #=> 5
+FibonacciEnumerator[6] #=> 8
+```
+
+You can also pass a `Range`.
+
+```rb
+FibonacciEnumerator.at(4..7) #=> [3, 5, 8, 13]
+FibonacciEnumerator[4..7] #=> [3, 5, 8, 13]
+```
+
+### each
+
+You can iterate through the Fibonacci series.
+Keep in mind that it's infinite, so the loop will
+go on forever unless manually interrupted
+
+```rb
+FibonacciEnumerator.each do |element|
+    puts element
+end
+# 1
+# 1
+# 2
+# 3
+# 8
+# ...
+```
+
+### select
+
+You can filter elements using `select` or `reject`
+
+```rb
+FibonacciEnumerator.first(25).select(&:even?)
+#=> [0, 2, 8, 34, 144, 610, 2584, 10946, 46368]
+```
+
+This class is `Enumerable` so methods like `each`, `select`, `reject`, `take` etc
+are available as well.
+
+### Sharing the cache between multiple calculations
+
+When you want to manually get particular elements of the Fibonacci sequence
+you can save some time by sharing the cache between calculations.
+
+You can do that by creating an instance of `FibonacciEnumerator`.
+
+```rb
+fib = FibonacciEnumerator.new
+
+fib[10]
+#=> 55
+fib[10] # cache is reused, no calculations were necessary!
+#=> 55
+fib[15] # the first 10 elements were already calculated, so its faster
+#=> 610
+```
+
+Instances are also `Enumerable` objects so methods like `each`, `select`, `reject`, `take` etc
+are available as well.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Verseth/ruby-fibonacci_enumerator.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/fibonacci_enumerator/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class FibonacciEnumerator # rubocop:disable Style/StaticClass
+  # @return [String]
+  VERSION = '0.1.0'
+end

data/lib/fibonacci_enumerator.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative 'fibonacci_enumerator/version'
+
+# An Enumerable class that makes it possible
+# to efficiently calculate elements of the Fibonacci sequence.
+#
+# It is an Enumerable object so it can be iterated through using `each`
+# and implements methods like `first`, `select`, `map` etc.
+class FibonacciEnumerator
+  include ::Enumerable
+
+  class << self
+    alias class_include? include?
+
+    include ::Enumerable
+
+    # @param index [Integer, Range]
+    def at(index)
+      new.at(index)
+    end
+    alias [] at
+
+    # @return [Enumerator, self]
+    # @yieldparam [Integer]
+    def each(&block)
+      new.each(&block)
+    end
+
+    alias include? class_include?
+  end
+
+  attr_reader :cache
+
+  def initialize
+    reset_cache
+  end
+
+  # @param index [Integer, Range]
+  # @return [Integer]
+  def at(index)
+    return at_int(index) if index.is_a?(::Integer)
+
+    at_range(index)
+  end
+
+  # @return [Enumerator, self]
+  # @yieldparam [Integer]
+  def each
+    return enum_for(:each) unless block_given?
+
+    (0..).each do |i|
+      yield at_int(i)
+    end
+
+    self
+  end
+
+  # @return [void]
+  def reset_cache
+    @cache = [0, 1, 1]
+  end
+
+  private
+
+  # @param index [Integer]
+  # @return [Integer]
+  def at_int(index)
+    if (item = @cache[index])
+      return item
+    end
+
+    while index >= @cache.length # rubocop:disable Style/WhileUntilModifier
+      @cache[@cache.length] = @cache[@cache.length - 1] + @cache[@cache.length - 2]
+    end
+
+    @cache[index]
+  end
+
+  # @param range [Range]
+  # @return [Integer]
+  def at_range(range)
+    return @cache[range] if range.end < @cache.length
+
+    while range.end >= @cache.length # rubocop:disable Style/WhileUntilModifier
+      @cache[@cache.length] = @cache[@cache.length - 1] + @cache[@cache.length - 2]
+    end
+
+    @cache[range]
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: fibonacci_enumerator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-13 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem which adds a module that can efficiently calculate the elements
+  of the fibonacci sequence.
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fibonacci_enumerator.rb
+- lib/fibonacci_enumerator/version.rb
+homepage: https://github.com/Verseth/ruby-fibonacci_enumerator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-fibonacci_enumerator
+  source_code_uri: https://github.com/Verseth/ruby-fibonacci_enumerator
+  rubygems_mfa_required: 'true'
+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.4.14
+signing_key:
+specification_version: 4
+summary: A Ruby gem which adds a module that can efficiently calculate the elements
+  of the fibonacci sequence.
+test_files: []