slither 0.99.3 → 0.99.5

data/spec/generator_spec.rb

@@ -1,42 +0,0 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-    
-describe Slither::Generator do
-  before(:each) do
-    @definition = Slither.define :test do |d|
-      d.header do |h|
-        h.trap { |line| line[0,4] == 'HEAD' }
-        h.column :type, 4
-        h.column :file_id, 10
-      end
-      d.body do |b|
-        b.trap { |line| line[0,4] =~ /[^(HEAD|FOOT)]/ }
-        b.column :first, 10
-        b.column :last, 10
-      end
-      d.footer do |f|
-        f.trap { |line| line[0,4] == 'FOOT' }
-        f.column :type, 4
-        f.column :file_id, 10
-      end     
-    end
-    @data = {
-      :header => [ {:type => "HEAD", :file_id => "1" }],
-      :body => [ 
-        {:first => "Paul", :last => "Hewson" },
-        {:first => "Dave", :last => "Evans" }
-      ],
-      :footer => [ {:type => "FOOT", :file_id => "1" }]
-    }   
-    @generator = Slither::Generator.new(@definition)
-  end
-  
-  it "should raise an error if there is no data for a required section" do
-    @data.delete :header
-    lambda {  @generator.generate(@data) }.should raise_error(Slither::RequiredSectionEmptyError, "Required section 'header' was empty.")
-  end
-  
-  it "should generate a string" do
-    expected = "HEAD         1\n      Paul    Hewson\n      Dave     Evans\nFOOT         1"
-    @generator.generate(@data).should == expected
-  end 
-end

data/spec/parser_spec.rb

@@ -1,74 +0,0 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-    
-describe Slither::Parser do
-  before(:each) do
-    @definition = mock('definition', :sections => [])
-    @file = mock("file", :gets => nil)
-    @file_name = 'test.txt'
-    @parser = Slither::Parser.new(@definition, @file_name)
-  end
-  
-  it "should open and yield the source file" do
-    File.should_receive(:open).with(@file_name, 'r').and_yield(@file)
-    @parser.parse
-  end
-  
-  describe "when parsing sections" do
-    before(:each) do
-      @definition = Slither.define :test do |d|
-        d.header do |h|
-          h.trap { |line| line[0,4] == 'HEAD' }
-          h.column :type, 4
-          h.column :file_id, 10
-        end
-        d.body do |b|
-          b.trap { |line| line[0,4] =~ /[^(HEAD|FOOT)]/ }
-          b.column :first, 10
-          b.column :last, 10
-        end
-        d.footer do |f|
-          f.trap { |line| line[0,4] == 'FOOT' }
-          f.column :type, 4
-          f.column :file_id, 10
-        end     
-      end
-      File.should_receive(:open).with(@file_name, 'r').and_yield(@file)
-      @parser = Slither::Parser.new(@definition, @file_name)
-    end
-
-    it "should add lines to the proper sections" do
-      @file.should_receive(:gets).exactly(4).times.and_return(
-        'HEAD         1',
-        '      Paul    Hewson',
-        '      Dave     Evans',
-        'FOOT         1',
-        nil
-      )
-      expected = {
-        :header => [ {:type => "HEAD", :file_id => "1" }],
-        :body => [ 
-          {:first => "Paul", :last => "Hewson" },
-          {:first => "Dave", :last => "Evans" }
-        ],
-        :footer => [ {:type => "FOOT", :file_id => "1" }]
-      }      
-      result = @parser.parse
-      result.should == expected
-    end
-
-    it "should allow optional sections to be skipped" do
-      @definition.sections[0].optional = true
-      @definition.sections[2].optional = true
-      @file.should_receive(:gets).twice.and_return('      Paul    Hewson', nil)
-      expected = { :body => [ {:first => "Paul", :last => "Hewson" } ] }
-      @parser.parse.should == expected      
-    end
-      
-    it "should raise an error if a required section is not found" do
-      @file.should_receive(:gets).twice.and_return('      Ryan      Wood', nil)
-      lambda { @parser.parse }.should raise_error(Slither::RequiredSectionNotFoundError, "Required section 'header' was not found.")
-    end
-    
-    # it "raise an error if a section limit is over run"
-  end
-end

data/spec/section_spec.rb

@@ -1,146 +0,0 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-    
-describe Slither::Section do
-  before(:each) do
-    @section = Slither::Section.new(:body)
-  end
-  
-  it "should have no columns after creation" do
-    @section.columns.should be_empty
-  end
-  
-  it "should know it's reserved names" do
-    Slither::Section::RESERVED_NAMES.should == [:spacer]
-  end
-  
-  describe "when adding columns" do    
-    it "should build an ordered column list" do
-      @section.should have(0).columns
-    
-      col1 = @section.column :id, 10
-      col2 = @section.column :name, 30
-      col3 = @section.column :state, 2
-    
-      @section.should have(3).columns
-      @section.columns[0].should be(col1)
-      @section.columns[1].should be(col2)
-      @section.columns[2].should be(col3)
-    end
-  
-    it "should create spacer columns" do
-      @section.should have(0).columns
-      @section.spacer(5)
-      @section.should have(1).columns
-    end
-  
-    it "can should override the alignment of the definition" do
-      section = Slither::Section.new('name', :align => :left)
-      section.options[:align].should == :left
-    end
-    
-    it "should use a missing method to create a column" do
-      @section.should have(0).columns
-      @section.first_name 5
-      @section.should have(1).columns
-    end
-    
-    it "should prevent duplicate column names" do
-      @section.column :id, 10
-      lambda { @section.column(:id, 30) }.should raise_error(Slither::DuplicateColumnNameError, "You have already defined a column named 'id'.")
-    end
-    
-    it "should allow duplicate column names that are reserved (i.e. spacer)" do
-      @section.spacer 10
-      lambda { @section.spacer 10 }.should_not raise_error(Slither::DuplicateColumnNameError)
-    end    
-  end
-  
-  it "should accept and store the trap as a block" do
-    @section.trap { |v| v == 4 }
-    trap = @section.instance_variable_get(:@trap)
-    trap.should be_a(Proc)
-    trap.call(4).should == true
-  end
-  
-  describe "when adding a template" do
-    before(:each) do
-      @template = mock('templated section', :columns => [1,2,3], :options => {})
-      @definition = mock("definition", :templates => { :test => @template } )
-      @section.definition = @definition
-    end
-    
-    it "should ensure the template exists" do
-      @definition.stub! :templates => {}
-      lambda { @section.template(:none) }.should raise_error(ArgumentError)
-    end
-    
-    it "should add the template columns to the current column list" do
-      @section.template :test
-      @section.should have(3).columns
-    end
-    
-    it "should merge the template option" do
-       @section = Slither::Section.new(:body, :align => :left)
-       @section.definition = @definition
-       @template.stub! :options => {:align => :right}
-       @section.template :test
-       @section.options.should == {:align => :left}
-    end
-  end
-
-  describe "when formatting a row" do    
-    before(:each) do
-      @data = { :id => 3, :name => "Ryan" }
-    end
-    
-    it "should default to string data aligned right" do
-      @section.column(:id, 5)
-      @section.column(:name, 10)      
-      @section.format( @data ).should == "    3      Ryan"      
-    end
-    
-    it "should left align if asked" do
-      @section.column(:id, 5)
-      @section.column(:name, 10, :align => :left)  
-      @section.format(@data).should == "    3Ryan      "      
-    end
-    
-    # it "should raise an error if the data and column definitions aren't the same size" do
-    #   @section.column(:id, 5)
-    #   lambda { @section.format(@data) }.should raise_error(
-    #     Slither::ColumnMismatchError,
-    #     "The 'body' section has 1 column(s) defined, but there are 2 column(s) provided in the data."
-    #   )
-    # end
-  end
-  
-  describe "when parsing a file" do
-    before(:each) do
-      @line = '   45      Ryan      WoodSC '
-      @section = Slither::Section.new(:body)
-      @column_content = { :id => 5, :first => 10, :last => 10, :state => 2 }      
-    end
-    
-    it "should return a key for key column" do
-      @column_content.each { |k,v| @section.column(k, v) }
-      parsed = @section.parse(@line)
-      @column_content.each_key { |name| parsed.should have_key(name) }
-    end
-
-    it "should not return a key for reserved names" do
-      @column_content.each { |k,v| @section.column(k, v) }
-      @section.spacer 5
-      @section.should have(5).columns
-      parsed = @section.parse(@line)
-      parsed.should have(4).keys
-    end
-  end
-  
-  it "should try to match a line using the trap" do
-    @section.trap do |line|
-      line == 'hello'
-    end
-    @section.match('hello').should be_true
-    @section.match('goodbye').should be_false
-  end
-end

data/spec/slither_spec.rb

@@ -1,84 +0,0 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-describe Slither do
-  
-  before(:each) do
-    @name = :doc
-    @options = { :align => :left }
-  end
-  
-  describe "when defining a format" do
-    before(:each) do
-      @definition = mock('definition')
-    end
-  
-    it "should create a new definition using the specified name and options" do
-      Slither.should_receive(:define).with(@name, @options).and_return(@definition)
-      Slither.define(@name , @options)
-    end
-    
-    it "should pass the definition to the block" do
-      yielded = nil
-      Slither.define(@name) do |y|
-        yielded = y
-      end
-      yielded.should be_a( Slither::Definition )
-    end
-    
-    it "should add to the internal definition count" do
-      Slither.definitions.clear
-      Slither.should have(0).definitions
-      Slither.define(@name , @options) {}
-      Slither.should have(1).definitions
-    end
-  end
-  
-  describe "when creating file from data" do 
-    it "should raise an error if the definition name is not found" do
-      lambda { Slither.generate(:not_there, {}) }.should raise_error(ArgumentError)      
-    end
-    
-    it "should output a string" do
-      definition = mock('definition')
-      generator = mock('generator')
-      generator.should_receive(:generate).with({})
-      Slither.should_receive(:definition).with(:test).and_return(definition)
-      Slither::Generator.should_receive(:new).with(definition).and_return(generator)
-      Slither.generate(:test, {})
-    end
-    
-    it "should output a file" do
-  	  file = mock('file')
-  	  text = mock('string')
-  	  file.should_receive(:write).with(text)
-  	  File.should_receive(:open).with('file.txt', 'w').and_yield(file)
-  	  Slither.should_receive(:generate).with(:test, {}).and_return(text)
-      Slither.write('file.txt', :test, {})
-  	end       
-  end
-	
-  describe "when parsing a file" do
-    before(:each) do
-      @file_name = 'file.txt'
-    end
-    
-    it "should check the file exists" do
-      lambda { Slither.parse(@file_name, :test, {}) }.should raise_error(ArgumentError)
-    end
-    
-    it "should raise an error if the definition name is not found" do
-      Slither.definitions.clear
-      File.stub!(:exists? => true)
-      lambda { Slither.parse(@file_name, :test, {}) }.should raise_error(ArgumentError)      
-    end
-    
-    it "should create a parser and call parse" do
-      File.stub!(:exists? => true)
-      parser = mock("parser", :null_object => true)
-      definition = mock('definition')     
-      Slither.should_receive(:definition).with(:test).and_return(definition)
-      Slither::Parser.should_receive(:new).with(definition, @file_name).and_return(parser)      
-      Slither.parse(@file_name, :test)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,4 +0,0 @@
-require 'rubygems'
-require 'spec'
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'slither'))
- 

data/tasks/ann.rake

@@ -1,80 +0,0 @@
-
-begin
-  require 'bones/smtp_tls'
-rescue LoadError
-  require 'net/smtp'
-end
-require 'time'
-
-namespace :ann do
-
-  # A prerequisites task that all other tasks depend upon
-  task :prereqs
-
-  file PROJ.ann.file do
-    ann = PROJ.ann
-    puts "Generating #{ann.file}"
-    File.open(ann.file,'w') do |fd|
-      fd.puts("#{PROJ.name} version #{PROJ.version}")
-      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
-      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
-      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
-      fd.puts
-      fd.puts("== DESCRIPTION")
-      fd.puts
-      fd.puts(PROJ.description)
-      fd.puts
-      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
-      fd.puts
-      ann.paragraphs.each do |p|
-        fd.puts "== #{p.upcase}"
-        fd.puts
-        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
-        fd.puts
-      end
-      fd.puts ann.text if ann.text
-    end
-  end
-
-  desc "Create an announcement file"
-  task :announcement => ['ann:prereqs', PROJ.ann.file]
-
-  desc "Send an email announcement"
-  task :email => ['ann:prereqs', PROJ.ann.file] do
-    ann = PROJ.ann
-    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
-    to   = Array(ann.email[:to])
-
-    ### build a mail header for RFC 822
-    rfc822msg =  "From: #{from}\n"
-    rfc822msg << "To: #{to.join(',')}\n"
-    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
-    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
-    rfc822msg << "\n"
-    rfc822msg << "Date: #{Time.new.rfc822}\n"
-    rfc822msg << "Message-Id: "
-    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
-    rfc822msg << File.read(ann.file)
-
-    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
-      ann.email[key]
-    end
-
-    params[3] = PROJ.email if params[3].nil?
-
-    if params[4].nil?
-      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
-      params[4] = STDIN.gets.chomp
-    end
-
-    ### send email
-    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
-  end
-end  # namespace :ann
-
-desc 'Alias to ann:announcement'
-task :ann => 'ann:announcement'
-
-CLOBBER << PROJ.ann.file
-
-# EOF

data/tasks/bones.rake

@@ -1,20 +0,0 @@
-
-if HAVE_BONES
-
-namespace :bones do
-
-  desc 'Show the PROJ open struct'
-  task :debug do |t|
-    atr = if t.application.top_level_tasks.length == 2
-      t.application.top_level_tasks.pop
-    end
-
-    if atr then Bones::Debug.show_attr(PROJ, atr)
-    else Bones::Debug.show PROJ end
-  end
-
-end  # namespace :bones
-
-end  # HAVE_BONES
-
-# EOF

data/tasks/gem.rake

@@ -1,201 +0,0 @@
-
-require 'find'
-require 'rake/packagetask'
-require 'rubygems/user_interaction'
-require 'rubygems/builder'
-
-module Bones
-class GemPackageTask < Rake::PackageTask
-  # Ruby GEM spec containing the metadata for this package.  The
-  # name, version and package_files are automatically determined
-  # from the GEM spec and don't need to be explicitly provided.
-  #
-  attr_accessor :gem_spec
-
-  # Tasks from the Bones gem directory
-  attr_reader :bones_files
-
-  # Create a GEM Package task library.  Automatically define the gem
-  # if a block is given.  If no block is supplied, then +define+
-  # needs to be called to define the task.
-  #
-  def initialize(gem_spec)
-    init(gem_spec)
-    yield self if block_given?
-    define if block_given?
-  end
-
-  # Initialization tasks without the "yield self" or define
-  # operations.
-  #
-  def init(gem)
-    super(gem.name, gem.version)
-    @gem_spec = gem
-    @package_files += gem_spec.files if gem_spec.files
-    @bones_files = []
-
-    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
-    if !test(?e, local_setup)
-      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
-    end
-  end
-
-  # Create the Rake tasks and actions specified by this
-  # GemPackageTask.  (+define+ is automatically called if a block is
-  # given to +new+).
-  #
-  def define
-    super
-    task :prereqs
-    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
-    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
-      when_writing("Creating GEM") {
-        chdir(package_dir_path) do
-          Gem::Builder.new(gem_spec).build
-          verbose(true) {
-            mv gem_file, "../#{gem_file}"
-          }
-        end
-      }
-    end
-
-    file package_dir_path => bones_files do
-      mkdir_p package_dir rescue nil
-
-      gem_spec.files = (gem_spec.files +
-          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
-
-      bones_files.each do |fn|
-        base_fn = File.join('tasks', File.basename(fn))
-        f = File.join(package_dir_path, base_fn)
-        fdir = File.dirname(f)
-        mkdir_p(fdir) if !File.exist?(fdir)
-        if File.directory?(fn)
-          mkdir_p(f)
-        else
-          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
-          safe_ln(fn, f)
-        end
-      end
-    end
-  end
-  
-  def gem_file
-    if @gem_spec.platform == Gem::Platform::RUBY
-      "#{package_name}.gem"
-    else
-      "#{package_name}-#{@gem_spec.platform}.gem"
-    end
-  end
-end  # class GemPackageTask
-end  # module Bones
-
-namespace :gem do
-
-  PROJ.gem._spec = Gem::Specification.new do |s|
-    s.name = PROJ.name
-    s.version = PROJ.version
-    s.summary = PROJ.summary
-    s.authors = Array(PROJ.authors)
-    s.email = PROJ.email
-    s.homepage = Array(PROJ.url).first
-    s.rubyforge_project = PROJ.rubyforge.name
-
-    s.description = PROJ.description
-
-    PROJ.gem.dependencies.each do |dep|
-      s.add_dependency(*dep)
-    end
-
-    PROJ.gem.development_dependencies.each do |dep|
-      s.add_development_dependency(*dep)
-    end
-
-    s.files = PROJ.gem.files
-    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
-    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
-
-    s.bindir = 'bin'
-    dirs = Dir["{#{PROJ.libs.join(',')}}"]
-    s.require_paths = dirs unless dirs.empty?
-
-    incl = Regexp.new(PROJ.rdoc.include.join('|'))
-    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
-    excl = Regexp.new(excl.join('|'))
-    rdoc_files = PROJ.gem.files.find_all do |fn|
-                   case fn
-                   when excl; false
-                   when incl; true
-                   else false end
-                 end
-    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
-    s.extra_rdoc_files = rdoc_files
-    s.has_rdoc = true
-
-    if test ?f, PROJ.test.file
-      s.test_file = PROJ.test.file
-    else
-      s.test_files = PROJ.test.files.to_a
-    end
-
-    # Do any extra stuff the user wants
-    PROJ.gem.extras.each do |msg, val|
-      case val
-      when Proc
-        val.call(s.send(msg))
-      else
-        s.send "#{msg}=", val
-      end
-    end
-  end  # Gem::Specification.new
-
-  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
-    pkg.need_tar = PROJ.gem.need_tar
-    pkg.need_zip = PROJ.gem.need_zip
-  end
-
-  desc 'Show information about the gem'
-  task :debug => 'gem:prereqs' do
-    puts PROJ.gem._spec.to_ruby
-  end
-
-  desc 'Write the gemspec '
-  task :spec => 'gem:prereqs' do
-    File.open("#{PROJ.name}.gemspec", 'w') do |f|
-      f.write PROJ.gem._spec.to_ruby
-    end
-  end
-
-  desc 'Install the gem'
-  task :install => [:clobber, 'gem:package'] do
-    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
-
-    # use this version of the command for rubygems > 1.0.0
-    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
-  end
-
-  desc 'Uninstall the gem'
-  task :uninstall do
-    installed_list = Gem.source_index.find_name(PROJ.name)
-    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
-      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
-    end
-  end
-
-  desc 'Reinstall the gem'
-  task :reinstall => [:uninstall, :install]
-
-  desc 'Cleanup the gem'
-  task :cleanup do
-    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
-  end
-end  # namespace :gem
-
-
-desc 'Alias to gem:package'
-task :gem => 'gem:package'
-
-task :clobber => 'gem:clobber_package'
-remove_desc_for_task 'gem:clobber_package'
-
-# EOF

data/tasks/git.rake

@@ -1,40 +0,0 @@
-
-if HAVE_GIT
-
-namespace :git do
-
-  # A prerequisites task that all other tasks depend upon
-  task :prereqs
-
-  desc 'Show tags from the Git repository'
-  task :show_tags => 'git:prereqs' do |t|
-    puts %x/git tag/
-  end
-
-  desc 'Create a new tag in the Git repository'
-  task :create_tag => 'git:prereqs' do |t|
-    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
-    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
-
-    tag = "%s-%s" % [PROJ.name, PROJ.version]
-    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
-
-    puts "Creating Git tag '#{tag}'"
-    unless system "git tag -a -m '#{msg}' #{tag}"
-      abort "Tag creation failed"
-    end
-
-    if %x/git remote/ =~ %r/^origin\s*$/
-      unless system "git push origin #{tag}"
-        abort "Could not push tag to remote Git repository"
-      end
-    end
-  end
-
-end  # namespace :git
-
-task 'gem:release' => 'git:create_tag'
-
-end  # if HAVE_GIT
-
-# EOF