nanoc-external 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e52bfe8f2eab2b27d2f4d3d5c2836dec17479c84
-  data.tar.gz: 45dc63c7ef389f0eeade105d573956ff505e707b
+SHA256:
+  metadata.gz: 14fc8e63139a81c757162280b1b3b8d02f5a288a5b155dcd46c6e797adcec8e1
+  data.tar.gz: e41ca0b6681e62e67ce43008686e02755c74aaf0fcbcd18d53fc692ea96d7522
 SHA512:
-  metadata.gz: 45f0d2bfb03731996479768de25226c0c959608cc12bb3dcb5c604ed1e702bf1c06a508378cc21fded3e463fb88c8636f6aa7dae2c2cf4d620153b45282e9d3f
-  data.tar.gz: 5077eb9cda044d6b98bc98726ad9550a3a554c3475515e375919ba34027499249109c9a46d668d5620ee0d53cbb742c09e6c45e845219d5a2b34a1b5fb0591f2
+  metadata.gz: af42121acb15406be39401a35c18233dd8a722a69d9ff102574ded2ab90dcff76dfbdc7d4fa86dd5335642d118dedb7264ce2cb726c6433e3329cb032c2c1e34
+  data.tar.gz: 43456697e102ff83c2c3ec3be9c7c3f1c87f8a1011ea27dadce548f23ee38dd50aa632fb6b2519944619006a387c126a0ba544708c8a10cfd68d8a8b29460c25

data/NEWS.md

@@ -1,5 +1,31 @@
 # nanoc-external news
 
+## 1.0.5 (2021-01-01)
+
+Enhancements:
+
+* Added support for Ruby 3.x
+
+## 1.0.4 (2020-03-07)
+
+Fixes:
+
+* Restored compatibility with Nanoc 4.11.14.
+
+## 1.0.3 (2019-04-28)
+
+Fixes:
+
+* Restored compatibility with latest version of Nanoc
+
+## 1.0.2 (2017-12-03)
+
+* Dropped support for Ruby 2.2 and older
+
+## 1.0.1
+
+* Added support for Nanoc 4
+
 ## 1.0.0 (2015-03-07)
 
 Initial release.

data/README.md

@@ -1,35 +1,34 @@
-[![Build Status](https://travis-ci.org/nanoc/nanoc-external.png)](https://travis-ci.org/nanoc/nanoc-external)
-[![Code Climate](https://codeclimate.com/github/nanoc/nanoc-external.png)](https://codeclimate.com/github/nanoc/nanoc-external)
-[![Coverage Status](https://coveralls.io/repos/nanoc/nanoc-external/badge.png?branch=master)](https://coveralls.io/r/nanoc/nanoc-external)
-
 # nanoc-external
 
-This provides a filter that allows [nanoc](http://nanoc.ws) to process content by executing an external program.
-
-Maintained by [lifepillar](https://github.com/lifepillar).
+This provides a filter that allows [Nanoc](https://nanoc.ws) to process content by executing an external program.
 
 ## Installation
 
-`gem install nanoc-external`
+Add `nanoc-external` to the `nanoc` group of your Gemfile:
+
+```ruby
+group :nanoc do
+  gem 'nanoc-external'
+end
+```
 
 ## Usage
 
+Call the `:external` filter and pass the command to execute as the `:exec` argument. For example:
+
 ```ruby
-filter :external, :exec => 'command-name'
+filter :external, exec: 'wc'
 ```
 
-The only requirement is that the external command must be
-able to receive its input from STDIN and it must send its
-output to STDOUT.
+The external command must receive input from standard input (“stdin”) and must send its output to standard out (“stdout”).
 
-Options passed to this filter will be passed on to the
-external command. For example:
+Options passed to this filter will be passed on to the external command. For example:
 
 ```ruby
-filter :external, exec: 'multimarkdown', options: => %w(--accept --mask --labels --smart)
+filter :external, exec: 'multimarkdown', options: %w(--accept --mask --labels --smart)
 ```
 
-If the executable is not in your PATH, use its full path:
+You can also pass the full path of the executable:
 
 ```ruby
 filter :external, exec: '/opt/local/bin/htmlcompressor'

data/lib/nanoc-external.rb

@@ -1,3 +1,3 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'nanoc/external'

data/lib/nanoc/external.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Nanoc
   module External

data/lib/nanoc/external/filter.rb

@@ -1,55 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-module Nanoc::External
+module Nanoc
+  module External
+    class Filter < Nanoc::Filter
+      identifier :external
 
-  # Pipes content through an external process.
-  #
-  # For this filter to work, the external program must be able to receive input
-  # from standard input and it must write its output to standard output.
-  class Filter < Nanoc::Filter
+      def run(content, params = {})
+        cmd   = params.fetch(:exec)
+        opts  = params.fetch(:options, [])
 
-    identifier :external
-
-    # Executes this filter. Parameters passed to this filter
-    # through `:options` will be passed to the specified command.
-    #
-    # @param [String] content The content to filter.
-    #
-    # @option params [Symbol] :options ([]) A list of options for the external command.
-    #
-    # @option params [Symbol] :exec ("") The name or the full path of the executable.
-    #
-    # @option params [Symbol] :debug (false) Set to true to enable debugging.
-    #
-    # @return [String] The filtered content
-    #
-    # @example
-    #   filter :external, exec: 'multimarkdown', options: %w( --smart )
-    #   filter :external, exec: '/usr/local/bin/htmlcompressor
-    def run(content, params = {})
-      debug = params.fetch(:debug, false)
-      cmd   = params.fetch(:exec, nil)
-      opts  = params.fetch(:options, [])
-
-      if cmd.nil?
-        raise Nanoc::Errors::GenericTrivial.new("nanoc-external: missing :exec argument")
+        command = TTY::Command.new(printer: :null)
+        command.run(cmd, *opts, input: content).out
       end
-
-      cmd_with_opts = [ cmd ] + opts
-      odebug(cmd_with_opts.join(' ')) if debug
-      out = StringIO.new
-      piper = Nanoc::Extra::Piper.new(:stdout => out, :stderr => $stderr)
-      piper.run(cmd_with_opts, content)
-      odebug(out.string) if debug
-      out.string
-    end
-
-  private
-
-    def odebug(msg)
-      msg.each_line { |l| puts "\033[1;31mDEBUG:\033[0m #{l}" }
     end
-
   end
-
 end

data/lib/nanoc/external/version.rb

@@ -1,9 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Nanoc
   module External
-
-    VERSION = '1.0.0'
-
+    VERSION = '1.0.5'
   end
 end

metadata

@@ -1,96 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-external
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
-- Lifepillar
-autorequire: 
+- Denis Defreyne
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2021-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nanoc
+  name: nanoc-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.7
-    - - "<"
+        version: '4.11'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.11.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '4.11'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
-description: Provides an :external filter for nanoc
-email: github@lifepillar.org
+        version: 4.11.14
+description: Provides an :external filter for Nanoc
+email: denis+rubygems@denis.ws
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
-- NEWS.md
+extra_rdoc_files: []
 files:
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - NEWS.md
 - README.md
-- Rakefile
 - lib/nanoc-external.rb
 - lib/nanoc/external.rb
 - lib/nanoc/external/filter.rb
 - lib/nanoc/external/version.rb
-- nanoc-external.gemspec
-- test/filters/test_external.rb
-- test/helper.rb
-homepage: http://nanoc.ws/
+homepage: https://nanoc.ws/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
-rdoc_options:
-- "--main"
-- README.md
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
-summary: External filter for nanoc
+summary: External filter for Nanoc
 test_files: []
-has_rdoc: 

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'minitest'
-gem 'rake'
-gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,48 +0,0 @@
-PATH
-  remote: .
-  specs:
-    nanoc-external (1.0.0)
-      nanoc (>= 3.6.7, < 4.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    colored (1.2)
-    coveralls (0.7.11)
-      multi_json (~> 1.10)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.9.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-    cri (2.6.1)
-      colored (~> 1.2)
-    docile (1.1.5)
-    mime-types (2.4.3)
-    minitest (5.5.1)
-    multi_json (1.11.0)
-    nanoc (3.7.5)
-      cri (~> 2.3)
-    netrc (0.10.3)
-    rake (10.4.2)
-    rest-client (1.7.3)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    simplecov (0.9.2)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.3.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.5)
-  coveralls
-  minitest
-  nanoc-external!
-  rake

data/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2014 Denis Defreyne and contributors
-
-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/Rakefile

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs = %w( lib test )
-  t.test_files = FileList['test/**/test_*.rb', 'test/**/*_spec.rb']
-end
-
-task :default => :test

data/nanoc-external.gemspec

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-$LOAD_PATH.unshift(File.expand_path('../lib/', __FILE__))
-require 'nanoc/external/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'nanoc-external'
-  s.version     = Nanoc::External::VERSION
-  s.homepage    = 'http://nanoc.ws/'
-  s.summary     = 'External filter for nanoc'
-  s.description = 'Provides an :external filter for nanoc'
-
-  s.author  = 'Lifepillar'
-  s.email   = 'github@lifepillar.org'
-  s.license = 'MIT'
-
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.files              = Dir['[A-Z]*'] +
-                         Dir['{lib,test}/**/*'] +
-                         [ 'nanoc-external.gemspec' ]
-  s.require_paths      = [ 'lib' ]
-
-  s.rdoc_options     = [ '--main', 'README.md' ]
-  s.extra_rdoc_files = [ 'LICENSE', 'README.md', 'NEWS.md' ]
-
-  s.add_runtime_dependency('nanoc', '>= 3.6.7', '< 4.0.0')
-  s.add_development_dependency('bundler', '~> 1.5')
-end

data/test/filters/test_external.rb

@@ -1,16 +0,0 @@
-# encoding: utf-8
-
-require 'helper'
-
-class Nanoc::External::FilterTest < Minitest::Test
-
-  def test_filter
-    filter = ::Nanoc::External::Filter.new({})
-    src = <<-SHAKESPEARE
-    Shall I compare thee to a Summer's day?
-    Thou art more lovely and more temperate
-    SHAKESPEARE
-    assert_match(/^\s*2\s*$/, filter.run(src, :exec => 'wc', :options => %w( -l ) ))
-  end
-
-end

data/test/helper.rb

@@ -1,9 +0,0 @@
-# encoding: utf-8
-
-require 'coveralls'
-Coveralls.wear!
-
-require 'minitest'
-require 'minitest/autorun'
-require 'nanoc'
-require 'nanoc-external'