fluxbox_apps_menu 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0396fb427fa3641352a8803e034f697afac4d60
-  data.tar.gz: 7b53ce6ad5c763e07cd42706933320dd6bbcbe6d
+  metadata.gz: 299c16c1c64506b78ab3c7d9cdf87f0c7b035315
+  data.tar.gz: a5ed2130437276cdc9329db41b91725ff3a260ba
 SHA512:
-  metadata.gz: 883eaeab6f1e6f6e8b76b5c1783856065c64d9923cb2a83b39ef8e9310934da7d977e00b6202da034643975bad3395cec7571cd0302cc510ccf066af9b9545cd
-  data.tar.gz: 020895fcbc7c2527015bb3c5e672d830bb9286933870802e4e99fd0f277cd222a805ca2cb01a82db9382fbeb341126c491f92ebc787bccdb9fec934d84e8258c
+  metadata.gz: 5268a846daa828e7f7bff6751f42cbb1ba46e00a9e24cfa960d5f88b2728e2093b1e87a42c847509aee474eb728ece1de165973fab0fe6f33450cefe01930cf2
+  data.tar.gz: b3954afe8f8967aba09b1f265551c3c21c680a4ab99808d010b6e22eb2406c5e1886ae18a4bda75bb69e2f97bf33e16b3f8d6fd891d6b2893e0eb837015e424c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fluxbox_apps_menu (1.1.2)
+    fluxbox_apps_menu (1.3.0)
       inifile (~> 3.0)
       thor
 
@@ -9,8 +9,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     inifile (3.0.0)
-    rake (10.1.0)
-    thor (0.19.1)
+    rake (12.0.0)
+    thor (0.19.4)
 
 PLATFORMS
   ruby
@@ -19,3 +19,6 @@ DEPENDENCIES
   bundler (~> 1.6)
   fluxbox_apps_menu!
   rake
+
+BUNDLED WITH
+   1.14.5

data/README.md

@@ -24,21 +24,23 @@ Or install it yourself as:
 
 ## Usage
 
-Build the menu
+Build the menu:
 
     $ fluxbox_apps_menu build
-    
-Create a copy of the config file (*fluxbox_apps_menu.yaml*) under
-the _~/.fluxbox_ folder
 
-    $ fluxbox_apps_menu menuconfig
-    
-When the application menu is built it can be included in
-your main fluxbox menu file (usually *~/.fluxbox/menu*) adding
-the row below where you want display it:
+When the application menu is built it can be included in your main fluxbox menu file 
+(usually *~/.fluxbox/menu*) adding the row below where you want display it:
 
     [include] (~/.fluxbox/menu-apps)
 
+
+To start with customizations create a copy of the config file (*fluxbox_apps_menu.yaml*) 
+under the _~/.fluxbox_ folder:
+
+    $ fluxbox_apps_menu config
+
+Once completed build again!
+
 ## Get help
 
 Where to start
@@ -48,7 +50,7 @@ Where to start
 Get help for a specific task
 
     $ fluxbox_apps_menu help build
-    $ fluxbox_apps_menu help menuconfig
+    $ fluxbox_apps_menu help config
     
 More help
 

data/lib/fluxbox_apps_menu.rb

@@ -4,16 +4,13 @@ require 'fluxbox_apps_menu/menu'
 require 'fluxbox_apps_menu/desktop_file'
 require 'fluxbox_apps_menu/utils'
 
-$VERBOSE = nil
-
 module FluxboxAppsMenu
 
   class Builder
 
     def initialize(opts)
-      #p opts; exit
       @filename = opts[:filename].to_s.empty? ? 'menu-apps' : opts[:filename]
-      @silent = opts[:silent]
+      @verbose = opts[:verbose]
       @overwrite = opts[:overwrite]
       @cfg = FluxboxAppsMenu::Config.new
       @fmenu = FluxboxAppsMenu::Menu.new(@cfg)
@@ -22,7 +19,7 @@ module FluxboxAppsMenu
     def create_menu
       if @overwrite == false
         if File.exists?(File.expand_path("~/.fluxbox/#{@filename}"))
-          puts "The file #{@filename} already exists!" unless @silent
+          STDERR.puts 'Fatal Error! '.bold.red "The file #{@filename} already exists!"
           exit
         end
       end
@@ -35,7 +32,7 @@ module FluxboxAppsMenu
     def init_config
       unless @overwrite
         if File.exists?(File.expand_path("~/.fluxbox/fluxbox_apps_menu.yaml"))
-          puts '[Error] '.bold.red + "The file 'fluxbox_apps_menu.yaml' already exists in '#{File.expand_path('~/.fluxbox')}'" unless @silent
+          STDERR.puts 'Fatal Error! '.bold.red + "The file 'fluxbox_apps_menu.yaml' already exists in '#{File.expand_path('~/.fluxbox')}'"
           exit
         end
       end
@@ -47,7 +44,7 @@ module FluxboxAppsMenu
     def scan_app_folder
       @cfg.app_paths.each do |d|
 
-        Dir.glob(d + '/*.desktop') do |f|
+        Dir.glob(File.expand_path(d + '/*.desktop')) do |f|
 
           ini = DesktopFile.new(f, @cfg)
 
@@ -56,35 +53,47 @@ module FluxboxAppsMenu
           name = ini.name
 
           if ini.hidden? 
-            puts '[Hidden] '.bold.green + "The application \"#{name}\" is hidden" unless @silent
+            puts '[H] '.bold.gray + "\"#{name}\" (#{f})" if @verbose
             next
           end
 
           cat = ini.categories
           if cat.nil?
-            puts '[No Category] '.bold.red + "The application \"#{name}\" doesn't have any category" unless @silent
+            puts '[C] '.bold.red + "\"#{name}\" (#{f})" if @verbose
             next
           end
 
           begin
-            submenu = @fmenu.assign_menu(cat, name)  
+            submenu = @fmenu.assign_menu(cat, name)
           rescue NoCategoriesError => e
-            puts '[No category] '.bold.red + "The \"#{e.message}\" menu item doesn't have any categoty, check your \"fluxbox_menu_apps.yaml\""
+            STDERR.puts 'Fatal Error! '.bold.red + "The \"#{e.message}\" menu item doesn't have any category, fix it to your \"fluxbox_menu_apps.yaml\""
             exit
           end
 
           unless submenu.nil?
             icon = ini.icon
             if icon.nil?
-              puts '[No Icon] '.bold.yellow + "The application \"#{name}\" doesn't have any icon" unless @silent
+              puts '[I] '.bold.yellow + "\"#{name}\" (#{f})" if @verbose
             end
 
-            submenu[name] = @fmenu.item_exec(name, icon, ini.exec)
+            submenu[name] = MenuItem.new(:label => name, :icon  => icon, :command => ini.exec)
+            puts '[V]'.bold.green + " \"#{name}\" (#{f})" if @verbose
           else
-            puts '[No mapped category] '.bold.red + "The application \"#{name}\" doesn't have any mapped category among: #{ini.categories.join(', ')}" unless @silent
+            STDERR.puts 'Warning! '.bold.yellow + "\"#{name}\" doesn't have any mapped category among: #{ini.categories.join(', ')}, fix it to your \"fluxbox_menu_apps.yaml\" " 
           end
         end
       end
+
+      if @verbose
+        puts ''
+        puts 'Quick Help:'
+        puts ''
+        puts '  [V]: Everything is ok'.bold.green
+        puts '  [H]: Hidden app'.bold.gray
+        puts '  [I]: App without icon'.bold.yellow
+        puts '  [C]: App without categories'.bold.red
+        puts ''
+      end
     end
 
   end

data/lib/fluxbox_apps_menu.yaml

@@ -7,6 +7,10 @@
 :banned_files: 
 - 'qmmp_.*'
 - 'umplayer_.*'
+:unhide_files:
+- 'nm-connection-editor'
+- 'bluedevilsendfile'
+- 'bluedevilwizard'
 :icon_paths:
 - /usr/share/icons/gnome/16x16/apps
 - /usr/share/icons/oxygen/16x16/apps
@@ -22,6 +26,7 @@
 - /usr/share/applications
 - /usr/share/applications/kde4
 - /usr/share/applications/YaST2
+- ~/.local/share/applications
 :menu:
   Development:
     :icon: applications-development

data/lib/fluxbox_apps_menu/cli.rb

@@ -8,33 +8,39 @@ module FluxboxAppsMenu
 
     desc 'build', 'Build the menu'
     method_option :filename, :aliases => '-f', :default => '', :desc => 'Save as filename.'
-    method_option :silent, :aliases => '-s', :default => false, :type => :boolean, :desc => 'Don\'t show any output message.'
+    method_option :verbose, :aliases => '-v', :default => false, :type => :boolean, :desc => 'Print helping output messages.'
     method_option :overwrite, :aliases => '-o', :default => true, :type => :boolean, :desc => 'Overwrite the app menu if exists.'
     def build
       FluxboxAppsMenu::Builder.new(options).create_menu
     end
 
-    desc 'menuconfig', 'Make a local copy of the configuration file.'
+    desc 'config', 'Make a local copy of the configuration file.'
     method_option :overwrite, :aliases => '-o', :default => false, :type => :boolean, :desc => 'Overwrite the config file if exists.'
-    def menuconfig
+    def config
       FluxboxAppsMenu::Builder.new(options).init_config
     end
-      
+
     def help(arg = nil)
       if arg.nil?
         puts <<EOL
+
 FluxboxAppsMenu v.#{FluxboxAppsMenu::VERSION} by Fabio Mucciante
 
 Description:
-  Build a Fluxbox menu putting the applications in the right
-  section as configured within the "fluxbox_apps_menu.yaml" file.
+  Generates a menu for Fluxbox containing the applications installed
+  and visible in other DE menus.
+
+  Customizations on the building process are achieved editing the
+  "fluxbox_apps_menu.yaml" file copied under the "~/.fluxbox"
+  folder by the "config" task.
+  Watch the online page for more info:
+
+    https://github.com/fabiomux/fluxbox_apps_menu/wiki
 
-  Using the "menuconfig" task a copy of this file will be created
-  under the "~/.fluxbox" path.
+  The file containing the application tree will be created by 
+  default to "~/.fluxbox/menu-apps" and can be included within the
+  main menu adding the line:
 
-  The application's menu file will be created in "~/.fluxbox/menu-apps"
-  and can be included within your fluxbox menu adding the row below:
-  
     [include] (~/.fluxbox/menu-apps)
 
 EOL
@@ -44,7 +50,7 @@ EOL
       end
     end
 
-    default_task :build
+#     default_task :build
   end
 
 end 

data/lib/fluxbox_apps_menu/config.rb

@@ -2,7 +2,7 @@ require 'yaml'
 
 module FluxboxAppsMenu
   class Config
-    attr_reader :lang, :icon_paths, :filename, :banned_files, :app_paths, :icons, :terminal
+    attr_reader :lang, :icon_paths, :filename, :banned_files, :unhide_files, :app_paths, :icons, :terminal
     attr_accessor :menu
 
     def initialize
@@ -19,8 +19,9 @@ module FluxboxAppsMenu
       yaml = YAML.load_file(@filename)
 
       @banned_files = yaml[:banned_files]
+      @unhide_files = yaml[:unhide_files]
       @icon_paths = yaml[:icon_paths]
-      @app_paths = yaml[:app_paths] + [ ENV['HOME'] + '/.local/share/applications']
+      @app_paths = yaml[:app_paths]
       @menu = yaml[:menu]
       @icons = yaml[:icons]
       @terminal = yaml[:terminal]

data/lib/fluxbox_apps_menu/desktop_file.rb

@@ -22,6 +22,7 @@ module FluxboxAppsMenu
     end
 
     def hidden?
+      @cfg.unhide_files.each { |r| return false if @filename =~ Regexp.new(r) }
        %w(true 1).include? @ini['Desktop Entry']['NoDisplay'].to_s
     end
 
@@ -44,9 +45,10 @@ module FluxboxAppsMenu
     end
 
     def exec
-      com = @ini['Desktop Entry']['Exec'].to_s.gsub('%c', name).gsub('%F', '')
-        .gsub('%i', '').gsub('%U', '').gsub('%f', '').gsub('%m', '')
-        .gsub('%u', '').gsub(/[ ]{2,}/, ' ').gsub(/\ }/, '}').strip
+      com = @ini['Desktop Entry']['Exec'].to_s
+        .gsub(/((?:"){,1})%c\1/, "\\1#{name}\\1")
+        .gsub(/((?:"){,1})(%F|%i|%U|%f|%m|%u)\1/, '')
+        .gsub(/[ ]{2,}/, ' ').gsub(/\ }/, '}').strip
 
       terminal? ? @cfg.terminal + ' ' + com : com
     end

data/lib/fluxbox_apps_menu/menu.rb

@@ -1,43 +1,92 @@
+require 'delegate'
+
 module FluxboxAppsMenu
 
-  class Menu
+  class MenuItem
+    attr_accessor :label, :icon, :command, :level
 
-    def initialize(cfg = nil)
-      @cfg = cfg.nil? ? FluxboxAppsMenu::Config.new : cfg
-    end
+    def initialize(args = {})
+      @label = args[:label]       if args.has_key? :label
+      @icon = args[:icon]         if args.has_key? :icon
+      @command = args[:command]   if args.has_key? :command
+      @level = args[:level]       if args.has_key? :level
 
-    def assign_menu(cat, label)
-      traverse_menu(@cfg.menu, cat.map(&:downcase), label)[0]
+      @rendered = []
+      @level ||= 0
     end
 
-    def render
-      render_menu(@cfg.menu)
+    def wrap_item(str)
+      "#{'  ' * level}#{str}\n"
     end
 
-    def item_exec(label, icon, command)
-      menu_item(label, icon, 'exec', command)
+    def <<(str)
+      @rendered << str
+      self
     end
 
-    def item_submenu(label, icon)
-      menu_item(label, icon, 'submenu')
+    def render
+      @rendered
     end
+  end
+
+  class SeparatorItem < SimpleDelegator
 
-    def item_separator
-      menu_item('', '', 'separator')
+    def initialize(obj)
+      super(obj)
+      obj << wrap_item('[separator]')
     end
+  end
 
-    # type = submenu, exec, separator
-    private
+  class ExecItem < SimpleDelegator
 
-    def menu_item(label, icon, type = 'exec', command = nil)
+    def initialize(obj)
+      super(obj)
       str = []
-      str << "[#{type}]"
+      str << '[exec]'
       str << "(#{label.gsub(/(?<!\\)\)/, '\)')})" unless label.to_s.empty?
       str << "{#{command}}" unless command.nil?
       str << "<#{icon}>" unless icon.to_s.empty?
 
-      str.join(' ')
+      obj << wrap_item(str.join(' '))
     end
+  end
+
+  class StartSubmenuItem < SimpleDelegator
+
+    def initialize(obj)
+      super(obj)
+      str = []
+      str << '[submenu]'
+      str << "(#{label.gsub(/(?<!\\)\)/, '\)')})" unless label.to_s.empty?
+      str << "<#{icon}>" unless icon.to_s.empty?
+
+      obj << wrap_item(str.join(' '))
+    end
+  end
+
+  class EndSubmenuItem < SimpleDelegator
+
+    def initialize(obj)
+      super(obj)
+      obj << wrap_item('[end]')
+    end
+  end
+
+  class Menu
+
+    def initialize(cfg = nil)
+      @cfg = cfg.nil? ? FluxboxAppsMenu::Config.new : cfg
+    end
+
+    def assign_menu(cat, label)
+      traverse_menu(@cfg.menu, cat.map(&:downcase), label)[0]
+    end
+
+    def render
+      render_menu(@cfg.menu)
+    end
+
+    private
 
     def traverse_menu(menu, cat, label, selected_index = nil)
       #categories with smaller index are the favorites
@@ -50,7 +99,7 @@ module FluxboxAppsMenu
         if info.class == Hash
           subitems = info.select { |k, v| k.class == String }
 
-          # when a label is set the path has high priority 
+          # when a label is set the path has high priority
           return [info, 0] if info.has_key?(label)
 
           if info.has_key? :mandatory_categories
@@ -71,7 +120,7 @@ module FluxboxAppsMenu
             if categories.include?(c.strip)
               i = categories.index(c)
               if i < selected_index
-                selected = info 
+                selected = info
                 selected_index = i
               end
             end
@@ -84,23 +133,28 @@ module FluxboxAppsMenu
     end
 
     def render_menu(menu, level = 0)
-      prefix = '  ' * (level)
       text = ''
 
       # sort the items but let menu folders at the top
-      menu = menu.select { |k, v| k.class == String }.sort_by { |k, v| v.class == String ? k.downcase : '' }
+      menu = menu.select { |k, v| k.class == String }.sort_by { |k, v| (v.kind_of? MenuItem) ? k.downcase : '' }
       menu.each do |name, items|
-        if items.class.to_s == 'Hash'
+
+        if items.class == Hash
           icon = items[:icon]
           items = items.select { |k, v| k.class == String }
           subitems = render_menu(items, level + 1)
 
           unless subitems.empty?
-            text += "#{prefix}#{item_submenu(name, @cfg.expand_icon(nil, icon))}\n#{subitems}#{prefix}[end]\n"
+            text += begin
+              i = MenuItem.new(:level => level, :label => name, :icon => @cfg.expand_icon(nil, icon))
+              EndSubmenuItem.new(StartSubmenuItem.new(i) << subitems).render
+            end.join
           end
-
-        elsif items.class.to_s == 'String'
-          text += prefix + items + "\n"
+        elsif items.kind_of? MenuItem
+          text += begin
+            items.level = level
+            ExecItem.new(items).render
+          end.join
         end
       end
 

data/lib/fluxbox_apps_menu/version.rb

@@ -1,3 +1,3 @@
 module FluxboxAppsMenu
-  VERSION = "1.2.0"
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluxbox_apps_menu
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Fabio Mucciante
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-13 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler