adhearsion-loquacious 1.9.2

data/spec/help_spec.rb

@@ -0,0 +1,369 @@
+
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Loquacious::Configuration::Help do
+
+  before :all do
+    @sio = StringIO.new
+  end
+
+  before :each do
+    @config = Loquacious.configuration_for 'specs'
+    @help = Loquacious::Configuration::Help.new 'specs', :io => @sio
+    @sio.clear
+  end
+
+  it "returns a help object by name" do
+    help = Loquacious::Configuration::Help.new 'specs'
+    config = help.instance_variable_get(:@config)
+    config.equal?(@config).should be_true
+  end
+
+  it "returns a help object for a configuration" do
+    help = Loquacious::Configuration::Help.new @config
+    config = help.instance_variable_get(:@config)
+    config.equal?(@config).should be_true
+  end
+
+  it "raises an error for invalid attribute names" do
+    lambda {@help.show(42)}.should raise_error(
+        Loquacious::Configuration::Help::Error,
+        "cannot convert 42 into an attribute identifier"
+    )
+  end
+
+  it "prints out all attribues" do
+    str = <<-OUTPUT
+    | foo method
+    |  - first
+    |
+    | bar method
+    |  - second
+    |
+    | the third group
+    |  - third
+    |
+    | life the universe and everything
+    |  - third.answer
+    |
+    | perhaps you do not understand
+    |  - third.question
+    |
+    OUTPUT
+
+    @help.show_all
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "prints out a specific attribute" do
+    str = <<-OUTPUT
+    | bar method
+    |  - second
+    |
+    OUTPUT
+    @help.show_attribute :second
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "properly parses nested attributes" do
+    str = <<-OUTPUT
+    | the third group
+    |  - third
+    |
+    | life the universe and everything
+    |  - third.answer
+    |
+    | perhaps you do not understand
+    |  - third.question
+    |
+    OUTPUT
+    @help.show_attribute 'third'
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+    str = <<-OUTPUT
+    | perhaps you do not understand
+    |  - third.question
+    |
+    OUTPUT
+    @help.show_attribute %w[third question]
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+    str = <<-OUTPUT
+    | life the universe and everything
+    |  - third.answer
+    |
+    OUTPUT
+    @help.show_attribute 'third.answer'
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "hides nesting attributes" do
+    help = Loquacious::Configuration::Help.new @config, :nesting_nodes => false, :io => @sio
+
+    str = <<-OUTPUT
+    | foo method
+    |  - first
+    |
+    | bar method
+    |  - second
+    |
+    | life the universe and everything
+    |  - third.answer
+    |
+    | perhaps you do not understand
+    |  - third.question
+    |
+    OUTPUT
+
+    help.show_all
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+    str = <<-OUTPUT
+    | life the universe and everything
+    |  - third.answer
+    |
+    | perhaps you do not understand
+    |  - third.question
+    |
+    OUTPUT
+    help.show_attribute 'third'
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+  end
+
+  it "preserves indentation for descriptions" do
+    Loquacious.configuration_for('specs') do
+      desc <<-DESC
+      This is a multiline description that has an example.
+      |
+      |   foo = %w[one two three]
+      |
+      See, the example is right above this line.
+      Hope it was instructive.
+      DESC
+      fourth 'the fourth value'
+    end
+
+    str = <<-OUTPUT
+    | This is a multiline description that has an example.
+    | 
+    |    foo = %w[one two three]
+    | 
+    | See, the example is right above this line.
+    | Hope it was instructive.
+    |  - fourth
+    |
+    OUTPUT
+    @help.show_attribute 'fourth'
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "pretty prints values" do
+    str = <<-OUTPUT
+    | foo method
+    |  - first          => "foo"
+    |
+    | bar method
+    |  - second         => "bar"
+    |
+    | the third group
+    |  - third
+    |
+    | life the universe and everything
+    |  - third.answer   => 42
+    |
+    | perhaps you do not understand
+    |  - third.question => :symbol
+    |
+    OUTPUT
+    @help.show :values => true
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "closely packs attributes when descriptions are omitted" do
+    str = <<-OUTPUT
+    |  - first          => "foo"
+    |  - second         => "bar"
+    |  - third
+    |  - third.answer   => 42
+    |  - third.question => :symbol
+    OUTPUT
+    @help.show_all :values => true, :descriptions => false
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "automatically picks up changes to the configuration" do
+    Loquacious.configuration_for('specs') do
+      fifth 'foo', :desc => 'the fifth configuration setting'
+    end
+
+    str = <<-OUTPUT
+    | the fifth configuration setting
+    |  - fifth
+    |
+    OUTPUT
+    @help.show_attribute 'fifth'
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "uses a custom name leader" do
+    help = Loquacious.help_for 'specs', :io => @sio, :name_leader => ' ## '
+    str = <<-OUTPUT
+    | foo method
+    | ## first
+    |
+    | bar method
+    | ## second
+    |
+    | the third group
+    | ## third
+    |
+    | life the universe and everything
+    | ## third.answer
+    |
+    | perhaps you do not understand
+    | ## third.question
+    |
+    OUTPUT
+    help.show_all
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+    str = <<-OUTPUT
+    | ## first          => "foo"
+    | ## second         => "bar"
+    | ## third
+    | ## third.answer   => 42
+    | ## third.question => :symbol
+    OUTPUT
+    help.show_all :values => true, :descriptions => false
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "uses a custom name length" do
+    help = Loquacious.help_for 'specs', :io => @sio, :name_length => 10
+    str = <<-OUTPUT
+    | foo method
+    |  - first
+    |
+    | bar method
+    |  - second
+    |
+    | the third group
+    |  - third
+    |
+    | life the universe and everything
+    |  - thir...wer
+    |
+    | perhaps you do not understand
+    |  - thir...ion
+    |
+    OUTPUT
+    help.show_all
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+    str = <<-OUTPUT
+    |  - first      => "foo"
+    |  - second     => "bar"
+    |  - third
+    |  - thir...wer => 42
+    |  - thir...ion => :symbol
+    OUTPUT
+    help.show_all :values => true, :descriptions => false
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "uses a custom name/value separator" do
+    help = Loquacious.help_for 'specs', :io => @sio, :name_value_sep => ' :: '
+    str = <<-OUTPUT
+    | foo method
+    |  - first          :: "foo"
+    |
+    | bar method
+    |  - second         :: "bar"
+    |
+    | the third group
+    |  - third
+    |
+    | life the universe and everything
+    |  - third.answer   :: 42
+    |
+    | perhaps you do not understand
+    |  - third.question :: :symbol
+    |
+    OUTPUT
+    help.show_all :values => true
+    @sio.to_s.should be == str.gutter!
+
+    @sio.clear
+    str = <<-OUTPUT
+    |  - first          :: "foo"
+    |  - second         :: "bar"
+    |  - third
+    |  - third.answer   :: 42
+    |  - third.question :: :symbol
+    OUTPUT
+    help.show_all :values => true, :descriptions => false
+    @sio.to_s.should be == str.gutter!
+  end
+
+  it "uses a custom description leader" do
+    Loquacious.configuration_for('specs') do
+      desc <<-DESC
+      This is a multiline description that has an example.
+      |
+      |   foo = %w[one two three]
+      |
+      See, the example is right above this line.
+      Hope it was instructive.
+      DESC
+      fourth 'the fourth value'
+    end
+
+    help = Loquacious.help_for 'specs', :io => @sio, :desc_leader => '~'
+    str = <<-OUTPUT
+    |~foo method
+    |  - first          => "foo"
+    |
+    |~This is a multiline description that has an example.
+    |~
+    |~   foo = %w[one two three]
+    |~
+    |~See, the example is right above this line.
+    |~Hope it was instructive.
+    |  - fourth         => "the fourth value"
+    |
+    |~bar method
+    |  - second         => "bar"
+    |
+    |~the third group
+    |  - third
+    |
+    |~life the universe and everything
+    |  - third.answer   => 42
+    |
+    |~perhaps you do not understand
+    |  - third.question => :symbol
+    |
+    OUTPUT
+    help.show_all :values => true
+    @sio.to_s.should be == str.gutter!
+
+  end
+  it "prints out a specific attribute" do
+    Loquacious.env_config = true
+    str = <<-OUTPUT
+    | bar method [LOQ_SPECS_SECOND]
+    |  - second
+    |
+    OUTPUT
+    @help.show_attribute :second
+    @sio.to_s.should be == str.gutter!
+    Loquacious.env_config = false
+  end
+end

data/spec/iterator_spec.rb

@@ -0,0 +1,70 @@
+
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Loquacious::Configuration::Iterator do
+
+  before(:each) do
+    @config = Loquacious.configuration_for 'specs'
+    @iterator = Loquacious::Configuration::Iterator.new(@config)
+  end
+
+  it 'should find a particular attribute' do
+    node = @iterator.find 'first'
+    node.name.should be == 'first'
+    node.key.should be == :first
+    node.desc.should be == 'foo method'
+    node.obj.should be == 'foo'
+    node.config?.should be == false
+
+    node = @iterator.find :third
+    node.name.should be == 'third'
+    node.key.should be == :third
+    node.desc.should be == 'the third group'
+    node.config?.should be == true
+
+    node = @iterator.find('third.answer')
+    node.name.should be == 'third.answer'
+    node.key.should be == :answer
+    node.desc.should be == 'life the universe and everything'
+    node.obj.should be == 42
+    node.config?.should be == false
+  end
+
+  it 'should return nil for unknown attributes' do
+    @iterator.find('last').should be_nil
+    @iterator.find('last.first.none').should be_nil
+    @iterator.find('third.none').should be_nil
+    @iterator.find(:foo).should be_nil
+  end
+
+  it 'should iterate over all attributes' do
+    ary = Array.new
+    @iterator.each {|n| ary << n.name}
+
+    ary.should be == %w{first second third third.answer third.question}
+  end
+
+  it 'should iterate over nested attributes if given' do
+    ary = Array.new
+    @iterator.each('third') {|n| ary << n.name}
+    ary.should be == %w{third third.answer third.question}
+
+    ary.clear
+    @iterator.each('first') {|n| ary << n.name}
+    ary.should be == %w{first}
+
+    ary.clear
+    @iterator.each('not_here') {|n| ary << n.name}
+    ary.should be_empty
+  end
+
+  it 'should ignore undefined nodes' do
+    @config.does_not_exist.foo  # this creates a Loquacious::Undefined node
+    @config.does_not_exist.kind_of?(::Loquacious::Undefined).should be_true
+
+    ary = Array.new
+    @iterator.each {|n| ary << n.name}
+    ary.should be == %w{first second third third.answer third.question}
+  end
+end
+# EOF

data/spec/loquacious_spec.rb

@@ -0,0 +1,76 @@
+
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Loquacious do
+  before(:all) do
+    @root_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+
+  it "should report a version number" do
+    Loquacious.version.should match(%r/\d+\.\d+\.\d+/)
+  end
+
+  it "finds things releative to 'lib'" do
+    Loquacious.libpath(%w[loquacious config.rb]).should be == File.join(@root_dir, %w[lib loquacious config.rb])
+  end
+
+  it "finds things releative to 'root'" do
+    Loquacious.path('Rakefile').should be == File.join(@root_dir, 'Rakefile')
+  end
+
+  describe "when copying configuration objects" do
+    it "creates a deep copy" do
+      obj = Loquacious::Configuration.new  {
+              first   'foo'
+              second  {
+                bar   'baz'
+              }
+            }
+
+      copy = Loquacious.copy obj
+      copy.first = 'foobar'
+      copy.second.bar = 'buz'
+
+      obj.first.eql?('foo').should be_true
+      obj.second.bar.eql?('baz').should be_true
+      copy.first.eql?('foobar').should be_true
+      copy.second.bar.eql?('buz').should be_true
+    end
+
+    it "looks up a configuration object by name" do
+      Loquacious.config_for('by name') {
+        first   'foo'
+        second  {
+          bar   'baz'
+        }
+      }
+
+      copy = Loquacious.copy('by name')
+      copy.first.eql?('foo').should be_true
+      copy.second.bar.eql?('baz').should be_true
+    end
+
+    it "returns nil when a configuration object cannot be found" do
+      Loquacious.copy('does not exist').eql?(nil).should be_true
+    end
+
+    it "overrides options with a block" do
+      Loquacious.config_for('another by name') {
+        first   'foo'
+        second  {
+          bar   'baz'
+        }
+      }
+
+      copy = Loquacious.copy('another by name') {
+        second { bar 'foobar' }
+        third "hey I'm new"
+      }
+
+      copy.first.eql?('foo').should be_true
+      copy.second.bar.eql?('foobar').should be_true
+      copy.third.eql?("hey I'm new").should be_true
+    end
+  end
+end
+