post_pusher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab7826c0117965f5dcc7227dee0cb9ce28c658d3
+  data.tar.gz: c8c732f07cfd4f4a780a4bc235ae669e647b0aac
+SHA512:
+  metadata.gz: 16040dcfbb6e034126c2829ebe694bef31ad5ba511400508892beeb05babc0d96416fb2b049ddda37c84a6e6e975c5d32ea64024caa110123bf87df5a975248e
+  data.tar.gz: 7b224d13fb05419433da875a532b9881220549dd0939330c56d8c5851f68be2238796bb30b79487e090d4f574343f35cd66aeac322c68931c33084734856e703

data/README.md

@@ -0,0 +1,60 @@
+## What Is PostPusher?
+
+A sweet gem that makes post pushing way easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'post_pusher'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself with:
+
+```
+gem install post_pusher
+```
+
+
+## Im a dev, how can I use PostPusher? Is it hard?
+
+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
+
+Running the tasks:
+-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
+
+## Running Tests
+
+1. Change to the gem's directory
+2. Run `bundle`
+3. Run `rake`
+
+## Release Process
+
+Once pull request is merged to master, on latest master:
+
+1. Update CHANGELOG.md. Version: [ major (breaking change: non-backwards
+   compatible release) | minor (new features) | patch (bugfixes) ]
+2. Update version in lib/post\_pusher/version.rb
+3. Release by running `bundle exec rake release`
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+import "#{Rails.root}/lib/tasks/dummy_tasks.rake" if Rails.env.test?
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/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/exe/post_push

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/post_pusher"
+require_relative "../lib/post_push_cli"
+
+PostPushCli.start ARGV

data/lib/generators/post_push_invoke/post_push_invoke_generator.rb

@@ -0,0 +1,35 @@
+class PostPushInvokeGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "Create a post push task that invokes another rake task"
+  argument :rake_task_name, type: :string
+  def create_post_push_invoke
+    check_task!
+    template "post_push_invoke.rake.erb", "lib/tasks/post_push/#{timestamp}_#{task_name}.rake"
+  end
+
+  private
+
+  def check_task!
+    Dir[File.join("lib/tasks/**/*.rake")].each do |f|
+      begin
+        load f
+      rescue LoadError, StandardError
+        nil
+      end
+    end
+
+    return if rake_task_name.start_with?("db:seed") # TODO: figure out where this is defined and load it
+    Rake::Task[rake_task_name] # raises an error if it's not present
+  end
+
+  def timestamp
+    # print out the dates/timestamps we see in migrations
+    # year month day hour minute second
+    DateTime.now.strftime("%Y%m%d%H%M%S")
+  end
+
+  def task_name
+    rake_task_name.tr ":", "_"
+  end
+end

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

@@ -0,0 +1,8 @@
+namespace :post_push do
+  namespace "<%= timestamp %>" do
+    desc 'Runs <%= task_name %>'
+    task '<%= task_name %>' => :environment do
+      Rake::Task['<%= rake_task_name %>'].invoke
+    end
+  end
+end

data/lib/generators/post_push_task/post_push_task_generator.rb

@@ -0,0 +1,17 @@
+class PostPushTaskGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  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"
+  end
+
+  private
+
+  def timestamp
+    # print out the dates/timestamps we see in migrations
+    # year month day hour minute second
+    DateTime.now.strftime("%Y%m%d%H%M%S")
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'progress_bar'
+<%
+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
+
+namespace :post_push do
+  namespace "<%=timestamp%>" do
+    desc 'Describe the task here'
+    task '<%=task_name%>' => :environment do
+
+      puts "---------------------------------------------------------"
+      puts "Starting <%=full_name%> at #{DateTime.now}"
+
+      total_records = YourModel.count
+      next if total_records.zero?
+      progress_bar = ProgressBar.new(total_records)
+
+      YourModel.find_each do |model|
+        # YOUR CODE HERE
+
+        progress_bar.increment!
+      end
+
+      puts "Updated #{total_records} records."
+      puts "Completed <%=full_name%> at #{DateTime.now}"
+    end
+  end
+end

data/lib/post_push_cli.rb

@@ -0,0 +1,98 @@
+require "thor"
+require_relative "../lib/post_pusher/rake_task_runner"
+
+class PostPushCli < Thor
+  desc "work", "Run remaining post push tasks"
+  def work
+    load_rails_env!
+    succeeded = []
+    failed = []
+
+    runnable_tasks.each do |task|
+      puts "Running task #{task}..."
+      puts
+      job = RakeTaskRunner.exec(task)
+
+      if job.status
+        task_complete!(task)
+        succeeded << task
+        success_message "Successfully ran #{task}"
+      else
+        error_message "Error in: #{task}"
+        failed << task
+      end
+
+      puts "-" * 56
+      puts
+    end
+
+    success_message "#{succeeded.size} tasks succeeded"
+    error_message "Errors occured in #{failed.size} tasks:\n#{failed.join("\n")}" if failed.any?
+  end
+
+  desc "status", "List post push tasks and their status"
+  option :new, default: false, desc: "Only show unrun tasks", type: :boolean
+  option :done, default: false, desc: "Only show finished tasks", type: :boolean
+  def status
+    load_rails_env!
+
+    unless options[:new]
+      puts "Finished tasks:"
+      puts completed_tasks.join "\n"
+    end
+
+    puts unless options[:new] || options[:done]
+
+    unless options[:done]
+      puts "Pending tasks:"
+      puts runnable_tasks.join "\n"
+    end
+
+    puts
+  end
+
+  private
+
+  def runnable_tasks
+    post_push_tasks - completed_tasks
+  end
+
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  def completed_tasks
+    connection.select_values("SELECT task_name from post_push_statuses")
+  end
+
+  def task_complete!(task_name)
+    connection.execute("INSERT INTO post_push_statuses (task_name) VALUES ('#{task_name}')")
+  end
+
+  def post_push_tasks
+    rake_task_names.grep(/^post_push:/).sort
+  end
+
+  def rake_task_names
+    rake_tasks.map(&:name)
+  end
+
+  def rake_tasks
+    @rake_tasks ||= begin
+      Rails.application.load_tasks
+      Rake.application.tasks
+    end
+  end
+
+  def load_rails_env!
+    require(File.expand_path("config/environment", Dir.getwd)) unless Rails.application
+  end
+
+  def success_message(msg)
+    puts "\e[32m#{msg}\e[0m" # green
+  end
+
+  def error_message(msg)
+    puts "\e[31m#{msg}\e[0m" # red
+  end
+end

data/lib/post_pusher.rb

@@ -0,0 +1,16 @@
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# 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/engine.rb

@@ -0,0 +1,13 @@
+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

data/lib/post_pusher/rake_task_runner.rb

@@ -0,0 +1,44 @@
+require "pty"
+
+class RakeTaskRunner
+  BUFSIZE = 160
+
+  def self.exec(task)
+    RakeTaskRunner.new(task).tap(&:work)
+  end
+
+  attr_reader :task_name, :status
+
+  def initialize(task_name)
+    @task_name = task_name
+  end
+
+  def work
+    @status = system(logging_rake_command)
+  end
+
+  private
+
+  def rake_command
+    "bundle exec rake #{task_name} RAILS_ENV=#{Rails.env}"
+  end
+
+  def logging_rake_command
+    # PIPESTATUS is a bash and zsh construct. It stashes the exit statuses
+    # of commands in a long pipe line like this one. $PIPESTATUS[0] is the
+    # first exit status. $PIPESTATUS[1] would give us the exit status from
+    # tee. So we're running rake, piping it into tee, and then making sure
+    # to exit with the exit status we care about.
+    "#{rake_command} 2>&1 | tee #{log_file_path} ; (exit ${PIPESTATUS[0]})"
+  end
+
+  def log_file_path
+    logs = File.join(Rails.root, "log", "post_push")
+    Dir.mkdir(logs) unless Dir.exist?(logs)
+    File.join(logs, "#{log_file_name}.log")
+  end
+
+  def log_file_name
+    task_name.split(":").drop(1).join("_")
+  end
+end

data/lib/post_pusher/version.rb

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path("../config/application", __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */