nexus_seed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fb70231c76e859262ea28255d625d4904b99a2e4fae96da3baeb5f9a2e30f36
+  data.tar.gz: 53a9e3507714af99e8e826e11ebf55bae6e8f89ad0d5ba0c3e86a90f08562a76
+SHA512:
+  metadata.gz: 877f35fa660e49088ce1686eafc40cdc9d69a543c60910998764aaa6daaa7e58dea0b979c5bd02f7a8cd7fd199cd1d1695f0aa09fcec01f1169b7a6b020cda46
+  data.tar.gz: 837e9a61883bb53c460e4b3d57e1e8c0c53ccc547d3f20411b0a92f5608d3ae0eaa6823c4025e838e6ddf6a45b125881c3653213ff384cfe57bb31529700bee7

data/.gitignore

@@ -0,0 +1,3 @@
+.idea/
+.vscode/
+results/

data/.gitlab-ci.yml

@@ -0,0 +1,36 @@
+image: "ruby:2.7"
+
+stages:
+  - release
+  - test
+
+before_script:
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - mkdir -p ~/.gem
+    - cp $RUBYGEMS_CREDENTIALS ~/.gem/credentials
+    - chmod 0600 ~/.gem/credentials
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - sed -i "s/0.0.0/$CI_COMMIT_TAG/g" lib/nexus_seed/version.rb
+    - gem build nexus_seed.gemspec
+    - gem push nexus_seed*.gem
+  artifacts:
+    paths:
+      - nexus_seed*.gem
+    expire_in: 30 days

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+Style/ClassVars:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/GlobalVars:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop'
+gem 'rubocop-shopify', "~> 1.0.4", require: false
+
+gem 'rspec'

data/README.md

@@ -0,0 +1,3 @@
+# nexus_seed
+
+Common rails application seeding logic.

data/lib/nexus_seed/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module NexusSeed
+  # Leave this as 0.1.0 in order for CI process to replace with the tagged version.
+  VERSION = '0.1.0'
+end

data/lib/nexus_seed.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+require 'nexus_seed'
+
+module NexusSeed
+  # defaults
+  @@retry_limit = 0
+  @@sleep_interval = 5
+  @@retries = 0
+  @@logger = SemanticLogger::Logger.new('NexusSeed')
+
+  # override this method with your specific requirement
+  def requires
+    true
+  end
+
+  def run
+    logger.measure_info('Total seed run.') do
+      _run_internal
+    end
+  end
+
+  # recursively called until requirement is met or the limit is reached
+  def _run_internal
+    if Rails.env.test? || Rails.env.development?
+      if requires
+        seed
+
+      elsif retries >= retry_limit && retry_limit != 0
+        # log error stating seeding could not complete and task details
+        logger.warn('limit reached')
+
+      else
+        # sleep and increment retries
+        sleep(sleep_interval)
+        self.retries = retries + 1
+
+        # log retry attempts
+        logger.warn("retrying after #{sleep_interval}s. Retry #{retries} of #{retry_limit}")
+
+        # call itself
+        _run_internal
+      end
+    else
+      logger.error('Will not seed in this rails env.', env: Rails.env)
+    end
+  rescue => e
+    logger.error('Error during seed task.', exception: e)
+  end
+
+  # retry limit
+  def retries
+    @@retries
+  end
+
+  # sleep interval
+  def sleep_interval
+    @@sleep_interval
+  end
+
+  # retry limit
+  def retry_limit
+    @@retry_limit
+  end
+
+  def retry_limit=(limit)
+    @@retry_limit = limit
+  end
+
+  def sleep_interval=(seconds)
+    # nope
+    return if seconds.to_i == 0
+
+    @@sleep_interval = seconds
+  end
+
+  def retries=(retries)
+    @@retries = retries
+  end
+
+  def logger
+    @@logger
+  end
+
+  def task_options(opts = {})
+    self.retry_limit = opts[:retry_limit].to_i unless opts[:retry_limit].nil?
+    self.sleep_interval = opts[:sleep_interval].to_i unless opts[:sleep_interval].nil?
+  end
+end

data/nexus_seed.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative 'lib/nexus_seed/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "nexus_seed"
+  spec.version = NexusSeed::VERSION
+  spec.summary = "seed usage for nexus"
+  spec.authors = ["Johnathon Harris"]
+  spec.email = "john.harris@nexusmods.com"
+  # 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
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+  spec.add_dependency('nexus_semantic_logger', '~> 1.10.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: nexus_seed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johnathon Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nexus_semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: 
+email: john.harris@nexusmods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- lib/nexus_seed.rb
+- lib/nexus_seed/version.rb
+- nexus_seed.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: seed usage for nexus
+test_files: []