fabrial 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84f5e2fcf01cf7ff1190a26ecea15da7b4220317
-  data.tar.gz: ee79f497a4789c6a08dfb185af9735bf71077862
+SHA256:
+  metadata.gz: bf013a11226fff5bf52dea812c36fcc95e8912f05d8118a8973727a7864125d6
+  data.tar.gz: 663a33a75e7e52a7e5f51be1476d0a250dc892a47fe0f8909b673fdeb7b6c23b
 SHA512:
-  metadata.gz: ecb80b0451e0d77e6d136e5bc019559d3f275ee0bd06d50e286435fa0060037dddf5c7fb927fc6dc5a0053e8a1d25c81ba7fbda2cb51b6940242fddee2cd55ab
-  data.tar.gz: 94f4ac89cd1a45d579d282b2de19167b2af9c5e1482539343d0f6271e16e37f676918eeaa65e2d828b920bfc5ec424a102212f607fd902bc89b8186d49adcc23
+  metadata.gz: 0b7bafadd06459481ddbc1e93e3598885976b9c1d93d44d8ac2319683554699f802f482988c3265c6dcf11df7ba27af4d45fafffecaf751dbc0b43ce9776f18f
+  data.tar.gz: 1949a259ec2c8f075241e54a11d9eebad8fde59473501af794b81e193772b26a331af245eeb36f14c247fe423f3b040881602a8115fce8d73a7263adb777cb01

data/.gitignore

@@ -6,3 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# Appraisal gemfiles
+/gemfiles/.bundle/
+/gemfiles/*.gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,261 @@
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+    - Whitelist
+    - Blacklist
+
+AllCops:
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  EnabledByDefault: true # Turn on all the cops!!
+  TargetRubyVersion: 2.3
+  Exclude:
+    - vendor/*
+    - gemfiles/**/*
+
+# Cops
+# ---------------------------------------------
+
+#################### Layout ###########################
+
+# I would like to turn this on, but the exception handling isn't good enough.
+# It raises an offense on the first definition that doesn't match the config,
+# and although you can disable there, if it is an earlier definition that threw
+# it off, there's no way to disable the actual exceptional case.
+#
+# For example:
+#
+# has_many :dashboards, through: :packages
+#
+# # rubocop:disable ClassStructure <-- this disable doesn't help
+# has_one :configuration, class_name: 'PracticeConfiguration'
+# # Dynamic alias to catch method override below
+# def practice_configuration # <-- out of order definition
+#   configuration
+# end
+# # rubocop:enable ClassStructure
+#
+# delegate :time_zone, to: :source # <-- offense raised here
+#
+# We'll want to keep an eye on this and see if it gets more capable over time.
+Layout/ClassStructure:
+  Enabled: false
+
+# I would like to turn this on, but it doesn't support two line method calls,
+# and wants to turn this:
+#
+# method(really_long_parameter_name, really_long_parameter_name,
+#   really_long_parameter_name, really_long_parameter_name)
+#
+# into this:
+#
+# method(
+#   really_long_parameter_name,
+#   really_long_parameter_name,
+# )
+#
+# At three lines I would like to switch styles, but two is too early
+#
+# I have opened an issue here: https://github.com/bbatsov/rubocop/issues/3393.
+# If it is resolved, we can turn this on.
+Layout/FirstMethodParameterLineBreak: { Enabled: false }
+
+# These are similar to the above FirstMethodParameterLineBreak
+Layout/FirstArrayElementLineBreak: { Enabled: false }
+Layout/FirstHashElementLineBreak: { Enabled: false }
+Layout/FirstMethodArgumentLineBreak: { Enabled: false }
+Layout/MultilineMethodArgumentLineBreaks: { Enabled: false }
+Layout/MultilineArrayLineBreaks: { Enabled: false }
+Layout/MultilineHashKeyLineBreaks: { Enabled: false }
+
+# This requires that function calls spanning multiple lines have the parameters
+# line up.  I only care if they are indented a little further.
+Layout/AlignParameters: { Enabled: false }
+
+# This requires that hashes spanning multiple lines have the elements
+# line up.  I only care if they are indented a little further.
+Layout/AlignHash: { Enabled: false }
+
+# This requires that arrays spanning multiple lines have the elements
+# line up.  I only care if they are indented a little further.
+Layout/AlignArray: { Enabled: false }
+
+Layout/MultilineAssignmentLayout: { Enabled: false } # Agreed, should be disabled
+
+Layout/IndentFirstArrayElement: { EnforcedStyle: consistent }
+
+Layout/EmptyLineBetweenDefs:
+  # If `true`, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: true
+
+# Sometimes we want to comment the arguments to a method and therefore need a
+# blank line separating the commented arg from the rest.  This would prevent
+# that.
+Layout/EmptyLinesAroundArguments: { Enabled: false }
+
+# I would force the default mode `with_first_argument`, for all calls over 2
+# lines if I could.
+Layout/AlignArguments: { EnforcedStyle: with_fixed_indentation }
+
+Layout/IndentFirstArgument: { EnforcedStyle: consistent }
+
+Layout/MultilineOperationIndentation: { EnforcedStyle: indented }
+
+Layout/MultilineMethodCallIndentation: { EnforcedStyle: indented }
+
+#################### Lint ##################################
+
+# This wants us to rewrite things like
+#
+# assert categories.any? { |c| c.appointment_category_id == 'GRM' }
+#
+# with
+#
+# assert(categories.any? { |c| c.appointment_category_id == 'GRM' })
+#
+# I don't like the extra parenthesis and expect our devs to know block
+# precedence.
+Lint/AmbiguousBlockAssociation: { Enabled: false }
+
+Lint/NumberConversion: { Enabled: false } # I like `.to_i`
+
+# Ignoring implicit references allows us to use the implicit passing of an
+# argument to `super` to count as an argument reference, without causing an
+# offense.
+Lint/ShadowedArgument: { IgnoreImplicitReferences: true }
+
+#################### Metrics ###############################
+
+# Defaults to 100, we relax it a bit.
+Metrics/ModuleLength: { Max: 150 }
+Metrics/ClassLength: { Max: 150 }
+
+# Defaults to 79, cut us a little slack
+Metrics/LineLength: { Max: 89 }
+
+# Defaults to 10, functions can be longer than 10 lines!!!
+Metrics/MethodLength: { Max: 40 }
+
+# Cut a bit more slack, but still warn on overly complex functions
+Metrics/CyclomaticComplexity: { Max: 10 }
+
+# Up the allowed complexity a little
+Metrics/PerceivedComplexity: { Max: 10 }
+
+# Increase max function size
+Metrics/AbcSize: { Max: 50 }
+
+################## Migration #############################
+
+# Agreed, should be off
+Migration/DepartmentName: { Enabled: false }
+
+#################### Naming ##############################
+
+# This defaults to 'e', we like names a little more descriptive than that.
+Naming/RescuedExceptionsVariableName: { PreferredName: err }
+
+#################### Style ###############################
+
+Style/Copyright: { Enabled: false } # we don't do copyright comments
+Style/Documentation: { Enabled: false } # don't enforce documentation (classes)
+Style/DocumentationMethod: { Enabled: false } # don't enforce documentation
+Style/InlineComment: { Enabled: false } # I like trailing comments.
+Style/MethodCallWithArgsParentheses: { Enabled: false } # I don't like parens
+Style/MethodCalledOnDoEndBlock: { Enabled: false } # chaining is ok
+Style/MissingElse: { Enabled: false } # else's not required
+Style/Send: { Enabled: false } # send is ok
+Style/StringHashKeys: { Enabled: false } # when we use strings, we mean to
+
+# We prefer `rescue => e` to `rescue StandardError => e`.  This is default Ruby
+# behavior and we expect devs to know it.
+Style/RescueStandardError: { EnforcedStyle: implicit }
+
+# They default the arguments to [acc, elem], which, although more expressive,
+# make it much harder to fit expressions on a single line.
+Style/SingleLineBlockParams:
+  Methods:
+    - reduce: [a, e]
+    - inject: [a, e]
+
+# I really like this one, but I cannot until they again support the
+# MaxLineLength option.  Without this, it forces us to write lines longer that
+# 80 characters.  I have an open issue here:
+# https://github.com/rubocop-hq/rubocop/issues/6077
+Style/IfUnlessModifier:
+  # MaxLineLength: 80
+  Enabled: false
+
+# This prevents method chaining if the function takes a multiline block, I agree
+# that those should be used carefully/spairingly to maintain readability, but in
+# general, they are ok.
+Style/MultilineBlockChain: { Enabled: false }
+
+Style/TrailingCommaInArrayLiteral: { EnforcedStyleForMultiline: comma }
+
+# I would love to turn this on, because I like the trailing comma, the problem
+# is that it *always* wants a comma, which results in weird things like this:
+#     },
+#   },
+# }
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  EnforcedStyleForMultiline: comma
+
+# I would love to turn this on, because I like the trailing comma, the problem
+# is that it *always* wants a comma, include if it is just a long single
+# argument like this:
+# group_concat(
+#   species.call.description
+#     .op('ORDER BY', species.call.description)
+#     .op('SEPARATOR', '||')
+#     .op('SEPARATOR', '||')*,*
+# ).as(patient_species)
+#
+# I have opened an issue here: https://github.com/bbatsov/rubocop/issues/3392.
+# We can enable this cop if/when it is resolved.
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+  Enabled: false
+
+# The default here, nested, takes up WAY to much left indent space.
+Style/ClassAndModuleChildren: { EnforcedStyle: compact }
+
+# Use [] for array % literals that create arrays, () for ones that create single
+# items, and {} for regex
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': '[]'
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+# `MinBodyLength` defines the number of lines of the a body of an if / unless
+# needs to have to trigger this cop
+Style/GuardClause: { MinBodyLength: 3 }
+
+# Sometimes nesting if's can greatly improve readability
+Style/IfInsideElse: { Enabled: false }
+
+# I prefer methods with a few parenthesis as possible.  This is a departure from
+# the community style guide.
+Style/NestedParenthesizedCalls: { Enabled: false }
+
+# Based on the arguments from here:
+# https://www.practicingruby.com/articles/ruby-and-the-singleton-pattern-dont-get-along,
+# I now prefer using `extend self` over `module_function` (mostly because of the
+# ability to define private methods).  This is a departure from the community
+# style guide here: https://github.com/bbatsov/ruby-style-guide#module-function,
+# but the guide dosen't give any justification for its reasoning, so I'm
+# comfortable defying it.
+Style/ModuleFunction: { Enabled: false }
+
+# Prefer `%{foo}` over `%<foo>s`
+Style/FormatStringToken: { EnforcedStyle: template }

data/.ruby-gemset

@@ -0,0 +1 @@
+fabrial

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.8

data/.travis.yml

@@ -1,5 +1,11 @@
-sudo: false
 language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.16.1
+cache: bundler
+script:
+  - bundle exec rubocop
+  - bundle exec rake
+
+gemfile:
+  - gemfiles/activerecord_4.2.0.gemfile
+  - gemfiles/activerecord_5.0.2.gemfile
+  - gemfiles/activerecord_5.1.0.gemfile
+  - gemfiles/activerecord_5.2.2.gemfile

data/Appraisals

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+appraise 'activerecord_4.2.0' do
+  gem 'activerecord', '~> 4.2.0', require: 'active_record'
+  gem 'activesupport', '~> 4.2.0', require: 'active_support/all'
+end
+
+appraise 'activerecord_5.0.2' do
+  gem 'activerecord', '~> 5.0.2', require: 'active_record'
+  gem 'activesupport', '~> 5.0.2', require: 'active_support/all'
+end
+
+appraise 'activerecord_5.1.0' do
+  gem 'activerecord', '~> 5.1.0', require: 'active_record'
+  gem 'activesupport', '~> 5.1.0', require: 'active_support/all'
+end
+
+appraise 'activerecord_5.2.2' do
+  gem 'activerecord', '~> 5.2.2', require: 'active_record'
+  gem 'activesupport', '~> 5.2.2', require: 'active_support/all'
+end

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in fabrial.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    fabrial (0.1.0)
+      activerecord (> 4.2.0, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.3.8)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.17.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.0)
+    rubocop (0.75.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2, >= 2.2.0)
+  bundler (~> 1.0)
+  database_cleaner
+  fabrial!
+  minitest (~> 5.12, >= 5.12.2)
+  minitest-focus (~> 1.1, >= 1.1.2)
+  minitest-reporters (~> 1.3, >= 1.3.8)
+  pry
+  pry-byebug
+  rake (~> 13.0)
+  rubocop (~> 0.75.0)
+  sqlite3 (~> 1.3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Jeremy Mickelson
+Copyright (c) 2019 AllyDVM INC.
 
 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,15 +1,12 @@
 # Fabrial
 
-COMMING SOON
+![Travis (.org)](https://img.shields.io/travis/allydvm/fabrial)
+![Gem](https://img.shields.io/gem/v/fabrial)
+![GitHub](https://img.shields.io/github/license/allydvm/fabrial)
 
-Fabrial makes it easy and pleasant to create your test data, directly inline
-with your tests, removing the need for hard to maintain fixture files or
-blueprints.
-
-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/fabrial`. To experiment with that code, run `bin/console` for an
-interactive prompt.
+Fabrial makes it easy to follow the "Arrange, Act, Assert" pattern in your tests.
+It makes it trivial to create your test data directly inline with your tests;
+removing the need for hard-to-maintain fixture files or blueprints.
 
 ## Installation
 
@@ -27,19 +24,9 @@ Or install it yourself as:
 
     $ gem install fabrial
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. 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/CyborgMaster/fabrial.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/allydvm/fabrial).
 
 ## License
 

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "fabrial"
+require 'bundler/setup'
+require 'fabrial'
 
 # 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 'pry'
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require 'irb'
+# IRB.start(__FILE__)

data/fabrial.gemspec

@@ -1,25 +1,28 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "fabrial/version"
+require 'fabrial/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fabrial"
+  spec.name          = 'fabrial'
   spec.version       = Fabrial::VERSION
-  spec.authors       = ["Jeremy Mickelson"]
-  spec.email         = ["jeremy.mickelson@gmail.com"]
+  spec.authors       = ['Jeremy Mickelson', 'Tad Thorley', 'Ralph Mickelson']
+  spec.email         = ['jeremy.mickelson@gmail.com']
 
   spec.summary       = 'Simply create test data inline with your tests'
   spec.description   = <<~DESCRIPTION
-    Fabrial makes it easy and pleasant to create your test data, directly inline
-    with your tests, removing the need for hard to maintain fixture files or
-    blueprints.
+    Fabrial makes it easy to follow the "Arrange, Act, Assert" pattern in your tests.
+    It makes it trivial to create your test data directly inline with your tests;
+    removing the need for hard-to-maintain fixture files or blueprints.
   DESCRIPTION
 
-  spec.homepage      = 'https://github.com/CyborgMaster/fabrial'
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/allydvm/fabrial'
+  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.
+  # 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'"
   # else
@@ -30,11 +33,23 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3.8'
+
+  spec.add_dependency 'activerecord', '> 4.2.0', '< 6.0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'appraisal', '~> 2.2', '>= 2.2.0'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'minitest', '~> 5.12', '>= 5.12.2'
+  spec.add_development_dependency 'minitest-focus', '~> 1.1', '>= 1.1.2'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.3', '>= 1.3.8'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.75.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.0'
 end

data/gemfiles/activerecord_4.2.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0", require: "active_record"
+gem "activesupport", "~> 4.2.0", require: "active_support/all"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.0.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.2", require: "active_record"
+gem "activesupport", "~> 5.0.2", require: "active_support/all"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.1.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0", require: "active_record"
+gem "activesupport", "~> 5.1.0", require: "active_support/all"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.2.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.2", require: "active_record"
+gem "activesupport", "~> 5.2.2", require: "active_support/all"
+
+gemspec path: "../"

data/lib/fabrial.rb

@@ -1,5 +1,39 @@
-require "fabrial/version"
+# frozen_string_literal: true
+
+require 'fabrial/version'
+require 'fabrial/errors'
+require 'fabrial/fabricate'
+require 'fabrial/create'
 
 module Fabrial
-  # Your code goes here...
+  extend Fabricate
+  extend Create
+  self.defaults = {}
+
+  @before_fabricate = nil
+  def self.before_fabricate(&block)
+    @before_fabricate = block
+  end
+
+  def self.run_before_fabricate(objects)
+    if @before_fabricate
+      @before_fabricate&.call objects
+    else
+      objects
+    end
+  end
+
+  @before_create = nil
+  def self.before_create(&block)
+    @before_create = block
+  end
+
+  def self.run_before_create(klass, data, ancesstors, children)
+    @before_create&.call klass, data, ancesstors, children
+  end
+
+  def self.reset
+    @before_fabricate = nil
+    @before_create = nil
+  end
 end

data/lib/fabrial/create.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Create
+  attr_accessor :defaults
+
+  def create(klass, data = {})
+    # Find the base class of any STI types
+    base = klass.base_class
+
+    default_data = defaults[klass]
+    default_data ||= defaults[base]
+    default_data ||= {}
+
+    data = default_data.merge data
+    klass.create! data
+  end
+
+  module AutoIds
+    extend self
+
+    @ids = {}
+
+    # Get the next auto-incrementing id for the given klass
+    def next(klass)
+      id = @ids[klass] || 1
+      @ids[klass] += 1
+      id
+    end
+  end
+end

data/lib/fabrial/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Fabrial
+  class Error < RuntimeError; end
+  class UnknownClassError < Error; end
+end

data/lib/fabrial/fabricate.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+# TODO: properly hook up parent associations for pre-created objects passed in
+
+module Fabrial::Fabricate
+  # Make expects a nested hash of type => data or [data]
+  def fabricate(objects)
+    objects = Fabrial.run_before_fabricate objects
+    add_default_return objects
+
+    ancestors = {}
+    returns = make_types objects, ancestors
+
+    # If returns is made up of pairs, return a hash.
+    if returns.first.is_a? Array
+      returns.to_h
+    else
+      returns.length <= 1 ? returns.first : returns
+    end
+  end
+
+  # If a return object(s) wasn't specified, default to returning the first
+  # object.
+  # TODO: Raise error if mixing array and hash return styles
+  def add_default_return(objects)
+    return if contains_return? objects
+
+    ret = objects.values.find do |v|
+      v.is_a?(Hash) || (v.is_a?(Array) && !v.empty?)
+    end
+    if ret
+      ret = ret.first if ret.is_a? Array
+      ret[:RETURN] = true
+    end
+  end
+
+  private
+
+  def contains_return?(objects)
+    return false unless objects.is_a? Hash
+
+    objects.key?(:RETURN) || objects.any? do |_k, v|
+      v.is_a?(Hash) && contains_return?(v) ||
+        v.is_a?(Array) && v.any?(&method(:contains_return?))
+    end
+  end
+
+  # TO REMOVE;
+  # Setup default source and practice if not provided
+  # def add_defaults(objects)
+  #   return objects if objects.delete :NO_DEFAULTS
+
+  #   unless %i[source sources].any? { |k| objects.key? k }
+  #     objects = { source: default_source.merge(objects) }
+  #   end
+
+  #   # We can only make a default practice if we are dealing with a single sync
+  #   # client.
+  #   source = objects[:source]
+  #   if source.is_a?(Hash)
+  #     unless %i[practice practices].any? { |p| source.key? p }
+  #       children = extract_child_records Practice, source
+  #       source[:practice] = default_practice.merge children
+  #     end
+  #   end
+
+  #   objects
+  # end
+
+  # return_skip_levels allows us to skip created default practices and
+  # sources when choosing an object to return.
+  def make_types(objects, ancestors)
+    returns = []
+    objects.each do |type, data|
+      klass = get_class(type)
+      if klass.nil?
+        raise Fabrial::UnknownClassError, "Class #{type} does not exist"
+      end
+
+      returns.concat make_type klass, data, ancestors
+    end
+    returns
+  end
+
+  def make_type(klass, data_list, ancestors)
+    returns = []
+
+    # TODO: may need a hook here
+    # ::Maker.next_bank klass # Needed if we aren't in test
+
+    associations = collect_associations(klass, ancestors)
+    Array.wrap(data_list).each do |data|
+      should_return = data.delete :RETURN
+      children = extract_child_records klass, data
+      run_before_create klass, data, ancestors, children
+      object = make_object klass, data, associations
+
+      # Make sure new object is added as last item of ancestor hash
+      # collect_associations expects this in order to hook up polymorphic fields
+      next_ancestors = ancestors.dup.except klass
+      next_ancestors[klass] = object
+
+      if should_return
+        # If `RETURN` holds a value, use it as the key.
+        returns << if should_return == true
+                     object
+                   else
+                     [should_return, object]
+                   end
+      end
+
+      returns.concat make_types children, next_ancestors
+    end
+    returns
+  end
+
+  def make_object(klass, data, associations)
+    # Check for already created object
+    return data[:object] if data[:object]
+
+    type_col = klass.inheritance_column.try :to_sym
+    type = data.delete(type_col).try :safe_constantize
+    type ||= klass
+    create type, data.reverse_merge(associations)
+  end
+
+  def collect_associations(klass, ancestors)
+    associations = collect_parents(klass, ancestors)
+    if (p = polymorphic(klass))
+      associations[p] = ancestors.values.last
+    end
+    associations
+  end
+
+  def extract_child_records(klass, data)
+    children = data.select do |type, v|
+      # Must have nested data
+      [Array, Hash].any? { |c| v.is_a? c } &&
+        # Must be a class that we can instantiate
+        get_class(type) &&
+
+        # Even if it has the same name as a Model in the system, if it is also
+        # the name of a column in the table, assume the data is for a serialzed
+        # field and not a nested relation.  Ex: Requests have a serialized field
+        # called content and there is also a Content model in the system.
+        (
+          # If they are using a class as the key, then always choose the class
+          # over the field.
+          type.is_a?(Class) ||
+
+            !column_names(klass).include?(type.to_s)
+        )
+    end
+    data.extract!(*children.keys)
+  end
+
+  def column_names(klass)
+    klass.column_names
+
+    # our project uses
+    # klass.column_names_including_stored
+  end
+
+  # TO REMOVE:
+  # def add_implicit_owner(klass, ancestors, children)
+  #   {
+  #     [Client, Patient] => Owner,
+  #     [Enterprise, Practice] => EnterpriseMembership,
+  #   }. each do |connected, connector|
+  #     next unless (connected.delete klass) && (ancestors.key? connected[0])
+
+  #     unless children.key? connector.name.demodulize.underscore.to_sym
+  #       children.reverse_merge! connector => {}
+  #     end
+  #   end
+  # end
+
+  def collect_parents(klass, ancestors)
+    associations = klass.reflect_on_all_associations
+    polymorphics = associations.select(&:polymorphic?)
+    associations
+      .select do |a|
+        (!a.collection? || a.macro == :has_and_belongs_to_many) &&
+          !a.polymorphic? &&
+
+          # This is to throw out specified versions of polymorphic associations.
+          # Ex: Alert has a polymorphic association called `alertable` and two
+          # other associations, `alertable_patient` and `alertable_client` that
+          # allow joining to specific tables.  These specified associations
+          # should be skipped.
+          polymorphics.none? do |other|
+            other != a && other.name.to_s == a.name.to_s.split('_').first
+          end
+      end
+      .select { |a| ancestors.key? a.klass } # Find ancestors that match
+      .map do |a| # Create data hash
+        if a.macro == :has_and_belongs_to_many
+          [a.name, [ancestors[a.klass]]]
+        else
+          [a.name, ancestors[a.klass]]
+        end
+      end.to_h
+  end
+
+  def polymorphic(klass)
+    klass.reflect_on_all_associations
+      .select(&:polymorphic?)
+      .map { |a| a.class_name.underscore.to_sym }[0]
+  end
+
+  def get_class(type)
+    return type if type.is_a? Class
+
+    type.to_s.classify.safe_constantize ||
+      type.to_s.classify.pluralize.safe_constantize
+  end
+
+  # TO REMOVE:
+  # DEFAULT_SOURCE_ID = -123
+  # public_constant :DEFAULT_SOURCE_ID
+  # def default_source
+  #   c = Source.find_by id: DEFAULT_SOURCE_ID
+  #   c ? { object: c } : { id: DEFAULT_SOURCE_ID }
+  # end
+  #
+  # DEFAULT_PRACTICE_ID = -456
+  # public_constant :DEFAULT_PRACTICE_ID
+  # def default_practice
+  #   p = Practice.find_by id: DEFAULT_PRACTICE_ID
+  #   p ? { object: p } : { id: DEFAULT_PRACTICE_ID }
+  # end
+end

data/lib/fabrial/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module Fabrial
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
+  public_constant :VERSION
 end

metadata

@@ -1,61 +1,219 @@
 --- !ruby/object:Gem::Specification
 name: fabrial
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Mickelson
+- Tad Thorley
+- Ralph Mickelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2019-10-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '5.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.2
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.75.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 description: |
-  Fabrial makes it easy and pleasant to create your test data, directly inline
-  with your tests, removing the need for hard to maintain fixture files or
-  blueprints.
+  Fabrial makes it easy to follow the "Arrange, Act, Assert" pattern in your tests.
+  It makes it trivial to create your test data directly inline with your tests;
+  removing the need for hard-to-maintain fixture files or blueprints.
 email:
 - jeremy.mickelson@gmail.com
 executables: []
@@ -63,17 +221,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
+- Appraisals
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - fabrial.gemspec
+- gemfiles/activerecord_4.2.0.gemfile
+- gemfiles/activerecord_5.0.2.gemfile
+- gemfiles/activerecord_5.1.0.gemfile
+- gemfiles/activerecord_5.2.2.gemfile
 - lib/fabrial.rb
+- lib/fabrial/create.rb
+- lib/fabrial/errors.rb
+- lib/fabrial/fabricate.rb
 - lib/fabrial/version.rb
-homepage: https://github.com/CyborgMaster/fabrial
+homepage: https://github.com/allydvm/fabrial
 licenses:
 - MIT
 metadata: {}
@@ -85,15 +255,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Simply create test data inline with your tests