Git Product home page Git Product logo

app-manifest's Introduction

AppManifest

A Ruby Gem for parsing AppManifests according to the app.json schema

Installation

Add this line to your application's Gemfile:

gem 'app_manifest'

And then execute:

$ bundle

Or install it yourself as:

$ gem install app_manifest

Usage

Initialize an app manifest:

AppManifest(name: 'my-app')

Extract an environment configuration:

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/heroku/app-manifest.

app-manifest's People

Contributors

appleton avatar benri avatar friism avatar joshwlewis avatar raulb avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

app-manifest's Issues

Schema Validation

We do a decent job at canonicalizing our app-manifest data to a standard serialization, given that the manifest passed is correct. However, there are cases where the input JSON does not meet our expectations and cannot be canonicalized:

  • Addon plans are not strings
  • environments values are not objects
  • addons is not an array

We should add code to validate that the json conforms to the app.json spec to prevent services and clients throwing weird errors.

License

Thank you for the work here! This is really useful in making use of the App.json standard more broadly. One thing that is limiting our adoption in production is a license for this gem. Would it be possible to add one to clarify useage rights?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.