genny 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 775a8ea859c1d9e327238c283dccee5bc11018bf
-  data.tar.gz: 683a7a9a6549e6accbb29e87ab497a55db71d157
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2VkZDQ5YTM3M2RhMjU3YTRlOWI4ODM1NGNmNDE1ODg4YzM0NjkxZg==
+  data.tar.gz: !binary |-
+    ZDNhNWE1MWUwZDU5OWIxNWUzNWIwMTk4NzM3YmU3ZWMxNzE1NTJjZA==
 SHA512:
-  metadata.gz: b12781c213a72a7f8ba5fb27a61195162d93f7ff8ee4f3ecbc1a315e975c2aabc134398b42be3c1d64de6098768e28469bdf8ec03c0efae6370857595872196b
-  data.tar.gz: baf4d7cecd6da46d907f45ab14c5e30c08606d9b46d96f30368663d0fe62c282d22c6bdd2e22352794ec50f44ab6c1dce43b55322c881e0d8bff222d29fd312d
+  metadata.gz: !binary |-
+    MjNhZTA3NDBlMjJkYjVkMTY1OWI5MDBmMTQ2M2E5NDFjY2NiMmRkZDhmOWQ3
+    NTgzMWVmMDQwMjczZjU1ZGM0ZTI3ODk1YTE1OGE0MWRlZjk3NmM3OGM4NTky
+    MjMxM2NlOWRhODU3OWM1M2FjMGUxNDU3MTg4MzQxNDQ5YmQyYTQ=
+  data.tar.gz: !binary |-
+    MTMzNmIwOTBlNjZlNzNiNmZjMzFlNWJmNWNiMTRlNGFlNDlhZGM0ZjYxZjFi
+    MDVhMTMwNzYyZGE1ZTU0ZmM0MjQyODNjNjIxNDdhYmNlNjY1NTc2YmU5MGEy
+    NTE4Y2YwMTNjZDJjNDAxNTBkMjQxNDk4YTk0OTFkOWQxYThjZjM=

data/README.md

@@ -64,13 +64,25 @@ js.genny
 
 ### Arrays
 
-A generated array will always be empty unless a `:classes` option has been defined. Any class in that array that responds to `genny` may be picked as the prototype for an element of the generated array.
+A generated array will always be empty unless a `:items` option has been defined. Any class in that array that responds to `genny` may be picked as the prototype for an element of the generated array.
 
 ```
 Genny::Array.genny
 # => []
 
-Genny::Array.genny(classes: [Genny::String, Genny::Integer])
+Genny::Array.genny(items: [Genny::String, Genny::Integer])
+# => ["mcztjgoriq", "nohfcavjyz", 739]
+
+Genny::Array.genny(
+  items: JSONSchema.new(
+    "type" => "object",
+    "properties" => {
+      "key" => {
+        "type" => "string"
+      }
+    }
+  )
+)
 # => ["mcztjgoriq", "nohfcavjyz", 739]
 ```
 
@@ -178,4 +190,6 @@ Yes please! Pull requests would be lovely.
 
 ## Contact
 
-I am [@jphastings](https://twitter.com/jphastings) and I work at [blinkbox Books](https://github.com/blinkboxbooks), do get in touch.
+I am [@jphastings](https://twitter.com/jphastings) and I work at [blinkbox Books](https://github.com/blinkboxbooks), do get in touch.
+
+Also, let's have none of this gif/jif nonsense. Unless it sounds *ugly* in your language, you have just finished reading the documentation for **/jeni/** ;)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/genny/array.rb

@@ -2,18 +2,37 @@ require "genny/base"
 
 module Genny
   module Array
+    # Generates an array of items of the types specified.
+    #
+    # @example No classes specified, can only return an empty array
+    #     Genny::Array.genny
+    #     # => []
+    #
+    # @example Specifying classes
+    #     Genny::Array.genny(items: [Genny::Integer, JSONSchema.new("type" => "string", "format" => "ipv4")])
+    #     # => ["mcztjgoriq", "nohfcavjyz", 739]
+    #
+    # @param [Hash] opts Options for the generator
+    # @option opts [Array<#genny>,#genny] :items The items which should be used to populate the array
+    # @option opts [Integer] :minItems (1) The fewest number of items the array should have
+    # @option opts [Integer] :maxItems (5) The largest number of items the array should have
+    # @raise RuntimeError if no :items given and minItems > 0
+    # @raise RuntimeError if :maxItems is lower than :minItems
+    # @return [Array]
     def self.genny(opts = {})
       opts = Genny.symbolize(opts)
-      opts[:classes] ||= []
-      raise ArgumentError, "classes must be an array" unless opts[:classes].respond_to?(:select)
-      klasses = [*opts[:classes]].select { |klass| klass.respond_to?(:genny) }
-      return [] if klasses.empty?
+      opts[:items] = opts[:items].is_a?(Array) ? opts[:items] : [opts[:items]].compact
+      raise ArgumentError, "classes must be an array" unless opts[:items].respond_to?(:select)
+      items = opts[:items].select { |item| item.respond_to?(:genny) }
+      if items.empty?
+        raise "No items given, cannot populate the array." unless opts[:minItems].to_i == 0
+        return []
+      end
       min_count = opts[:minItems] || 1
-      max_count = opts[:maxItems] || 5
+      max_count = opts[:maxItems] || [opts[:minItems], 5].max
+      raise "maxItems is lower than minItems" if max_count < min_count
       count = Random.rand(max_count - min_count + 1) + min_count
-      return count.times.map do
-        klasses.sample.genny(opts[:items] || {})
-      end
+      return count.times.map { items.sample.genny }
     end
   end
 end

data/lib/genny/engines/faker.rb

@@ -1,35 +1,38 @@
 begin
   require "faker"
 
-  module Genny::String
-    # First name
-    hint do |opts|
-      hint = opts[:hint].downcase
-      next unless hint.match("first") && hint.match("name")
-      # TODO: ensure the length limits are met
-      Faker::Name.first_name
-    end
+  # First name
+  Genny::String.hint do |opts|
+    hint = opts[:hint].downcase
+    next unless hint.match("first") && hint.match("name")
+    # TODO: ensure the length limits are met
+    Faker::Name.first_name
+  end
 
-    # Last name
-    hint do |opts|
-      hint = opts[:hint].downcase
-      next unless hint.match("last") && hint.match("name")
-      # TODO: ensure the length limits are met
-      Faker::Name.last_name
-    end
+  # Last name
+  Genny::String.hint do |opts|
+    hint = opts[:hint].downcase
+    next unless hint.match("last") && hint.match("name")
+    # TODO: ensure the length limits are met
+    Faker::Name.last_name
+  end
 
-    # Full name
-    hint do |opts|
-      next unless opts[:hint].downcase.match("name")
-      # TODO: ensure the length limits are met
-      Faker::Name.name
-    end
+  # Full name
+  Genny::String.hint do |opts|
+    next unless opts[:hint].downcase.match("name")
+    # TODO: ensure the length limits are met
+    Faker::Name.name
+  end
+
+  # Email address
+  Genny::String.hint do |opts|
+    next unless opts[:hint].downcase.match("email")
+    Faker::Internet.safe_email
+  end
 
-    # Email address
-    hint do |opts|
-      next unless opts[:hint].downcase.match("email")
-      Faker::Internet.safe_email
-    end
+  # Email address as format
+  Genny::String.format("email") do |opts|
+    Faker::Internet.safe_email
   end
 rescue LoadError
 end

data/lib/genny/json_schema.rb

@@ -15,8 +15,8 @@ class JSONSchema < SimpleDelegator
     super(hash)
   end
 
-  def genny
-    opts = Genny.symbolize(self)
+  def genny(additional_opts = {})
+    opts = Genny.symbolize(self.merge(additional_opts))
     return opts[:enum].sample if opts.has_key?(:enum)
     return schema_from_ref(opts[:'$ref']).genny if opts[:'$ref']
 

data/lib/genny/string.rb

@@ -32,5 +32,6 @@ module Genny
     format("ipv4")      { |opts| 4.times.map { Random.rand(255) }.join(".") }
     format("ipv6")      { |opts| 8.times.map { Random.rand(65536).to_s(16).rjust(4, "0") }.join(":") }
     format("uri")       { |opts| Genny::URI.genny(opts).to_s }
+    format("email")     { |opts| Genny::String.genny + "@example.com" }
   end
 end

data/lib/genny/uri.rb

@@ -3,6 +3,8 @@ require "uri"
 
 module Genny
   module URI
+    # @param [Hash] opts Options for the generator
+    # @option opts [String] :host ('example.com') The host of the generated URI
     def self.genny(opts = {})
       opts = Genny.symbolize(opts)
       ::URI::HTTP.build(host: opts[:host] || 'example.com', path: "/#{Genny::String.genny}")

data/lib/genny/version.rb

@@ -1,4 +1,5 @@
 module Genny
+  # Grabbed from the VERSION file in the root of the gem
   VERSION = begin
     File.read(File.join(__dir__, "../../../VERSION")).strip
   rescue Errno::ENOENT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genny
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - JP Hastings-Spital
@@ -14,42 +14,56 @@ dependencies:
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: json-schema
+  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'
 description: Genny likes to make things up. It generates ruby objects, mainly from
@@ -78,7 +92,7 @@ files:
 - lib/genny/time.rb
 - lib/genny/uri.rb
 - lib/genny/version.rb
-homepage: ''
+homepage: https://github.com/blinkboxbooks/genny
 licenses: []
 metadata: {}
 post_install_message: 
@@ -87,17 +101,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Genny likes to make things up. It generates ruby objects, mainly from JSON