bonito 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41888e2e81cc5c6f383b6fe3526984cd0d85bb874853509af626b880c824e669
+  data.tar.gz: ae72f04e929420aaa6698f0b89fb3ffb4dabc3827ab248d84f3b400ec5c72a95
+SHA512:
+  metadata.gz: 769052dccffcd20cd2fd281217e872c5455c6bc2b26a9dc3b10945a8992767b06dcd91e736dfe723eba49c6d2e007e8fc550197da1e2b8ecb2dc4343338418a4
+  data.tar.gz: 606bfa014aa8ef709f8069a173529f91ef06328dd182242259983c8eaa74ab938be4fc87ffa7e59fc4f461e62e2f9dd3f2dae2167f2d1abd25c033f26c57a886

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+plugins:
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+
+exclude_patterns:
+  - "docs/"

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/docs/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/*
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version
+.ruby_gemset

data/.reek.yml

@@ -0,0 +1,3 @@
+detectors:
+    IrresponsibleModule:
+        enabled: false

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+  - 'bonito.gemspec'
+
+Metrics/BlockLength:
+  ExcludedMethods: [
+    'describe', 'shared_examples', 'context', 'over', 'simultaneously',
+    'please', 'let',
+  ]

data/.ruby-gemset

@@ -0,0 +1 @@
+bonito

data/.travis.yml

@@ -0,0 +1,30 @@
+env:
+  global:
+  - CC_TEST_REPORTER_ID=7288d4a38203cc17d30f9fb4e9d46399d6e7b6f017572bc833d8da3f38fea48b
+language: ruby
+rvm:
+- 2.5.1
+- 2.3.0
+before_install:
+- gem update --system
+- gem install bundler
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+  - bundle exec rake rerdoc
+after_script:
+- ./cc-test-reporter after-build -t simplecov --exit-code $TRAVIS_TEST_RESULT
+cache: bundler
+
+deploy:
+  provider: pages
+  local_dir: docs
+  skip_cleanup: true
+  target_branch: gh-pages
+  github_token: $PERSONAL_ACCESS_TOKEN
+  keep_history: true
+  on:
+    branch: master

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 tomfinill@gmail.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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bonito.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tom Finill
+
+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,159 @@
+# Bonito
+
+![build](https://travis-ci.org/TomFinill/bonito.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/42198ebf17bf127e0da6/maintainability)](https://codeclimate.com/github/TomFinill/bonito/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/42198ebf17bf127e0da6/test_coverage)](https://codeclimate.com/github/TomFinill/bonito/test_coverage)
+
+## TL;DR
+
+**Bonito** is a ruby DSL for generating canned data.  It can simulate, by 
+ _freezing time_, sequences of events happening in series and parallel in 
+ order to approximate any kind of live data.
+
+`Bonito` uses [Timecop](https://github.com/travisjeffery/timecop) in order to
+ perform this _freezing_. 
+
+![bonito](https://live.staticflickr.com/3363/3278938654_a9991fa129_z.jpg)
+
+### An example is worth a thousand theorems
+
+#### Timeline Definition
+
+Suppose you work for a small media startup and you wish to create a set of data
+that can be loaded into a demo environment in order to then be used by the sales 
+department when presenting to potential customers.
+
+This data could consist of models representing `Author`s and the `Article`s they 
+write, as well as readers (or `User`s) and `Comment`s they leave on the 
+aforementioned `Article`s.
+
+Obviously, each `Article` should be created by an `Author` and the simulated
+ creation time of each `Comment` should be _after_ that of its associated 
+ `Article`.  In fact, we can consider the data to consist of a collection of 
+ _timelines_ where each timeline includes the creation of an `Article` by an 
+ `Author` with this being followed afterwards by a series of `Comment`s on the
+ `Article` being created by `User`s.
+ 
+`Bonito` offers a `Window` object to model such timelines. 
+
+Each `Window` has a duration in which events occur.  These events are referred 
+to in `Bonito` as `Moment`s.  
+
+For example, a `Window` representing the timeline described above could be 
+created as follows:
+
+```ruby
+example_window = Bonito.over 1.week do
+  please do
+    author = authors.sample
+    title = Faker::Company.bs
+    self.article = Article.new(title, author)
+    articles << article
+  end
+
+  repeat times: rand(10), over: 5.days do
+    please do
+      user = users.sample
+      content = Faker::Lorem.sentence
+      comments << Comment.new(content, article, user)
+    end
+  end
+end
+```
+
+Here, via the `over` method on the `Bonito` module, a `Window` is defined.  Within
+this window a series of `Moment`s are defined. Firstly, the `Window#please` method 
+is invoked to define the event.  In this case the event consists of creating an
+`Article`.
+
+After this, we wish to define `Moment`s in which many `Comment`s are created for
+the `Article`.
+
+To do this we use the `Window#repeat` method. This method accepts a block along 
+with a `times` parameter and an `over` parameter and inserts a new, child `Window`
+into the current, parent window.  The contents of the child window will be
+that defined by the block repeated `times` times.
+
+This means that the child `Window` defines up to 9 (`rand(10)`) `Moment`s
+where each such `Moment` creates a `Comment` belonging to the previously 
+created `Article`.
+
+_Now_, suppose we intend to simulate the creation of multiple `Article`s and 
+their associated `Comment`s.  One way to achieve this would be to repeat the 
+previously defined `Window` via the `repeat` command:
+
+```ruby
+serial_window = Bonito.over 10.weeks do
+  repeat times: 5 do
+    use example_window
+  end
+end
+``` 
+
+However this approach has a serious drawback: all events will occur _in series_.
+The second `Article` will not be created until all the `Comment`s on the first 
+`Article` have been created and similarly the third `Article` will be preceded by
+all `Comment`s on the second.
+
+Ideally what we want is for `Articles` and `Comment`s to be _interleaved_.
+
+We can achieve this using the `Window#simultaneously`
+method to create a `Container` object, used to define parallel timelines. We 
+then fill that container with the same, `Window` five times, using the 
+`Container#use` method.
+
+```ruby
+parallel_window = Bonito.over 2.weeks do
+  simultaneously do
+    repeat times: 5 do
+      use example_window 
+    end
+  end
+end
+```
+
+The above will create 5 `Article`s, each having up to 9 `Comment`s where the 
+moment at which `Article` is created is independent of any other `Article` or 
+`Comment`.  The times at which the `Comment`s are created, meanwhile, are 
+dependent _only_ on the `Article` to which they belong.
+
+#### Execution
+
+Now we have defined the _shape_ of the data we wish to create, it remains 
+to actually create it.  
+
+This is achieved via a `Runner` object that takes a `Window` and uses it to 
+evaluate `Moment`s.
+
+```ruby
+  Bonito.run parallel_window, starting: 8.weeks_ago
+```
+
+This will take the `Window` object `parallel_window` and distribute the `Moment`s
+it contains according to its configuration, mapping each `Moment` to a point 
+in time relative to the start time given by the `starting` parameter.
+
+_However_, a typical use case may require different data set sizes for 
+different applications: For example, a large dataset to live in a staging 
+environment in order to sanity check releases and a small, easy to load dataset 
+that can be used locally while developing.
+
+Suppose we have certain events that we wish to occur only once, 
+(using the above example, this may be the creation of some `Organisation` object
+representing the news company for which articles are being written) as well
+as events that we wish to be able to scale, such as the creation of `Article`
+objects and their associated `Comment`s.
+
+Using `Bonito`, we could define two windows: a `singleton_window` that is run once per
+dataset and generates our `Organisation` model, as well as a `scalable_window`
+that results in different sizes of data according to some size parameter.
+
+These windows can then be combined as follows, where the size paramter `factor`
+can be provided dynamically as, say, an argument provided to a `Rake` task.
+ 
+```ruby
+scaled_window = singleton_window + (scalable_window * factor)
+```
+
+The `scaled_window`, when run, will run the `scalable_window` `factor` times
+in parallel.
+
+

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'docs'
+  rdoc.rdoc_files.include('README.md', 'lib')
+end

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bonito'
+require 'active_support/core_ext/numeric/time'
+
+# 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
+
+# Do any other automated setup that you need to do here

data/bonito.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bonito/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bonito'
+  spec.version       = Bonito::VERSION
+  spec.authors       = ['Tom Finill']
+  spec.email         = ['tomfinill@gmail.com']
+
+  spec.summary       = 'A simple tool to create demo data'
+  spec.description   = 'Create realistic demo data by simulating events occurring over some time period'
+  spec.homepage      = 'https://github.com/TomFinill/bonito'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'algorithms', '~> 0.5'
+  spec.add_dependency 'ruby-progressbar'
+  spec.add_dependency 'timecop'
+
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'faker', '~> 1.9.1'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+
+end