RubyGems - PORTL - Versions diffs - 0.1.0 - Mend

PORTL 0.1.0

Files changed (16) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eed1f0a92f64b92f9d4b8c17006a383f4ab412bc
+  data.tar.gz: 579e5d84d99d4ea9cae9d174638755fc3596bf27
+SHA512:
+  metadata.gz: fc58412ba592ce73a58042b7d5ec2df4843665e94dc23548a64be8a79d8b88ff2edcab1479e65c72ddc67de0e81f2465c2fe776d005cabada792af36ffa3836e
+  data.tar.gz: 59e3b6832e255adae4c56745a81090a72537fe20a2d0ee27d24397bbc11404a1a09b34001cfccf21d5e5c942ca6ce75808c3a50cc9ce682519c23066df0f5203

data/.gitignore ADDED Viewed

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

data/.travis.yml ADDED Viewed

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile ADDED Viewed

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2016 Travis Haynes
+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 ADDED Viewed

@@ -0,0 +1,57 @@
+# PORTL
+**Plain Old Ruby Template Language**
+This is a templating language for Rails that uses plain Ruby.
+```ruby
+raw '<!doctype html>'
+html do
+  head do
+    title 'PORTL Example'
+    meta charset: 'utf-8'
+  end
+  body do
+    div id: 'main' do
+      h1 'Hello world!'
+    end
+  end
+end
+```
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'portl'
+```
+Then run `bundle` to install.
+## Usage
+Create a template in your project with the `.rb` extension. For example,
+`application.html.rb`.
+The syntax for the HTML tags are the same as the `content_tag` view helper.
+Most HTML5 tags should be supported. For those that aren't, just use
+`content_tag` directly.
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`.
+## Contributing
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/hi5dev/portl](https://github.com/hi5dev/portl).
+## License
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs += %w[test lib]
+  t.test_files = FileList['test/**/*_test.rb']
+end
+task default: :test

data/bin/console ADDED Viewed

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'portl'
+require 'irb'
+IRB.start

data/bin/setup ADDED Viewed

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle install

data/lib/portl.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'action_view'
+require 'tilt'
+module PORTL
+  autoload :Engine, 'portl/engine'
+  autoload :HTML, 'portl/html'
+  autoload :Template, 'portl/template'
+  autoload :VERSION, 'portl/version'
+  # Compiles a PORTL template.
+  #
+  # @param [String] data The Ruby code of the template being compiled.
+  # @param [Object] scope An object the engine uses for its context.
+  # @param [Hash] options Options to pass to the engine.
+  # @return [String] The compiled code.
+  def self.compile(data, scope=nil, options={})
+    PORTL::Engine.new(data, scope, options).result
+  end
+end
+# Register the .rb extension with Tilt
+Tilt.register PORTL::Template, 'rb'

data/lib/portl/engine.rb ADDED Viewed

@@ -0,0 +1,54 @@
+class PORTL::Engine
+  include ActionView::Helpers::TagHelper
+  attr_reader :data, :scope, :options
+  attr_accessor :output_buffer
+  def initialize(data, scope=nil, options={})
+    @data = data
+    @scope = scope
+    @options = options
+    @output_buffer = ActionView::OutputBuffer.new
+  end
+  # Compiles the data within the supplied scope and returns the result.
+  #
+  # @return [String] The result of the compiled code.
+  def result
+    eval(data)
+  end
+  # Creates an HTML tag.
+  #
+  # @param [Symbol] tag The tag to generate.
+  # @param [*Array] args Arguments to pass to the Rails `content_tag` helper.
+  # @param [&Proc] block Code to render inside of the tag.
+  # @param [ActionView::OutputBuffer] The updated buffer.
+  def html_tag(tag, *args, &block)
+    if PORTL::HTML::NON_CLOSING_TAGS.include?(tag)
+      output_buffer << raw("<#{tag}#{tag_options(args[0], true)}>")
+    else
+      output_buffer << content_tag(tag, *args, &block)
+    end
+  end
+  # Adds plain text to the output buffer.
+  #
+  # @param [String] value The text to add.
+  # @return [ActionView::OutputBuffer] The updated buffer.
+  def text(value)
+    output_buffer << raw(value)
+  end
+  private
+  # Dynamically create tag generators for all of the supported HTML tags.
+  PORTL::HTML::TAGS.each do |tag|
+    # Do not redefine a method if it already exists.
+    next if methods.include?(tag)
+    # Delegate to the #html_tag method, passing the tag as the first argument.
+    define_method(tag) {|*args, &block| html_tag(tag, *args, &block) }
+  end
+end

data/lib/portl/html.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module PORTL
+  module HTML
+    # All of the HTML tags available to the engine.
+    TAGS = %i[
+      a abbr acronym address applet area article aside audio b base
+      basefont bdi bdo big blockquote body br button canvas caption
+      center cite code col colgroup datalist dd del details dfn dialog
+      dir div dl dt em fieldset figcaption figure font footer form frame
+      frameset h1 head header hr html i iframe img input ins kbd keygen
+      label legend li link main map mark menu menuitem meta meter nav
+      noframes noscript object ol optgroup option output p param pre
+      progress q rp rt ruby s samp script section select small source
+      span strike strong style sub summary sup table tbody td textarea
+      tfoot th thead time title tr track tt u ul var video wbr
+    ]
+    # HTML tags that should not be closed.
+    NON_CLOSING_TAGS = %i[
+      br input meta
+    ]
+  end
+end

data/lib/portl/template.rb ADDED Viewed

@@ -0,0 +1,41 @@
+module PORTL
+  # @!attribute data
+  #   Template source; loaded from a file or given directly.
+  #
+  #   @return [String] The content of the template.
+  #
+  # @!attribute file
+  #   The name of the file where the template data was loaded from.
+  #
+  #   @return [String] Full path to the file.
+  #
+  # @!attribute line
+  #   The line number in #file where template data was loaded from.
+  #
+  #   @return [Integer] Line number.
+  #
+  # @!attribute options
+  #   A Hash of template engine specific options.
+  #
+  #   @return [Hash] Options used to compile the template.
+  #
+  class Template < Tilt::Template
+    # Prepares the template. This is called immediately after the data is
+    # loaded. Instance variables set in this method are available to #evaluate
+    # when it is called.
+    #
+    # @note If this isn't overridden an exception will be raised.
+    def prepare
+      # nothing to see here, move along, oh my God, what is this??
+      # huddle around everybody! come closer and take a look at this empty
+      # method.
+    end
+    # Execute the compiled template and return the result string. Template
+    # evaluation is guaranteed to be performed in the scope object with the
+    # locals specified and with support for yielding to the block.
+    def evaluate(scope, locals)
+      @output ||= PORTL.compile(data, scope, options)
+    end
+  end
+end

data/lib/portl/version.rb ADDED Viewed

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

data/portl.gemspec ADDED Viewed

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'portl/version'
+Gem::Specification.new do |spec|
+  spec.name = 'PORTL'
+  spec.version = PORTL::VERSION
+  spec.authors = ['Travis Haynes']
+  spec.email = ['travis@hi5dev.com']
+  spec.summary = 'A plain Ruby templating language for Rails.'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^#{spec.bindir}/}) do |file|
+    File.basename(file)
+  end
+  spec.require_paths = %w[lib]
+  spec.add_dependency 'rails', '>= 4.0.0'
+  spec.add_dependency 'tilt', '~> 2.0.5'
+  spec.add_development_dependency 'byebug', '~> 9.0.5'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata ADDED Viewed

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: PORTL
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Travis Haynes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2016-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email:
+- travis@hi5dev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/portl.rb
+- lib/portl/engine.rb
+- lib/portl/html.rb
+- lib/portl/template.rb
+- lib/portl/version.rb
+- portl.gemspec
+homepage:
+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: A plain Ruby templating language for Rails.
+test_files: []