nanoc-external 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6b874e7f7ae3fb33148fb4496368a0ff3976f93
-  data.tar.gz: 46edf73cacb6ad444d403bdc8e4ddcc0a5907464
+SHA256:
+  metadata.gz: 0e06ea835b1ad1ab34524b31c62a74842038125a56d3f11c740044572b059f86
+  data.tar.gz: af95f7457c1a766f40522d9823e59bfb73b48cd2408da305ee50726366a645c9
 SHA512:
-  metadata.gz: 10e5a9cf175954db4ced30bc5f0432eb2e412df5bf82598f01bb82e113e1d60a86eb9a2759e1baea7b056b048ee0efc781a7e8f8271e99215a9d18956cab6192
-  data.tar.gz: 539aeb9bc39b75c79c59b5bbecaf655ecec289418b233b8b8d5b20ff40f5ba3657e1dea0169588e7a82ee60c402dcd1c0359a1a1b4f5e8b3d3245659f413bb5c
+  metadata.gz: 50de96d91e8ea672376e1df8b3631077aa526837e1615a9abdf2f430572ac0e26a6afcacbfabd37e22734f3228eb613a3fa3b9058b2ed1904d31998d01475005
+  data.tar.gz: 35fa93d19f6b80ce215a594231c8386ed9fcb088eb70a75ad6f8c820d698a4ef9e228685d7b1c6f03faa938d7ee2995d3f5da202e0dbcf34cf8b6185ad5c25ed

data/NEWS.md

@@ -1,5 +1,9 @@
 # nanoc-external news
 
+## 1.0.2 (2017-12-03)
+
+* Dropped support for Ruby 2.2 and older
+
 ## 1.0.1
 
 * Added support for Nanoc 4

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](http://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,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Nanoc::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
-
     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)
+      cmd   = params.fetch(:exec)
       opts  = params.fetch(:options, [])
 
-      if cmd.nil?
-        raise Nanoc::Errors::GenericTrivial.new("nanoc-external: missing :exec argument")
-      end
-
-      cmd_with_opts = [ cmd ] + opts
-      odebug(cmd_with_opts.join(' ')) if debug
+      cmd_with_opts = [cmd] + opts
       out = StringIO.new
-      piper = Nanoc::Extra::Piper.new(:stdout => out, :stderr => $stderr)
+      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.1'
-
+    VERSION = '1.0.2'
   end
 end

metadata

@@ -1,87 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-external
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
-- Lifepillar
+- Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
+        version: '4.8'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '4.8'
 description: Provides an :external filter for nanoc
-email: github@lifepillar.org
+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-1.0.0.gem
-- nanoc-external.gemspec
-- test/filters/test_external.rb
-- test/helper.rb
 homepage: http://nanoc.ws/
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--main"
-- README.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -89,9 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 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,65 +0,0 @@
-GIT
-  remote: git://github.com/nanoc/nanoc.git
-  revision: bf13d9cc634faba39ceeaaa87b9ad6a9b2d45830
-  specs:
-    nanoc (4.0.0rc3)
-      cri (~> 2.3)
-
-PATH
-  remote: .
-  specs:
-    nanoc-external (1.0.1)
-      nanoc (>= 3.6.7, < 4.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    colored (1.2)
-    coveralls (0.8.3)
-      json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-    cri (2.7.0)
-      colored (~> 1.2)
-    docile (1.1.5)
-    domain_name (0.5.25)
-      unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    json (1.8.3)
-    mime-types (2.6.2)
-    minitest (5.8.2)
-    netrc (0.11.0)
-    rake (10.4.2)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    term-ansicolor (1.3.2)
-      tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.6.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.5)
-  coveralls
-  minitest
-  nanoc!
-  nanoc-external!
-  rake
-
-BUNDLED WITH
-   1.10.6

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', '< 5.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'