radagen 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb56ff6848be1ab3ca322e0c45067323eba296f6
-  data.tar.gz: 83a447038d9980169a5d206f17e083721ef40890
+  metadata.gz: 896666612f1a2920da3ae25a99e8923ac952a10e
+  data.tar.gz: cd19cde8c568b367a79278fc419696780cba5896
 SHA512:
-  metadata.gz: c0f94c3d19faf7cc4fe6e2fb1fd4b154289fb3ce21ac4bb12056297f54ce2a9c5cf1b9e147bb13bad35ee607a8b143b85b9bccd2554e02e2f58caac0fe837fc2
-  data.tar.gz: 3f29be3edea5dd05fe6586247f591b358d6a61b15f68e654459a4a8cfefcce687ed41971ea77f9806aec4a16107a0825383026596562d764a12fefcce8d7876b
+  metadata.gz: ca65d99d4dd0cd6795c58043e2b625014fc60ba70cdbc4009f7ee29cbfc36fd63c84a271b6e2050438322ba7d425cae71be3dd9716a34390df58dae5f5204075
+  data.tar.gz: f09efadae15a5b844e0ceb478e2f37ddf9db80a8301f789a18cfbe4bb97e0c6c69335be5bac5bd163ffc747c14e2069527f6bacb4c678a471628153c38f7fe17

data/.travis.yml

@@ -8,4 +8,5 @@ rvm:
   - 2.2.6
   - 2.3.4
   - 2.4.1
-before_install: gem install bundler -v 1.12.5
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/README.md

@@ -1,6 +1,7 @@
 # Radagen
 
 [![Build Status](https://travis-ci.org/smidas/radagen.svg?branch=master)](https://travis-ci.org/smidas/radagen)
+[![Gem Version](https://badge.fury.io/rb/radagen.svg)](https://badge.fury.io/rb/radagen)
 
 Radagen is a psuedo random data generator library for the Ruby language built with two primary design goals: *composition* and *sizing*. These two properties allow this library to be used in a range of different applications from simple test data generation, model checking, fuzz testing, database seeding to the foundation of a generative/property based testing framework.
 
@@ -23,11 +24,13 @@ Or install it yourself as:
 
     $ gem install radagen
 
-## API Documentation
+## Documentation
+
+[Lastest Release API](http://www.rubydoc.info/gems/radagen)
 
 ## Usage
 
-The main use case for Radagen is to create data generators that produce arbitrarily complex values. These generators can then be used in many different contexts. Lets start with a few of the `scalar` generators provided by Radagen.
+The main use case for Radagen is to create data generators that produce arbitrarily complex values. These generators can then be used in many different contexts. Let's start with a few of the `scalar` generators provided by Radagen.
 
 ```ruby
 require 'radagen'
@@ -37,14 +40,14 @@ my_fixnum = gen.fixnum
 my_string = gen.string_alphanumeric
 ```
 
-So far we required the Radagen gem and "namespaced" the Radagen module to `gen`. Throughout the rest of this documentation it will be assume `Radagen` is namespaced to `gen`. Let's take look at what values these generators can produce.
+So far we required the Radagen gem and "namespaced" the Radagen module to `gen`. Throughout the rest of this documentation it will be assumed `Radagen` is namespaced to `gen`. Let's take look at what values these generators produce.
 
 ```ruby
 my_fixnum.sample => [0, 0, -1, 1, -3, -4, -5, -1, -2, -7]
 my_string.sample => ["", "", "jV", "", "7zS", "2", "U9O84Q", "4S", "6Ccw66", "0Sip741V"]
 ```
 
-`sample` above is a utility method on the `Radagen::Generator` object that allows you to interact with your generator seeing what type of values it will produce. As shown above `sample` returns a sampling of 10 values by default. You can change this number sampled by providing a count.
+`sample` above is a utility method on the `Radagen::Generator` object that allows you to interact with your generator seeing what type of values it will produce. As shown above `sample` returns a sampling of 10 values by default. You can also provide a count.
 
 ```ruby
 my_string.sample(30) =>  ["",
@@ -79,14 +82,14 @@ my_string.sample(30) =>  ["",
                           "9QbchgbZtY7C57Eq"]
 ```
 
-There is something to be noticed about the values produced by `my_string` generator. The values grow in *size* and *complexity* because as `sample` calls the generator it passes a larger and larger *size* value. This is a very important aspect of all Radagen generators and will be detailed further in `sizing`.
+Notice the values produced by `my_string` generator. They grow in *size* and *complexity* because as `sample` calls the generator, it passes a larger and larger *size* value. This is a very important aspect of all Radagen generators and will be detailed further in `sizing`.
 
 ### Composition
 
 `scalar` generators are interesting but can only take you so far. We now will explore the ideas around composition. Lets build on the previous generators.
 
 ```ruby
-my_hash = gen.hash(:fixnum => my_fixnum, :string => my_strings)
+my_hash = gen.hash(:fixnum => my_fixnum, :string => my_string)
 my_hash.sample => [{:fixnum=>0, :string=>""},
                    {:fixnum=>1, :string=>"9"},
                    {:fixnum=>-1, :string=>"1"},
@@ -151,7 +154,7 @@ end
 email_account.sample => ["@gmail.com", "r@gmail.com", "U@gmail.com", "mj@gmail.com", "z^@mailinator.com", "B_@mailinator.com", "(t-f;@gmail.com", "@gmail.com", ")3-@mailinator.com", "n@mailinator.com"]
 ```
 
-Lets walk thru the above example. `elements` will randomly select an element from the array you pass it (ex. 'gmail.com' or 'mailinator.com'). `string_ascii` will produce strings containing the *ascii* band of characters. `fmap` will take values from a generator, which in this case was a two `tuple` with the first value taken from the *name* generator and the second taken from the *domain* generator, and passes those values to a `block`. Within the block we do some destructuring to the tuple and with string interpolation we return an email account string. Note the block passed to `fmap` requires you return a *value* NOT another generator.
+`elements` will randomly select an element from the array you pass it (ex. 'gmail.com' or 'mailinator.com'). `string_ascii` will produce strings containing the *ascii* band of characters. `fmap` will take values from a generator, which in this case was a two `tuple` with the first value taken from the *name* generator and the second taken from the *domain* generator, and passes those values to a `block`. Within the block we do some destructuring to the tuple and with string interpolation we return an email account string. Note the block passed to `fmap` requires you return a *value* NOT another generator.
 
 The first example you noticed has an *empty* name which isn't a valid email address. We see our first example of how a 'stocastic' like tool can challenge our assumptions, or at least forces you to consider the domain you are working a little deeper.
 
@@ -217,13 +220,13 @@ You can also leverage the `to_enum` method which will return an enumerable repre
 Sizing provides the ability for a generator to produce values of varying degrees of well, *size*. Size has different meaning depending on the context of the generator being used. In some cases generators don't honor the size parameter at all. Examples being `uuid` and `identity`. When a generator is called to produce a value the *size* that is passed in represents the *upper bound* of all possible sizes starting from zero that could be generated. Why? This is so that methods like `to_enum`, `sample` and `gen` don't return a predictable linear growth of values as they are passed ever increasing size values. It is also why this library and libraries like it seem to have the ability to walk thru progressively more complex values "randomly", perhaps challenging boundary assumptions of a model.
 
 ```ruby
-5.times { p gen.fixnum.gen(size: 2) } => 2 0 -1 1 -2
+5.times { p gen.fixnum.gen(2) } => 2 0 -1 1 -2
 
-5.times { p gen.string.gen(size: 300) } => "oysO930W8B4QU02J05qEWPn6R6H7xTZKFGbG6Hpo28b"
-                                           "R021N1tw0927BXZP7GbzgRE4rA5t46785g27jsztMRlaz571XzHoi6yBv22ec97194yByN3KIYM3EX1XiRrA08Y32S5i2AvkevMRLClA8Xsb0N7R"
-                                           "3zFiC25U5495KY52FcB1B12txoA6xlFc83TJ97j9ytKSfi0rs1EwSILytRyMy2S5F70TrT6H457teJkVk5fr"
-                                           "VaLYheY512yh2qsj2MV31dl7oV56kWmmLlPSDIJwd74mOcyYfQft8N9756VfM5ExtBHql9TnRWl15j3beLww4p176G48s5q8bEWS0Nwcx7RX0WBz2nO412k7fWGi3nmxn8i156C45AHS27ttTB34sT0MiY63HWG0rbXLXnt41d3m5HiWmbnyh9yL36KH3TL4NMwK4vV0A9gZ6DpLrvPUWYaNYgEqQ0MGll1d2009l388upimkl71xaglmK97r7EDA491"
-                                           "82Q78FWpl1992nXtPUP2cF0rnM7jUPo0M6F8VgvbrQjHY4Var31H0aY94OF0Np6mlxM648S38LBvTrjZObsGn2eB9RPqzqWOlzMD0j71UKRZU90L7B95B5MdZMviaj5vml3JkkIODi6QZQWUobQt4Gr6b0mqR69UQ77897BuK2VjmFdNPLx4z8we7Bk0vU5o6DcJQgxOu7ZP"
+5.times { p gen.string.gen(300) } => "oysO930W8B4QU02J05qEWPn6R6H7xTZKFGbG6Hpo28b"
+                                     "R021N1tw0927BXZP7GbzgRE4rA5t46785g27jsztMRlaz571XzHoi6yBv22ec97194yByN3KIYM3EX1XiRrA08Y32S5i2AvkevMRLClA8Xsb0N7R"
+                                     "3zFiC25U5495KY52FcB1B12txoA6xlFc83TJ97j9ytKSfi0rs1EwSILytRyMy2S5F70TrT6H457teJkVk5fr"
+                                     "VaLYheY512yh2qsj2MV31dl7oV56kWmmLlPSDIJwd74mOcyYfQft8N9756VfM5ExtBHql9TnRWl15j3beLww4p176G48s5q8bEWS0Nwcx7RX0WBz2nO412k7fWGi3nmxn8i156C45AHS27ttTB34sT0MiY63HWG0rbXLXnt41d3m5HiWmbnyh9yL36KH3TL4NMwK4vV0A9gZ6DpLrvPUWYaNYgEqQ0MGll1d2009l388upimkl71xaglmK97r7EDA491"
+                                     "82Q78FWpl1992nXtPUP2cF0rnM7jUPo0M6F8VgvbrQjHY4Var31H0aY94OF0Np6mlxM648S38LBvTrjZObsGn2eB9RPqzqWOlzMD0j71UKRZU90L7B95B5MdZMviaj5vml3JkkIODi6QZQWUobQt4Gr6b0mqR69UQ77897BuK2VjmFdNPLx4z8we7Bk0vU5o6DcJQgxOu7ZP"
 
 ```
 

data/lib/radagen/generator.rb

@@ -45,8 +45,8 @@ module Radagen
     #   string_alpha.gen(200, 45362642634632684368) => "IaxBvRLxDIvLBhKezMdMmVZBCGzSJZvVjHkcLHsEchCpZWOmLAUQ"
     #
     def gen(size=30, seed=Random.new_seed)
-      prng = Random.new(seed)
-      @gen_proc.call(prng, size)
+      prng = prng(seed)
+      self.call(prng, size)
     end
 
     # Create a lazy enumerable of generator values. Size cycles from *size_min* to *size_max*
@@ -64,13 +64,19 @@ module Radagen
     def to_enum(opts={})
       default_opts = {size_min: 0, size_max: 300, seed: Random.new_seed}
       size_min, size_max, seed = default_opts.merge(opts).values_at(:size_min, :size_max, :seed)
-      prng = Random.new(seed)
+      prng = prng(seed)
 
       (size_min...size_max).cycle.lazy.map do |size|
         @gen_proc.call(prng, size)
       end
     end
 
+    private
+
+    def prng(seed)
+      Random.new(seed)
+    end
+
   end
 
 end

data/lib/radagen/version.rb

@@ -1,3 +1,3 @@
 module Radagen
-  VERSION = "0.3.3"
+  VERSION = "0.3.5"
 end

data/lib/radagen.rb

@@ -1,4 +1,3 @@
-require 'radagen/version'
 require 'radagen/generator'
 
 module Radagen
@@ -10,7 +9,7 @@ module Radagen
   # @return [Boolean]
   #
   def gen?(obj)
-    obj.class == Radagen::Generator
+    obj.is_a?(Radagen::Generator)
   end
 
   # Creates a generator that will choose (inclusive)
@@ -168,17 +167,19 @@ module Radagen
     end
   end
 
-  # Creates a generator that when called returns a varying
-  # length Array with values realized from the passed in
-  # generator. Excepts an options Hash that can contain the
-  # keys :min and :max. These will define the minimum and
-  # maximum amount of values in the realized Array.
+  # Creates a generator that when called returns a fixed or
+  # varying length Array with values realized from the passed in
+  # generator. Excepts options Hash that can contain the
+  # keys :min, :max, :count. These will define the minimum,
+  # maximum or fixed amount of values in the realized Array.
   #
   # @note If you provide a *:min* value then it is good practice to also provide a *:max* value as you can't be sure that the *size* passed to the generator will be greater or equal to :min.
+  # @note If you provide a *:count* value then *:min* and *:max* values if passed in are ignored.
   # @param gen [Radagen::Generator] generator that produces values in the Array
   # @param opts [Hash] the options hash to provide extra context to the generator
   # @option opts [Fixnum] :min (0) minimum number of values in a generated Array
   # @option opts [Fixnum] :max (*size*) maximum number of values in a generated Array
+  # @option opts [Fixnum] :count (nil) fixed number of values in a generated Array
   # @return [Radagen::Generator]
   #
   # @example
@@ -190,16 +191,27 @@ module Radagen
   # @example
   #   array(fixnum, min: 4, max: 7).sample(4) #=> [[0, 0, 0, 0, 0], [-1, 0, -1, 1, -1], [-2, -2, -1, 2, 0], [0, 2, 3, -1, -2, -2, 3]]
   #
-  def array(gen, opts={})
-    size_gen = sized do |size|
-      min, max = {min: 0, max: size}.merge(opts).values_at(:min, :max)
-      raise RangeError.new, "max value (#{max}) needs to be larger than or equal to min value (#{min}), provide a max value larger than min." unless max >= min
-      choose(min, max)
-    end
+  # @example
+  #   array(fixnum, count: 10).sample(3) #=> [[0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [1, -1, 1, 1, 0, 1, 1, 1, 0, 0], [2, 1, 0, 2, 0, -1, -2, 2, 2, 2]]
+  #
+  def array(gen, opts = {})
+    count = { count: nil }.merge(opts)[:count]
+    raise ArgumentError, "count must be an Integer or Nil" unless count.is_a?(Integer) or count.is_a?(NilClass)
 
-    bind(size_gen) do |_size|
-      gens = (0..._size).map { gen }
+    if count
+      gens = (0...count).map { gen }
       tuple(*gens)
+    else
+      size_gen = sized do |size|
+        min, max = { min: 0, max: size }.merge(opts).values_at(:min, :max)
+        raise RangeError.new, "max value (#{max}) needs to be larger than or equal to min value (#{min})" unless max >= min
+        choose(min, max)
+      end
+
+      bind(size_gen) do |_size|
+        gens = (0..._size).map { gen }
+        tuple(*gens)
+      end
     end
   end
 
@@ -564,7 +576,7 @@ module Radagen
   # @return [Radagen::Generator]
   #
   # @example
-  #   string_alpha.sample #=> ["", "", "", "H", "i", "Nxc", "gPfIt", "KpGRCl", "BjuiQE", "FCnfPkr"]
+  #   string_numeric.sample #=> ["", "0", "16", "5", "277"]
   #
   def string_numeric
     fmap(array(char_numeric)) do |char_array|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: radagen
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Nathan Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,5 +110,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: radagen - 0.3.3
+summary: radagen - 0.3.5
 test_files: []