jekyll-pluralize 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 247bb30b104cb48e834c55bf9efaffc12fe2ed813cd4c6b41091264c5934112a
+  data.tar.gz: '028fbae3322a0b0ee16af79463fd38318e138b25b9ae665abcfa3721e5c6c0b8'
+SHA512:
+  metadata.gz: c8efc7f67b1c0cab704c3f5c94e3a98edf765da55977fe88dd5da061e310591d659e60f6aef3ee70241fe93f661b5a3be6d2d6cb71aae64e1ae65548a8a01231
+  data.tar.gz: 819be8128592cd4399cf2b7ce5bc516dfe64151d025915dc6f229116c088df89098e6abb26dc1f10942128054bae915eb07d8a8ce29157729616639cc86bd1d8

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# changelog jekyll-pluralize
+
+- **0.0.2**
+  - bumped version, just for push the build gem on rubygems repository
+
+- **0.0.1**
+  - firsts commits

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 David Demonchy
+
+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,97 @@
+# jekyll-pluralize
+
+[![Build Status](https://travis-ci.com/fusco/jekyll-pluralize.svg?token=3MyQnqkrgpzDsKfyWtLB&branch=main)](https://travis-ci.com/fusco/jekyll-pluralize)
+
+A plugin to make an simple pluralize with Jekyll.
+
+## installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'jekyll-pluralize'
+```
+
+and add this line in your application's `_config.yml` :
+
+```yml
+# _config.yml
+
+plugins:
+  - jekyll-pluralize
+```
+
+## Usage
+
+In you html file, use liquid syntax with :
+
+```liquid
+{{ number | pluralize: 'singular', 'plural' }}
+```
+### with singular and plural words
+
+If `page.posts.size = 1` or `page.posts.size = 0`
+
+```liquid
+<span>
+ {{ page.post.size }}
+ {{ page.post.size | pluralize: 'post', 'posts' }}
+</span>
+```
+
+render :
+
+```html
+<span>
+ 1 post or 0 post
+</span>
+```
+
+If `page.posts.size >= 2`
+
+```liquid
+<span>
+ {{ page.post.size }}  
+ {{ page.post.size | pluralize: 'post', 'posts' }}
+</span>
+```
+
+render :
+
+```html
+<span>
+ 2 posts
+</span>
+```
+ ### with singular and without plural words
+
+If `page.posts.size = 1` or `page.posts.size = 0`
+
+```liquid
+<span>
+ {{ page.post.size }}  
+ {{ page.post.size | pluralize: 'post' }}
+</span>
+```
+
+```html
+<span>
+ 1 post or 0 post
+</span>
+```
+If `page.posts.size >= 2`
+
+```liquid
+<span>
+ {{ page.post.size }}  
+ {{ page.post.size | pluralize: 'post' }}
+</span>
+```
+
+render :
+
+```html
+<span>
+ 2 posts
+</span>
+```

data/lib/jekyll-pluralize.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# jekyll module
+module Jekyll
+  # Pluralize
+  module Pluralize
+    # pluralize method  {{ number | pluralize: 'word', words' }}
+    def pluralize(*args)
+      analyzed_words(args[0], args[1], args[2]) if args[0].numeric?
+    end
+
+    private
+
+    def analyzed_words(number, singular, plural)
+      if plural.nil?
+        plural_undefined(number, singular)
+      else
+        plural_defined(number, singular, plural)
+      end
+    end
+
+    def plural_defined(number, singular, plural)
+      one_item(number) ? singular : plural
+    end
+
+    def plural_undefined(number, singular)
+      one_item(number) ? singular : singular.concat('s')
+    end
+
+    def one_item(number)
+      return true if number.to_i.equal?(1)
+    end
+  end
+end
+
+# Override Integer CLass
+class Integer
+  def numeric?
+    return true if self =~ /\A\d+\Z/
+
+    begin
+      true if Float(self)
+    rescue TypeError
+      false
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Pluralize)

data/lib/jekyll/pluralize/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# module Jekyll
+module Jekyll
+  # module pluralize, verions
+  module Pluralize
+    VERSION = '0.0.2'
+  end
+end

data/spec/pluralize_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: false
+
+require 'spec_helper'
+
+describe(Jekyll::Pluralize) do
+  let(:output) do
+    pluralize(number, word, words)
+  end
+
+  context 'pluzalize with plural args and 2 items' do
+    let(:word)    { 'post' }
+    let(:words)   { 'posts' }
+    let(:number)  { 2 }
+    let(:content) { "{{ '#{number}' | pluralize: '#{word}', '#{words}' }}" }
+    it 'produces the correct plural string' do
+      expect(output).to eq(words)
+    end
+  end
+
+  context 'not pluzalize with the plural args and 1 item' do
+    let(:word)    { 'post' }
+    let(:words)   { 'posts' }
+    let(:number)  { 1 }
+    let(:content) { "{{ '#{number}' | pluralize: '#{word}', '#{words}' }}" }
+    it 'produces the correct singular string' do
+      expect(output).to eq(word)
+    end
+  end
+end
+
+describe(Jekyll::Pluralize) do
+  let(:output) do
+    pluralize(number, word)
+  end
+
+  context 'pluzalize without plural args and 2 items' do
+    let(:word)    { 'post' }
+    let(:words)   { 'posts' }
+    let(:number)  { 2 }
+    let(:content) { "{{ '#{number}' | pluralize: '#{word}' }}" }
+    it 'produces the correct plural string' do
+      expect(output).to eq(words)
+    end
+  end
+
+  context 'not pluzalize without plural args and 1 item' do
+    let(:word)    { '1 post' }
+    let(:number)  { 1 }
+    let(:content) { "{{ '#{number}' | pluralize: '#{word}' }}" }
+    it 'produces the correct singular' do
+      expect(output).to eq(word)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'liquid'
+require File.expand_path('../lib/jekyll-pluralize.rb', File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  include Jekyll::Pluralize
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pluralize
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- David Demonchy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: pluralize liquid filter for Jekyll
+email:
+- david@demonchy.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/jekyll-pluralize.rb
+- lib/jekyll/pluralize/version.rb
+- spec/pluralize_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fusco/jekyll-pluralize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: liquid filter which converts string with pluralize.
+test_files:
+- spec/spec_helper.rb
+- spec/pluralize_spec.rb