app_manifest 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '07832c80f5af96888eaf027f758789adbf3f79a5'
-  data.tar.gz: 908be879c0110a7c0739cff235536687fa6e834c
+  metadata.gz: 98e7fd7a9df5650e85261c7075ba606fee8577a3
+  data.tar.gz: d05a3fc7de5170ee6382f374bf11bbe00cc7d23d
 SHA512:
-  metadata.gz: 3c1b7bdccc06899ce46bef23b268b1807b02e11a69768c4395683a6dba0b3ce25889b9fc30c87284236000270468f48fcbd7afeaaf47f3d9ad2614ac421af230
-  data.tar.gz: 26d2b46194b915ed316f373643059a7dfa4c55843816c04a2cadfa87d5b025739c18d8b17ba531cd750e8b73c0def9d298e541dcc1ee60dd84ff853db6ebde15
+  metadata.gz: 52af724010c244dfa20b5f17ce50f109089acc3e0189ce268ce3391ba781a39a0ece6639aa224ebb6936a801e07ab02fa6538c3097426996f01a1e20fc1a542e
+  data.tar.gz: 695439ffdb68a4a023ed50e8ce522a87275f37cc41bb834e647d4151995d49c021c1746aefee6a52a2a0ec0fb317d4380655800a7adb0d5c450a40d4911c5065

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## [0.3.0] - 2017-06-18
+
+### Added
+- Manifests are now fully modeled. There are now getters and setters for
+  nested data (for example: `manifest.addons.first.plan`).
+
+### Changed
+- `Manifest#to_hash` now returns a hash for the current manifest state, rather
+  than the hash that was passed in.
+- `Manifest#environment` now returns an `Environment` instance, as a result,
+  it's serialization will not include nested `environments` data.
+
+### Removed
+- `Manifest#manifest` was removed as it was superfluous and potentially 
+  confusing. `Manifest#to_hash` may be a suitable replacement.
+
 ## [0.2.1] - 2017-04-04
 ### Fixed
 - Prevent `NoMethodError on TrueClass` when a `true` or `false` environment variable is provided.

data/app_manifest.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_dependency "multi_json", "~> 1.0"
+  spec.add_dependency "virtus", "~> 1.0"
 end

data/lib/app_manifest.rb

@@ -1,6 +1,15 @@
 require 'multi_json'
+require 'virtus'
 
 require "app_manifest/version"
+require "app_manifest/nullable_array"
+require "app_manifest/serializer"
+require "app_manifest/addon"
+require "app_manifest/buildpack"
+require "app_manifest/env"
+require "app_manifest/formation"
+require "app_manifest/environment_attributes"
+require "app_manifest/environment"
 require "app_manifest/manifest"
 
 # Create a new manifest from json string or a hash

data/lib/app_manifest/addon.rb

@@ -0,0 +1,10 @@
+module AppManifest
+  class Addon
+    include Virtus.model
+    include Serializer
+
+    attribute :plan,    String
+    attribute :as,      String
+    attribute :options, Hash[String => String], default: nil
+  end
+end

data/lib/app_manifest/buildpack.rb

@@ -0,0 +1,8 @@
+module AppManifest
+  class Buildpack
+    include Virtus.model
+    include Serializer
+
+    attribute :url, String
+  end
+end

data/lib/app_manifest/env.rb

@@ -0,0 +1,11 @@
+module AppManifest
+  class Env
+    include Virtus.model
+    include Serializer
+
+    attribute :description, String
+    attribute :generator,   String
+    attribute :required,    Boolean
+    attribute :value,       String
+  end
+end

data/lib/app_manifest/environment.rb

@@ -0,0 +1,7 @@
+module AppManifest
+  class Environment
+    include Virtus.model
+    include EnvironmentAttributes
+    include Serializer
+  end
+end

data/lib/app_manifest/environment_attributes.rb

@@ -0,0 +1,21 @@
+module AppManifest
+  # Setup attributes that are shared on Manifest and Environment models
+  module EnvironmentAttributes
+    def self.included(base)
+      base.attribute :addons,      NullableArray[Addon]
+      base.attribute :buildpacks,  NullableArray[Buildpack]
+      base.attribute :description, String
+      base.attribute :env,         Hash[String => Env],       default: nil
+      base.attribute :formation,   Hash[String => Formation], default: nil
+      base.attribute :image,       String
+      base.attribute :keywords,    NullableArray[String]
+      base.attribute :logo,        String
+      base.attribute :name,        String
+      base.attribute :repository,  String
+      base.attribute :scripts,     Hash[String => String],    default: nil
+      base.attribute :stack,       String
+      base.attribute :success_url, String
+      base.attribute :website,     String
+    end
+  end
+end

data/lib/app_manifest/formation.rb

@@ -0,0 +1,9 @@
+module AppManifest
+  class Formation
+    include Virtus.model
+    include Serializer
+
+    attribute :quantity, Integer
+    attribute :size,     String
+  end
+end

data/lib/app_manifest/manifest.rb

@@ -1,26 +1,26 @@
 module AppManifest
   # A simple model-like wrapper around a manifest hash.
   class Manifest
+    include Virtus.model
+    include EnvironmentAttributes
+    include Serializer
+
+    attribute :environments, Hash[String => Environment], default: nil
+
     def self.from_json(string)
       hash = MultiJson.load(string)
-      self.new(hash)
+      new(hash)
     end
 
     def initialize(hash)
-      @manifest = AppManifest.canonicalize(hash)
+      canonicalized = AppManifest.canonicalize(hash)
+      super(canonicalized)
     end
 
     def environment(name)
-      env_manifest = manifest.fetch(:environments, {}).fetch(name, {})
-      self.class.new(manifest.merge(env_manifest))
-    end
-
-    def to_hash
-      manifest
+      scoped_data = (environments || {}).fetch(name.to_s, {}).to_hash
+      global_data = to_hash
+      Environment.new(global_data.merge(scoped_data))
     end
-
-    private
-
-    attr_reader :manifest
   end
 end

data/lib/app_manifest/nullable_array.rb

@@ -0,0 +1,13 @@
+module AppManifest
+  class NullableArray < Array; end
+
+  class NullableArrayAttribute < Virtus::Attribute::Collection
+    default nil
+    required false
+    primitive Array
+
+    def coerce(value)
+      value.nil? ? value : super(value)
+    end
+  end
+end

data/lib/app_manifest/serializer.rb

@@ -0,0 +1,29 @@
+module AppManifest
+  # Serialization logic for AppManifest models
+  module Serializer
+    def self.serialize(value)
+      case value
+      when Array
+        value.map { |v| serialize(v) }
+      when Hash
+        value.each_with_object({}) do |(k, v), h|
+          h[k] = serialize(v)
+        end
+      when Integer, Float, String, Symbol, TrueClass, FalseClass, NilClass
+        value
+      else
+        if value.respond_to?(:attributes)
+          value.attributes.each_with_object({}) do |(key, val), hash|
+            hash[key] = serialize(val) unless val.nil?
+          end
+        else
+          val.to_s
+        end
+      end
+    end
+
+    def to_hash
+      Serializer.serialize(self)
+    end
+  end
+end

data/lib/app_manifest/version.rb

@@ -1,3 +1,3 @@
 module AppManifest
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_manifest
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Owen Jacobson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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:
@@ -86,7 +100,15 @@ files:
 - bin/console
 - bin/setup
 - lib/app_manifest.rb
+- lib/app_manifest/addon.rb
+- lib/app_manifest/buildpack.rb
+- lib/app_manifest/env.rb
+- lib/app_manifest/environment.rb
+- lib/app_manifest/environment_attributes.rb
+- lib/app_manifest/formation.rb
 - lib/app_manifest/manifest.rb
+- lib/app_manifest/nullable_array.rb
+- lib/app_manifest/serializer.rb
 - lib/app_manifest/version.rb
 homepage: https://devcenter.heroku.com/articles/app-json-schema
 licenses: []