liquid-tag-attribute_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 910fc47e5c4f81438c3bb047d9efc21aa0a66999c9915c2f55db3f49fb4ad793
+  data.tar.gz: f109516c8d350a77d641ef9554173a2c2adb6f89a811c6cbe2f2df96bb8757b6
+SHA512:
+  metadata.gz: 2dd04e8d6c1a987c699a0951688c1346c42c42013b4481276b1e329f8c8740b836e1a286af459932e34a06999a1aacd963cf9792d8ca424a34198b56782d935f
+  data.tar.gz: 397c35d8bfb52b246ab59fe5c0cec458ce2e4d576738a8718571c27e38de088683bfecab1223a44d41ded401cdf971bac2fcb3e56d1b5303fc33f1af41df0ad3

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-25
+
+* Initial release

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in liquid-tag-attribute_parser.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop",       "~> 1.7"
+gem "rubocop-rake",  "~> 0.6"
+gem "rubocop-rspec", "~> 2.4"
+
+gem "simplecov", "~> 0.21"
+gem "yard",      "~> 0.9"

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    liquid-tag-attribute_parser (0.1.0)
+      liquid (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    liquid (4.0.3)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.19.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  liquid-tag-attribute_parser!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.4)
+  simplecov (~> 0.21)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Unai Abrisketa
+
+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,177 @@
+# Liquid::Tag::AttributeParser
+
+`Liquid::Tag::AttributeParser` allows you to send familiar `html`-like attributes along with your Liquid tags to receive back a more manageable Ruby hash with all the given information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'liquid-tag-attribute_parser'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install liquid-tag-attribute_parser
+```
+## Usage
+
+Three easy steps:
+
+1. Take the raw argument data you get from the Liquid Tag
+1. Use `Liquid::Tag::AttributeParser` to parse the raw data
+1. Get back the data on a Hash format
+
+#### Working example for [Jekyll tags](https://jekyllrb.com/docs/plugins/tags/):
+
+```ruby
+require "liquid/tag/attribute_parser"
+
+module Jekyll
+  class GreetingTag < Liquid::Tag
+    def initialize(_tag_name, text, _tokens)
+      super
+      @attributes = Liquid::Tag::AttributeParser.new(text).attributes
+    end
+
+    def render(_context)
+      "Hello! My name is #{@attributes[:name]} and I'm #{@attributes[:age]}"
+    end
+  end
+end
+
+Liquid::Template.register_tag('greeting', Jekyll::GreetingTag)
+```
+
+```html
+{% greeting name="Jekyll" age=13 %}
+```
+
+## Supported data types
+
+### `String`
+
+```ruby
+Liquid::Tag::AttributeParser.new('string="This is a string"').attributes
+
+# => {:string=>"This is a string"}
+```
+
+### `Boolean`
+
+```ruby
+Liquid::Tag::AttributeParser.new('boolean=true').attributes
+
+# => {:boolean=>true}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('boolean=false').attributes
+
+# => {:boolean=>false}
+```
+
+### `Integer`
+
+```ruby
+Liquid::Tag::AttributeParser.new('integer=123').attributes
+
+# => {:integer=>123}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('integer=+123').attributes
+
+# => {:integer=>123}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('integer=-123').attributes
+
+# => {:integer=>-123}
+```
+
+### `Float`
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=1.23').attributes
+
+# => {:float=>1.23}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=+1.23').attributes
+
+# => {:float=>1.23}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=-1.23').attributes
+
+# => {:float=>-1.23}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=123.0').attributes
+
+# => {:float=>123.0}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=+123.0').attributes
+
+# => {:float=>123.0}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=-123.0').attributes
+
+# => {:float=>-123.0}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=.123').attributes
+
+# => {:float=>0.123}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=+.123').attributes
+
+# => {:float=>0.123}
+```
+
+```ruby
+Liquid::Tag::AttributeParser.new('float=-.123').attributes
+
+# => {:float=>-0.123}
+```
+
+### Combination of different data types
+
+```ruby
+Liquid::Tag::AttributeParser.new('string="This is a string" boolean=true integer=-123 float=.123').attributes
+
+# => {:string=>"This is a string", :boolean=>true, :integer=>-123, :float=>0.123}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/unabris/liquid-tag-attribute_parser.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "liquid/tag/attribute_parser"
+
+# 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/liquid/tag/attribute_parser/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Liquid
+  class Tag
+    class AttributeParser
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/liquid/tag/attribute_parser.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "attribute_parser/version"
+
+module Liquid
+  class Tag
+    class AttributeParser # :nodoc:
+      # TODO: Improve the key selecting regexp
+      STRING_ATTRIBUTES  = /[^\s]+=(?:'[^']+')|[^\s]+=(?:"[^"]+")/.freeze
+      BOOLEAN_ATTRIBUTES = /[^\s]+=(?:true|false)/.freeze
+      NUMBER_ATTRIBUTES  = /[^\s]+=(?:[+-]?(?:[0-9]*[.])?[0-9]+)/.freeze
+
+      attr_reader :attributes
+
+      def initialize(raw)
+        @raw = raw
+        @attributes = {}
+
+        parse
+      end
+
+      private
+
+      def parse
+        %i[string boolean number].each do |kind|
+          regexp = Object.const_get("#{self.class}::#{kind.upcase}_ATTRIBUTES")
+
+          instance_variable_set("@#{kind}_attributes", @raw.scan(regexp).map { |a| a.split("=") })
+          send("parse_#{kind}_attributes")
+        end
+      end
+
+      def parse_string_attributes
+        @string_attributes.each do |k, v|
+          # TODO: Fin a better way for parsing `v` without `eval`
+          @attributes[k.to_sym] = eval(v) # rubocop:disable Security/Eval
+        end
+      end
+
+      def parse_boolean_attributes
+        @boolean_attributes.each do |k, v|
+          # TODO: Fin a better way for parsing `v` without `eval`
+          @attributes[k.to_sym] = eval(v) # rubocop:disable Security/Eval
+        end
+      end
+
+      def parse_number_attributes
+        @number_attributes.each do |k, v|
+          # Add leading zero when `v` starts with `+.`, `-.` or just `.` because it breaks the `eval` statement
+          v.gsub!(/^[+-]?(\.)/) { |m| m.gsub!(Regexp.last_match(1), "0.") }
+
+          # TODO: Fin a better way for parsing `v` without `eval`
+          @attributes[k.to_sym] = eval(v) # rubocop:disable Security/Eval
+        end
+      end
+    end
+  end
+end

data/liquid-tag-attribute_parser.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/liquid/tag/attribute_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "liquid-tag-attribute_parser"
+  spec.version       = Liquid::Tag::AttributeParser::VERSION
+  spec.authors       = ["Unai Abrisketa"]
+  spec.email         = ["github@unaiabrisketa.com"]
+
+  spec.summary       = "Easily parse liquid tags"
+  spec.description   = "Send html-like attributes along with your Liquid tag and parse them to get a hash back"
+  spec.homepage      = "https://github.com/unabris/liquid-tag-attribute_parser"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/unabris/liquid-tag-attribute_parser"
+  spec.metadata["changelog_uri"] = "https://github.com/unabris/liquid-tag-attribute_parser/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("liquid", ">= 3.0")
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: liquid-tag-attribute_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unai Abrisketa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Send html-like attributes along with your Liquid tag and parse them to
+  get a hash back
+email:
+- github@unaiabrisketa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/liquid/tag/attribute_parser.rb
+- lib/liquid/tag/attribute_parser/version.rb
+- liquid-tag-attribute_parser.gemspec
+homepage: https://github.com/unabris/liquid-tag-attribute_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unabris/liquid-tag-attribute_parser
+  source_code_uri: https://github.com/unabris/liquid-tag-attribute_parser
+  changelog_uri: https://github.com/unabris/liquid-tag-attribute_parser/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.26
+signing_key:
+specification_version: 4
+summary: Easily parse liquid tags
+test_files: []