ascii_art 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e465c17c093866118f5d4323bc350c37729d1712
+  data.tar.gz: 5e8022b32b4e1c45c7cad83de1bf9b752ad26bd9
+SHA512:
+  metadata.gz: 82728e777271005239312d6c6333b0f37b09c3e2d7e9515c2baabbf41743a4ac49b7df436f6aaa0e61a61ff92691dca37fac5e29dc2daa3dba6e8a9603763614
+  data.tar.gz: 181dcecdd96bdfb909b9b09633007870c1e86d21fe22d71f8e5cb3b41550011b5262e59edea6d496ad2b4e9d5e18049bbef1e314171d95b0720c144801ece67b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+drawing.txt

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'curses'
+gem 'commander'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris C Cerami
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+[![Gem Version](https://badge.fury.io/rb/ascii_art.svg)](http://badge.fury.io/rb/ascii_art)
+
+# ASCII Art
+
+```
+__________ ____ __________________.___.
+\______   \    |   \______   \__  |   |
+ |       _/    |   /|    |  _//   |   |
+ |    |   \    |  / |    |   \\____   |
+ |____|_  /______/  |______  // ______|
+        \/                 \/ \/
+   _____    __________________ .___.___        _____ _____________________
+  /  _  \  /   _____/\_   ___ \|   |   |      /  _  \\______   \__    ___/
+ /  /_\  \ \_____  \ /    \  \/|   |   |     /  /_\  \|       _/ |    |
+/    |    \/        \\     \___|   |   |    /    |    \    |   \ |    |
+\____|__  /_______  / \______  /___|___|____\____|__  /____|_  / |____|
+        \/        \/         \/       /_____/       \/       \/
+```
+
+## Description
+
+The ascii_art gem will allow you to turn your terminal into a canvas for creating images with ASCII characters.
+
+## Installation
+
+Install the gem with:
+
+    $ gem install ascii_art
+
+## Usage
+
+To open a new canvas, simply use:
+
+```ruby
+AsciiArt.start
+```
+
+or from the command line:
+
+```
+$ ascii_art start
+```
+
+This will open a blank canvas on which you can start drawing.
+
+### Key Commands
+
+Key                   | Action
+----------------------|--------------------------------------
+Arrows                | Move the cursor around the screen
+`tab`                 | "Lift" the brush so you can move the cursor without marking the canvas
+`p`                   | "Print" the drawing, saving it to a `drawing.txt` file in your current directory
+Other character keys  | Change the character being drawn
+`esc`                 | Quit the program
+
+If you would like to specify a different file to which your drawing should be saved, you can use the -f or --file option on the command line:
+
+```
+$ ascii_art start -f my_drawing.txt
+```
+```
+$ ascii_art start --file best_art.txt
+```
+
+If you'd like to continue working on a drawing you've started previously, you can load files into the app using the `scan` command:
+
+```
+$ ascii_art scan an_old_drawing.txt
+```
+
+and can still use the -f option to set the print destination:
+
+```
+$ ascii_art scan an_old_drawing.txt -f my_new_masterpiece.txt
+```
+
+This will read the file you specify and draw its contents to a new canvas. In order to prevent overwriting any of your beautiful handiwork, the brush will start in the lifted position, and can be lowered with the `tab` key.
+
+## Contributing
+
+If you would like to contribute to AsciiArt, feel free to create a
+pull request. If you'd like to contact me, you can reach me at
+[chrisccerami@gmail.com](mailto:chrisccerami@gmail.com) or on
+Twitter [@chrisccerami](https://twitter.com/chrisccerami).
+
+1. Fork it ( https://github.com/chrisccerami/ascii_art/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Copyright (c) 2015 Chris C Cerami
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r ascii_art -I ./lib"
+end

data/ascii_art.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ascii_art/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ascii_art"
+  spec.version       = AsciiArt::VERSION
+  spec.authors       = ["Chris C Cerami"]
+  spec.email         = ["chrisccerami@gmail.com"]
+  spec.date          = '2015-07-17'
+  spec.summary       = "A command line app for drawing and saving ASCII art"
+  spec.description   = "Using this gem, you can create ASCII style drawings in your command line, which you can choose to save to a .txt file."
+  spec.homepage      = "http://rubygems.org/gems/ascii_art"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path  = "lib"
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'curses'
+  spec.add_runtime_dependency 'commander', '~> 4.3'
+end

data/bin/ascii_art

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'ascii_art'
+require 'ascii_art/version'
+
+program :version, AsciiArt::VERSION
+program :description, 'A command line app for drawing and saving ASCII art'
+
+command :start do |c|
+  c.syntax = 'ascii_art start [options]'
+  c.summary = 'Open a new canvas to begin drawing'
+  c.description = c.summary
+  c.example 'Starts the ascii_art program', 'ascii_art start'
+  c.example 'Starts the app with a custom save filename', 'ascii_art start -f my_file.txt'
+  c.option '-f', '--file FILENAME', String, 'Change the filename where your art will be saved'
+  c.action do |args, options|
+    AsciiArt.start(options.file)
+  end
+end
+
+command :scan do |c|
+  c.syntax = 'ascii_art scan [options]'
+  c.summary = 'Load a txt file to continue drawing'
+  c.description = c.summary
+  c.example 'Starts the app with a drawing preloaded from a txt file', 'ascii_art scan my_file.txt'
+  c.option '-f', '--file FILENAME', String, 'Change the filename where your art will be saved'
+  c.action do |args, options|
+    AsciiArt.start_with_scan(args.first, options.file)
+  end
+end

data/lib/ascii_art.rb

@@ -0,0 +1,20 @@
+# external dependencies
+require 'curses'
+require 'singleton'
+
+# internal dependencies
+require 'ascii_art/painter'
+require 'ascii_art/canvas'
+require 'ascii_art/brush'
+require 'ascii_art/printer'
+require 'ascii_art/scanner'
+
+module AsciiArt
+  def self.start(filename=nil)
+    Painter.new(filename).paint
+  end
+
+  def self.start_with_scan(load_file, print_file=nil)
+    Painter.new(print_file).load_drawing(load_file)
+  end
+end

data/lib/ascii_art/brush.rb

@@ -0,0 +1,36 @@
+module AsciiArt
+  class Brush
+    attr_accessor :stroke, :x_pos, :y_pos, :lifted
+    def initialize(stroke, x, y)
+      @stroke = stroke
+      @x_pos = x
+      @y_pos = y
+      @lifted = false
+    end
+
+    def raise_or_lower
+      @lifted = !@lifted
+    end
+
+    def move(x, y)
+      @x_pos = x
+      @y_pos = y
+    end
+
+    def move_up
+      move(@x_pos, @y_pos - 1)
+    end
+
+    def move_down
+      move(@x_pos, @y_pos + 1)
+    end
+
+    def move_left
+      move(@x_pos - 1, @y_pos)
+    end
+
+    def move_right
+      move(@x_pos + 1, @y_pos)
+    end
+  end
+end

data/lib/ascii_art/canvas.rb

@@ -0,0 +1,52 @@
+module AsciiArt
+  class Canvas
+    include Curses
+    include Singleton
+
+    attr_accessor :surface
+
+    def initialize
+      noecho
+      @surface = init_screen
+      stdscr.keypad = true
+    end
+
+    def close
+      close_screen
+      exit
+    end
+
+    def move(x, y)
+      setpos(y, x)
+    end
+
+    def paint(x, y, string)
+      move(x, y)
+      addstr(string)
+    end
+
+    def accept_input
+      loop do
+        return getch
+      end
+    end
+
+    def clear(x, y)
+      move(x, y)
+      delch
+      insch(' ')
+    end
+
+    def read_at_cursor
+      inch
+    end
+
+    def line_count
+      lines
+    end
+
+    def column_count
+      cols
+    end
+  end
+end

data/lib/ascii_art/painter.rb

@@ -0,0 +1,80 @@
+module AsciiArt
+  require_relative 'canvas'
+  class Painter
+    def initialize(print_file=nil)
+      @canvas = Canvas.instance
+      @brush = Brush.new('.', 0, 0)
+      @print_file = print_file
+      @printer
+      @scanner
+      at_exit { canvas.close }
+    end
+
+    COMMAND_KEYS = [
+      Canvas::KEY_UP,
+      Canvas::KEY_DOWN,
+      Canvas::KEY_LEFT,
+      Canvas::KEY_RIGHT,
+      9, # tab key character code
+      27, # esc key character code
+      'p'
+    ]
+
+    def paint
+      canvas.paint(brush.x_pos, brush.y_pos, brush.stroke)
+      command_loop
+    end
+
+    def load_drawing(filename)
+      Scanner.new(filename).scan
+      brush.lifted = true
+      move_brush
+      command_loop
+    end
+
+    def command_loop
+      loop do
+        follow_commands
+      end
+    end
+
+    private
+
+    attr_accessor :scanner
+    attr_reader :canvas, :brush, :printer, :print_file
+
+    def follow_commands
+      char = canvas.accept_input
+      if COMMAND_KEYS.include?(char)
+        system_commands(char)
+      else
+        brush.stroke = char
+      end
+      move_brush
+    end
+
+    def move_brush
+      if brush.lifted
+        canvas.move(brush.x_pos, brush.y_pos)
+      else
+        canvas.paint(brush.x_pos, brush.y_pos, brush.stroke)
+      end
+    end
+
+    def system_commands(char)
+      inputs = {
+        Canvas::KEY_UP => proc { brush.move_up },
+        Canvas::KEY_LEFT => proc { brush.move_left },
+        Canvas::KEY_DOWN => proc { brush.move_down },
+        Canvas::KEY_RIGHT => proc { brush.move_right },
+        9 => proc { brush.raise_or_lower },
+        27 => proc { canvas.close },
+        'p' => proc {
+          printer = Printer.new(print_file ||= 'drawing.txt')
+          printer.print
+        }
+      }
+      inputs[char].call
+    end
+  end
+end

data/lib/ascii_art/printer.rb

@@ -0,0 +1,23 @@
+module AsciiArt
+  require_relative 'canvas'
+  class Printer
+    attr_accessor :canvas, :lines, :columns, :file
+    def initialize(filename)
+      @canvas = Canvas.instance
+      @lines = @canvas.line_count
+      @columns = @canvas.column_count
+      @file = File.new(filename, 'w')
+    end
+
+    def print
+      (0..lines - 1).each do |y|
+        (0..columns - 1).each do |x|
+          canvas.move(x, y)
+          file.write(canvas.read_at_cursor.chr)
+        end
+        file.write("\n")
+      end
+      file.close
+    end
+  end
+end

data/lib/ascii_art/scanner.rb

@@ -0,0 +1,24 @@
+module AsciiArt
+  class Scanner
+    require_relative 'canvas'
+
+    attr_accessor :filename
+    attr_reader :drawing
+    def initialize(filename)
+      @filename = filename
+      @drawing
+    end
+
+    def scan
+      row = 0
+      open_file.each_line do |line|
+        Canvas.instance.paint(0, row, line)
+        row += 1
+      end
+    end
+
+    def open_file
+      File.open(filename, "r")
+    end
+  end
+end

data/lib/ascii_art/version.rb

@@ -0,0 +1,3 @@
+module AsciiArt
+  VERSION = "0.4.2"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ascii_art
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+platform: ruby
+authors:
+- Chris C Cerami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Using this gem, you can create ASCII style drawings in your command line,
+  which you can choose to save to a .txt file.
+email:
+- chrisccerami@gmail.com
+executables:
+- ascii_art
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ascii_art.gemspec
+- bin/ascii_art
+- lib/ascii_art.rb
+- lib/ascii_art/brush.rb
+- lib/ascii_art/canvas.rb
+- lib/ascii_art/painter.rb
+- lib/ascii_art/printer.rb
+- lib/ascii_art/scanner.rb
+- lib/ascii_art/version.rb
+homepage: http://rubygems.org/gems/ascii_art
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A command line app for drawing and saving ASCII art
+test_files: []