Code Monkey home page Code Monkey logo

brewscribe's Introduction

Brewscribe Build Status Code Climate

Brewscribe is a Beersmith2 (.bsmx) file parser.

Installation

gem install brewscribe or gem brewscribe in your Gemfile.

Usage

To start, you can import your .bsmx file with Brewscribe.import(file) where file is any object that responds to #read. This will return a Brewscribe::Document object, containing all the parsed information within the file. Currently, only Recipe objects will be parsed.

By default, Brewscribe will set a text property for each attribute of the recipe, and if it has a parser object it will attempt to further parse the data.

An example of this is found in Brewscribe::IngredientList:

document = Brewscribe.import File.read './spec/support/recipe.bsmx'
recipe = document.recipes.first
recipe.ingredients.class # => Brewscribe::IngredientList
recipe.ingredients.grains.class # => Array
recipe.ingredients.grains.first.class # => Brewscribe::Grain
recipe.ingredients.grains.first.name # => "Pale Malt (2 Row) US"

Contributing

I <3 Contributions.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

TODO

  • Document / Recipe Export
  • More documentation

Author

Created by Andrew Nordman.

brewscribe's People

Contributors

cadwallion avatar omrishiv avatar

Watchers

 avatar  avatar  avatar

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.