record_loader 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f743ea558870c1ddea1c262a64381725c6361f7a340cebc9bcff77e36a631ed
-  data.tar.gz: 40f7875e4cad259176da0f1b88591b5ac4934d07491db655d014a05098b3ad1e
+  metadata.gz: 3124ed2c75924cff8ca8199b02b8325ce115569990611d2936581318f5a26ff6
+  data.tar.gz: 22d2213737d370b87e2b3f57f2ab6d79a682d4ca82947a44abf4611ee665f6f5
 SHA512:
-  metadata.gz: 80b92f4b9ab83a6a46a7a363ed2e0205904bf6c10239566beeb04ee21152fc0ab809cb93fe9a22b019781a260a0cbec19fae8e7054f1011d700525ecb1b3c225
-  data.tar.gz: e834371ac808b6bad18f6f3708d9e0752a18419367260b6a182b31b88f2780b118fab20f03512c55d7e2a6a1acf2abb41fa5a2647002c1e8eae9c3e923d5a7e7
+  metadata.gz: ad50708c4c703d9ae0cc19a6049be3890d1a77c368439070d1647a17d122e0020814be9f510bec7d1a21de7995340a46eb69027ba621b7a6722583ea31f08ee3
+  data.tar.gz: 610ef99153702f568664ea03437c840e3d27670ba3f3ad227b36f796e2a7973c7c273d1d6da27114e952e0ad53d3476e5c781196eda53529c7513224627a7278

data/.github/workflows/cops_and_specs.yml

@@ -21,14 +21,10 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.5
-    - name: Install dependencies
-      run: bundle install
+        bundler-cache: true
     - name: Run Rubocop
       run: bundle exec rubocop
     - name: Test & publish code coverage

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.3
+2.7.4

data/CHANGELOG.md

@@ -3,7 +3,15 @@
 Keeps track of notable changes. Please remember to add new behaviours to the
 Unreleased section to make new releases easy.
 
-## [Unreleased]
+## [0.2.0]
+
+- [Added] `RecordLoader.export_attributes` for easy generation of yaml from
+           existing data
+- [Added] Improved feedback if exceptions raised during record creation
+- [Added] Improved templated yml files to use attributes from table
+- [Changed] Update name of yaml files generated as part of tests.
+            No changes are required to existing loaders.
+- [Fixed] Default yaml files correctly templated
 
 ## [0.1.1]
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    record_loader (0.1.1)
+    record_loader (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -67,4 +67,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.3.21

data/README.md

@@ -43,9 +43,18 @@ Or install it yourself as:
 If you are using Rails, you do not need to make any further changes, and all necessary hooks will be installed when
 generating your first record loader.
 
-## Usage (Rails)
+## How to run
+
+To execute all record loaders created for your project you can use the command:
+
+```bash
+    rake record_loader:all
+```
+
+## How to generate new records loaders for your project (Rails)
 
 RecordLoader provides a generator to automatically build a loader, specs and the yaml files necessary to use it.
+You may need to manually modify the contents of those files to adapt to the data type you are defining.
 In addition, the first time you use it it will automatically install the necessary rake files and configuration.
 You can access this by running:
 
@@ -62,12 +71,12 @@ Which will return the documentation:
 Suppose you want to create a loader to maintain a selection of product types. You'll first use the generator:
 
 ```bash
-  $ bundle exec rails g record_loader
+  $ bundle exec rails g record_loader product_type
        exist
       create  config/record_loader/product_types/default_records.yml
       create  lib/record_loader/product_type_loader.rb
       create  lib/record_loader/tasks/record_loader/product_type.rake
-      create  spec/data/record_loader/product_types/two_entry_example.yml
+      create  spec/data/record_loader/product_types/product_types_basic.yml
       create  spec/lib/record_loader/product_type_loader_spec.rb
         skip  lib/record_loader/application_record_loader.rb
    identical  lib/tasks/record_loader.rake
@@ -123,7 +132,7 @@ with the first argument being the key, and the second argument being the value,
 This contains the `record_loader:product_type` which will trigger the record loader, and also ensures that
 `record_loader:product_type` will get invoked on calling `record_loader:all`.
 
-#### `spec/data/record_loader/product_types/two_entry_example.yml`
+#### `spec/data/record_loader/product_types/product_types_basic.yml`
 
 A basic configuration for testing the loader. Tests use a separate directory to avoid coupling your specs to the data.
 
@@ -157,14 +166,15 @@ If you have an existing feature flag system you can use this instead by adding a
 ## 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.
+its rake task to use the other as a pre-requisite. Rake's dependency handling is smart enough to ensure each
+task only gets run once.
 
 For example
 
 ```ruby
 namespace :record_loader do
   desc 'Automatically generate Dependent through DependentLoader'
-  task dependent: [:environment, :prerequisite] do
+  task dependent: [:environment, 'record_loader:prerequisite'] do
     RecordLoader::DependentLoader.new.create!
   end
 end

data/lib/generators/record_loader/USAGE

@@ -32,5 +32,5 @@ Example:
       config/record_loader/my_things/default_records.yml
       lib/record_loader/my_thing_loader.rb
       lib/record_loader/tasks/record_loader/my_thing.rake
-      spec/data/record_loader/my_things/two_entry_example.yml
+      spec/data/record_loader/my_things/my_things_basic.yml
       spec/lib/record_loader/my_thing_loader_spec.rb

data/lib/generators/record_loader/record_loader_generator.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require 'record_loader/attribute'
+
 # Rails generator to automatically build record loaders
 # @see lib/generators/record_loader/USAGE
 class RecordLoaderGenerator < Rails::Generators::NamedBase
+  IGNORED_COLUMNS = %w[created_at updated_at].freeze
+
   source_root File.expand_path('templates', __dir__)
 
   class_option :record_class, type: :string, default: nil,
@@ -27,8 +31,35 @@ class RecordLoaderGenerator < Rails::Generators::NamedBase
               skip: true
   end
 
+  def build_example_hash(size = 2)
+    (1..size).each_with_object({}) do |iteration, store|
+      store["Unique #{record_key} #{iteration}"] = loader_attributes.each_with_object({}) do |attribute, config|
+        config[attribute.name] = attribute.value(iteration)
+      end
+    end
+  end
+
   private
 
+  def klass
+    @klass ||= record_class.constantize
+  end
+
+  def loader_attributes
+    klass.content_columns
+         .reject { |column| IGNORED_COLUMNS.include?(column.name) }
+         .map { |column| RecordLoader::Attribute.new(column.name, column.type, defaults[column.name]) }
+  end
+
+  # The defaults returned by content_columns are not coerced
+  def defaults
+    klass.column_defaults
+  end
+
+  def attributes_values(index)
+    loader_attributes.map { |a| "#{a.name}: #{a.ruby_value(index)}" }.join(', ')
+  end
+
   def loader_class_name
     "#{name.camelcase}Loader"
   end

data/lib/generators/record_loader/templates/config/default_records/%underscores%/{default_records.yml → default_records.yml.tt}

@@ -1,11 +1,6 @@
----
 # Add entries to this file to generate them automatically upon running
 # rake record_loader:all or rake record_loader:<%= underscore %>
 # If you want entries which are only created in development mode then simply
 # create a file in this directory ending in '.dev.yml'
 # You can add as many additional .yml files to this directory as you wish.
-# Example:
-# <%= record_key %> A:
-#   other_attribute: 'Value'
-# <%= record_key %> B:
-#   other_attribute: 'Value'
+<%= build_example_hash(2).to_yaml.gsub(/^/,'# ') %>

data/lib/generators/record_loader/templates/lib/record_loader/%underscore_loader%.rb.tt

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 # This file was automatically generated via `rails g record_loader`
 
 # RecordLoader handles automatic population and updating of database records
 # across different environments
 # @see https://rubydoc.info/github/sanger/record_loader/
 module RecordLoader
-  # Creates the specified plate types if they are not present
+  # Creates the specified <%= record_class %> if they are not present
   class <%= loader_class_name %> < ApplicationRecordLoader
     config_folder '<%= underscores %>'
 

data/lib/generators/record_loader/templates/spec/data/record_loader/%underscores%/{two_entry_example.yml → %underscores%_basic.yml.tt}

@@ -1,5 +1,3 @@
----
 # This file was automatically generated via `rails g record_loader`
 # You should modify it to match your particular model.
-Unique attribute: {}
-Unique attribute 2: {}
+<%= build_example_hash(2).to_yaml %>

data/lib/generators/record_loader/templates/spec/lib/record_loader/%underscore_loader%_spec.rb.tt

@@ -5,27 +5,35 @@ require 'record_loader/<%= underscore_loader %>'
 
 # This file was initially generated via `rails g record_loader`
 RSpec.describe RecordLoader::<%= loader_class_name %>, type: :model, loader: true do
-  subject(:record_loader) do
+  def a_new_record_loader
     described_class.new(directory: test_directory, files: selected_files)
   end
 
+  subject(:record_loader) { a_new_record_loader }
+
   # Tests use a separate directory to avoid coupling your specs to the data
   let(:test_directory) { Rails.root.join('spec/data/record_loader/<%= underscores %>') }
 
-  context 'with two_entry_example selected' do
-    let(:selected_files) { 'two_entry_example' }
+  context 'with <%= underscores %>_basic selected' do
+    let(:selected_files) { '<%= underscores %>_basic' }
 
     it 'creates two records' do
-      expect { record_loader.create! }.to change { <%= record_class %>.count }.by(2)
+      expect { record_loader.create! }.to change(<%= record_class %>, :count).by(2)
     end
 
     # It is important that multiple runs of a RecordLoader do not create additional
     # copies of existing records.
     it 'is idempotent' do
       record_loader.create!
-      expect { record_loader.create! }.not_to change { <%= record_class %>.count }
+      expect { a_new_record_loader }.not_to change(<%= record_class %>, :count)
     end
 
-    it 'sets attributes on the created records'
+    it 'sets attributes on the created records' do
+      record_loader.create!
+      expect(<%= record_class %>.all).to include(
+        have_attributes(<%= attributes_values(0) %>),
+        have_attributes(<%= attributes_values(1) %>)
+      )
+    end
   end
 end

data/lib/record_loader/attribute.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module RecordLoader
+  # Used by the generator to help guide the generation of the initial
+  # yaml files
+  class Attribute
+    BASE_TIME = Time.parse('2021-10-08 13:00:40 +0100')
+    BASE_DATE = Date.parse('2021-10-08')
+
+    # @return [String] The name of the attribute, takes the column name
+    attr_reader :name
+
+    # @return [Symbol] The attribute type (eg. :string) as returned by the rails connection adapter
+    attr_reader :type
+
+    # @return [Object] The default of the attribute
+    attr_reader :default
+
+    #
+    # Create a new attribute
+    #
+    # @param name [String] The name of the attribute, takes the column name
+    # @param type [Symbol] The attribute type (eg. :string) as returned by the rails connection adapter
+    # @param default [Object] The default value of the column
+    #
+    def initialize(name, type, default)
+      @name = name
+      @type = type
+      @default = default
+    end
+
+    def value(index)
+      if @default.nil?
+        value_for_type(index)
+      else
+        @default
+      end
+    end
+
+    def ruby_value(index)
+      case type
+      when :datetime, :timestamp then "Time.parse('#{value(index)}')"
+      when :date then "Date.parse('#{value(index)}')"
+      else
+        value(index).inspect
+      end
+    end
+
+    private
+
+    # If this gets much more complicated then consider separate classes for
+    # handling the type specific behaviour. Avoiding for now as I'm not sure it
+    # adds much
+    def value_for_type(index) # rubocop:disable Metrics/CyclomaticComplexity
+      case type
+      when :integer then index
+      when :datetime, :timestamp then BASE_TIME + index
+      when :date then BASE_DATE + index
+      when :boolean then false
+      when :float, :decimal then index.to_f
+      when :json then {}
+      else # Covers string and text, but also a fallback for other column types
+        "#{name.tr('_', ' ')} #{index}"
+      end
+    end
+  end
+end

data/lib/record_loader/base.rb

@@ -65,9 +65,10 @@ module RecordLoader
     #
     def initialize(files: nil, directory: default_path, dev: adapter.development?)
       @path = directory.is_a?(Pathname) ? directory : Pathname.new(directory)
-      @dev = dev
+
+      list = Filter.create(files: files, dev: dev, wip_list: wip_list)
       @files = @path.glob("*#{RecordFile::EXTENSION}")
-                    .select { |child| load_file?(files, RecordFile.new(child)) }
+                    .select { |child| list.include?(RecordFile.new(child)) }
       load_config
     end
 
@@ -80,6 +81,8 @@ module RecordLoader
       adapter.transaction do
         @config.each do |key, config|
           create_or_update!(key, config)
+        rescue StandardError => e
+          raise StandardError, "Failed to create #{key} due to: #{e.message}"
         end
       end
     end
@@ -125,26 +128,6 @@ module RecordLoader
       Pathname.pwd.join(*base_config_path, self.class.config_folder)
     end
 
-    #
-    # Indicates that a file should be loaded
-    #
-    # @param [Array] list provides an array of files (minus extenstions) to load
-    # @param [Pathname] file The file to check
-    #
-    # @return [Boolean] returns true if the file should be loaded
-    #
-    def load_file?(list, file)
-      if list.nil?
-        return @dev if file.dev?
-        return wip_list.include?(file.basename) if file.wip?
-
-        true
-      else
-        # If we've provided a list, that's all that matters
-        list.include?(file.basename)
-      end
-    end
-
     #
     # Load the appropriate configuration files into @config
     #

data/lib/record_loader/filter/file_list.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RecordLoader
+  module Filter
+    # FileList Filters handle determining whether a file is loaded based on the
+    # Supplied lift of files. WIP and environment flags are ignored.
+    class FileList
+      #
+      # Create a new FileList filter
+      #
+      # @param files [Array<String>,NilClass] pass in an array of file names to load, or nil to load all files.
+      #
+      def initialize(file_list)
+        @file_list = file_list
+      end
+
+      #
+      # Indicates that a file should be loaded. Compares the files base_name
+      # (ie. the name excluding extensions or wip/environment flags) against the
+      # provided list.
+      #
+      # @param [RecordLoader::RecordFile] file The file to check
+      #
+      # @return [Boolean] returns true if the file should be loaded
+      #
+      def include?(file)
+        @file_list.include?(file.basename)
+      end
+    end
+  end
+end

data/lib/record_loader/filter/standard.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RecordLoader
+  module Filter
+    # Filters handle determining whether a file is loaded based on the environment
+    # and WIP flags.
+    class Standard
+      #
+      # Create a new standard filter
+      #
+      # @param dev [Boolean] Override the rails environment to generate (or not)
+      #                      data from dev.yml files.
+      # @param wip_list [Array<String>] An array of currently active WIP flags.
+      #
+      def initialize(dev:, wip_list:)
+        @dev = dev
+        @wip_list = wip_list
+      end
+
+      #
+      # Indicates that a file should be loaded. Checks the environment flags
+      # against the current environment, or if the file is flagged as WIP
+      # check it against the active wip flags.
+      #
+      # @param [RecordLoader::RecordFile] file The file to check
+      #
+      # @return [Boolean] returns true if the file should be loaded
+      #
+      def include?(file)
+        return @dev if file.dev?
+        return @wip_list.include?(file.basename) if file.wip?
+
+        true
+      end
+    end
+  end
+end

data/lib/record_loader/filter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'filter/file_list'
+require_relative 'filter/standard'
+
+module RecordLoader
+  #
+  # {RecordLoader::Filter}s provide a means of determining if a file should be
+  # loaded. This is currently an internal mechanism, and no interface is
+  # provided for adding your own filters.
+  #
+  # = Existing Filters
+  # There are currently two adapters used
+  #
+  # - {RecordLoader::Filter::Standard}
+  # The default filter. Loads files based on environment and WIP flags. Used by
+  # {RecordLoader::Base} if no list of files is supplied.
+  #
+  # - {RecordLoader::Filter::FileList}
+  # Filters files solely based on a supplied list. Used by {RecordLoader::Base}
+  # if a list of files is supplied. Overides wip flag and environment specific
+  # behaviour.
+  #
+  # = Custom Filters
+  # There is currently no support for custom filters.
+  #
+  module Filter
+    # Returns the appropriate filter for the provided arguments:
+    # - {RecordLoader::Filter::FileList}
+    # If a list of files is supplied
+    # - {RecordLoader::Filter::Standard}
+    # Otherwise
+    #
+    # @param files [Array<String>,NilClass] pass in an array of file names to load, or nil to load all files.
+    #                                       Dev and wip flags will be ignored for files passed in explicitly
+    # @param dev [Boolean] Override the rails environment to generate (or not)
+    #                      data from dev.yml files.
+    # @param, wip_list [Array<String>] An array of currently active WIP flags.
+    # @return [RecordLoader::Filter::Standard, RecordLoader::Filter::FileList] An appropriate filter
+    def self.create(files: nil, dev: false, wip_list: [])
+      if files.nil?
+        RecordLoader::Filter::Standard.new(dev: dev, wip_list: wip_list)
+      else
+        RecordLoader::Filter::FileList.new(files)
+      end
+    end
+  end
+end

data/lib/record_loader/version.rb

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

data/lib/record_loader.rb

@@ -2,6 +2,7 @@
 
 require 'record_loader/version'
 require 'record_loader/adapter'
+require 'record_loader/filter'
 require 'record_loader/base'
 require 'record_loader/record_file'
 
@@ -12,4 +13,18 @@ require 'record_loader/railtie' if defined?(Rails)
 module RecordLoader
   # Raised when it appears RecordLoader is improperly configured
   ConfigurationError = Class.new(StandardError)
+
+  #
+  # Helper method to automatically generate config yaml for existing data.
+  # This method does not handle setting up associations as the best way of
+  # serializing that information is left up to the individual RecordLoader
+  #
+  # @param [ActiveRecord::Base] model_class A class to serialize
+  # @param [String] key The key to index by (eg. 'name')
+  # @return [String] Yaml listing the existing records
+  def self.export_attributes(model_class, key)
+    model_class.all.each_with_object({}) do |record, store|
+      store[record[key]] = record.attributes.except('id', 'updated_at', 'created_at', key)
+    end.to_yaml
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: record_loader
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - James Glover
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,7 +136,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -150,16 +149,20 @@ 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/default_records/%underscores%/default_records.yml
+- lib/generators/record_loader/templates/config/default_records/%underscores%/default_records.yml.tt
 - 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
+- lib/generators/record_loader/templates/spec/data/record_loader/%underscores%/%underscores%_basic.yml.tt
 - lib/generators/record_loader/templates/spec/lib/record_loader/%underscore_loader%_spec.rb.tt
 - lib/record_loader.rb
 - lib/record_loader/adapter.rb
 - lib/record_loader/adapter/basic.rb
 - lib/record_loader/adapter/rails.rb
+- lib/record_loader/attribute.rb
 - lib/record_loader/base.rb
+- lib/record_loader/filter.rb
+- lib/record_loader/filter/file_list.rb
+- lib/record_loader/filter/standard.rb
 - lib/record_loader/railtie.rb
 - lib/record_loader/record_file.rb
 - lib/record_loader/version.rb
@@ -185,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Easily manage seeding and updating data from simple yml files

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.17.3