rails-vue-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afd0db3f28463bae72f7c7ae725ee14af62bfec326cf0cccb790025577b5a461
+  data.tar.gz: 515631b0e8484733d34cffe0c368681f325bd7f7136be0f056809490b618bb90
+SHA512:
+  metadata.gz: 88cdcfbc2b89cc8594c252e4af3a1efa8f71b0fb16340d179b5323d5fcd756db75db2958b155d458ea755b7cfc007c91583c17eaa064e80a786b403b66e1faa4
+  data.tar.gz: 432849aa7759d818c71406a9d235eedef5d602c99034ac2b9ca114a52ba76ca6d936dfd6c4d781bafeea5c658566c934ef545d9c8325f266b93ccec4a9a67a83

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lucas Hourquebie
+
+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,127 @@
+# Rails::Vue::Helpers
+
+**VueHelpers** is a small gem developed by [Unagi](https://unagi.com.ar/) for Ruby on Rails applications. It has built-in helpers with [Vue.js](https://vuejs.org/) compatibility in order to use some of the most common Rails helpers with Vue.js directives.
+
+The gem allows Rails applications extends the implementation of `link_to`, `content_tag` and `check_box_tag` in order to support Vue.js directives.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-vue-helpers'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-vue-helpers
+
+## Usage
+
+This gem extends some of the most commons Rails helpers, so the original helpers can be used in the same the way as before without any modification.
+
+However, if you'd like to add some Vue directives, you should use consider this gem syntax. The following options applies for all the helpers the gem provides, which at the present time are: `link_to`, `content_tag` and `check_box_tag`.
+
+All the options are received as values of the `vue` key. This key is another option as `class` or `id`, which are officially supported by Rails helpers. So, a full example could be the next one:
+
+```ruby
+<%= link_to users_path,
+  class: 'btn btn-primary',
+  vue: {
+    bind: {class: "disabledUsersLink && 'disabled'"},
+    on:   {click: "handleExportCookie('#{request.uuid}')"}
+  },
+  title: 'This action will redirect you to users list' do
+%>
+  Go to users list
+<% end %>
+```
+
+### v-bind
+`v-bind` is used for one-way data binding. Whenever you need to add one or more `v-bind` directives on a tag, you could use the `binding` key inside the `vue` hash. Its value must be a hash: each key is an attribute binding, whereas its value is the associated binding evaluation.
+
+```ruby
+<%= link_to 'Users list', users_path,
+  class: 'btn btn-primary',
+  vue: {
+    bind: {
+      class: "disabledUsersLink && 'disabled'",
+      title: 'usersLinkTitle'
+    }
+  }
+%>
+```
+
+### v-on
+`v-bind` is used for events handling. If you need to use one or more `v-on` directives on a tag, you must use the `on` key inside the `vue` hash. Its value must be a hash: each key is an event name, whereas its value is the action it will perform when the event is listened.
+
+```ruby
+<%= link_to 'Users list', users_path,
+  class: 'btn btn-primary',
+  vue: {
+    on: {
+      click:     "handleExportCookie('#{request.uuid}')"},
+      mouseover: 'displayHint'
+    }
+  }
+%>
+```
+
+### v-model
+`v-model` directive is used for two-way data binding. This feature is available using the `model` key of the `vue` hash. Its value must be a string, which represents the evaluation of the `v-model`.
+
+```ruby
+<%= check_box_tag "customers_id[]",
+  customer.id,
+  false,
+  class: 'customers_id',
+  vue: {
+    model: 'selectedUsers'
+  }
+%>
+```
+
+### Directives
+Vue has a lot of directives, so the gem implements the `directives` key to support all of them. Directives like `v-show`, `v-if` or `v-for`, and even custom components directives can be used with this. In order to use it, you must set the `directives` key inside the `vue` hash. Its value must be a hash: each key is a directive, whereas its value is the associated data.
+
+```ruby
+<%= content_tag :span, '10% discount',
+  class: 'text-bold',
+  vue: {
+    directives: {
+      show: 'showCouponsForm'
+    }
+  }
+%>
+```
+
+### Props
+Components properties are available through the `props` key of the `vue` hash. Its value must be a hash: each key is a prop, and its value is property data.
+
+```ruby
+<%= content_tag :select2, '',
+  vue: {
+    props: {
+      ajax:              '/users/autocomplete',
+      placeholder:       'Search...',
+      name:              'filter[user_id]'
+    }
+  }
+%>
+```
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucashour/rails-vue-helpers.
+
+## 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,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 "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/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails-vue-helpers/tag_helpers'
+
+module RailsVueHelpers
+  class Railtie < Rails::Railtie
+    initializer 'rails-vue-helpers.view_helper' do
+      ActiveSupport.on_load :action_view do
+        include RailsVueHelpers::TagHelpers
+      end
+    end
+  end
+end

data/lib/rails-vue-helpers/tag_helpers.rb

@@ -0,0 +1,69 @@
+module RailsVueHelpers
+  module TagHelpers
+    def link_to(name = nil, options = nil, html_options = nil, &block)
+      options = html_options unless block_given?
+
+      rails_tag_with_vue_data(super, options, :a)
+    end
+
+    def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+      options = [content_or_options_with_block, options].find do |argument|
+        argument.is_a?(Hash)
+      end
+
+      rails_tag_with_vue_data(super, options)
+    end
+
+    def check_box_tag(name, value = '1', checked = false, options = {})
+      rails_tag_with_vue_data(super, options, :input)
+    end
+
+    private
+
+    def rails_tag_with_vue_data(rails_tag, options, tag_name = nil)
+      regex = rails_tag[/<#{tag_name}.+?>/][/(?:(?!>).)*/]
+
+      rails_tag.gsub(regex, "\\0 #{vue_data(options)}").html_safe
+    end
+
+    def vue_data(options)
+      options  ||= {}
+      attributes = (options[:vue] || options['vue'] || {}).stringify_keys
+      options    = {}
+
+      (attributes['bind'] || {}).each do |key, value|
+        options[":#{key}"] = value
+      end
+
+      (attributes['on'] || {}).each do |key, value|
+        options["@#{key}"] = value
+      end
+
+      (attributes['directives'] || {}).each do |key, value|
+        options["v-#{key}"] = value.to_s
+      end
+
+      (attributes['props'] || {}).each do |key, value|
+        options[key] = value.to_s
+      end
+
+      if attributes['model']
+        options['v-model'] = attributes['model']
+      end
+
+      remove_quotation_marks(options)
+      tag_builder.tag_options(options)
+    end
+
+    def remove_quotation_marks(options)
+      options.each do |key, value|
+        return unless value
+        next if value[0] != "\""
+        next if value[-1] != "\""
+
+        value[0] = ''
+        value[-1] = ''
+      end
+    end
+  end
+end

data/lib/rails-vue-helpers/version.rb

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

data/lib/rails-vue-helpers.rb

@@ -0,0 +1,2 @@
+require "rails-vue-helpers/tag_helpers"
+require "rails-vue-helpers/railtie"

data/rails-vue-helpers.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/rails-vue-helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-vue-helpers'
+  spec.version       = RailsVueHelpers::VERSION
+  spec.authors       = ['Lucas Hourquebie']
+  spec.email         = ['lucashour1993@gmail.com']
+
+  spec.summary       = 'Main Rails helpers extension to support Vue.js attributes'
+  spec.homepage      = 'https://unagi.com.ar/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.add_dependency "actionview", ">= 4.2"
+  spec.add_dependency "railties", ">= 4.2"
+
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rails-vue-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Hourquebie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- lucashour1993@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails-vue-helpers.rb
+- lib/rails-vue-helpers/railtie.rb
+- lib/rails-vue-helpers/tag_helpers.rb
+- lib/rails-vue-helpers/version.rb
+- rails-vue-helpers.gemspec
+homepage: https://unagi.com.ar/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Main Rails helpers extension to support Vue.js attributes
+test_files: []