citizen-scripts 1.1.0

data/lib/citizen_code_scripts/begin.rb

@@ -0,0 +1,195 @@
+require 'json'
+require 'tempfile'
+
+module CitizenCodeScripts
+  class Pivotal
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def request(url, method: "GET", body: nil)
+      cmd = %Q{curl --silent -X #{method} -H "X-TrackerToken: #{token}"}
+      cmd += %Q{ -H "Content-Type: application/json"}
+
+      if body
+        cmd += %Q{ -d '#{body}'}
+      end
+
+      cmd += %Q{ "#{url}"}
+
+      result = `#{cmd}`
+
+      JSON.parse(result.strip)
+    end
+  end
+
+  class Begin < Base
+    def self.description
+      "Starts your Pivotal Tracker story and opens a new PR on Github"
+    end
+
+    def self.help
+      <<-EOF
+citizen begin #{colorize(:light_blue, "[story id] [branch name]")}
+
+Example: $ #{colorize(:light_blue, 'citizen begin "#133717234"')}
+
+This command will start your Pivotal Tracker story for you, open a pull
+request on Github, and copy over the Pivotal Tracker story description to
+the Github pull request description. As well, any tasks in your
+Pivotal Tracker story will automatically become [x] checkbox tasks on the
+Github PR.
+
+* All branch names will be auto-converted to
+  kebab-case, lowercase
+
+* Passing story id/branch name as arguments are optional - if
+  they are missing, you'll be prompted
+EOF
+    end
+
+    def run
+      story_id, branch_name = argv
+
+      if !command?("hub")
+        abort <<-EOF
+You need to install `hub` before you can use this program.
+
+brew install hub
+EOF
+      end
+
+      pivotal = Pivotal.new(git_config("user.pivotalApiToken"))
+      config_abort_if_blank!("user.pivotalApiToken", pivotal.token)
+
+      project_id = git_config("user.pivotalProjectId")
+      config_abort_if_blank!("user.pivotalProjectId", project_id)
+
+      story_id ||= prompt("Please paste the Pivotal story ID here")
+      story_id = story_id.gsub(/[^\d]/, '')
+
+      story_url = "https://www.pivotaltracker.com/services/v5"\
+        "/projects/#{project_id}/stories/#{story_id}"
+
+      story = pivotal.request(story_url)
+
+      default_branch_name = normalized_branch_name(story['name'])
+
+      branch_name ||= prompt("Please enter a branch name (#{default_branch_name})")
+
+      if branch_name.strip == ""
+        branch_name = default_branch_name
+      else
+        branch_name = normalized_branch_name(branch_name)
+      end
+
+      # Start the story
+      pivotal.request(story_url, method: "PUT", body: '{ "current_state":"started" }')
+
+      silent "git checkout master",
+        "git fetch origin",
+        "git reset --hard origin/master"
+
+      puts "==> Checking out #{branch_name}"
+
+      silent "git checkout -b #{branch_name}",
+        'git commit --allow-empty -m "Initial commit for story #' + story_id + '"',
+        "git push origin #{branch_name}",
+        "git branch --set-upstream #{branch_name} origin/#{branch_name}"
+
+      tasks = pivotal.request(
+      "https://www.pivotaltracker.com/services/v5"\
+        "/projects/#{project_id}/stories/#{story_id}/tasks"
+      )
+
+      story_description = story['description']
+
+      if story_description.nil?
+        story_description = "_No story description given in Pivotal_"
+      end
+
+      description = <<-EOF
+#{story['name']}
+
+#{story['url']}
+
+# Description
+
+#{story_description}
+EOF
+
+      description.strip!
+
+      unless tasks.empty?
+        description += "\n\n## TODO\n\n"
+
+        tasks.each do |task|
+          description += "- [ ] #{task['description']}\n"
+        end
+
+        description.strip!
+      end
+
+      puts "==> Opening pull request on GitHub"
+
+      tempfile = Tempfile.new('begin_pull_request')
+
+      begin
+        tempfile.write(description)
+        tempfile.close
+
+        labels = ['WIP', story['story_type']].join(',')
+
+        url = `hub pull-request -F #{tempfile.path} -l "#{labels}" -a "" -o`
+
+        # Copy it to your clipboard
+        system("echo #{url} | pbcopy")
+        puts url
+      ensure
+        tempfile.unlink
+      end
+    end
+
+    private
+
+    def silent(*cmds)
+      cmds.each { |cmd| system("#{cmd} >/dev/null 2>&1") }
+    end
+
+    def command?(name)
+      `which #{name}`
+      $?.success?
+    end
+
+    def git_config(key)
+      `git config --local --get #{key}`.strip
+    end
+
+    def config_abort_if_blank!(key, value)
+      if value.strip == ""
+        abort <<-EOF
+You need to set the #{key} value in your git config!
+
+git config --local --add #{key} [value]
+EOF
+      end
+    end
+
+    def prompt(msg)
+      print "#{msg} > "
+      value = STDIN.gets.strip
+      puts
+      value
+    end
+
+    def normalized_branch_name(branch_name)
+      branch_name
+        .gsub(/[^\w\s-]/, '')
+        .gsub(/\s+/, '-')
+        .downcase
+        .gsub(/-*$/, '') # trailing dashes
+    end
+  end
+end

data/lib/citizen_code_scripts/colorize.rb

@@ -0,0 +1,39 @@
+module CitizenCodeScripts::Colorize
+  extend self
+
+  def self.included(base)
+    colorize = self
+
+    base.class_eval do
+      extend colorize
+    end
+  end
+
+  COLOR_CODES = {
+    black: 30,
+    blue: 34,
+    brown: 33,
+    cyan: 36,
+    dark_gray: 90,
+    green: 32,
+    light_blue: 94,
+    light_cyan: 96,
+    light_gray: 37,
+    light_green: 92,
+    light_purple: 95,
+    light_red: 91,
+    light_yellow: 93,
+    purple: 35,
+    red: 31,
+    white: 97,
+    yellow: 33,
+
+    command: 96,
+    error: 91,
+    info: 93,
+  }
+
+  def colorize(color, string)
+    "\e[#{COLOR_CODES[color]}m#{string}\e[0m"
+  end
+end

data/lib/citizen_code_scripts/doctor.rb

@@ -0,0 +1,179 @@
+class CitizenCodeScripts::Doctor < CitizenCodeScripts::Base
+  class Check
+    include CitizenCodeScripts::Colorize
+
+    attr_reader :name, :command, :remedy, :problems
+
+    def initialize(name:, command:, remedy:)
+      @name = name
+      @command = command
+      @remedy = remedy
+      @problems = []
+    end
+
+    def run!
+      print "Checking: #{name}... "
+
+      success = if command.respond_to?(:call)
+        command.call
+      else
+        system "#{command} > /dev/null 2>&1"
+      end
+
+      if success
+        puts 'OK'
+      else
+        print colorize(:error, 'F')
+        fix = remedy.respond_to?(:join) ? remedy.join(" ") : remedy
+        puts "\n  To fix: #{fix}\n\n"
+
+        problems << name
+      end
+    end
+  end
+
+  def self.description
+    "Checks the health of your development environment"
+  end
+
+  def initialize(*args)
+    super
+    @checks = []
+  end
+
+  def run
+    case argv.first
+    when "list"
+      list_default_checks
+    else
+      run_doctor
+    end
+  end
+
+  def self.help
+    "doctor - helps you diagnose any setup issues with this application\n"
+  end
+
+  def self.help_subcommands
+    {
+      "citizen doctor" => "runs health checks and gives a report",
+      "citizen doctor list" => "prints a list of default checks you can use when overriding doctor checks in your app"
+    }
+  end
+
+  def run_doctor
+    run_checks
+    report
+  end
+
+  def list_default_checks
+    puts "These default checks are available for use in your overrides:"
+    puts
+
+    default_checks.each do |name|
+      puts "  - #{colorize(:light_blue, name)}"
+    end
+
+    puts
+  end
+
+  def check(**options)
+    check = Check.new(options)
+    @checks << check
+
+    check.run!
+  end
+
+  private
+
+  def run_checks
+    run_default_checks
+  end
+
+  def run_default_checks
+    default_checks.each do |check|
+      send(check)
+    end
+  end
+
+  def default_checks
+    %i[
+      check_postgres_launchctl
+      check_postgres_running
+      check_postgres_role
+      check_db_migrated
+      check_direnv_installed
+      check_phantomjs_installed
+      check_gemfile_dependencies
+      check_envrc_file_exists
+    ]
+  end
+
+  def check_postgres_launchctl
+    check \
+      name: "postgres launchctl script is linked",
+      command: "ls -1 ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist",
+      remedy: command("ln -sfv /usr/local/opt/postgresql/*.plist ~/Library/LaunchAgents")
+  end
+
+  def check_postgres_running
+    check \
+      name: "postgres is running",
+      command: "psql -l",
+      remedy: command("launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist")
+  end
+
+  def check_postgres_role
+    check \
+      name: "postgres role exists",
+      command: "psql -U postgres -l",
+      remedy: command("createuser --superuser postgres")
+  end
+
+  def check_gemfile_dependencies
+    check \
+      name: "Gemfile dependencies are up to date",
+      command: "bundle check",
+      remedy: command("bundle")
+  end
+
+  def check_db_migrated
+    check \
+      name: "DB is migrated",
+      command: "source .envrc && rails runner 'ActiveRecord::Migration.check_pending!'",
+      remedy: command("rake db:migrate")
+  end
+
+  def check_direnv_installed
+    check \
+      name: "direnv installed",
+      command: "which direnv",
+      remedy: command("brew install direnv")
+  end
+
+  def check_phantomjs_installed
+    check \
+      name: "PhantomJS installed",
+      command: "which phantomjs",
+      remedy: command("brew install phantomjs")
+  end
+
+  def check_envrc_file_exists
+    check \
+      name: "envrc",
+      command: "stat .envrc",
+      remedy: "get your .envrc file from 1password"
+  end
+
+  def problems
+    @checks.map(&:problems).flatten
+  end
+
+  def report
+    exit problems.size
+  end
+
+  def command(s)
+    "run #{colorize :command, s}"
+  end
+end

data/lib/citizen_code_scripts/help.rb

@@ -0,0 +1,53 @@
+class CitizenCodeScripts::Help < CitizenCodeScripts::Base
+  def self.help
+    "Inception was a lame movie"
+  end
+
+  def self.help_subcommands
+    {}
+  end
+
+  def self.description
+    "Prints this message out"
+  end
+
+  def run
+    specific_script = argv[0]
+
+    if CitizenCodeScripts::Base.script_names.include?(specific_script)
+      script = CitizenCodeScripts::Base.scripts[specific_script]
+      puts full_help(script)
+    elsif specific_script
+      puts colorize(:red, "\"#{specific_script}\" does not exist, cannot display help")
+    else
+      basic_usage
+    end
+  end
+
+  private
+
+  def full_help(script)
+    (script.help || "") + script.help_subcommands.map do |cmd, description|
+      " - #{colorize(:light_blue, cmd)} - #{description}"
+    end.join("\n")
+  end
+
+  def basic_usage
+    puts "Usage: citizen #{colorize(:light_blue, '[script name]')}"
+    puts
+    puts "Specify a specific script to run, options are: "
+    puts
+
+    names_and_descriptions = CitizenCodeScripts::Base.scripts.map do |name, script|
+      [colorize(:light_green, name), colorize(:light_blue, script.description)]
+    end
+
+    padding = names_and_descriptions.map { |name, _| name.length }.max
+
+    names_and_descriptions.each do |name, description|
+      puts "  %-#{padding}s %s" % [name, description]
+    end
+
+    puts
+  end
+end

data/lib/citizen_code_scripts/heroku_doctor.rb

@@ -0,0 +1,58 @@
+require_relative './doctor'
+
+class HerokuDoctor < CitizenCodeScripts::Doctor
+  def self.description
+    "Checks the health of your Heroku config"
+  end
+
+  def self.help
+    <<~TEXT
+      citizen heroku-doctor #{colorize(:light_blue, "environment")} = #{colorize(:yellow, "staging")}
+    TEXT
+  end
+
+  def run_checks
+    @env = argv[0] || "staging"
+    @heroku_app_name = app_names[@env.to_s]
+
+    puts "Environment: #{@env}"
+    puts "Heroku app:  #{@heroku_app_name}"
+    puts
+
+    # this one should always be first - it will NEVER pass for the citizen-rails project which is OKAY!
+    check(
+      name: "The citizen.yml file has been configured properly",
+      command: "! grep 'citizen-rails-staging' citizen.yml",
+      remedy: "configure your citizen.yml file to have the correct app names set for all your Heroku environments"
+    )
+
+    check(
+      name: "app #{@heroku_app_name} exists",
+      command: "cat .git/config | grep git@heroku.com:#{@heroku_app_name}.git",
+      remedy: [command("heroku apps:create #{@heroku_app_name}"), "and/or", command("git remote add staging git@heroku.com:#{@heroku_app_name}.git")]
+    )
+
+    check_env("DEPLOY_TASKS", "db:migrate")
+    check_env("RAILS_ENV", "production")
+    check_env("DATABASE_URL", "postgres://", "go to https://dashboard.heroku.com/apps/#{@heroku_app_name}/resources and add the Heroku Postgress add-on")
+
+    check_buildpack("https://github.com/heroku/heroku-buildpack-ruby")
+    check_buildpack("https://github.com/gunpowderlabs/buildpack-ruby-rake-deploy-tasks")
+  end
+
+  def check_env(env_var, value, remedy=nil)
+    check(
+      name: env_var,
+      command: "heroku config:get #{env_var} -a #{@heroku_app_name} | grep '#{value}'",
+      remedy: remedy || command("heroku config:set #{env_var}=#{value} -a #{@heroku_app_name}")
+    )
+  end
+
+  def check_buildpack(url)
+    check(
+      name: url.split("/").last,
+      command: "heroku buildpacks -a #{@heroku_app_name} | grep '#{url}'",
+      remedy: command("heroku buildpacks:add #{url} -a #{@heroku_app_name}")
+    )
+  end
+end

data/lib/citizen_code_scripts/kill_db_sessions.rb

@@ -0,0 +1,22 @@
+class CitizenCodeScripts::KillDbSessions < CitizenCodeScripts::Base
+  def self.description
+    "Kills active Postgres sessions"
+  end
+
+  def run
+    print "Loading Rails... "
+    require app_root.join("./config/environment")
+
+    puts "done"
+
+    print "Killing DB sessions... "
+    ActiveRecord::Base.connection.execute(<<-SQL)
+      SELECT pg_terminate_backend(pg_stat_activity.pid)
+      FROM pg_stat_activity
+      WHERE datname = current_database()
+      AND pid <> pg_backend_pid()
+    SQL
+
+    puts "done"
+  end
+end

data/lib/citizen_code_scripts/levenstein.rb

@@ -0,0 +1,40 @@
+class Levenstein
+  def self.edit_distance(s, t)
+    m = s.length
+    n = t.length
+    return m if n == 0
+    return n if m == 0
+    d = Array.new(m+1) { Array.new(n+1) }
+
+    (0..m).each { |i| d[i][0] = i }
+    (0..n).each { |j| d[0][j] = j }
+    (1..n).each do |j|
+      (1..m).each do |i|
+        d[i][j] = if s[i-1] == t[j-1] # adjust index into string
+          d[i-1][j-1] # no operation required
+        else
+          [d[i-1][j]+1, # deletion
+           d[i][j-1]+1, # insertion
+           d[i-1][j-1]+1, # substitution
+          ].min
+        end
+      end
+    end
+    d[m][n]
+  end
+
+  def self.closest_match(needle, haystack)
+    min_distance = haystack.map(&:size).max
+    results = nil
+    haystack.each do |value|
+      distance = edit_distance(needle, value)
+      if distance < min_distance
+        min_distance = distance
+        results = [value]
+      elsif distance == min_distance
+        results << value
+      end
+    end
+    results
+  end
+end

data/lib/citizen_code_scripts/pushit.rb

@@ -0,0 +1,23 @@
+class CitizenCodeScripts::Pushit < CitizenCodeScripts::Base
+  def self.description
+    "Pulls code, runs test, pushes your code"
+  end
+
+  def self.help
+    <<-EOF
+citizen pushit
+
+Pulls the latest code, restarts, runs the tests, and pushes
+your new code up.
+EOF
+  end
+
+  def run
+    CitizenCodeScripts::Update.run
+    CitizenCodeScripts::Test.run
+
+    step "Pushing" do
+      system('git push')
+    end
+  end
+end

data/lib/citizen_code_scripts/rspec.rb

@@ -0,0 +1,19 @@
+class CitizenCodeScripts::Rspec < CitizenCodeScripts::Base
+  def self.description
+    "Runs your RSpec suite"
+  end
+
+  def run
+    begin
+      load(File.expand_path("./spring", __FILE__))
+    rescue LoadError
+    end
+
+    require 'bundler/setup'
+
+    step "Running RSpec" do
+      command = [Gem.bin_path('rspec-core', 'rspec')] + argv
+      system!(command.join(" "))
+    end
+  end
+end

data/lib/citizen_code_scripts/test.rb

@@ -0,0 +1,17 @@
+class CitizenCodeScripts::Test < CitizenCodeScripts::Base
+  def self.description
+    "Runs all test suites for CI/pushit"
+  end
+
+  def run
+    step "Running test suite" do
+      rspec
+    end
+  end
+
+  private
+
+  def rspec
+    CitizenCodeScripts::Rspec.run
+  end
+end

data/lib/citizen_code_scripts/todayi.rb

@@ -0,0 +1,29 @@
+class CitizenCodeScripts::TodayI < CitizenCodeScripts::Base
+  def self.help
+    <<-EOF
+citizen today-i
+
+Prints out a list of commit message names that you worked on today.
+EOF
+  end
+
+  def self.description
+    "Prints a list of commit msgs from today"
+  end
+
+  def run
+    date_string = Time.now.to_s.split(' ')[0]
+
+    lines = %x{
+      git log \
+        --date=local \
+        --oneline \
+        --after="#{date_string} 00:00" \
+        --before="#{date_string} 23:59"
+    }
+
+    lines.each_line do |line|
+      puts line.split(" ", 2)[1]
+    end
+  end
+end