captain_hoog 1.1.1 → 2.0.0

data/lib/captain_hoog/cli/hoog.rb

@@ -0,0 +1,129 @@
+module CaptainHoog
+  module Cli
+    autoload :Git, 'captain_hoog/cli/git'
+    autoload :Pull, 'captain_hoog/cli/pull'
+    class Hoog < Thor
+      include Thor::Actions
+      include Git
+      include Pull
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def self.source_root
+        File.join(File.dirname(__FILE__), "templates")
+      end
+
+      def self.hookin_repo
+        "git@github.com:RSCSCybersecurity/hookins.git"
+      end
+
+      class_option :type, type: :string, default: 'pre-commit'
+      class_option :project_dir, type: :string, default: Dir.getwd
+      class_option :plugins_dir, type: :string, default: Dir.getwd
+
+      map %w[--version -v] => :__print_version
+
+      option :skip_hookins, type: :boolean, default: false 
+      option :silence, type: :boolean, default: false
+      desc "install","Installs the hook into your Git repository"
+      def install(*_args)
+        check_if_git_present
+        check_if_option_present("plugins_dir")
+        init_environment(home_dir: Dir.home,
+                        silence: options[:silence],
+                        skip_hookins: options[:skip_hookins])
+        install_hook({ as: options[:type],
+                       context: {
+                         root_dir: Dir.getwd,
+                         plugins_dir: options[:plugins_dir],
+                         project_dir: options[:project_dir]
+                       }
+                    })
+        puts "Installed hook as #{options[:type]} hook".green
+      end
+
+      desc "remove", "Removes a hook from your Git repository"
+      def remove(*_args)
+        check_if_git_present
+        remove_hook(as: options[:type])
+        puts "The #{options[:type]} hook is removed.".green
+      end
+
+      option :from, type: :string, required: true
+      option :to, type: :string, required: true
+      desc "move", "Moves a hook from type to another"
+      def move(*_args)
+        check_if_git_present
+        if options[:from] == options[:to]
+          puts "--from and --to arguments are the same".red
+          raise Thor::Error
+        else
+          move_hook(options)
+          puts "The #{options[:from]} hook is moved to #{options[:to]} hook.".green
+        end
+      end
+
+      desc "version, -v", "Prints out the version"
+      def __print_version
+        puts CaptainHoog::VERSION
+      end
+
+      option :home, type: :string
+      desc "init", "Initializes the Captain Hoog Environment"
+      def init
+        home_dir = options[:home]
+        init_environment(home_dir: home_dir)
+      end
+
+      desc 'treasury', 'Manages the treasury and holds the hoogs'
+      subcommand 'treasury', Treasury
+
+      private
+
+      def install_hook(config)
+        opts        = config[:context]
+        opts[:type] = config[:as]
+        copy_config_file(opts)
+        template("install.erb",File.join(hooks_dir, config[:as]), opts)
+        FileUtils.chmod(0755,File.join(hooks_dir, config[:as]))
+      end
+
+      def remove_hook(config)
+        FileUtils.rm_rf(File.join(hooks_dir, config[:as]))
+      end
+
+      def move_hook(config)
+        from = File.join(hooks_dir, config[:from])
+        to   = File.join(hooks_dir, config[:to])
+        FileUtils.mv(from, to)
+      end
+
+      def check_if_option_present(type)
+        unless options.has_key?(type)
+          puts "No value provided for required options '--#{type}'".red
+          raise Thor::Error
+        end
+      end
+
+      def copy_config_file(opts={})
+        template('hoogfile.erb', git_dir.join('hoogfile.yml'), opts)
+      end
+
+      def init_environment(home_dir: Dir.home, 
+                           silence: false,
+                           skip_hookins: false)
+        environment_dir = File.join(home_dir, '.hoog')
+        treasury_dir = File.join(environment_dir, 'treasury')
+        if File.exist?(treasury_dir)
+          puts "Treasury already exists. Skipping.".yellow unless silence
+        else
+          puts "Initializing treasury".green unless silence
+          FileUtils.mkdir_p(treasury_dir)
+        end
+        pull_and_clone(self.class.hookin_repo, treasury_dir) unless skip_hookins
+      end
+    end
+  end
+end

data/lib/captain_hoog/cli/pull.rb

@@ -0,0 +1,14 @@
+module CaptainHoog
+  module Cli
+    module Pull
+      module_function
+
+      def pull_and_clone(repository_url, path)
+        target_name = File.basename(repository_url.split('/').last, '.git')
+        ::Git.clone(repository_url, target_name, path: path)
+      rescue
+        puts "Default hookin treasury already exists. Skipping.".yellow
+      end
+    end
+  end
+end

data/lib/captain_hoog/{templates → cli/templates}/install.erb

@@ -9,6 +9,7 @@ CaptainHoog::PreGit.configure do |config|
   config.plugins_dir      = hoog_config.plugins_dir
   config.project_dir      = hoog_config.project_dir
   config.plugins_conf     = hoog_config.plugins_env
+  config.context          = '<%=config[:type] %>'
   #config.headline_on_success = "All is fine."
   #config.headline_on_failure = "Oops. Something went wrong"
 end

data/lib/captain_hoog/cli/treasury.rb

@@ -0,0 +1,15 @@
+module CaptainHoog
+  module Cli
+    autoload :Pull, 'captain_hoog/cli/pull'
+    class Treasury < Thor
+      include Pull
+      
+      desc 'pull','Pulls from repository into the treasury'
+      option :home, type: :string
+      def pull(repository_url)
+        path = options[:home] ? options[:home] : CaptainHoog.treasury_path
+        pull_and_clone(repository_url, path)
+      end
+    end
+  end
+end

data/lib/captain_hoog/cli.rb

@@ -0,0 +1,9 @@
+#require 'captain_hoog/cli/treasury'
+#require 'captain_hoog/cli/hoog'
+
+module CaptainHoog
+  module Cli
+    autoload :Treasury, 'captain_hoog/cli/treasury'
+    autoload :Hoog,     'captain_hoog/cli/hoog'
+  end
+end

data/lib/captain_hoog/core_ext/hash.rb

@@ -2,10 +2,10 @@ class Hash
   def stringify_keys
     reduce({}) do |hash, (key, value)|
       new_value = if value.respond_to?(:stringify_keys)
-        value.stringify_keys
-      else
-        value
-      end
+                    value.stringify_keys
+                  else
+                    value
+                  end
       hash.merge(key.to_s => new_value)
     end
   end

data/lib/captain_hoog/dependencies.rb

@@ -3,3 +3,6 @@ require 'terminal-table'
 require 'yaml'
 require 'ostruct'
 require 'erb'
+require 'thor'
+require 'pathname'
+require 'git'

data/lib/captain_hoog/git.rb

@@ -13,13 +13,8 @@ module CaptainHoog
       end
     end
 
-    def message
-      if block_given?
-        @message = yield
-        unless @message.is_a?(String)
-          raise CaptainHoog::Errors::MessageResultNotValidError
-        end
-      end
+    def message(color: :red, &blk)
+      @message = CaptainHoog::Message.new(color, blk) if blk
     end
 
     def helper(name,&block)

data/lib/captain_hoog/message.rb

@@ -0,0 +1,31 @@
+module CaptainHoog
+  class Message
+    
+    def initialize(color, body)
+      @body  = body
+      @color = color
+    end
+
+    def call(no_color: true)
+      (no_color || will_have_no_color) ? message : message.send(@color)
+    end
+
+    def message
+      message = @body.call
+      check_msg(message)
+      message
+    end
+
+    private
+    def check_msg(msg)
+      unless msg.is_a?(String)
+        raise CaptainHoog::Errors::MessageResultNotValidError
+      end
+    end
+
+    def will_have_no_color
+      @color.eql?(:none)
+    end
+
+  end
+end

data/lib/captain_hoog/pre_git.rb

@@ -1,16 +1,29 @@
 module CaptainHoog
   # Public: Entry class for handling a Pre-Something with plugins.
   class PreGit
+    module PluginDirs
+      module_function
+      def collect(plugins_dir)
+        treasury_path = CaptainHoog.treasury_path
+        if File.exist?(treasury_path)
+          Dir["#{treasury_path}/**"].each_with_object(plugins_dir) do |dir, res|
+            res << dir if File.directory?(dir)
+          end
+        end
+      end
+    end
 
-    class << self
-      attr_accessor :project_dir,
-                    :plugins_dir,
-                    :headline_on_success,
-                    :headline_on_failure,
-                    :suppress_headline,
-                    :plugins_conf
+    %i{ project_dir
+        headline_on_success
+        headline_on_failure
+        suppress_headline
+        plugins_conf
+        context }.each do |class_method|
+      singleton_class.send(:attr_accessor, class_method)
     end
 
+    singleton_class.send(:attr_reader, :plugins_dir)
+
     # Public: Runs the hook.
     #
     # Inits a new instance of self and evaluates the plugins (if found some)
@@ -29,6 +42,12 @@ module CaptainHoog
       yield(self) if block_given?
     end
 
+    def self.plugins_dir=(plugins_dir)
+      @plugins_dir = []
+      PluginDirs.collect(@plugins_dir)
+      (@plugins_dir << plugins_dir).flatten!
+    end
+
     def initialize(plugins_list = nil)
       @plugins      = []
       @plugins_list = plugins_list
@@ -69,6 +88,7 @@ module CaptainHoog
       env = Env.new
       env[:project_dir]    = self.class.project_dir
       env[:plugins_config] = self.class.plugins_conf
+      env[:context ]       = self.class.context
       env
     end
 
@@ -78,10 +98,10 @@ module CaptainHoog
 
     def message_on_failure
       unless self.class.suppress_headline
-        puts defined_message_on(:failure).red
+        puts defined_message_on(:failure)
         puts "\n"
         @results.select{|result| not result[:result] }.each do |result|
-          puts result[:message].red
+          puts result[:message].call(no_color: false)
         end
       end
     end
@@ -102,7 +122,7 @@ module CaptainHoog
     end
 
     def shared_plugins_dir_present?
-      File.exists?(shared_plugins_dir)
+      File.exist?(shared_plugins_dir)
     end
 
     def shared_plugins_dir
@@ -110,6 +130,7 @@ module CaptainHoog
     end
 
     def read_plugins_from_dir(dir, env)
+      return unless dir
       unless File.basename(dir).match(/test/)
         Dir["#{dir}/**"].each do |file|
           if File.directory?(file)

data/lib/captain_hoog/test/sandbox.rb

@@ -72,7 +72,7 @@ module CaptainHoog
             git         = eigenplugin.instance_variable_get(:@git)
             {
               test: git.instance_variable_get(:@test_result),
-              message: git.instance_variable_get(:@message)
+              message: git.instance_variable_get(:@message).call
             }
           end
         end

data/lib/captain_hoog/version.rb

@@ -1,3 +1,3 @@
 module CaptainHoog
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/lib/captain_hoog.rb

@@ -1,17 +1,24 @@
-require "captain_hoog/version"
 require "captain_hoog/dependencies"
 require "captain_hoog/core_ext"
-require "captain_hoog/errors"
-require "captain_hoog/delegatable"
-require "captain_hoog/helper_table"
-require "captain_hoog/env"
-require "captain_hoog/git"
-require "captain_hoog/plugin"
-require "captain_hoog/pre_git"
-require "captain_hoog/plugin_list"
-require "captain_hoog/struct/hoog_struct"
-require "captain_hoog/hoogfile"
 
 module CaptainHoog
-  # Your code goes here...
+
+  autoload :Version,      'captain_hoog/version'
+  autoload :Errors,       'captain_hoog/errors/dsl_errors'
+  autoload :Delegatable,  'captain_hoog/delegatable'
+  autoload :HelperTable,  'captain_hoog/helper_table'
+  autoload :Env,          'captain_hoog/env'
+  autoload :Git,          'captain_hoog/git'
+  autoload :Plugin,       'captain_hoog/plugin'
+  autoload :PreGit,       'captain_hoog/pre_git'
+  autoload :PluginList,   'captain_hoog/plugin_list'
+  autoload :Struct,       'captain_hoog/struct/hoog_struct'
+  autoload :Hoogfile,     'captain_hoog/hoogfile'
+  autoload :Cli,          'captain_hoog/cli'
+  autoload :Message,      'captain_hoog/message'
+
+  module_function
+  def treasury_path
+    File.join(Dir.home, '.hoog', 'treasury')
+  end
 end

data/spec/fixtures/neverland.git/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/spec/fixtures/neverland.git/config

@@ -0,0 +1,6 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = true
+	ignorecase = true
+	precomposeunicode = true

data/spec/fixtures/neverland.git/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

data/spec/fixtures/neverland.git/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
+test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
+:

data/spec/fixtures/neverland.git/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}