jekyll_constant_values 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 055e551e09e53e64092e17f340952638a02e5bb4
+  data.tar.gz: eb2f1b9272b843b2c8536bdd1ae34feec3ec9b4c
+SHA512:
+  metadata.gz: 5ec326b003849b13a66517717a43c2dfc03e8a7fee1d2414c2be40a1570f2b17fffe8e12d947fb85aaa78bd63d6f0ac6d0134667b794b81f9e2866e56e0690d4
+  data.tar.gz: cb5e385336f453e44a5f77bea5bc6de1bc9c03df7b84624e492fd7cfe600ed08ad6eae785ce5cbe8568e6f404b9fb923a4b2e6689caf4cd8910c29c42454a9e9

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll_constant_values.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 unabris
+
+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,65 @@
+# Jekyll Constant Values
+
+__Jekyll Constant Values__ plugin allows you to render constant values in the `.html` files of your [Jekyll][jekyll-web] project. This way, if you have words that you repeat a lot or words that are susceptible to changes (like the number of workers in your company), this plugin helps you to only have to modify the value in a single file.
+
+## 1. Installation
+
+1. Add the following to your site's Gemfile:
+
+```ruby
+gem 'jekyll_constant_values', group: :jekyll_plugins
+```
+
+2. Run `bundle install` in your command line:
+
+```bash
+$ bundle install
+```
+
+3. Create a new YAML file called `constants.yml` under your `_data/` folder. If you prefer, you can customize the name of the file (must be also under `_data/`) and put the name of your custom file without the extension in your `_config.yml` file this way:
+
+```yaml
+constants: your-custom-name
+```
+
+## 2. Usage
+
+1. Fill your constants YAML file with the content you need:
+
+```yaml
+company_name: Group Hirthe-Ritchie
+contact:
+  phone: (186)285-7925
+  address: 282 Kevin Brook
+workers: 150
+```
+
+2. Use `{% const [key] %}` Jekyll tag to render the content you need in the `.html` files:
+
+```html
+<h3>{% const company_name %}</h3>
+<p>We are more than {% const workers %} workers in our company located in {% const contact.address %}.</p>
+<a href="tel:{% const contact.phone %}">Call us</a>
+```
+
+3. After rendering the previous example, you will see the following code in the `.html` file:
+
+```html
+<h3>Group Hirthe-Ritchie</h3>
+<p>We are more than 150 workers in our company located in 282 Kevin Brook.</p>
+<a href="tel:(186)285-7925">Call us</a>
+```
+
+## 3. Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 4. License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[jekyll-web]: https://jekyllrb.com/

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/jekyll_constant_values.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_constant_values/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_constant_values'
+  spec.version       = JekyllConstantValues::VERSION
+  spec.authors       = ['Unai Abrisketa']
+  spec.email         = ['unai.abrisqueta@gmail.com']
+
+  spec.summary       = %q{Jekyll plugin to render constant values}
+  spec.homepage      = 'https://github.com/unabris/jekyll_constant_values'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/jekyll_constant_values.rb

@@ -0,0 +1,66 @@
+require 'jekyll_constant_values/version'
+
+module Jekyll
+  class Site
+    attr_accessor :constants_file
+    alias :process_constants :process
+
+    def process
+      # Get the constants file path
+      const_file = constants_file_path
+      # Exit the process if not valid file
+      exit unless valid_file?(const_file)
+      # Assign the path if valid
+      self.constants_file ||= const_file
+      # Show info message
+      puts "Using file #{const_file} for constant values"
+
+      process_constants
+    end
+
+    def constants_file_path
+      # Check if a custom name for constants file is defined
+      if config['constants'].nil?
+        '_data/constants.yml' # Default constants file
+      else
+        '_data/' + config['constants'] + '.yml' # Custom constants file
+      end
+    end
+
+    def valid_file?(const_file)
+      # Check if the constants file exist
+      unless File.exist?(const_file)
+        puts "No such file or directory #{const_file}"
+        return false
+      end
+      true
+    end
+  end
+
+  class ConstantValues < Liquid::Tag
+    def initialize(tag_name, key, tokens)
+      super
+      @key = key.strip
+    end
+
+    def render(context)
+      # Load Jekyll site object
+      site = context.registers[:site]
+      # Load constants file
+      c_file = YAML.load_file(site.constants_file)
+      # Get constant value
+      c_value = @key.to_s.split('.').inject(c_file) { |h, k| h[k.to_s] }
+      # Check if constant value is empty
+      if c_value.nil?
+        # Get the path of the file where is failing
+        page_path = context.registers[:page]['path']
+        # Show info message
+        puts "No constant value for key '#{@key}' in file '#{page_path}'"
+      end
+      # Return the constant value
+      c_value
+    end
+  end
+end
+
+Liquid::Template.register_tag('const', Jekyll::ConstantValues)

data/lib/jekyll_constant_values/version.rb

@@ -0,0 +1,3 @@
+module JekyllConstantValues
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_constant_values
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unai Abrisketa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- unai.abrisqueta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_constant_values.gemspec
+- lib/jekyll_constant_values.rb
+- lib/jekyll_constant_values/version.rb
+homepage: https://github.com/unabris/jekyll_constant_values
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to render constant values
+test_files: []