romantic_text 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21d6578acdda679ea72dd1ec7eb1c577c49afee17896496a90a884ae47058119
+  data.tar.gz: 457453820720e812ccecd82a6a4454d9419203b0161bdefb38259c622c5c8b25
+SHA512:
+  metadata.gz: a71c59dc64fba8d4576d8702eba1e948ed917588771fdf51fddba6e83dbcc71abccd5efc34a18af3b01795adb733f745622a7fad0fb4fd6bfbccfb763c93032a
+  data.tar.gz: cba936040efe1ec973edf74575d8447d4990e2c4148410f28100621cac3aff72d6e351c16ca8f2bd381b029fcaa1384b70c20ada8eb269a40c9a8b398cfbd9a6

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  Exclude:
+    - tmp/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+
+# no romantic :(
+Style/Alias:
+  Enabled: false
+
+# no document
+Style/Documentation:
+  Enabled: false
+
+# incompatible DSL
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+# incompatible DSL
+Metrics/BlockLength:
+  Enabled: false
+
+# incompatible DSL
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*
+
+# my preference :)
+Metrics/LineLength:
+  Max: 120
+
+# my preference :(
+Metrics/MethodLength:
+  Max: 20

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in romantic_text.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    romantic_text (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    power_assert (1.1.4)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rr (1.2.1)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    test-unit (3.3.3)
+      power_assert
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  romantic_text!
+  rubocop (= 0.72.0)
+  test-unit (~> 3.3)
+  test-unit-rr (~> 1.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ru_shalm
+
+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,157 @@
+# RomanticText
+
+> A romantic DSL for writing HTML.
+
+<!-- TOC -->
+
+- [RomanticText](#romantictext)
+    - [Installation](#installation)
+    - [Usage](#usage)
+        - [Simply](#simply)
+        - [Attributes](#attributes)
+        - [Shorthand id / class](#shorthand-id--class)
+        - [Escape HTML](#escape-html)
+        - [Use `h` method](#use-h-method)
+    - [Motivation](#motivation)
+    - [Contributing](#contributing)
+    - [License](#license)
+
+<!-- /TOC -->
+
+## Installation
+
+```ruby
+gem 'romantic_text'
+```
+
+## Usage
+
+```ruby
+require 'romantic_text'
+
+html = RomanticText.markup do
+  `#wrapper`['data-version': '1.0'] do
+    `h1` << 'Welcome to RomanticText'
+    `main.contents`[] do
+      `p`[] do
+        _ 'This is '
+        `strong`[class: 'red'] << 'a romantic DSL'
+        _ ' for writing HTML.'
+      end
+    end
+    dangerous_raw_html '<div class="footer">Thanks.</div>'
+  end
+end
+
+puts html.to_s
+# <div id="wrapper" data-version='1.0'>
+# <h1>Welcome to RomanticText</h1>
+# <main class="contents">
+# <p>This is <strong class="red">a romantic DSL</strong> for writing HTML.</p>
+# </main>
+# <div class="footer">Thanks.</div>
+# </div>
+```
+
+### Simply
+
+```ruby
+html = RomanticText.markup do
+  `div` << 'Hello'
+end
+html.to_s # => <div>Hello</div>
+
+html = RomanticText.markup do
+  `div`[] do
+    _ 'Hello'
+  end
+end
+html.to_s # => <div>Hello</div>
+```
+
+### Attributes
+
+```ruby
+html = RomanticText.markup do
+  `a`[class: 'my-class', href: 'https://example.com'] do
+    _ 'link'
+  end
+end
+html.to_s # => <a class="my-class" href="https://example.com">link</a>
+```
+
+### Shorthand id / class
+
+```ruby
+html = RomanticText.markup do
+  `#my-id` << 'text'
+  `p.my-class1.my-class2` << 'text'
+end
+html.to_s # => <div id="my-id">text</div><p class="my-class1 my-class2">text</p>
+```
+
+### Escape HTML
+
+```ruby
+# safe :)
+html = RomanticText.markup do
+  `div`[] do
+    _ '<script>alert(1)</script>'
+  end
+end
+html.to_s # => <div>&lt;script&gt;alert(1)&lt;/script&gt;</div>
+
+# danger :(
+html = RomanticText.markup do
+  `div`[] do
+    dangerous_raw_html '<script>alert(1)</script>'
+  end
+end
+html.to_s # => <div><script>alert(1)</script></div>
+```
+
+### Use `h` method
+
+```ruby
+html1 = RomanticText.markup do
+  `p`[class: 'red'] do
+    `strong` << 'Hello'
+  end
+end
+
+html2 = RomanticText.markup do
+  h('p', class: 'red') do
+    h('strong') << 'Hello'
+  end
+end
+
+html1.to_s == html2.to_s # => true
+```
+
+## Motivation
+
+I think backquote method is very very exciting :laughing:
+
+```ruby
+class Hoge
+  def `(arg)
+    arg.upcase
+  end
+
+  def custom_eval(&block)
+    instance_eval(&block)
+  end
+end
+
+Hoge.new.custom_eval { `hello` } # => HELLO
+```
+
+It can be used like [Tagged templates in JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rutan/romantic_text.
+
+## 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 '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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'romantic_text'
+
+# 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/romantic_text/element.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module RomanticText
+  class Element
+    def initialize(subject = nil, attributes = {})
+      @name = pick_element_name(subject)
+      @attributes = pick_id_and_classes(subject)
+      merge_attributes!(attributes)
+      @children = []
+    end
+
+    def `(name)
+      Element.new(name).tap { |e| @children.push(e) }
+    end
+
+    def h(name, attributes = {}, &block)
+      public_send(:`, name).render(attributes, &block)
+    end
+
+    def <<(str)
+      @children.push Utils.escape(str)
+    end
+    alias_method :text, :<<
+    alias_method :_, :<<
+
+    def dangerous_raw_html(str)
+      @children.push str.to_s
+    end
+
+    def render(attributes = {}, &block)
+      merge_attributes!(attributes)
+      instance_eval(&block) if block_given?
+      self
+    end
+    alias_method :[], :render
+
+    def to_s
+      inner = @children.map(&:to_s).join('')
+      return inner if @name.nil?
+
+      generate_tag(@name, @attributes, inner)
+    end
+
+    private
+
+    def pick_element_name(subject)
+      return nil if subject.nil?
+
+      name = subject.gsub(/(?:#|\.).*\z/, '')
+      name.empty? ? 'div' : name
+    end
+
+    def pick_id_and_classes(subject)
+      return {} if subject.nil?
+
+      group = subject.scan(/(?:#|\.)[^#\.]+/).group_by { |n| n[0] }
+      {
+        id: group['#'] ? group['#'].first.to_s.delete('#') : nil,
+        class: group['.'] ? group['.'].map { |s| s.delete('.') } : nil
+      }
+    end
+
+    def generate_tag(element_name, attributes, inner_html)
+      name = Utils.escape(element_name)
+      attr_text = generate_attributes(attributes)
+      "<#{name}#{" #{attr_text}" unless attr_text.empty?}>#{inner_html}</#{name}>"
+    end
+
+    def generate_attributes(attributes)
+      attributes.map do |key, value|
+        next if value.nil?
+        next if value.is_a?(Array) && value.empty?
+
+        "#{Utils.escape(key)}=\"#{Utils.escape((value.is_a?(Array) ? value.join(' ') : value))}\""
+      end.compact.join(' ')
+    end
+
+    def merge_attributes!(attributes)
+      attributes.each do |key, value|
+        case @attributes[key]
+        when Array
+          if value.is_a?(Array)
+            @attributes[key].concat!(value)
+          else
+            @attributes[key].push value
+          end
+        else
+          @attributes[key] = value.is_a?(Array) ? value : value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/romantic_text/utils.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'cgi/escape'
+
+module RomanticText
+  module Utils
+    class << self
+      def html_safe?(text)
+        text.respond_to?(:html_safe?) ? text.html_safe? : false
+      end
+
+      def escape(text)
+        html_safe?(text) ? text.to_s : CGI.escapeHTML(text.to_s)
+      end
+    end
+  end
+end

data/lib/romantic_text/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RomanticText
+  VERSION = '0.1.0'
+end

data/lib/romantic_text.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'romantic_text/version'
+require 'romantic_text/utils'
+require 'romantic_text/element'
+
+module RomanticText
+  class << self
+    def markup(&block)
+      Element.new.render(&block)
+    end
+  end
+end

data/romantic_text.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'romantic_text/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'romantic_text'
+  spec.version       = RomanticText::VERSION
+  spec.authors       = ['ru_shalm']
+  spec.email         = ['ru_shalm@hazimu.com']
+
+  spec.summary       = 'A romantic DSL for writing HTML.'
+  spec.homepage      = 'https://github.com/rutan/romantic_text'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '0.72.0'
+  spec.add_development_dependency 'test-unit', '~> 3.3'
+  spec.add_development_dependency 'test-unit-rr', '~> 1.0'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: romantic_text
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ru_shalm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- ru_shalm@hazimu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/romantic_text.rb
+- lib/romantic_text/element.rb
+- lib/romantic_text/utils.rb
+- lib/romantic_text/version.rb
+- romantic_text.gemspec
+homepage: https://github.com/rutan/romantic_text
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A romantic DSL for writing HTML.
+test_files: []