app_manifest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88250826ba2e106bd940d7f102bb681c696808c6
+  data.tar.gz: 69002497677af7078a8ce80bdc212a7dabeb7e51
+SHA512:
+  metadata.gz: 345cf82e77ed451b94f270b47aaec1d86cbe92bb23e3f8f257106b48d0822d8166133bbf6332624a77d7990c7ae12df6facae8e78bcca50cec0132b0df72965d
+  data.tar.gz: 99d7a9f26420962bbac8e5a833a31885f987d417eb0f3c2fcf4d457ebf915afd24cfdea0439f09a1a23a9c80ff8b1c60b7a6e2058a8482895e3d1abcded69919

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+app_manifest-*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in app_manifest.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# AppManifest
+
+A Ruby Gem for parsing AppManifests according to the [app.json
+schema](https://devcenter.heroku.com/articles/app-json-schema)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'app_manifest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install app_manifest
+
+## Usage
+
+Initialize an app manifest:
+
+```ruby
+AppManifest(name: 'my-app')
+```
+
+Extract an environment configuration:
+```ruby
+manifest = AppManifest(name: 'my-app', environments: { test: { addons: ['beta'] } })
+
+manifest.environment(:test).to_hash
+# => { name: 'my-app', addons: [{ plan: 'beta' }] }
+```
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/heroku/app-manifest.
+

data/Rakefile

@@ -0,0 +1,10 @@
+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/app_manifest.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_manifest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'app_manifest'
+  spec.version       = AppManifest::VERSION
+  spec.authors       = ['Owen Jacobson', 'Josh W Lewis']
+  spec.email         = ['ojacobson@heroku.com', 'jlewis@heroku.com']
+
+  spec.summary       = 'A library for parsing Heroku app manifests'
+  spec.description   = 'Parse app manifests used by Heroku Button, Heroku ' \
+                       'Review Apps, and Heroku CI.'
+  spec.homepage      = 'https://devcenter.heroku.com/articles/app-json-schema'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "multi_json", "~> 1.0"
+end

data/bin/console

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

@@ -0,0 +1,166 @@
+require 'multi_json'
+
+require "app_manifest/version"
+require "app_manifest/manifest"
+
+# Create a new manifest from json string or a hash
+def AppManifest(input)
+  if input.is_a?(Hash)
+    AppManifest::Manifest.new(input)
+  elsif input.is_a?(String)
+    AppManifest::Manifest.from_json(input)
+  end
+end
+
+module AppManifest
+  class << self
+    # Takes a hash representing an app manifest and returns a new hash
+    # with canonical serialization. This will resolve shorthands and older
+    # serializations into a canonical serialization.
+    def canonicalize(manifest)
+      keys_to_sym(manifest)
+        .merge(canonicalize_env(manifest))
+        .merge(canonicalize_formation(manifest))
+        .merge(canonicalize_addons(manifest))
+        .merge(canonicalize_environments(manifest))
+    end
+
+    private
+
+    # Takes an env serialization returns a new serialization hash in the
+    # canonical format.
+    # For instance:
+    # canonicalize_env({"FOO" => "BAR"}) # => { "FOO" => { value: "BAR" } }
+    def canonicalize_env(manifest)
+      canonicalize_key(manifest, :env) do |env|
+        Hash[
+          env.map do |key, value|
+            if value.is_a? String
+              value = {
+                value: value,
+              }
+            end
+            [key.to_s, value]
+          end
+        ]
+      end
+    end
+
+    # Takes a formation serialization and returns a new serializaiton in the
+    # standard format.
+    # For example:
+    # canonicalize_formation([{ "process" => "web", "count" => 1 }]
+    # # => { web: { count: 1 } }
+    def canonicalize_formation(manifest)
+      canonicalize_key(manifest, :formation) do |formation|
+        if formation.is_a? Array
+          Hash[
+            formation.map do |entry|
+              process = entry[:process]
+              entry = entry.reject { |k, _| k == :process }
+              [process.to_sym, entry]
+            end
+          ]
+        else
+          formation
+        end
+      end
+    end
+
+    # Takes an addon serialization and returns a new serialization in the
+    # canonical format.
+    # For example:
+    # canonicalize_addons(["heroku-postgres:hobby-dev"])
+    # # => { plan: "heroku-postgres:hobby-dev" }
+    def canonicalize_addons(manifest)
+      canonicalize_key(manifest, :addons) do |addons|
+        addons.map do |entry|
+          if entry.is_a? String
+            {
+              plan: entry,
+            }
+          else
+            entry
+          end
+        end
+      end
+    end
+
+
+    # Takes an environments serialization and canonicalizes each entry.
+    def canonicalize_environments(manifest)
+      canonicalize_key(manifest, :environments) do |environments|
+        Hash[
+          environments.map do |key, environment|
+            [key, canonicalize(environment)]
+          end
+        ]
+      end
+    end
+
+    # Takes a hash, a key in that hash, and a block. If the key is present, runs
+    # the corresponding value through the block and returns a new hash with the
+    # canonicalized value. (This can be merged into the original hash using
+    # .update.) Otherwise, returns an empty hash.
+    def canonicalize_key(manifest, key)
+      if manifest.has_key? key
+        val = manifest[key]
+        {
+          key => yield(val),
+        }
+      else
+        {}
+      end
+    end
+
+    # Takes a (possibly nested) hash whose keys respond to to_sym
+    # Returns a hash where all levels of hashes have only symbol keys
+    #
+    # {"a" => 1, "b" => { "c" => 2 }}
+    #  => {:a => 1, :b => { :c => 2 }}
+    #
+    # This special-cases the immediate children of any key named 'env' or :env,
+    # so that env var names remain (or become) strings.
+    #
+    # {'env' => { 'a' => { 'b' => 2 }}}
+    # => {:env => { 'a' => { :b => 2 }}}
+    def keys_to_sym(hash)
+      Hash[
+        hash.map do |key, val|
+          [
+            key.to_sym,
+            if ['env', :env].include? key
+              env_to_sym(val)
+            else
+              val_to_sym(val)
+            end
+          ]
+        end
+      ]
+    end
+
+    def keys_to_string(hash)
+      Hash[
+        hash.map do |key, val|
+          [key.to_s, val_to_sym(val)]
+        end
+      ]
+    end
+
+    def val_to_sym(value)
+      if value.is_a? Hash
+        keys_to_sym(value)
+      else
+        value
+      end
+    end
+
+    def env_to_sym(value)
+      if value.is_a? Hash
+        keys_to_string(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/app_manifest/manifest.rb

@@ -0,0 +1,26 @@
+module AppManifest
+  # A simple model-like wrapper around a manifest hash.
+  class Manifest
+    def self.from_json(string)
+      hash = MultiJson.load(string)
+      self.new(hash)
+    end
+
+    def initialize(hash)
+      @manifest = AppManifest.canonicalize(hash)
+    end
+
+    def environment(name)
+      env_manifest = manifest.fetch(:environments, {}).fetch(name, {})
+      self.class.new(manifest.merge(env_manifest))
+    end
+
+    def to_hash
+      manifest
+    end
+
+    private
+
+    attr_reader :manifest
+  end
+end

data/lib/app_manifest/version.rb

@@ -0,0 +1,3 @@
+module AppManifest
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: app_manifest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Jacobson
+- Josh W Lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Parse app manifests used by Heroku Button, Heroku Review Apps, and Heroku
+  CI.
+email:
+- ojacobson@heroku.com
+- jlewis@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- app_manifest.gemspec
+- bin/console
+- bin/setup
+- lib/app_manifest.rb
+- lib/app_manifest/manifest.rb
+- lib/app_manifest/version.rb
+homepage: https://devcenter.heroku.com/articles/app-json-schema
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A library for parsing Heroku app manifests
+test_files: []