middleman-robots 1.3.2 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c7fe8c7c18e4b99c7a53f13c46b307bbaa9ba9c2
-  data.tar.gz: 10db367365abdc793d320d016a813e38b0138374
+SHA256:
+  metadata.gz: 525009b32d148d32e07a4373e7532a46126e2b271ffef6221ad4d750d5a9b4a9
+  data.tar.gz: 45366b77e1e3ca26d889d4cead667c3826387063c48a5ae97dd12cde7f470d79
 SHA512:
-  metadata.gz: 9abfe16e709d8011b319419a88cd4a269fa41c7dfd7818cc944abc1f212913ce83d2764a40719718da3d39309c70aac7502672e3b2e381aa72c99498c4c0a9fc
-  data.tar.gz: cb625f0c79cc12a438c10f3b8030bcb4effe242c39eb1e45f092d41c364f314ee5c0d85611a42dbd9efc1591a1989cee4f4876c7943cc6a22d29435d9443a1da
+  metadata.gz: a9826c1a46025521f1fb884a8c17581e9d3aa9b3226fe2e37487ba1b33fd70c978c52a9b0d05164ee288e4d3d2c30597671c4c0a6809be94c72cea5f9821c31b
+  data.tar.gz: f152418cb899e8874ef4fbe52a79b785bb3cb9c3b7d08adb37c444f035f2e8c87319a977aa0e095b0b4683d909da6d9031fc1a46835c4c9601f49930634089d3

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+on: [push]
+name: CI
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby-version: [2.6, 2.7, 3.0]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - run: bundle exec rake test
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - run: bundle exec rubocop

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'pkg/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - '*.gemspec'
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - 'lib/middleman-robots.rb'

data/.travis.yml

@@ -5,18 +5,17 @@ before_script:
   - bundle update
 rvm:
   - ruby-head
-  - 2.4.0
-  - 2.3.1
-  - 2.2.4
+  - 2.6.4
+  - 2.5.6
+  - 2.4.7
 os:
-- linux
+  - linux
 matrix:
   fast_finish: true
   allow_failures:
-    - rvm: jruby-head
-script: bundle exec rake test
+    - rvm: ruby-head
+script:
+  - bundle exec rubocop
+  - bundle exec rake test
 cache: bundler
 env: TEST=true
-notifications:
-  slack:
-    secure: C8xb94J4fstzAI7t9GcvKQieKc1k+ECA96ydcxDwBI1fAbupQjz4jafMwnOnD1g9QMe8hlykSNUlCXNCbcA9DZG7COjPZHCY3Icv1+0Dp44bBTDQldR8DPACPMU5Qe+pWoTZViPgJQ7tq2V9TXrGdOnOtkPTwZ9KtZrmNhxW7tM=

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in middleman-robots.gemspec

data/README.md

@@ -1,9 +1,9 @@
 # Middleman::Robots
 
 [![Gem Version](https://badge.fury.io/rb/middleman-robots.svg)](http://badge.fury.io/rb/middleman-robots)
-[![Build Status](https://travis-ci.org/yterajima/middleman-robots.svg?branch=master)](https://travis-ci.org/yterajima/middleman-robots)
+[![GitHub Actions CI](https://github.com/yterajima/middleman-robots/actions/workflows/ci.yml/badge.svg)](https://github.com/yterajima/middleman-robots/actions/workflows/ci.yml)
 
-`middleman-robots` is an extension of [Middleman](http://middlemanapp.com/). This can create `robots.txt`.
+`middleman-robots` is an extension of [Middleman](https://middlemanapp.com/). This can create `robots.txt`.
 
 This plugin support Middleman v3-stable and v4.
 
@@ -26,10 +26,10 @@ Or install it yourself as:
 ```ruby
 # config.rb
 activate :robots, 
-  :rules => [
-    {:user_agent => '*', :allow => %w(/)}
+  rules: [
+    { user_agent: '*', allow: %w[/] }
   ],
-  :sitemap => "http://example.com/sitemap.xml"
+  sitemap: 'https://example.com/sitemap.xml'
 ```
 
 Created `robots.txt`:
@@ -38,28 +38,28 @@ Created `robots.txt`:
 User-Agent: *
 Allow: /
 
-Sitemap: http://example.com/sitemap.xml
+Sitemap: https://example.com/sitemap.xml
 
 ```
 
-You can use options, `:rules` [{`:user_agent`(string), `:allow`(array), `:disallow`(array)}] and `:sitemap`. Like this:
+You can use options, `rules` [ {`user_agent`(string), `allow`(array), `disallow`(array)}] and `sitemap`. Like this:
 
 ```ruby
 # config.rb
 activate :robots,
-  :rules => [
+  rules: [
     {
-      :user_agent => 'Googlebot',
-      :disallow =>  %w(tmp/ /something/dir/file_disallow.html),
-      :allow =>  %w(allow/ /something/dir/file_allow.html)
+      user_agent: 'Googlebot',
+      disallow: %w[tmp/ /something/dir/file_disallow.html],
+      allow: %w[allow/ /something/dir/file_allow.html]
     },
     {
-      :user_agent => 'Googlebot-Image',
-      :disallow =>  %w(tmp/ /something/dir/file_disallow.html),
-      :allow =>  %w(allow/ /something/dir/file_allow.html)
+      user_agent: 'Googlebot-Image',
+      disallow: %w[tmp/ /something/dir/file_disallow.html],
+      allow: %w[allow/ /something/dir/file_allow.html]
     }
   ],
-  :sitemap => "http://example.com/sitemap.xml"
+  sitemap: 'https://example.com/sitemap.xml'
 ```
 
 Created `robots.txt`:
@@ -77,7 +77,7 @@ Disallow: /something/dir/file_disallow.html
 Allow: /allow/
 Allow: /something/dir/file_allow.html
 
-Sitemap: http://example.com/sitemap.xml
+Sitemap: https://example.com/sitemap.xml
 
 ```
 

data/Rakefile

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 task default: :test
 
 desc 'test command'
 task :test do
-  Dir.glob('tests/test_*.rb') do |f|
-    sh "bundle exec ruby #{f}"
-  end
+  sh 'bundle exec rspec spec/'
   sh 'bundle exec cucumber features/'
 end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/features/build.feature

@@ -9,7 +9,6 @@ Feature: Middleman-Robots on build
     And a successfully built app at "basic-app"
     When I cd to "build"
     Then a file named "robots.txt" should exist
-    And the output should contain "== middleman-robots: robots.txt added to resources =="
     And the file "robots.txt" should contain exactly:
       """
       """
@@ -18,9 +17,7 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
-        {:user_agent => '*'}
-      ]
+      activate :robots, rules: [ { user_agent: '*'} ]
       """
     And a successfully built app at "basic-app"
     When I cd to "build"
@@ -34,9 +31,7 @@ Feature: Middleman-Robots on build
     And a file named "config.rb" with:
       """
       activate :robots do |r|
-        r.rules = [
-          {:user_agent => '*'}
-        ]
+        r.rules = [ { user_agent: '*'} ]
       end
       """
     And a successfully built app at "basic-app"
@@ -50,9 +45,7 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
-        {:user_agent => '*'}
-      ]
+      activate :robots, rules: [ { user_agent: '*'} ]
       """
     And a successfully built app at "basic-app"
     When I cd to "build"
@@ -65,9 +58,7 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
-        {'user-agent' => '*'}
-      ]
+      activate :robots, rules: [ { 'user-agent': '*' } ]
       """
     And a successfully built app at "basic-app"
     When I cd to "build"
@@ -80,10 +71,10 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
+      activate :robots, rules: [
         {
-          :user_agent => '*',
-          :disallow =>  %w(tmp/* /something/dir/file_disallow.html)
+          user_agent: '*',
+          disallow:  %w[tmp/* /something/dir/file_disallow.html]
         }
       ]
       """
@@ -100,10 +91,10 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
+      activate :robots, rules: [
         {
-          :user_agent => '*',
-          :allow =>  %w(allow/* /something/dir/file_allow.html)
+          user_agent: '*',
+          allow: %w[allow/* /something/dir/file_allow.html]
         }
       ]
       """
@@ -120,11 +111,11 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
+      activate :robots, rules: [
         {
-          :user_agent => '*',
-          :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-          :allow =>  %w(allow/* /something/dir/file_allow.html)
+          user_agent: '*',
+          disallow: %w[tmp/* /something/dir/file_disallow.html],
+          allow: %w[allow/* /something/dir/file_allow.html]
         }
       ]
       """
@@ -143,16 +134,16 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :rules => [
+      activate :robots, rules: [
         {
-          :user_agent => 'Googlebot',
-          :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-          :allow =>  %w(allow/* /something/dir/file_allow.html)
+          user_agent: 'Googlebot',
+          disallow: %w[tmp/* /something/dir/file_disallow.html],
+          allow: %w[allow/* /something/dir/file_allow.html]
         },
         {
-          :user_agent => 'Googlebot-Image',
-          :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-          :allow =>  %w(allow/* /something/dir/file_allow.html)
+          user_agent: 'Googlebot-Image',
+          disallow: %w[tmp/* /something/dir/file_disallow.html],
+          allow: %w[allow/* /something/dir/file_allow.html]
         }
       ]
       """
@@ -177,7 +168,7 @@ Feature: Middleman-Robots on build
     Given a fixture app "basic-app"
     And a file named "config.rb" with:
       """
-      activate :robots, :sitemap => "http://example.com/sitemap.xml"
+      activate :robots, sitemap: 'http://example.com/sitemap.xml'
       """
     And a successfully built app at "basic-app"
     When I cd to "build"
@@ -191,19 +182,19 @@ Feature: Middleman-Robots on build
     And a file named "config.rb" with:
       """
       activate :robots,
-        :rules => [
+        rules: [
           {
-            :user_agent => 'Googlebot',
-            :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-            :allow =>  %w(allow/* /something/dir/file_allow.html)
+            user_agent:'Googlebot',
+            disallow: %w[tmp/* /something/dir/file_disallow.html],
+            allow: %w[allow/* /something/dir/file_allow.html]
           },
           {
-            :user_agent => 'Googlebot-Image',
-            :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-            :allow =>  %w(allow/* /something/dir/file_allow.html)
+            user_agent:'Googlebot-Image',
+            disallow: %w[tmp/* /something/dir/file_disallow.html],
+            allow: %w[allow/* /something/dir/file_allow.html]
           }
         ],
-        :sitemap => "http://example.com/sitemap.xml"
+        sitemap: 'http://example.com/sitemap.xml'
       """
     And a successfully built app at "basic-app"
     When I cd to "build"

data/features/support/env.rb

@@ -1,5 +1,6 @@
-PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+# frozen_string_literal: true
+
+PROJECT_ROOT_PATH = File.expand_path('../../', __dir__)
 require 'middleman-core'
 require 'middleman-core/step_definitions'
 require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-robots')
-

data/fixtures/server-app/config.rb

@@ -1,14 +1,28 @@
-activate :robots,
-  :rules => [
-    {
-      :user_agent => 'Googlebot',
-      :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-      :allow =>  %w(allow/* /something/dir/file_allow.html)
-    },
-    {
-      :user_agent => 'Googlebot-Image',
-      :disallow =>  %w(tmp/* /something/dir/file_disallow.html),
-      :allow =>  %w(allow/* /something/dir/file_allow.html)
-    }
-  ],
-  :sitemap => "http://example.com/sitemap.xml"
+# frozen_string_literal: true
+
+rules = [
+  {
+    user_agent: 'Googlebot',
+    disallow: %w[
+      tmp/*
+      /something/dir/file_disallow.html
+    ],
+    allow: %w[
+      allow/*
+      /something/dir/file_allow.html
+    ]
+  },
+  {
+    user_agent: 'Googlebot-Image',
+    disallow: %w[
+      tmp/*
+      /something/dir/file_disallow.html
+    ],
+    allow: %w[
+      allow/*
+      /something/dir/file_allow.html
+    ]
+  }
+]
+
+activate :robots, rules: rules, sitemap: 'http://example.com/sitemap.xml'

data/lib/middleman-robots.rb

@@ -1,5 +1,7 @@
-require "middleman-core"
-require "middleman-robots/version"
+# frozen_string_literal: true
+
+require 'middleman-core'
+require 'middleman-robots/version'
 
 ::Middleman::Extensions.register(:robots) do
   require 'middleman-robots/extension'

data/lib/middleman-robots/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-robots/generator'
 require 'tempfile'
 
@@ -9,19 +11,22 @@ module Middleman
       option :sitemap, false, 'URI of sitemap.xml'
 
       def manipulate_resource_list(resources)
-        tmp_path = File.expand_path('../../../tmp/robots/robots.txt', __FILE__)
-        File.open(tmp_path, 'w+') do |f|
-          f.puts(Generator.new(options.rules, options.sitemap).process)
-        end
-
-        robots = Middleman::Sitemap::Resource.new(
+        write_robots(options)
+        resources << Middleman::Sitemap::Resource.new(
           app.sitemap,
           'robots.txt',
           tmp_path
         )
+      end
+
+      def write_robots(options)
+        File.open(tmp_path, 'w+') do |f|
+          f.puts(Generator.new(options.rules, options.sitemap).process)
+        end
+      end
 
-        logger.info '== middleman-robots: robots.txt added to resources =='
-        resources << robots
+      def tmp_path
+        File.expand_path('../../tmp/robots/robots.txt', __dir__)
       end
     end
   end