fake_data 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cdaac93546def3c7d0c48e9c30ed2b003e85b7b
-  data.tar.gz: 70ca387710795bd8c7c8facdb0471ae446e53e4c
+  metadata.gz: 41847a41f8158d6ef36a7db01a2ca9c21b2fbaa2
+  data.tar.gz: f68e00914385129db81e356a08d26cd33dfb4a03
 SHA512:
-  metadata.gz: 5710d6c44169fa92d868c725ed68f980990a6e897bc9526d8c726a38f7f11d6342e2df2581846a742e3e88f0beed1bc220e80ae5bafa3e04f217d7d4734f1917
-  data.tar.gz: 9af00b36aea62ddfa43208ede20df3aa6414e6b1701f4c80d65926ab78fe59b160836253776cec04d1655405470848b12d9feb3a4a381cb514b2db29b5b90e09
+  metadata.gz: fd21e7bfdb387b808aea3c91a14703fabf9a7c2965d4160fa68f01bd334f59f4b97c106c72f72af6fed51de74a6387a66b8acab386465136edf6f9a61abb7af4
+  data.tar.gz: c1c9fce599b40728e9aba33cd99ec8b5fa62d079d1e31e50088f7fe313fe78562acc23802e62b6bc22946dde043f299f37e22808c3892b39f28ae77a075c457f

data/README.md

@@ -1,14 +1,10 @@
 [![Build Status](https://travis-ci.org/schovi/FakeData.png?branch=master)](https://travis-ci.org/schovi/FakeData)
-
 [![Gem Version](https://badge.fury.io/rb/fake_data.png)](http://badge.fury.io/rb/fake_data)
-
 [![Coverage Status](https://coveralls.io/repos/schovi/FakeData/badge.png)](https://coveralls.io/r/schovi/FakeData)
 
 # FakeData
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fake_data`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Fake data generator for simple and complex structures or objects. For data generation it uses [Faker gem](https://github.com/stympy/faker)
 
 ## Installation
 
@@ -20,15 +16,130 @@ gem 'fake_data'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install fake_data
+```
+$ gem install fake_data
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+With simple schema generates fake data. Supports structure controling like how many items array should have or value presence based on probability. For random data is used (Faker gem)[https://github.com/stympy/faker].
+
+### String
+
+All following rows are equivalent.
+
+```ruby
+FakeData.once("Hello, my name is %{Faker::Name.name}")
+=> "Hello, my name is Miss Darius Stokes"
+FakeData.once("Hello, my name is %{Name.name}")
+=> "Hello, my name is Ms. Santino Gutmann"
+FakeData.once("Hello, my name is %{name.name}")
+=> "Hello, my name is Miss Edward Kunde"
+```
+
+### Array
+
+#### Simple array with content
+
+```ruby
+FakeData.once(
+  [
+    "I live in %{address.city}",
+    "My family came from %{address.country}"
+  ]
+)
+=> ["I live in Winnifredshire", "And my family came from Hungary"]
+```
+
+### Hash
+
+```ruby
+FakeData.once(
+  {
+    id: "%{number.number(5)}",
+    name: "%{name.name}",
+    email: "%{internet.email}"
+  }
+)
+
+=> {"id"=>"70095", "name"=>"Mr. Alverta Gibson", "email"=>"seamus@schambergerswaniawski.name"}
+```
+
+### Repeating
+
+#### Generated Array with given number of items
+
+Use hash with only one special control key `"%{repeat(n)}"`
+
+```ruby
+FakeData.once(
+  {"%{repeat(2)}" => "I have email %{internet.email}"}
+)
+=> ["I have email eryn@bayer.name", "I have email roxane.hoppe@rosenbaum.com"]
+```
+
+#### Generated Array with random number of items
+
+From empty Array to Array with N items with `repeat(0..n)`
+
+```ruby
+3.times do
+  p FakeData.once({"%{repeat(0..2)}" => "My favorite beer is: %{beer.name}"})
+end
+
+=> ["My favorite beer is Pliny The Elder", "My favorite beer is: Brooklyn Black"]
+=> ["My favorite beer is: Ten FIDY"]
+=> []
+```
+
+#### Generated Array with random number of items and nothing for empty array
+
+For empty Array returns `nil` with `repeat(0..n, nil: true)`
+
+```ruby
+FakeData.once({"%{repeat(0..1, nil: true)}" => "My favorite beer is: %{beer.name}"})
+=> nil
+```
+
+### Value presence with probability
+
+Use hash with only one special control key `"%{maybe}"` - change is 50%. `maybe(20)` - chance is 20%
+
+```ruby
+2.times do
+  FakeData.once({"%{maybe(20)}" => "I like to watch on movies with %{superhero.name}"})
+end
+=> "I like to watch on movies with Giant Thanos Thirteen"
+=> nil
+```
+
+### Complex example
+
+```ruby
+FakeData.once(
+  {
+    id:       "%{number.number(5)}",
+    name:     "%{name.name}",
+    age:      20,
+    facebook: "%{internet.url('facebook.com/profile')}",
+    friends: {
+      "%{maybe(75)}" => {
+        "%{repeat(2..20)}" => {
+          id:       "%{number.number(5)}",
+          name:     "%{name.name}",
+          facebook: "%{internet.url('facebook.com/profile')}",
+        }
+      }
+    }
+  }
+)
+```
 
 ## Development
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "fake-data"
+require "fake_data"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/fake_data/method.rb

@@ -4,7 +4,7 @@ require "fake_data/method/control"
 module FakeData
   class Method
     # TODO: problem with parsing "test()" => method = test; arguments = ["()"]
-    METHOD_MATCHER = /((?<klass>[a-z_.:]+)\.)?(?<method>[a-z_=\?]+)\s*(\((?<args1>.+)\)|(?<args2>.+))?\s*/i
+    METHOD_MATCHER = /((?<klass>[a-z_.:]+)\.)?(?<method>[a-z0-9_=\?]+)\s*(\((?<args1>.+)\)|(?<args2>.+))?\s*/i
     LEFT_BRACKET_MATCHER = /^\(/
     RIGHT_BRACKET_MATCHER = /\)$/
     # TODO: better argument splitting

data/lib/fake_data/method/control.rb

@@ -1,8 +1,8 @@
 module FakeData
   class Method
     class Control < FakeData::Method
-
       attr_reader :call_block
+
       class << self
         def repeat(count, params = {}, &block)
           if count.is_a?(Range)

data/lib/fake_data/version.rb

@@ -1,3 +1,3 @@
 module FakeData
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fake_data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - David Schovanec
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Universal random data generator