record_loader 0.1.0

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+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
+    described_class.new(directory: test_directory, files: selected_files)
+  end
+
+  # 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' }
+
+    it 'creates two records' do
+      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 }
+    end
+
+    it 'sets attributes on the created records'
+  end
+end

data/lib/record_loader/adapter/basic.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module RecordLoader
+  module Adapter
+    #
+    # A very basic {RecordLoader::Adapter} which provides limited logging
+    # functionality, environment is extracted from RACK_ENV
+    #
+    class Basic
+      # @return [Logger] The configured logger instance
+      attr_reader :logger
+
+      #
+      # Create a new {RecordLoader::Adapter::Basic}. Can pass in a pre-existing
+      # logger is required.
+      # @see https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html
+      #
+      # @param [#debug&#info&#warn#&error&#fatal] logger Optional logger object. Creates a new ruby Logger by default.
+      #
+      def initialize(logger: Logger.new(STDOUT))
+        @logger = logger
+      end
+
+      #
+      # Impliments the RecordLoader::Adapter interface by providing a transaction
+      # method. Used by {RecordLoader::Base.create!}. This implimentation
+      # yields immediately, but otherwise performs no other functions.
+      #
+      # @return [Void]
+      #
+      def transaction
+        yield
+      end
+
+      #
+      # Returns whether we are running in a development environment
+      # Determined by looking at RACK_ENV
+      #
+      # @return [Boolean] True if in development
+      #
+      def development?
+        ENV.fetch('RACK_ENV', 'unknown').casecmp?('development')
+      end
+    end
+  end
+end

data/lib/record_loader/adapter/rails.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RecordLoader
+  module Adapter
+    # An adapter designed for use with Rails applications. Automatically wraps {RecordLoader::Base.create!} in an
+    # active record transaction, and directs logging to the configure rails logger. Environment is extracted
+    # from Rails.env
+    class Rails
+      # Wraps Rails.logger method
+      # @return [#debug&#info&#warn#&error&#fatal]
+      def logger
+        ::Rails.logger
+      end
+
+      #
+      # Wraps the ActiveRecord::Base.transaction method.
+      # @see https://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html
+      # @return [Void]
+      def transaction(&block)
+        ActiveRecord::Base.transaction(&block)
+      end
+
+      #
+      # Returns whether we are running in a development environment
+      #
+      # @return [Boolean] True is in development
+      #
+      def development?
+        ::Rails.env.development?
+      end
+    end
+  end
+end

data/lib/record_loader/adapter.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'adapter/basic'
+require_relative 'adapter/rails'
+
+module RecordLoader
+  #
+  # {RecordLoader::Adapter}s provide a means of wrapping various framework
+  # methods in order to use {RecordLoader} outside of Rails and ActiveRecord.
+  #
+  # = Existing Adapters
+  # There are currently two adapters available
+  #
+  # - {RecordLoader::Adapter::Basic}
+  # A simple general purpose adapter which provides no support for transactions and only basic logging.
+  #
+  # - {RecordLoader::Adapter::Rails}
+  # An adapter designed for use with Rails applications. Automatically wraps {RecordLoader::Base.create!} in an
+  # active record transaction, and directs logging to the configure rails logger.
+  #
+  # = Custom Adapters
+  # It is possible to create custom adapters to use with your own frameworks. It is suggested that you inherit from
+  # {RecordLoader::Adapter::Basic} to provide forward compatibility with future versions of RecordLoader.
+  #
+  # Custom adapters should support three instance methods:
+  #
+  # - transaction(&block)
+  # Wraps the {RecordLoader::Base.create!} and allows you to handle transactional rollbacks in the event that
+  # something goes wrong. This method recieves a block and should be yielded to to generate the records.
+  #
+  # - logger
+  # Should return a logger object which impliments: debug, info, warn, error, fatal methods
+  #
+  # - development?
+  # Returns true if we are running in development mode.
+  #
+  # @example my_adapter.rb
+  #  class MyAdapter < RecordLoader::Adapter::Basic
+  #    def transaction
+  #      Database.open_transaction
+  #      yield
+  #      Database.commit_transaction
+  #    rescue StandardError
+  #      Database.abort_transaction
+  #    end
+  #
+  #    def logger
+  #      DistributedLoggingSystem.logger
+  #    end
+  #  end
+  #
+  # @example application_record_loader.rb
+  #  class ApplicationRecordLoader
+  #    adapter MyAdapter.new
+  #  end
+  module Adapter
+  end
+end

data/lib/record_loader/base.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RecordLoader
+  # Inherit from RecordLoader base to automatically load one or more yaml files
+  # into a @config hash. Config folders are found in config/default_records
+  # and each loader should specify its own subfolder by setting the config_folder
+  # class attribute.
+  class Base
+    # @return [Array] The default route to the yaml files containing the records
+    #                 path is relative to the root directory of your application
+    #                 and will contain a subfolder for each record loader.
+    BASE_CONFIG_PATH = %w[config default_records].freeze
+
+    class << self
+      # @overload  config_folder(config_folder)
+      #   Sets the folder, located under {BASE_CONFIG_PATH}, from which the records
+      #   will be loaded.
+      #
+      #   @param [String] config_folder Set the config folder for the class
+      #
+      #   @return [String] The configured config folder
+      #
+      # @overload  config_folder
+      #   Returns the folder, located under {BASE_CONFIG_PATH}, from which the records
+      #   will be loaded.
+      #
+      #   @return [String] The configured config folder
+      #
+      def config_folder(config_folder = nil)
+        @config_folder = config_folder unless config_folder.nil?
+        @config_folder
+      end
+
+      # @overload  adapter(adapter)
+      #   Sets the {RecordLoader::Adapter adapter} to use for the record loader, see the {RecordLoader::Adapter adapter}
+      #   for further information.
+      #
+      #   @param [Object] adapter Set the adapter to use for the class
+      #
+      #   @return [Object] The configured adapter
+      #
+      # @overload  adapter
+      #   Returns the configured adapter
+      #
+      #   @return [Object] The configured adapter
+      #
+      def adapter(adapter = nil)
+        @adapter = adapter unless adapter.nil?
+        @adapter || superclass.adapter
+      end
+    end
+
+    adapter RecordLoader::Adapter::Basic.new
+
+    #
+    # Create a new config loader from yaml files
+    #
+    # @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 directory [Pathname, String] The directory from which to load the files.
+    #   defaults to config/default_records/plate_purposes
+    # @param dev [Boolean] Override the rails environment to generate (or not) data from dev.yml files.
+    #
+    def initialize(files: nil, directory: default_path, dev: adapter.development?)
+      @path = directory.is_a?(Pathname) ? directory : Pathname.new(directory)
+      @dev = dev
+      @files = @path.glob("*#{RecordFile::EXTENSION}")
+                    .select { |child| load_file?(files, RecordFile.new(child)) }
+      load_config
+    end
+
+    #
+    # Opens a transaction and creates or updates each of the records in the yml files
+    # via the #create_or_update! method
+    #
+    # @return [Void]
+    def create!
+      adapter.transaction do
+        @config.each do |key, config|
+          create_or_update!(key, config)
+        end
+      end
+    end
+
+    private
+
+    #   Returns the configured adapter
+    #
+    #   @return [Object] The configured adapter
+    #
+    def adapter
+      self.class.adapter
+    end
+
+    #
+    # Returns the default route to the yaml files containing the records path
+    # is relative to the root directory of your application and will contain a
+    # subfolder for each record loader.
+    #
+    # Redefine this method in ApplicationRecordLoader to overide the default
+    # configuration.
+    #
+    # @example
+    #   RecordLoader::Base.base_config_path # => ['config', 'default_records']
+    #
+    # @return [Array] base path for record loader record
+    #
+    def base_config_path
+      BASE_CONFIG_PATH
+    end
+
+    # Returns an array of WIP flags
+    def wip_list
+      ENV.fetch('WIP', '').split(',')
+    end
+
+    #
+    # The default path to load config files from
+    #
+    # @return [Pathname] The directory containing the yml files
+    #
+    def default_path
+      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
+    #
+    def load_config
+      @config = @files.each_with_object({}) do |file, store|
+        latest_file = YAML.load_file(file)
+        duplicate_keys = store.keys & latest_file.keys
+        adapter.logger.warn "Duplicate keys in #{@path}: #{duplicate_keys}" unless duplicate_keys.empty?
+        store.merge!(latest_file)
+      end
+    end
+  end
+end

data/lib/record_loader/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RecordLoader
+  # Adds Railtie hooks for Rails usage
+  # This class is only loaded if rails is detected
+  # This sets up the generators
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/record_loader/record_file.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RecordLoader
+  # A RecordFile is a wrapper to handle categorization of the yaml files
+  # used by RecordLoader
+  class RecordFile
+    # @return [String] Extension of the yaml files to load.
+    EXTENSION = '.yml'
+    # @return [String] The tag immediately prior to the extension that flags a
+    #                  file as being development specific. For example a file
+    #                  names users.dev.yaml
+    DEV_IDENTIFIER = '.dev'
+    # @return [String] The tag immediately prior to the extension that flags a
+    #                  file as being work-in-progress. For example a file
+    #                  names new_feature.wip.yaml
+    WIP_IDENTIFIER = '.wip'
+
+    # Create a RecordFile wrapper for a given file
+    # @param record_file [Pathname] The path of the file to wrap
+    def initialize(record_file)
+      @record_file = record_file
+    end
+
+    # Returns the name of the file, minus the extension and dev/wip flags
+    # @return [String] The name of the file eg. "000_purpose"
+    def basename
+      without_extension.delete_suffix(WIP_IDENTIFIER)
+                       .delete_suffix(DEV_IDENTIFIER)
+    end
+
+    # Returns true if the file is development environment specific
+    # ie. ends in .dev.yml
+    # @return [Boolean] True if the file is a dev file
+    def dev?
+      without_extension.end_with?(DEV_IDENTIFIER)
+    end
+
+    # Returns true if the file is flagged as WIP
+    # ie. ends in .wip.yml
+    # @return [Boolean] True if the file is a wip file
+    def wip?
+      without_extension.end_with?(WIP_IDENTIFIER)
+    end
+
+    private
+
+    def without_extension
+      @record_file.basename(EXTENSION).to_s
+    end
+  end
+end

data/lib/record_loader/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RecordLoader
+  # @return [String] The current sem-ver version number
+  VERSION = '0.1.0'
+end

data/lib/record_loader.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'record_loader/version'
+require 'record_loader/adapter'
+require 'record_loader/base'
+require 'record_loader/record_file'
+
+# Only load the railtie is we detect rails
+require 'record_loader/railtie' if defined?(Rails)
+
+# Root namespace of RecordLoader
+module RecordLoader
+  # Raised when it appears RecordLoader is improperly configured
+  ConfigurationError = Class.new(StandardError)
+end

data/record_loader.gemspec

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'record_loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'record_loader'
+  spec.version       = RecordLoader::VERSION
+  spec.authors       = ['James Glover']
+  spec.email         = ['james.glover@sanger.ac.uk']
+
+  spec.summary       = 'Easily manage seeding and updating data from simple yml files'
+  spec.description   = 'Provides a simple interface for generating and maintaining database
+                        records across multiple environments in a simple and reproducible manner.'
+  spec.homepage      = 'https://www.github.com/sanger/record_loader'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  # 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'"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://www.github.com/sanger/record_loader'
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Development dependencies
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.82'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  # Pin simplecov to ~> 0.17 until CodeClimate compatibility
+  # issues resolved:
+  # https://github.com/codeclimate/test-reporter/issues/413
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: record_loader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Glover
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: |-
+  Provides a simple interface for generating and maintaining database
+                          records across multiple environments in a simple and reproducible manner.
+email:
+- james.glover@sanger.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/cops_and_specs.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/record_loader/USAGE
+- 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/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/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/base.rb
+- lib/record_loader/railtie.rb
+- lib/record_loader/record_file.rb
+- lib/record_loader/version.rb
+- record_loader.gemspec
+homepage: https://www.github.com/sanger/record_loader
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/sanger/record_loader
+  source_code_uri: https://www.github.com/sanger/record_loader
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Easily manage seeding and updating data from simple yml files
+test_files: []