synthetic-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5501edc9878433adbf55c5fac7b16471c995aa52
+  data.tar.gz: 29ad055a0114c4986741f218f4d644563a63cfeb
+SHA512:
+  metadata.gz: 699f7ffdbde97f2c660e190877b350e5823b731ddf7e04fbd09c27e85f98895a91080d6349a4ca8e30991eaa31c00e38056b66af19fe2f85986c8e7021b055e4
+  data.tar.gz: 46606126b5440326629b3430f23d0ba40e873311e0928fca967c11f1800131e264f0c9e1aa9af7bf45f6d32bb9f5dd7ba852a518d55f64bb4d7dbd70d2209d8f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.csv

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ikethecoder@canzea.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in synthetic-data.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    synthetic-data (0.1.0)
+      faker (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    faker (2.2.1)
+      i18n (>= 0.8)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  synthetic-data!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ike The Coder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Synthetic::Data
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synthetic-data'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synthetic-data
+
+## Usage
+
+```
+Synthetic.generate "models/user_profile.yml"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/synthetic-data. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Synthetic::Data project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/synthetic-data/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "synthetic/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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path `pwd`/.bundle
+
+# Do any other automated setup that you need to do here

data/lib/synthetic/data.rb

@@ -0,0 +1,73 @@
+require 'faker'
+require 'json'
+require 'csv'
+require 'yaml'
+require 'date'
+require "synthetic/data/version"
+
+module Synthetic
+    class Error < StandardError; end
+
+    def self.generate(rules_file)
+
+        Faker::Config.locale = 'en-CA'
+
+        definition = YAML.load_file(rules_file)
+        
+        headers = []
+        for field in definition['fields'].keys do
+            headers.push(field)
+        end
+        
+        options = {
+            :write_headers => true,
+            :headers => headers.join(',')
+        }
+        
+        start = Time.now.to_i
+        
+        CSV.open(definition['output'], "wb", options) do |csv|
+        
+            for i in 1..definition['records'] do
+        
+                row = []
+                for f in definition['fields'].keys do
+                    field = definition['fields'][f]
+        
+                    type = field['type'].split '.'
+        
+                    args = {}
+                    for key in field.keys do
+                        if not ['type','unique'].include? key then
+        
+                            if field[key].is_a? String and field[key].start_with? '@' then
+                                args[:"#{key}"] = row[headers.index(field[key][1..-1])]
+                            else
+                                args[:"#{key}"] = field[key]
+                            end
+                        end
+                    end
+        
+                    obj = Faker.const_get(type[0])
+                    if field['unique'] then
+                        obj = obj.public_send('unique')
+                    end
+        
+                    if field.keys.length == 1 then
+                        row.push(obj.public_send(type[1]))
+                    else
+                        row.push(obj.public_send(type[1], args))
+                    end
+                end
+                csv.puts(row)
+        
+                if i % 1000 == 0 then
+                    elapsed = Time.now.to_i - start
+                    puts("Completed #{i} records.  Total elapsed #{elapsed} seconds.")
+                end
+            end
+        end
+        
+        print "CSV file written (#{definition['output']})"
+    end
+end

data/lib/synthetic/data/version.rb

@@ -0,0 +1,5 @@
+module Synthetic
+  module Data
+    VERSION = "0.1.0"
+  end
+end

data/models/address.yml

@@ -0,0 +1,23 @@
+
+name: address
+records: 10000
+output: addresses.csv
+fields:
+  id:
+    type: Number.leading_zero_number
+    unique: true
+    digits: 12
+  street_address:
+    type: Address.street_address
+  city:
+    type: Address.city
+  state:
+    type: Address.state
+  postal_code:
+    type: Address.postcode
+  country:
+    type: Address.country
+  latitude:
+    type: Address.latitude
+  longitude:
+    type: Address.longitude

data/models/company.yml

@@ -0,0 +1,11 @@
+
+name: company
+records: 10000
+output: companies.csv
+fields:
+  id:
+    type: Number.leading_zero_number
+    unique: true
+    digits: 12
+  company_name:
+    type: Company.name

data/models/rel.yml

@@ -0,0 +1,18 @@
+name: company_address
+records: 10000
+output: company_addresses.csv
+relationship:
+  repeat_min: 1
+  repeat_max: 10
+  fields:
+    id:
+      type: Number.leading_zero_number
+      unique: true
+      digits: 12
+    company:
+      lookup: "company.id"
+    type:
+      type: Type.one_of
+      options: ["business", "registered", "correspondence"]
+    address_id:
+      lookup: "address.id"

data/models/user_profile.yml

@@ -0,0 +1,27 @@
+
+name: user_profile
+records: 5
+output: user_profiles.csv
+fields:
+  id:
+    type: Number.leading_zero_number
+    unique: true
+    digits: 12
+  last_name:
+    type: Name.last_name
+  first_name:
+    type: Name.first_name
+  username:
+    type: Internet.username
+    specifier: 10
+  email:
+    type: Internet.email
+    name: "@first_name"
+  gender:
+    type: Gender.binary_type
+  nationalid:
+    type: IDNumber.valid
+  birthdate:
+    type: Date.birthday
+    min_age: 8
+    max_age: 75

data/synthetic-data.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "synthetic/data/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "synthetic-data"
+  spec.version       = Synthetic::Data::VERSION
+  spec.authors       = ["Ike The Coder"]
+  spec.email         = ["ikethecoder@canzea.com"]
+
+  spec.summary       = %q{Synthetic data generator.}
+  spec.description   = %q{Add to a CI/CD pipeline to generate quality synthetic data.}
+#  spec.homepage      = "em's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+#   if spec.respond_to?(:metadata)
+#     spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+#     spec.metadata["homepage_uri"] = spec.homepage
+#     spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+#     spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+#   else
+#     raise "RubyGems 2.0 or newer is required to protect against " \
+#       "public gem pushes."
+#   end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "faker", "~> 2.2"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: synthetic-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ike The Coder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Add to a CI/CD pipeline to generate quality synthetic data.
+email:
+- ikethecoder@canzea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/synthetic/data.rb
+- lib/synthetic/data/version.rb
+- models/address.yml
+- models/company.yml
+- models/rel.yml
+- models/user_profile.yml
+- synthetic-data.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Synthetic data generator.
+test_files: []