middleman-scrub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5739863e0db95214f51e9f36e52e504c73d7122b
+  data.tar.gz: 741614d06f80b490f94dad319eec2e8b4f8de57a
+SHA512:
+  metadata.gz: 1e00ef50a170a262145a61bebcbb8e280487655d329063adffb888aca50abb2b48a9e8afbbb63020853bffa5743e058e4d612b0be604ed89578a7d5e1f0d35ea
+  data.tar.gz: cf8af61d5fb0516658c9f17ecc8e4e1321e70c641ced114eafd5384f11212083ae4ce07931d51cbe10bc65cabd3c7a729a94def199ce94b7e23b26bc5050149d

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+/tmp

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+cache: bundler
+before_script:
+  - bundle update
+rvm:
+  - 2.4.0
+  - 2.3.1
+  - 2.2.4
+
+branches:
+  only:
+    - master
+  
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,6 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-scrub.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,10 @@
+ The MIT License (MIT)
+
+Copyright © 2017 Uchio KONDO
+
+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,24 @@
+# middleman-scrub
+
+[![Build Status](https://travis-ci.org/udzura/middleman-scrub.svg?branch=master)](https://travis-ci.org/udzura/middleman-scrub)
+
+Scrub the invalid letters which source file contains.
+
+## Usage
+
+```ruby
+activate :scrub
+```
+
+### Config
+
+```
+activate :scrub,
+  scrub_regexp: /[あ-お]/, # To add target letters
+  target_filename: /\.html$/, # To specify target files
+  verbose: true # Debug
+```
+
+## License
+
+[MIT.](https://udzura.mit-license.org/)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/activate.feature

@@ -0,0 +1,11 @@
+Feature: middleman-scrub is activated
+
+  Scenario: Activate middleman-scrub
+    Given a fixture app "empty-app"
+    And a file named "config.rb" with:
+      """
+      activate :scrub
+      """
+    When I run `middleman build --verbose`
+    Then the exit status should be 0
+    And the output should not contain "Unknown Extension: scrub"

data/features/scrub.feature

@@ -0,0 +1,37 @@
+Feature: scrub the invalid letters
+
+  Scenario: ignore files that does not contain invalid letters
+    Given a fixture app "sample-app"
+    And a file named "config.rb" with:
+      """
+      page '/*.html', layout: false
+      activate :scrub
+      """
+    When I run `middleman build --verbose`
+    Then the exit status should be 0
+    And the file "build/test001.html" should contain 'OK'
+
+  Scenario: scrub letters specified in config.rb
+    Given a fixture app "sample-app"
+    And a file named "config.rb" with:
+      """
+      page '/*.html', layout: false
+      activate :scrub, :scrub_regexp => /[あ-お]/
+      """
+    When I run `middleman build --verbose`
+    Then the exit status should be 0
+    And the file "build/test002.html" should contain 'かきくけこ'
+    And the file "build/test002.html" should not contain 'あいうえお'
+
+  Scenario: scrub invalid letters by default
+    Given a fixture app "sample-app"
+    And a file named "config.rb" with:
+      """
+      page '/*.html', layout: false
+      activate :scrub
+      """
+    When I run `middleman build --verbose`
+    Then the exit status should be 0
+    And the file "build/test003.html" should contain 'あいうえお'
+    And the file "build/test003.html" should not contain invalid letters
+

data/features/support/env.rb

@@ -0,0 +1,6 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'features', 'support', 'extra_step_defs')
+
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-scrub')

data/features/support/extra_step_defs.rb

@@ -0,0 +1,13 @@
+unless defined? EXTRA_STEP_DEFINED
+
+Then /^the file "([^"]*)" should not contain '([^']*)'$/ do |file, partial_content|
+  expect(file).not_to have_file_content(Regexp.new(Regexp.escape(partial_content)), true)
+end
+
+Then /^the file "([^"]*)" should not contain invalid letters$/ do |file|
+  expect(file).not_to have_file_content(/[\u0000\u0001\u000b]/, true)
+end
+
+EXTRA_STEP_DEFINED = 1
+
+end

data/fixtures/sample-app/source/test001.html.md

@@ -0,0 +1,3 @@
+# OK
+
+Example app

data/fixtures/sample-app/source/test002.html.md

@@ -0,0 +1,2 @@
+あいうえお
+かきくけこ

data/fixtures/sample-app/source/test003.html.md.erb

@@ -0,0 +1,2 @@
+<%= "\u0000\u0001\u000b" %>
+あいうえお

data/lib/middleman-scrub/extension.rb

@@ -0,0 +1,40 @@
+# Require core library
+require 'middleman-core'
+
+# Extension namespace
+class ::Middleman::Scrub < ::Middleman::Extension
+  option :scrub_regexp,
+         /[^\u0009\u000A\u000D\u0020-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]/, 'A regexp to match for scrubbing target chars'
+  option :target_filename,
+         /\.(html|xml|rss|txt)\z/, 'Target filename convention to be scrubbed'
+  option :verbose,      false, 'Verbose mode'
+
+  def initialize(app, options_hash={}, &block)
+    super
+  end
+
+  def after_configuration
+    debug("Configured. Regexp: #{options.scrub_regexp}")
+  end
+
+  def after_build(builder)
+    files = Dir.glob("#{app.config[:build_dir]}/**/*")
+              .select{|f| options.target_filename.match(f) }
+
+    files.each do |f|
+      content_orig = File.read(f)
+      content = content_orig.gsub(options.scrub_regexp, "")
+      if content != content_orig
+        File.write(f, content)
+      end
+      debug("Scrubbed: #{f}")
+    end
+  end
+
+  private
+  def debug(msg)
+    STDERR.puts(msg) if options.verbose
+  end
+end
+
+require 'middleman-scrub/version'

data/lib/middleman-scrub/version.rb

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

data/lib/middleman-scrub.rb

@@ -0,0 +1,6 @@
+require "middleman-core"
+
+::Middleman::Extensions.register :scrub do
+  require "middleman-scrub/extension"
+  ::Middleman::Scrub
+end

data/middleman-scrub.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'middleman-scrub/version'
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-scrub"
+  s.version     = MiddlemanScrub::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Uchio Kondo"]
+  s.email       = ["udzura@udzura.jp"]
+  s.homepage    = "https://github.com/udzura/middleman-scrub"
+  s.summary     = %q{Scrub the created files by middleman}
+  s.description = %q{Scrub the created files by middleman}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.2.1"])
+
+  s.add_development_dependency "middleman-cli"
+  s.add_development_dependency "bundler", "~> 1.13"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "cucumber", "~> 1.3"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "aruba", "~> 0.14"
+  s.add_development_dependency "pandoc-ruby"
+  s.add_development_dependency "kramdown"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: middleman-scrub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uchio Kondo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-06 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.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: middleman-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: pandoc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Scrub the created files by middleman
+email:
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/activate.feature
+- features/scrub.feature
+- features/support/env.rb
+- features/support/extra_step_defs.rb
+- fixtures/empty-app/config.rb
+- fixtures/empty-app/source/.gitkeep
+- fixtures/sample-app/config.rb
+- fixtures/sample-app/source/.gitkeep
+- fixtures/sample-app/source/test001.html.md
+- fixtures/sample-app/source/test002.html.md
+- fixtures/sample-app/source/test003.html.md.erb
+- lib/middleman-scrub.rb
+- lib/middleman-scrub/extension.rb
+- lib/middleman-scrub/version.rb
+- middleman-scrub.gemspec
+homepage: https://github.com/udzura/middleman-scrub
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Scrub the created files by middleman
+test_files:
+- features/activate.feature
+- features/scrub.feature
+- features/support/env.rb
+- features/support/extra_step_defs.rb