clearbooks 0.16.3

data/lib/clearbooks/core_ext/hash.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+
+# @class        class Hash
+# @brief        Ruby Hash Object functions adding Savon and some other tweaks
+class Hash
+
+  # @fn         def except *keys {{{
+  # @brief      Deletes specified keys from hash copy and returns it
+  # @credit     https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/except.rb
+  def except(*keys)
+    copy = self.dup
+    keys.each { |key| copy.delete(key) }
+    copy
+  end # }}}
+
+  # @fn         def compact {{{
+  # @brief      Deletes keys with +nil+ values from hash copy and returns it
+  def compact
+    delete_if { |k, v| v.nil? }
+  end # }}}
+
+  # @fn         def savon key {{{
+  # @brief      Savon shortcut to get attributes via :key or :@key
+  def savon(key)
+    v = self[key] || self["@#{(key.to_s)}".to_sym]
+    if (v.is_a? Hash)
+      v.from_savon
+    else
+      v
+    end
+  end # }}}
+
+  # @fn         def from_savon {{{
+  # @brief      Translates ":@key" savon attribute keys to ":key"
+  def from_savon
+    self.reduce({}) do |hash, (k, v)|
+      k = k.to_s
+      k = k[1..-1] if k.start_with? '@'
+      hash[k.to_sym] = v
+      hash
+    end
+  end # }}}
+
+end
+
+

data/lib/clearbooks/core_ext/io_binary_read.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+
+# @class      class IO #:nodoc:
+#
+# @credit     https://github.com/erikhuda/thor/blob/master/lib/thor/core_ext/io_binary_read.rb
+class IO
+
+  class << self
+    def binread(file, *args)
+      fail ArgumentError, "wrong number of arguments (#{1 + args.size} for 1..3)" unless args.size < 3
+      File.open(file, "rb") do |f|
+        f.read(*args)
+      end
+    end unless method_defined? :binread
+  end
+
+end # of class IO
+
+# vim:ts=2:tw=100:wm=100

data/lib/clearbooks/core_ext/string.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+
+# @class        class String
+# @brief        Ruby core String handling
+class String
+
+  TRUE_VALUES = %W{1 t true on y yes}.freeze
+
+  # @fn         def to_b {{{
+  # @brief      Converts String to Boolean value
+  #
+  # @credit     https://github.com/prodis/wannabe_bool/blob/master/lib/wannabe_bool/object.rb
+  def to_b
+    TRUE_VALUES.include?(self.to_s.strip.downcase)
+  end # }}}
+
+end # of class String
+
+
+# vim:ts=2:tw=100:wm=100

data/lib/clearbooks/error.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+
+Dir[ "#{File.dirname(__FILE__)}/error/*.rb" ].sort.each do |path|
+  require_relative "error/#{File.basename( path, '.rb' )}"
+end
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/error/errors.rb

@@ -0,0 +1,228 @@
+#!/usr/bin/env ruby
+
+
+# @module         module Clearbooks
+# @brief          Clearbooks module namespace
+module Clearbooks
+
+
+  class ClearbooksError < StandardError
+
+    class << self
+      # @param [Integer] code
+      def status_code(code)
+        define_method(:status_code) { code }
+        define_singleton_method(:status_code) { code }
+      end
+    end
+
+    alias_method :message, :to_s
+  end # of class ClearbooksError
+
+  class DeprecatedError < ClearbooksError; status_code(10); end
+  class InternalError < ClearbooksError; status_code(99); end
+  class ArgumentError < InternalError; end
+  class AbstractFunction < InternalError; end
+
+  class ClearbooksfileNotFound < ClearbooksError
+    status_code(100)
+
+    # @param [#to_s] filepath
+    #   the path where a Clearbooksfile was not found
+    def initialize(filepath)
+      @filepath = File.dirname(File.expand_path(filepath)) rescue filepath
+    end
+
+    def to_s
+      "No Clearbooksfile or Clearbooksfile.lock found at '#{@filepath}'!"
+    end
+  end
+
+  class CookbookNotFound < ClearbooksError
+    status_code(103)
+
+    def initialize(name, version, location)
+      @name     = name
+      @version  = version
+      @location = location
+    end
+
+    def to_s
+      if @version
+        "Cookbook '#{@name}' (#{@version}) not found #{@location}!"
+      else
+        "Cookbook '#{@name}' not found #{@location}!"
+      end
+    end
+  end
+
+  class DuplicateDependencyDefined < ClearbooksError
+    status_code(105)
+
+    def initialize(name)
+      @name = name
+    end
+
+    def to_s
+      out  = "Your Clearbooksfile contains multiple entries named "
+      out << "'#{@name}'. Please remove duplicate dependencies, or put them in "
+      out << "different groups."
+      out
+    end
+  end
+
+  class NoSolutionError < ClearbooksError
+    status_code(106)
+
+    attr_reader :demands
+
+    # @param [Array<Dependency>] demands
+    def initialize(demands)
+      @demands = demands
+    end
+
+    def to_s
+      "Unable to find a solution for demands: #{demands.join(', ')}"
+    end
+  end
+
+  class ClearbooksfileReadError < ClearbooksError
+    status_code(113)
+
+    # @param [#status_code] original_error
+    def initialize(original_error)
+      @original_error  = original_error
+      @error_message   = original_error.to_s
+      @error_backtrace = original_error.backtrace
+    end
+
+    def status_code
+      @original_error.respond_to?(:status_code) ? @original_error.status_code : 113
+    end
+
+    alias_method :original_backtrace, :backtrace
+    def backtrace
+      Array(@error_backtrace) + Array(original_backtrace)
+    end
+
+    def to_s
+      [
+        "An error occurred while reading the Clearbooksfile:",
+        "",
+        "  #{@error_message}",
+      ].join("\n")
+    end
+  end
+
+
+  class InvalidConfiguration < ClearbooksError
+    status_code(115)
+
+    def initialize(errors)
+      @errors = errors
+    end
+
+    def to_s
+      out = "Invalid configuration:\n"
+      @errors.each do |key, errors|
+        errors.each do |error|
+          out << "  #{key} #{error}\n"
+        end
+      end
+
+      out.strip
+    end
+  end
+
+  class InsufficientPrivledges < ClearbooksError
+    status_code(119)
+
+    def initialize(path)
+      @path = path
+    end
+
+    def to_s
+      "You do not have permission to write to '#{@path}'! Please chown the " \
+      "path to the current user, chmod the permissions to include the " \
+      "user, or choose a different path."
+    end
+  end
+
+  class DependencyNotFound < ClearbooksError
+    status_code(120)
+
+    # @param [String, Array<String>] names
+    #   the list of cookbook names that were not defined
+    def initialize(names)
+      @names = Array(names)
+    end
+
+    def to_s
+      if @names.size == 1
+        "Dependency '#{@names.first}' was not found. Please make sure it is " \
+        "in your Clearbooksfile, and then run `berks install` to download and " \
+        "install the missing dependencies."
+      else
+        out = "The following dependencies were not found:\n"
+        @names.each do |name|
+          out << "  * #{name}\n"
+        end
+        out << "\n"
+        out << "Please make sure they are in your Clearbooksfile, and then run "
+        out << "`berks install` to download and install the missing "
+        out << "dependencies."
+        out
+      end
+    end
+  end
+
+
+  class LockfileParserError < ClearbooksError
+    status_code(136)
+
+    # @param [String] lockfile
+    #   the path to the Lockfile
+    # @param [~Exception] original
+    #   the original exception class
+    def initialize(original)
+      @original = original
+    end
+
+    def to_s
+      "Error reading the Clearbooks lockfile:\n\n" \
+      "  #{@original.class}: #{@original.message}"
+    end
+  end
+
+  class LockfileNotFound < ClearbooksError
+    status_code(140)
+
+    def to_s
+      'Lockfile not found! Run `berks install` to create the lockfile.'
+    end
+  end
+
+
+  class LockfileOutOfSync < ClearbooksError
+    status_code(144)
+
+    def to_s
+      'The lockfile is out of sync! Run `berks install` to sync the lockfile.'
+    end
+  end
+
+
+  class NoAPISourcesDefined < ClearbooksError
+    status_code(146)
+
+    def to_s
+      "Your Clearbooksfile does not define any API sources! You must define " \
+      "at least one source in order to download cookbooks. To add the " \
+      "default Clearbooks API server, add the following code to the top of " \
+      "your Clearbooksfile:"
+    end
+  end
+
+end
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/interface/rake/cucumber.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+
+## Handle Cucumber # {{{
+
+namespace :cucumber do
+
+  begin
+    require 'cucumber'
+    require 'cucumber/rake/task'
+
+    desc "Cucumber Core Tasks" # {{{
+    Cucumber::Rake::Task.new(:pretty) do |t|
+      t.cucumber_opts = "--format pretty -S"
+    end # }}}
+
+    desc "Cucumber Core Tasks" # {{{
+    Cucumber::Rake::Task.new(:progress) do |t|
+      t.cucumber_opts = "--format progress -S"
+    end # }}}
+
+  rescue LoadError
+    desc 'Cucumber rake task not available'
+    task :pretty do
+      abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    end
+
+    task :progress do
+      abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    end
+  end
+
+end # pf namespace }}}
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/interface/rake/default.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+
+# System
+require 'bundler'
+require 'bundler/gem_tasks'
+
+require 'shellwords'
+require 'fileutils'
+
+require 'date'
+require 'ostruct'
+
+
+
+### General
+
+desc "Show the default task when executing rake without arguments" # {{{
+task :default => :help # }}}
+
+desc "Shows the usage help screen" # {{{
+task :help do |t|
+  `rake -T`
+end # }}}
+
+
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/interface/rake/documentation.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+
+namespace :docs do 
+
+  desc "Generate Yardoc documentation for this project" # {{{
+  task :generate do |t|
+
+    # Define new tags for yardoc to detect
+    tags             = {}
+    tags[ "module" ] = "Module"
+    tags[ "class" ]  = "Class"
+    tags[ "fn" ]     = "Function"
+    tags[ "brief" ]  = "Description"
+
+    # Hide tags we don't want in yardoc output
+    hidden           = %w[module class fn]
+
+    # Construct tag string for CLI command
+    tags_line = ""
+    tags.each_pair { |n,v| tags_line += " --tag #{n.to_s}:\"#{v.to_s}\"" }
+    hidden.each { |h| tags_line += " --hide-tag #{h.to_s}" }
+
+    puts "(II) Generating multi-file yardoc output written to doc/yardoc"
+    system "yard --private --protected --markup-provider=redcarpet --markup=markdown #{tags_line.to_s} -o doc/yardoc lib/**/*.rb lib/**/**/*.rb - LICENSE MAINTAINERS API_DOCS.md"
+
+    puts "(II) Generating one-file yardoc output written to doc/yardoc_pdf"
+    system "yard --private --protected --markup-provider=redcarpet --markup=markdown --one-file #{tags_line.to_s} -o doc/yardoc_pdf lib/**/*.rb lib/**/**/*.rb - LICENSE MAINTAINERS API_DOCS.md"
+
+    # puts "(II) HTML to PDF written to doc/yardoc_pdf"
+    # pdf = WickedPdf.new.pdf_from_string( File.read( "doc/yardoc_pdf/index.html" ) )
+    # File.write( "doc/yardoc_pdf/index.pdf", pdf )
+  end # }}}
+
+  desc "Generate Yard Graphs for this project" # {{{
+  task :graph do |t|
+    basedir = "doc/yard-graph"
+    FileUtils.mkdir_p( basedir )
+    system "yard graph --dependencies --empty-mixins --full > #{basedir.to_s}/graph.dot"
+    system "dot -Tpng #{basedir.to_s}/graph.dot > #{basedir.to_s}/graph.png"
+  end # }}}
+
+end # of namespace :docs
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby

data/lib/clearbooks/interface/rake/guard.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+
+namespace :guard do
+
+  desc "Execute Ruby Guard" # {{{
+  task :default do |g|
+    sh "bundle exec guard start -G Guardfile"
+  end # }}}
+
+end
+
+# vim:ts=2:tw=100:wm=100:syntax=ruby