vamp 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ed0c28b4a5fa22a09ccafc6674d51076fb75816
-  data.tar.gz: 931968ca87c4c1cf6c4c5a4b8865625bece04ec0
+  metadata.gz: 4c4315d0432b085681e7afa71522bfc0fe3e04f3
+  data.tar.gz: 591b310d5939ddfa3070a867b54f8c603092e72f
 SHA512:
-  metadata.gz: b196797bc06e8c60be048e59a4a9a11bcbf8fdece181c07d3e0832afd61616f79aee6caa725380f58b4be0bc61a6f04c72dde40dd5a8cfd33debf0c5fb1db91f
-  data.tar.gz: e122c443482653ceaa831f2dad9a6d84a010dd2040e710c89b159b6a6bbc5803d4ffb0738ed2fec214c9fb8da6b1cba24a307f03b3cd2bb998f0415310d6605b
+  metadata.gz: 16383a97ea438b01e28dc035290fc1d5ed58952f516a70df23a702088a2d323c138b475e5dd91a5e7653ba57b6d57d241e49ceac634e794f9f651a2df48868b2
+  data.tar.gz: f831bae4c7f817ac9fc073fdefd45ff0f8a5dd48bc868709c0cb4a634d4ee91e37ce0b141ba1ab3dc10ba8f1ada633aca1f6e173db5ced106dfcbabaa51f3614

data/.gitignore

@@ -2,6 +2,7 @@
 /.idea/
 /.yardoc
 /Gemfile.lock
+/*.gem
 /_yardoc/
 /coverage/
 /doc/

data/README.md

@@ -1,7 +1,8 @@
 # Vamp - necessities for the elegant vampire
 
 Want to pimp up your command line interface?
-Just require this gem insert some code and your CLI makes witty vampire quotes.
+Just require this gem, insert some code and your CLI makes witty vampire quotes.
+You can even play animated ascii art in a console window.
 
 ## Installation
 
@@ -19,10 +20,9 @@ Or install it yourself as:
 
     $ gem install vamp
 
-## Usage
+## Usage with thor
 
 ```ruby
-
 require "thor"
 require "vamp"
 
@@ -53,6 +53,23 @@ end
 CLI.start(ARGV)
 ```
 
+## Animation Usage
+
+You can play an ascii art animation within a terminal window by using vamp.
+
+```ruby
+require "vamp"
+
+animator = Vamp::Animator.new(File.join(Gem.loaded_specs["vamp"].gem_dir, "files", "vampire.txt"), 31, 0, 24,
+  "No man knows till he has suffered from the night how sweet and how dear to his heart and eye the morning can be.")
+animator.play
+```
+
+To see the animation in higher resolution just click on the following image.
+
+[![Animation Demo](https://raw.githubusercontent.com/m-31/vamp/data/pic/demo_001.gif)](https://raw.githubusercontent.com/m-31/vamp/data/pic/demo_001.mp4)
+
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies.

data/lib/vamp/art.rb

@@ -0,0 +1,189 @@
+module Vamp
+  module Art
+
+    def self.remove_ansi(text)
+      text.gsub(/[\[\d;]+m/, '')
+    end
+
+    # ascii art by the queen of ascii art: Joan Stark (jgs)
+    # https://en.wikipedia.org/wiki/Joan_Stark
+    VAMPIRE = <<-'END'
+        =/\                 /\=
+        / \'._   (\_/)   _.'/ \
+       / .''._'--(o.o)--'_.''. \
+      /.' _/ |`'=/ " \='`| \_ `.\
+     /` .' `\;-,'\___/',-;/` '. '\
+    /.-' jgs   `\(-V-)/`       `-.\
+    `            "   "            `
+    END
+    HOBGOBLIN_COLOR = <<-'END'
+            ,     _.._     ,
+           (`._."`    `"._.')
+            '._          _.'               /\
+             | /`-.  .-'\ | __           .'.'
+             |(_()_\/_()_)|'  `\        ( (
+             ;   ,____,   ;     \        ) )
+              \  /VvvV\  /    \  \.__   / /
+             /`'._`""`_.'      \  \  `\/ /
+            /  .  `--'          \  \    /
+           /  / `-,       _.----'   \  ;
+          /  /     )     /  .--------` \
+         /  /.----'     /  /   ___.     \
+        /  /|   _    _,|  (---'   \     |
+       /  / |   \`""`  \\\\        \    |
+      / /`  |    |      \\\`        \   \
+     / /    ;    |                  /   /
+    / / _    \  /                 /`  /`
+   / _\/(    | |                 /  .'_
+  | ( \  '--'  \               .'  (__)`\
+  \\\\  `-------'         jgs /________.'
+   `\\\
+
+    END
+    HOBGOBLIN = remove_ansi(HOBGOBLIN_COLOR)
+    SHARK_COLOR = <<-'END'
+     o
+                              ___..                       ,
+                      __..--''__ (                      .';
+  o      __.-------.-'            `--..__             .'  ;
+    _.--'   0)         .--._             ``--...____.'   .'
+   (     _.      )).   .__.-''                          <
+    `````---....._____.....-   -..___       _____...--'-.'.
+  jgs                   `-.___.'     ```````             `.;
+
+    END
+    SHARK = remove_ansi(SHARK_COLOR)
+    DRAGON_COLOR = <<-'END'
+                     ___    ___
+               ,_;-'-._\__/_.-'
+             ,_\       a\/a
+           ,_\      ,-(  _'-._
+         ,_\       (==/\ |'-._\
+       ,_\   -.  /\ \/ | |\   `
+     ,_\       \/==\ '._\7 '._
+ jgs '.  '._    \=/\'-}}} '-}}}
+      /    />   /`  )
+ |\_.'   .'(   <_  <_
+ \____.-'   '--}}}-}}}
+
+    END
+    DRAGON = remove_ansi(DRAGON_COLOR)
+
+    # ascii art by Daniel Au (dcau)
+    # http://www.oocities.org/SoHo/7373/dcau.htm
+    SKULL_COLOR = <<-'END'
+             _,.-------.,_
+         ,;~'             '~;,
+       ,;                     ;,
+      ;                         ;
+     ,'                         ',
+    ,;                           ;,
+    ; ;      .           .      ; ;
+    | ;   ______       ______   ; |
+    |  `/~"     ~" . "~     "~\'  |
+    |  ~  ,-~~~^~, | ,~^~~~-,  ~  |
+     |   |        }:{        |   |
+     |   l       / | \       !   |
+     .~  (__,.--" .^. "--.,__)  ~.
+     |     ---;' / | \ `;---     |
+      \__.       \/^\/       .__/
+       V| \                 / |V
+        | |T~\___!___!___/~T| |
+        | |`IIII_I_I_I_IIII'| |
+        |  \,III I I I III,/  |
+         \   `~~~~~~~~~~'    /
+           \   .       .   /     -dcau
+             \.    ^    ./
+               ^~~~^~~~^
+
+    END
+    SKULL = remove_ansi(SKULL_COLOR)
+
+    # acii art by Andreas Freise (a:f)
+    # http://www.ascii-art.de/
+    LIZARD_COLOR = <<-'END'
+                                           )/_
+                                 _.--..---"-,--c_
+                            \L..'           ._O__)_
+                    ,-.     _.+  _  \..--( /           a:f
+                      `\.-''__.-' \ (     \_
+                        `'''       `\__   /\
+                                    ')
+
+    END
+    LIZARD = remove_ansi(LIZARD_COLOR)
+
+    # ascii art by Nico Okha (mOm)
+    RUNNING = <<-'END'
+         _
+       _( }
+      /_  )
+      / "/
+     / -;\
+ ;--' ´  /'
+        <_
+    END
+    DECLARING = <<-'END'
+        ,
+     (}_/
+    /,;
+  "^/ \
+    \|/
+    //
+    ""`
+    END
+
+    DECLARING2 = <<-'END'
+ !
+ ||
+ !|
+ | \      _
+ | \    /~ ~\
+  \ \_ /<- ->\
+   \  \_\.O.|\\
+    \   '  /__"
+    |         \
+    \ '   .  \ \
+    \        /) >
+     \  ,    | /
+     | \__/   <
+     >  /o   |)
+     /  T    /
+     /  |   /
+     /  | . /
+     \/  \/ \
+      \  \   \
+       \  \  \
+        \  > \
+       /^ / ^\
+      ^^^~ ~~~mOm
+    END
+    GREEK = <<-'END'
+                       ___
+                      /.  `\
+                     / , ` |
+                     /^\__/'
+                _,--~,  /_
+              /'  ~~~ -__ ~-,
+             ,/  ,       _   \
+            / |`-_  _ '_/%\  `\
+           /  |_,    ~~ __/`\  \
+    ,--~~"'  / \      `--/   |, >
+   //^|~~---'  ;  ,     ,    |  '
+             ,'`      , (    | /
+           ,'   `;;;,'   \  ,' |
+          /      77);     `./||`
+         /      ,"^  \,     ,
+        /      /       \     ,
+        (    ,'         \    |
+        \    `.          \_-  \
+         \     ;           \   `,
+          `    '            \   |
+            \  `             \  `
+             |  )             `, `.
+            /   '             ,'  )
+           mooO'             Ooom'     mOm
+
+    END
+  end
+end

data/lib/vamp/graphic/context.rb

@@ -0,0 +1,142 @@
+require "forwardable"
+require_relative "dotter"
+require_relative "text_dotter"
+require_relative "transfer"
+require_relative "transfer5"
+
+module Vamp
+  module Graphic
+    # Graphic Context
+    class Context
+      extend Forwardable
+
+      def_delegators :@dotter, :dot, :dot?, :undot, :in?, :clear, :screen, :width, :height
+
+      attr_reader :dotter       # can set a dot within [0, width] [0, height[]]
+
+      def initialize(dotter)
+        @dotter = dotter
+      end
+
+      # Cohen–Sutherland clipping algorithm clips a line from
+      # P0 = (x0, y0) to P1 = (x1, y1) against a rectangle with
+      # diagonal from (xmin, ymin) to (xmax, ymax).
+      def line(x0, y0, x1, y1)
+        xmin = 0.0
+        ymin = 0.0
+        xmax = width - 1.0
+        ymax = height - 1.0
+
+        # compute outcodes for P0, P1, and whatever point lies outside the clip rectangle
+        outcode0 = compute_out_code(x0, y0)
+        outcode1 = compute_out_code(x1, y1)
+
+        accept = false
+
+        while true
+          if 0 == (outcode0 | outcode1)     # Bitwise OR is 0. Trivially accept and get out of loop
+            accept = true
+            break
+          elsif 0 != (outcode0 & outcode1)  # Bitwise AND is not 0. Trivially reject and get out of loop
+            break
+          else
+            # failed both tests, so calculate the line segment to clip
+            # from an outside point to an intersection with clip edge
+
+            # At least one endpoint is outside the clip rectangle; pick it.
+            outcodeOut = outcode0 != 0 ? outcode0 : outcode1
+
+
+            # Now find the intersection point;
+            # use formulas y = y0 + slope * (x - x0), x = x0 + (1 / slope) * (y - y0)
+            if 0 != (outcodeOut & TOP)            # point is above the clip rectangle
+              x = x0.to_f + (x1 - x0) * (ymax - y0) / (y1 - y0)
+              y = ymax
+            elsif (0 != outcodeOut & BOTTOM)      # point is below the clip rectangle
+              x = x0.to_f + (x1 - x0) * (ymin - y0) / (y1 - y0)
+              y = ymin
+            elsif (0 != outcodeOut & RIGHT)       # point is to the right of clip rectangle
+              y = y0.to_f + (y1 - y0) * (xmax - x0) / (x1 - x0)
+              x = xmax
+            elsif (0 != outcodeOut & LEFT)        # point is to the left of clip rectangle
+              y = y0.to_f + (y1 - y0) * (xmin - x0) / (x1 - x0)
+              x = xmin
+            end
+
+            # Now we move outside point to intersection point to clip
+            # and get ready for next pass.
+            if outcodeOut == outcode0
+              x0 = x
+              y0 = y
+              outcode0 = compute_out_code(x0, y0)
+            else
+              x1 = x
+              y1 = y
+              outcode1 = compute_out_code(x1, y1)
+            end
+          end
+        end
+        if accept
+          draw_line_direct (x0 + 0.5).to_i, (y0 + 0.5).to_i, (x1 + 0.5).to_i, (y1 + 0.5).to_i
+        end
+        self
+      end
+
+      # protected
+
+      # Bresenham's line algorithm
+      def draw_line_direct(x0, y0, x1, y1)
+        dx = (x1 - x0).abs
+        sx = x0 < x1 ? 1 : -1
+        dy = -(y1 - y0).abs
+        sy = y0 < y1 ? 1 : -1
+        err = dx + dy
+        while true
+          dot(x0, y0)
+          break if x0 == x1 && y0 == y1
+          e2 = 2 * err
+          if e2 > dy
+            err += dy
+            x0 += sx
+          end
+          if e2 < dx
+            err += dx
+            y0 += sy
+          end
+        end
+        self
+      end
+
+      private
+
+      # clipping area constants
+      INSIDE  = 0; # 0000
+      LEFT    = 1; # 0001
+      RIGHT   = 2; # 0010
+      BOTTOM  = 4; # 0100
+      TOP     = 8; # 1000
+
+      # Compute the bit code for a point (x, y) using the clip rectangle
+      # bounded diagonally by (xmin, ymin), and (xmax, ymax)
+      def compute_out_code(x, y)
+        xmin = 0
+        ymin = 0
+        xmax = width - 1
+        ymax = height - 1
+        code = INSIDE    # initialised as being inside of clip window
+
+        if x < xmin      # to the left of clip window
+          code |= LEFT
+        elsif x > xmax   # to the right of clip window
+          code |= RIGHT
+        end
+        if y < ymin      # below the clip window
+          code |= BOTTOM
+        elsif y > ymax   # above the clip window
+          code |= TOP
+        end
+        code
+      end
+    end
+  end
+end

data/lib/vamp/graphic/dotter.rb

@@ -0,0 +1,53 @@
+module Vamp
+  module Graphic
+    # basis class for graphic implementations
+    # you have to implement :dot, :undot, :clear and :screen
+    class Dotter
+      attr_reader :width        # number of dots in x direction
+      attr_reader :height       # number of dots in y direction
+
+      def initialize(width, height)
+        @width = width
+        @height = height
+        clear
+      end
+
+      # put dot at x, ys
+      def dot(x, y)
+        check(x, y)
+        self
+      end
+
+      # is there a dot at x, y
+      def dot?(x, y)
+        check(x, y)
+      end
+
+      # remove dot at x, y
+      def undot(x, y)
+        check(x, y)
+        self
+      end
+
+      # clear screen of all dots
+      def clear
+        self
+      end
+
+      # return complete screen as string representation
+      def screen
+      end
+
+      # check if (x, y) is on the screen
+      def in?(x, y)
+        (0...width)  === x && (0...height) === y
+      end
+
+      # check if (x, y) is on the screen, fails if not
+      def check(x, y)
+        fail "for (#{x}, #{y}}: x not in [0, #{width}["  unless (0...width)  === x
+        fail "for (#{x}, #{y}}: y not in [0, #{height}[" unless (0...height) === y
+      end
+    end
+  end
+end

data/lib/vamp/graphic/text_dotter.rb

@@ -0,0 +1,35 @@
+require_relative "dotter"
+
+module Vamp
+  module Graphic
+    # simple sample implementation for a graphic basic implementation
+    class TextDotter < Dotter
+      def dot(x, y)
+        super
+        @data[y][x] = "X"
+        self
+      end
+
+      def dot?(x, y)
+        super
+        @data[y][x] == "X"
+      end
+
+      def undot(x, y)
+        super
+        @data[y][x] = " "
+        self
+      end
+
+      def clear
+        @data = Array.new(height) { Array.new(width, " ") }
+        self
+      end
+
+      def screen
+        line = "+" + "-" * width + "+\n"
+        line + @data.map { |x| "|#{x.join('')}|" }.join("\n").to_s + "\n" + line
+      end
+    end
+  end
+end

data/lib/vamp/graphic/transfer.rb

@@ -0,0 +1,170 @@
+module Vamp
+  module Graphic
+    # Transfer dotter data into ASCII
+    class Transfer
+
+      attr_reader :char_width
+      attr_reader :char_height
+      attr_reader :context
+      attr_reader :mapping
+
+      SPACE = <<-'END'
+___
+___
+___
+      END
+
+      SLASH = <<-'END'
+__X
+_X_
+X__
+      END
+
+      BACKSLASH = <<-'END'
+X__
+_X_
+__X
+      END
+
+      BACKTICK = <<-'END'
+X__
+___
+___
+      END
+
+      PIPE = <<-'END'
+_X_
+_X_
+_X_
+      END
+
+      MINUS = <<-'END'
+___
+XXX
+___
+      END
+
+      UNDERSCORE = <<-'END'
+___
+___
+XXX
+      END
+
+      FULLSTOP = <<-'END'
+___
+___
+_X_
+      END
+
+      DOUBLEQUOTES = <<-'END'
+X_X
+___
+___
+      END
+
+      SINGLEQUOTE = <<-'END'
+_X_
+___
+___
+      END
+
+      STAR = <<-'END'
+_X_
+XXX
+_X_
+      END
+
+      HASH = <<-'END'
+XXX
+XXX
+XXX
+      END
+
+      def initialize(context)
+        @context = context
+        @char_width = 3
+        @char_height = 3
+        @mapping = {
+            " "  => create_pattern(SPACE),
+            "/"  => create_pattern(SLASH),
+            "\\" => create_pattern(BACKSLASH),
+            "`"  => create_pattern(BACKTICK),
+            "|"  => create_pattern(PIPE),
+            "-"  => create_pattern(MINUS),
+            "_"  => create_pattern(UNDERSCORE),
+            "."  => create_pattern(FULLSTOP),
+            "\"" => create_pattern(DOUBLEQUOTES),
+            "'"  => create_pattern(SINGLEQUOTE),
+            "*"  => create_pattern(STAR),
+            "\#" => create_pattern(HASH),
+        }
+      end
+
+      def create_data(pattern)
+        a = pattern.split("\n")
+        fail "pattern has wrong height" if a.size != char_height
+        char_height.times do |dy|
+          fail "pattern has wrong width" if a[dy].size != char_width
+        end
+        a
+      end
+
+      def create_pattern(pattern)
+        char = TextDotter.new(char_width, char_height)
+        a = create_data(pattern)
+        char_height.times do |y|
+          char_width.times do |x|
+            char.dot(x, y) if a[y][x] == "X"
+          end
+        end
+        char
+      end
+
+      def get_pattern(x, y)
+        pattern = ""
+        char_height.times do |dy|
+          char_width.times do |dx|
+            if context.in?(x + dx, y + dy)
+              pattern += (context.dot?(x + dx, y + dy) ? "X" : "_")
+            else
+              pattern += "_"
+            end
+          end
+          pattern += "\n"
+        end
+        create_pattern(pattern.strip)
+      end
+
+      def difference(pattern1, pattern2)
+        m = 0
+        char_width.times do |dx|
+          char_height.times do |dy|
+            m += 1 if pattern1.dot?(dx, dy) != pattern2.dot?(dx, dy)
+          end
+        end
+        m
+      end
+
+      def get_matching(pattern)
+        ranking = {}
+        mapping.each do |k, v|
+          r = difference(pattern, v)
+          ranking[k] = r
+        end
+        ranking.min_by{|k, v| v}[0]
+      end
+
+
+      def ascii
+        a = ""
+        (context.height / char_height).times do |y|
+          (context.width / char_width).times do |x|
+            a += get_matching(get_pattern(x * char_width, y * char_height))
+          end
+          a += "\n"
+        end
+        a.chomp
+      end
+    end
+  end
+end