Project

sentencify

0.0
No commit activity in last 3 years
No release in over 3 years
With Sentencify, you can create sentences with array of Active Record objects. It supports I18n.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

Runtime

 Project Readme

Sentencify

Build Status Coverage Status

With Sentencify, you can create sentences with array of Active Record objects. It supports I18n.

It is inspired by the to_sentence rails method.

Example : Tiste, John, Pierre, Lola and 3 others

Installation

Add this line to your application's Gemfile:

gem 'sentencify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sentencify

Usage

Default

Considering that you have an User model with a login field:

In your controller:

def index
  @users = User.all
end

names = ['John', 'Doe']

In your index.html.erb view:

@users.sentencize(on: :login)

names.sentencize

It will display all your users by login with a default limit of 5.

You can change this value by passing a limit parameter as following: limit: 10

Advanced

Images

You can use the sentencize_images helper if you are in a Rails app.

sentencize_images(@users, on: :avatar)

Parameters

Others parameters:

  • empty, default value: 'No element found'
  • words_connector, default value: ', '
  • two_words_connector, default value: ' and '
  • last_word_connector, default value: ' and '
  • final_singular_connector, default value: ' other'
  • final_plural_connector, default value: ' others'

I18n

You can also set the connectors via I18n by passing a dictionary into the form:

fr:
  sentencify:
    two_words_connector: ' et '
    last_word_connector: ' et '

Contributing

  1. Fork it
  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 new Pull Request