drumknott 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9339ecbc7b7de3bd690f0dea5bbe9d8121c16356
-  data.tar.gz: 0c960ae61a94806b72be20e57a73a95b9e820f7b
+SHA256:
+  metadata.gz: 975e98965c58ecfe46625a7c4f3a4fd95db412264699ecff9d2265a113ff78f5
+  data.tar.gz: d0a93ee4dca7922870640460d9432745eb045dbcd4deb209aedf1942a630dfbe
 SHA512:
-  metadata.gz: 1e275414f772076a8c6fb694992fd87ab9f01768175ab30eb078d4ca44f1246effb1e063eb187a6e86eae0bf7c1c06caed9e1636beaae53b96c8726f4369ee61
-  data.tar.gz: 1b44931fc983e83dcb0ce25220ea7d79022a1cff341b42a0e3284711dfd24ad0157c90d506b16773cfc9a014e87b7c57de292368d4c9d016094f5a2ade068df5
+  metadata.gz: 6d3414215d62b5f12a9a0d1add3a9a7d50a1d5d237f24d3a626ab3bc88738f4f1854af4dd8a1b9424d51dc33bf93c92003dedaf4d525010577dd88dc528e0e62
+  data.tar.gz: ed4477254c76c42ae3afc35bfb0dbdd623de4ce471308e44c28d8f50bb63e3c2caab6c413b324cc5692554f25bc7ce09136096957bb96cdd3f029585235de1c1

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rubocop-*-yml

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from:
+  - https://gist.githubusercontent.com/pat/ba3b8ffb1901bfe5439b460943b6b019/raw/.rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 rvm:
-  - 2.2.2
-script: bundle exec rspec
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+script: bundle exec rake
 sudo: false

data/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -35,5 +35,4 @@ Firstly, please note the Code of Conduct for all contributions to this project.
 
 ## Licence
 
-Copyright (c) 2016, Drumknott is developed and maintained by Pat Allan, and is
-released under the open MIT Licence.
+Copyright (c) 2016-2020, Drumknott is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/Rakefile

@@ -1 +1,11 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+Rake::Task["default"].clear if Rake::Task.task_defined?("default")
+task :default => %i[ rubocop spec ]

data/bin/console

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "drumknott"

data/bin/setup

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #!/bin/bash
 set -euo pipefail
 IFS=$'\n\t'

data/drumknott.gemspec

@@ -1,24 +1,30 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 Gem::Specification.new do |spec|
   spec.name          = "drumknott"
-  spec.version       = "0.3.0"
+  spec.version       = "0.4.0"
   spec.authors       = ["Pat Allan"]
   spec.email         = ["pat@freelancing-gods.com"]
 
-  spec.summary       = %q{Jekyll content uploader for Drumknott's search service.}
-  spec.description   = %q{Takes each of your compiled Jekyll pages and uploads them to Drumknott.}
+  spec.summary       = "Jekyll content uploader for Drumknott's search service."
+  spec.description   = "Takes each of your compiled Jekyll pages and uploads " \
+    "them to Drumknott."
   spec.homepage      = "https://github.com/pat/drumknott"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'faraday'
-  spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'jekyll', '>= 3.0'
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "jekyll", ">= 3.0"
+  spec.add_runtime_dependency "json"
 
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop", "~> 0.79.0"
+  spec.add_development_dependency "webmock"
 end

data/exe/drumknott

@@ -1,6 +1,8 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
 # -*- mode: ruby -*-
 
-require 'drumknott'
+require "drumknott"
 
 Drumknott::CLI.call ARGV[0], ARGV[1..-1]

data/lib/drumknott.rb

@@ -1,13 +1,14 @@
-require 'faraday'
-require 'json'
-require 'jekyll'
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "jekyll"
 
 module Drumknott
-  #
 end
 
-require 'drumknott/cli'
-require 'drumknott/include_pages'
-require 'drumknott/keys'
-require 'drumknott/outputs'
-require 'drumknott/refresh'
+require "drumknott/cli"
+require "drumknott/include_pages"
+require "drumknott/keys"
+require "drumknott/outputs"
+require "drumknott/refresh"

data/lib/drumknott/cli.rb

@@ -1,24 +1,8 @@
-class Drumknott::CLI
-  EMPTY_CACHE = {}.freeze
-
-  def self.call(command, arguments = [], name = nil, key = nil, include_pages = nil)
-    new(command, arguments, name, key, include_pages).call
-  end
-
-  def initialize(command, arguments = [], name = nil, key = nil, include_pages = nil)
-    @command, @arguments, @name, @key, @include_pages =
-      command, arguments, name, key, include_pages
-  end
+# frozen_string_literal: true
 
-  def call
-    case command
-    when 'refresh'
-      Drumknott::Refresh.call name, key, include_pages?
-    when 'keys'
-      Drumknott::Keys.call arguments
-    else
-      puts "Unknown command #{command}." unless command == 'help'
-      puts <<-MESSAGE
+class Drumknott::CLI
+  EMPTY_CACHE  = {}.freeze
+  HELP_MESSAGE = <<-MESSAGE
 Commands are:
   refresh: Update your site's content on Drumknott.
   keys:    Create local file with your Drumknott credentials.
@@ -28,12 +12,38 @@ Example Usage:
   $ drumknott refresh
   $ drumknott keys my-site-name my-site-key
 
-Credentials for Drumknott are expected via environment variables, or via a
-.drumknott file created using the `keys` command.
+Credentials for Drumknott are expected via environment variables, or
+via a .drumknott file created using the `keys` command.
 
   DRUMKNOTT_NAME: Your site name, as registered with Drumknott.
   DRUMKNOTT_KEY:  Your API key, as provided by Drumknott.
-      MESSAGE
+  MESSAGE
+
+  def self.call(
+    command, arguments = [], name = nil, key = nil, include_pages = nil
+  )
+    new(command, arguments, name, key, include_pages).call
+  end
+
+  def initialize(
+    command, arguments = [], name = nil, key = nil, include_pages = nil
+  )
+    @command       = command
+    @arguments     = arguments
+    @name          = name
+    @key           = key
+    @include_pages = include_pages
+  end
+
+  def call
+    case command
+    when "refresh"
+      Drumknott::Refresh.call name, key, include_pages?
+    when "keys"
+      Drumknott::Keys.call arguments
+    else
+      puts "Unknown command #{command}." unless command == "help"
+      puts HELP_MESSAGE
     end
   end
 
@@ -42,23 +52,23 @@ Credentials for Drumknott are expected via environment variables, or via a
   attr_reader :command, :arguments
 
   def cache
-    return EMPTY_CACHE unless File.exists? '.drumknott'
+    return EMPTY_CACHE unless File.exist? ".drumknott"
 
-    @cache ||= JSON.parse File.read('.drumknott')
+    @cache ||= JSON.parse File.read(".drumknott")
   end
 
   def name
-    @name || cache['name'] || ENV['DRUMKNOTT_NAME']
+    @name || cache["name"] || ENV["DRUMKNOTT_NAME"]
   end
 
   def key
-    @key || cache['key'] || ENV['DRUMKNOTT_KEY']
+    @key || cache["key"] || ENV["DRUMKNOTT_KEY"]
   end
 
   def include_pages?
     return @include_pages unless @include_pages.nil?
-    return cache['pages'] unless cache['pages'].nil?
+    return cache["pages"] unless cache["pages"].nil?
 
-    Drumknott::IncludePages.call ENV['DRUMKNOTT_PAGES']
+    Drumknott::IncludePages.call ENV["DRUMKNOTT_PAGES"]
   end
 end

data/lib/drumknott/include_pages.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Drumknott::IncludePages
-  TRUE_OPTIONS = ['true', 'yes', 'y'].freeze
+  TRUE_OPTIONS = %w[ true yes y ].freeze
 
   def self.call(value)
     case value

data/lib/drumknott/keys.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class Drumknott::Keys
   def self.call(arguments)
     new(arguments).call
   end
 
   def initialize(arguments)
-    @name, @key, @pages, ignored = *arguments
+    @name, @key, @pages, _ignored = *arguments
   end
 
   def call
-    File.write '.drumknott', JSON.generate(
-      'name'  => name,
-      'key'   => key,
-      'pages' => Drumknott::IncludePages.call(pages)
+    File.write ".drumknott", JSON.generate(
+      "name"  => name,
+      "key"   => key,
+      "pages" => Drumknott::IncludePages.call(pages)
     )
   end
 

data/lib/drumknott/outputs.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Drumknott::Outputs
-  #
 end
 
-require 'drumknott/outputs/silent'
-require 'drumknott/outputs/progress_bar'
+require "drumknott/outputs/silent"
+require "drumknott/outputs/progress_bar"

data/lib/drumknott/outputs/progress_bar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Drumknott::Outputs::ProgressBar < Drumknott::Outputs::Silent
   def call(label, collection)
     bar = ::ProgressBar.create :title => label, :total => collection.length

data/lib/drumknott/outputs/silent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Drumknott::Outputs::Silent
   def self.call(&block)
     new(&block).call
@@ -7,7 +9,7 @@ class Drumknott::Outputs::Silent
     @block = block
   end
 
-  def call(label, collection)
+  def call(_label, collection)
     collection.each { |item| block.call item }
   end
 

data/lib/drumknott/refresh.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 class Drumknott::Refresh
-  URL = 'https://drumknottsearch.com'
+  URL = "https://drumknottsearch.com"
 
   def self.call(name, key, include_pages = true)
     new(name, key, include_pages).call
   end
 
   def initialize(name, key, include_pages)
-    @name, @key, @include_pages = name, key, include_pages
+    @name          = name
+    @key           = key
+    @include_pages = include_pages
   end
 
   def call
@@ -23,7 +27,7 @@ class Drumknott::Refresh
   def clear
     connection.post do |request|
       request.url "/api/v1/#{name}/pages/clear"
-      request.headers['AUTHENTICATION'] = key
+      request.headers["AUTHENTICATION"] = key
     end
   end
 
@@ -43,37 +47,46 @@ class Drumknott::Refresh
   end
 
   def output_class
-    return Drumknott::Outputs::Silent if ENV['DRUMKNOTT_SILENT']
+    return Drumknott::Outputs::Silent if ENV["DRUMKNOTT_SILENT"]
 
-    require 'ruby-progressbar'
+    require "ruby-progressbar"
     Drumknott::Outputs::ProgressBar
   rescue LoadError
     Drumknott::Outputs::Silent
   end
 
+  def page_json_for(document)
+    JSON.generate(
+      :page => {
+        :name    => document.data["title"],
+        :path    => document.url,
+        :content => document.output
+      }
+    )
+  end
+
   def site
     @site ||= Jekyll::Site.new Jekyll.configuration
   end
 
   def update
     output.call "Posts", site.posts.docs
-    output.call "Pages", site.pages if include_pages?
+    return unless include_pages?
+
+    output.call(
+      "Pages",
+      site.pages.select { |page| page.html? || page.url.end_with?("/") }
+    )
   end
 
   def update_document(document)
     connection.put do |request|
       request.url "/api/v1/#{name}/pages"
 
-      request.headers['AUTHENTICATION'] = key
-      request.headers['Content-Type']   = 'application/json'
+      request.headers["AUTHENTICATION"] = key
+      request.headers["Content-Type"]   = "application/json"
 
-      request.body = JSON.generate({
-        :page => {
-          :name    => document.data['title'],
-          :path    => document.url,
-          :content => document.output
-        }
-      })
+      request.body = page_json_for document
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drumknott
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -126,10 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll content uploader for Drumknott's search service.
 test_files: []
-has_rdoc: