railbars 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a030fe6ba8744260b27bf9dc3289152d92e8ab2f
+  data.tar.gz: 0b99415db6b4b97cd399a8dcabe70dd6dee2ca08
+SHA512:
+  metadata.gz: e0d88ba6bb273622ce817e668d5e005d683ff2d044f18162c1aa30c93c4dcf66d72c6af9eaa4d3e7c8e79fe91caf761f8adeb8e75d167a31688dbc9346db2ab8
+  data.tar.gz: 3d8dc0eb14f1ac76256f6faae5e95ef89027809e70b2f7a98fa69b9ef57c3cc790c9a0bed818dae34960e4662673be502bf6bc7d1fc0ee476936f2d79ecb2798

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mark@mrlhumphreys.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mark Humphreys
+
+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,166 @@
+# Railbars
+
+Railbars provides a bunch of view helpers for generating handlebar templates in your rails app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railbars'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install railbars
+
+## Usage
+
+### Expressions
+
+Expressions are simple values
+
+```erb
+  <p><%= hb('hello') %></p>
+```
+
+Output:
+
+```html
+  <p>{{hello}}</p>
+```
+
+### Helpers
+
+If you have defined custom helpers and support literal params and hash params. They can be used like so:
+
+```erb
+  <p><%= hb('nameOfHelper', 'firstParam', 'secondParam', {firstHash: 'a', secondHash: 1}) %></p>
+```
+
+Output:
+
+```html
+  <p>{{#nameOfHelper firstParam secondParam firstHash="a" secondHash=1}}</p>
+```
+
+### Block Helpers
+
+Like Helpers, block helpers support params, but have the added bonus of wrapping around a block:
+
+```erb
+  <%= hb('nameOfHelper', 'firstParam', 'secondParam', {firstHash: 'a', secondHash: 1}) do %>
+    <p>Hello</p>
+  <% end %>
+```
+
+Output:
+
+```html
+  {{#nameOfHelper firstParam secondParam firstHash="a" secondHash=1}}
+    <p>Hello</p>
+  {{/nameOfHelper}}
+```
+
+### Unescape
+
+Handlebars Unescape are available through the `hbunescape` method:
+
+```erb
+  <p><%= hbunescape('hello') %></p>
+```
+
+Output:
+
+```html
+  <p>{{{hello}}}</p>
+```
+
+### Partials
+
+Handlebars Partials are available through the `hbpartial` method:
+
+```erb
+  <p><%= hbpartial('hello') %></p>
+```
+
+Output:
+
+```html
+  <p>{{> hello}}}</p>
+```
+
+### Each
+
+Built in helpers such as each are also provided:
+
+```erb
+  <%= hbeach('item') do %>
+    <li>Element</li>
+  <% end %>
+```
+
+Output:
+
+```html
+  {{#each item}}
+    <li>Element</li>
+  {{/each}}
+```
+
+### If
+
+If, like else, also has a helper with similar syntax:
+
+```erb
+  <%= hbif('loggedIn') do %>
+    <p>Logged In</p>
+  <% end %>
+```
+
+Output:
+
+```html
+  {{#if loggedIn}}
+    <p>Logged In</p>
+  {{/each}}
+```
+
+### Else
+
+Else is just a simple expression and can be placed within an if block:
+
+```erb
+  <%= hbif('loggedIn') do %>
+    <p>Logged In</p>
+    <%= hbelse %>
+    <p>Logged Out</p>
+  <% end %>
+```
+
+Output:
+
+```html
+  {{#if loggedIn}}
+    <p>Logged In</p>
+    {{#else }}
+    <p>Logged Out</p>
+  {{/each}}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrlhumphreys/railbars. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "railbars"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/railbars.rb

@@ -0,0 +1,11 @@
+require 'cgi'
+
+require 'railbars/version'
+
+# :nodoc:
+module Railbars
+
+end
+
+require 'railbars/view_helpers'
+require 'railbars/railtie' if defined?(Rails)

data/lib/railbars/railtie.rb

@@ -0,0 +1,10 @@
+require 'railbars/view_helpers'
+
+module Railbars
+  # :nodoc:
+  class Railtie < Rails::Railtie
+    initializer "railbars.view_helpers" do
+      ActionView::Base.send :include, Railbars::ViewHelpers
+    end
+  end
+end

data/lib/railbars/version.rb

@@ -0,0 +1,4 @@
+module Railbars
+  # :nodoc:
+  VERSION = "0.1.0"
+end

data/lib/railbars/view_helpers.rb

@@ -0,0 +1,219 @@
+module Railbars
+
+  # = View Helpers
+  #
+  # Handlebar Helpers for Rails Views.
+  module ViewHelpers
+    # Handlebars helper, returns an expression, helper or block handlebar string
+    #
+    # @param [String] name
+    #   The name of the value for the expression or the name of the block.
+    #
+    # @param [Array<Object>] params
+    #   The parameters the helper takes
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hb('hello')
+    #   #=> "{{hello}}"
+    #
+    #   irb> hb('myHelper', 'param1', 'param2')
+    #   #=> "{{myHelper param1 param2}}"
+    #
+    #   irb> hb('myBlockHelper', 'param') { '<p>Hello</p>' }
+    #   #=> "{{#myBlockHelper param}}<p>Hello</p>{{/myBlockHelper}}"
+    def hb(name, *params, &block)
+      if block
+        hbblock(name, *params, &block)
+      else
+        if params.any?
+          hbhelper(name, *params)
+        else
+          hbexp(name)
+        end
+      end
+    end
+
+    # Handlebars expression helper, returns the value wrapped in handlebars
+    #
+    # @param [String] exp
+    #   The value to be wrapped
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbexp('hello')
+    #   #=> "{{hello}}"
+    def hbexp(exp)
+      "{{#{exp}}}"
+    end
+
+    # Handlebars block helper, returns the contents of the block wrapped with the specified block helper
+    #
+    # @param [String] name
+    #   The name of the block helper
+    #
+    # @param [Array<Object>] params
+    #   The parameters the helper takes
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbblock('myBlockHelper', 'param') { '<p>Hello</p>' }
+    #   #=> "{{#myBlockHelper param}}<p>Hello</p>{{/myBlockHelper}}"
+    def hbblock(name, *params, &block)
+      "{{##{name} #{hbparams(*params)}}}#{capture(&block)}{{/#{name}}}".html_safe
+    end
+
+    # Handlebars helper helper, returns the helper name with params
+    #
+    # @param [String] name
+    #   The name of the helper
+    #
+    # @param [Array<Object>] params
+    #   The parameters the helper takes
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbhelper('myHelper', 'param1', 'param2')
+    #   #=> "{{myHelper param1 param2}}"
+    def hbhelper(name, *params)
+      "{{#{name} #{hbparams(*params)}}}"
+    end
+
+    # Handlebars escape helper, returns the value wrapped in escaped handlebars
+    #
+    # @param [String] value
+    #   The value to be wrapped
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbunescape('hello')
+    #   #=> "{{{hello}}}"
+    def hbunescape(value)
+      "{{{#{value}}}}"
+    end
+
+    # Handlebars partial helper, returns the value wrapped in partial handlebars
+    #
+    # @param [String] name
+    #   The name of the partial
+    #
+    # @param [Array<Object>] params
+    #   The parameters the partial takes
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbunescape('partialName', 'param1', 'param2')
+    #   #=> "{{> partial param1 param2}}"
+    def hbpartial(name, *params)
+      "{{> #{name} #{hbparams(*params)} }}"
+    end
+
+    # Handlebars each helper, returns the contents of the block wrapped with each handlebars
+    #
+    # @param [String] item
+    #   The name of item
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbeach('point') { '<li>Hello</li>' }
+    #   #=> "{{#each point}}<li>Hello</li>{{/each}}"
+    def hbeach(item, &block)
+      hbblock('each', item, &block)
+    end
+
+    # Handlebars if helper, returns the contents of the block wrapped with if handlebars
+    #
+    # @param [String] condition
+    #   The condition of this block
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbif('present') { '<p>Hello</p>' }
+    #   #=> "{{#if present}}<p>Hello</p>{{/if}}"
+    def hbif(condition, &block)
+      hbblock('if', condition, &block)
+    end
+
+    # Handlebars else helper, returns else wrapped in handlebars
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   irb> hbelse
+    #   #=> "{{hbelse}}"
+    def hbelse
+      hbexp('else')
+    end
+
+    # Translates params into handlebars param literals and hash literals
+    #
+    # @param [Array<Object>] params
+    #   The values to be translated
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   # Translate a hash into handlebars hash literals
+    #   irb> translate_values('cat', 'dog', food: 'lots')
+    #   #=> "cat dog food=\"lots\""
+    def hbparams(*params)
+      if params.empty?
+        nil
+      else
+        values = translate_values(params.select { |p| p.is_a?(String) })
+        hash = translate_hash(params.last.is_a?(Hash) ? params.last : {})
+
+        [values, hash].compact.join(' ')
+      end
+    end
+
+    # Translates params into handlebars param literals
+    #
+    # @param [Array] values
+    #   The values to be translated
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   # Translate a hash into handlebars hash literals
+    #   irb> translate_values('rin', 'len')
+    #   #=> "rin len"
+    def translate_values(values)
+      if values.empty?
+        nil
+      else
+        values.join(' ')
+      end
+    end
+
+    # Translates a hash into handlebars hash literals
+    #
+    # @param [Hash] hash
+    #   The hash to be translated
+    #
+    # @return [String]
+    #
+    # ==== Example:
+    #   # Translate a hash into handlebars hash literals
+    #   irb> translate_hash({miku: "senbonzakura", luka: "double lariat"})
+    #   #=> "miku=\"senbonzakura\" luka=\"double lariat\""
+    def translate_hash(hash)
+      if hash.empty?
+        nil
+      else
+        hash.map do |k, v|
+          value = v.is_a?(String) ? "\"#{v}\"" : v
+          "#{k}=#{value}"
+        end.join(' ')
+      end
+    end
+  end
+end

data/railbars.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'railbars/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "railbars"
+  spec.version       = Railbars::VERSION
+  spec.authors       = ["Mark Humphreys"]
+  spec.email         = ["mark@mrlhumphreys.com"]
+
+  spec.summary       = "Handlebars view helpers for Rails"
+  spec.description   = "Adds a number of helpful view helper methods for rendering Handlebars templates in the view."
+  spec.homepage      = "https://github.com/mrlhumphreys/railbars"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "actionview", "~> 5.0.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: railbars
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Humphreys
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-03 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Adds a number of helpful view helper methods for rendering Handlebars
+  templates in the view.
+email:
+- mark@mrlhumphreys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/railbars.rb
+- lib/railbars/railtie.rb
+- lib/railbars/version.rb
+- lib/railbars/view_helpers.rb
+- railbars.gemspec
+homepage: https://github.com/mrlhumphreys/railbars
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: Handlebars view helpers for Rails
+test_files: []