unforgettable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 915899e7da99424e1ae42fc09d73d8472d308a1fa54948f205a9c6c3f98315f1
+  data.tar.gz: ef2d54a8942df49a1c8c222500bbcb3e1d1cebf7206a40c2b8087f87c5ab8fed
+SHA512:
+  metadata.gz: 94e0179768d2136840d7bcbc35cfdd102485b1a8d9aa556fc53bdf153911e9c3b364858062f9b6cbe00a133fe2828d6fe8f1086c180bbca41688e778256f8123
+  data.tar.gz: aae260f917b033721d8d454c68097d9d88adec317818769d429bad9b6c7295e82a46c75de7797a2f84e150addb6fb948f987da181307e1046f00d04812dc050e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in unforgettable.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,155 @@
+PATH
+  remote: .
+  specs:
+    unforgettable (0.0.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3)
+      actionpack (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3)
+      actionpack (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3)
+      activesupport (= 6.1.3)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activestorage (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activesupport (= 6.1.3)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    minitest (5.14.4)
+    nio4r (2.5.5)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3)
+      actioncable (= 6.1.3)
+      actionmailbox (= 6.1.3)
+      actionmailer (= 6.1.3)
+      actionpack (= 6.1.3)
+      actiontext (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activemodel (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    timecop (0.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  rack-test
+  rails
+  rake (~> 13.0)
+  timecop
+  unforgettable!
+
+BUNDLED WITH
+   2.2.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 James Stubblefield
+
+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,74 @@
+# Unforgettable
+
+How many times have you deployed a new release of a rails app and forgot to run a post-release rake task?  Unforgettable tracks which tasks it has run previously, and which tasks still need to be invoked. Never forget to run post-release deploy rake tasks again!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unforgettable'
+```
+
+And then execute:
+
+    bundle install
+
+Run the generator to create a migration for the table that will be used to track the tasks that Unforgettable invokes.
+
+    rails g unforgettable:install
+    rails db:migrate
+## Usage
+
+Generate new release tasks by running:
+
+    rails g unforgettable:task
+
+This will create a new *.rake file in the folder `lib/tasks/unforgettable`.  You can then insert whatever code you need to run during your next Unforgettable release.
+
+You can trigger all previously uninvoked Unforgettable release tasks by running
+
+    $ rails unforgettable:release
+
+### Integration with Capistrano
+
+You can integrate Unforgettable with Capistrano deploys by adding the below to your `deploy.rb` file.
+
+```ruby
+namespace :deploy do
+  desc 'Invoke any new Unforgettable release tasks'
+  task :release do
+    on roles(:app) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, 'unforgettable:release'
+        end
+      end
+    end
+  end
+end
+
+after 'deploy:published',  'deploy:release'
+```
+
+### Rerunning Completed Tasks
+
+Unforgettable records all tasks that have been run as a row on the `unforgettable_releases` table.
+
+    irb(main):002:0> Unforgettable::Release.all
+    => #<ActiveRecord::Relation [#<Unforgettable::Release id: 1, version: "release_20210303203356", created_at: "2021-03-04 02:37:49", updated_at: "2021-03-04 02:37:49">]>
+
+You can delete a previous record to force Unforgettable to run the task again.
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [Bitbucket](https://bitbucket.org/eightbitdevelopers/unforgettable).
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "unforgettable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/unforgettable/install_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Unforgettable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Generate a migration for unforgettable_releases"
+      source_root File.join(File.dirname(__FILE__), "templates")
+
+      def generate_migration
+        migration_template "migration_template.rb", "db/migrate/create_unforgettable_releases.rb", migration_version: migration_version
+      end
+
+      private
+
+      def migration_version
+        if defined?(Rails::VERSION) && Rails::VERSION::MAJOR >= 5
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+    end
+  end
+end

data/lib/generators/unforgettable/task_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module Unforgettable
+  module Generators
+    class TaskGenerator < Rails::Generators::Base
+
+      desc "Create an unforgettable release rake task"
+      source_root File.join(File.dirname(__FILE__), "templates")
+
+      def create_rakefile
+        template('task_template.rake', "lib/tasks/unforgettable/release_#{release_id}.rake")
+      end
+
+      private
+
+      def release_id
+        @release_id ||= Time.now.strftime('%Y%m%d%H%M%S')
+      end
+
+      def task_name
+        ":release_#{release_id}".to_sym
+      end
+    end
+  end
+end

data/lib/generators/unforgettable/templates/migration_template.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateUnforgettableReleases < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :unforgettable_releases do |t|
+      t.string :version, null: false
+      t.timestamps
+    end
+    add_index :unforgettable_releases, :version, unique: true
+  end
+end

data/lib/generators/unforgettable/templates/task_template.rake

@@ -0,0 +1,10 @@
+namespace :unforgettable do
+  desc "Unforgettable release task <%= release_id %>"
+  task <%= task_name %> => :environment do
+    # Add any code that needs to be run by unforgettable
+    #   `User.admin.update_all(state: 'active')`
+    #
+    # You can call other rake tasks to be run
+    #   `Rake::Task['my_rake_namespace:my_rake_task'].invoke`
+  end
+end

data/lib/unforgettable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails'
+require "active_record"
+
+require_relative "unforgettable/version"
+
+require 'unforgettable/engine' if defined?(Rails)
+require 'unforgettable/railtie' if defined?(Rails::Railtie)
+require 'unforgettable/models/release'
+require 'unforgettable/tasks/release'
+
+module Unforgettable
+  class Error < StandardError; end
+end

data/lib/unforgettable/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Unforgettable
+  class Engine < ::Rails::Engine
+    paths["app/models"] << "lib/unforgettable/models/release"
+  end
+end

data/lib/unforgettable/models/release.rb

@@ -0,0 +1,5 @@
+module Unforgettable
+  class Release < ActiveRecord::Base
+    self.table_name = 'unforgettable_releases'
+  end
+end

data/lib/unforgettable/railtie.rb

@@ -0,0 +1,10 @@
+module Unforgettable
+  class Railtie < Rails::Railtie
+    railtie_name :unforgettable
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/unforgettable/tasks/release.rb

@@ -0,0 +1,43 @@
+module Unforgettable
+  module Tasks
+    class Release
+      class << self
+        def call
+          new_tasks.each { |task| run!(task) }
+        end
+
+        private
+
+        def new_tasks
+          previous_tasks = Unforgettable::Release.pluck(:version)
+          all_tasks.reject { |task| previous_tasks.include?(task) }
+        end
+
+        def all_tasks
+          filenames = Dir.entries(unforgettable_folder).reject {|f| File.directory?(f) || f[0].include?('.')}
+          filenames.map { |filename| filename.split('.')[0] }
+        end
+
+        def unforgettable_folder
+          File.join(Rails.root, 'lib', 'tasks', 'unforgettable')
+        end
+
+        def run!(task_name)
+          print_border
+          puts "Running #{task_name}"
+          Rake::Task["unforgettable:#{task_name}"].invoke
+          create_record(task_name)
+          print_border
+        end
+
+        def print_border
+          puts "*" * 80
+        end
+
+        def create_record(task_name)
+          Unforgettable::Release.create(version: task_name)
+        end
+      end
+    end
+  end
+end

data/lib/unforgettable/tasks/unforgetable/release.rake

@@ -0,0 +1,6 @@
+namespace :unforgettable do
+  desc "Unforgettable primary release task"
+  task :release => :environment do
+    Unforgettable::Tasks::Release.call
+  end
+end

data/lib/unforgettable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Unforgettable
+  VERSION = "0.1.0"
+end

data/unforgettable.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/unforgettable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "unforgettable"
+  spec.version       = Unforgettable::VERSION
+  spec.authors       = ["James Stubblefield"]
+
+  spec.summary       = "Unforgettable tracks which tasks it has run previously, and which tasks still need to be invoked."
+  spec.description   = "Unforgettable tracks which tasks it has run previously, and which tasks still need to be invoked."
+  spec.homepage      = "https://bitbucket.org/eightbitdevelopers/unforgettable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://bitbucket.org/eightbitdevelopers/unforgettable"
+  spec.metadata["changelog_uri"] = "https://bitbucket.org/eightbitdevelopers/unforgettable/src/master/CHANGELOG.md"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "timecop"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: unforgettable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Stubblefield
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rails
+  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: pry
+  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: timecop
+  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'
+description: Unforgettable tracks which tasks it has run previously, and which tasks
+  still need to be invoked.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/unforgettable/install_generator.rb
+- lib/generators/unforgettable/task_generator.rb
+- lib/generators/unforgettable/templates/migration_template.rb
+- lib/generators/unforgettable/templates/task_template.rake
+- lib/unforgettable.rb
+- lib/unforgettable/engine.rb
+- lib/unforgettable/models/release.rb
+- lib/unforgettable/railtie.rb
+- lib/unforgettable/tasks/release.rb
+- lib/unforgettable/tasks/unforgetable/release.rake
+- lib/unforgettable/version.rb
+- unforgettable.gemspec
+homepage: https://bitbucket.org/eightbitdevelopers/unforgettable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://bitbucket.org/eightbitdevelopers/unforgettable
+  source_code_uri: https://bitbucket.org/eightbitdevelopers/unforgettable
+  changelog_uri: https://bitbucket.org/eightbitdevelopers/unforgettable/src/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.7
+signing_key:
+specification_version: 4
+summary: Unforgettable tracks which tasks it has run previously, and which tasks still
+  need to be invoked.
+test_files: []