qfill 0.0.3 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebf168a7298dded7f0c9f3eb4e4edd7fd6f6150465a857343c2433eae5861364
+  data.tar.gz: 8917c3a87fdb98aea36a483008d26e46099bae22ce904b6802df9e310c6053c5
+SHA512:
+  metadata.gz: aa7d5e8882e07947969161d2da89dab24d5e2549ea5138b95fef4bf90ffa82b2eb451133281c1de72c328a903850e6434a701d753b55e7c9aae690f5709e6b50
+  data.tar.gz: df6957d37df1670ad0362c333b60540ed8242b2f8b3db7a84fcf2219cdda5012a5698cbd2cad51054d8cb4a1241b208db46d406df4c8caae68016b78a2980a20

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "04:28"
+    open-pull-requests-limit: 10

data/.github/workflows/style.yml

@@ -0,0 +1,37 @@
+name: Code Style Checks
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+      - '*-maintenance'
+      - '*-dev'
+    tags:
+      - '!*' # Do not execute on tags
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  rubocop:
+    name: Rubocop
+    if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.7
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install --jobs 3 --retry 3
+      - name: Run Rubocop
+        run: bundle exec rubocop -DESP

data/.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+      - '*-maintenance'
+      - '*-dev'
+    tags:
+      - '!*' # Do not execute on tags
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    name: Specs - Ruby ${{ matrix.ruby }} ${{ matrix.name_extra || '' }}
+    if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.0.0
+          - 2.7
+          - 2.6
+          - 2.5
+          - 2.4
+    runs-on: ubuntu-20.04
+    continue-on-error: ${{ matrix.allow_failure || endsWith(matrix.ruby, 'head') }}
+    steps:
+      - uses: amancevice/setup-code-climate@v0
+        name: CodeClimate Install
+        if: matrix.ruby == '2.7' && github.event_name != 'pull_request'
+        with:
+          cc_test_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler: ${{ matrix.bundler || 2 }}
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 3 --retry 3 --binstubs --standalone
+      - name: CodeClimate Pre-build Notification
+        run: cc-test-reporter before-build
+        if: matrix.ruby == '2.7' && github.event_name != 'pull_request'
+        continue-on-error: ${{ matrix.allow_failures != 'false' }}
+      - name: Run tests
+        run: bundle exec rake test
+      - name: CodeClimate Post-build Notification
+        run: cc-test-reporter after-build
+        if: matrix.ruby == '2.7' && github.event_name != 'pull_request' && always()
+        continue-on-error: ${{ matrix.allow_failures != 'false' }}

data/.rspec

@@ -1,2 +1,3 @@
---color
---format progress
+--require spec_helper
+--format=documentation
+--colour

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - 'rubocop-md'
+  - 'rubocop-packaging'
+  - 'rubocop-performance'
+  - 'rubocop-rake'
+  - 'rubocop-rspec'
+
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true # Display the name of the failing cops
+  Exclude:
+    - 'gemfiles/vendor/**/*'
+    - 'vendor/**/*'
+
+Metrics/BlockLength:
+  IgnoredMethods:
+    - context
+    - describe
+    - it
+    - shared_context
+    - shared_examples
+    - shared_examples_for
+    - namespace
+    - draw

data/.rubocop_todo.yml

@@ -0,0 +1,163 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-04-22 19:38:54 UTC using RuboCop version 1.13.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'qfill.gemspec'
+
+# Offense count: 3
+Lint/BinaryOperatorWithIdenticalOperands:
+  Exclude:
+    - 'spec/qfill/filter_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/qfill/manager_spec.rb'
+
+# Offense count: 3
+Lint/UselessAssignment:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+    - 'lib/qfill/list_set.rb'
+    - 'lib/qfill/popper.rb'
+    - 'spec/qfill/filter_spec.rb'
+
+# Offense count: 14
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 106
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 8
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/qfill/popper.rb'
+
+# Offense count: 3
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/qfill/manager.rb'
+    - 'lib/qfill/origin.rb'
+    - 'lib/qfill/result.rb'
+
+# Offense count: 1
+Packaging/GemspecGit:
+  Exclude:
+    - 'qfill.gemspec'
+
+# Offense count: 22
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/qfill/manager_spec.rb'
+
+# Offense count: 1
+RSpec/EmptyExampleGroup:
+  Exclude:
+    - 'spec/qfill/manager_spec.rb'
+
+# Offense count: 45
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/qfill/filter_spec.rb'
+    - 'spec/qfill/list_set_spec.rb'
+    - 'spec/qfill/list_spec.rb'
+    - 'spec/qfill/origin_spec.rb'
+    - 'spec/qfill/popper_spec.rb'
+    - 'spec/qfill/pusher_spec.rb'
+    - 'spec/qfill/result_spec.rb'
+
+# Offense count: 7
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 34
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 1
+Rake/Desc:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 14
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+    - 'lib/qfill/filter.rb'
+    - 'lib/qfill/list.rb'
+    - 'lib/qfill/list_set.rb'
+    - 'lib/qfill/manager.rb'
+    - 'lib/qfill/origin.rb'
+    - 'lib/qfill/popper.rb'
+    - 'lib/qfill/pusher.rb'
+    - 'lib/qfill/result.rb'
+    - 'lib/qfill/strategy/base.rb'
+    - 'lib/qfill/strategy/drain_to_empty.rb'
+    - 'lib/qfill/strategy/drain_to_limit.rb'
+    - 'lib/qfill/strategy/sample.rb'
+    - 'spec/support/helper.rb'
+    - 'spec/support/random_object.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/qfill/pusher.rb'
+    - 'lib/qfill/result.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/qfill/manager.rb'
+
+# Offense count: 24
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+# IgnoredPatterns: (?-mix:^\#)
+Layout/LineLength:
+  Max: 274

data/.simplecov

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/vendor/bundle/'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -1,4 +1,35 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in qfill.gemspec
 gemspec
+
+ruby_version = Gem::Version.new(RUBY_VERSION)
+
+gem 'yard', '~> 0.9.24', require: false
+
+### deps for rdoc.info
+group :documentation do
+  gem 'github-markup', platform: :mri
+  gem 'redcarpet', platform: :mri
+end
+
+group :development, :test do
+  if ruby_version >= Gem::Version.new('2.4')
+    # No need to run byebug on earlier versions
+    gem 'byebug', platform: :mri
+  end
+
+  if ruby_version >= Gem::Version.new('2.7')
+    # No need to run rubocop or simplecov on earlier versions
+    gem 'rubocop', '~> 1.9', platform: :mri
+    gem 'rubocop-md', platform: :mri
+    gem 'rubocop-packaging', platform: :mri
+    gem 'rubocop-performance', platform: :mri
+    gem 'rubocop-rake', platform: :mri
+    gem 'rubocop-rspec', platform: :mri
+
+    gem 'simplecov', '~> 0.21', platform: :mri
+  end
+end

data/Guardfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+guard 'rspec', version: 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Peter Boling
+Copyright (c) 2013-2021 Peter Boling
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# Qfill - Advanced Queue Tranformations
+# Qfill - Advanced Queue Transformations
 
 This gem takes a dynamic number of queues (arrays) of things, and manages the transformation into a new set of queues,
 according to a dynamic set of guidelines.
@@ -23,7 +23,7 @@ There will be a dynamic number of origination queues each containing a set of sn
 some matching criteria.
 There is a Popper which is called to pop the next object from the next origination queue.
 There is a Filter which is optionally called to validate any object that is popped from the origin.
-Origin keeps popping until an object is validated for as a result-worthy object.
+Origin keeps popping until an object is validated as a result-worthy object.
 
 Example:
 

data/Rakefile

@@ -1 +1,24 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec do
+    warn 'RSpec is disabled'
+  end
+end
+task test: :spec
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    warn 'RuboCop is disabled'
+  end
+end
+
+task default: [:test]

data/lib/qfill/errors/invalid_index.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Qfill
+  module Errors
+    class InvalidIndex < StandardError
+    end
+  end
+end

data/lib/qfill/filter.rb

@@ -1,5 +1,7 @@
-#filter1 = Qfill::Filter.new( -> (object, stuff, stank) { object.is_awesome_enough_to_be_in_results?(stuff, stank) }, stuff, stank)
-#filter2 = Qfill::Filter.new( -> (object, rank, bank) { object.is_awesome_enough_to_be_in_results?(rank, bank) }, rank, bank)
+# frozen_string_literal: true
+
+# filter1 = Qfill::Filter.new( -> (object, stuff, stank) { object.is_awesome_enough_to_be_in_results?(stuff, stank) }, stuff, stank)
+# filter2 = Qfill::Filter.new( -> (object, rank, bank) { object.is_awesome_enough_to_be_in_results?(rank, bank) }, rank, bank)
 #
 # Filters are destructive. If an item is filtered from a Result list it is lost, since it has already been popped off the origin list, and won't be coming back
 module Qfill
@@ -12,7 +14,7 @@ module Qfill
     end
 
     def run(*args)
-      self.processor.call(*args, *self.processor_arguments)
+      processor.call(*args, *processor_arguments)
     end
   end
 end

data/lib/qfill/list.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # This is the base queue class for Origin queues and Result queues.
 #
-#Qfill::List.new(:name => "High List",
+# Qfill::List.new(:name => "High List",
 #                    :elements => [Thing1, Thing3],
 #                    :filter => filter1),
 module Qfill
@@ -9,10 +11,10 @@ module Qfill
 
     def initialize(options = {})
       raise ArgumentError, "Missing required option :name for #{self.class}.new()" unless options && options[:name]
+
       @name = options[:name]
       @elements = options[:elements] || []
       @filter = options[:filter]
     end
-
   end
 end

data/lib/qfill/list_set.rb

@@ -1,29 +1,39 @@
-#popper = Qfill::ListSet.new(
+# frozen_string_literal: true
+
+# This is the base queues class for Popper queues and Pusher queues.
+#
+# popper = Qfill::ListSet.new(
 #  Qfill::List.new( :name => "High List",
 #                       :elements => [Thing1, Thing3],
 #                       :filter => filter1 ) )
 module Qfill
   class ListSet
-
     attr_accessor :queues, :current_index
 
     def initialize(*args)
-      raise ArgumentError, "Missing required arguments for #{self.class}.new(queues)" unless args.length > 0
+      raise ArgumentError, "Missing required arguments for #{self.class}.new(queues)" unless args.length.positive?
+
       @queues = args
       @current_index = 0
     end
 
     def [](key)
-      return self.queues.find { |queue| queue.name == key }
+      queues.find { |queue| queue.name == key }
+    end
+
+    def index_of(queue_name)
+      index = queues.index { |queue| queue.name == queue_name }
+      return index if index
+
+      raise Qfill::Errors::InvalidIndex, "Cannot locate index of #{queue_name}"
     end
 
     def reset!
       self.current_index = 0
     end
 
-    def get_total_elements
-      self.queues.inject(0) {|counter, queue| counter += queue.elements.length}
+    def count_all_elements
+      queues.inject(0) { |counter, queue| counter += queue.elements.length }
     end
-
   end
 end