starlined 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f888548f69dc89b4370d0e53b5519de9801aea7c80b0afa082bd8e1b8eea7d
-  data.tar.gz: c98ca5605a8fcfd7964dd83c092a6a4adc9099c46f45d98851e73a0347f74471
+  metadata.gz: 9d9ab3da983ad9f964ebb269a39173a8399167d485d8e01beea227677a9040a8
+  data.tar.gz: fe0167c40eada1ac3944504db6caf3039db6f092a888f64fbb58fa46ce1dc358
 SHA512:
-  metadata.gz: 531927461b447b1def71be1a7fb01a4fd7776251edb6959a7a285cc9df91fecab449c2e891f07d21724f16180c7971e075d44e5e05e6a26567f7ad2868f4b3e6
-  data.tar.gz: 6b2668fb896d46fb9824fb982a2f039bc6be83495c7d40dbde14d75df662601439306425bc8df9848006ac0e0976fd284a1663f1e9b780c5bc2ab2bb085297a1
+  metadata.gz: b121573babef094896871fa3a7542dbef69084616d6ff514314d994ce0aa3309cd5c4fbe1cc3ee34a0339ec42bc386aeeb251f29d04df33f83665869eca4503d
+  data.tar.gz: 9005aeeca2e28607cb2eac4829401e28a2203a4f82d860fb90c2e5a6dc9975eb8a0b5af3d5df648e51d2c763e4dfc08123f1ad2a7d216abc0d098d08b6febe0a

data/LICENSE.txt

@@ -1,21 +1 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Mier
-
-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.
+Juan Mier <mier@mier.info>, CC-NC-BY-4.0

data/README.md

@@ -1,148 +1,84 @@
-# Starlined
+# starlined 🌟
 
-A Ruby gem that provides beautiful terminal output utilities with animated star progress indicators, colored messages, and command execution with visual feedback.
+terminal output gem with animated stars, colored messages, and progress tracking.
 
-## Features
-
-- 🌟 **Animated Progress Indicators** - Beautiful star animations that move while commands execute
-- 🎨 **Colored Messages** - Error, info, warning, and success messages with appropriate colors
-- 🔄 **Thread-Safe Operations** - Safe to use with parallel command execution
-- ⚡ **Command Runner** - Execute shell commands with automatic progress animation
-- 🔧 **Highly Configurable** - Customize animation speed, message formatting, and more
-
-## Installation
-
-Add this line to your application's Gemfile:
+## install
 
 ```ruby
 gem 'starlined'
 ```
 
-And then execute:
-
-```bash
-bundle install
-```
-
-Or install it yourself as:
-
-```bash
-gem install starlined
-```
-
-## Usage
+## usage
 
-### Basic Message Output
+### basic messages
 
 ```ruby
 require 'starlined'
-
-# include the messages module for easy access
 include Starlined::Messages
 
-# display various message types
-info("Starting application...")
-warn("Configuration file not found, using defaults")
-error("Connection failed", "Database timeout")
-success("Build completed", 3.5) # with elapsed time
-verbose("Debug information") # only shown if verbose mode is enabled
+info "Starting deployment"
+warn "Config file missing"
+error "Connection failed"
+success "Build complete", 3.5  # with elapsed time
 ```
 
-### Animated Command Execution
+### run with animation (sequentially)
 
 ```ruby
 runner = Starlined::Runner.new
+runner.start("Installing deps", steps: 3)
 
-# start an animation with a message
-runner.start("Installing dependencies", steps: 3)
-
-# run commands with animation
 runner.run("bundle install", aka: "bundler")
 runner.run("npm install", aka: "npm")
-runner.run("rake db:migrate", aka: "migrations")
+runner.run("rake db:migrate", aka: "database")
 
-# stop animation and show success
 runner.stop
 ```
 
-### Interactive Input
+The `aka` parameter shows what's currently running in the animation.
 
-```ruby
-include Starlined::Messages
-
-response = ask("What's your project name?")
-puts "Creating project: #{response}"
-```
-
-### Configuration
-
-```ruby
-Starlined.configure do |config|
-  config.verbose = true          # enable verbose output
-  config.sleep_time = 0.5        # animation speed (seconds)
-  config.msg_ljust = 40          # message padding
-  config.stars_range = (0..7)    # animation width
-end
-```
-
-### Advanced Usage with Parallel Execution
+### run in parallel
 
 ```ruby
 runner = Starlined::Runner.new
 runner.start("Running tests", steps: 3)
 
 threads = []
-threads << Thread.new { runner.run("rspec spec/models", aka: "models") }
-threads << Thread.new { runner.run("rspec spec/controllers", aka: "controllers") }
-threads << Thread.new { runner.run("rspec spec/helpers", aka: "helpers") }
-
+threads << Thread.new { runner.run("rspec spec/models") }
+threads << Thread.new { runner.run("rspec spec/controllers") }
+threads << Thread.new { runner.run("rspec spec/features") }
 threads.each(&:join)
+
 runner.stop
 ```
 
-### Using Animation Directly
+### animation manipulation/control
 
 ```ruby
-animation = Starlined::Animation.new("Processing files", steps: 100)
+animation = Starlined::Animation.new("Processing", steps: 100)
 animation.start
 
 100.times do |i|
-  # do some work
-  sleep(0.1)
+  # do work
   animation.increment_step
   animation.add_alias("file_#{i}.txt")
-  # more work
+  sleep 0.1
   animation.remove_alias("file_#{i}.txt")
 end
 
 animation.stop
 ```
 
-## Configuration Options
-
-| Option | Default | Description |
-|--------|---------|-------------|
-| `sleep_time` | `0.75` | Time between animation frames (seconds) |
-| `msg_ljust` | `30` | Left padding for messages |
-| `extra_rjust` | `8` | Right padding for extra info |
-| `stars_range` | `(0..5)` | Range for star animation positions |
-| `verbose` | `false` | Enable verbose output |
-| `clear_line_string` | `"\33[2K"` | ANSI code to clear terminal line |
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+### custom configuration
 
-To install this gem onto your local machine, run `bundle exec rake install`.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/starlined.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+Starlined.configure do |config|
+  config.vrbose = true         # show verbose messages
+  config.sleep_time = 0.5      # animation speed
+  config.msg_ljust = 40        # message padding
+end
+```
 
-## Author
+## license
 
-Created by Mier - Extracted from the Okticket builder script utilities.
+CC-NC-BY-4.0, open-sourced from [okticket](https://okticket.es)

data/examples/basic_messages.rb

@@ -19,10 +19,10 @@ sleep(1)
 
 # configurar modo verbose
 Starlined.configure do |config|
-  config.verbose = true
+  config.vrbose = true
 end
 
-verbose("This verbose message is now visible")
+vrbose("This verbose message is now visible")
 sleep(1)
 
 # ejemplo con error (comentado para no salir del programa)

data/lib/starlined/animation.rb

@@ -7,7 +7,7 @@ module Starlined
     attr_reader :thread, :message, :start_time, :steps, :current_steps
     attr_accessor :aliases
 
-    def initialize(message = "Booting up", steps = 0)
+    def initialize(message = 'Booting up', steps = 0)
       @message = message
       @start_time = Time.now
       @steps = steps
@@ -17,13 +17,12 @@ module Starlined
       @pos = [0, 1, 2]
       @move = 1
 
-      # manejo de aliases
+      # manejo de alias
       @aliases = []
       @alias_pointer = 0
       @alias_timer = 0
       @alias_semaphore = Mutex.new
 
-      # semáforo para pasos
       @steps_semaphore = Mutex.new
 
       @running = false
@@ -32,12 +31,14 @@ module Starlined
 
     def start
       return if @running
+
       @running = true
       @thread = Thread.new { animation_loop }
     end
 
     def stop
       return unless @running
+
       @running = false
       @thread&.kill
       @thread = nil
@@ -51,15 +52,17 @@ module Starlined
 
     def add_alias(aka)
       return if aka.nil?
+
       @alias_semaphore.synchronize { @aliases.push(aka) }
     end
 
     def remove_alias(aka)
       return if aka.nil?
+
       @alias_semaphore.synchronize do
         @aliases.delete(aka)
         # ajustar el puntero si se eliminó un elemento antes de la posición actual
-        @alias_pointer = 0 if @alias_pointer >= @aliases.length && @aliases.length > 0
+        @alias_pointer = 0 if @alias_pointer >= @aliases.length && !@aliases.empty?
       end
     end
 
@@ -87,16 +90,16 @@ module Starlined
     end
 
     def build_stars
-      stars = ""
+      stars = ''
       config = Starlined.configuration
 
       config.stars_range.each do |i|
-        if !@pos.include?(i)
-          stars += " "
-        elsif i == @pos[1]
-          stars += "*".bold.red
-        else
-          stars += "*".yellow
+        if !@pos.include?(i) # caso: posición vacía
+          stars += ' '
+        elsif i == @pos[1]   # caso: estrella central
+          stars += config.symbol.bold.red
+        else                 # caso: estrellas laterales
+          stars += config.symbol.yellow
         end
       end
 

data/lib/starlined/configuration.rb

@@ -3,15 +3,16 @@
 module Starlined
   class Configuration
     attr_accessor :sleep_time, :msg_ljust, :extra_rjust, :stars_range,
-                  :verbose, :clear_line_string
+                  :vrbose, :clear_line_string, :symbol
 
     def initialize
       @sleep_time = 0.75
       @msg_ljust = 30
       @extra_rjust = 8
       @stars_range = (0..5).to_a
-      @verbose = false
+      @vrbose = false
       @clear_line_string = "\33[2K"
+      @symbol = '*'
     end
   end
 end

data/lib/starlined/messages.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "colorize"
+require 'colorize'
 
 module Starlined
   module Messages
@@ -8,41 +8,42 @@ module Starlined
 
     def error(message = nil, context = nil)
       clear_line
-      output = "\r[#{"FAILED".red}] #{context || "Operation failed"}"
+      output = "\r[#{'FAILED'.red}] #{context || 'Operation failed'}"
       output += " (#{message})" unless message.nil?
       puts output
     end
 
     def info(message)
       clear_line
-      puts "\r[ #{"INFO".blue} ] #{message}"
+      puts "\r[ #{'INFO'.blue} ] #{message}"
     end
 
     def warn(message)
       clear_line
-      puts "\r[ #{"WARN".yellow} ] #{message}"
+      puts "\r[ #{'WARN'.yellow} ] #{message}"
     end
 
     def success(message, time = nil)
       clear_line
-      output = "\r[  #{"OK".green}  ] #{message}"
+      output = "\r[  #{'OK'.green}  ] #{message}"
       if time
-        dots = "." * [3, 36 - message.length - time.to_s.length].max
+        dots = '.' * [3, 36 - message.length - time.to_s.length].max
         output += " #{dots.bold.gray} #{time}s"
       end
       puts output
     end
 
-    def verbose(message)
-      return unless Starlined.configuration.verbose
+    def vrbose(message)
+      return unless Starlined.configuration.vrbose
+
       clear_line
-      puts "\r[#{"VRBOSE".light_black}] #{message}"
+      puts "\r[#{'VRBOSE'.light_black}] #{message}"
     end
 
     def ask(prompt)
       clear_line
-      print "\r[  #{"??".light_blue}  ] #{prompt}: "
-      STDIN.gets.chomp
+      print "\r[  #{'??'.light_blue}  ] #{prompt}: "
+      $stdin.gets.chomp
     end
 
     private

data/lib/starlined/runner.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "open3"
-require "colorize"
+require 'open3'
+require 'colorize'
 
 module Starlined
   class Runner
@@ -26,40 +26,28 @@ module Starlined
       stop_animation
     end
 
-    def run(command, print_err = true, aka: nil, no_count: false)
-      needs_sudo = !!(command =~ /^sudo/)
-
-      execute(
-        -> { Open3.capture3(command) },
-        print_err,
-        aka: aka,
-        no_count: no_count,
-        sudo: needs_sudo,
-      )
-    end
-
-    def execute(callback, print_err = true, aka: nil, no_count: false, sudo: false)
-      handle_sudo if sudo
+    # Función que se encarga de ejecutar comandos y mostrar animaciones por pantalla.
+    # Utiliza un hilo separado para las animaciones y comprueba el exitcode de los callbacks
+    # para detectar errores. Si se ejecutan múltiples instancias de manera simultánea
+    # (como cuando se ejecutan comandos en paralelo), se utiliza un semáforo para controlar
+    # que no se creen más de un hilo de animación. Si se ejecuta un comando que requiere
+    # permisos de sudo, detecta si necesita contraseña y para la animación según corresponda.
+    def run(command, print_err: true, aka: nil, no_count: false)
+      handle_sudo if !!(command =~ /^sudo/)
 
       @run_semaphore.synchronize do
         @animation&.add_alias(aka) unless aka.nil?
-
-        if @run_instances == 0 && @animation
-          @animation.start
-        end
+        @animation.start if @run_instances.zero? && @animation
         @run_instances += 1
       end
 
-      result = callback.call
+      result = -> { Open3.capture3(command) }.call
 
       @run_semaphore.synchronize do
         @run_instances -= 1
         @animation&.increment_step unless no_count
         @animation&.remove_alias(aka) unless aka.nil?
-
-        if @run_instances == 0 && @animation
-          @animation.stop
-        end
+        @animation.stop if @run_instances.zero? && @animation
       end
 
       handle_error(result, print_err) unless result.last.success?
@@ -75,23 +63,22 @@ module Starlined
     end
 
     def handle_sudo
-      needs_password = !system("sudo -n true &>/dev/null")
+      needs_password = !system('sudo -n true &>/dev/null')
+      return unless needs_password || RUBY_PLATFORM.include?('darwin')
 
-      if needs_password || RUBY_PLATFORM.include?("darwin")
-        stop_animation
+      stop_animation
 
-        if needs_password
-          # alertar al usuario con diferentes métodos
-          print "\a" # terminal bell
-          system("tput bel 2>/dev/null") # alternative bell
-          Messages.info("Password required")
-        end
+      if needs_password
+        # alertar al usuario con diferentes métodos
+        print "\a" # terminal bell
+        system('tput bel 2>/dev/null') # alternative bell
+        Messages.info('Password required')
+      end
 
-        result = system("sudo -v")
-        raise "Sudo privileges not granted" unless result
+      result = system('sudo -v')
+      raise 'Sudo privileges not granted' unless result
 
-        @animation&.start if @run_instances != 0
-      end
+      @animation&.start if @run_instances != 0
     end
 
     def handle_error(result, print_err)
@@ -99,11 +86,9 @@ module Starlined
 
       stop_animation
       Messages.error(nil, @animation&.message)
+      puts result[1].empty? ? result[0] : result[1] # stdout si stderr está vacío
 
-      puts result[1] # stderr
-      puts result[0] if result[1].empty? # stdout si stderr está vacío
-
-      Messages.verbose("Exit code: #{result.last.exitstatus}")
+      Messages.vrbose("Exit code: #{result.last.exitstatus}")
       exit 1
     end
   end

data/lib/starlined/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Starlined
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/starlined.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "open3"
-require "colorize"
+require 'open3'
+require 'colorize'
 
-require_relative "starlined/version"
-require_relative "starlined/configuration"
-require_relative "starlined/animation"
-require_relative "starlined/messages"
-require_relative "starlined/runner"
+require_relative 'starlined/version'
+require_relative 'starlined/configuration'
+require_relative 'starlined/animation'
+require_relative 'starlined/messages'
+require_relative 'starlined/runner'
 
 module Starlined
   class << self

data/starlined.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Terminal output utilities with animated progress indicators"
   spec.homepage = "https://github.com/miermontoto/starlined"
-  spec.license = "MIT"
+  spec.license = "CC-NC-BY-4.0"
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starlined
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - mier
@@ -117,7 +117,7 @@ files:
 - starlined.gemspec
 homepage: https://github.com/miermontoto/starlined
 licenses:
-- MIT
+- CC-NC-BY-4.0
 metadata:
   homepage_uri: https://github.com/miermontoto/starlined
   source_code_uri: https://github.com/miermontoto/starlined