bsielski_value_generator 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d6bf8e7eab4c6c2df03480e8fdf0fda7ae423ae2c3c521c2978f09e5d933b35
-  data.tar.gz: 2690611ff53b74df4303eb3d47185c6cbf811e9398e174e5a194cafdcf09d2f1
+  metadata.gz: 8d9a3b8d67dba32050aa9fa381fc01c5ab17271c6ab1fa32d9fab0edec461f1c
+  data.tar.gz: d245b33cc4b1ae56f6ce5b316be8bfe3bc77bbb510f654c8386eae56147b5b0b
 SHA512:
-  metadata.gz: 5c0cf9430f04c3c5de34dee49b520a4d350108b3ce175b98ca578d039db20c6435dec4eed2c594cb798dcd3773b0e1a0885d68715328458de8230a64e551c463
-  data.tar.gz: 805f87aa4a4447367ee1a132ca3addb59f159634cb0cf84938e9b58958df41c39774971ad47d285dea70725ad982d9f006d13a71ee9b943b6c7e48b88cbfbcc6
+  metadata.gz: 17f230e9f5ff70ae372c8b389056c6a000d1c2ff59344800f51ef514a2dffe1cc0e2493c8f00ad7ba140f0f87a50bb0d36737685b852c8c0ad20f635521bb96b
+  data.tar.gz: e67eed2246e46ce31c5e4314d1aa1a8b4bbf5e33656a0b7ad4a97906abec94c8403a339e0e78fdee537367775d8d2484d9fb97240291e098c560c8a45a73b67b

data/.rspec

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

data/README.md

@@ -45,250 +45,262 @@ int_gen = VGen::IntGen.new
 random_int = int_gen.call
 ```
 
-All generators have just one public method: `#call`.
-
+All generators have just one public method: ***#call***.
 
 
 ## API
 
 
-
-### VGen::IntGen
+### Class VGen::IntGen
 
 ```ruby
 require "v_gen/int_gen"
 ```
 
-#### Class Public Methods
-
-##### `new(range=(0..10)) → new_generator`
+#### Constructor
 
-*range* is the range from which the number is randomly generated.
+```ruby
+VGen::IntGen.new # => new_generator
+```
 
-#### Public Instance Methods
+Optionally paramaters:
 
-##### `call → new_int`
+  - **_range_** - is the range from which the number is randomly generated. Default is `(0..10)`.
+  
 
+#### Call
 
+```ruby
+VGen::IntGen.new.call # => new_int
+```
 
-### VGen::FloatGen
+### Class VGen::FloatGen
 
 ```ruby
 require "v_gen/float_gen"
 ```
+#### Constructor
 
-#### Class Public Methods
-
-##### `new(range=(-10..10)) → new_generator`
-
-See VGen::IntGen.new for details about *range* argument.
+```ruby
+VGen::FloatGen.new # => new_generator
+```
 
-#### Public Instance Methods
+Optionally paramaters:
 
-##### `call → new_float`
+  - **_range_** - is the range from which the number is randomly generated. Default is `(-10..10)`.
 
+#### Call
 
+```ruby
+VGen::FloatGen.new.call # => new_float
+```
 
-### VGen::LetterGen
+### Class VGen::LetterGen
 
 ```ruby
 require "v_gen/letter_gen"
 ```
 
-#### Class Public Methods
+#### Constructor
 
-##### `new(only: (("A".."Z").to_a + ("a".."z").to_a), except: []) → new_generator`
-
-*only* an array (or range) of objects from which one randomly chosen is returned.
-
-*except* an array (or range) that is substracted from *only* array (range).
+```ruby
+VGen::LetterGen.new # => new_generator
+```
 
-#### Public Instance Methods
+Optionally paramaters:
 
-##### `call → new_object`
+  - **_only:_** - an array (or range) of objects from which one randomly chosen is returned. Default is `("A".."Z").to_a + ("a".."z").to_a`.
+  - **_except:_** - an array (or range) that is substracted from **_only:_** array (or range). Default is `[]`.
 
+#### Call
 
+```ruby
+VGen::LetterGen.new.call # => new_letter
+```
 
-### VGen::LowerLetterGen
+### Class VGen::LowerLetterGen
 
 ```ruby
 require "v_gen/lower_letter_gen"
 ```
 
-#### Class Public Methods
-
-##### `new(only: ("A".."Z"), except: []) → new_generator`
-
-See VGen::LetterGen.new for details about *only* and *except* arguments.
-
-The object in *only* and *except* arrays or ranges must respond to `#downcase` method.
+#### Constructor
 
-#### Public Instance Methods
-
-##### `call → new_lowercased_object`
+```ruby
+VGen::LowerLetterGen.new # => new_generator
+```
 
+Optionally paramaters:
 
+  - **_only:_** - an array (or range) of objects from which one randomly chosen is returned. Default is `("A".."Z")` (those letters are downcased anyway by the class).
+  - **_except:_** - an array (or range) that is substracted from **_only:_** array (or range). Default is `[]`.
 
-#### Example
+#### Call
 
 ```ruby
-lower_letter_gen = VGen::LowerLetterGen.new(only: ("A".."Z"))
-lower_letter_gen.call # => "j"
-lower_letter_gen.call # => "e"
+VGen::LowerLetterGen.new.call # => new_lower_letter
 ```
 
+
 ### VGen::UpperLetterGen
 
 ```ruby
 require "v_gen/upper_letter_gen"
 ```
 
-#### Class Public Methods
+#### Constructor
 
-##### `new(only: ("A".."Z"), except: []) → new_generator`
-
-See VGen::LetterGen.new for details about *only* and *except* arguments.
-
-The object in *only* and *except* arrays or ranges must respond to `#upcase` method.
+```ruby
+VGen::UpperGen.new # => new_generator
+```
 
-#### Public Instance Methods
+Optionally paramaters:
 
-##### `call → new_uppercased_object`
+  - **_only:_** - an array (or range) of objects from which one randomly chosen is returned. Default is `("A".."Z")`.
+  - **_except:_** - an array (or range) that is substracted from **_only:_** array (or range). Default is `[]`.
 
-#### Example
+#### Call
 
 ```ruby
-upper_letter_gen = VGen::UpperLetterGen.new(only: ("A".."Z"))
-upper_letter_gen.call # => "I"
-upper_letter_gen.call # => "D"
+VGen::UpperLetterGen.new.call # => new_upper_letter
 ```
 
 
+### Class VGen::TypicalLetterGen
 
-### VGen::TypicalLetterGen
+This generator returns random lower letters with with taking into account the frequency of occurrence in English language.
 
 ```ruby
 require "v_gen/typical_letter_gen"
 ```
 
-#### Class Public Methods
+#### Constructor
 
-##### `new → new_generator`
-
-#### Public Instance Methods
+```ruby
+VGen::TypicalLetterGen.new # => new_generator
+```
 
-##### `call → new_letter`
+#### Call
 
-It returns a random lowercased letter with taking into account the frequency of occurrence in English language.
+```ruby
+VGen::TypicalLetterGen.new.call # => new_letter
+```
 
 
+### Class VGen::VarWordGen
 
-### VGen::VarWordGen
+This generator returns random lowercased strings sometimes with underscore in the middle of the string.
 
 ```ruby
 require "v_gen/var_word_gen"
 ```
 
-#### Class Public Methods
-
-##### `new(letter_gen: TypicalLetterGen.new, lenght: (4..9), except: []) → new_generator`
-
-*letter_gen* is a generator used to creating a letters for words.
+#### Constructor
 
-*length* possible word length as a range.
+```ruby
+VGen::VarWordGen.new # => new_generator
+```
 
-*except* words forbidden to generate.
+Optionally paramaters:
 
-#### Public Instance Methods
+  - **_letter_gen:_** - is a generator used to creating a letters for words. Default is `VGen::TypicalLetterGen.new`.
+  - **_length:_** - possible word length as a range (for random length) or an int (for fixed length).
+  - **_except:_** - words forbidden to generate. Default is `[]`.
 
-##### `call(lenght: (4..9), except: []) → new_random_word`
+#### Call
 
-It returns a random lowercased word sometimes with underscore in the middle.
+```ruby
+VGen::VarWordGen.new.call # => new_word
+```
 
 
+### Class VGen::KeywordGen
 
-### VGen::KeywordGen
+This generator returns random lowercased symbols sometimes with underscore in the middle of the string.
 
 ```ruby
 require "v_gen/keyword_gen"
 ```
 
-#### Class Public Methods
+#### Constructor
 
-##### `new(word_gen: VarWordGen.new) → new_generator`
-
-*word_gen* is a generator used to creating a word that will be converted to a symbol.
+```ruby
+VGen::KeywordGen.new # => new_generator
+```
 
-#### Public Instance Methods
+Optionally paramaters:
 
-##### `call → new_random_word`
+  - **_word_gen:_** - is a generator used to creating a string, which is converted into a symbos. Default is `VGen::VarWordGen.new`.
 
-It returns a random lowercased word sometimes with underscore in the middle.
+#### Call
 
+```ruby
+VGen::KeywordGen.new.call # => new_keyword
+```
 
+### Class VGen::ArrayGen
 
-### VGen::ArrayGen
+This generator returns an array of random values.
 
 ```ruby
 require "v_gen/array_gen"
 ```
 
-#### Class Public Methods
-
-##### `new(min: 4, max: 8, gens: [proc {Random.new.rand}]) → new_generator`
+#### Constructor
 
-*min* is a minimum size of a generated arrays.
-
-*max* is a maximum size of a generated arrays.
+```ruby
+VGen::ArrayGen.new # => new_generator
+```
 
-*gens* are generators used randomly to generate values.
+Optionally paramaters:
 
-#### Public Instance Methods
+  - **_min:_** - is a minimum size of a generated arrays. Default is `4`.
+  - **_max:_** - is a maximum size of a generated arrays. Default is `9`.
+  - **_length:_** - possible array length as a range (for random length) or an int (for fixed length).
+  - **_size:_** - alias for **_length:_**.
+  - **_gens:_** - are generators used randomly to generate values. Default is `[ proc {Random.new.rand} ]`.
+  - **_uniq:_** - if truthy then generated arrays have unique elements. Default is `false`.
 
-##### `call → new_random_word`
+#### Call
 
-It returns an array of  random values.
+```ruby
+VGen::ArrayGen.new.call # => new_array
+```
 
 
+### Class VGen::HashGen
 
-### VGen::HashGen
+This generator returns a hash of random keys and values.
 
 ```ruby
 require "v_gen/hash_gen"
 ```
 
-#### Class Public Methods
-
-##### `new(min: 4, max: 8, key_gens: [proc {Random.new.rand(0..100)}], value_gens: [proc {Random.new.rand}]) → new_generator`
-
-*min* is a minimum size of a generated arrays.
-
-*max* is a maximum size of a generated arrays.
-
-*key_gens* are generators used randomly to generate keys.
-
-*value_gens* are generators used randomly to generate values.
-
-#### Public Instance Methods
-
-##### `call → new_random_word`
-
-It returns a hash of random keys and values.
-
-
+#### Constructor
 
+```ruby
+VGen::HashGen.new # => new_generator
+```
 
+Optionally paramaters:
 
+  - **_min:_** - is a minimum size of a generated hashes. Default is `4`.
+  - **_max:_** - is a maximum size of a generated hashes. Default is `8`.
+  - **_length:_** - possible hash length as a range (for random length) or an int (for fixed length).
+  - **_size:_** - alias for **_length:_**.
+  - **_key_gens:_** - are generators used randomly to generate keys. Default is `[ proc {Random.new.rand(0..100)} ]`.
+  - **_value_gens:_** - are generators used randomly to generate values. Default is `[ proc {Random.new.rand} ]`.
+  - **_with:_** - is a hash that must be included in the generated hash. In other words it is a obligatory set of key and values pairs. Default is `{}`.
 
-## To do features
+#### Call
 
-- Better API
-- Some easy to use generators with default parameters
+```ruby
+VGen::HashGen.new.call # => new_array
+```
 
 ## To do features
 
-- Better API
-- Some easy to use generators with default parameters
+  - Some easy to use generators with default parameters
 
 ## License
 

data/lib/bsielski_v_gen/array_gen.rb

@@ -1,20 +1,42 @@
 module VGen
   class ArrayGen
     def initialize(
+          uniq: false,
           min: 4,
-          max: 8,
+          max: 9,
+          length: nil,
+          size: nil,
           gens: [ proc {Random.new.rand} ]
         )
+      @uniq = uniq
+      @length = length || size || (min..max)
       @gens = gens
       @min = min
       @max = max
     end
 
     def call()
-      arr = Array.new(Random.new.rand(@min..@max)) {
-        @gens.sample
+      used_values = []
+      Array.new(array_length) {
+        loop do
+          candidate_value = @gens.sample.call
+          if used_values.include?(candidate_value)
+            next
+          else
+            used_values << candidate_value if @uniq
+            break candidate_value
+          end
+        end
       }
-      arr.map(&:call)
+    end
+        
+    private
+
+    def array_length
+      length = Random.new.rand(@length) if @length.is_a? Range
+      length = @length if @length.is_a? Integer
+      raise "length (size) can't be negative" if length < 0
+      length
     end
   end
 end

data/lib/bsielski_v_gen/hash_gen.rb

@@ -1,11 +1,16 @@
 module VGen
   class HashGen
     def initialize(
+          with: {},
           min: 4,
           max: 8,
+          length: nil,
+          size: nil,
           key_gens:   [ proc {Random.new.rand(0..100)} ],
           value_gens: [ proc {Random.new.rand} ]
         )
+      @with = with
+      @length = length || size || (min..max)
       @key_gens = key_gens
       @value_gens = value_gens
       @min = min
@@ -13,23 +18,35 @@ module VGen
     end
     
     def call()
-      length = Random.new.rand(@min..@max)
+      with_length = @with.length
       hash = Hash[
-        Array.new(length) do
+        Array.new(hash_length - with_length) do
           [
             @key_gens.sample.call,
             @value_gens.sample.call
           ]
         end
       ]
-      while hash.size < length do
-        hash = hash.merge(
-          {
-            @key_gens.sample.call => @value_gens.sample.call
-          }
-        )
+      unless @with.empty?
+        hash.merge!(@with)
+      end
+      while hash.size < hash_length do
+        new_pair =  {
+          @key_gens.sample.call => @value_gens.sample.call
+        }
+        hash = new_pair.merge(hash)  
       end
+      hash = hash.to_a.shuffle.to_h unless @with.empty?
       hash
     end
+
+    private
+
+    def hash_length
+      length = Random.new.rand(@length) if @length.is_a? Range
+      length = @length if @length.is_a? Integer
+      raise "length (size) can't be negative" if length < 0
+      length
+    end
   end
 end

data/lib/bsielski_v_gen/var_word_gen.rb

@@ -4,18 +4,20 @@ module VGen
   class VarWordGen
     def initialize(
           letter_gen: TypicalLetterGen.new,
-          length: (4..9),
+          length: nil,
+          size: (4..9),
           except: []
         )
-      @length = length
+      @length = length || size
       @letter_gen = letter_gen
       @except = except
     end
 
     def call()
+      
       loop do
         word = Array.new(
-          Random.new.rand(@length),
+          word_length,
           @letter_gen
         ).map(&:call).join
         if word.size > 2
@@ -26,5 +28,14 @@ module VGen
         return word unless @except.include? word
       end
     end
+    
+    private
+
+    def word_length
+      length = Random.new.rand(@length) if @length.is_a? Range
+      length = @length if @length.is_a? Integer
+      raise "length (size) can't be negative" if length < 0
+      length
+    end
   end
 end

data/lib/bsielski_v_gen/version.rb

@@ -1,3 +1,3 @@
 module VGen
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bsielski_value_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Bartłomiej Sielski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler