post_pusher 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab7826c0117965f5dcc7227dee0cb9ce28c658d3
-  data.tar.gz: c8c732f07cfd4f4a780a4bc235ae669e647b0aac
+SHA256:
+  metadata.gz: c8c075270ea055b6c37e28f6bd4e5f4d04c2ea444d7e5fd778e7e383872a7af8
+  data.tar.gz: 17a834e02031b085ca403a82d9d1ae5266633460d450de239f64c09ae0dcdac0
 SHA512:
-  metadata.gz: 16040dcfbb6e034126c2829ebe694bef31ad5ba511400508892beeb05babc0d96416fb2b049ddda37c84a6e6e975c5d32ea64024caa110123bf87df5a975248e
-  data.tar.gz: 7b224d13fb05419433da875a532b9881220549dd0939330c56d8c5851f68be2238796bb30b79487e090d4f574343f35cd66aeac322c68931c33084734856e703
+  metadata.gz: 2dcfca7ce58d41fbc3275ad2363b0ca5fbd7228bf5625daa0b6aac51d49a8950a59a90e2404a7617ff731bdd2e4970b8f7bda3b96f47771df2b255107f871559
+  data.tar.gz: df616fa091701d274f76022233d35d0ba2aeaa8c025bdfd9671ee9763e5603e71564f2a316d1dc75d4f76277e922de95aa6141cb3899c7b9d357b1f1d325207b

data/README.md

@@ -19,7 +19,7 @@ $ bundle
 Or install it yourself with:
 
 ```
-gem install post_pusher
+$ gem install post_pusher
 ```
 
 
@@ -28,20 +28,24 @@ gem install post_pusher
 No way buddy; getting your post push task ready for a release using PostPusher is super easy.
 
 Steps:
--rails g post_push_task task_name
--add your code into the new task
--commit
+
+- `rails g post_push_task task_name`
+- add your code into the new task
+- commit
 
 Running the tasks:
--bin/post_push work
 
-## How do I add this to my rails app?
+- `bin/post_push work`
+
+## How do I add this to my Rails app?
 
--Add PostPusher to your gemfile
--bundle
--Run migrations (creates records table)
--bundle binstub post_pusher (this enables you to be able to run bin/post_push by putting the post_push file in your bin directory)
--Commit your changes
+- Add PostPusher to your gemfile
+- `bundle`
+- `rails g post_pusher:install` (generate migration to create post_push_statuses table)
+- Run migrations (creates records table)
+- `bundle binstub post_pusher` (this enables you to be able to run `bin/post_push` by putting the post_push file in your bin directory)
+- `bundle binstubs bundler --force` (this replaces `bin/bundle` so `bin/post_push` commands work properly)
+- Commit your changes
 
 ## Running Tests
 

data/lib/generators/post_push_task/post_push_task_generator.rb

@@ -4,7 +4,7 @@ class PostPushTaskGenerator < Rails::Generators::Base
   desc "Create a post push task"
   argument :task_name, type: :string
   def create_post_push_task
-    template "post_push_task.rake.erb", "lib/tasks/post_push/#{timestamp}_#{task_name}.rake"
+    template "post_push_task.rake.erb", "lib/tasks/post_push/#{timestamp}_#{task_name.underscore}.rake"
   end
 
   private

data/lib/generators/post_push_task/templates/post_push_task.rake.erb

@@ -5,7 +5,7 @@ full_name = "post_push:#{timestamp}:#{task_name}"
 # When writing your task, be sure to:
 #  * Print out useful information at startup and on completion
 #  * Use a progress bar if the task will take a while
-#  * Check Rails.env.development? or stage? and skip lengthy operations
+#  * Skip lengthy tasks unless we're in prod or the task is run with FORCE
 
 namespace :post_push do
   namespace "<%=timestamp%>" do
@@ -15,6 +15,13 @@ namespace :post_push do
       puts "---------------------------------------------------------"
       puts "Starting <%=full_name%> at #{DateTime.now}"
 
+      # If your task takes more than a minute or two to run, consider
+      # uncommenting this section so dev and stage environments can skip it
+      # unless Rails.env.production? || ENV['FORCE']
+        # puts "Skipping <%=task_name%> in #{Rails.env}; to run this specify FORCE=1"
+        # next
+      # end
+
       total_records = YourModel.count
       next if total_records.zero?
       progress_bar = ProgressBar.new(total_records)

data/lib/generators/post_pusher/install/install_generator.rb

@@ -0,0 +1,27 @@
+module PostPusher
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the post_pusher migrations"
+
+      def self.next_migration_number(path)
+        Time.now.utc.to_s(:number)
+      end
+
+      def copy_migrations
+        copy_migration "create_post_push_status"
+      end
+
+      protected
+
+      def copy_migration(filename)
+        if self.class.migration_exists?("db/migrate", "#{filename}")
+          say_status("skipped", "Migration #{filename}.rb already exists")
+        else
+          migration_template "#{filename}.rb", "db/migrate/#{filename}.rb"
+        end
+      end
+    end
+  end
+end

data/lib/post_push_cli.rb

@@ -2,6 +2,10 @@ require "thor"
 require_relative "../lib/post_pusher/rake_task_runner"
 
 class PostPushCli < Thor
+  def self.exit_on_failure?
+    true
+  end
+
   desc "work", "Run remaining post push tasks"
   def work
     load_rails_env!
@@ -28,6 +32,7 @@ class PostPushCli < Thor
 
     success_message "#{succeeded.size} tasks succeeded"
     error_message "Errors occured in #{failed.size} tasks:\n#{failed.join("\n")}" if failed.any?
+    raise "Some tasks failed" if failed.any?
   end
 
   desc "status", "List post push tasks and their status"

data/lib/post_pusher.rb

@@ -1,16 +1 @@
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# STEP 1
-# Load all dependent gems.
-
-# require 'a_dependent_gem'
-# require 'another_dependent_gem'
-# require 'a_dependent_local_gem'
-# ...
-
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# STEP 2
-# Load this gem's code.
 require "rails"
-require "rails/engine"
-
-require "post_pusher/engine"

data/lib/post_pusher/rake_task_runner.rb

@@ -34,7 +34,7 @@ class RakeTaskRunner
 
   def log_file_path
     logs = File.join(Rails.root, "log", "post_push")
-    Dir.mkdir(logs) unless Dir.exist?(logs)
+    FileUtils.mkdir_p(logs) unless Dir.exist?(logs)
     File.join(logs, "#{log_file_name}.log")
   end
 

data/lib/post_pusher/version.rb

@@ -1,4 +1,4 @@
 module PostPusher
-  VERSION = "1.0.0".freeze
+  VERSION = "1.2.1".freeze
 end
 

data/test/dummy/config/application.rb

@@ -3,7 +3,6 @@ require File.expand_path("../boot", __FILE__)
 require "rails/all"
 
 Bundler.require(*Rails.groups)
-require "post_pusher"
 
 module Dummy
   class Application < Rails::Application

data/test/dummy/db/migrate/20160620190743_create_post_push_status.rb

@@ -0,0 +1,7 @@
+class CreatePostPushStatus < (Rails::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[4.2] : ActiveRecord::Migration)
+  def change
+    create_table :post_push_statuses do |t|
+      t.string :task_name, null: false, index: true
+    end
+  end
+end

data/test/generators/post_pusher/install/install_generator_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'fileutils'
+require 'rails/generators'
+require 'generators/post_pusher/install/install_generator'
+
+class PostPusher::Generators::InstallGeneratorTest < ::Rails::Generators::TestCase
+  TEMP_DIR = File.expand_path("../../../../tmp", __dir__)
+  tests PostPusher::Generators::InstallGenerator
+  destination TEMP_DIR
+
+  setup :prepare_destination
+
+  it 'creates the migration file' do
+    run_generator
+    assert_migration "db/migrate/create_post_push_status.rb"
+  end
+
+  it 'skips the migration file if it already exists' do
+    run_generator
+    run_generator
+
+    files = Dir.entries("#{TEMP_DIR}/db/migrate").reject { |f| f == '.' || f == '..' }
+
+    assert_equal 1, files.length
+    assert_migration "db/migrate/create_post_push_status.rb"
+  end
+end

data/test/post_push_exe_test.rb

@@ -13,16 +13,16 @@ class PostPushExeTest < ActiveSupport::TestCase
   end
 
   describe "#work" do
-    setup { subject.work }
-
     # TODO: re-enable this.  Solano isn't finding all the tasks (I think),
     # so this one isn't available.  Make it work in a debug console with
     # bin/solano_run_gem_tests.  --sagotsky
     # it "should mark finished tasks so they dont rerun" do
+    #   subject.work
     #   completed_tasks.must_include 'post_push:3:runnable_task'
     # end
 
     it "should not mark failed tasks as finished" do
+      subject.work rescue nil
       completed_tasks.wont_include "post_push:1:broken_task"
     end
   end

data/test/test_helper.rb

@@ -2,7 +2,9 @@ $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
 require "active_support"
 require File.expand_path("dummy/config/environment.rb", __dir__)
+
 ActiveSupport::TestCase.test_order = :random # if we don't set this, active_support gives a warning
+
 require "minitest/autorun"
 require 'minitest/reporters'
 require "post_pusher"
@@ -27,5 +29,8 @@ class ActiveSupport::TestCase
   extend MiniTest::Spec::DSL
 end
 
-ActiveRecord::Migrator.migrate File.expand_path("dummy/db/migrate", __dir__)
-ActiveRecord::Migrator.migrate File.expand_path("../db/migrate", __dir__)
+if defined?(ActiveRecord::MigrationContext)
+  ActiveRecord::MigrationContext.new(File.expand_path("dummy/db/migrate", __dir__)).up
+else
+  ActiveRecord::Migrator.migrate File.expand_path("dummy/db/migrate", __dir__)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: post_pusher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - PatientsLikeMe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,44 +28,44 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.11.0
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.11
 - !ruby/object:Gem::Dependency
   name: minitest-spec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
 description: A tool to run a set of tasks after deploys
 email:
 - engineers@patientslikeme.com
@@ -104,15 +132,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- db/migrate/20160620190743_create_post_push_status.rb
 - exe/post_push
 - lib/generators/post_push_invoke/post_push_invoke_generator.rb
 - lib/generators/post_push_invoke/templates/post_push_invoke.rake.erb
 - lib/generators/post_push_task/post_push_task_generator.rb
 - lib/generators/post_push_task/templates/post_push_task.rake.erb
+- lib/generators/post_pusher/install/install_generator.rb
+- lib/generators/post_pusher/install/templates/create_post_push_status.rb
 - lib/post_push_cli.rb
 - lib/post_pusher.rb
-- lib/post_pusher/engine.rb
 - lib/post_pusher/rake_task_runner.rb
 - lib/post_pusher/version.rb
 - test/dummy/README.rdoc
@@ -147,12 +175,14 @@ files:
 - test/dummy/config/secrets.yml
 - test/dummy/db/migrate/20150618161222_create_user.rb
 - test/dummy/db/migrate/20151229195418_create_soft_deletables.rb
+- test/dummy/db/migrate/20160620190743_create_post_push_status.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/tasks/dummy_tasks.rake
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
+- test/generators/post_pusher/install/install_generator_test.rb
 - test/post_push_exe_test.rb
 - test/rake_task_runner_test.rb
 - test/test_helper.rb
@@ -175,50 +205,51 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.2.0
 signing_key: 
 specification_version: 4
 summary: A tool to run a set of tasks after deploys
 test_files:
-- test/rake_task_runner_test.rb
-- test/test_helper.rb
-- test/dummy/README.rdoc
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/lib/tasks/dummy_tasks.rake
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20151229195418_create_soft_deletables.rb
-- test/dummy/db/migrate/20150618161222_create_user.rb
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/helpers/application_helper.rb
 - test/dummy/bin/rake
 - test/dummy/bin/setup
-- test/dummy/bin/rails
 - test/dummy/bin/bundle
-- test/dummy/config/environment.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/bin/rails
+- test/dummy/config/secrets.yml
+- test/dummy/config/routes.rb
 - test/dummy/config/locales/en.yml
-- test/dummy/config/application.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/test.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/application.rb
 - test/dummy/config/database.yml
 - test/dummy/config/boot.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config/routes.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config.ru
 - test/dummy/Rakefile
-- test/dummy/public/404.html
-- test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/404.html
+- test/dummy/lib/tasks/dummy_tasks.rake
+- test/dummy/db/schema.rb
+- test/dummy/db/migrate/20151229195418_create_soft_deletables.rb
+- test/dummy/db/migrate/20160620190743_create_post_push_status.rb
+- test/dummy/db/migrate/20150618161222_create_user.rb
+- test/dummy/README.rdoc
+- test/test_helper.rb
 - test/post_push_exe_test.rb
+- test/generators/post_pusher/install/install_generator_test.rb
+- test/rake_task_runner_test.rb

data/lib/post_pusher/engine.rb

@@ -1,13 +0,0 @@
-module PostPusher
-  class Engine < ::Rails::Engine
-    engine_name "post_pusher"
-
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match root.to_s
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
-        end
-      end
-    end
-  end
-end