sentencify 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+sentencify

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sentencify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Baptiste Lecocq
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,72 @@
+# Sentencify
+
+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:
+```rb
+def index
+  @users = User.all
+end
+```
+
+In your `index.html.erb` view:
+```rb
+@users.sentencize(on: :login)
+```
+
+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
+#### 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:
+```yml
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sentencify/version.rb

@@ -0,0 +1,3 @@
+module Sentencify
+  VERSION = "0.0.1"
+end

data/lib/sentencify.rb

@@ -0,0 +1,44 @@
+require 'active_support/core_ext/array'
+
+class Array
+  def sentencize(options = {})
+    options.assert_valid_keys(:on, :limit, :empty, :words_connector, :two_words_connector, :last_word_connector, :final_connector)
+
+    default_connectors = {
+      on:                       :title,
+      limit:                    5,
+      empty:                    'No element found',
+      words_connector:          ', ',
+      two_words_connector:      ' and ',
+      last_word_connector:      ' and ',
+      final_singular_connector: ' other',
+      final_plural_connector:   ' others'
+    }
+
+    if defined?(I18n)
+      i18n_connectors = I18n.translate(:'sentencify', default: {})
+      default_connectors.merge!(i18n_connectors)
+    end
+
+    options = default_connectors.merge!(options)
+
+    case length
+    when 0
+      options[:empty]
+    when 1
+      self[0][options[:on]]
+    when 2
+      elts = self.map(&options[:on])
+      "#{elts[0]}#{options[:two_words_connector]}#{elts[1]}"
+    else
+      elts = self.map(&options[:on])
+      if options[:limit] >= length
+        "#{elts[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{elts[-1]}"
+      else
+        nb_others = length-options[:limit]
+        others    = (nb_others != 1) ? options[:final_plural_connector] : options[:final_singular_connector]
+        "#{elts[0..options[:limit]-1].join(options[:words_connector])}#{options[:last_word_connector]}#{nb_others}#{others}"
+      end
+    end
+  end
+end

data/sentencify.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sentencify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sentencify'
+  spec.version       = Sentencify::VERSION
+  spec.authors       = ['Baptiste Lecocq']
+  spec.email         = ['baptiste.lecocq@gmail.com']
+  spec.description   = 'Create sentences with array of Active Record objects'
+  spec.summary       = 'Create sentences with array of Active Record objects'
+  spec.homepage      = 'https://github.com/baptistelecocq/sentencify'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sentencify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Baptiste Lecocq
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create sentences with array of Active Record objects
+email:
+- baptiste.lecocq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sentencify.rb
+- lib/sentencify/version.rb
+- sentencify.gemspec
+homepage: https://github.com/baptistelecocq/sentencify
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Create sentences with array of Active Record objects
+test_files: []