revealing 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1cfdf9b16a29d0442f9797da23283cf21e042d3bae193a43b971e63db6f1d48
-  data.tar.gz: 41dcd0c131559f49e4816434fb21009affb951b0d0c5fff8b3aae37e80e9d7bb
+  metadata.gz: a37bb931585056c7b87a37d847e4b144502d891142f6990929a91c094d33eda7
+  data.tar.gz: c91b10d0efa0f63a2d43ee788cdc3c4332ee9b81ad44e6d9ec758f9ea4f4af91
 SHA512:
-  metadata.gz: 02f68688cc9544651d6fc0a6216c04fda5a2a38f4ae9b65696dadb6bbfceff618b22513279279a50ac33c15f77505533a7cd32fc8cd1004dc97cd9869d121888
-  data.tar.gz: abac2135a5d8edfafa2dfd9c510bb57db148bb2197f128684d1c6bfd7b277f36dd451594e539cccd56fc43f1c1568abacf719c4e941705ed6fe61c927a776bb4
+  metadata.gz: b87b7e7786c552580c4557f7a103779316b1efb87e4469a491d3f1eee8c48d7ee46558072253c1a1fa5a6198f49d2761284d045f624e2cd0caa06c10ad076c5b
+  data.tar.gz: 8865d6dc64fa54bc6a9824c73be20bbb21d33bd6abc71d291664d6a600ce881de0311d3f4a368e1dd4d259102f6c1ef446abf686a222da86fbce17491d5298fc

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/*.rake'
+  Exclude:
+    - vendor/**/*
+    - db/migrations/**/*
+
+  DisplayCopNames:
+    Enabled: true
+
+  DisplayStyleGuide:
+    Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 180

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.2

data/.travis.yml

@@ -1,7 +1,17 @@
 ---
-sudo: false
+dist: xenial
 language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler
+cache:
+  - bundler
+ directories:
+   - /home/travis/.rvm/
+before_install:
+    - gem update --system
+    - gem install bundler
+addons:
+  apt:
+    update: true
+    packages:
+      - pandoc
+      - gpp
+      - graphicsmagick

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/Guardfile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { %w(spec/unit spec/system) }
+end
+
+group 'unit' do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/unit/.+_spec\.rb$})
+    watch(%r{^lib/.+/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  end
+end
+
+group 'system' do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/system/.+_spec\.rb$})
+    watch(%r{^lib/.+/(.+)\.rb$}) { |m| "spec/system/#{m[1]}_spec.rb" }
+  end
+end

data/README.markdown

@@ -4,9 +4,14 @@
 
 This gem provides a set of [`Rake`](https://github.com/ruby/rake) tasks to create [`reveal.js`](https://revealjs.com) presentations from markdown files. It uses [`pandoc`](https://pandoc.org/) to create the final presentation. The output is a self-contained set of static HTML files that can be viewed locally uploaded to a web server.
 
+Unique features:
+
+1. `revealing` assumes that your presentation is built using `Rake`. Additional, custom steps (like deployment) can easily be added to the Rakefile that was generated for you.
+1. Efficiency - by carefully modeling the dependencies between source files (your markdown), intermediate build products (processed include statements), and the final output (HTML and resized images), build steps are only run when necessary (e.g. when a corresponding source file was changed).
+
 # Examples
 
-* [Zero to CF in Kube-Cluster in 30 Seconds with Concourse, Helm, Fissile and Eirini](http://zero2cfin30s.eirini.cf/) (source: [suhlig/zero-to-cf-in-30-seconds](https://github.com/suhlig/zero-to-cf-in-30-seconds))
+* [Zero to CF in Kube-Cluster in 30 Seconds with Concourse, Helm, Fissile and Eirini](http://zero2cfin30s.eirini.cf/) (source: [suhlig/zero-to-cf-in-30-seconds](https://github.com/suhlig/zero-to-cf-in-30-seconds)) is built using `revealing` and published on IBM Cloud using a GitHub action after each `git push`.
 
 # Development
 
@@ -32,11 +37,13 @@ This gem provides a set of [`Rake`](https://github.com/ruby/rake) tasks to creat
 
 # TODO
 
-1. `revealing doctor` to analyze tools
-1. Rubocop
-1. Read desired dependencies (URLs or version numbers) from ENV vars or a YAML file (with sensible defaults coming from this project)
-1. Re-add ditaa processing
 1. Add mathjax (copy to target if present, otherwise use CDN)
+1. Read desired dependencies (URLs or version numbers) from ENV vars or a YAML file (with sensible defaults coming from this project)
+1. Re-add ditaa processing, or replace with [mermaid-filter](https://github.com/raghur/mermaid-filter)
+
+Milestone: 1.1
+
+1. Charts using [vega-lite](https://vega.github.io/vega-lite/usage/embed.html)
 1. Add guard-livereload to the generated project
 1. Expose customization of
    * highlight-style

data/Rakefile

@@ -2,7 +2,21 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: 'spec'
+namespace :spec do
+  desc 'Run CI tests'
+  task ci: %i[rubocop unit system]
+
+  %w[unit system].each do |type|
+    desc "Run #{type} tests"
+    RSpec::Core::RakeTask.new(type) do |t|
+      t.pattern = "spec/#{type}/**/*_spec.rb"
+    end
+  end
+end
+
+task default: 'spec:ci'

data/lib/revealing/cli.rb

@@ -1,12 +1,31 @@
 require 'thor'
 require 'pathname'
+require_relative 'prerequisite'
 
 module Revealing
+  PREREQUISITES = [
+    Prerequisite.new('curl'),
+    Prerequisite.new('gm', 'graphicsmagick'),
+    Prerequisite.new('gpp'),
+    Prerequisite.new('pandoc'),
+  ]
+
   class CLI < Thor
     def self.exit_on_failure?
       true
     end
 
+    desc 'doctor', 'Checks whether your system is fit for revealing.'
+    def doctor
+      PREREQUISITES.each do |tool|
+        if tool.available?
+          puts "OK: #{tool} is available."
+        else
+          warn "Error: #{tool.command} is not available. Install it using `#{tool.install_hint}`."
+        end
+      end
+    end
+
     desc 'init [DIRECTORY]', 'initialize a new revealing project in DIRECTORY. Defaults to the current working directory.'
     def init(directory = '.')
       project_directory = Pathname(directory)

data/lib/revealing/prerequisite.rb

@@ -0,0 +1,63 @@
+require 'rubygems/platform'
+
+module Revealing
+  class Prerequisite
+    attr_reader :command
+    alias :to_s :command
+
+    def initialize(command, details = nil)
+      @command = command
+
+      case details
+      when NilClass
+        @package_info = same_as_command(command)
+      when String
+        @package_info = different_but_same_on_all_platforms(details)
+      when Hash
+        @package_info = different_for_each_platform(details)
+      when Proc
+        @package_info = callable(details)
+      else
+        raise "Don't know how to interpret '#{package_info.inspect}' as package info."
+      end
+    end
+
+    def available?
+      system("sh -c 'command -v #{command} > /dev/null'")
+    end
+
+    def install_hint
+      @package_info[Gem::Platform.local.os.to_sym]
+    end
+
+    private
+
+    def same_as_command(command)
+      {
+        darwin: "brew install #{command}",
+        linux: "apt install #{command}",
+      }
+    end
+
+    def different_but_same_on_all_platforms(details)
+      {
+        darwin: "brew install #{details}",
+        linux: "apt install #{details}",
+      }
+    end
+
+    def different_for_each_platform(details)
+      {
+        darwin: "brew install #{details[:darwin]}",
+        linux: "apt install #{details[:linux]}",
+      }
+    end
+
+    def callable(details)
+      {
+        darwin: details.call(:darwin),
+        linux: details.call(:linux),
+      }
+    end
+  end
+end

data/lib/revealing/tasks/assets.rake

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
+
+def print_duplicates(list)
+  warn 'Error: The following assets have the same base name and would override another in the output:'
+  warn ''
+  warn list.join("\n")
+  warn ''
+  warn 'Consider renaming them to be unique.'
+end
+
 def refute_duplicate_basename(assets)
-  assets = assets.map{ |f| Pathname(f) }
-  basenames = assets.map{ |f| f.basename }
-
-  if basenames.length != basenames.uniq.length
-    # https://stackoverflow.com/a/8922931/3212907
-    duplicate_basenames = basenames.select{ |e| basenames.count(e) > 1 }.uniq
-    list = assets.select{ |a| duplicate_basenames.include?(a.basename) }
-    warn "Error: The following assets have the same base name and would override another in the output:"
-    warn ''
-    warn list.join("\n")
-    warn ''
-    warn "Consider renaming them to be unique."
-    fail
-  end
+  assets = assets.map { |f| Pathname(f) }
+  basenames = assets.map(&:basename)
+
+  return if basenames.length == basenames.uniq.length
+
+  # https://stackoverflow.com/a/8922931/3212907
+  duplicate_basenames = basenames.select { |e| basenames.count(e) > 1 }.uniq
+  list = assets.select { |a| duplicate_basenames.include?(a.basename) }
+  print_duplicates(list)
+  raise
 end
 
 refute_duplicate_basename(RESIZABLE_ASSETS)

data/lib/revealing/tasks/gpp.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 desc "Sources are pre-processed into the single #{GPP_FILE}"
 file GPP_FILE => [GPP_DIR, DIRTY_FILE] + SOURCE_FILES do |target|
   sh %(gpp -I src -x -o #{target} #{SOURCE_DIR}/index.markdown)

data/lib/revealing/tasks/reveal.js.rake

@@ -1,4 +1,6 @@
-REVEAL_JS_VERSION = '3.7.0'.freeze
+# frozen_string_literal: true
+
+REVEAL_JS_VERSION = '3.7.0'
 
 desc 'reveal.js is present'
 directory REVEAL_JS_TARGET_DIR => TARGET_DIR do |target|

data/lib/revealing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revealing
-  VERSION = '1.0.5'
+  VERSION = '1.0.7'
 end

data/revealing.gemspec

@@ -30,8 +30,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor'
 
   spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end
 # rubocop:enable Metrics/BlockLength

data/templates/init/Gemfile

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

data/templates/init/README.markdown

@@ -15,6 +15,7 @@ Do this once:
 1. Get Ruby if not already present
 1. `gem install bundler`
 1. `bundle install`
+1. Check that you have the required tools as reported by `revealing doctor`
 
 # Generate the Presentation
 

data/templates/init/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'revealing/tasks'
 
 task default: TARGET_FILE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revealing
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Steffen Uhlig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-bundler
+  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: guard-rspec
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +164,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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Provides a workflow for creating reveal.js
                            presentations. It uses pandoc to create the
@@ -135,12 +191,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - README.markdown
 - Rakefile
 - exe/revealing
 - lib/revealing/cli.rb
+- lib/revealing/prerequisite.rb
 - lib/revealing/tasks.rb
 - lib/revealing/tasks/assets.rake
 - lib/revealing/tasks/gpp.rake