bitmap_compiler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b886f6b74288b45633834252af0f68cf8c132c2
-  data.tar.gz: e917bfbf7d12ac7c0c3b9a4ff59b8b543a4e6af7
+  metadata.gz: aafbe44681ab6a478eca0daa40fb3f8f64090dc3
+  data.tar.gz: 0f4e958a789fe9811eea5c5da73b5336c1b59237
 SHA512:
-  metadata.gz: d5cf3c89cf783bb2684d2fe5bd6587508aa592782c6122a39234b87225b27c17a3de3a04118c9c1f9cd82cf25ea486a993424fcdf2491ee97db75bb1d9001a27
-  data.tar.gz: 84de4e9ceca35c8c0ca0c1816a44960b9ecde19cd8a5b790411bc9fc4ed37a7811e8e46a00805a66320ed6a5c1cc0da944eceab9214442bad5ba341404318c77
+  metadata.gz: 39b0bfe42961adc68ca05abe7c9a0d73fa5f06910c61f406b59439a4cedbec3b33c97c7cd03834e0185700a59ed80ff7190a4739ed8910c70ff4be6e1806915e
+  data.tar.gz: 34b775a0ff3ce50a9ed9aca5789473e3e2f099e09f09f9362f25243cd09b4f33cf0799b832275c4aa1cf398a6923f35566a685e6507357df0030500bcb4b4471

data/CHANGELOG.md

@@ -3,12 +3,19 @@
 ## HEAD Unreleased
 ### Latest update: 2018-08-29
 
+### Chores
+
+- [PR #11](https://github.com/vbrazo/bitmap_compiler/pull/11) Add gem version badge [@vbrazo](https://github.com/vbrazo)
+
 ### Documentation
 
+- [PR #12](https://github.com/vbrazo/bitmap_compiler/pull/12) Add documentation for classes [@vbrazo](https://github.com/vbrazo)
 - [PR #10](https://github.com/vbrazo/bitmap_compiler/pull/10) Update README.md [@vbrazo](https://github.com/vbrazo)
 
 ### Feature Request/Enhancement
- 
+
+- [PR #14](https://github.com/vbrazo/bitmap_compiler/pull/14) Add CLI missing specs [@vbrazo](https://github.com/vbrazo)
+- [PR #13](https://github.com/vbrazo/bitmap_compiler/pull/13) Use Error classes instead of printing the output [@vbrazo](https://github.com/vbrazo)
 - [PR #9](https://github.com/vbrazo/bitmap_compiler/pull/9) Add CLI [@vbrazo](https://github.com/vbrazo)
 - [PR #8](https://github.com/vbrazo/bitmap_compiler/pull/8) Add Error Pattern and its subclasses [@vbrazo](https://github.com/vbrazo)
 - [PR #7](https://github.com/vbrazo/bitmap_compiler/pull/7) Add BitmapController actions [@vbrazo](https://github.com/vbrazo)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitmap_compiler (0.1.0)
+    bitmap_compiler (0.2.0)
       thor
 
 GEM

data/README.md

@@ -1,17 +1,15 @@
-[![Build Status](https://travis-ci.org/vbrazo/bitmap_compiler.svg?branch=master)](https://travis-ci.org/vbrazo/bitmap_compiler) [![Maintainability](https://api.codeclimate.com/v1/badges/1cc557f6b323fd458c12/maintainability)](https://codeclimate.com/github/vbrazo/bitmap_compiler/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/1cc557f6b323fd458c12/test_coverage)](https://codeclimate.com/github/vbrazo/bitmap_compiler/test_coverage)
+# Bitmap Compiler [![Build Status](https://travis-ci.org/vbrazo/bitmap_compiler.svg?branch=master)](https://travis-ci.org/vbrazo/bitmap_compiler) [![Gem Version](https://badge.fury.io/rb/bitmap_compiler.svg)](https://badge.fury.io/rb/bitmap_compiler) [![Maintainability](https://api.codeclimate.com/v1/badges/1cc557f6b323fd458c12/maintainability)](https://codeclimate.com/github/vbrazo/bitmap_compiler/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/1cc557f6b323fd458c12/test_coverage)](https://codeclimate.com/github/vbrazo/bitmap_compiler/test_coverage)
 
-# BitmapCompiler
-
-This is the Bitmap compiler gem! It aims to build a Bitmap given an input file.
+This is the Bitmap compiler gem! It aims to build a bitmap given an input file.
 
 You can check on `spec/support` folder to see examples. The supported commands are:
 
 ```
-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).
+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)
 S           - Show the contents of the current image
 ```
 
@@ -41,37 +39,22 @@ OWOOO
 OWOOO
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'bitmap_compiler'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install bitmap_compiler
-
 ## Usage
 
-You can use the application programmatically by installing the gem and using on the Ruby environment (You can run `bin/console` for this). Check the examples folder for more examples.
+### Ruby console
+
+You can use the application programmatically by installing the gem and using on the Ruby environment (You can run `bin/console` for this). If you want to test the Editor class after launching the console, just run:
 
 ```ruby
 BitmapCompiler::Core::Editor.new.run('spec/support/show.txt')
 ```
 
-There is also a CLI provided that can be used.
-
 ### CLI
 
 The application also has a CLI built-in that can be used directly on any *nix terminal. 
 
 ```
+$ bitmap_compiler process_file -f=spec/support/show.txt
 $ bitmap_compiler process_file --file=spec/support/show.txt
 ```
 
@@ -81,9 +64,31 @@ Use the help command for more information.
 $ bitmap_compiler help process_file
 ```
 
+### Rails
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitmap_compiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitmap_compiler
+
+After that you should be able to use the `Editor` class in your `rails console` or inside your application:
+
+```ruby
+BitmapCompiler::Core::Editor.new.run("Specify the file path")
+```
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec spec` to run the tests.
 
 ## Contributing
 
@@ -92,3 +97,4 @@ See [CONTRIBUTING.md](https://github.com/vbrazo/bitmap_compiler/blob/master/CONT
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/bitmap_compiler.rb

@@ -17,5 +17,5 @@ require 'bitmap_compiler/core/errors/unknown_command_error'
 require 'bitmap_compiler/core/editor'
 require 'bitmap_compiler/core/output'
 
-# Bitmap gem global module
+# BitmapCompiler global module
 module BitmapCompiler; end

data/lib/bitmap_compiler/cli.rb

@@ -2,10 +2,11 @@
 
 require 'thor'
 
-# Class responsible for handle the command line interface
+# Responsibility: handle the command line interface
 module BitmapCompiler
   class CLI < Thor
     desc 'process_file BITMAP', 'Bitmap compiler via CLI'
+
     option :file, type: :string, aliases: [:f]
 
     # CLI method to call the Editor
@@ -18,8 +19,6 @@ module BitmapCompiler
 
     private
 
-    attr_reader :bitmap_compiler
-
     def bitmap_compiler
       @bitmap_compiler ||= BitmapCompiler::Core::Editor.new
     end

data/lib/bitmap_compiler/core/bitmap.rb

@@ -1,5 +1,6 @@
 module BitmapCompiler
   module Core
+    # Bitmap entity
     class Bitmap
       MIN_WIDTH = MIN_HEIGHT = 1
       MAX_WIDTH = MAX_HEIGHT = 250

data/lib/bitmap_compiler/core/bitmap_actions.rb

@@ -1,6 +1,6 @@
-# BitmapCompiler shares role behavior
 module BitmapCompiler
   module Core
+    # BitmapActions shares role behavior
     module BitmapActions
       def change_color(row:, column:, color: Bitmap::STANDARD_COLOR)
         return image_not_found unless bitmap
@@ -8,7 +8,7 @@ module BitmapCompiler
         if bitmap.change_pixel(row, column, color)
           return_output
         else
-          return_output(message: InvalidPixelError.new.message)
+          raise BitmapCompiler::Core::Errors::InvalidPixelError
         end
       end
 
@@ -18,7 +18,7 @@ module BitmapCompiler
         if bitmap.clear
           return_output
         else
-          return_output(message: ImageNotClearedError.new.message)
+          raise BitmapCompiler::Core::Errors::ImageNotClearedError
         end
       end
 
@@ -27,7 +27,7 @@ module BitmapCompiler
            args[:height].between?(Bitmap::MIN_HEIGHT, Bitmap::MAX_HEIGHT)
           return_output(bitmap: Bitmap.new(args[:width], args[:height]))
         else
-          return_output(message: InvalidDimensionsError.new.message)
+          raise BitmapCompiler::Core::Errors::InvalidDimensionsError
         end
       end
 
@@ -47,12 +47,12 @@ module BitmapCompiler
 
           return_output
         else
-          return_output(message: InvalidCoordinatesError.new.message)
+          raise Errors::InvalidCoordinatesError
         end
       end
 
       def change_vertical_line(row:, start_column:, end_column:, color: Bitmap::STANDARD_COLOR)
-        return image_not_found unless bitmap
+        image_not_found unless bitmap
 
         if bitmap.valid_vertical_line_coordinates?(row, start_column, end_column)
           (start_column..end_column).each do |column_index|
@@ -61,18 +61,18 @@ module BitmapCompiler
 
           return_output
         else
-          return_output(message: InvalidCoordinatesError.new.message)
+          raise BitmapCompiler::Core::Errors::InvalidCoordinatesError
         end
       end
 
       def unknown_command
-        return_output(message: UnknownCommandError.new.message)
+        raise BitmapCompiler::Core::Errors::UnknownCommandError
       end
 
       private
 
       def image_not_found
-        return_output(message: NoImageFoundError.new.message)
+        raise BitmapCompiler::Core::Errors::NoImageFoundError
       end
 
       def return_output(args = {})

data/lib/bitmap_compiler/core/bitmap_controller.rb

@@ -2,6 +2,7 @@
 
 module BitmapCompiler
   module Core
+    # Responsibility: execute commands
     class BitmapController
       include BitmapActions
 
@@ -19,10 +20,12 @@ module BitmapCompiler
           create_bitmap(bitmap_hash)
         when 'C'
           clear
+        when 'L'
+          change_color(pixel_hash)
         when 'V'
-          change_vertical_line(change_vertical_line_hash)
+          change_vertical_line(vertical_line_hash)
         when 'H'
-          change_horizontal_line(change_horizontal_line_hash)
+          change_horizontal_line(horizontal_line_hash)
         when 'S'
           print
         else
@@ -39,7 +42,7 @@ module BitmapCompiler
         }
       end
 
-      def change_horizontal_line_hash
+      def horizontal_line_hash
         {
           start_row: Integer(input[1]),
           end_row: Integer(input[2]),
@@ -48,7 +51,15 @@ module BitmapCompiler
         }
       end
 
-      def change_vertical_line_hash
+      def pixel_hash
+        {
+          row: Integer(input[1]),
+          column: Integer(input[2]),
+          color: input[3]
+        }
+      end
+
+      def vertical_line_hash
         {
           row: Integer(input[1]),
           start_column: Integer(input[2]),

data/lib/bitmap_compiler/core/editor.rb

@@ -2,6 +2,7 @@
 
 module BitmapCompiler
   module Core
+    # Responsibility: process the files
     class Editor
       attr_reader :bitmap
 
@@ -10,7 +11,7 @@ module BitmapCompiler
       end
 
       def run(file)
-        raise IncorrectFileError if file.nil? || !File.exist?(file)
+        raise BitmapCompiler::Core::Errors::IncorrectFileError if file.nil? || !File.exist?(file)
 
         File.open(file).each { |line| process_line(line.chomp) }
       end
@@ -26,7 +27,7 @@ module BitmapCompiler
       private
 
       def bitmap_controller
-        BitmapController.new(bitmap)
+        @bitmap_controller ||= BitmapController.new(bitmap)
       end
 
       def execute(input)

data/lib/bitmap_compiler/core/errors/bitmap_error.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
-# BitmapError is a Template Method Pattern for our Error classes
-class BitmapError < StandardError
-  def message
-    raise NotImplementedError
+# Template Method Pattern for our Error classes
+module BitmapCompiler
+  module Core
+    module Errors
+      class BitmapError < StandardError
+        def message
+          raise NotImplementedError
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/image_not_cleared_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class ImageNotClearedError < BitmapError
-  def message
-    'Unable to clear Image'
+module BitmapCompiler
+  module Core
+    module Errors
+      class ImageNotClearedError < BitmapError
+        def message
+          'Unable to clear Image'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/incorrect_file_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class IncorrectFileError < BitmapError
-  def message
-    'Incorrect File'
+module BitmapCompiler
+  module Core
+    module Errors
+      class IncorrectFileError < BitmapError
+        def message
+          'Incorrect File'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/invalid_coordinates_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class InvalidCoordinatesError < BitmapError
-  def message
-    'Invalid Coordinates'
+module BitmapCompiler
+  module Core
+    module Errors
+      class InvalidCoordinatesError < BitmapError
+        def message
+          'Invalid Coordinates'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/invalid_dimensions_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class InvalidDimensionsError < BitmapError
-  def message
-    'Invalid height and/or width'
+module BitmapCompiler
+  module Core
+    module Errors
+      class InvalidDimensionsError < BitmapError
+        def message
+          'Invalid height and/or width'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/invalid_pixel_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class InvalidPixelError < BitmapError
-  def message
-    'Invalid Pixel'
+module BitmapCompiler
+  module Core
+    module Errors
+      class InvalidPixelError < BitmapError
+        def message
+          'Invalid Pixel'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/no_image_found_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class NoImageFoundError < BitmapError
-  def message
-    'Image Not Found'
+module BitmapCompiler
+  module Core
+    module Errors
+      class NoImageFoundError < BitmapError
+        def message
+          'Image Not Found'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/errors/unknown_command_error.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-class UnknownCommandError < BitmapError
-  def message
-    'Unknown Command'
+module BitmapCompiler
+  module Core
+    module Errors
+      class UnknownCommandError < BitmapError
+        def message
+          'Unknown Command'
+        end
+      end
+    end
   end
 end

data/lib/bitmap_compiler/core/output.rb

@@ -2,6 +2,7 @@
 
 module BitmapCompiler
   module Core
+    # Output entity
     class Output
       attr_reader :bitmap, :message
 

data/lib/bitmap_compiler/version.rb

@@ -1,3 +1,3 @@
 module BitmapCompiler
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitmap_compiler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vitor Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor