ocg 1.4.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa3d1a73808ebe1197e76243c66e4d00b0220c4bbe398e2fcf11e1f58c0f243
-  data.tar.gz: 8709140dacba810330d6ec2b4889002e0a432a1acd4e5af3767ed3a91cded7a4
+  metadata.gz: 45e7d61cdd0972c7916e79ea804cfed5c6cdf03abc8748a250026d21f2af3301
+  data.tar.gz: 692aff9f1133bc0498ee29a4d14f827cd87d60f0d5a91747a6dc110ec30ad018
 SHA512:
-  metadata.gz: 374148f48f17496aa4d6c572c6e091d08f12b79a8bc1172c2605cb91d30bc1e9a70bda8591fc28e96b1445895c17c930f9dff0b96e5c0460a98d3ed67a9e8b3a
-  data.tar.gz: 1f403b651a77e2b905543008ba198ddbf6ac6eb02dac413de5aab076458d2386815b6c6baf42b77025790273d108e0ba3b13649c7a56ea49e2940dd6245f9a04
+  metadata.gz: 7543c7ae5777f111d5bd962437c5febffc0b23ea3310063be99a1319ab6523e23a67f7e58222fc4e694905d0e027eb9edd88784545ab7e2bab0e783d56a3c3f6
+  data.tar.gz: 30a95c0daf0cb9794a7827f16f3f701b589e01b4841d6a95cdacea0de208a362c8792a7c80c37a727808ea6acfe7b14449ad33a6b00a49990edd0a73b7e94252

data/README.md

@@ -1,12 +1,12 @@
 # Option combination generator
 
-| AppVeyor | Circle | Github Actions | Codecov | Gem |
-| :------: | :----: | :------------: | :-----: | :-: |
-| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ocg?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ocg/branch/master) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ocg/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ocg/tree/master) | [![Github Actions test status](https://github.com/andrew-aladev/ocg/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ocg/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ocg/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ocg) | [![Gem](https://img.shields.io/gem/v/ocg.svg)](https://rubygems.org/gems/ocg) |
+| AppVeyor | Jenkins | Github Actions | Codecov | Gem |
+| :------: | :-----: | :------------: | :-----: | :-: |
+| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ocg?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ocg/branch/master) | [![Jenkins test status](http://37.187.122.190:58182/buildStatus/icon?job=ocg)](http://37.187.122.190:58182/job/ocg) | [![Github Actions test status](https://github.com/andrew-aladev/ocg/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ocg/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ocg/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ocg) | [![Gem](https://img.shields.io/gem/v/ocg.svg)](https://rubygems.org/gems/ocg) |
 
 ## Installation
 
-Operating systems: GNU/Linux, OSX, FreeBSD, Windows.
+Operating systems: GNU/Linux, OSX, FreeBSD.
 
 ```sh
 gem install ocg
@@ -50,6 +50,8 @@ It will populate all option combinations.
 
 ## Docs
 
+Please review [rdoc generated docs](https://andrew-aladev.github.io/ocg).
+
 `OCG.new options` will prepare a generator.
 It will provide all possible option combinations.
 

data/lib/ocg/copyable.rb

@@ -2,9 +2,11 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 class OCG
+  # OCG::Copyable module.
   module Copyable
     VARIABLES_TO_COPY = [].freeze
 
+    # Initializes copy of +source+ object using +VARIABLES_TO_COPY+ keys.
     def initialize_copy(source)
       self.class::VARIABLES_TO_COPY.each do |variable|
         key   = "@#{variable}".to_sym

data/lib/ocg/main.rb

@@ -7,38 +7,53 @@ require_relative "copyable"
 require_relative "error"
 require_relative "options"
 
+# OCG class.
 class OCG
   include Copyable
   include ::Enumerable
   extend ::Forwardable
 
-  DELEGATORS        = %i[reset next last started? finished? length].freeze
+  # Current delegators.
+  DELEGATORS = %i[reset next last started? finished? length].freeze
+
+  # Current variables to copy.
   VARIABLES_TO_COPY = %i[generator].freeze
 
+  # Define current delegators.
   def_delegators :@generator, *DELEGATORS
 
+  # Initializes options generator using +generator_or_options+.
+  # +generator_or_options+ may be +generator+ object or +options+.
+  # +options+ is a hash with values convertable to array.
   def initialize(generator_or_options = {})
     @generator = self.class.prepare_generator generator_or_options
   end
 
+  # Prepares options generator using +generator_or_options+.
+  # +generator_or_options+ may be +generator+ object or +options+.
+  # +options+ is a hash with values convertable to array.
   def self.prepare_generator(generator_or_options)
     return generator_or_options if generator_or_options.is_a? OCG
 
     Options.new generator_or_options
   end
 
+  # Adds +generator_or_options+ to current option combinations generator.
   def and(generator_or_options = {})
     Operator::AND.new self, generator_or_options
   end
 
+  # Mixes +generator_or_options+ with current option combinations generator.
   def mix(generator_or_options = {})
     Operator::MIX.new self, generator_or_options
   end
 
+  # Mixes +generator_or_options+ with current option combinations generator.
   def or(generator_or_options = {})
     Operator::OR.new self, generator_or_options
   end
 
+  # Processes each option combination.
   def each(&_block)
     instance = dup
     instance.reset

data/lib/ocg/operator/abstract.rb

@@ -5,9 +5,12 @@ require_relative "../error"
 
 class OCG
   module Operator
+    # OCG::Operator::Abstract class.
     class Abstract < OCG
       VARIABLES_TO_COPY = %i[left_generator right_generator].freeze
 
+      # Initializes operator using +left_generator_or_options+ and +right_generator_or_options+.
+      # Internaly object initializes left and right generators.
       def initialize(left_generator_or_options, right_generator_or_options) # rubocop:disable Lint/MissingSuper
         @left_generator  = OCG.prepare_generator left_generator_or_options
         @right_generator = OCG.prepare_generator right_generator_or_options
@@ -15,6 +18,7 @@ class OCG
         reset
       end
 
+      # Resets left and right generators specifically for options.
       def reset
         @left_generator.reset
         @right_generator.reset
@@ -22,6 +26,7 @@ class OCG
         nil
       end
 
+      # Merges results specifically for options.
       protected def merge_results(left, right)
         if left.nil?
           right

data/lib/ocg/operator/and.rb

@@ -5,7 +5,9 @@ require_relative "abstract"
 
 class OCG
   module Operator
+    # OCG::Operator::AND class.
     class AND < Abstract
+      # Get next option combination result.
       def next
         return nil if finished?
 
@@ -22,6 +24,7 @@ class OCG
         merge_results left, right
       end
 
+      # Get last option combination result.
       def last
         left  = @left_generator.last
         right = @right_generator.last
@@ -29,14 +32,17 @@ class OCG
         merge_results left, right
       end
 
-      def started?
-        @left_generator.started? || @right_generator.started?
-      end
-
+      # Is option combinations generation finished?
       def finished?
         @left_generator.finished? && @right_generator.finished?
       end
 
+      # Is option combinations generation started?
+      def started?
+        @left_generator.started? || @right_generator.started?
+      end
+
+      # Get options combination length.
       def length
         left_length  = @left_generator.length
         right_length = @right_generator.length

data/lib/ocg/operator/mix.rb

@@ -5,19 +5,23 @@ require_relative "abstract"
 
 class OCG
   module Operator
+    # OCG::Operator::MIX class.
     class MIX < Abstract
+      # Initializes current generators.
       def initialize(*args)
         super
 
         reset_main_generator
       end
 
+      # Initializes copy of current generators.
       def initialize_copy(*args)
         super
 
         reset_main_generator
       end
 
+      # Resets left or right generator based on internal state.
       def reset_main_generator
         @main_generator =
           if @right_generator.length > @left_generator.length
@@ -27,6 +31,7 @@ class OCG
           end
       end
 
+      # Get next option combination result.
       def next
         return nil if finished?
 
@@ -39,6 +44,7 @@ class OCG
         merge_results left, right
       end
 
+      # Get last option combination result.
       def last
         left  = @left_generator.last
         right = @right_generator.last
@@ -46,14 +52,17 @@ class OCG
         merge_results left, right
       end
 
-      def started?
-        @main_generator.started?
-      end
-
+      # Is option combinations generation finished?
       def finished?
         @main_generator.finished?
       end
 
+      # Is option combinations generation started?
+      def started?
+        @main_generator.started?
+      end
+
+      # Get options combination length.
       def length
         @main_generator.length
       end

data/lib/ocg/operator/or.rb

@@ -5,7 +5,9 @@ require_relative "abstract"
 
 class OCG
   module Operator
+    # OCG::Operator::OR class.
     class OR < Abstract
+      # Get next option combination result.
       def next
         return nil if finished?
 
@@ -16,6 +18,7 @@ class OCG
         end
       end
 
+      # Get last option combination result.
       def last
         left  = @left_generator.last
         right = @right_generator.last
@@ -27,14 +30,17 @@ class OCG
         end
       end
 
+      # Is option combinations generation started?
       def started?
         @left_generator.started? || @right_generator.started?
       end
 
+      # Is option combinations generation finished?
       def finished?
         @left_generator.finished? && @right_generator.finished?
       end
 
+      # Get option combinations length.
       def length
         @left_generator.length + @right_generator.length
       end

data/lib/ocg/options.rb

@@ -5,11 +5,15 @@ require_relative "copyable"
 require_relative "validation"
 
 class OCG
+  # OCG::Options class.
   class Options
     include Copyable
 
+    # Current variables to be copied.
     VARIABLES_TO_COPY = %i[options keys last_options value_indexes].freeze
 
+    # Initializes options using +options+ values.
+    # +options+ is a hash with values convertable to array.
     def initialize(options)
       Validation.validate_options options
       @options = options.transform_values(&:to_a)
@@ -24,10 +28,12 @@ class OCG
       @is_finished = length.zero?
     end
 
+    # Resets internal value indexes.
     protected def reset_value_indexes
       @value_indexes = @options.transform_values { |_values| 0 }
     end
 
+    # Resets current option combinations state.
     def reset
       return nil unless started?
 
@@ -41,10 +47,11 @@ class OCG
       nil
     end
 
+    # Get next option combination.
     def next
       return nil if @is_finished
 
-      @last_options = @value_indexes.map { |name, value_index| [name, @options[name][value_index]] }.to_h
+      @last_options = @value_indexes.to_h { |name, value_index| [name, @options[name][value_index]] }
 
       @is_finished = @keys.all? do |name|
         values          = @options[name]
@@ -63,18 +70,22 @@ class OCG
       @last_options
     end
 
+    # Get last option combination.
     def last
       @last_options
     end
 
+    # Is option combinations generation started?
     def started?
       !@last_options.nil?
     end
 
+    # Is option combinations generation finished?
     def finished?
       @is_finished
     end
 
+    # Get option combinations length.
     def length
       @options.reduce(0) do |length, (_name, values)|
         if length.zero?

data/lib/ocg/validation.rb

@@ -4,7 +4,11 @@
 require_relative "error"
 
 class OCG
+  # OCG::Validation module.
   module Validation
+    # Raises error when +options+ is not hash
+    #   and option values are not convertable to array
+    #   and option values are not empty.
     def self.validate_options(options)
       raise ValidateError, "invalid options hash" unless options.is_a? ::Hash
 

data/lib/ocg/version.rb

@@ -2,5 +2,6 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 class OCG
-  VERSION = "1.4.0".freeze
+  # Option combination generator version.
+  VERSION = "1.4.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocg
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,48 +66,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +173,8 @@ files:
 homepage: https://github.com/andrew-aladev/ocg
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -168,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Option combination generator.