cuke_modeler 0.0.1

data/spec/integration/tag_integration_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+SimpleCov.command_name('Tag') unless RUBY_VERSION.to_s < '1.9.0'
+
+describe 'Tag, Integration' do
+
+  context 'getting stuff' do
+
+    before(:each) do
+      source = ['@feature_tag',
+                'Feature: Test feature',
+                '',
+                '  Scenario Outline: Test test',
+                '    * a step',
+                '',
+                '  @example_tag',
+                '  Examples: Test example',
+                '    | a param |']
+      source = source.join("\n")
+
+      file_path = "#{@default_file_directory}/tag_test_file.feature"
+      File.open(file_path, 'w') { |file| file.write(source) }
+
+      @directory = CukeModeler::Directory.new(@default_file_directory)
+      @tag = @directory.feature_files.first.features.first.tests.first.examples.first.tag_elements.first
+      @high_level_tag = @directory.feature_files.first.features.first.tag_elements.first
+    end
+
+
+    it 'can get its directory' do
+      directory = @tag.get_ancestor(:directory)
+
+      directory.should equal @directory
+    end
+
+    it 'can get its feature file' do
+      feature_file = @tag.get_ancestor(:feature_file)
+
+      feature_file.should equal @directory.feature_files.first
+    end
+
+    it 'can get its feature' do
+      feature = @tag.get_ancestor(:feature)
+
+      feature.should equal @directory.feature_files.first.features.first
+    end
+
+    it 'can get its test' do
+      test = @tag.get_ancestor(:test)
+
+      test.should equal @directory.feature_files.first.features.first.tests.first
+    end
+
+    it 'can get its example' do
+      example = @tag.get_ancestor(:example)
+
+      example.should equal @directory.feature_files.first.features.first.tests.first.examples.first
+    end
+
+    it 'returns nil if it does not have the requested type of ancestor' do
+      example = @high_level_tag.get_ancestor(:example)
+
+      example.should be_nil
+    end
+
+  end
+end

data/spec/integration/world_integration_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+SimpleCov.command_name('World') unless RUBY_VERSION.to_s < '1.9.0'
+
+describe 'World, Integration' do
+
+  before(:each) do
+    @world = CukeModeler::World
+    @world.loaded_step_patterns.clear
+  end
+
+  # Nothing left to do here for now.
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov' unless RUBY_VERSION.to_s < '1.9.0'
+
+
+require "#{File.dirname(__FILE__)}/../lib/cuke_modeler"
+
+require "#{File.dirname(__FILE__)}/unit/feature_element_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/nested_element_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/tagged_element_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/containing_element_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/bare_bones_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/test_element_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/prepopulated_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/sourced_element_unit_specs"
+require "#{File.dirname(__FILE__)}/unit/raw_element_unit_specs"
+
+RSpec.configure do |config|
+  config.before(:all) do
+    @default_file_directory = "#{File.dirname(__FILE__)}/temp_files"
+    @default_feature_file_name = 'test_feature.feature'
+  end
+
+  config.before(:each) do
+    FileUtils.mkdir(@default_file_directory)
+  end
+
+  config.after(:each) do
+    FileUtils.remove_dir(@default_file_directory, true)
+  end
+end
+

data/spec/unit/background_unit_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+SimpleCov.command_name('Background') unless RUBY_VERSION.to_s < '1.9.0'
+
+describe 'Background, Unit' do
+
+  clazz = CukeModeler::Background
+
+  it_should_behave_like 'a feature element', clazz
+  it_should_behave_like 'a nested element', clazz
+  it_should_behave_like 'a containing element', clazz
+  it_should_behave_like 'a bare bones element', clazz
+  it_should_behave_like 'a prepopulated element', clazz
+  it_should_behave_like 'a test element', clazz
+  it_should_behave_like 'a sourced element', clazz
+  it_should_behave_like 'a raw element', clazz
+
+  it 'can be parsed from stand alone text' do
+    source = 'Background: test background'
+
+    expect { @element = clazz.new(source) }.to_not raise_error
+
+    # Sanity check in case instantiation failed in a non-explosive manner
+    @element.name.should == 'test background'
+  end
+
+  context 'background output edge cases' do
+
+    before(:each) do
+      @background = clazz.new
+    end
+
+    it 'is a String' do
+      @background.to_s.should be_a(String)
+    end
+
+    it 'can output an empty background' do
+      expect { @background.to_s }.to_not raise_error
+    end
+
+    it 'can output a background that has only a name' do
+      @background.name = 'a name'
+
+      expect { @background.to_s }.to_not raise_error
+    end
+
+    it 'can output a background that has only a description' do
+      @background.description_text = 'a description'
+
+      expect { @background.to_s }.to_not raise_error
+    end
+
+  end
+
+end

data/spec/unit/bare_bones_unit_specs.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+shared_examples_for 'a bare bones element' do |clazz|
+
+  before(:each) do
+    @element = clazz.new
+  end
+
+  it 'can be initialized empty' do
+    expect { clazz.new }.to_not raise_error
+  end
+
+end

data/spec/unit/containing_element_unit_specs.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+shared_examples_for 'a containing element' do |clazz|
+
+  before(:each) do
+    @element = clazz.new
+  end
+
+  it 'has children - #contains' do
+    @element.should respond_to(:contains)
+  end
+
+  it 'returns a collection of children - #contains' do
+    @element.contains.is_a?(Array).should be_true
+  end
+
+end

data/spec/unit/directory_unit_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+SimpleCov.command_name('Directory') unless RUBY_VERSION.to_s < '1.9.0'
+
+describe 'Directory, Unit' do
+
+  clazz = CukeModeler::Directory
+
+  it_should_behave_like 'a nested element', clazz
+  it_should_behave_like 'a containing element', clazz
+  it_should_behave_like 'a bare bones element', clazz
+  it_should_behave_like 'a prepopulated element', clazz
+
+  before(:each) do
+    @directory = clazz.new
+  end
+
+  it 'cannot model a non-existent directory' do
+    path = "#{@default_file_directory}/missing_directory"
+
+    expect { CukeModeler::Directory.new(path) }.to raise_error(ArgumentError)
+  end
+
+  it 'knows the name of the directory that it is modeling' do
+    path = "#{@default_file_directory}"
+
+    directory = CukeModeler::Directory.new(path)
+
+    directory.name.should == 'temp_files'
+  end
+
+  it 'knows the path of the directory that it is modeling' do
+    path = "#{@default_file_directory}"
+
+    directory = CukeModeler::Directory.new(path)
+
+    directory.path.should == path
+  end
+
+  it 'has feature files - #feature_files' do
+    @directory.should respond_to(:feature_files)
+  end
+
+  it 'can get and set its feature files - #feature_files, #feature_files=' do
+    @directory.feature_files = :some_feature_files
+    @directory.feature_files.should == :some_feature_files
+    @directory.feature_files = :some_other_feature_files
+    @directory.feature_files.should == :some_other_feature_files
+  end
+
+  it 'knows how many feature files it has - #feature_file_count' do
+    @directory.feature_files = [:file_1, :file_2, :file_3]
+
+    @directory.feature_file_count.should == 3
+  end
+
+  it 'has directories - #directories' do
+    @directory.should respond_to(:directories)
+  end
+
+  it 'can get and set its directories - #directories, #directories=' do
+    @directory.directories = :some_directories
+    @directory.directories.should == :some_directories
+    @directory.directories = :some_other_directories
+    @directory.directories.should == :some_other_directories
+  end
+
+  it 'knows how many directories it has - #directory_count' do
+    @directory.directories = [:directory_1, :directory_2, :directory_3]
+
+    @directory.directory_count.should == 3
+  end
+
+  it 'starts with no feature files or directories' do
+    @directory.feature_files.should == []
+    @directory.directories.should == []
+  end
+
+  it 'contains feature files and directories' do
+    directories = [:directory_1, :directory_2, :directory_3]
+    files = [:file_1, :file_2, :file_3]
+    everything = files + directories
+
+    @directory.directories = directories
+    @directory.feature_files = files
+
+    @directory.contains.should =~ everything
+  end
+
+  context 'directory output edge cases' do
+
+    it 'is a String' do
+      @directory.to_s.should be_a(String)
+    end
+
+    it 'can output an empty directory' do
+      expect { @directory.to_s }.to_not raise_error
+    end
+
+  end
+
+end
+

data/spec/unit/doc_string_unit_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+SimpleCov.command_name('DocString') unless RUBY_VERSION.to_s < '1.9.0'
+
+describe 'DocString, Unit' do
+
+  clazz = CukeModeler::DocString
+
+  it_should_behave_like 'a nested element', clazz
+  it_should_behave_like 'a bare bones element', clazz
+  it_should_behave_like 'a prepopulated element', clazz
+  it_should_behave_like 'a raw element', clazz
+
+  it 'can be parsed from stand alone text' do
+    source = "\"\"\"\nsome doc string\n\"\"\""
+
+    expect { @element = clazz.new(source) }.to_not raise_error
+
+    # Sanity check in case instantiation failed in a non-explosive manner
+    @element.contents_text.should == "some doc string"
+    #todo Remove once Array contents is no longer supported
+    @element.contents.should == ["some doc string"]
+  end
+
+  before(:each) do
+    @doc_string = clazz.new
+  end
+
+  it 'has a content type - #content_type' do
+    @doc_string.should respond_to(:content_type)
+  end
+
+  it 'can get and set its content type - #content_type, #content_type=' do
+    @doc_string.content_type = :some_content_type
+    @doc_string.content_type.should == :some_content_type
+    @doc_string.content_type = :some_other_content_type
+    @doc_string.content_type.should == :some_other_content_type
+  end
+
+  it 'starts with no content type' do
+    @doc_string.content_type.should == nil
+  end
+
+  it 'has contents' do
+    #todo Remove once Array contents is no longer supported
+    @doc_string.should respond_to(:contents)
+    @doc_string.should respond_to(:contents_text)
+  end
+
+  it 'can get and set its contents' do
+    #todo Remove once Array contents is no longer supported
+    @doc_string.contents = :some_contents
+    @doc_string.contents.should == :some_contents
+    @doc_string.contents = :some_other_contents
+    @doc_string.contents.should == :some_other_contents
+
+    @doc_string.contents_text = :some_contents
+    @doc_string.contents_text.should == :some_contents
+    @doc_string.contents_text = :some_other_contents
+    @doc_string.contents_text.should == :some_other_contents
+  end
+
+  it 'starts with no contents' do
+    #todo Remove once Array contents is no longer supported
+    @doc_string.contents.should == []
+    @doc_string.contents_text.should == ''
+  end
+
+  #todo Remove once Array contents is no longer supported
+  it 'stores its contents as an array of strings - deprecated' do
+    source = "\"\"\"\nsome text\nsome more text\n\"\"\""
+    doc_string = CukeModeler::DocString.new(source)
+
+    contents = doc_string.contents
+
+    contents.is_a?(Array).should be_true
+    contents.each do |line|
+      line.is_a?(String).should be_true
+    end
+  end
+
+  it 'stores its contents as a String' do
+    source = "\"\"\"\nsome text\nsome more text\n\"\"\""
+    doc_string = clazz.new(source)
+
+    contents = doc_string.contents_text
+
+    contents.is_a?(String).should be_true
+  end
+
+  context 'doc string output edge cases' do
+
+    it 'is a String' do
+      @doc_string.to_s.should be_a(String)
+    end
+
+    it 'can output an empty doc string' do
+      expect { @doc_string.to_s }.to_not raise_error
+    end
+
+    it 'can output a doc string that has only a content type' do
+      @doc_string.content_type = 'some type'
+
+      expect { @doc_string.to_s }.to_not raise_error
+    end
+
+  end
+
+end

data/spec/unit/example_unit_spec.rb

@@ -0,0 +1,251 @@
+require 'spec_helper'
+
+SimpleCov.command_name('Example') unless RUBY_VERSION.to_s < '1.9.0'
+
+describe 'Example, Unit' do
+
+  clazz = CukeModeler::Example
+
+  it_should_behave_like 'a feature element', clazz
+  it_should_behave_like 'a nested element', clazz
+  it_should_behave_like 'a tagged element', clazz
+  it_should_behave_like 'a bare bones element', clazz
+  it_should_behave_like 'a prepopulated element', clazz
+  it_should_behave_like 'a sourced element', clazz
+  it_should_behave_like 'a containing element', clazz
+  it_should_behave_like 'a raw element', clazz
+
+
+  it 'can be parsed from stand alone text' do
+    source = ['Examples: test example',
+              '|param| ']
+
+    source = source.join("\n")
+
+    expect { @element = clazz.new(source) }.to_not raise_error
+
+    # Sanity check in case instantiation failed in a non-explosive manner
+    @element.name.should == 'test example'
+  end
+
+
+  before(:each) do
+    @example = clazz.new
+  end
+
+
+  it 'has parameters - #parameters' do
+    @example.should respond_to(:parameters)
+  end
+
+  it 'can get and set its parameters - #parameters, #parameters=' do
+    @example.parameters = :some_parameters
+    @example.parameters.should == :some_parameters
+    @example.parameters = :some_other_parameters
+    @example.parameters.should == :some_other_parameters
+  end
+
+  it 'starts with no parameters' do
+    @example.parameters.should == []
+  end
+
+  it 'has rows - #rows' do
+    @example.should respond_to(:rows)
+  end
+
+  #todo - remove once Hash rows are no longer supported
+  it 'can get and set its rows - #rows, #rows=' do
+    @example.rows = :some_rows
+    @example.rows.should == :some_rows
+    @example.rows = :some_other_rows
+    @example.rows.should == :some_other_rows
+  end
+
+  #todo - remove once Hash rows are no longer supported
+  it 'starts with no rows' do
+    @example.rows.should == []
+  end
+
+  #todo - remove once Hash rows are no longer supported
+  it 'stores its rows as an nested array of hashes' do
+    source = "Examples:\n|param1|param2|\n|value1|value2|"
+    example = CukeModeler::Example.new(source)
+
+    rows = example.rows
+
+    rows.is_a?(Array).should be_true
+    rows.empty?.should be_false
+    rows.each { |row| row.is_a?(Hash).should be_true }
+  end
+
+  it 'does not include the parameter row as a row' do
+    source = "Examples:\n|param1|param2|\n|value1|value2|\n|value3|value4|"
+    example = CukeModeler::Example.new(source)
+
+    rows = example.rows
+
+    rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}]
+  end
+
+  it 'has row elements - #row_elements' do
+    @example.should respond_to(:row_elements)
+  end
+
+  it 'can get and set its row elements - #row_elements, #row_elements=' do
+    @example.row_elements = :some_row_elements
+    @example.row_elements.should == :some_row_elements
+    @example.row_elements = :some_other_row_elements
+    @example.row_elements.should == :some_other_row_elements
+  end
+
+  it 'starts with no row elements' do
+    @example.row_elements.should == []
+  end
+
+  context '#add_row' do
+
+    it 'can add a new example row' do
+      clazz.new.should respond_to(:add_row)
+    end
+
+    it 'can add a new row as a hash' do
+      source = "Examples:\n|param1|param2|\n|value1|value2|"
+      example = CukeModeler::Example.new(source)
+
+      new_row = {'param1' => 'value3', 'param2' => 'value4'}
+      example.add_row(new_row)
+
+      #todo - remove once Hash rows are no longer supported
+      example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}]
+      example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2'], ['value3', 'value4']]
+    end
+
+    it 'can add a new row as an array' do
+      source = "Examples:\n|param1|param2|\n|value1|value2|"
+      example = CukeModeler::Example.new(source)
+
+      new_row = ['value3', 'value4']
+      example.add_row(new_row)
+
+      #todo - remove once Hash rows are no longer supported
+      example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}]
+      example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2'], ['value3', 'value4']]
+    end
+
+    it 'can only use a Hash or an Array to add a new row' do
+      expect { @example.add_row({}) }.to_not raise_error
+      expect { @example.add_row([]) }.to_not raise_error
+      expect { @example.add_row(:a_row) }.to raise_error(ArgumentError)
+    end
+
+    it 'trims whitespace from added rows' do
+      source = "Examples:\n|param1|param2|\n|value1|value2|"
+      example = CukeModeler::Example.new(source)
+
+      hash_row = {'param1' => 'value3  ', 'param2' => '  value4'}
+      array_row = ['value5', ' value6 ']
+      example.add_row(hash_row)
+      example.add_row(array_row)
+
+      #todo - remove once Hash rows are no longer supported
+      example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}, {'param1' => 'value5', 'param2' => 'value6'}]
+      example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2'], ['value3', 'value4'], ['value5', 'value6']]
+    end
+  end
+
+  context '#remove_row' do
+
+    it 'can remove an existing example row' do
+      clazz.new.should respond_to(:remove_row)
+    end
+
+    it 'can remove an existing row as a hash' do
+      source = "Examples:\n|param1|param2|\n|value1|value2|\n|value3|value4|"
+      example = CukeModeler::Example.new(source)
+
+      old_row = {'param1' => 'value3', 'param2' => 'value4'}
+      example.remove_row(old_row)
+
+      #todo - remove once Hash rows are no longer supported
+      example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}]
+      example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2']]
+    end
+
+    it 'can remove an existing row as an array' do
+      source = "Examples:\n|param1|param2|\n|value1|value2|\n|value3|value4|"
+      example = CukeModeler::Example.new(source)
+
+      old_row = ['value3', 'value4']
+      example.remove_row(old_row)
+
+      #todo - remove once Hash rows are no longer supported
+      example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}]
+      example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2']]
+    end
+
+    it 'can only use a Hash or an Array to remove an existing row' do
+      expect { @example.remove_row({}) }.to_not raise_error
+      expect { @example.remove_row([]) }.to_not raise_error
+      expect { @example.remove_row(:a_row) }.to raise_error(ArgumentError)
+    end
+
+    it 'trims whitespace from removed rows' do
+      source = "Examples:\n|param1|param2|\n|value1|value2|\n|value3|value4|\n|value5|value6|"
+      example = CukeModeler::Example.new(source)
+
+      hash_row = {'param1' => 'value3  ', 'param2' => '  value4'}
+      array_row = ['value5', ' value6 ']
+      example.remove_row(hash_row)
+      example.remove_row(array_row)
+
+      #todo - remove once Hash rows are no longer supported
+      example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}]
+      example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2']]
+    end
+  end
+
+  context 'example output edge cases' do
+
+    it 'is a String' do
+      @example.to_s.should be_a(String)
+    end
+
+    it 'can output an empty example' do
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    it 'can output an example that has only a name' do
+      @example.name = 'a name'
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    it 'can output an example that has only a description' do
+      @example.description_text = 'a description'
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    it 'can output an example that has only a tags' do
+      @example.tags = ['a tag']
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    #todo - remove once Hash rows are no longer supported
+    it 'can output an example that only has parameters' do
+      @example.parameters = ['param1']
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    #todo - remove once Hash rows are no longer supported
+    it 'can output an example that only has rows' do
+      @example.rows = [{:param1 => 'row1'}]
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+  end
+
+end