data_builder 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ffa6367098c65adf86a4c45a05c9a3cf68d9ea8
-  data.tar.gz: 6714fbdb50f5342f6706947b1d6e581507bbbb86
+  metadata.gz: 38ab44128293206daf0e094a73036fb1317ea971
+  data.tar.gz: c9cd869a2144e970290a9833cdabad471bcf814d
 SHA512:
-  metadata.gz: dd34e50ba54ad2d37605e66b84529e5f99bdf95141bbdaec8036707c9c0927ec8d848db48311d8011d0fb7d48ec2bdf8802489039666e305c198442b00ad600c
-  data.tar.gz: 30fa6c54b64e20bfc29fa356e2af558efd812a1bda3564325c61d8218d91153159157367a28b2e5c72c26182f395a53ca66732f5fd9a6035371c17a5d83f7dc4
+  metadata.gz: 8b22c0008029a53d113811afffd71ef785ba0af3b9b276fe8cf017c9eaf537145dd83cdc15bbbf739da6ffe11899e5b6e08088eb7f2f24adf9ba23e427c92a30
+  data.tar.gz: ff250a2359122a694544c199142fc369c903f6f6a9f81828ae6027d330d7f8b1498a3130782a0d5602902456e6806c201718d54883c8b9b865158368dce34396

data/.gitignore

@@ -1,40 +1,49 @@
-# Ruby-Specific
+# Ruby Generated
 
+/Gemfile.lock
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
-
-# Ouput-Specific
-
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
+/spec/coverage/
 /tmp/
-*.log
-*.tmp
-*.swp
-*.bak
 
-# IDE-Specific
+# Generated Reports
+reports/
 
-.idea
-.settings
-.project
-.classpath
-*.iws
+# Rspec Failure Tracking
 
-# Windows-Specific
+.rspec_status
 
-Thumbs.db
+# IDE Files
 
-# Mac OS-Specific
-
-*.DS_Store
-._*
+.idea/
+*.iml
+*.iws
+*.ipr
+.vscode/
+.settings/
+.metadata
+.classpath
+.loadpath
+.buildpath
+.project
 
-# Linux-Specific
+# OS Files
 
-.directory
-.Trash-*
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+$RECYCLE.BIN/
+Desktop.ini
+*.tmp
+*.bak
+*.swp
+*~.nib

data/.hound.yml

@@ -60,3 +60,9 @@ Metrics/MethodLength:
 # Encourage fewer parameters.
 Metrics/ParameterLists:
   Max: 4
+
+Metrics/AbcSize:
+  Max: 18
+
+Metrics/ModuleLength:
+  Max: 180

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in data_builder.gemspec
+gem "coveralls", require: false
+
 gemspec

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+**The MIT License (MIT)**
 
-Copyright (c) 2016 Jeff Nyman
+Copyright © 2016-2019 Jeff Nyman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,7 @@
 # DataBuilder
 
 [![Gem Version](https://badge.fury.io/rb/data_builder.svg)](http://badge.fury.io/rb/data_builder)
-[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/data_builder/blob/master/LICENSE.txt)
-
-[![Dependency Status](https://gemnasium.com/jeffnyman/data_builder.png)](https://gemnasium.com/jeffnyman/data_builder)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/data_builder/blob/master/LICENSE.md)
 
 The goal of DataBuilder is to apply an expressive means of constructing a data set based on information stored in YAML files.
 
@@ -15,13 +13,23 @@ To get the latest stable release, add this line to your application's Gemfile:
 gem 'data_builder'
 ```
 
-And then include it in your bundle:
+To get the latest code:
+
+```ruby
+gem 'data_builder', git: 'https://github.com/jeffnyman/data_builder'
+```
+
+After doing one of the above, execute the following command:
 
-    $ bundle
+```
+$ bundle
+```
 
 You can also install DataBuilder just as you would any other gem:
 
-    $ gem install data_builder
+```
+$ gem install data_builder
+```
 
 ## Usage
 
@@ -137,7 +145,7 @@ data = testing.data_about(:alpha_centauri)
 ### Default Files
 
 You might wonder how DataBuilder knew to look for `default.yml` since I didn't use a `load` method in these examples. If you do not specify a filename the logic will attempt to use a file named `default.yml` in the specific data path you have specified or in the default path of `data`.
- 
+
 Another option is that you can set an environment variable called `DATA_BUILDER_SOURCE`. When this variable exists and is set, the value it is set to will be used instead of the `default.yml` file. Keep in mind that the "data source" here refers to the file, not the keys within a file.
 
 ### Namespaced Data
@@ -167,9 +175,27 @@ Given the examples, you can see that `data_about` was chosen as the method name
 
 The reason for these aliases is, again, to make the logic expressive about its intent. This is particularly nice if you fit DataBuilder in with the context of a fluent API.
 
+### Scenarios in Cucumber
+
+If you are using Cucumber, there is another to specify the data file to load. You can apply a _tag_ to a given scenario. The tag should take the form of `@databuilder_NAME` where `NAME` is replaced with the name of the data file you want to be loaded for the scenario.
+
+As an example, if you add the tag `@databuilder_stars` then the file `stars.yml` will be loaded. If you want to use the tags you have to add the following code in a hook:
+
+```ruby
+Before do |scenario|
+  DataBuilder.data_files_for(scenario)
+end
+```
+
+You can use `data_for_scenario` in place of `data_files_for` if you feel that reads better.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec:all` to run the tests. 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`.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec:all` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+The default `rake` command will run all tests as well as a RuboCop analysis.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
@@ -194,4 +220,4 @@ This code is loosely based upon the [DataMagic](https://github.com/cheezy/data_m
 ## License
 
 DataBuilder is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
-See the [LICENSE](https://github.com/jeffnyman/data_builder/blob/master/LICENSE.txt) file for details.
+See the [LICENSE](https://github.com/jeffnyman/data_builder/blob/master/LICENSE.md) file for details.

data/Rakefile

@@ -10,6 +10,7 @@ namespace :spec do
   desc 'Clean all generated reports'
   task :clean do
     system('rm -rf spec/reports')
+    system('rm -rf spec/coverage')
   end
 
   RSpec::Core::RakeTask.new(all: :clean) do |config|

data/data_builder.gemspec

@@ -21,13 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "pry"
 
   spec.add_runtime_dependency "data_reader"
+  spec.add_runtime_dependency "faker"
 
   spec.post_install_message = %{
 (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)

data/lib/data_builder.rb

@@ -1,12 +1,34 @@
+require "data_builder/core_ext/hash"
+require "data_builder/core_ext/integer"
+require "data_builder/core_ext/string"
 require "data_builder/version"
+require "data_builder/generation"
+require "data_builder/generation_date"
+require "data_builder/generation_standard"
 
 require "data_reader"
+require "faker"
 
 module DataBuilder
   extend DataReader
+  extend DateGeneration
+  extend StandardGeneration
+
+  attr_reader :parent
+
+  if I18n.respond_to? :enforce_available_locales
+    I18n.enforce_available_locales = false
+  end
+
+  def self.included(caller)
+    @parent = caller
+    generators.each do |generator|
+      Generation.send :include, generator
+    end
+  end
 
   class << self
-    attr_accessor :data_source
+    attr_accessor :data_contents
 
     def default_data_path
       'data'
@@ -18,6 +40,16 @@ module DataBuilder
         t.gsub('@databuilder_', '').to_sym
       end
     end
+
+    alias data_for_scenario data_files_for
+
+    def locale=(value)
+      Faker::Config.locale = value
+    end
+
+    def generators
+      @generators || []
+    end
   end
 
   def data_about(key, specified = {})
@@ -26,13 +58,15 @@ module DataBuilder
       DataBuilder.load("#{file}.yml")
     else
       record = key.to_s
-      DataBuilder.load(builder_source) unless DataBuilder.data_source
+      DataBuilder.load(builder_source) unless DataBuilder.data_contents
     end
 
-    data = DataBuilder.data_source[record]
+    data = DataBuilder.data_contents[record]
     raise ArgumentError, "Undefined key for data: #{key}" unless data
 
-    data.merge(specified).clone
+    # rubocop:disable Metrics/LineLength
+    process_data(data.merge(specified.key?(record) ? specified[record] : specified).deep_copy)
+    # rubocop:enable Metrics/LineLength
   end
 
   alias data_from data_about
@@ -44,13 +78,35 @@ module DataBuilder
     original_data_path = DataBuilder.data_path
     DataBuilder.data_path = data_location
     data_files = data_files_for(scenario)
-    DataBuilder.load("#{data_files.last}.yml") if data_files.count > 0
+    DataBuilder.load("#{data_files.last}.yml") if data_files.count.positive?
     DataBuilder.data_path = original_data_path
   end
 
   private
 
+  def process_data(data)
+    case data
+      when Hash
+        data.each { |key, value| data[key] = process_data(value) }
+      when Array
+        data.each_with_index { |value, i| data[i] = process_data(value) }
+      when String
+        return generate(data[1..-1]) if data[0, 1] == "~"
+    end
+    data
+  end
+
+  def generate(value)
+    generation.send :process, value
+  rescue StandardError => e
+    fail "Failed to generate: #{value}\n Reason: #{e.message}\n"
+  end
+
+  def generation
+    @generation ||= Generation.new parent
+  end
+
   def builder_source
-    ENV['DATA_BUILDER_SOURCE'] ? ENV['DATA_BUILDER_SOURCE'] : 'default.yml'
+    ENV['DATA_BUILDER_SOURCE'] || 'default.yml'
   end
 end

data/lib/data_builder/core_ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def deep_copy
+    Marshal.load(Marshal.dump(self))
+  end
+end

data/lib/data_builder/core_ext/integer.rb

@@ -0,0 +1,11 @@
+class Integer
+  def days_from_today(format = '%D')
+    the_day = Date.today + self
+    the_day.strftime(format)
+  end
+
+  def days_ago(format = '%D')
+    the_day = Date.today - self
+    the_day.strftime(format)
+  end
+end

data/lib/data_builder/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+  def integer?
+    true if Integer(self)
+  rescue StandardError
+    false
+  end
+end

data/lib/data_builder/generation.rb

@@ -0,0 +1,13 @@
+require "data_builder/generation_date"
+require "data_builder/generation_standard"
+
+module DataBuilder
+  class Generation
+    include DateGeneration
+    include StandardGeneration
+
+    def initialize(parent)
+      @parent = parent
+    end
+  end
+end

data/lib/data_builder/generation_date.rb

@@ -0,0 +1,41 @@
+module DataBuilder
+  module DateGeneration
+    def today(format = '%D')
+      Date.today.strftime(format)
+    end
+
+    def tomorrow(format = '%D')
+      tomorrow = Date.today + 1
+      tomorrow.strftime(format)
+    end
+
+    def yesterday(format = '%D')
+      yesterday = Date.today - 1
+      yesterday.strftime(format)
+    end
+
+    def month
+      randomize(Date::MONTHNAMES[1..-1])
+    end
+
+    def month_abbr
+      randomize(Date::ABBR_MONTHNAMES[1..-1])
+    end
+
+    def day_of_week
+      randomize(Date::DAYNAMES)
+    end
+
+    def day_of_week_abbr
+      randomize(Date::ABBR_DAYNAMES)
+    end
+
+    alias db_today today
+    alias dn_tomorrow tomorrow
+    alias db_yesterday yesterday
+    alias db_month month
+    alias db_month_abbr month_abbr
+    alias db_day_of_week day_of_week
+    alias db_day_of_week_abbr day_of_week_abbr
+  end
+end

data/lib/data_builder/generation_standard.rb

@@ -0,0 +1,223 @@
+module DataBuilder
+  module StandardGeneration
+    attr_reader :parent
+
+    def full_name
+      Faker::Name.name
+    end
+
+    def first_name
+      Faker::Name.first_name
+    end
+
+    def last_name
+      Faker::Name.last_name
+    end
+
+    def name_prefix
+      Faker::Name.prefix
+    end
+
+    def name_suffix
+      Faker::Name.suffix
+    end
+
+    def title
+      Faker::Name.title
+    end
+
+    def street_address(include_secondary = false)
+      Faker::Address.street_address(include_secondary: include_secondary)
+    end
+
+    def secondary_address
+      Faker::Address.secondary_address
+    end
+
+    def city
+      Faker::Address.city
+    end
+
+    def state
+      Faker::Address.state
+    end
+
+    def state_abbr
+      Faker::Address.state_abbr
+    end
+
+    def zip_code
+      Faker::Address.zip
+    end
+
+    def country
+      Faker::Address.country
+    end
+
+    def credit_card_number
+      Faker::Business.credit_card_number
+    end
+
+    def credit_card_type
+      Faker::Business.credit_card_type
+    end
+
+    def phone_number
+      value = Faker::PhoneNumber.phone_number
+      remove_extension(value)
+    end
+
+    def cell_phone
+      value = Faker::PhoneNumber.cell_phone
+      remove_extension(value)
+    end
+
+    def company_name
+      Faker::Company.name
+    end
+
+    def catch_phrase
+      Faker::Company.catch_phrase
+    end
+
+    def words(number = 3)
+      Faker::Lorem.words(number: number).join(' ')
+    end
+
+    def sentence(min_word_count = 4)
+      Faker::Lorem.sentence(word_count: min_word_count)
+    end
+
+    def sentences(sentence_count = 3)
+      Faker::Lorem.sentences(number: sentence_count).join(' ')
+    end
+
+    def paragraphs(paragraph_count = 3)
+      Faker::Lorem.paragraphs(number: paragraph_count).join('\n\n')
+    end
+
+    def characters(character_count = 255)
+      Faker::Lorem.characters(number: character_count)
+    end
+
+    def email_address(name = nil)
+      Faker::Internet.email(name: name)
+    end
+
+    def domain_name
+      Faker::Internet.domain_name
+    end
+
+    def user_name
+      Faker::Internet.user_name
+    end
+
+    def url
+      Faker::Internet.url
+    end
+
+    alias db_first_name first_name
+    alias db_full_name full_name
+    alias db_last_name last_name
+    alias db_name_prefix name_prefix
+    alias db_name_suffix name_suffix
+    alias db_title title
+    alias db_street_address street_address
+    alias db_secondary_address secondary_address
+    alias db_city city
+    alias db_state state
+    alias db_state_abbr state_abbr
+    alias db_zip_code zip_code
+    alias db_country country
+    alias db_credit_card_number credit_card_number
+    alias db_credit_card_type credit_card_type
+    alias db_phone_number phone_number
+    alias db_cell_phone cell_phone
+    alias db_company_name company_name
+    alias db_catch_phrase catch_phrase
+    alias db_words words
+    alias db_sentence sentence
+    alias db_sentences sentences
+    alias db_paragraphs paragraphs
+    alias db_characters characters
+    alias db_email_address email_address
+    alias db_domain_name domain_name
+    alias db_user_name user_name
+    alias db_url url
+
+    def randomize(value)
+      case value
+        when Array then value[rand(value.size)]
+        when Range then rand((value.last + 1) - value.first) + value.first
+        else value
+      end
+    end
+
+    def sequence(value)
+      index = index_variable_for(value)
+      index = (index ? index + 1 : 0)
+      index = 0 if index == value.length
+      set_index_variable(value, index)
+      value[index]
+    end
+
+    def mask(value)
+      result = ''
+
+      value.each_char do |ch|
+        result += case ch
+                    when '#' then randomize(0..9).to_s
+                    when 'A' then ('A'..'Z').to_a[rand(26)]
+                    when 'a' then ('a'..'z').to_a[rand(26)]
+                    else ch
+                  end
+      end
+
+      result
+    end
+
+    alias db_randomize randomize
+    alias db_sequence sequence
+    alias db_mask mask
+
+    private
+
+    def process(value)
+      # rubocop:disable Security/Eval
+      eval value
+      # rubocop:enable Security/Eval
+    end
+
+    def remove_extension(phone)
+      index = phone.index('x')
+      phone = phone[0, (index - 1)] if index
+      phone
+    end
+
+    def set_index_variable(ary, value)
+      index_hash[index_name(ary)] = value
+    end
+
+    def index_variable_for(ary)
+      value = index_hash[index_name(ary)]
+      index_hash[index_name(ary)] = -1 unless value
+      index_hash[index_name(ary)]
+    end
+
+    def index_hash
+      dh = data_hash[parent]
+      data_hash[parent] = {} unless dh
+      data_hash[parent]
+    end
+
+    def index_name(ary)
+      "#{ary[0]}#{ary[1]}_index".gsub(' ', '_').downcase
+    end
+
+    def data_hash
+      # rubocop:disable Style/GlobalVars
+      $data_builder_data_hash ||= {}
+      # rubocop:enable Style/GlobalVars
+    end
+  end
+end

data/lib/data_builder/version.rb

@@ -1,3 +1,3 @@
 module DataBuilder
-  VERSION = "1.0.0".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides expressive data set handling from YAML files.
 email:
 - jeffnyman@gmail.com
@@ -105,10 +119,9 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
@@ -117,13 +130,19 @@ files:
 - data/default.yml
 - data_builder.gemspec
 - lib/data_builder.rb
+- lib/data_builder/core_ext/hash.rb
+- lib/data_builder/core_ext/integer.rb
+- lib/data_builder/core_ext/string.rb
+- lib/data_builder/generation.rb
+- lib/data_builder/generation_date.rb
+- lib/data_builder/generation_standard.rb
 - lib/data_builder/version.rb
 homepage: https://github.com/jeffnyman/data_builder
 licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ DataBuilder 1.0.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ DataBuilder 2.0.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -140,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Provides expressive data set handling from YAML files.

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.3