handy_toolbox 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8153ab3dd9d135545418c75c5b394a0d05c1462
-  data.tar.gz: 3610c4584474c30ecc9fe3d7567c4ff62acbb650
+  metadata.gz: 1339da7be846b9dc3bce036dbcc4bd9338480709
+  data.tar.gz: 3dc2c7c12dacb1468e2e142f466dba1543f75c0e
 SHA512:
-  metadata.gz: cf1fd975e5ec0e617243b43fa9a85eeb8f75912dfbe9355e1dea6c86efabba5b2ccc5d6dd8bd8621b3eaf61537b539626ad2ca7fd6502c24159b4ee974f85429
-  data.tar.gz: e903eec79411f7040fdc0a18b44b5a3ca964e6a8a999b5c285f886e26ef268e20d56d73d541460534cb7480e3e6d1f10cce52b4c0e6cd8b942b9c6783186ed27
+  metadata.gz: 7cf4d3cae1a4daaed0b2b3e3c029bcb458ea8b76fa229535b522072aff75470de6bcc8d8322b892db7973e3b846a4c62b5b82df3960e1c590d8d05797bb4e75b
+  data.tar.gz: e71a860c3bbceb136a0a8e8be99caffb75ef04809b9c67d300ec8aa44f348ce3e921c11a2afef20c8fe779d8ff8355d036a0ec0ac4c9329a7c664cb0fbf76dd8

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### Changelog
+
+#### 0.1.1
+- Replace title box with full line header
+- Fix text overflow issues for long task description
+
+#### 0.1.0
+- Initial release

data/README.md

@@ -7,12 +7,14 @@ HandyToolbox is a text based user interface that will help you with every day ta
 
 Gem was built for the Rails apps in mind but can be used standalone as well and not only for Ruby related stuff.
 
+View [changelog](CHANGELOG.md).
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'handy_toolbox'
+gem 'handy_toolbox', require: false
 ```
 
 And then execute:
@@ -41,6 +43,14 @@ app = App.new(title: 'Project name')
 app.run
 ```
 
+If you want to use your default terminal colors you can pass extra option to app:
+
+```ruby
+app = App.new(
+  default_colors: true # default is false
+)
+```
+
 ### Defining your tasks
 
 Other example [here](EXAMPLE.md).
@@ -178,11 +188,9 @@ home / end - go to first/last item
 
 ![Main menu](promo/1.png?raw=true)
 
-![Quick tasks](promo/2.png?raw=true)
-
-![Nested menu with loader not executed yet](promo/3.png?raw=true)
+![Simple tasks](promo/2.png?raw=true)
 
-![Loaded data from loader](promo/4.png?raw=true)
+![Long tasks](promo/3.png?raw=true)
 
 ## TODO
 

data/bin/example

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "handy_toolbox"
+include HandyToolbox
+
+
+class RakeLoader < Loader
+  def on_load(node)
+    data = IO.read('fixtures/rakes.txt')
+    data.strip.split("\n").each do |rake|
+      name, desc = rake.split("#")
+      node.tool name.strip, desc: desc.strip
+    end
+  end
+end
+
+class RailsDatabasePlugin < Plugin
+  def on_attach(node)
+    node.menu 'Database' do |db|
+      db.tool 'rails db:migrate', name: 'Migrate database'
+      db.tool 'rails db:test:prepare', name: 'Prepare test database'
+    end
+  end
+end
+
+
+branch = Cmd.exec('git branch').match(/^\* (?<name>.+)$/)[:name]
+app = App.new(
+  title: "My project name (on #{branch})"#,
+  # default_colors: true
+)
+
+app.menu 'Quick' do |quick|
+  quick.menu 'Some'
+  quick.tool 'ls -la', desc: 'Lists current directory'
+end
+
+app.menu 'Rails' do |rails|
+  rails.plugin RailsDatabasePlugin
+  rails.menu_loader 'Rake', RakeLoader
+  rails.menu 'Assets' do |assets|
+    assets.tool 'rake assets:precompile', desc: 'Precompile all the assets'
+  end
+end
+
+app.menu 'Deployment' do |deploy|
+  deploy.tool 'cap staging deploy', name: 'Deploy to staging'
+  deploy.tool 'cap production deploy', name: 'Deploy to production'
+end
+
+app.run

data/fixtures/rakes.txt

@@ -0,0 +1,38 @@
+rake about                              # List versions of all Rails frameworks and the environment
+rake app:template                       # Applies the template supplied by LOCATION=(/path/to/template) or URL
+rake app:update                         # Update configs and some other initially generated files (or use just update:configs or update:bin)
+rake assets:clean[keep]                 # Remove old compiled assets
+rake assets:clobber                     # Remove compiled assets
+rake assets:environment                 # Load asset compile environment
+rake assets:precompile                  # Compile all the assets named in config.assets.precompile
+rake cache_digests:dependencies         # Lookup first-level dependencies for TEMPLATE (like messages/show or comments/_comment.html)
+rake cache_digests:nested_dependencies  # Lookup nested dependencies for TEMPLATE (like messages/show or comments/_comment.html)
+rake db:create                          # Creates the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:create:all to create all databases in the config). Without RAILS_ENV or when RAILS_ENV is development, it defaults to creating the development and test databases
+rake db:drop                            # Drops the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:drop:all to drop all databases in the config). Without RAILS_ENV or when RAILS_ENV is development, it defaults to dropping the development and test databases
+rake db:environment:set                 # Set the environment value for the database
+rake db:fixtures:load                   # Loads fixtures into the current environment's database
+rake db:migrate                         # Migrate the database (options: VERSION=x, VERBOSE=false, SCOPE=blog)
+rake db:migrate:status                  # Display status of migrations
+rake db:rollback                        # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+rake db:schema:cache:clear              # Clears a db/schema_cache.dump file
+rake db:schema:cache:dump               # Creates a db/schema_cache.dump file
+rake db:schema:dump                     # Creates a db/schema.rb file that is portable against any DB supported by Active Record
+rake db:schema:load                     # Loads a schema.rb file into the database
+rake db:seed                            # Loads the seed data from db/seeds.rb
+rake db:setup                           # Creates the database, loads the schema, and initializes with the seed data (use db:reset to also drop the database first)
+rake db:structure:dump                  # Dumps the database structure to db/structure.sql
+rake db:structure:load                  # Recreates the databases from the structure.sql file
+rake db:version                         # Retrieves the current schema version number
+rake dev:cache                          # Toggle development mode caching on/off
+rake initializers                       # Print out all defined initializers in the order they are invoked by Rails
+rake log:clear                          # Truncates all/specified *.log files in log/ to zero bytes (specify which logs with LOGS=test,development)
+rake middleware                         # Prints out your Rack middleware stack
+rake notes                              # Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)
+rake notes:custom                       # Enumerate a custom annotation, specify with ANNOTATION=CUSTOM
+rake restart                            # Restart app by touching tmp/restart.txt
+rake routes                             # Print out all defined routes in match order, with names
+rake secret                             # Generate a cryptographically secure secret key (this is typically used to generate a secret for cookie sessions)
+rake stats                              # Report code statistics (KLOCs, etc) from the application or engine
+rake time:zones[country_or_offset]      # List all time zones, list by two-letter country code (`rails time:zones[US]`), or list by UTC offset (`rails time:zones[-8]`)
+rake tmp:clear                          # Clear cache and socket files from tmp/ (narrow w/ tmp:cache:clear, tmp:sockets:clear)
+rake tmp:create                         # Creates tmp directories for cache, sockets, and pids

data/lib/handy_toolbox/app.rb

@@ -3,11 +3,11 @@ module HandyToolbox
   class App
     attr_reader :title
 
-    def initialize(title: "Tools")
+    def initialize(title: "Tools", default_colors: false)
       @title = title
       @loop = true
       @builder = Menu.new(nil, nil)
-      @screen = Screen.new
+      @screen = Screen.new(default_colors: default_colors)
       @navigator = Navigator.new
       @tool_runner = ToolRunner.new
       @positions = {}
@@ -21,7 +21,7 @@ module HandyToolbox
 
         while @loop
           screen.draw do
-            draw_title
+            screen.header(title)
             draw_tools
           end
           handle_input
@@ -94,17 +94,8 @@ module HandyToolbox
       end
     end
 
-    def draw_title
-      horizontal_line = "-" * (title.size + 4)
-      padded_title = "| #{title} |"
-
-      screen.text_at(0, 0, horizontal_line)
-      screen.text_at(0, 1, padded_title)
-      screen.text_at(0, 2, horizontal_line)
-    end
-
     def draw_tools
-      y = 4
+      y = 2
       longest = find_longest_child_name
       @positions = {}
       current.children.each_with_index do |child|
@@ -119,14 +110,14 @@ module HandyToolbox
             if is_multiline
               Ui.dim do
                 text = format_desc(str[1])
-                screen.text_at(2, y + 1, text)
+                screen.text_at(1, y + 1, text)
               end
               text = format_child_name(child.icon, str[0], longest)
-              screen.text_at(2, y + 2, text)
+              screen.text_at(1, y + 2, text)
               @positions[child.id] = y + 2
             else
               text = format_child_name(child.icon, str, longest)
-              screen.text_at(2, y, text)
+              screen.text_at(1, y, text)
               @positions[child.id] = y
             end
           end
@@ -141,11 +132,11 @@ module HandyToolbox
     end
 
     def format_desc(str)
-      "     # #{str}"
+      "    # #{str}"
     end
 
     def format_child_name(icon, name, max_len)
-      "  #{icon}#{name.ljust(max_len, ' ')}  "
+      " #{icon}#{name.ljust(max_len, ' ')} "
     end
 
     def find_longest_child_name

data/lib/handy_toolbox/screen.rb

@@ -3,12 +3,18 @@ require 'curses'
 module HandyToolbox
 
   class Screen
+    SPACE = ' '.freeze
 
     attr_reader :scroll
 
+    def initialize(default_colors: false)
+      @default_colors = default_colors
+    end
+
     def init
       Curses.init_screen
       Curses.start_color
+      Curses.use_default_colors if @default_colors
       Ui.hide_cursor
       Curses.cbreak
       Curses.crmode
@@ -30,8 +36,20 @@ module HandyToolbox
       Curses.refresh
     end
 
+    def header(title)
+      title = " #{title}"[0, Curses.cols - 1]
+      title = title.ljust(Curses.cols, SPACE)
+
+      Ui.reverse do
+        if scroll.fits_into_pane?(-scroll.top)
+          Ui.text_at(0, -scroll.top, title)
+        end
+      end
+    end
+
     def text_at(x, y, str)
       if scroll.fits_into_pane?(y)
+        str = str[0, Curses.cols - x - 1]
         Ui.text_at(x, y - scroll.top, str)
       end
       @max_y = y if @max_y < y

data/lib/handy_toolbox/ui.rb

@@ -31,6 +31,12 @@ module HandyToolbox
       highlight_off if condition
     end
 
+    def self.reverse
+      attr_on Curses::A_REVERSE
+      yield
+      attr_off Curses::A_REVERSE
+    end
+
     def self.dim_on
       attr_on Curses::A_DIM
     end

data/lib/handy_toolbox/version.rb

@@ -1,3 +1,3 @@
 module HandyToolbox
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handy_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bartłomiej Wójtowicz
@@ -65,13 +65,16 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - EXAMPLE.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/example
 - bin/setup
+- fixtures/rakes.txt
 - handy_toolbox.gemspec
 - lib/handy_toolbox.rb
 - lib/handy_toolbox/app.rb
@@ -94,7 +97,6 @@ files:
 - promo/1.png
 - promo/2.png
 - promo/3.png
-- promo/4.png
 homepage: https://github.com/qbart/handy_toolbox
 licenses:
 - MIT