record_loader 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 159dabfb7769aebda7cb1c5fd9f77b67e728917876c769d663191caefc386a48
-  data.tar.gz: 64e7699028b6ca62daa1dd1bab3b9513f19a61affca1ce3df0f0b074cfc60315
+  metadata.gz: 9f743ea558870c1ddea1c262a64381725c6361f7a340cebc9bcff77e36a631ed
+  data.tar.gz: 40f7875e4cad259176da0f1b88591b5ac4934d07491db655d014a05098b3ad1e
 SHA512:
-  metadata.gz: 3dff12471dc11ca8b76a029e229240bb76f2b86e079c9149af0119525e4ce784c8875f33e17b92f3d2ca900eb7d7d6759bb589959f568af4a56ea9a6ede85454
-  data.tar.gz: a7506298753fe9e3d99a06b574312d00c975d93763c9a9715dc17ee5657cea60ab62fcacc5116dd36b57e2a538ecc26f841e2a0dc0891f9fa135052378a2595e
+  metadata.gz: 80b92f4b9ab83a6a46a7a363ed2e0205904bf6c10239566beeb04ee21152fc0ab809cb93fe9a22b019781a260a0cbec19fae8e7054f1011d700525ecb1b3c225
+  data.tar.gz: e834371ac808b6bad18f6f3708d9e0752a18419367260b6a182b31b88f2780b118fab20f03512c55d7e2a6a1acf2abb41fa5a2647002c1e8eae9c3e923d5a7e7

data/CHANGELOG.md

@@ -5,6 +5,13 @@ Unreleased section to make new releases easy.
 
 ## [Unreleased]
 
+## [0.1.1]
+
+- [Fixed] Preflight task on `rake release` now run prior to release.
+- [Fixed] Generators place config files in correct directory
+- [Documentation] Improved documentation regarding dependencies
+- [Documentation] Improved documentation regarding deployment
+
 ## [0.1.0]
 
 Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    record_loader (0.1.0)
+    record_loader (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -154,6 +154,39 @@ If you have an existing feature flag system you can use this instead by adding a
   end
 ```
 
+## RecordLoader Dependencies
+
+Sometimes one loader will be dependent on the output of another. If this is the case, you can simply configure
+its rake task to use the other as a pre-requisite.
+
+For example
+
+```ruby
+namespace :record_loader do
+  desc 'Automatically generate Dependent through DependentLoader'
+  task dependent: [:environment, :prerequisite] do
+    RecordLoader::DependentLoader.new.create!
+  end
+end
+```
+
+## Triggering on deployment
+
+It can be useful to set `rake record_loader:all` to run automatically on deployment.
+It is recommend you trigger this after migrations have run.
+
+### Within Sanger PSD
+
+**This section is relevant to developers within the Sanger only. Other users of the Gem should hook into their own deployment systems as they see fit.**
+
+In Production Software Development at the Sanger we have the Ansible deployment project configured to run
+`rake application:post_deploy` after migrations for selected applications. If you wish to take advantage of this
+uncomment the appropriate line in `lib/tasks/record_loader.rake`. You should also ensure that your application has
+the post_deploy tasks enabled by setting the post_deploy to true for your application.
+
+Currently this behaviour is configured as part of the 'rails' role, and will need to be set-up independently for
+any non-Rails ruby applications.
+
 ## Non Rails Environments
 
 In non-rails environments you can use the {RecordLoader::Adapter::Basic} adapter to avoid Rails specific functionality.

data/Rakefile

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+# We add preflight to the release task pre-requisites before loading in the
+# bundler/gem_tasks to ensure that it runs first. This is becuase 'release' is
+# actually composed entirely of pre-requisites and so would otherwise end up
+# running the pre-flight tasks AFTER everything else
+task release: :preflight
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -9,8 +15,6 @@ RuboCop::RakeTask.new
 
 task default: %i[rubocop spec]
 
-task release: :preflight
-
 desc 'Runs the preflight checklist before building a release'
 task :preflight do
   puts '🛫 Preflight checklist'

data/lib/generators/record_loader/static_files/record_loader.rake

@@ -9,3 +9,9 @@ namespace :record_loader do
     puts 'Loading all records'
   end
 end
+
+# In Sanger PSD we have the ansible deployment project configured to run `rake application:post_deploy` after migrations
+# for selected applications.
+# Uncomment the following to automatically trigger record loader on running the application:post_deploy task.
+# You may need to set `post_deploy: true` in the ansible configuration for your application.
+# task 'application:post_deploy' => 'record_loader:all'

data/lib/record_loader/version.rb

@@ -2,5 +2,5 @@
 
 module RecordLoader
   # @return [String] The current sem-ver version number
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: record_loader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Glover
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ files:
 - lib/generators/record_loader/record_loader_generator.rb
 - lib/generators/record_loader/static_files/application_record_loader.rb
 - lib/generators/record_loader/static_files/record_loader.rake
-- lib/generators/record_loader/templates/config/record_loader/%underscores%/default_records.yml
+- lib/generators/record_loader/templates/config/default_records/%underscores%/default_records.yml
 - lib/generators/record_loader/templates/lib/record_loader/%underscore_loader%.rb.tt
 - lib/generators/record_loader/templates/lib/tasks/record_loader/%underscore%.rake.tt
 - lib/generators/record_loader/templates/spec/data/record_loader/%underscores%/two_entry_example.yml
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Easily manage seeding and updating data from simple yml files