amp-front 0.1.0

data/spec/dispatch_specs/runner_spec.rb

@@ -0,0 +1,116 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amp::Dispatch::Runner do
+  before do
+    @runner = Amp::Dispatch::Runner.new(['--version'], :ampfile => "NO SUCH FILE@@@@@@@@@@@@@@@@@@")
+  end
+
+  describe '#run!' do
+    it 'parses arguments' do
+      proc { @runner.run! }.should raise_error(SystemExit)
+    end
+    
+    it 'runs the matching command' do
+      mock_command_class = mock('command class')
+      mock_command = mock('command')
+      Amp::Command.should_receive(:for_name).
+                   with('tester --verbose').
+                   and_return(mock_command_class)
+      mock_command_class.should_receive(:inspect).and_return('Amp::Command::Tester')
+      mock_command_class.should_receive(:new).and_return(mock_command)
+      mock_command.should_receive(:collect_options).and_return([{:verbose => true}, ['--verbose']])
+      mock_command.should_receive(:call).with(
+          {:verbose => true, :help => false, :version => false}, ['--verbose'])
+      
+      runner = Amp::Dispatch::Runner.new(['tester', '--verbose'])
+      runner.run!
+    end
+
+    it 'does not crash when no valid command' do
+      Amp::Command.should_receive(:for_name).
+                   with('').
+                   and_return(nil)
+      mock_command_class = mock('command class')
+      mock_command = mock('command')
+      Amp::Command::Help = mock_command_class
+      mock_command_class.should_receive(:name).at_most(:once).and_return('Amp::Command::Help')
+      mock_command_class.should_receive(:new).and_return(mock_command)
+      mock_command.should_receive(:collect_options).and_return([{}, []])
+      mock_command.should_receive(:call).with(
+          {:help => false, :version => false}, [])
+
+      runner = Amp::Dispatch::Runner.new([''])
+      runner.run!
+    end
+  end
+  
+  describe '#trim_argv_for_command' do
+    it 'strips arguments when arguments matches the command name' do
+      arguments = ['base', 'help']
+      command = mock(:command_class)
+      command.should_receive(:inspect).and_return('Amp::Command::Base')
+      @runner.trim_argv_for_command(arguments, command).should == ['help']
+      arguments.should == ['base', 'help']
+    end
+    
+    it 'strips arguments for commands in namespaces' do
+      arguments = ['base', 'help']
+      command = mock(:command_class)
+      command.should_receive(:inspect).and_return('Amp::Command::Base::Help')
+      @runner.trim_argv_for_command(arguments, command).should == []
+      arguments.should == ['base', 'help']
+    end
+    
+    it 'raises when the command name does not match arguments' do
+      arguments = ['base', 'hello']
+      command = mock(:command_class)
+      command.should_receive(:inspect).twice.and_return('Amp::Command::Base::Help')
+      proc { @runner.trim_argv_for_command(arguments, command) }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '#collect_options' do
+    it 'stops un unknown options' do
+      arguments = ['help', 'please']
+      options = @runner.collect_options(arguments)
+      arguments.should == ['help', 'please']
+    end
+    
+    it 'parses --version automatically and exit' do
+      swizzling_stdout do
+        proc { @runner.collect_options(['--version', 'please']) }.should raise_error(SystemExit)
+      end
+    end
+    
+    it 'displays Amp::VERSION_TITLE with --version' do
+      result = swizzling_stdout do
+        proc { @runner.collect_options(['--version', 'please']) }.should raise_error(SystemExit)
+      end
+      result.should include(Amp::VERSION_TITLE)
+    end
+
+    it 'returns the parsed options' do
+      options, arguments = @runner.collect_options(['help', 'please'])
+      options.should == {:version => false, :help => false}
+    end
+
+    it 'returns the unparsed arguments' do
+      options, arguments = @runner.collect_options(['help', 'please'])
+      arguments.should == ['help', 'please']
+    end
+  end
+end

data/spec/dispatch_specs/spec_helper.rb

@@ -0,0 +1,15 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/help_specs/help_entry_spec.rb

@@ -0,0 +1,78 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amp::Help::HelpEntry do
+  before(:each) do
+    @entry_counter ||= 0
+    @entry_counter += 1
+    @entry_name = "fake_help_#{@entry_counter}"
+  end
+
+  after(:each) do
+    Amp::Help::HelpRegistry.entries[@entry_name] = []
+  end
+  
+  describe '#text' do
+    it 'equals the text provided in the constructor' do
+      entry = Amp::Help::HelpEntry.new(@entry_name, 'abcba')
+      entry.text.should == 'abcba'
+    end
+  end
+  
+  describe Amp::Help::MarkdownHelpEntry do
+    describe '#text' do
+      it 'equals the text provided run through the markdown parser' do
+        input = '*hello* **there**'
+        entry = Amp::Help::MarkdownHelpEntry.new(@entry_name, input)
+        output = entry.text
+        output.should == "\e[4mhello\e[24m \e[1mthere\e[22m\n\n"
+      end
+    end
+  end
+  
+  describe Amp::Help::ErbHelpEntry do
+    describe '#text' do
+      it 'equals the text provided run through ERb' do
+        input = '<% 5.times do |x| %><%= x %><% end %>'
+        entry = Amp::Help::ErbHelpEntry.new(@entry_name, input)
+        output = entry.text
+        output.should == "01234"
+      end
+    end
+  end
+
+  describe Amp::Help::CommandHelpEntry do
+    describe '#text' do
+      it "contains the command's description" do
+        @klass = Class.new(Amp::Command::Base) { desc 'foo bar baz' }
+        entry = Amp::Help::CommandHelpEntry.new(@entry_name, @klass)
+        output = entry.text
+        output.should include('foo bar baz')
+      end
+      
+      it "contains the command's options" do
+        @klass = Class.new(Amp::Command::Base) do
+          opt :force, 'forces something dangerous', :short => '-f'
+        end
+        entry = Amp::Help::CommandHelpEntry.new(@entry_name, @klass)
+        output = entry.text
+        output.should include('--force')
+        output.should include('forces something dangerous')
+        output.should include('-f')
+      end
+    end
+  end
+end

data/spec/help_specs/help_registry_spec.rb

@@ -0,0 +1,77 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amp::Help::HelpRegistry do
+  before(:each) do
+    @entry_counter ||= 0
+    @entry_counter += 1
+    @entry_name = "fake_help_#{@entry_counter}"
+  end
+
+  after(:each) do
+    Amp::Help::HelpRegistry.entries[@entry_name] = []
+  end
+
+  describe '#register' do
+    it 'makes help entries available through #[]' do
+      fake_help_entry = mock(:help_entry)
+      Amp::Help::HelpRegistry.register(@entry_name, fake_help_entry)
+      Amp::Help::HelpRegistry[@entry_name].should == [fake_help_entry]
+    end
+
+    it 'makes help entries availabe through #entries' do
+      fake_help_entry = mock(:help_entry)
+      Amp::Help::HelpRegistry.register(@entry_name, fake_help_entry)
+      Amp::Help::HelpRegistry.entries[@entry_name].should == [fake_help_entry]
+    end
+  end
+  
+  describe '#unregister' do
+    it 'raises an error when the help entry is not found' do
+      lambda {
+        Amp::Help::HelpRegistry.unregister('frobnozzle')
+      }.should raise_error(ArgumentError)
+    end
+    
+    it 'only needs one argument when a help entry is unambiguous' do
+      fake_help_entry = mock(:help_entry)
+      Amp::Help::HelpRegistry.entries[@entry_name] = [fake_help_entry]
+      # Sanity check before unregistering it
+      Amp::Help::HelpRegistry.entries[@entry_name].should == [fake_help_entry]
+      Amp::Help::HelpRegistry.unregister(@entry_name)
+      Amp::Help::HelpRegistry.entries[@entry_name].should == []
+    end
+
+    it 'raises an error when giving 1 argument on an ambiguous match' do
+      fake_1, fake_2 = mock(:help_entry), mock(:other_help_entry)
+      Amp::Help::HelpRegistry.entries[@entry_name] = [fake_1, fake_2]
+      # Sanity check before unregistering it
+      Amp::Help::HelpRegistry.entries[@entry_name].should == [fake_1, fake_2]
+      lambda {
+        Amp::Help::HelpRegistry.unregister(@entry_name)
+      }.should raise_error(ArgumentError)
+    end
+
+    it 'succeeds when ambiguous matches are clarified' do
+      fake_1, fake_2 = mock(:help_entry), mock(:other_help_entry)
+      Amp::Help::HelpRegistry.entries[@entry_name] = [fake_1, fake_2]
+      # Sanity check before unregistering it
+      Amp::Help::HelpRegistry.entries[@entry_name].should == [fake_1, fake_2]
+      Amp::Help::HelpRegistry.unregister(@entry_name, fake_2)
+      Amp::Help::HelpRegistry.entries[@entry_name].should == [fake_1]
+    end
+  end
+end

data/spec/help_specs/spec_helper.rb

@@ -0,0 +1,15 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/plugin_specs/base_spec.rb

@@ -0,0 +1,36 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Amp::Plugins::Base do
+  it 'yields itself for easy configuration' do
+    new_plugin = Amp::Plugins::Base.create('silly') do |plugin|
+      plugin.author = 'Michael Edgar'
+    end
+    new_plugin.author.should == 'Michael Edgar'
+  end
+  
+  it 'mentions its author when inspected' do
+    plugin = Amp::Plugins::Base.create('silly') do |plugin|
+      plugin.author = 'adgar@carboni.ca'
+    end
+    plugin.new.inspect.should include('adgar@carboni.ca')
+  end
+  
+  it 'infers its own module name' do
+    plugin = Amp::Plugins::Base.create('silly')
+    plugin.new.module.should == 'Amp::Plugins::Silly'
+  end
+end

data/spec/plugin_specs/spec_helper.rb

@@ -0,0 +1,15 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/spec.opts

@@ -0,0 +1 @@
+--color --backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'amp-front'
+require 'spec'
+
+include Amp
+
+Spec::Runner.configure do |config|
+end
+
+def swizzling_stdout
+  new_stdout = StringIO.new
+  $stdout, old_stdout = new_stdout, $stdout
+  yield
+  new_stdout.string
+ensure
+  $stdout = old_stdout
+  new_stdout.string
+end

data/spec/support_specs/module_extensions_spec.rb

@@ -0,0 +1,104 @@
+##################################################################
+#                  Licensing Information                         #
+#                                                                #
+#  The following code is licensed, as standalone code, under     #
+#  the Ruby License, unless otherwise directed within the code.  #
+#                                                                #
+#  For information on the license of this code when distributed  #
+#  with and used in conjunction with the other modules in the    #
+#  Amp project, please see the root-level LICENSE file.          #
+#                                                                #
+#  © Michael J. Edgar and Ari Brown, 2009-2010                   #
+#                                                                #
+##################################################################
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ModuleExtensions do
+  before do
+    @class = Class.new do
+      extend ModuleExtensions
+      cattr_reader :read1, :read2
+      cattr_writer :write1, :write2
+      cattr_accessor :both1, :both2
+      cattr_accessor_with_default :arr1, []
+    end
+  end
+
+  describe '#cattr_reader' do
+    it 'creates reading methods for the given variables' do
+      @class.__send__(:instance_variable_set, :@read1, 'hello')
+      @class.read1.should == 'hello'
+      @class.__send__(:instance_variable_set, :@read2, 5)
+      @class.read2.should == 5
+    end
+  end
+
+  describe '#cattr_writer' do
+    it 'creates writing methods for the given variables' do
+      @class.write1 = 'hello'
+      @class.__send__(:instance_variable_get, :@write1).should == 'hello'
+      @class.write2 = 5
+      @class.__send__(:instance_variable_get, :@write2).should == 5
+    end
+  end
+
+  describe '#cattr_accessor' do
+    it 'creates reading and writing methods for the given variables' do
+      @class.both1 = 'hello'
+      @class.both1.should == 'hello'
+      @class.__send__(:instance_variable_get, :@both1).should == 'hello'
+      @class.__send__(:instance_variable_set, :@both1, 'world')
+      @class.both1.should == 'world'
+      @class.both2 = 5
+      @class.both2.should == 5
+      @class.__send__(:instance_variable_get, :@both2).should == 5
+      @class.__send__(:instance_variable_set, :@both2, 10)
+      @class.both2.should == 10
+    end
+  end
+
+  describe '#cattr_accessor_with_default' do
+    it 'creates reading and writing methods, but defaults the ivar value' do
+      @class.arr1.should == []
+      @class.__send__(:instance_variable_get, :@arr1).should == []
+      @class.arr1.should == [] # second invocation, after default value set
+      @class.arr1 = [1, 2]
+      @class.arr1.should == [1, 2]
+      @class.__send__(:instance_variable_get, :@arr1).should == [1, 2]
+    end
+  end
+
+  describe '#cattr_get_and_setter' do
+    before do
+      @base = Class.new do
+        extend ModuleExtensions
+        cattr_get_and_setter :type
+        type :silly
+      end
+    end
+
+    it 'acts a setter and getter on the base class' do
+      @base.type.should == :silly
+    end
+
+    it 'is not inherited' do
+      @derived = Class.new(@base)
+      @derived.type.should_not == :silly
+    end
+
+    it 'can be used by inherited classes' do
+      @derived = Class.new(@base) do
+        type :laughable
+      end
+      @derived.type.should == :laughable
+      @base.type.should == :silly
+    end
+
+    it 'turns a block into a proc and sets it' do
+      @derived = Class.new(@base) do
+        type { 5 + 3 }
+      end
+      @derived.type.call.should == 8
+    end
+  end
+end