frozen-filters 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ef57c3f85f527856693505c2e2c78825621460f397faef4cf25180a121c02da
-  data.tar.gz: 182d3df6cd704cd6c8280053defab0a74740d5a723b61cb591cedc2ab533a73a
+  metadata.gz: 8619a0aad345f04850e48755327aee77ad2bdd17de3c70892e63d194cb8dba5f
+  data.tar.gz: 9d4b9ee1ad4f26fb203bf15c7e3595be63d44c1435e9eeaf1f5206cbab84834a
 SHA512:
-  metadata.gz: 27c984064e05a2ecfb0ff37bfb57d3ac4c72261230d1a3257dcf7948b92f6b4742e7034d7047f1f8c59c509c0bfb11d925f8f595ad0e8ce062e9d62667666ce7
-  data.tar.gz: da1ff4689ac0d0949773f77f8c22f3bbbdf622e50b7aadbde9a5b8e37a3edfca727531e05922ebd0684161dd9ac788f981e0fcb46a96b9d489a260b712344ea6
+  metadata.gz: 4e582ec706d6c57202234cdf800e12e222a6391504f84fbff99b6c059f1cb45c7118da178c3a2d32f64a84d6beb8826c516c01477320529368510359580c7fc8
+  data.tar.gz: 127075375c03b4d710d3513d6a757cd34baf048a541859dcc8527f3a4671f0a97f1b9a8c2665f24fa293f7da3e63c79fa0f8b67b6955098d00f57e1797706ea0

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] -
+### Added
+- (DEV) Add test script.
+- (DEV) Add trevis support.
+- (DEV) Add support for `enabled:false` in a test case.
+- Add `extract_path` and `extract_qs` filters.
+- Add `array_head`, `array_tail` and `array_to_taglist` filters.
+
+### Fixed
+- Fix `extract_dirname` when it's only `/index.html`.
+
+
 ## [0.2.0] -
 ### Added
 - Add jekyllrb and installation information to README.md.

data/README.md

@@ -1,5 +1,6 @@
 ## Description
-[![Gem Version](https://badge.fury.io/rb/frozen-filters.svg)](https://badge.fury.io/rb/frozen-filters)  
+[![Gem Version](https://badge.fury.io/rb/frozen-filters.svg)](https://badge.fury.io/rb/frozen-filters)
+[![Build Status](https://travis-ci.org/a-bentofreire/frozen-filters.svg?branch=master)](https://travis-ci.org/a-bentofreire/frozen-filters)  
   
 Liquid filters for shopify [liquid](https://github.com/shopify/liquid) template engine.  
 This ruby gem is a port of [frozen-filters-js](https://github.com/a-bentofreire/frozen-filters-js).
@@ -27,7 +28,7 @@ Usage within `jekyllrb`:
   
 - Add to blog `Gemfile`: 
 ```ruby
-gem "frozen-filters", "~> 0.2.0"
+gem "frozen-filters", "~> 0.3.0"
 ```
 - Add to `plugins` section of blog `_config.yml`: 
 ```ruby
@@ -40,19 +41,45 @@ e.g.
 ```
 
 ## Filters
+### Url Filters
   
 - `remove_ext` - Removes the extension part of an url.   
 e.g. `http://www.example.com/first/second/index?param1=value1&param2=value2`.
   
 - `remove_qs` - Removes the query string part of an url. e.g. `http://www.example.com/first/second/index.html`.
 - `extract_basename` - Returns the basename of an url. e.g. `index.html`.
-- `extract_dirname` - Returns the dirname of an url. e.g. `first/second`.
+- `extract_dirname` - Returns the dirname of an url. e.g. `/first/second`.
+- `extract_path` - Returns the path of an url. e.g. `/first/second/index.html`.
 - `extract_protocol` - Returns the protocol. e.g. `http`.
+- `extract_qs` - Returns the query string. e.g. `param1=value1&param2=value2`.
+  
+### Array Filters
+  
+- `array_head` - Returns the first `N` elements of an array.  
+ e.g. `{{ ["first","second","third"] | array_head: 2 }}` =~ `["first","second"]`.  
+ If the number of parameters is negative it returns an empty array.  
+ The the input isn't an array it returns the untouched input.  
+  
+- `array_tail` - Returns the last `N` elements of an array.  
+ e.g. `{{ ["first","second","third"] | array_tail: 2 }}` =~ `["first","second"]`.  
+ If the number of parameters is negative it returns an empty array.  
+ The the input isn't an array it returns the untouched input.  
+- `array_to_taglist` - Transforms an array into an enclosed html tag list separated by newline.  
+ e.g. `{{ ["first","second" | array_to_taglist: "li" }}`  returns:  
+```html
+<li>first</li>
+<li>second</li>
+```
+  
+If the input isn't an array, it returns the untouched input.
   
 ## Internationalization
   
-The url filters support domains and paths with non-latin characters.  
-e.g. `http://吃.高雄/第一/第二/首頁.html?param1=value1&param2=value2`.
+The url filters support domains and paths with:
+- non-latin characters.  
+e.g. `http://吃.高雄/第一/第二/首頁.html?param1=value1&param2=value2`.  
+- punycodes:  
+e.g. `https://xn--jp-cd2fp15c.xn--fsq.jp/abc/index.html?param1=value1&param2=value2`.  
   
 ## Copyrights
   

data/lib/frozen-filters.rb

@@ -25,25 +25,66 @@ module FrozenFilters
     input.to_s.gsub(/^.*\/([^\/\?]+).*$/, '\1')
   end
 
-  # Returns the dirname of an url. e.g. `first/second`.
+  # Returns the dirname of an url. e.g. `/first/second`.
   def extract_dirname(input)
+    result = extract_path(input).gsub(/\/[^\/]+$/, '')
+    result != "" ? result : "/"
+  end
+
+  # Returns the path of an url. e.g. `/first/second/index.html`.
+  def extract_path(input)
     input_s = input.to_s
     if /^(\w+):/.match(input_s)
-      input_s.gsub(/^\w+:[^\/]*\/\/[^\/]+(\/[^\?]+)\/.*$/, '\1')
+      input_s.gsub(/^\w+:[^\/]*\/\/[^\/]+(\/[^\?]+)(?:\?.*)?$/, '\1')
     else
-      input_s.gsub(/\/[^\/]+$/, '')
+      input_s.gsub(/(?:\?.*)$/, '')
     end
   end
 
   # Returns the protocol. e.g. `http`.
   def extract_protocol(input)
     matches = input.to_s.match(/^(\w+):/)
-    if matches
-      matches[1]
+    matches ? matches[1] : ""
+  end
+
+  # Returns the query string part. e.g. `param1=value1&param2=value2`.
+  def extract_qs(input)
+    input.to_s.gsub(/^[^\?]*\??/, '\1')
+  end
+
+  # Returns the first N elements of an array.
+  # e.g. `{{ ["first","second","third"] | array_head: 2 }}` =~ `["first","second"]`.
+  # If the number of parameters is negative it returns an empty array.
+  # The the input isn't an array it returns the untouched input.
+  def array_head(input, p)
+    input.kind_of?(Array) ? input.take([0, p.to_i].max) : input
+  end
+
+  # Returns the last N elements of an array.
+  # e.g. `{{ ["first","second","third"] | array_tail: 2 }}` =~ `["second","third"]`.
+  # If the number of parameters is negative it returns an empty array.
+  # The the input isn't an array it returns the untouched input.
+  def array_tail(input, p)
+    input.kind_of?(Array) ? input.drop([0, input.length - p.to_i].max) : input
+  end
+
+  # Transforms an array into an enclose html tag list separated by newline.
+  # e.g. `{{ ["first","second" | array_to_taglist: "li" }}` =~
+  # ```html
+  # <li>first</li>
+  # <li>second</li>
+  # ```
+  # The the input isn't an array it returns the untouched input.
+  def array_to_taglist(input, p)
+    if input.kind_of?(Array) && p.kind_of?(String)
+      startTag = "<" + p + ">"
+      endTag = "</" + p + ">"
+      input.length != 0 ? startTag + input.join(endTag + "\n" + startTag) + endTag : ""
     else
-      ""
+      input
     end
   end
+
 end
 
 Liquid::Template.register_filter(FrozenFilters)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen-filters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexandre Bento Freire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -24,9 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: |2
-    frozen-filters adds filters for url processing to the liquid template engine.
-    Designed to be used with jekyll.
+description: "  Liquid filters for shopify template engine. Designed to be used with
+  jekyll.\n"
 email: devpieces@a-bentofreire.com
 executables: []
 extensions: []