dbms_buffers 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ee12df3813b088a33c85ef865b7c6c68b8b1691ea96938394624ebcbb74cbc9
+  data.tar.gz: c62465c4f2ec50e8ef7de8ee586a0c3b712565d1503971298639c2db7aa38c15
+SHA512:
+  metadata.gz: 236576f69b30141a843f9278914fce0c88d02310f458a3ee3290bd9a60599f40333762726c4e479ced96f22f81d1f04a5a1ad9de7b8b25690ac015d7c3698efa
+  data.tar.gz: e4f32e07e317a0f322e590770684a687cc5b334be9985fc8419821169f7e7e17446a46fb0d455b2b4e2565c3a10f701ba233217367e22cabd8a5352efb5db728

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.reek.yml

@@ -0,0 +1,7 @@
+---
+detectors:
+  IrresponsibleModule:
+    enabled: false
+  TooManyStatements:
+    enabled: true
+    max_statements: 15

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Layout/LineLength:
+  Max: 100
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/WordArray:
+  EnforcedStyle: brackets

data/.ruby-gemset

@@ -0,0 +1 @@
+dbms_buffers

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## CHANGELOG
+
+## Current
+
+* Gem created, rubocop added.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dbms_buffers.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    dbms_buffers (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.4)
+    kwalify (0.7.2)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    reek (5.5.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.78.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    unicode-display_width (1.6.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dbms_buffers!
+  rake (~> 10.0)
+  reek (~> 5.5.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.78)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Manuel Dossinger
+
+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,39 @@
+# DbmsBuffers
+
+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/dbms_buffers`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dbms_buffers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dbms_buffers
+
+## 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 tags, 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]/dbms_buffers.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dbms_buffers'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dbms_buffers.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dbms_buffers/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'dbms_buffers'
+  spec.version = DbmsBuffers::VERSION
+  spec.authors = ['Manuel Dossinger']
+
+  spec.summary = 'Buffer implementations that can be found in typical DBMS lectures.'
+  spec.homepage = 'https://github.com/contradictioned/dbms-buffers'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/contradictioned/dbms-buffers'
+  spec.metadata['changelog_uri'] = 'https://github.com/contradictioned/dbms-buffers/blob/master/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'reek', '~> 5.5.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.78'
+end

data/lib/dbms_buffers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'dbms_buffers/version'
+require 'dbms_buffers/clock'
+require 'dbms_buffers/generators'
+require 'dbms_buffers/lru'
+
+module DbmsBuffers
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/dbms_buffers/clock.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module DbmsBuffers
+  ClockBufferEntry = Struct.new(:value, :clock_value)
+
+  # The clock buffer, also known as second-change buffer,
+  # arranges entries in a logical clock and a single hand.
+  # When the buffer is full and a not-yet-inserted entry needs space,
+  # the hand goes clockwise until it finds an entry with clock_value = 0.
+  # This entry is evicted, removed from the buffer, and the new values
+  # is inserted with clock_value 1.
+  # All entries the hand passes where clock_value = 1, this value is decremented,
+  # but they are not replaced yet (they have a second chance).
+  # When an element is accessed that has clock_value = 0, this value is set to 1 again.
+  class ClockBuffer
+    attr_reader :pointer, :size
+
+    def initialize(size)
+      @size = size
+      @buffer = []
+      @pointer = 0
+    end
+
+    def access(value)
+      try_touch(value) || try_insert_new(value) || try_replace(value)
+    end
+
+    def clock_value_of(value)
+      @buffer[index(value)].clock_value
+    end
+
+    def entries
+      @buffer.clone
+    end
+
+    def contains?(value)
+      @buffer.any? { |entry| value == entry.value }
+    end
+
+    def used
+      @buffer.size
+    end
+
+    private
+
+    # If value is contained in the buffer, it's value is set to 1
+    # and true is returned, otherwise false
+    def try_touch(value)
+      result = contains? value
+      touch(value) if result
+      result
+    end
+
+    # If buffer slots are free, inserts value and returns true.
+    def try_insert_new(value)
+      return false if used == @size
+
+      entry = ClockBufferEntry.new(value, 1)
+      @buffer[@pointer] = entry
+      advance_pointer
+
+      true
+    end
+
+    def try_replace(value)
+      entry = @buffer[@pointer]
+      if entry.clock_value.zero?
+        entry.value = value
+        entry.clock_value = 1
+        return true
+      end
+
+      entry.clock_value = 0
+      advance_pointer
+      try_replace value
+    end
+
+    def advance_pointer
+      @pointer = (@pointer + 1) % @size
+    end
+
+    def index(value)
+      @buffer.index { |entry| entry.value == value }
+    end
+
+    def touch(value)
+      @buffer.find { |entry| entry.value == value }.clock_value = 1
+    end
+  end
+end

data/lib/dbms_buffers/generators.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DbmsBuffers
+  # The SimpleGenerator generates random elements for putting into the buffer.
+  # By default, it generates a letter from A to Z.
+  # This can be adjusted using the range method, e.g.
+  # SimpleGenerator.new.range(['A', 'B', 'C'])
+  class SimpleGenerator
+    def initialize(seed = Random.new_seed)
+      @rng = Random.new(seed)
+      @range = *('A'..'Z')
+    end
+
+    def range(range)
+      @range = range.to_a
+      self
+    end
+
+    def get
+      idx = @rng.rand(@range.size)
+      @range[idx]
+    end
+
+    def repeat(amount)
+      result = []
+      amount.times { result << get }
+      result
+    end
+  end
+end

data/lib/dbms_buffers/lru.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module DbmsBuffers
+  LRUBufferEntry = Struct.new(:value, :timestamp)
+
+  # The LRUBuffer applies least recently used as eviction strategy.
+  # For this, it saves the time of the last access with each buffered value.
+  class LRUBuffer
+    attr_reader :size
+
+    def initialize(size)
+      @size = size
+      @buffer = []
+      @time = 0
+    end
+
+    def access(value)
+      @time += 1
+      try_touch(value) || try_insert_new(value) || try_replace(value)
+    end
+
+    def entries
+      @buffer.clone
+    end
+
+    def contains?(value)
+      @buffer.any? { |entry| value == entry.value }
+    end
+
+    def used
+      @buffer.size
+    end
+
+    private
+
+    def try_touch(value)
+      result = contains? value
+      touch(value) if result
+      result
+    end
+
+    def try_insert_new(value)
+      return false if used == @size
+
+      entry = LRUBufferEntry.new(value, @time)
+      @buffer << entry
+
+      true
+    end
+
+    def try_replace(value)
+      entry = oldest_entry
+      entry.value = value
+      entry.timestamp = @time
+
+      true
+    end
+
+    def index(value)
+      @buffer.index { |entry| entry.value == value }
+    end
+
+    def oldest_entry
+      @buffer.min { |entry_a, entry_b| entry_a.timestamp <=> entry_b.timestamp }
+    end
+
+    def touch(value)
+      @buffer.find { |entry| entry.value == value }.timestamp = @time
+    end
+  end
+end

data/lib/dbms_buffers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DbmsBuffers
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: dbms_buffers
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Manuel Dossinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dbms_buffers.gemspec
+- lib/dbms_buffers.rb
+- lib/dbms_buffers/clock.rb
+- lib/dbms_buffers/generators.rb
+- lib/dbms_buffers/lru.rb
+- lib/dbms_buffers/version.rb
+homepage: https://github.com/contradictioned/dbms-buffers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/contradictioned/dbms-buffers
+  source_code_uri: https://github.com/contradictioned/dbms-buffers
+  changelog_uri: https://github.com/contradictioned/dbms-buffers/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Buffer implementations that can be found in typical DBMS lectures.
+test_files: []