merginator 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d2fea30ed75731053fb8a668dfde25de0b0bfa56b091020d68a0878dbc74ac4
-  data.tar.gz: 478433d62ff8943e02dcb1affa790868d0d93bc45292c374c10fbc84e6bf44a5
+  metadata.gz: cec09691fc1e5abd0eb16409a89002e835b565c1f030235d58e01143a090419a
+  data.tar.gz: 84dc992b1e3567c82ef5d53d280d8708105a81186d71b4adc592d1284d75fec4
 SHA512:
-  metadata.gz: 91709f61f93ae9b2296a935d06fdf69d6f8c8722ee91546d87329faa20a95e56be5b3d8fe4d62c6fcf8f7d55df41dfc5740d743a04097332d71cae1779f3e3f8
-  data.tar.gz: 04004fb039e34a98ee2803f7d33da2d3654d280929299fd2121c11455992441183da5c6f55be3e8e51d5a9494e35158313ff9c57ed1a3231ef3af3b5971632c6
+  metadata.gz: 4238899209c3d5fbf18a3f4d72ff0167ac0d4218f338f9ae09ef78cc798e9798456729d41ebcadd3fa01df75b0758fcf5096af3e3b4ba3eb1db024f2a0b06eb0
+  data.tar.gz: e1b1b285d7dee050ab08a2100794f82a0a993ac40f26dc12af30c98f04ab5cd2c1d4e1e6edf56ff595844490d44fda3d648edb7db2bab19dad761247729086b6

data/.rubocop.yml

@@ -5,6 +5,9 @@ require:
 AllCops:
   TargetRubyVersion: 2.7.8
   NewCops: enable
+  Exclude:
+    - 'Steepfile'
+    - 'vendor/**/*'
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.2.2] - 2023-06-30
+
+- Updating ignore total behavior to actually ignore total when validating
+
+## [0.2.1] - 2023-06-27
+
+- Configuration change version bump
+
+## [0.2.0] - 2023-06-27
+
+- Updating configuration
+- Improving functionality based on usage
+
 ## [0.1.1] - 2023-06-26
 
 - Updating README

data/Gemfile

@@ -8,8 +8,8 @@ gemspec
 gem 'rake'
 
 gem 'minitest'
-
-gem 'rubocop'
+gem 'rubocop', require: false
 gem 'rubocop-minitest', require: false
 gem 'rubocop-rake', require: false
-gem 'rbs', require: false
+gem 'simplecov', require: false
+gem 'steep', require: false

data/Gemfile.lock

@@ -1,13 +1,30 @@
 PATH
   remote: .
   specs:
-    merginator (0.1.1)
+    merginator (0.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.5.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    csv (3.2.7)
+    docile (1.3.5)
+    ffi (1.15.5)
+    fileutils (1.7.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
     minitest (5.18.1)
     parallel (1.23.0)
     parser (3.2.2.3)
@@ -16,11 +33,15 @@ GEM
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rbs (3.1.0)
     regexp_parser (2.8.1)
     rexml (3.2.5)
-    rubocop (1.52.1)
+    rubocop (1.53.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
@@ -36,6 +57,33 @@ GEM
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.2.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    steep (1.4.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.2.2)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
@@ -45,10 +93,11 @@ DEPENDENCIES
   merginator!
   minitest
   rake
-  rbs
   rubocop
   rubocop-minitest
   rubocop-rake
+  simplecov
+  steep
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,4 +1,4 @@
-# Merginator
+# Merginator [![Gem Version](https://badge.fury.io/rb/merginator.svg)](https://badge.fury.io/rb/merginator) ![Build Status](https://github.com/RyanVerhey/merginator/actions/workflows/main.yml/badge.svg?branch=main)
 
 Easily merge collections with a simple API!
 
@@ -6,11 +6,11 @@ Easily merge collections with a simple API!
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add Merginator
+    $ bundle add merginator
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install Merginator
+    $ gem install merginator
 
 ## Usage
 

data/Rakefile

@@ -13,4 +13,20 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+namespace :test do
+  desc 'Run all tests: tests, rubocop, and steep'
+  task :all do
+    Rake::Task['test'].execute
+    Rake::Task['rubocop'].execute
+    Rake::Task['test:steep:check'].execute
+  end
+
+  namespace :steep do
+    desc 'Run steep check'
+    task :check do
+      sh 'steep', 'check'
+    end
+  end
+end
+
+task default: %i[test rubocop test:steep:check]

data/Steepfile

@@ -0,0 +1,5 @@
+target :merginator do
+  signature "sig"
+
+  check "lib"
+end

data/lib/merginator/pattern_merge.rb

@@ -7,33 +7,33 @@ module Merginator
   # first, 2 from the second, and one from the third. Also passing in the total,
   # or, an amount for a page
   class PatternMerge
-    attr_reader :pattern, :total, :counts
+    attr_reader :pattern, :total, :counts, :wrapper
 
-    def initialize(*pattern, total: nil)
+    def initialize(*pattern, total: nil, wrapper: [])
       @pattern = pattern
       validate_pattern
 
       @total = total
       validate_total
 
+      @wrapper = wrapper
+      validate_wrapper
+
       # Counts are helpful when you're looking for a particular length end result
       # and querying a database or index. If you're not, they're not needed.
-      @counts = generate_pattern_counts(@total) if @total
+      @counts = generate_pattern_counts(@total)
     end
 
-    def merge(*collections)
-      validate_merge_collections(collections)
+    def merge(*collections, wrapper: @wrapper, ignore_total: false)
+      validate_merge_collections(collections, ignore_total: ignore_total)
+      validate_wrapper wrapper
 
-      total = @total || collections.sum(&:size)
+      total_to_use = total_to_use(collections, ignore_total: ignore_total)
 
-      slices_for_collections = collections.map.with_index do |collection, index|
-        collection.each_slice(@pattern[index]).to_a
-      end
+      slices_for_collections = slice_collections(collections)
+      merge_collections_into_wrapper(slices_for_collections, wrapper: wrapper, total: total_to_use)
 
-      slices_for_collections.map(&:size).max.times.each_with_object([]) do |index, arr|
-        arr << slices_for_collections.map { |slices| slices[index] || [] }.flatten
-        break(arr) if arr.flatten.size >= total
-      end.flatten.take(total)
+      wrapper
     end
 
     private
@@ -44,6 +44,8 @@ module Merginator
     # Merginator::Mergifier::PatternMerge.new(4, 2, 1, total: 25)
     # => [16, 6, 3]
     def generate_pattern_counts(total)
+      return unless total
+
       full_repetitions = total / @pattern.sum
       counts = @pattern.map { |num| num * full_repetitions }
 
@@ -57,27 +59,55 @@ module Merginator
       counts
     end
 
+    def slice_collections(collections)
+      collections.map.with_index do |collection, index|
+        collection.each_slice(@pattern[index]).to_a
+      end
+    end
+
+    def merge_collections_into_wrapper(slices_for_collections, wrapper:, total:)
+      slices_for_collections.map(&:size).max.to_i.times.each_with_object(wrapper) do |index, wrapper_obj|
+        wrapper_obj.concat slices_for_collections.map { |slices| slices[index] || [] }.flatten
+        break(wrapper_obj) if wrapper_obj.size >= total
+      end
+
+      wrapper.replace wrapper.take(total)
+    end
+
+    def total_to_use(collections, ignore_total: false)
+      !@total || ignore_total ? collections.sum(&:size) : @total.to_i
+    end
+
     def validate_pattern
       raise ArgumentError, 'there must be more than one collection in the pattern' if @pattern.count <= 1
       raise ArgumentError, 'pattern must be all integers' unless @pattern.all? { |n| n.is_a? Integer }
     end
 
     def validate_total
-      raise ArgumentError, 'total must be at least 1' if @total && @total < 1
+      return if (@total || 1).positive?
+
+      raise ArgumentError, 'total must be at least 1'
     end
 
-    def validate_merge_collections(collections)
+    def validate_merge_collections(collections, ignore_total: false)
       unless @pattern.count == collections.count
         message = 'number of collections must match pattern; '
         message += "expected #{@pattern.count} collections, actual: #{collections.count}"
         raise ArgumentError, message
       end
 
-      if @total && collections.flatten.count < @total
-        message = 'total number of elements in collections must be >= provided total; '
-        message += "expected #{@total} elements, actual: #{collections.flatten.count}"
-        raise ArgumentError, message
-      end
+      total_to_use = total_to_use(collections, ignore_total: ignore_total)
+      return if collections.sum(&:size) >= total_to_use
+
+      message = 'total number of elements in collections must be >= provided total; '
+      message += "expected #{@total} elements, actual: #{collections.flatten.count}"
+      raise ArgumentError, message
+    end
+
+    def validate_wrapper(wrapper = @wrapper)
+      return if wrapper.is_a?(Array)
+
+      raise ArgumentError, 'wrapper must be like an array'
     end
   end
 end

data/lib/merginator/version.rb

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

data/lib/merginator.rb

@@ -5,8 +5,6 @@ require_relative 'merginator/pattern_merge'
 
 # Contains top-level namespace code
 module Merginator
-  class Error < StandardError; end
-
   def self.pattern_merge(...)
     PatternMerge.new(...)
   end

data/merginator.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/merginator/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'merginator'
+  spec.version = Merginator::VERSION
+  spec.authors = ['Ryan Verhey']
+  spec.email = ['ryan@ryanverhey.com']
+
+  spec.summary = 'Merging collections based on a pattern.'
+  spec.description = 'Merge 2 or more collections based on a repeating pattern.'
+  spec.homepage = 'https://github.com/RyanVerhey/merginator'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.8'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/RyanVerhey/merginator'
+  spec.metadata['changelog_uri'] = 'https://github.com/RyanVerhey/merginator/blob/main/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|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|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
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,18 @@
+---
+sources:
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: 87fba082504c606c03edf724cdf2e119bcd46c8c
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,20 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true

data/sig/pattern_merge.rbs

@@ -0,0 +1,25 @@
+# See the writing guide of rbs: https://github.com/ruby/rbs#guides
+type wrapper = Array[untyped]
+type collection = Array[untyped]
+type total = Integer?
+
+class Merginator::PatternMerge
+  attr_reader pattern: Array[Integer]
+  attr_reader total: total
+  attr_reader counts: Array[Integer]?
+  attr_reader wrapper: wrapper
+
+  def initialize: (*Integer, ?total: total, ?wrapper: wrapper) -> void
+  def merge: (*collection, ?wrapper: wrapper, ?ignore_total: bool) -> wrapper
+
+  private
+
+  def generate_pattern_counts: (total) -> Array[Integer]?
+  def slice_collections: (Array[collection]) -> Array[Array[untyped]]
+  def merge_collections_into_wrapper: (Array[Array[untyped]], wrapper: wrapper, total: Integer) -> wrapper
+  def total_to_use: (Array[collection], ?ignore_total: bool) -> Integer
+  def validate_pattern: () -> void
+  def validate_total: () -> void
+  def validate_merge_collections: (Array[collection], ?ignore_total: bool) -> void
+  def validate_wrapper: (?wrapper) -> void
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merginator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ryan Verhey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies: []
 description: Merge 2 or more collections based on a repeating pattern.
 email:
@@ -26,11 +26,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - lib/merginator.rb
 - lib/merginator/pattern_merge.rb
 - lib/merginator/version.rb
-- sig/mergifier/pattern_merge.rbs
+- merginator.gemspec
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - sig/merginator.rbs
+- sig/pattern_merge.rbs
 homepage: https://github.com/RyanVerhey/merginator
 licenses:
 - MIT

data/sig/mergifier/pattern_merge.rbs

@@ -1,15 +0,0 @@
-# See the writing guide of rbs: https://github.com/ruby/rbs#guides
-class Merginator::PatternMerge
-  @pattern: Array[Integer]
-  @total: Integer
-  @counts: Array[Integer]?
-
-  def merge: (*Enumerable[untyped]) -> Array[untyped]
-
-  private
-
-  def generate_pattern_counts: (Integer) -> Array[Integer]
-  def validate_pattern: () -> void
-  def validate_total: () -> void
-  def validate_merge_collections: (*Enumerable[untyped]) -> void
-end