rails_vue_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5e1805c87ecdbcf6302374c64a6ce1a136126ec
+  data.tar.gz: 6e94dd43863ba0e4fdf6241c4ff97712353082e7
+SHA512:
+  metadata.gz: 490fb02f4362c1ede03b02c4edfb3705a2c631f438113a11bb20cd730a6707eb11b80233ece6acf974e6d215c491b577af5362a84274d4a9dbdc73a3306a0ad5
+  data.tar.gz: de849851ced6af6c9d41f2e61575f2ab23897c5b6761d5684e0b5e85621e9354b2ab129738ef7e498e56f75e977b62dbd50cd2b65fdec7f4d6b58d40f4495947

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0.pre.3

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 kristaps.kulikovskis@makit.lv. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_vue_helpers.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    rails_vue_helpers (0.1.0)
+      actionview (>= 4.1, < 6.0)
+      activesupport (>= 4.1, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.1.5)
+      activesupport (= 5.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  rails_vue_helpers!
+  rake (~> 10.0)
+  rspec (~> 3.6)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kristaps Kulikovskis
+
+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,85 @@
+# Rails Vue Helpers
+
+This small helper gem allows you to add Vue components to your Rails views with a clean syntax.
+
+Instead of writing
+```ruby
+<some-component v-on:click='doThis' v-bind:vueParam="<%= @some_instance.to_json %>" />
+````
+  you can write
+
+```ruby
+<%= vue_component('someComponent', events: { click: 'doThis'}, binded: { vue_param: @some_instance}) %>
+```
+
+This gem conveniently calls `to_json` on objects, as well as handles cases where parameters include single or double quotes, without screwing up HTML rendering.
+
+All you need to do this wrap everything in a Vue initialized container, and you're good to go.
+
+## Installation
+
+```ruby
+gem 'rails_vue_helpers'
+```
+
+## Usage
+
+`vue_component('componentName', **args, &block)`
+
+All arguments, except special keys: `binded:`, `events:`, `raw:` are translated in regular camelCased Vue props
+
+
+### Events
+
+```ruby
+<%= vue_component('someComponent', events: { click: 'doThis'} ) %>
+```
+will result in
+
+```ruby
+<some-component v-on:click='doThis'></some-component>
+```
+
+### Binded parameters
+
+```ruby
+<%= vue_component('someComponent', binded: { some_array: ['a', 'b'], some_boolean: true } ) %>
+```
+will result in
+
+```ruby
+<some-component v-bind:someArray="['a', 'b']", v-bind:someBoolean="true"></some-component>
+```
+
+### Directives or custom attributes
+
+```ruby
+<%= vue_component('someComponent', raw: 'v-something v-something-else') %>
+```
+will result in
+
+```ruby
+<some-component v-something v-something-else></some-component>
+```
+
+### Wrapper
+
+```ruby
+<%= vue_component('someWrapperComponent') do %>
+  <div>Everything else you need in rails view</div>
+  <%= vue_component('someInnerComponent') %>
+<% end %>
+```
+will result in
+
+```ruby
+<some-wrapper-component>
+  <div>Everything else you need in rails view</div>
+  <some-inner-component></some-inner-component>
+</some-component>
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_vue_helpers"
+
+# 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(__FILE__)

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/rails_vue_helpers.rb

@@ -0,0 +1,10 @@
+require "rails_vue_helpers/version"
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'action_view'
+require 'rails_vue_helpers/vue_component_builder'
+require "rails_vue_helpers/vue_helper"
+
+ActiveSupport.on_load(:action_view) do
+  include RailsVueHelpers::VueHelper
+end

data/lib/rails_vue_helpers/version.rb

@@ -0,0 +1,3 @@
+module RailsVueHelpers
+  VERSION = "0.1.0"
+end

data/lib/rails_vue_helpers/vue_component_builder.rb

@@ -0,0 +1,70 @@
+class RailsVueHelpers::VueComponentBuilder
+  delegate :capture, :content_tag, to: :@template
+  def initialize(template, component_name, **props)
+    @component_name = component_name
+    @props = props
+    @template = template
+    @raw = @props[:raw]
+  end
+
+  def to_html(&block)
+    if block_given?
+      ActiveSupport::SafeBuffer.new("<#{sanitized_component_name} #{attributes} #{@raw}>#{capture(&block)}</#{sanitized_component_name}>")
+    else
+      ActiveSupport::SafeBuffer.new("<#{sanitized_component_name} #{attributes} #{@raw}></#{sanitized_component_name}>")
+    end
+  end
+
+  def sanitized_component_name
+    ActiveSupport::Inflector.underscore(@component_name.to_s).tr('_', '-')
+  end
+
+  private
+
+  def attributes
+    [binded_props, event_props, regular_props].flatten.join(' ')
+  end
+
+  def binded_props
+    binded_props = @props[:binded] || {}
+    binded_props.map { |key, value| transpile_binded_prop(key, value) }
+  end
+
+  def event_props
+    event_props = @props[:events] || {}
+    event_props.map { |key, value| transpile_event_prop(key, value) }
+  end
+
+  def regular_props
+    regular_props = @props.reject { |key, value| [:events, :binded, :raw].include?(key) }
+    regular_props.map { |key, value| transpile_regular_prop(key, value) }
+  end
+
+  def transpile_regular_prop(key, value)
+    normalized_key = key.to_s.underscore.tr('_', '-')
+    normalized_value = value
+
+    if value.is_a?(Array)
+      normalized_value = value.to_s.tr('"', '\'')
+    elsif value =~ /"/
+      normalized_value = value.tr('"', '\'')
+    end
+    "#{normalized_key}=\"#{normalized_value}\" "
+  end
+
+  def transpile_binded_prop(key, value)
+    normalized_key = ActiveSupport::Inflector.underscore(key.to_s).tr('_', '-')
+    normalized_value = value
+    unless value.is_a?(String)
+      # if there are some single quotes in the text, make them in ASCII
+      # so HTML doesn't brake
+      normalized_value = value.to_json.gsub("'", "&#39")
+    end
+    "v-bind:#{normalized_key}='#{normalized_value}'"
+  end
+
+  def transpile_event_prop(key, value)
+    normalized_key = key.to_s.underscore.tr('_', '-')
+    "v-on:#{normalized_key}='#{value}'"
+  end
+end

data/lib/rails_vue_helpers/vue_helper.rb

@@ -0,0 +1,5 @@
+module RailsVueHelpers::VueHelper
+  def vue_component(component_name, **props, &block)
+    RailsVueHelpers::VueComponentBuilder.new(self, component_name, **props).to_html(&block)
+  end
+end

data/rails_vue_helpers.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_vue_helpers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_vue_helpers"
+  spec.version       = RailsVueHelpers::VERSION
+  spec.authors       = ["Kristaps Kulikovskis"]
+  spec.email         = ["kristaps.kulikovskis@gmail.lv"]
+
+  spec.summary       = %q{ActionView helper methods for injecting Vue.js components into your Rails views}
+  spec.description   = %q{ActionView helper methods for injecting Vue.js components into your Rails views}
+  spec.homepage      = "https://github.com/LeKristapino/rails_vue_helpers"
+  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.add_dependency 'activesupport', ['>= 4.1', '< 6.0']
+  spec.add_dependency 'actionview', ['>= 4.1', '< 6.0']
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rails_vue_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kristaps Kulikovskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: ActionView helper methods for injecting Vue.js components into your Rails
+  views
+email:
+- kristaps.kulikovskis@gmail.lv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_vue_helpers.rb
+- lib/rails_vue_helpers/version.rb
+- lib/rails_vue_helpers/vue_component_builder.rb
+- lib/rails_vue_helpers/vue_helper.rb
+- rails_vue_helpers.gemspec
+homepage: https://github.com/LeKristapino/rails_vue_helpers
+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.6.11
+signing_key: 
+specification_version: 4
+summary: ActionView helper methods for injecting Vue.js components into your Rails
+  views
+test_files: []