ronin-core 0.1.0.beta1

data/spec/cli/shell_spec.rb

@@ -0,0 +1,211 @@
+require 'spec_helper'
+require 'ronin/core/cli/shell'
+
+describe Ronin::Core::CLI::Shell do
+  describe ".shell_name" do
+    subject { shell_class }
+
+    context "and when shell_name is not set in the shell class" do
+      module TestShell
+        class ShellWithNoShellName < Ronin::Core::CLI::Shell
+        end
+      end
+
+      let(:shell_class) { TestShell::ShellWithNoShellName }
+
+      it "must default to nil" do
+        expect(subject.shell_name).to be(nil)
+      end
+    end
+
+    context "and when shell_name is set in the shell class" do
+      module TestShell
+        class ShellWithShellName < Ronin::Core::CLI::Shell
+          shell_name 'test'
+        end
+      end
+
+      let(:shell_class) { TestShell::ShellWithShellName }
+
+      it "must return the set shell_name" do
+        expect(subject.shell_name).to eq("test")
+      end
+    end
+
+    context "but when the shell_name was set in the superclass" do
+      module TestShell
+        class ShellThatInheritsItsShellName < ShellWithShellName
+        end
+      end
+
+      let(:shell_class) do
+        TestShell::ShellThatInheritsItsShellName
+      end
+
+      it "must return the shell_name set in the superclass" do
+        expect(subject.shell_name).to eq("test")
+      end
+
+      context "but the shell_name is overridden in the sub-class" do
+        module TestShell
+          class ShellThatOverridesItsInheritedShellName < ShellWithShellName
+            shell_name "test2"
+          end
+        end
+
+        let(:shell_class) do
+          TestShell::ShellThatOverridesItsInheritedShellName
+        end
+
+        it "must return the shell_name set in the sub-class" do
+          expect(subject.shell_name).to eq("test2")
+        end
+      end
+    end
+  end
+
+  describe ".prompt_sigil" do
+    subject { shell_class }
+
+    context "and when prompt_sigil is not set in the shell class" do
+      module TestShell
+        class ShellWithNoPromptSigil < Ronin::Core::CLI::Shell
+        end
+      end
+
+      let(:shell_class) { TestShell::ShellWithNoPromptSigil }
+
+      it "must default to '>'" do
+        expect(subject.prompt_sigil).to eq('>')
+      end
+    end
+
+    context "and when prompt_sigil is set in the shell class" do
+      module TestShell
+        class ShellWithPromptSigil < Ronin::Core::CLI::Shell
+          prompt_sigil '$'
+        end
+      end
+
+      let(:shell_class) { TestShell::ShellWithPromptSigil }
+
+      it "must return the set prompt_sigil" do
+        expect(subject.prompt_sigil).to eq("$")
+      end
+    end
+
+    context "but when the prompt_sigil was set in the superclass" do
+      module TestShell
+        class ShellThatInheritsItsPromptSigil < ShellWithPromptSigil
+        end
+      end
+
+      let(:shell_class) do
+        TestShell::ShellThatInheritsItsPromptSigil
+      end
+
+      it "must return the prompt_sigil set in the superclass" do
+        expect(subject.prompt_sigil).to eq("$")
+      end
+
+      context "but the prompt_sigil is overridden in the sub-class" do
+        module TestShell
+          class ShellThatOverridesItsInheritedPromptSigil < ShellWithPromptSigil
+            prompt_sigil "#"
+          end
+        end
+
+        let(:shell_class) do
+          TestShell::ShellThatOverridesItsInheritedPromptSigil
+        end
+
+        it "must return the prompt_sigil set in the sub-class" do
+          expect(subject.prompt_sigil).to eq("#")
+        end
+      end
+    end
+  end
+
+  module TestShell
+    class TestShell < Ronin::Core::CLI::Shell
+      shell_name 'test'
+    end
+  end
+
+  let(:shell_class) { TestShell::TestShell }
+  subject { shell_class.new }
+
+  describe "#initialize" do
+    context "when no keyword arguments are given" do
+      it "must default #shell_name to self.class.shell_name" do
+        expect(subject.shell_name).to eq(shell_class.shell_name)
+      end
+
+      it "must default #prompt_sigil to self.class.prompt_sigil" do
+        expect(subject.prompt_sigil).to eq(shell_class.prompt_sigil)
+      end
+    end
+
+    context "when the shell_name: keyword argument is given" do
+      let(:new_shell_name) { 'override' }
+
+      subject { shell_class.new(shell_name: new_shell_name) }
+
+      it "must override #shell_name" do
+        expect(subject.shell_name).to eq(new_shell_name)
+      end
+    end
+
+    context "when the prompt_sigil: keyword argument is given" do
+      let(:new_prompt_sigil) { '$' }
+
+      subject { shell_class.new(prompt_sigil: new_prompt_sigil) }
+
+      it "must override #prompt_sigil" do
+        expect(subject.prompt_sigil).to eq(new_prompt_sigil)
+      end
+    end
+  end
+
+  describe "#shell_name" do
+    it "must return the shell class'es .shell_name" do
+      expect(subject.shell_name).to eq(shell_class.shell_name)
+    end
+  end
+
+  describe "#prompt_sigil" do
+    it "must return the shell class'es .prompt_sigil" do
+      expect(subject.prompt_sigil).to eq(shell_class.prompt_sigil)
+    end
+  end
+
+  describe "#prompt" do
+    let(:stdout) { StringIO.new }
+
+    subject { shell_class.new(stdout: stdout) }
+
+    context "when stdout is a TTY" do
+      before do
+        allow(subject.stdout).to receive(:tty?).and_return(true)
+      end
+
+      let(:red)             { CommandKit::Colors::ANSI::RED }
+      let(:bright_red)      { CommandKit::Colors::ANSI::BRIGHT_RED }
+      let(:bold)            { CommandKit::Colors::ANSI::BOLD }
+      let(:reset_intensity) { CommandKit::Colors::ANSI::RESET_INTENSITY }
+      let(:reset_color)     { CommandKit::Colors::ANSI::RESET_COLOR     }
+
+      it "must return an ANSI colored prompt" do
+        expect(subject.prompt).to eq(
+          "#{red}#{subject.shell_name}#{reset_color}#{bold}#{bright_red}>#{reset_color}#{reset_intensity}"
+        )
+      end
+    end
+
+    context "when stdout is not a TTY" do
+      it "must return a plain-text prompt" do
+        expect(subject.prompt).to eq("#{subject.shell_name}>")
+      end
+    end
+  end
+end

data/spec/fixtures/example_class_registry/base_class.rb

@@ -0,0 +1,9 @@
+module ExampleClassRegistry
+  class BaseClass
+
+    def self.register(path)
+      ExampleClassRegistry.register(path,self)
+    end
+
+  end
+end

data/spec/fixtures/example_class_registry/classes/loaded_class.rb

@@ -0,0 +1,9 @@
+require_relative '../base_class'
+
+module ExampleClassRegistry
+  class LoadedClass < BaseClass
+
+    register 'loaded_class'
+
+  end
+end

data/spec/fixtures/example_class_registry/classes/name_mismatch.rb

@@ -0,0 +1,9 @@
+require_relative '../base_class'
+
+module ExampleClassRegistry
+  class LoadedModule < BaseClass
+
+    register 'different_name'
+
+  end
+end

data/spec/fixtures/example_class_registry/classes/no_module.rb

@@ -0,0 +1,4 @@
+module ExampleClassRegistry
+  class SomeClass
+  end
+end

data/spec/fixtures/example_class_registry.rb

@@ -0,0 +1,8 @@
+require 'ronin/core/class_registry'
+
+module ExampleClassRegistry
+
+  include Ronin::Core::ClassRegistry
+  class_dir "#{__dir__}/example_class_registry/classes"
+
+end

data/spec/git_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'ronin/core/git'
+
+describe Ronin::Core::Git do
+  describe ".user_name" do
+    let(:user_name) { 'Foo Bar' }
+
+    it "must execute `git config user.name`" do
+      expect(subject).to receive(:`).with("git config user.name").and_return("#{user_name}#{$/}")
+
+      expect(subject.user_name).to eq(user_name)
+    end
+
+    context "when `git config user.name` returns an empty String" do
+      it "must return nil" do
+        expect(subject).to receive(:`).with("git config user.name").and_return("")
+
+        expect(subject.user_name).to be(nil)
+      end
+    end
+  end
+
+  describe ".user_email" do
+    let(:user_email) { 'foo@example.com' }
+
+    it "must execute `git config user.email`" do
+      expect(subject).to receive(:`).with("git config user.email").and_return("#{user_email}#{$/}")
+
+      expect(subject.user_email).to eq(user_email)
+    end
+
+    context "when `git config user.email` returns an empty String" do
+      it "must return nil" do
+        expect(subject).to receive(:`).with("git config user.email").and_return("")
+
+        expect(subject.user_email).to be(nil)
+      end
+    end
+  end
+
+  describe ".github_user" do
+    let(:github_user) { 'foo' }
+
+    it "must execute `git config github.user`" do
+      expect(subject).to receive(:`).with("git config github.user").and_return("#{github_user}#{$/}")
+
+      expect(subject.github_user).to eq(github_user)
+    end
+
+    context "when `git config github.user` returns an empty String" do
+      it "must return nil" do
+        expect(subject).to receive(:`).with("git config github.user").and_return("")
+
+        expect(subject.github_user).to be(nil)
+      end
+    end
+  end
+end

data/spec/home_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'ronin/core/home'
+
+describe Ronin::Core::Home do
+  describe "DIR" do
+    it "must equal Gem.user_home" do
+      expect(subject::DIR).to eq(Gem.user_home)
+    end
+  end
+
+  describe "CACHE_DIR" do
+    it "must equal ~/.cache" do
+      expect(subject::CACHE_DIR).to eq(
+        File.join(Gem.user_home,'.cache')
+      )
+    end
+  end
+
+  describe ".cache_dir" do
+    let(:name) { 'foo' }
+
+    it "must join ~/.cache with the given directory name" do
+      expect(subject.cache_dir(name)).to eq(
+        File.join(Gem.user_home,'.cache',name)
+      )
+    end
+  end
+
+  describe "CONFIG_DIR" do
+    it "must equal ~/.config" do
+      expect(subject::CONFIG_DIR).to eq(
+        File.join(Gem.user_home,'.config')
+      )
+    end
+  end
+
+  describe ".config_dir" do
+    let(:name) { 'foo' }
+
+    it "must join ~/.config with the given directory name" do
+      expect(subject.config_dir(name)).to eq(
+        File.join(Gem.user_home,'.config',name)
+      )
+    end
+  end
+
+  describe "LOCAL_SHARE" do
+    it "must equal ~/.local/share" do
+      expect(subject::LOCAL_SHARE_DIR).to eq(
+        File.join(Gem.user_home,'.local','share')
+      )
+    end
+  end
+
+  describe ".local_share_dir" do
+    let(:name) { 'foo' }
+
+    it "must join ~/.local/share with the given directory name" do
+      expect(subject.local_share_dir(name)).to eq(
+        File.join(Gem.user_home,'.local','share',name)
+      )
+    end
+  end
+end