diamante 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6b43ae1ec66a8f51786fd345c7d621608a4e3620aa5d218d86258fa5290f039
-  data.tar.gz: 3418eae92c72e9d50eb69f1c0143c3f071467260f17bb2dde51800e64f2e786a
+  metadata.gz: 7607a260666a965bd57829cb9fb3955b0aab16b04f88475662238af66efcb2bb
+  data.tar.gz: f394a8fafab95e0fece4367014bc09ce5e45c2df92a8216b31c3da5e5d137d4c
 SHA512:
-  metadata.gz: e36fcfd32c5e8a69dd0defabbc48c358a90161253b74428e6ca00476f476ce26874ff0f10accbb193a53ad916620a2195d80127ade727779b5f4b59aedc178b1
-  data.tar.gz: 2357d1df863b9828e935bc975409729ab0bf7f207e4aef2b8e144c67e2ae4d7e8ddcf9a4f0a868f650102da42b19c956498ea80dee45a36018ba9fc46d2ca376
+  metadata.gz: d125e9bf5ef1c98df9eb90320192cc09977e4a84f35bf7b33b160da0be5a1a8bad47e54b0b6b857e3df51d9d77201625c23b606377453a44615cfec2f672c829
+  data.tar.gz: efaf5b5b80af5c8dd5da9f84570834742bed9db047d610466e32564f2925b167737ed82184e6dab4c9c51d247ebb5d36c19a39a5b88dc9cc045f0595ec287f9b

data/README.md

@@ -1,6 +1,6 @@
 # Diamante
 
-Presentar diapositivas en el temrinal.
+Presentar diapositivas en el terminal.
 
 ## Instalación
 
@@ -9,27 +9,63 @@ Presentar diapositivas en el temrinal.
 
 ## Modo de uso
 
-* Crear una carpeta con el fichero de configuración YAML y las diapositivas en ficheros de texto. [Ver ejemplo](./examples/yaml/).
-* Abrir un terminal.
-* Ejecutar `diamante show PATH/TO/CONFIG.yaml`.
+```bash
+$ diamante PATH/TO/CONFIG.yaml
+```
+
+* Crear una carpeta con el fichero de configuración (YAML) y las diapositivas en ficheros de texto. [Ver ejemplo](./examples/data/).
+
+```bash
+examples/data
+├── 01.txt
+├── 02.txt
+├── 03.txt
+└── 04.txt
+```
+* Ejecutar `diamante show examples/matrix.yaml`.
+
+![](./docs/example.png)
+
+| Tecla | Función                       |
+| ----- | ----------------------------- |
+| q     | Salir de la presentación      |
+| right | Ir a la siguiente diapositiva |
+| left  | Ir a la diapositiva anterior  |
 
 ## Características
 
 * El contenido de cada diapositiva va en un fichero de texto separado.
 * El fichero de configuración tiene el siguiente formato:
 ```yaml
-:header: "Gema diamante"
-:files: "examples/yaml/*.txt"
-:bye: "Morpheus: 'Follow me.'"
+:game:
+  :bye: "Morpheus: 'Follow me.'"  
+:bg:
+  :scene: Matrix
+  :chars: "!#$%&\\\/()*+,-.01:;<=>?@[]^_oO{}|ª·¿•xX "
+:fg:
+  :scene: Slides
+  :files: "examples/data/*.txt"
+:ui:
+  :scene: UI
+  :header: "Gema diamante"
 ```
 
-Significado de los parámetros:
+* Significado de los parámetros de configuración:
+
+| Sección   | Parámetro   | Descripción          |
+| --------- | ----------- | -------------------- |
+| `:game`   | `:bye`      | Mensaje de despedida |
+| `:bg`     | `:scene`    | Escena de background |
+| `:bg`     | `:chars`    | Caracteres para el efecto Matrix |
+| `:fg`     | `:scene`    | Escena de foreground |
+| `:fg`     | `:files`    | Ficheros de texto con las diapositivas |
+| `:ui`     | `:scene`    | Escena del interfaz de usuario |
+| `:ui`     | `:header`   | Título de la presentación |
+
+## Desarrollo
 
-| Parámetro | Descripción |
-| --------- | ----------- |
-| `:header` | Título de la presentación |
-| `:files`  | Ficheros de texto que contienen las diapositivas |
-| `:bye`    | Mensaje de despedida |
+* La biblioteca está hecha de forma modular para poder usar distintas escenas de background, foreground o user interface en el futuro.
+* Actualmente no se están usando los parámetros `:scene`, pero en un futuro permitirán definir las escenas a cargar para reproducir la presentación.
 
 ## Contributing
 

data/lib/diamante/cli.rb

@@ -13,6 +13,12 @@ class CLI < Thor
     exit 0
   end
 
+  map ["n", "-n", "--new"] => "new"
+  desc "new", "Create new project"
+  def new(dirpath)
+    Diamante.new(dirpath)
+  end
+
   map ["r", "-r", "--restart"] => "restart"
   desc "restart", "Restart ANSI terminal"
   def restart

data/lib/diamante/files/config.yaml

@@ -0,0 +1,11 @@
+:game:
+  :bye: "Morpheus: 'Follow me.'"  
+:bg:
+  :scene: Matrix
+  :chars: "!#$%&\\\/()*+,-.01:;<=>?@[]^_oO{}|ª·¿•xX "
+:fg:
+  :scene: Slides
+  :files: "PATH/TO/*.txt"
+:ui:
+  :scene: UI
+  :header: "New project"

data/lib/diamante/game.rb

@@ -2,9 +2,7 @@
 
 require_relative "ansi"
 require_relative "config"
-require_relative "scenes/matrix"
-require_relative "scenes/slides"
-require_relative "scenes/ui"
+require_relative "scenes/scene_factory"
 
 module Diamante
   class Game
@@ -17,7 +15,7 @@ module Diamante
       begin
         init
         loop do
-          process
+          update
           render
           sleep 0.1
         end
@@ -31,9 +29,10 @@ module Diamante
 
     def init
       ANSI.set_raw_mode
-      scene1 = Scene::Matrix.new(@config[:bg])
-      scene2 = Scene::Slides.new(@config[:fg])
-      scene3 = Scene::UI.new(@config[:ui], scene2)
+      scene1 = Scene::SceneFactory.create(@config[:bg])
+      scene2 = Scene::SceneFactory.create(@config[:fg])
+      scene3 = Scene::SceneFactory.create(@config[:ui])
+      scene3.slides = scene2
       @scenes = {
         bg: scene1,
         fg: scene2,
@@ -41,16 +40,22 @@ module Diamante
       }
     end
 
-    def process
+    def update
       key = ANSI.pressed_key
           
       case key
       when :up    then puts "↑ Arriba"
       when :down  then puts "↓ Abajo"
-      when :left  then @scenes[:fg].prev
-      when :right then @scenes[:fg].next
+      when :left  then
+        @scenes[:bg].init
+        @scenes[:fg].prev
+      when :right then
+        @scenes[:bg].init
+        @scenes[:fg].next
       when :quit  then deinit
       end
+
+      @scenes.each_value { _1.update }
     end
 
     def render

data/lib/diamante/project.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'fileutils'
+
+module Diamante
+  class Project
+    def self.new(dirpath)
+      puts "==> Creating new project"
+
+      FileUtils.mkdir_p(dirpath)
+      puts "--> Create dir  : #{dirpath}"
+
+      source_file = File.join(__dir__, 'files', 'config.yaml')
+      if File.exist?(source_file)
+        FileUtils.cp(source_file, dirpath)
+        puts "--> Create file : #{dirpath}/config.yaml"
+      else
+        puts "Error: El archivo no existe en la ruta esperada: #{source_file}"
+      end
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+    end
+  end
+end

data/lib/diamante/scenes/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Diamante
+  module Scene
+    class Base
+      def update
+      end
+
+      def render
+      end
+    end
+  end
+end

data/lib/diamante/scenes/matrix.rb

@@ -1,23 +1,27 @@
 # frozen_string_literal: true
 
 require "pastel"
+require_relative "base"
 require_relative "../ansi"
 
 module Diamante
   module Scene
-    class Matrix
+    class Matrix < Base
     
       def initialize(config)
-        @config = config # todo: elegible_chars
+        @config = config
         @pastel = Pastel.new
-        # @eligible_chars = "ª\|@·#$~%&/\¿¸^*¨;•:·_-+'.,".chars + ['.', ' ']
         @matrix_chars = @config[:chars].chars
         @term = ANSI.new
         @height = @term.height
         @width = @term.width
-        @chars = {}
+        init
       end
       
+      def init
+        @chars = {}
+      end
+
       def render
         @chars[rand(@width)] = 0
     

data/lib/diamante/scenes/scene_factory.rb

@@ -0,0 +1,25 @@
+require_relative "matrix"
+require_relative "slides"
+require_relative "space"
+require_relative "ui"
+
+module Diamante
+  module Scene
+    class SceneFactory
+      def self.create(config)
+        klass_name = config[:scene]
+
+        case klass_name
+        when "Matrix" then return Matrix.new(config)
+        when "Slides" then return Slides.new(config)
+        when "Space" then return Space.new(config)
+        when "UI" then return UI.new(config)
+        else
+          warn "[SceneFactory] Unkown scene! (#{klass_name})"
+          exit 1
+        end
+      end
+    end
+  end
+end
+

data/lib/diamante/scenes/slides.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require "pastel"
+require_relative "base"
 require_relative "../ansi"
 
 module Diamante
   module Scene
-    class Slides
+    class Slides < Base
       attr_reader :index
     
       def initialize(config)
@@ -16,6 +17,11 @@ module Diamante
         @width = @term.width
 
         @files = Dir.glob(@config[:files])
+        if @files.empty?
+          ANSI.set_cooked_mode
+          warn "[ERROR] No slides! Revise config.yaml"
+          exit 1
+        end
         @index = 0
         load_slide
       end
@@ -52,8 +58,12 @@ module Diamante
   
       def load_slide
         @chars = {}
-        ANSI.clear_screen  
-        @slide = File.readlines(@files[@index])
+        ANSI.clear_screen
+        if @files[@index].nil?
+          @slide = "Undefined!"
+        else
+          @slide = File.readlines(@files[@index])
+        end
       end
     end  
   end

data/lib/diamante/scenes/space.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "pastel"
+require_relative "base"
+require_relative "../ansi"
+
+module Diamante
+  module Scene
+    class Space < Base
+      def initialize(config)
+        @config = config
+        @chars_list = "-O "
+        init
+      end
+      
+      def init
+        @stars = []
+        5.times { @stars << Star.new }
+      end
+
+      def update
+        @stars.each { _1.render }
+      end
+
+      def render
+        @stars.each { _1.update }
+      end
+        
+      private 
+
+      class Star
+        attr_reader :char
+        attr_reader :x
+        attr_reader :y
+
+        def initialize
+          @pastel = Pastel.new
+          @term = ANSI.new
+          @char = @pastel.white.bold("*")
+          @x = 0
+          @y = 0
+          init
+        end
+
+        def init
+          @last_y = @y
+          @last_x = @x
+          @y = rand(@term.height).to_f
+          @x = rand(@term.width).to_f
+          @speed = rand * 0.000000001
+        end
+
+        def update
+          sleep 0.1
+          @last_y = @y
+          @last_x = @x
+          @x += @x + @speed * 0.000000000001
+          if @x >= @term.width
+            ANSI.print_text_at(@last_y.to_i, @last_x.to_i + 1, " ")
+            @y = rand(@term.height).to_f
+            @x = 0
+            @speed = rand * 0.00000001
+          end
+        end
+
+        def render
+          return if (@x - @last_x + @y - @last_y).zero?
+          ANSI.print_text_at(@last_y.to_i, @last_x.to_i + 1, " ")
+          text = @pastel.white.bold(@char)
+          ANSI.print_text_at(@y.to_i, @x.to_i + 1, text)
+        end
+      end
+    end  
+  end
+end
+

data/lib/diamante/scenes/ui.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require "pastel"
-require_relative "../ansi"
+require_relative "base"
 require_relative "slides"
+require_relative "../ansi"
 
 module Diamante
   module Scene
-    class UI
-      def initialize(config, slides)
+    class UI < Base
+      attr_accessor :slides
+
+      def initialize(config)
         @pastel = Pastel.new
     
         @header = config[:header]

data/lib/diamante/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diamante
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/diamante.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "diamante/md/markdown"
+require_relative "diamante/project"
 require_relative "diamante/version"
 
 module Diamante
 
+  def self.new(dirpath)
+    Project.new(dirpath)
+  end
+
   def self.show(filepath)
     if filepath.end_with? ".md"
       Markdown.new(filepath).show

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diamante
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -70,11 +70,16 @@ files:
 - lib/diamante/ansi.rb
 - lib/diamante/cli.rb
 - lib/diamante/config.rb
+- lib/diamante/files/config.yaml
 - lib/diamante/game.rb
 - lib/diamante/md/markdown.rb
 - lib/diamante/md/parser.rb
+- lib/diamante/project.rb
+- lib/diamante/scenes/base.rb
 - lib/diamante/scenes/matrix.rb
+- lib/diamante/scenes/scene_factory.rb
 - lib/diamante/scenes/slides.rb
+- lib/diamante/scenes/space.rb
 - lib/diamante/scenes/ui.rb
 - lib/diamante/version.rb
 homepage: https://github.com/dvarrui/diamante