jekyll-file-protocol 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (12) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +17 -0
  3. data/Gemfile +4 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +67 -0
  6. data/Rakefile +1 -0
  7. data/jekyll-file-protocol.gemspec +26 -0
  8. data/lib/jekyll/filters/relative_path.rb +17 -0
  9. data/lib/jekyll-file-protocol/relative_path_renderer.rb +43 -0
  10. data/lib/jekyll-file-protocol/version.rb +3 -0
  11. data/lib/jekyll-file-protocol.rb +7 -0
  12. metadata +111 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 65c09e1b868b13991dcd019846350db16c970c6c
4
+ data.tar.gz: bae5782a49b0ffeec216dd746700811534237f1f
5
+ SHA512:
6
+ metadata.gz: 203a0d597b2d2a3910bb13361db9aa651f3b0196a8ba48d1df274b39373afe0bdf6fdd87c763fde794dd2006c12c530173b9e9f2a6ee16b36cb6ac4ca4c995d3
7
+ data.tar.gz: c7f7b35dd2e4aac549e35f54497fc8d43cee401a82775f99fa01d937d47f0eb690cb1e4211ec43d45ffda5a9daef76897aef8221f57749b91372ef64cc3b3b86
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in jekyll-file-protocol.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Fire-Dragon-DoL
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # JekyllFileProtocol
2
+
3
+ This gem provides a small set of helpers that should allow you to generate a
4
+ static website that will work on file protocol, using **relative paths** instead
5
+ of absolute paths.
6
+
7
+ This gem is born to help me creating relative paths for filters of the gem [jekyll-assets](https://github.com/ixti/jekyll-assets), which I highly recommend expecially if you know how Ruby on Rails works.
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ gem 'jekyll-file-protocol', '~> 0.1.0'
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install jekyll-file-protocol
22
+
23
+ ## Usage
24
+
25
+ The gem actually provides a single helper (a filter) that is quite straightforward to use.
26
+ The example will use the asset_path filter provided by jekyll-assets gem.
27
+
28
+ So imagine we have these files:
29
+
30
+ ```
31
+ # /house/rooms/living.html
32
+
33
+ <html>
34
+ <body>
35
+ <img src="{{ 'living.png' | asset_path | relative_path }}" />
36
+ </body>
37
+ </html>
38
+ ```
39
+
40
+ ```
41
+ # /assets/living.png
42
+ ```
43
+
44
+ The resulting html will be:
45
+
46
+ ```
47
+ # /_site/house/rooms/living.html
48
+
49
+ <html>
50
+ <body>
51
+ <img src="../../assets/living.png" />
52
+ </body>
53
+ </html>
54
+ ```
55
+
56
+ ## TODO
57
+
58
+ - Write some tests
59
+ - Add helpers that work file with asset\_path on SCSS
60
+
61
+ ## Contributing
62
+
63
+ 1. Fork it
64
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
65
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
66
+ 4. Push to the branch (`git push origin my-new-feature`)
67
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/jekyll-file-protocol.gemspec ADDED
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'jekyll-file-protocol/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "jekyll-file-protocol"
8
+ spec.version = JekyllFileProtocol::VERSION
9
+ spec.authors = ["Fire-Dragon-DoL"]
10
+ spec.email = ["francesco.belladonna@gmail.com"]
11
+ spec.description = %q{Small set of helpers to generate a static website that works on file protocol using relative paths instead of absolute}
12
+ spec.summary = %q{Small set of helpers to generate a static website that works on file protocol}
13
+ spec.homepage = ""
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency "jekyll", "~> 1.2.1"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.3"
24
+ spec.add_development_dependency "pry"
25
+ spec.add_development_dependency "rake"
26
+ end
data/lib/jekyll/filters/relative_path.rb ADDED
@@ -0,0 +1,17 @@
1
+ require 'jekyll-file-protocol/relative_path_renderer'
2
+
3
+ module JekyllFileProtocol
4
+
5
+ module Jekyll
6
+
7
+ module Filters
8
+
9
+ def relative_path(url)
10
+ ::JekyllFileProtocol::RelativePathRenderer.new(@context, url).render
11
+ end
12
+
13
+ end
14
+ end
15
+ end
16
+
17
+ Liquid::Template.register_filter JekyllFileProtocol::Jekyll::Filters
data/lib/jekyll-file-protocol/relative_path_renderer.rb ADDED
@@ -0,0 +1,43 @@
1
+ module JekyllFileProtocol
2
+
3
+ class RelativePathRenderer
4
+
5
+ def initialize(context, path)
6
+ @context = context
7
+ @page_url = @context.registers[:page]['url']
8
+ @path = path.strip
9
+
10
+ generate_relative_path! if is_absolute_path?
11
+ end
12
+
13
+ def render
14
+ @relative_path
15
+ end
16
+
17
+ protected
18
+
19
+ def count_depth(path)
20
+ @page_url.scan('/').size
21
+ end
22
+
23
+ def is_absolute_path?
24
+ @path.start_with?('/')
25
+ end
26
+
27
+ def generate_relative_path!
28
+ @relative_path = @path
29
+ relative = @relative_path
30
+
31
+ if relative.start_with?('//')
32
+ relative = relative[2..-1]
33
+ else
34
+ relative = relative[1..-1]
35
+ end
36
+
37
+ relative = ("../" * count_depth(@page_url)) + relative
38
+ @relative_path = relative
39
+ end
40
+
41
+ end
42
+
43
+ end
data/lib/jekyll-file-protocol/version.rb ADDED
@@ -0,0 +1,3 @@
1
+ module JekyllFileProtocol
2
+ VERSION = "0.1.0"
3
+ end
data/lib/jekyll-file-protocol.rb ADDED
@@ -0,0 +1,7 @@
1
+ require 'jekyll-file-protocol/version'
2
+ require 'jekyll-file-protocol/relative_path_renderer'
3
+ require 'jekyll/filters/relative_path'
4
+
5
+
6
+ module JekyllFileProtocol
7
+ end
metadata ADDED
@@ -0,0 +1,111 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jekyll-file-protocol
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Fire-Dragon-DoL
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-11-28 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: jekyll
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: 1.2.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: 1.2.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: '1.3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: '1.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: pry
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Small set of helpers to generate a static website that works on file
70
+ protocol using relative paths instead of absolute
71
+ email:
72
+ - francesco.belladonna@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - .gitignore
78
+ - Gemfile
79
+ - LICENSE.txt
80
+ - README.md
81
+ - Rakefile
82
+ - jekyll-file-protocol.gemspec
83
+ - lib/jekyll-file-protocol.rb
84
+ - lib/jekyll-file-protocol/relative_path_renderer.rb
85
+ - lib/jekyll-file-protocol/version.rb
86
+ - lib/jekyll/filters/relative_path.rb
87
+ homepage: ''
88
+ licenses:
89
+ - MIT
90
+ metadata: {}
91
+ post_install_message:
92
+ rdoc_options: []
93
+ require_paths:
94
+ - lib
95
+ required_ruby_version: !ruby/object:Gem::Requirement
96
+ requirements:
97
+ - - '>='
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ required_rubygems_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - '>='
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ requirements: []
106
+ rubyforge_project:
107
+ rubygems_version: 2.0.3
108
+ signing_key:
109
+ specification_version: 4
110
+ summary: Small set of helpers to generate a static website that works on file protocol
111
+ test_files: []