busser 0.1.0

data/lib/busser/cli.rb

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/thor'
+require 'busser/command/plugin'
+require 'busser/command/setup'
+require 'busser/command/suite'
+require 'busser/command/test'
+
+module Busser
+
+  # Main command line interface class which delegates to subcommands.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class CLI < Thor::Base
+
+    register Busser::Command::Setup, "setup",
+      "setup", "Creates a Busser home"
+    register Busser::Command::Plugin, "plugin",
+      "plugin SUBCOMMAND", "Plugin subcommands"
+    register Busser::Command::Suite, "suite",
+      "suite SUBCOMMAND", "Suite subcommands"
+    register Busser::Command::Test, "test",
+      "test [PLUGIN ...]", "Runs test suites"
+  end
+end

data/lib/busser/command/plugin.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/thor'
+require 'busser/command/plugin_install'
+require 'busser/command/plugin_list'
+
+module Busser
+
+  module Command
+
+    # Plugin commands.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class Plugin < Busser::Thor::Base
+
+      register Busser::Command::PluginInstall, "install",
+        "install PLUGIN [PLUGIN ...]", "Installs one or more plugins"
+      register Busser::Command::PluginList, "list",
+        "list", "Lists installed plugins"
+    end
+  end
+end

data/lib/busser/command/plugin_install.rb

@@ -0,0 +1,95 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rubygems/dependency_installer'
+require 'busser/thor'
+
+module Busser
+
+  module Command
+
+    # Plugin install command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class PluginInstall < Busser::Thor::BaseGroup
+
+      argument :plugins, :type => :array
+
+      def install_all
+        silence_gem_ui!
+        plugins.each { |plugin| install(plugin) }
+      end
+
+      private
+
+      def install(plugin)
+        install_gem(plugin)
+      end
+
+      def install_gem(plugin)
+        name, version = plugin.split("@")
+
+        if gem_installed?(name, version)
+          info "#{plugin} plugin already installed"
+        else
+          spec = dep_installer.install(new_dep(name, version)).first
+          info "Plugin #{plugin} installed (version #{spec.version})"
+        end
+      end
+
+      def gem_installed?(name, version)
+        installed = Array(Gem::Specification.find_all_by_name(name, version))
+        version = latest_version(name) if version.nil?
+
+        installed.find { |spec| spec.version.to_s == version }
+      end
+
+      def latest_version(name)
+        available_gems = dep_installer.find_gems_with_sources(new_dep(name))
+
+        spec, source = if available_gems.respond_to?(:last)
+          # DependencyInstaller sorts the results such that the last one is
+          # always the one it considers best.
+          spec_with_source = available_gems.last
+          spec_with_source && spec_with_source
+        else
+          # Rubygems 2.0 returns a Gem::Available set, which is a
+          # collection of AvailableSet::Tuple structs
+          available_gems.pick_best!
+          best_gem = available_gems.set.first
+          best_gem && [best_gem.spec, best_gem.source]
+        end
+
+        spec && spec.version && spec.version.to_s
+      end
+
+      def silence_gem_ui!
+        Gem::DefaultUserInteraction.ui = Gem::SilentUI.new
+      end
+
+      def dep_installer
+        Gem::DependencyInstaller.new
+      end
+
+      def new_dep(name, version = nil)
+        Gem::Dependency.new(name, version)
+      end
+    end
+  end
+end

data/lib/busser/command/plugin_list.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/plugin'
+require 'busser/thor'
+
+module Busser
+
+  module Command
+
+    # Plugin list command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class PluginList < Busser::Thor::BaseGroup
+
+      def list
+        if plugin_data.empty?
+          say "No plugins installed yet"
+        else
+          print_table([["Plugin", "Version"]] + plugin_data)
+        end
+      end
+
+      private
+
+      def plugin_data
+        @plugin_data ||= Busser::Plugin.runner_plugins.map do |path|
+          spec = Busser::Plugin.gem_from_path(path)
+          [File.basename(path), (spec && spec.version)]
+        end
+      end
+    end
+  end
+end

data/lib/busser/command/setup.rb

@@ -0,0 +1,93 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/thor'
+require 'busser/plugin'
+
+module Busser
+
+  module Command
+
+    # Setup command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class Setup < Busser::Thor::BaseGroup
+
+      def perform
+        banner "Setting up Busser"
+        create_busser_root
+        generate_busser_binstub
+      end
+
+      private
+
+      def create_busser_root
+        info "Creating BUSSER_ROOT in #{root_path}"
+        empty_directory(root_path, :verbose => false)
+      end
+
+      def generate_busser_binstub
+        binstub = root_path + "bin/busser"
+
+        info "Creating busser binstub"
+        create_file(binstub, :verbose => false) do
+          <<-BUSSER_BINSTUB.gsub(/^ {12}/, '')
+            #!/usr/bin/env bash
+            #
+            # This file was generated by Busser.
+            #
+            # The application 'busser' is installed as part of a gem, and
+            # this file is here to facilitate running it.
+            #
+
+            # Get the directory where this ruby is. This will also resolve
+            # any symlinks in the directory/script, so it will be the fully
+            # resolved path.
+            SOURCE="#{ruby_bin}"
+            while [ -h "$SOURCE" ] ; do SOURCE="$(readlink "$SOURCE")"; done
+            DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
+
+            # Export gem paths so that we use the isolated gems.
+            export GEM_HOME="#{gem_home}"
+            export GEM_PATH="${GEM_HOME}"
+
+            # Unset RUBYOPT, we don't want this bleeding into our runtime.
+            unset RUBYOPT GEMRC
+
+            # Call the actual Busser bin with our arguments
+            exec "${DIR}/ruby" "${DIR}/busser" "$@"
+          BUSSER_BINSTUB
+        end
+        chmod(binstub, 0755, :verbose => false)
+      end
+
+      def ruby_bin
+        if bindir = RbConfig::CONFIG["bindir"]
+          File.join(bindir, "ruby")
+        else
+          "ruby"
+        end
+      end
+
+      def gem_home
+        Gem.paths.home
+      end
+    end
+  end
+end

data/lib/busser/command/suite.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/thor'
+require 'busser/command/suite_cleanup'
+require 'busser/command/suite_path'
+
+module Busser
+
+  module Command
+
+    # Suite commands.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class Suite < Busser::Thor::Base
+
+      register Busser::Command::SuiteCleanup, "cleanup",
+        "cleanup", "Cleans up test suite directories"
+      register Busser::Command::SuitePath, "path",
+        "path [<plugin_name>]", "Displays the directory for suite tests"
+    end
+  end
+end

data/lib/busser/command/suite_cleanup.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/thor'
+
+module Busser
+
+  module Command
+
+    # Suite cleanup command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class SuiteCleanup < Busser::Thor::BaseGroup
+
+      def cleanup
+        if suite_path.directory?
+          Pathname.glob(suite_path + "*").each do |dir|
+            info "Removing #{dir}"
+            dir.rmtree
+          end
+        else
+          info "Suite path directory #{suite_path} does not exist, skipping."
+        end
+      end
+    end
+  end
+end

data/lib/busser/command/suite_path.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'busser/thor'
+
+module Busser
+
+  module Command
+
+    # Suite path command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class SuitePath < Busser::Thor::BaseGroup
+
+      argument :suite_name, :required => false
+
+      def path
+        say suite_path(suite_name)
+      end
+    end
+  end
+end