middleman-html-beautify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 831d5c0f891beaee101dae3bb9bcd20db08e7d4d3c4f0a2722a76a32a8b602b0
+  data.tar.gz: 6156df30d031bae6ebde811305b48a82811feeb3cf99612fb24a2e9dfd47df27
+SHA512:
+  metadata.gz: 625e52b3066f3c3ab899a6eee45b907bdfab983fadc401c939f0860b26b72b7c1de8c9f966485877751a3fa8e36fef79b1488f31c045037a4a42aa43df226137
+  data.tar.gz: 33a17d61b81beaeaf2b5cf434566962267b0066c80374c2b8673fcd4207dc4885e81b7b8012220fed748aa5cb1c2d588becc8f5c3a6e00d4c3735dad7a07042d

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# We recommend you to keep these unchanged
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.6.3
+gemfile:
+  - Gemfile
+script:
+  - bundle exec rake test

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 inotom
+
+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,45 @@
+# Middleman::HtmlBeautify
+
+[![Build Status](https://travis-ci.org/inotom/middleman-html-beautify.svg?branch=master)](https://travis-ci.org/inotom/middleman-html-beautify)
+
+`middleman-html-beautify` is an extension for the [Middleman](https://middlemanapp.com/) static site generator that beautify HTML via [HTML Beautifier](https://github.com/threedaymonk/htmlbeautifier).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-html-beautify'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+
+## Usage
+
+Add this line to your config.rb
+
+```ruby
+activate :html_beautify
+```
+
+There are default settings.
+
+```ruby
+activate :html_beautify do |option|
+  option.keep_blank_lines = 0
+  option.indent           = "  "
+  option.initial_level    = 0
+  option.stop_on_errors   = false
+end
+```
+
+
+## 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 @@
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+task :test => [:cucumber]
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |task|
+  ENV['TEST'] = 'true'
+  task.cucumber_opts = '--color --strict --format pretty'
+end

data/features/beautify.feature

@@ -0,0 +1,84 @@
+Feature: Beautify HTML
+
+  Scenario: Preview HTML with html_beautify disabled
+    Given a fixture app "basic-app"
+    And a file named "config.rb" with:
+      """
+      """
+    Given the Server is running at "basic-app"
+    When I go to "/index.html"
+    Then I should see:
+      """
+      <!doctype html>
+      <html>
+      <head>
+      <title>Hello World</title>
+      </head>
+      <body>
+
+      <h1>
+      Multi
+      Line
+      </h1>
+      <h2> Broken Up </h2>
+
+
+      </body>
+      </html>
+      """
+
+  Scenario: Preview HTML with html_beautify enabled
+    Given a fixture app "basic-app"
+    And a file named "config.rb" with:
+      """
+      activate :html_beautify
+      """
+    Given the Server is running at "basic-app"
+    When I go to "/index.html"
+    Then I should see:
+      """
+      <!doctype html>
+      <html>
+        <head>
+          <title>Hello World</title>
+        </head>
+        <body>
+          <h1>
+            Multi
+            Line
+          </h1>
+          <h2> Broken Up </h2>
+        </body>
+      </html>
+    """
+
+  Scenario: Preview HTML with html_beautify enabled and custom option
+    Given a fixture app "basic-app"
+    And a file named "config.rb" with:
+      """
+      activate :html_beautify do |option|
+        option.keep_blank_lines = 1
+        option.indent           = "\t"
+        option.initial_level    = 1
+      end
+      """
+    Given the Server is running at "basic-app"
+    When I go to "/index.html"
+    Then I should see:
+      """
+      <!doctype html>
+      	<html>
+      		<head>
+      			<title>Hello World</title>
+      		</head>
+      		<body>
+
+      			<h1>
+      				Multi
+      				Line
+      			</h1>
+      			<h2> Broken Up </h2>
+
+      		</body>
+      	</html>
+      """

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-html-beautify')

data/fixtures/basic-app/config.rb

@@ -0,0 +1 @@
+activate :html_beautify

data/fixtures/basic-app/source/index.html

@@ -0,0 +1,16 @@
+<!doctype html>
+<html>
+<head>
+<title>Hello World</title>
+</head>
+<body>
+
+<h1>
+Multi
+Line
+</h1>
+<h2> Broken Up </h2>
+
+
+</body>
+</html>

data/lib/middleman-html-beautify.rb

@@ -0,0 +1,7 @@
+require 'middleman-core'
+require 'middleman-html-beautify/version'
+
+::Middleman::Extensions.register(:html_beautify) do
+  require 'middleman-html-beautify/extension'
+  ::Middleman::HtmlBeautify::Extension
+end

data/lib/middleman-html-beautify/extension.rb

@@ -0,0 +1,58 @@
+module Middleman
+  module HtmlBeautify
+    class Extension < ::Middleman::Extension
+      option :keep_blank_lines, 0, 'Keep blank lines count'
+      option :indent, '  ', 'Indent character'
+      option :initial_level, 0, 'Starting indent level'
+      option :stop_on_errors, false, 'Stop building with errors'
+
+      def initialize(*)
+        super
+      end
+
+      def after_configuration
+        app.use Rack, options.to_h
+      end
+
+      class Rack
+
+        DEFAULT_OPTIONS = {
+          keep_blank_lines: 0,
+          indent: '  ',
+          initial_level: 0,
+          stop_on_errors: false
+        }
+
+        def initialize app, options = {}
+          require 'htmlbeautifier'
+
+          @app = app
+
+          @options = DEFAULT_OPTIONS.merge(options)
+        end
+
+        def call env
+          status, headers, body = @app.call(env)
+
+          if headers.key? 'Content-Type' and headers['Content-Type'] =~ /html/
+            content = ''
+
+            body.each do |part|
+              content << part
+            end
+
+            content = HtmlBeautifier.beautify(content, @options)
+
+            headers['Content-Length'] = content.bytesize.to_s if headers['Content-Length']
+
+            [status, headers, [content]]
+          else
+            [status, headers, body]
+          end
+        ensure
+          body.close if body.respond_to?(:close)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-html-beautify/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module HtmlBeautify
+    VERSION = '0.1.0'
+  end
+end

data/middleman-html-beautify.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'middleman-html-beautify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-html-beautify"
+  spec.version       = Middleman::HtmlBeautify::VERSION
+  spec.authors       = ["inotom"]
+  spec.email         = ["wdf7322@yahoo.co.jp"]
+
+  spec.summary       = %q{Beautify HTML string}
+  spec.description   = %q{Beautify HTML string}
+  spec.homepage      = "https://github.com/inotom/middleman-html-beautify"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'middleman-core', '>= 4.3'
+  spec.add_runtime_dependency 'htmlbeautifier', '>= 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'cucumber', '~> 1.3'
+  spec.add_development_dependency 'capybara', '~> 3.30'
+  spec.add_development_dependency 'aruba', '~> 0.5'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: middleman-html-beautify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- inotom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.30'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Beautify HTML string
+email:
+- wdf7322@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/beautify.feature
+- features/support/env.rb
+- fixtures/basic-app/config.rb
+- fixtures/basic-app/source/index.html
+- lib/middleman-html-beautify.rb
+- lib/middleman-html-beautify/extension.rb
+- lib/middleman-html-beautify/version.rb
+- middleman-html-beautify.gemspec
+homepage: https://github.com/inotom/middleman-html-beautify
+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.3.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: Beautify HTML string
+test_files:
+- features/beautify.feature
+- features/support/env.rb