sentencify 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjU1NmJiYzIwYjE4OGQ3YWVlOTdlNmI3MGVhODgwMTgwMGU1MWFkMQ==
+  data.tar.gz: !binary |-
+    YjNjMTRhZDI1YThmNGRiNTM5ODEwMWNlOGQ1ZDQzMmFmMTQyYWViMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjA0M2RhZmE3YWJiZTYxYzlkZTdkMWFiMDI1YzlhMjVjOTZhZGQzODlmY2Ey
+    YjhlMTI3OTY2NDYxODQyZmIzZjliODcxYTIwZDA5ZDJlMDkxZDU4ZmQxMjIw
+    Mjc4MWIzYzQ2M2UxOWFmY2QyMTc4YTQyMzNhMDExOGQ5NDQ1OGM=
+  data.tar.gz: !binary |-
+    MmUxYTc2NGRlZjE2NDU3NjJhMmI3NjBiNDIzNTY0OTJiMzg3MTlkYzIwMDU1
+    ZThkNGI2NzE4MzJjNTM5OGU0ZmZkYjYzMTA2M2E3YmM2YzIxZGRjYWIyNWQ3
+    NzlhMDU5NGYwNGVlMjU5ZWYyZmZhNzI1MDA0NWNhZjMxOGU5MGE=

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0 (25/07/13)
+
+* Sentencize images with `sentencize_images` helper
+* Refactor specs
+
 ## 0.2.0 (11/07/13)
 
 * Add specs

data/README.md

@@ -26,11 +26,13 @@ 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
@@ -38,22 +40,28 @@ end
 ```
 
 In your `index.html.erb` view:
+
 ```rb
 @users.sentencize(on: :login)
-@users.sentencize(on: :avatar, image: true)
 ```
 
 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`
 
-**Extra**: You can display images by turning the image option to true.
-
 ### Advanced
+
+#### Images
+
+You can use the `sentencize_images` helper if you are in a Rails app.
+
+```rb
+sentencize_images(@users, on: :avatar)
+```
+
 #### Parameters
 
 Others parameters:
-* `image`, default value: false
 * `empty`, default value: 'No element found'
 * `words_connector`, default value: ', '
 * `two_words_connector`, default value: ' and '
@@ -64,6 +72,7 @@ Others parameters:
 #### I18n
 
 You can also set the connectors via I18n by passing a dictionary into the form:
+
 ```yml
 fr:
   sentencify:

data/lib/sentencify/railtie.rb

@@ -0,0 +1,9 @@
+require 'sentencify/sentencify_helper'
+
+module Sentencify
+  class Railtie < Rails::Railtie
+    initializer 'sentencize.sentencify_helper' do
+      ActionView::Base.send :include, SentencifyHelper
+    end
+  end
+end

data/lib/sentencify/sentencify_helper.rb

@@ -0,0 +1,8 @@
+module Sentencify
+  module SentencifyHelper
+    def sentencize_images(to_sentencify = [], options = {})
+      will_sentencized = to_sentencify.map { |o| image_tag(o.send(options[:on])) }
+      raw(will_sentencized.sentencize(options.merge({ image: true })))
+    end
+  end
+end

data/lib/sentencify/sentencize.rb

@@ -0,0 +1,51 @@
+require 'active_support/core_ext/array'
+
+class Array
+  def sentencize(options = {})
+    assert_sentenciable options
+
+    default_connectors = {
+      on:                       :title,
+      image:                    false,
+      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
+    will_sentencized  = self.dup
+    will_sentencized  = will_sentencized.map! { |o| o[options[:on]] } unless options[:image]
+
+    case length
+    when 0
+      options[:empty]
+    when 1
+      will_sentencized[0]
+    when 2
+      "#{will_sentencized[0]}#{options[:two_words_connector]}#{will_sentencized[1]}"
+    else
+      if options[:limit] >= length
+        "#{will_sentencized[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{will_sentencized[-1]}"
+      else
+        nb_others = length - options[:limit]
+        others    = (nb_others != 1) ? options[:final_plural_connector] : options[:final_singular_connector]
+        "#{will_sentencized[0..options[:limit]-1].join(options[:words_connector])}#{options[:last_word_connector]}#{nb_others}#{others}"
+      end
+    end
+  end
+
+private
+
+  def assert_sentenciable(options = {})
+    options.assert_valid_keys(:on, :image, :limit, :empty, :words_connector, :two_words_connector, :last_word_connector, :final_singular_connector, :final_plural_connector)
+  end
+end

data/lib/sentencify/version.rb

@@ -1,3 +1,3 @@
 module Sentencify
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/sentencify.rb

@@ -1,46 +1,2 @@
-require 'active_support/core_ext/array'
-
-class Array
-  def sentencize(options = {})
-    options.assert_valid_keys(:on, :image, :limit, :empty, :words_connector, :two_words_connector, :last_word_connector, :final_singular_connector, :final_plural_connector)
-
-    default_connectors = {
-      on:                       :title,
-      image:                    false,
-      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)
-
-    will_sentencized = self.map { |o| o[options[:on]] }
-    will_sentencized.map! { |s| "<img src='#{s}' />" } if options[:image]
-
-    case length
-    when 0
-      options[:empty]
-    when 1
-      will_sentencized[0]
-    when 2
-      "#{will_sentencized[0]}#{options[:two_words_connector]}#{will_sentencized[1]}"
-    else
-      if options[:limit] >= length
-        "#{will_sentencized[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{will_sentencized[-1]}"
-      else
-        nb_others = length-options[:limit]
-        others    = (nb_others != 1) ? options[:final_plural_connector] : options[:final_singular_connector]
-        "#{will_sentencized[0..options[:limit]-1].join(options[:words_connector])}#{options[:last_word_connector]}#{nb_others}#{others}"
-      end
-    end
-  end
-end
+require 'sentencify/sentencize'
+require 'sentencify/railtie' if defined?(Rails)

data/spec/sentencify/sentencize_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'sentencify/sentencize'
+
+describe Array do
+  subject { [] }
+
+  describe '#assert_sentenciable' do
+    it { expect { subject.send(:assert_sentenciable, on: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, image: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, limit: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, empty: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, words_connector: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, two_words_connector: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, last_word_connector: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, final_singular_connector: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, final_plural_connector: :field) }.to_not raise_error }
+
+    it { expect { subject.send(:assert_sentenciable, dummy: :field) }.to raise_error }
+  end
+
+  describe '#sentencize' do
+    let(:options) { {} }
+
+    it 'calls #assert_sentenciable with options' do
+      subject.should_receive(:assert_sentenciable).with(options)
+      subject.sentencize(options)
+    end
+
+    context 'when there is no object' do
+      it 'returns a no element found string' do
+        subject.sentencize(on: :login).should == 'No element found'
+      end
+    end
+
+    context 'when there is one object' do
+      subject { [
+        { name: 'Baptiste Lecocq', login: 'Tiste' }
+      ] }
+
+      it 'returns a one element string' do
+        subject.sentencize(on: :login).should == 'Tiste'
+      end
+    end
+
+    context 'when there is two objects' do
+      subject { [
+        { name: 'Baptiste Lecocq', login: 'Tiste' },
+        { name: 'Chuck Norris', login: 'Chucky' }
+      ] }
+
+      it 'returns a two elements string' do
+        subject.sentencize(on: :login).should == 'Tiste and Chucky'
+      end
+    end
+
+    context 'when there is a number of objects less than the limit' do
+      subject { [
+        { name: 'Baptiste Lecocq', login: 'Tiste' },
+        { name: 'Chuck Norris', login: 'Chucky' },
+        { name: 'Van Damme', login: 'JCVD' }
+      ] }
+
+      it 'returns a two elements string' do
+        subject.sentencize(on: :login).should == 'Tiste, Chucky and JCVD'
+      end
+    end
+
+    context 'when there is a number of objects greater than the limit' do
+      subject { [
+        { name: 'Baptiste Lecocq', login: 'Tiste' },
+        { name: 'Chuck Norris', login: 'Chucky' },
+        { name: 'Van Damme', login: 'JCVD' }
+      ] }
+
+      it 'returns a two elements string' do
+        subject.sentencize(on: :login, limit: 2).should == 'Tiste, Chucky and 1 other'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,8 +2,8 @@ require 'coveralls'
 Coveralls.wear!
 
 RSpec.configure do |config|
-  config.filter_run :focus
-  config.order = 'random'
-  config.run_all_when_everything_filtered = true
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run                                       :focus
+  config.order                                            = 'random'
+  config.run_all_when_everything_filtered                 = true
+  config.treat_symbols_as_metadata_keys_with_true_values  = true
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sentencify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Baptiste Lecocq
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -111,35 +100,37 @@ files:
 - README.md
 - Rakefile
 - lib/sentencify.rb
+- lib/sentencify/railtie.rb
+- lib/sentencify/sentencify_helper.rb
+- lib/sentencify/sentencize.rb
 - lib/sentencify/version.rb
 - sentencify.gemspec
-- spec/sentencify_spec.rb
+- spec/sentencify/sentencize_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/baptistelecocq/sentencify
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Create sentences with array of Active Record objects
 test_files:
-- spec/sentencify_spec.rb
+- spec/sentencify/sentencize_spec.rb
 - spec/spec_helper.rb

data/spec/sentencify_spec.rb

@@ -1,99 +0,0 @@
-require 'spec_helper'
-require 'sentencify'
-
-describe Array do
-  let(:to_sentence) { [] }
-
-  describe '#sentencize' do
-    it 'allows :on option' do
-      expect { to_sentence.sentencize(on: :field) }.to_not raise_error
-    end
-
-    it 'allows :image option' do
-      expect { to_sentence.sentencize(image: :field) }.to_not raise_error
-    end
-
-    it 'allows :limit option' do
-      expect { to_sentence.sentencize(limit: :field) }.to_not raise_error
-    end
-
-    it 'allows :empty option' do
-      expect { to_sentence.sentencize(empty: :field) }.to_not raise_error
-    end
-
-    it 'allows :words_connector option' do
-      expect { to_sentence.sentencize(words_connector: :field) }.to_not raise_error
-    end
-
-    it 'allows :two_words_connector option' do
-      expect { to_sentence.sentencize(two_words_connector: :field) }.to_not raise_error
-    end
-
-    it 'allows :last_word_connector option' do
-      expect { to_sentence.sentencize(last_word_connector: :field) }.to_not raise_error
-    end
-
-    it 'allows :final_singular_connector option' do
-      expect { to_sentence.sentencize(final_singular_connector: :field) }.to_not raise_error
-    end
-
-    it 'allows :final_plural_connector option' do
-      expect { to_sentence.sentencize(final_plural_connector: :field) }.to_not raise_error
-    end
-
-    it 'denies other options' do
-      expect { to_sentence.sentencize(test: :field) }.to raise_error
-    end
-
-    context 'when there is no object' do
-      it 'returns a no element found string' do
-        to_sentence.sentencize(on: :login).should == 'No element found'
-      end
-    end
-
-    context 'when there is one object' do
-      let(:to_sentence) { [
-        { name: 'Baptiste Lecocq', login: 'Tiste' }
-      ] }
-
-      it 'returns a one element string' do
-        to_sentence.sentencize(on: :login).should == 'Tiste'
-      end
-    end
-
-    context 'when there is two objects' do
-      let(:to_sentence) { [
-        { name: 'Baptiste Lecocq', login: 'Tiste' },
-        { name: 'Chuck Norris', login: 'Chucky' }
-      ] }
-
-      it 'returns a two elements string' do
-        to_sentence.sentencize(on: :login).should == 'Tiste and Chucky'
-      end
-    end
-
-    context 'when there is a number of objects less than the limit' do
-      let(:to_sentence) { [
-        { name: 'Baptiste Lecocq', login: 'Tiste' },
-        { name: 'Chuck Norris', login: 'Chucky' },
-        { name: 'Van Damme', login: 'JCVD' }
-      ] }
-
-      it 'returns a two elements string' do
-        to_sentence.sentencize(on: :login).should == 'Tiste, Chucky and JCVD'
-      end
-    end
-
-    context 'when there is a number of objects greater than the limit' do
-      let(:to_sentence) { [
-        { name: 'Baptiste Lecocq', login: 'Tiste' },
-        { name: 'Chuck Norris', login: 'Chucky' },
-        { name: 'Van Damme', login: 'JCVD' }
-      ] }
-
-      it 'returns a two elements string' do
-        to_sentence.sentencize(on: :login, limit: 2).should == 'Tiste, Chucky and 1 other'
-      end
-    end
-  end
-end