Code Monkey home page Code Monkey logo

annotate_yaml's Introduction

AnnotateYaml

Gem Version Gem Total Download Code Climate

Have you never been bored to scroll up an entire YAML structure to find out how to access the value?

Fear no more, here is this marvellous gem which add comment to each value of your YAML files so you can easily use it in your views or wherever you may need it.

Quick Exemple

Let's say you want to use the quadrillion value of this file, what is its key?

en:
  number:
    format:
      delimiter: ! ','
      precision: 3
      separator: .
      significant: false
      strip_insignificant_zeros: false
    [...]
    human:
      decimal_units:
        format: ! '%n %u'
        units:
          billion: Billion
          million: Million
          quadrillion: Quadrillion
          thousand: Thousand
          trillion: Trillion
          unit: ''

With annotate_yaml your YAML file will look like this:

en:
  number:
    format:
      delimiter: ! ',' # en.number.format.delimiter
      precision: 3 # en.number.format.precision
      separator: . # en.number.format.separator
      significant: false # en.number.format.significant
      strip_insignificant_zeros: false # en.number.format.strip_insignificant_zeros
    [...]
    human:
      decimal_units:
        format: ! '%n %u' # en.number.human.decimal_units.format
        units:
          billion: Billion # en.number.human.decimal_units.units.billion
          million: Million # en.number.human.decimal_units.units.million
          quadrillion: Quadrillion # en.number.human.decimal_units.units.quadrillion
          thousand: Thousand # en.number.human.decimal_units.units.thousand
          trillion: Trillion # en.number.human.decimal_units.units.trillion
          unit: '' # en.number.human.decimal_units.units.unit

Now you know the key is number.human.decimal_units.units.quadrillion, thanks annotate_yaml!

Installation

Add this line to your application's Gemfile:

gem 'annotate_yaml'

And then execute:

$ bundle

Or install it yourself as:

$ gem install annotate_yaml

Usage

To annotate your locales run:

rake annotate:yaml:locales

This will add a commented key to access each value of the YAML file.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/annotate_yaml/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

annotate_yaml's People

Contributors

apneadiving avatar purban avatar

Stargazers

 avatar  avatar

Watchers

 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.