one_off 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cc793a7ba8fa8c0f6a59bf94feda1a7e1c90a7902dc68fe3a641e608db9ecf8
+  data.tar.gz: 88fd5c273f09d626cf41ed28060695d86da63f8daf984aa1979eaad547230c21
+SHA512:
+  metadata.gz: a1e15673ac6fd993c35375bdfb8efee813c757d5ae8898f2dac672c13cab3b822a234ce8c670f2981b6ed4daceaa36a38f672f8be8573a909762690cdb4ef8bd
+  data.tar.gz: 2b6ef33ec59955e18e64cf2089df84a31e2e4248f51ae5e4c378bf6c6772d476d7b2cd98cecd6a5a84bc1c54e99049829b157edd6217222d2a15e4bb17679ca8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Hamed Asghari
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# OneOff
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'one_off'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install one_off
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OneOff'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/jobs/one_off/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OneOff
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/one_off/executor_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OneOff
+  class ExecutorJob < ApplicationJob
+    def perform(file)
+      require "#{Rails.root}/db/one_off/#{file.filename}"
+      Rails.logger.info "=== Starting one_off task #{file.task_name}"
+      OneOff.const_get(file.task_name.camelize).new.call
+      Rails.logger.info "=== Finished one_off task #{file.task_name}"
+    end
+  end
+end

data/app/models/one_off/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OneOff
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/one_off/task.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OneOff
+  class Task < ApplicationRecord
+  end
+end

data/db/migrate/20200324033752_create_one_off_tasks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateOneOffTasks < ActiveRecord::Migration[6.0]
+  def change
+    create_table :one_off_tasks do |t|
+      t.string :version
+    end
+
+    add_index :one_off_tasks, :version, unique: true
+  end
+end

data/lib/generators/one_off/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator will create a one_off script to be executed when code is deployed to production.
+
+Example:
+    rails generate one_off name_of_your_task
+
+    This will create:
+        db/one_off/<timestamp>_name_of_your_task.rb

data/lib/generators/one_off/one_off_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class OneOffGenerator < Rails::Generators::NamedBase
+  def create_one_off_file
+    timestamp = Time.zone.now.strftime('%Y%m%d%H%M%S')
+    create_file "db/one_off/#{timestamp}_#{file_name}.rb", <<~FILE
+      require 'one_off/environments'
+
+      module OneOff
+        class #{class_name}
+          include Environments
+
+          environments :development, :production
+
+          def perform
+          end
+        end
+      end
+    FILE
+  end
+end

data/lib/one_off/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OneOff
+  class Engine < ::Rails::Engine
+    isolate_namespace OneOff
+    config.generators.api_only = true
+  end
+end

data/lib/one_off/environments.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OneOff
+  module Environments
+    extend ActiveSupport::Concern
+
+    included do
+      def call
+        perform if Array.wrap(self.class.__environments).include?(Rails.env)
+      end
+
+      def perform
+        raise NotImplementedError
+      end
+    end
+
+    class_methods do
+      attr_reader :__environments
+
+      def environments(*envs)
+        @__environments = envs.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/one_off/file.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OneOff
+  class File
+    include GlobalID::Identification
+
+    REGEX = /\A(\d{14})_(\w+)\z/.freeze
+
+    class << self
+      def all
+        Dir.glob('db/one_off/*.rb', base: Rails.root)
+          .map { |f| ::File.basename(f, '.rb') }
+          .select { |f| REGEX.match(f) }
+          .map { |f| new(f) }
+      end
+
+      def find(id)
+        all.find { |file| file.id == id.to_i }
+      end
+    end
+
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def file_name_match
+      @file_name_match ||= REGEX.match(filename)
+    end
+
+    def version
+      file_name_match[1].to_i
+    end
+
+    alias id version
+
+    def task_name
+      file_name_match[2]
+    end
+  end
+end

data/lib/one_off/migrator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OneOff
+  class Migrator
+    class << self
+      def run(files: pending_files)
+        files.sort_by(&:version).each do |file|
+          OneOff::ExecutorJob.perform_later(file)
+          Rails.logger.info "=== Queued one_off task #{file.task_name}"
+          OneOff::Task.create_or_find_by!(version: file.version)
+        end
+      end
+
+      def db_versions
+        @db_versions ||= OneOff::Task.pluck(:version).map(&:to_i)
+      end
+
+      def pending_files
+        OneOff::File.all.index_by(&:version).except(*db_versions).values
+      end
+
+      def matching(pattern)
+        OneOff::File.all.select { |f| f.filename.match? pattern }
+      end
+    end
+  end
+end

data/lib/one_off/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OneOff
+  VERSION = '1.0.0'
+end

data/lib/one_off.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'one_off/engine'
+require 'one_off/file'
+
+module OneOff
+  # Your code goes here...
+end

data/lib/tasks/one_off_tasks.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+namespace :one_off do
+  task run: :environment do
+    require 'one_off/migrator'
+    OneOff::Migrator.run
+  end
+
+  task :matching, [:search_string] => [:environment] do |_t, args|
+    require 'one_off/migrator'
+    OneOff::Migrator.run files: OneOff::Migrator.matching(args.search_string)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: one_off
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hamed Asghari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: A Rails plugin that creates a one_off script to be executed when code
+  is deployed to production
+email:
+- hasghari@g2.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/one_off/application_job.rb
+- app/jobs/one_off/executor_job.rb
+- app/models/one_off/application_record.rb
+- app/models/one_off/task.rb
+- db/migrate/20200324033752_create_one_off_tasks.rb
+- lib/generators/one_off/USAGE
+- lib/generators/one_off/one_off_generator.rb
+- lib/one_off.rb
+- lib/one_off/engine.rb
+- lib/one_off/environments.rb
+- lib/one_off/file.rb
+- lib/one_off/migrator.rb
+- lib/one_off/version.rb
+- lib/tasks/one_off_tasks.rake
+homepage: https://github.com/g2crowd/one_off
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Rails plugin with a generator to create one off scripts
+test_files: []