env_compare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6417ed28ff6a91297a3ecc58af784d6819d4f59465984720b57cf9e495f553b
+  data.tar.gz: a3e325abdeef448d2dac80474a8f51d433ebb2c047f6bea309b9cdde136d0f09
+SHA512:
+  metadata.gz: d61b7acab0d9661c8e36e2e3e92f1c53cb263184d0c4dfdbbcbd0dcfbcffdc954700384fa77dd0b1a1adc3106a7a4380125e24f352f341b05c9a871e7506d758
+  data.tar.gz: de8a8214ceadb18c47f3abb2ca18e402286ba99ea2b92439a1f375142cd8225be3fe27dab6685912611d36017bc55887b854b5f979e12a6bcb445c5e8a82f573

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.html

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+# https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml
+---
+require:
+  - rubocop-performance
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in env_compare.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    env_compare (0.1.0)
+      launchy
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  env_compare!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,65 @@
+# EnvCompare
+
+Compare Heroku ENV variables across environments in an HTML
+table.
+
+In a perfect world, you're using a platform or tool for managing your
+environment variables across Heroku environments. However, you may
+find the need to compare review app settings, staging, or even
+production environment variables
+
+This gem helps pull down the environment variables and give you
+a little interface to view & compare them with (via a UI)
+
+No server; it's all done via a CLI. It's really just a wrapper around
+some commands around the [heroku cli](https://devcenter.heroku.com/articles/heroku-cli) that does some formatting and
+munging of the output so you don't have to copy it all to Excel
+
+This gem wraps the heroku CLI tool to generates a small temporary
+HTML file & opens it using [launchy](https://github.com/copiousfreetime/launchy)
+
+It automates a few things:
+- Hides environment variables that match across all environments
+- Puts them in alpha order
+
+It's primarily intended to compare pre-production ENV variables
+
+## Installation
+
+    # Install heroku CLI
+    brew tap heroku/brew && brew install heroku
+
+    git clone https://github.com/jaydorsey/env_compare.git && cd env_compare
+    bundle
+    rake build
+    gem install pkg/env_compare-0.1.0.gem
+
+After installation you should have access to the `ec` executable wrapper
+
+> Note: There's no published gem yet. I'm not really sure how useful this is
+> but you can install via above or use the development commands below if you
+> don't want to build & install the gem locally
+
+## Usage
+
+First, you need to login with heroku cli:
+
+    heroku login
+
+Then, you can use the `ec` command
+
+Create a file showing differences between 2 or more heroku applications:
+
+    ec diff heroku-app-name1 heroku-app-name2 heroku-app-name3
+
+## Development
+
+To test this on your machine locally, after cloning the repo:
+
+    git clone https://github.com/jaydorsey/env_compare.git && cd env_compare
+    bundle
+    bundle exec ec diff heroku-app-name1 heroku-app-name2
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jaydorsey/env_compare.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "env_compare"
+
+# 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

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/env_compare.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/env_compare/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'env_compare'
+  spec.version = EnvCompare::VERSION
+  spec.authors = ['Jay Dorsey']
+  spec.email = ['jaydorsey@fastmail.com']
+
+  spec.summary = 'Compare ENV variables across Heroku environments'
+  spec.description = 'Compare ENV variables across Heroku environments'
+  spec.homepage = 'https://jaydorsey.com/'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jaydorsey/env_compare'
+  spec.metadata['changelog_uri'] = 'https://github.com/jaydorsey/env_compare/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'launchy'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+end

data/exe/ec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "env_compare"
+
+EnvCompare::CLI.start(ARGV)

data/lib/env_compare.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'env_compare/errors'
+require 'env_compare/name_space'
+require 'env_compare/version'
+require 'erb'
+require 'launchy'
+require 'securerandom'
+require 'thor'
+require 'pry'
+
+module EnvCompare
+  class CLI < Thor
+    attr_accessor :envs
+
+    desc 'version', 'list version'
+    def version
+      puts EnvCompare::VERSION
+    end
+
+    desc 'list ENVIRONMENT', 'List environment variables for a single environment'
+
+    def list(environment)
+      output = `heroku config -a #{environment}`
+      puts output
+    end
+
+    option :theme, type: :string, default: 'dark', desc: 'Theme to use'
+    option :all, type: :boolean, default: false, desc: 'Display all ENV variables, including matches'
+    desc 'diff ENV1 ENV2', 'Compare environment variables for 2+ environments'
+    def diff(*envs)
+      return list(envs.first) if envs.size == 1
+
+      heroku_results(envs)
+
+      # https://stackoverflow.com/a/5462069/2892779
+      html =
+        theme(options[:theme]).
+          result(
+            ::EnvCompare::NameSpace.new(data: calculated_output(envs), headers: ['KEY', envs].flatten).get_binding
+          )
+
+      save_and_open_file(html)
+    end
+
+    private
+
+    def all_keys
+      @all_keys ||= Set.new
+    end
+
+    def calculated_output(envs)
+      all_keys.sort.map do |key|
+        results = envs.map { |env| heroku_results[env][key] }
+        next if results.uniq.size == 1 && !options[:all]
+
+        [key, *results]
+      end.compact
+    end
+
+    def heroku_results(envs = nil)
+      @heroku_results ||=
+        envs.each_with_object({}) do |env, obj|
+          obj[env] = {}
+          lines = `heroku config -a #{env}`.split("\n").drop(1)
+
+          lines.each do |line|
+            key, _, value = line.partition(':')
+            obj[env][key.strip] = value.strip
+
+            all_keys << key.strip
+          end
+        end
+    end
+
+    def save_and_open_file(html)
+      filename = "#{SecureRandom.hex(32)}.html"
+      output = File.open(filename, 'w')
+      output.write(html)
+      output.close
+
+      full_path = File.join(Dir.pwd, output.path)
+
+      Launchy.open(full_path)
+
+      sleep(1)
+
+      File.delete(full_path)
+    end
+
+    def theme(file)
+      return ERB.new(File.read(theme_path(file))) if File.exist?(theme_path(file))
+
+      raise MissingThemeError
+    end
+
+    def theme_path(file)
+      @theme_path ||= File.join(File.dirname(__dir__), 'themes', "#{file}.erb")
+    end
+  end
+end

data/lib/env_compare/errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module EnvCompare
+  class MissingThemeError < StandardError
+    def message
+      <<~MSG
+
+
+        Theme not found. Use one of:
+
+            --theme light
+            --theme dark
+      MSG
+    end
+  end
+end

data/lib/env_compare/name_space.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EnvCompare
+  class NameSpace
+    def initialize(hash)
+      hash.each do |key, value|
+        singleton_class.send(:define_method, key) { value }
+      end
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/env_compare/version.rb

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

data/themes/dark.erb

@@ -0,0 +1,57 @@
+<html>
+  <head>
+  <style>
+  body {
+    background: #000;
+    font-family: Arial, Helvetica, sans-serif;
+  }
+  table {
+    color: #da8fff;
+    table-layout: fixed;
+    width: 100%;
+  }
+
+  table, th, td {
+    border: 1px solid #636366;
+    border-collapse: collapse;
+  }
+
+  th {
+    color: #ffb340;
+    letter-spacing: 1px;
+  }
+
+  td {
+    padding: 10px;
+    word-wrap: break-word;
+  }
+
+  td:first-child {
+    color: #409cff;
+  }
+  </style>
+  </head>
+  <body>
+    <table>
+      <tr>
+      <% headers.each_with_index do |header, idx| %>
+        <th>
+          <%= header %>&nbsp;
+          (<%= data.map { |col| col[idx] }.compact.size - 1 %> keys)
+        </th>
+      <% end %>
+      </tr>
+      <% data.each do |row| %>
+        <tr>
+          <% row.each do |cell| %>
+            <td>
+              <% unless cell.nil? %>
+                <code><%= cell %></code>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </table>
+  </body>
+</html>

data/themes/light.erb

@@ -0,0 +1,57 @@
+<html>
+  <head>
+  <style>
+  body {
+    background: #fff;
+    font-family: Arial, Helvetica, sans-serif;
+  }
+  table {
+    color: #000;
+    table-layout: fixed;
+    width: 100%;
+  }
+
+  table, th, td {
+    border: 1px solid #636366;
+    border-collapse: collapse;
+  }
+
+  th {
+    color: #000;
+    letter-spacing: 1px;
+  }
+
+  td {
+    padding: 10px;
+    word-wrap: break-word;
+  }
+
+  td:first-child {
+    color: #409cff;
+  }
+  </style>
+  </head>
+  <body>
+    <table>
+      <tr>
+      <% headers.each_with_index do |header, idx| %>
+        <th>
+          <%= header %>&nbsp;
+          (<%= data.map { |col| col[idx] }.compact.size - 1 %> keys)
+        </th>
+      <% end %>
+      </tr>
+      <% data.each do |row| %>
+        <tr>
+          <% row.each do |cell| %>
+            <td>
+              <% unless cell.nil? %>
+                <code><%= cell %></code>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </table>
+  </body>
+</html>

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: env_compare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jay Dorsey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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: thor
+  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: 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: rspec
+  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: rubocop
+  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: rubocop-performance
+  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: Compare ENV variables across Heroku environments
+email:
+- jaydorsey@fastmail.com
+executables:
+- ec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- env_compare.gemspec
+- exe/ec
+- lib/env_compare.rb
+- lib/env_compare/errors.rb
+- lib/env_compare/name_space.rb
+- lib/env_compare/version.rb
+- themes/dark.erb
+- themes/light.erb
+homepage: https://jaydorsey.com/
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://jaydorsey.com/
+  source_code_uri: https://github.com/jaydorsey/env_compare
+  changelog_uri: https://github.com/jaydorsey/env_compare/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Compare ENV variables across Heroku environments
+test_files: []