flex-cartesian 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da0e2d7afc6efca08b21663c3a4d7e80a924fb1707b02aae11c866a515fc067
-  data.tar.gz: dfd7f4fb1f71ec9ed4f469831a3efca245e43fe379fc7af51b6a708842906bdf
+  metadata.gz: 365e591e60a0c174cbfec4f2b80cf1e6f2cd6e2c57b27be341fc16bf10a6ac98
+  data.tar.gz: 86030f2e3c14e8bb2e9042bcf6b639211ab65a24095d158c15f002047d7d3c99
 SHA512:
-  metadata.gz: 5afd71db98e0446c6e32478ec41db552811d68b3e40b915d34193c7d6ca9065ab19ebe154612886fa755074ace224b8db6799a9657710ca658af64671f4fc327
-  data.tar.gz: 49affdbb1e79d165f51f4e1698d3948dfb5e0e3de543711f39696cf0a7ab5bb355f8cb35eb98d7cfd64cfd69db228a473744de27e647e61a6ebbf6bd01a0aada
+  metadata.gz: 69e18d211995c7f5f5325fe0146bcf580bcbee923444aa524ec8ac13e773264d8b3fe66f8dcaed84f2b29409c9b089b00d5f4a19f7f0b74fbf25f8ed3936ba16
+  data.tar.gz: 2395bf3d93663c0d39ea8126498b68c8e02f805ee2183387071f278f1bf8bddf44822ac80ff41bce33e88732959ff9c79017ceeea69f19609b1818e2fdf86d3f

data/README.md

@@ -24,10 +24,10 @@
 
 ## Installation
 
-Install dependencies:
-
 ```bash
 bundle install
+gem build flex-cartesian.gemspec
+gem install flex-cartesian-*.gem
 ```
 
 ## Usage
@@ -77,6 +77,108 @@ s.output(format: :markdown, align: true)
 s.output(format: :csv)
 ```
 
+## API Overview
+
+### Initialization
+```ruby
+FlexCartesian.new(dimensions_hash)
+```
+- `dimensions_hash`: a hash with named dimensions; each value can be an `Enumerable` (e.g., arrays, ranges).
+
+Example:
+```ruby
+dimensions = {
+  dim1: [1, 2],
+  dim2: ['x', 'y'],
+  dim3: [true, false]
+}
+
+FlexCartesian.new(dimensions)
+```
+
+---
+
+### Iterate Over All Combinations
+```ruby
+# With block
+cartesian(dims = nil, lazy: false) { |vector| ... }
+
+# Without block: returns Enumerator
+cartesian(dims = nil, lazy: false)
+```
+- `dims`: optional dimensions hash (default is the one provided at initialization).
+- `lazy`: if true, returns a lazy enumerator.
+
+Each combination is passed as a `Struct` with fields matching the dimension names:
+```ruby
+s.cartesian { |v| puts "#{v.dim1} - #{v.dim2}" }
+```
+
+---
+
+### Count Total Combinations
+```ruby
+size(dims = nil) → Integer
+```
+Returns the number of possible combinations.
+
+---
+
+### Convert to Array
+```ruby
+to_a(limit: nil) → Array
+```
+- `limit`: maximum number of combinations to collect.
+
+---
+
+### Iterate with Progress Bar
+```ruby
+progress_each(dims = nil, lazy: false, title: "Processing") { |v| ... }
+```
+Displays a progress bar using `ruby-progressbar`.
+
+---
+
+### Print Table to Console
+```ruby
+output(
+  separator: " | ",
+  colorize: false,
+  align: false,
+  format: :plain  # or :markdown, :csv
+  limit: nil
+)
+```
+Prints all combinations in table form (plain/markdown/CSV).  
+Markdown example:
+```
+| dim1 | dim2 |
+|------|------|
+|  1   | "a"  |
+|  2   | "b"  |
+```
+
+---
+
+### Load from JSON or YAML
+```ruby
+FlexCartesian.from_json("file.json")
+FlexCartesian.from_yaml("file.yaml")
+```
+
+---
+
+### Output from Vectors
+Each yielded combination is a `Struct` extended with:
+```ruby
+output(separator: " | ", colorize: false, align: false)
+```
+Example:
+```ruby
+s.cartesian { |v| v.output(colorize: true, align: true) }
+```
+
 ## License
 
 This project is licensed under the terms of the GNU General Public License v3.0.  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flex-cartesian
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Yury Rassokhin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-02 00:00:00.000000000 Z
+date: 2025-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -52,26 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: |
-  Flexible and human-friendly Cartesian product enumerator for Ruby.
-  Supports dimension-agnostic iteration, named dimensions, structured output,
+description: Supports dimension-agnostic iterators, named dimensions, tabular output,
   lazy/eager evaluation, progress bar, JSON/YAML loading, and export to Markdown/CSV.
-
-  Code example: https://github.com/Yuri-Rassokhin/flex-cartesian/blob/main/README.md#usage
 email:
 - yuri.rassokhin@gmail.com
 executables: []