random-set 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ad4d2dc9bcb1b5ae42bae76fbbe5cae3c29a4df
+  data.tar.gz: 51912ae6cdc5572a07e0ee431cab8caaba93910c
+SHA512:
+  metadata.gz: b70d391565cc6a1ee4e4b51af0a3d78e59e518d55e38642c08c4bd83392900cf2f3a39a92ff85014f2840b082d07ddc8d7526423a21b51a1addbe9b1ab773535
+  data.tar.gz: bf473e2f91d385005447da3e79f1bc00bc1955b4f80b76424f61b30d81afcc7a279fb06a977a3be534463ea4a5a654cd25a94961a73895802b0fb1b00c44b7e3

data/.gitignore

@@ -0,0 +1,29 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore .DS_Store
+.DS_Store
+
+# Ignore the output files.
+/pkg
+
+# Ignore bundler and database config and precompiled assets
+/.bundle
+/.env
+
+# Ignore all logfiles and tempfiles.
+/tmp
+
+# Ignore TextMate projects
+*.tmproj
+*.sublime-project
+*.sublime-workspace
+
+# Documentation files and other stuff
+.yardoc
+/doc
+/nbproject
+/coverage

data/.ruby-gemset

@@ -0,0 +1 @@
+flux

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    random_set (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  random_set!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joost Lubach
+
+MIT License
+
+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,87 @@
+# RandomSet
+
+Generates a series of data based on a template. This template may be a hash
+or an array. If a hash is given, the output of this function is an array of hashes.
+Conversely, if an array is given, the output is an array of arrays.
+
+Each item in the given template corresponds to an attribute of each item in the result
+set, and specifies how its data should be generated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'random-set'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install random-set
+
+## Examples
+
+Generate an array of tuples, where the second argument is a random number between 0 and 1:
+
+    RandomSet.generate [ (1..3), ->{ rand } ]
+    => [ [1, 0.156], [2, 0.782], [3, 0.249] ]
+
+Generate some randomized trend over the last week:
+
+    RandomSet.generate :date => (Date.current - 7.days), :value => ->{ rand }
+
+## Counting
+
+If at least one of the attribute templates is 'fixed-size', e.g. a range or an array,
+a count is heuristically found by taking the maximum size. The value `nil` is provided
+where an attribute value cannot be inferred:
+
+    RandomSet.generate [ (1..2), (1..4) ]
+    => [ [1,1], [1,2], [nil,3], [nil,4] ]
+
+If you have only infinitely sized templates, you need to specify a count:
+
+    RandomSet.generate [ ->{ rand } ]
+    => raises CannotInferCount
+
+    RandomSet.generate 3, [ ->{ rand } ]
+    => [ [0.562], [0.168], [0.476] ]
+
+## Supported templates
+
+The following templates are supported:
+
+* Anything with an `each` method that returns an Enumerator.
+* Procs or lambdas. One argument is passed: the number of the current iteration.
+* An instance of any class that has a `next` method. If this class also has a `count` method,
+  it is considered a fixed-size template.
+
+## Built-in generators
+
+The following built-in generators are available as templates:
+
+* Gaussian - a Gaussian (normal distribution) random number generator.
+* GaussianTrend - a trend generator using a Gaussian distribution. Each value is taken as the
+  mean of the next value.
+
+To use a built-in generator, create an instance in your template:
+
+    RandomSet.generate 5, [ RandomSet::GaussianTrend.new(1000) ]
+    => [ [1307.878], [1397.881], [1296.988], [1929.835], [2118.800] ]
+
+## Integration with Faker and others
+
+Using procs, you can easily integrate Faker-like libraries:
+
+    RandomSet.generate 3, [ ->{ Faker::Name.name } ]
+    => [ ["Mr. Zita Cruickshank"], ["Godfrey Grady"], ["Mrs. Simone Nikolaus"] ]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/random-set.rb

@@ -0,0 +1 @@
+require 'random_set'

data/lib/random_set/gaussian.rb

@@ -0,0 +1,48 @@
+module RandomSet
+
+  # Generates a Gaussian (normally distributed) random number, using the given mean and standard
+  # deviation.
+  #
+  # Source: http://stackoverflow.com/questions/5825680/code-to-generate-gaussian-normally-distributed-random-numbers-in-ruby
+  class Gaussian
+
+    # Initializes the generator.
+    #
+    # @param [Float] mean    The mean.
+    # @param [Float] stddev  The standard deviation.
+    # @param [Proc] rand_helper
+    #   A proc used to generate the random number. This is Ruby's +rand+ function by default.
+    def initialize(mean, stddev, rand_helper = lambda { Kernel.rand })
+      @rand_helper = rand_helper
+      @mean = mean
+      @stddev = stddev
+      @valid = false
+      @next = 0
+    end
+
+    def next
+      if @valid then
+        @valid = false
+        return @next
+      else
+        @valid = true
+        x, y = self.class.gaussian(@mean, @stddev, @rand_helper)
+        @next = y
+        return x
+      end
+    end
+
+    private
+
+    def self.gaussian(mean, stddev, rand)
+      theta = 2 * Math::PI * rand.call
+      rho = Math.sqrt(-2 * Math.log(1 - rand.call))
+      scale = stddev * rho
+      x = mean + scale * Math.cos(theta)
+      y = mean + scale * Math.sin(theta)
+      return x, y
+    end
+
+  end
+
+end

data/lib/random_set/gaussian_trend.rb

@@ -0,0 +1,32 @@
+require 'random_set/gaussian'
+
+module RandomSet
+
+  # Generates a Gaussian trend. For each sample, a Gaussian random number is generated using
+  # {Gaussian}, and its value is taken as the mean value for the next value. This produces
+  # a natural trend.
+  class GaussianTrend
+
+    # Initializes the generator.
+    #
+    # @param [Float] start
+    #   The first mean value.
+    # @param [Float] volatility
+    #   This number is multiplied with the mean to provide the standard deviation. The higher
+    #   the number, the 'wilder' the trend will become. A value of 0.2 (default) produces a
+    #   natural trend.
+    # @param [Proc] rand_helper
+    #   See {Gaussian#initialize}.
+    def initialize(start, volatility = 0.2, rand_helper = lambda { Kernel.rand })
+      @prev = start
+      @volatility = volatility
+      @rand_helper = rand_helper
+    end
+
+    def next
+      @prev = Gaussian.new(@prev, @prev * @volatility, @rand_helper).next
+    end
+
+  end
+
+end

data/lib/random_set/template.rb

@@ -0,0 +1,94 @@
+module RandomSet
+
+  # A template for the random set.
+  # @api internal
+  class Template
+
+    def initialize(templates)
+      @hash       = templates.is_a?(Hash)
+      @generators = resolve_generators(templates)
+    end
+
+    def hash?
+      @hash
+    end
+
+    def resolve_generators(templates)
+      hash = {}
+
+      process = proc do |key, template|
+        hash[key] = create_generator(template)
+      end
+
+      if hash?
+        templates.each &process
+      else
+        templates.each_with_index { |template, index| process[index, template] }
+      end
+
+      hash
+    end
+
+    def create_generator(template)
+      case template
+      when nil then nil
+      when ->(t){ t.respond_to?(:next) } then template
+      when ->(t){ t.respond_to?(:each) } then template.each
+      when Proc then CustomGenerator.new(template)
+      else raise UnsupportedTemplate, "cannot create a generator for a template of class #{template.class}"
+      end
+    end
+
+    attr_reader :generators
+
+    # Gives a count for the items in this template. If no count can be inferred, +nil+ is returned.
+    def count
+      max = nil
+      generators.each do |_key, generator|
+        next unless generator && generator.respond_to?(:count)
+        max = [ max.to_i, generator.count ].max
+      end
+      max
+    end
+
+    def generate(count = self.count)
+      raise CannotInferCount, "no count was specified or could be inferred" unless count
+
+      data = []
+      count.times.each { data << generate_next(data) }
+      data
+    end
+
+    def generate_next(data)
+      item = hash? ? {} : []
+      generators.each do |key, generator|
+        begin
+          item[key] = generator.try(:next)
+        rescue StopIteration
+          # If some enumerator came to the end, we just leave the rest of the keys blank.
+          item[key] = nil
+        end
+      end
+      item
+    end
+
+    class CustomGenerator
+
+      def initialize(block)
+        @block = block
+        @iteration = 0
+      end
+
+      attr_reader :block
+
+      def next
+        block.call @iteration
+      ensure
+        @iteration += 1
+      end
+
+    end
+
+  end
+
+end

data/lib/random_set/version.rb

@@ -0,0 +1,3 @@
+module RandomSet
+  VERSION = "0.0.2"
+end

data/lib/random_set.rb

@@ -0,0 +1,30 @@
+module RandomSet
+
+  class UnsupportedTemplate < RuntimeError; end
+  class CannotInferCount < RuntimeError; end
+
+  class << self
+
+    # @!method generate([count], template)
+    #
+    # Generates a series of data based on the given template. This template may be a hash
+    # or an array. If a hash is given, the output of this function is an array of hashes.
+    # Conversely, if an array is given, the output is an array of arrays.
+    #
+    # @param [Fixnum] count          A count. Leave this out if the count can be inferred.
+    # @param [Hash|Array] template   The generator template.
+    # @return [Array]                The generated data.
+    #
+    # @raise [UnsupportedTemplated]  If any of the provided templates was not supported.
+    # @raise [CannotInferCount]      If no count was specified, and no count could be inferred.
+    def generate(*args)
+      raise ArgumentError, "template required" if args.empty?
+      raise ArgumentError, "too many arguments (1..2 expected)" if args.length > 2
+      Template.new(args.pop).generate *args
+    end
+
+  end
+end
+
+require 'random_set/template'
+require 'random_set/gaussian_trend'

data/random-set.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'random_set/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "random-set"
+  spec.version       = RandomSet::VERSION
+  spec.authors       = ["Joost Lubach"]
+  spec.email         = ["joost@yoazt.com"]
+  spec.description   = %q{Generates a series of data based on a template.}
+  spec.summary       = %q{Generates a series of data based on a template.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: random-set
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Joost Lubach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  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'
+description: Generates a series of data based on a template.
+email:
+- joost@yoazt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/random-set.rb
+- lib/random_set.rb
+- lib/random_set/gaussian.rb
+- lib/random_set/gaussian_trend.rb
+- lib/random_set/template.rb
+- lib/random_set/version.rb
+- random-set.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.1.4
+signing_key: 
+specification_version: 4
+summary: Generates a series of data based on a template.
+test_files: []
+has_rdoc: