Nutritious Polygonal Meatball
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    brauhaus-stylespublic

    Brauhaus.js BJCP Styles Plugin

    Dependency Status Build Status Coverage Status NPM version

    A plugin for Brauhaus.js that adds BJCP Styles. Features include:

    • Support for multiple Javascript runtimes
      • Node.js 0.8.19+, 0.10.x
      • Chrome, Firefox, Internet Explorer 9+, Safari, Opera, etc
    • About 80 BJCP Styles defined in the catalog
    • Functions to list categories and styles
    • About 12kb when minified

    Interactive Examples

    Installation

    There are two ways to use Brauhaus.js - either in a web browser (client-side) or on e.g. Node.js (server-side).

    Web Browser (client-side use)

    To use Brauhaus.js in a web browser, simply download the following files and include them as you would any other script:

    <script type="text/javascript" src="/scripts/brauhaus.min.js"></script>
    <script type="text/javascript" src="/scripts/brauhaus-styles.min.js"></script>
    <script type="text/javascript">
        // Your code goes here!
        // See below for an example...
    </script> 

    Node.js (server-side use)

    For Node.js, you can easily install Brauhaus.js plugins using npm:

    npm install brauhaus-styles

    Quick Example

    // The following line is NOT required for web browser use
    var Brauhaus = require('brauhaus');
     
    // Import plugins here, e.g.
    require('brauhaus-beerxml');
     
    // Create a recipe
    var r = new Brauhaus.Recipe({
        name: 'My test brew',
        description: 'A new test beer using Brauhaus.js!',
        batchSize: 20.0,
        boilSize: 10.0,
        style: Brauhaus.getStyle('Bock', 'Doppelbock')
    });
     
    ...

    Beer Styles

    The styles plugin adds many pre-defined BJCP styles to Brauhaus.

    Brauhaus.STYLES

    An object where the keys are categories and the values are objects that contain a group of styles. The styles are objects with ranges for gravities, bitterness, color, and carbonation. The functions below are used to get information from these objects.

    Brauhaus.getStyleCategories ()

    Get a list of BJCP style categories supported by Brauhaus.

    >>> Brauhaus.getStyleCategories()
    ['Light Lager', 'Pilsner', 'Bock', ...]

    Brauhaus.getStyles (string)

    Get a list of styles for a particular category

    >>> Brauhaus.getStyles('Bock')
    ['Maibock / Helles Bock', 'DoppelBock', ...]

    Brauhaus.getStyle (category, style)

    Get an object representing a particular style.

    >>> Brauhaus.getStyle('Bock', 'Doppelbock')
    {
        name: 'Doppelbock',
        category: 'Bock',
        gu: [1.072, 1.112],
        fg: [1.016, 1.024],
        srm: [6, 25],
        ibu: [16, 26],
        abv: [7, 10],
        carb: [1.6, 2.4]
    }

    Contributing

    Contributions are welcome - just fork the project and submit a pull request when you are ready!

    Getting Started

    First, create a fork on GitHub. Then:

    git clone ...
    cd brauhaus-styles
    npm install

    Style Guide

    Brauhaus uses the CoffeeScript Style Guide with the following exceptions:

    1. Indent 4 spaces
    2. Maximum line length is 120 characters

    When building brauhaus.js with cake build or npm test you will see the output of CoffeeLint, a static analysis code quality tool for CoffeeScript. Please adhere to the warnings and errors to ensure your changes will build.

    Unit Tests

    Before submitting a pull request, please add any relevant tests and run them via:

    npm test

    If you have PhantomJS installed and on your path then you can use:

    CI=true npm test

    Pull requests will automatically be tested by Travis CI both in Node.js 0.6/0.8/0.10 and in a headless webkit environment (PhantomJS). Changes that cause tests to fail will not be accepted. New features should be tested to be accepted.

    New tests can be added in the test directory. If you add a new file there, please don't forget to update the test.html to include it!

    Code Coverage

    You can generate a unit test code coverage report for unit tests using the following:

    cake coverage

    You can find an HTML report in the coverage directory that is created. This report will show line-by-line code coverage information.


    Please note that all contributions will be licensed under the MIT license in the following section.

    License

    Copyright (c) 2013 Daniel G. Taylor

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Keywords

    none

    install

    npm i brauhaus-styles

    Downloadsweekly downloads

    8

    version

    1.0.0

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar
    • avatar