frozen-filters 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b165a0212aff0bea581304fd91dcd2e476f4d4492c2f20a0b1dc121b00942513
-  data.tar.gz: 93e6a6ee246da962eeb235eadfdf2a11579de1bbe5b51538e11cb63315edd885
+  metadata.gz: 9ef57c3f85f527856693505c2e2c78825621460f397faef4cf25180a121c02da
+  data.tar.gz: 182d3df6cd704cd6c8280053defab0a74740d5a723b61cb591cedc2ab533a73a
 SHA512:
-  metadata.gz: 914179ec309c8fdc9f18876f5d17c02f0c242ea2051a05091b133ae79ebc37cf6c4faef7e708b064a6f3d4251f7e18c375822bacd2f5054c297e09456d8bb98e
-  data.tar.gz: a2aed00604fe7531a19cd29776991ade4568f2b8c2e0fb612242517056d8354aa9cc4aefadd159287347b46719dad771d8e078545b447ad2df5b5b94731cd73a
+  metadata.gz: 27c984064e05a2ecfb0ff37bfb57d3ac4c72261230d1a3257dcf7948b92f6b4742e7034d7047f1f8c59c509c0bfb11d925f8f595ad0e8ce062e9d62667666ce7
+  data.tar.gz: da1ff4689ac0d0949773f77f8c22f3bbbdf622e50b7aadbde9a5b8e37a3edfca727531e05922ebd0684161dd9ac788f981e0fcb46a96b9d489a260b712344ea6

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+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.2.0] -
+### Added
+- Add jekyllrb and installation information to README.md.
+- Add badge to README.md.
+
+
+## [0.1.0] -
+### Added
+- Add filters: remove_ext, remove_qs, extract_basename, extract_dirname, extract_protocol.

data/LICENSE.txt

@@ -0,0 +1,25 @@
+MIT License+uuid License
+
+For details of these license see
+https://github.com/a-bentofreire/uuid-licenses/blob/master/MIT-uuid-license.md
+
+
+Copyright (c) 2018 Alexandre Bento Freire
+
+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, the uuid, 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,64 @@
+## Description
+[![Gem Version](https://badge.fury.io/rb/frozen-filters.svg)](https://badge.fury.io/rb/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).
+
+## Installation
+`gem install frozen-filters`  
+
+## Usage
+  
+Usage outside `jekyllrb`:  
+  
+```ruby
+require 'liquid'
+require 'frozen-filters'
+
+vars = {
+  'url' => 'http://www.example.com/first/second/index.html?param1=value1&param2=value2'
+}
+
+@template = Liquid::Template.parse('{{ url | remove_ext }}')
+@template.render(vars)  # http://www.example.com/first/second/index?param1=value1&param2=value2
+```
+  
+Usage within `jekyllrb`:  
+  
+- Add to blog `Gemfile`: 
+```ruby
+gem "frozen-filters", "~> 0.2.0"
+```
+- Add to `plugins` section of blog `_config.yml`: 
+```ruby
+  - frozen-filters
+```
+- Use the filters on any liquid page.
+e.g.
+```html
+{{ "/assets/main.css" | remove_ext }}
+```
+
+## 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_protocol` - Returns the protocol. e.g. `http`.
+  
+## Internationalization
+  
+The url filters support domains and paths with non-latin characters.  
+e.g. `http://吃.高雄/第一/第二/首頁.html?param1=value1&param2=value2`.
+  
+## Copyrights
+  
+© 2018 [Alexandre Bento Freire](https://www.a-bentofreire.com)  
+  
+  
+## License
+  
+[MIT License+uuid License](https://github.com/a-bentofreire/uuid-licenses/blob/master/MIT-uuid-license.md)  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frozen-filters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre Bento Freire
@@ -24,12 +24,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: 
+description: |2
+    frozen-filters adds filters for url processing to the liquid template engine.
+    Designed to be used with jekyll.
 email: devpieces@a-bentofreire.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - lib/frozen-filters.rb
 homepage: https://github.com/a-bentofreire/frozen-filters
 licenses: