bitmap_cmd_editor 1.0.4

data/features/show_content.feature

@@ -0,0 +1,40 @@
+Feature: Show Content
+	S - Show the contents of the current image
+
+	Scenario: Showing Table
+		Given I run `bitmap_cmd_editor` interactively
+		And I type "I 5 6"
+		And I type "L 4 1 E"
+		And I type "L 3 2 E"
+		And I type "L 4 2 E"
+		And I type "L 3 3 E"
+		And I type "L 2 5 E"
+		And I type "F 4 2 H"
+		When I type "S"
+		And I type "X"
+		Then it should pass with:
+				"""
+				Welcome to the Bitmap Command Editor
+				------------------------------------
+
+				Available Commands:
+				-------------------
+
+					I M N - Create a new M x N image with all pixels coloured white (O).
+					C - Clears the table, setting all pixels to white (O).
+					L X Y C - Colours the pixel (X,Y) with colour C.
+					V X Y1 Y2 C - Draw a vertical segment of colour C in column X between rows Y1 and Y2 (inclusive).
+					H X1 X2 Y C - Draw a horizontal segment of colour C in row Y between columns X1 and X2 (inclusive).
+					F X Y C - Fill the region R with the colour C. R is defined as: Pixel (X,Y) belongs to R. Any other pixel which is the same colour as (X,Y) and shares a common side with any pixel in R also belongs to this region.
+					S - Show the contents of the current image
+					X - Terminate the session
+
+				O O O H O
+				O O H H O
+				O O H O O
+				O O O O O
+				O E O O O
+				O O O O O
+
+				End the Session...
+				"""

data/features/step_definitions/clear_table_step.rb

@@ -0,0 +1,4 @@
+Then(/^the bitmap should be$/) do |table|
+	expected_table=table.raw
+  expect(@bitmap.table).to match_array(expected_table)
+end

data/features/step_definitions/colours_pixel_step.rb

@@ -0,0 +1,10 @@
+Given(/^a bitmap was created typing the command "([^"]*)"$/) do |command|
+  steps %{
+    Given a bitmap created
+		And The user type "#{command}"
+  }
+end
+
+When(/^The user tries to colour "([^"]*)"$/) do |command|
+  @command = @bitmap.process_command(command)
+end

data/features/step_definitions/create_bitmap_step.rb

@@ -0,0 +1,19 @@
+Given(/^a bitmap created$/) do
+  @bitmap = Bitmap.new
+end
+
+When(/^The user type "([^"]*)"$/) do |command|
+  @bitmap.process_command(command)
+end
+
+Then(/^this bitmap should be created$/) do |table|
+	expected_table=table.raw
+  expect(@bitmap.table).to match_array(expected_table)
+end
+When(/^The user attempts to create "([^"]*)"$/) do |command|
+  @command = @bitmap.process_command(command)
+end
+
+Then(/^He should see the message "([^"]*)"$/) do |message|
+  expect(@command).to include(message)
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'bitmap_cmd_editor'

data/lib/bitmap_cmd_editor.rb

@@ -0,0 +1,3 @@
+require "bitmap_cmd_editor/version"
+
+include BitmapCmdEditor

data/lib/bitmap_cmd_editor/bitmap.rb

@@ -0,0 +1,195 @@
+module BitmapCmdEditor
+	# @author Diego Hernán Piccinini Lagos
+	# It's the main object is instantiated empty when the application start
+	class Bitmap
+
+		attr_reader :table, :columns, :rows
+
+		# @param (see CommandValidator#initialize)
+		def initialize
+			@table=[]
+			@columns = 0
+			@rows = 0
+		end
+
+		# process the operations commands availables view the constant COMMANDS, X is excluded because it is a
+		# system command not a bitmap command
+		# @param input [String] the command typed for example: I 5 6
+		# @return CommandValidator.validate response [Symbol|String] could be :valid or Error Message string
+		def process_command(input)
+
+			validator=Validators::CommandValidator.validate(input)
+			if validator == :valid
+				args = input.split(' ')
+				case args[0]
+				when 'I'
+					create_image(args)
+				when 'C'
+					clear_image(args)
+				when 'L'
+					colours_pixel(args)
+				when 'V'
+					draw_vertical_line(args)
+				when 'H'
+					draw_horizontal_line(args)
+				when 'F'
+					fill_region(args)
+				when 'S'
+					print_table(args)
+				end
+			else
+				validator
+			end
+		end
+    private
+
+			# For create image table map for M columns and N rows with the command I M N
+			# @param args [String] the command typed for example: I 5 6
+			# @return CreateImageValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def create_image(args)
+				validator=Validators::CreateImageValidator.validate(args)
+				if validator == :valid
+					@columns=Integer(args[1])
+					@rows = Integer(args[2])
+					@table = fill_table(@columns,@rows)
+				end
+				validator
+			end
+
+			# clear the image with the command C all values will be O
+			# @param args [String] in this case is C
+			# @return CreateImageValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def clear_image(args)
+				validator=Validators::ClearImageValidator.validate(args)
+				if validator == :valid
+					@table = fill_table(@columns,@rows)
+				end
+				validator
+			end
+
+			# to fill a coordinate with specific colour with command L M N C
+			# @param args [String] in this case the command is for example L 4 2 A
+			# @return ColourPixelValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def colours_pixel(args)
+				validator=Validators::ColourPixelValidator.validate(args, @columns, @rows)
+				if validator == :valid
+					column=Integer(args[1]) - 1
+					row = Integer(args[2]) - 1
+					@table[row][column]=args[3]
+				end
+				validator
+			end
+
+			# to create a fill all  table coordinates with a colour
+			# @param columns [Integer]
+			# @param rows [Integer]
+			# @param colour [String]
+			# @return table 2 dimensions [Array] pixels coordinates rows and coloumns with colour
+			def fill_table(columns, rows, colour = 'O')
+				table = []
+				rows.times do |row|
+					table[row] =Array.new(columns,colour)
+				end
+				table
+			end
+
+			# to draw a vertical line
+			# @param args [String] in this case the command is for example V 2 1 4 W
+			# @return VerticalLineValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def draw_vertical_line(args)
+				validator=Validators::VerticalLineValidator.validate(args, @columns, @rows)
+				if validator == :valid
+					column=Integer(args[1]) - 1
+					row_start = Integer(args[2]) - 1
+					row_end = Integer(args[3]) - 1
+					(row_start..row_end).each do |row|
+						@table[row][column]=args[4]
+					end
+				end
+				validator
+			end
+
+			# to draw a horinzontal line
+			# @param args [String] in this case the command is for example H 2 1 4 C
+			# @return VerticalLineValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def draw_horizontal_line(args)
+				validator=Validators::HorizontalLineValidator.validate(args, @columns, @rows)
+				if validator == :valid
+					column_start=Integer(args[1]) - 1
+					column_end = Integer(args[2]) - 1
+					row = Integer(args[3]) - 1
+					(column_start..column_end).each do |column|
+						@table[row][column]=args[4]
+					end
+				end
+				validator
+			end
+
+			# to fill a region with specific colour with command F M N C
+			# @param args [String] in this case the command is for example F 4 2 A
+			# @return FillRegionValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def fill_region(args)
+				validator=Validators::FillRegionValidator.validate(args, @columns, @rows)
+				if validator == :valid
+					column=Integer(args[1]) - 1
+					row = Integer(args[2]) - 1
+					searched = []
+					same_region = [[row , column]]
+					begin
+						same_region, searched = get_region(same_region,searched)
+					end while not (same_region - searched).empty?
+
+					same_region.each do |fill_coordinate|
+						r=fill_coordinate[0]
+						c=fill_coordinate[1]
+						@table[r][c]=args[3]
+					end
+				end
+				validator
+			end
+
+			# search the same colour adjacent pixels
+			# @param same_region [Array] the region has finded
+			# @param searched [Array] the pixels that it has a previous search
+			def get_region(same_region, searched)
+
+				diff = same_region - searched
+				# search only the points not searched before
+				diff.each do |find_center|
+					row= find_center[0]
+					column = find_center[1]
+					if row> (BitmapCmdEditor::MIN_ROWS - 1)
+						same_region.push [row - 1 , column]  if @table[row - 1][column] == @table[row][column]
+					end
+					if row< (@rows -1)
+						same_region.push [row + 1 , column]  if @table[row + 1][column] == @table[row][column]
+					end
+					if column> (BitmapCmdEditor::MIN_COLUMNS - 1 )
+						same_region.push [row  , column - 1]  if @table[row][column - 1] == @table[row][column]
+					end
+					if column< (@columns - 1)
+						same_region.push [row , column + 1]  if @table[row][column  + 1] == @table[row][column]
+					end
+					searched.push find_center
+				end
+				same_region = same_region.uniq
+				searched = searched.uniq
+				[same_region , searched]
+			end
+
+
+			# print the table with the command S
+			# @param args [String] in this case is S
+			# @return PrintTableValidator.validate response [Symbol|String] could be :valid or Error Message string
+			def print_table(args)
+				validator=Validators::PrintTableValidator.validate(args)
+				if validator == :valid
+					puts "\n"
+					@table.each do |row|
+						puts row.join(' ')
+					end
+				end
+				validator
+			end
+	end
+end

data/lib/bitmap_cmd_editor/client.rb

@@ -0,0 +1,34 @@
+require 'readline'
+
+module BitmapCmdEditor
+  # @author Diego Hernán Piccinini Lagos
+  # This class handle the the interactive loop until X + Enter to exit
+
+	class Client
+		class << self
+			# getting commands in a loop
+			def get_commands
+				begin
+					puts WELCOME_MESSAGE
+					bitmap = Bitmap.new
+					loop do
+						input = Readline.readline("> ")
+						input.strip!
+
+						# the command X must not be processed it's only to exit
+						if input=='X'
+							puts "\nEnd the Session..."
+							break
+						else
+								process=bitmap.process_command(input)
+								puts process unless process==:valid
+						end
+					end
+
+				rescue => err
+					puts err.message
+				end
+			end
+		end
+	end
+end

data/lib/bitmap_cmd_editor/exceptions.rb

@@ -0,0 +1,17 @@
+module BitmapCmdEditor
+  # @author Diego Hernán Piccinini Lagos
+  class NotImplementedCommand < NotImplementedError; end
+  class CreateImageArgumentError < ArgumentError; end
+  class MoreColumnsThanAllowed < RangeError; end
+  class MoreRowsThanAllowed < RangeError; end
+  class LessColumnsThanAllowed < RangeError; end
+  class LessRowsThanAllowed < RangeError; end
+  class OutOfRange < RangeError; end
+  class ClearImageArgumentError < ArgumentError; end
+  class ColourPixelArgumentError < ArgumentError; end
+  class HorizontalLineArgumentError < ArgumentError; end
+  class VerticalLineArgumentError < ArgumentError; end
+  class FillRegionArgumentError < ArgumentError; end
+  class PrintTableArgumentError < ArgumentError; end
+
+end

data/lib/bitmap_cmd_editor/validators/clear_image_validator.rb

@@ -0,0 +1,20 @@
+module BitmapCmdEditor
+	module Validators
+		# @author Diego Hernán Piccinini Lagos
+		# To validate a new bitmap image table created
+		class ClearImageValidator
+			class << self
+				# @param args [Array] the command 0=> 'C'
+				def validate(args)
+					begin
+						raise ClearImageArgumentError.new(
+							ErrorMessage.new(:clear_image_wrongs_arguments).show_content) unless args.count == 1
+						:valid
+					rescue  => err
+						err.message
+					end
+				end
+			end
+		end
+	end
+end

data/lib/bitmap_cmd_editor/validators/colour_pixel_validator.rb

@@ -0,0 +1,34 @@
+module BitmapCmdEditor
+	module Validators
+		# @author Diego Hernán Piccinini Lagos
+		class ColourPixelValidator
+			class << self
+				# @param args [Array] the command 0=> 'L' and 1=> columns 2 =>rows 3 => colour
+				# @param bitmap_columns [Integer] number of columns of the image created
+				# @param bitmap_rows [Integer] number of rows of the image created
+				def validate(args, bitmap_columns, bitmap_rows)
+					begin
+						raise ColourPixelArgumentError.new(
+							ErrorMessage.new(:command_wrong_arguments, {:arguments => 3}).show_content) unless args.count == 4
+
+						begin
+							columns= Integer(args[1])
+							rows= Integer(args[2])
+						rescue => err
+							raise TypeError.new(ErrorMessage.new(:coordinates_are_not_integer).show_content)
+						end
+						ValidatorHelper.out_of_range('columns',BitmapCmdEditor::MIN_COLUMNS,bitmap_columns,columns)
+
+						ValidatorHelper.out_of_range('rows',BitmapCmdEditor::MIN_ROWS,bitmap_rows,rows)
+
+						raise TypeError.new(ErrorMessage.new(:the_colour_is_invalid).show_content) unless ('A'..'Z').include?args[3]
+
+						:valid
+					rescue  => err
+						err.message
+					end
+				end
+			end
+		end
+	end
+end

data/lib/bitmap_cmd_editor/validators/command_validator.rb

@@ -0,0 +1,21 @@
+module BitmapCmdEditor
+	module Validators
+		# @author Diego Hernán Piccinini Lagos
+		# To validate the command and show the user a help message
+		class CommandValidator
+			class << self
+				# @param input [String] the input command string
+				def validate(input)
+					begin
+						args=input.split(' ')
+						raise NotImplementedCommand.new(ErrorMessage.new(:command_not_exist).show_content) unless BitmapCmdEditor::COMMANDS.include?(args[0])
+						:valid
+					rescue NotImplementedCommand => err
+						err.message
+					end
+				end
+			end
+		end
+
+	end
+end

data/lib/bitmap_cmd_editor/validators/create_image_validator.rb

@@ -0,0 +1,34 @@
+module BitmapCmdEditor
+	module Validators
+		# @author Diego Hernán Piccinini Lagos
+		# To validate a new bitmap image table created
+		class CreateImageValidator
+			class << self
+				# @param args [Array] the command 0=> 'I' and 1=> columns 2 =>rows
+				def validate(args)
+					begin
+						raise CreateImageArgumentError.new(
+							ErrorMessage.new(:command_wrong_arguments, {:arguments => 2}).show_content) unless args.count == 3
+						begin
+							columns= Integer(args[1])
+							rows= Integer(args[2])
+						rescue => err
+							raise TypeError.new(ErrorMessage.new(:coordinates_are_not_integer).show_content)
+						end
+						ValidatorHelper.more_than_max('columns',BitmapCmdEditor::MAX_COLUMNS,columns)
+
+						ValidatorHelper.more_than_max('rows',BitmapCmdEditor::MAX_ROWS,rows)
+
+						ValidatorHelper.less_than_min('columns',BitmapCmdEditor::MIN_COLUMNS,columns)
+
+						ValidatorHelper.less_than_min('rows',BitmapCmdEditor::MIN_ROWS,rows)
+
+						:valid
+					rescue  => err
+						err.message
+					end
+				end
+			end
+		end
+	end
+end