paperwork 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f63892db3d3c30b601943f7c6a0929b92079d3dab71696a7b2426ef7ce7d3a
-  data.tar.gz: 2b70456d7d56e4674df35e4a1864483c75d64087519ea3643b131369aea3ed83
+  metadata.gz: acec360949d7b7403f5b7d6985a6cca4289d03c19cf13f7c12a5db5d468072ea
+  data.tar.gz: d6cdb1bd4f9cbb211d2663c62b1ccd461c15a7c8d7a84f9afad049c31a8c2dd4
 SHA512:
-  metadata.gz: a4f75a8c77f49ba6c00125cdd4176505bb43c85cf127278a033c479bc6d7a5ba22f4fecae0561b2ca4da0572aa5f014ce3e7a205b70a72aa1c59e6368ff81748
-  data.tar.gz: c3efec0580ccd1a16ac3fb11caf587537d7fb3c57c9b3006a16d0c77d302313ed2dea8dbe3ec1385b5aef8ed706b36493f8ac30cdd8e7730d1ab115d3717190d
+  metadata.gz: e6a1b14be156b22c42345512735e242a58b1b4ea38354e9b0550c1cab88d4c52d3a8b3efacbefbbe010f983fdaaf7536351efb394390604db58566086c085d98
+  data.tar.gz: 3b781ef6f0ce74100687d61e04a425a6477629f1ad1cf65f2f476a80629eddef4a32cbed834d5ef0012addd5f1dcc1dd0652aafeda8280f2e281aac6ecd958dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paperwork (0.3.0)
+    paperwork (0.3.1)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
       thor (~> 1.1.0)

data/lib/paperwork/cli.rb

@@ -1,8 +1,16 @@
-require "yaml"
-require "thor"
-require "paperwork"
+# frozen_string_literal: true
 
+##
+# globla namespace for paperwork
+#
 module Paperwork
+    require "yaml"
+    require "thor"
+    require "paperwork"
+
+    ##
+    # command line interface for paperwork
+    #
     class CLI < Thor
         attr_accessor :config
 
@@ -11,13 +19,22 @@ module Paperwork
         class_option :verbose, aliases: "-v", desc: "be verbose about the build", type: :boolean, default: false
 
         desc    "build",
-                "creates documentation as defined in #{CONFIG_FILE} and writes it to '#{Paperwork::Config[:build_root]}/<name>/build'"
+                <<~DESC
+                    creates documentation as defined in
+                    #{CONFIG_FILE} and writes it to
+                    '#{Paperwork::Config[:build_root]}/<name>/build'
+                DESC
         def build
             build_internal "build"
         end
 
         desc    "rebuild",
-                "removes previous builds and creates documentation as defined in #{CONFIG_FILE} and writes it to '#{Paperwork::Config[:build_root]}/<name>/build'"
+                <<~DESC
+                    removes previous builds and creates
+                    documentation as defined in
+                    #{CONFIG_FILE} and writes it to
+                    '#{Paperwork::Config[:build_root]}/<name>/build'
+                DESC
         def rebuild
             build_internal "rebuild"
         end
@@ -29,33 +46,38 @@ module Paperwork
         end
 
         protected
-            def build_internal(task)
-                setup_config
-                setup_tasks
-                invoke_tasks task
-            end
 
-            def setup_config
+        def build_internal(task)
+            setup_config
+            setup_tasks
+            invoke_tasks task
+        end
+
+        def setup_config
+            unless File.exist?(CONFIG_FILE)
                 raise Exception.new(
                     "#{CONFIG_FILE} not found. You need to create a configuration file first."
-                ) unless File.exist?(CONFIG_FILE)
+                )
+            end
 
-                yaml = YAML.load_file(CONFIG_FILE)
-                self.config = yaml["config"]
-                self.config["sources"] << CONFIG_FILE
+            yaml = YAML.load_file(CONFIG_FILE)
+            self.config = yaml["config"]
+            self.config["sources"] << CONFIG_FILE
 
-                raise Exception.new(
-                    "No 'config' found in #{CONFIG_FILE}. You need to describe the build setup in a 'config' section first."
-                ) if self.config.nil?
-            end
+            return unless self.config.nil?
 
-            def setup_tasks
-                paperwork self.config["name"], sources: self.config["sources"]
-            end
+            raise Exception.new(
+                "No 'config' found in #{CONFIG_FILE}. You need to describe the build setup in a 'config' section first."
+            )
+        end
 
-            def invoke_tasks(target)
-                Rake::Task["paperwork:#{self.config["name"]}:set_verbose"].invoke if options[:verbose]
-                Rake::Task["paperwork:#{self.config["name"]}:#{target}"].invoke
-            end
+        def setup_tasks
+            paperwork self.config["name"], sources: self.config["sources"]
+        end
+
+        def invoke_tasks(target)
+            Rake::Task["paperwork:#{self.config["name"]}:set_verbose"].invoke if options[:verbose]
+            Rake::Task["paperwork:#{self.config["name"]}:#{target}"].invoke
+        end
     end
 end

data/lib/paperwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperwork
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperwork
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tobias Schmid
@@ -126,9 +126,7 @@ description:
 email:
 - couchbelag@gmail.com
 executables:
-- console
 - paperwork
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -142,9 +140,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
 - bin/paperwork
-- bin/setup
 - custom.css
 - custom.js
 - lib/paperwork.rb

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "paperwork"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here