fluxbox_apps_menu 1.1.0

data/README.md

@@ -0,0 +1,57 @@
+# FluxboxAppsMenu
+
+FluxboxAppsMenu create an applications menu file for Fluxbox Window Manager
+including the applications stored within the folders containing the
+_.desktop_ files and discarding automatically those marked as hidden.
+
+They will be organized in several categories and sub-categories specified
+within the config file *fluxbox_apps_menu.yaml*
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluxbox_apps_menu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluxbox_apps_menu
+
+## Usage
+
+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
+    
+Get help
+
+    $ fluxbox_apps_menu help
+    
+Get help for a specific task
+
+    $ fluxbox_apps_menu help build
+    $ fluxbox_apps_menu help menuconfig
+
+When the application's 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)
+
+## Contributing
+
+1. Fork it ( https://github.com/fabiomux/fluxbox_apps_menu/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/fluxbox_apps_menu

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'fluxbox_apps_menu/cli'
+
+FluxboxAppsMenu::CLI.start

data/fluxbox_apps_menu.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluxbox_apps_menu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluxbox_apps_menu'
+  spec.version       = FluxboxAppsMenu::VERSION
+  spec.authors       = ['Fabio Mucciante']
+  spec.email         = ['fabio.mucciante@gmail.com']
+  spec.summary       = %q{Build the Fluxbox apps menu.}
+  spec.description   = %q{This script reads the .desktop files installed and build the application's menu under the Fluxbox home folder.}
+  spec.homepage      = 'https://github.com/fabiomux/fluxbox_apps_menu'
+  spec.license       = 'GPL v.3'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  
+  spec.add_runtime_dependency "inifile", "~> 3.0"
+  spec.add_runtime_dependency "thor"
+end

data/lib/fluxbox_apps_menu.rb

@@ -0,0 +1,85 @@
+require 'fluxbox_apps_menu/version'
+require 'fluxbox_apps_menu/config'
+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]
+      @overwrite = opts[:overwrite]
+      @cfg = FluxboxAppsMenu::Config.new
+      @fmenu = FluxboxAppsMenu::Menu.new(@cfg)
+    end
+
+    def create_menu
+      if @overwrite == false
+        if File.exists?(File.expand_path("~/.fluxbox/#{@filename}"))
+          puts "The file #{@filename} already exists!" unless @silent
+          exit
+        end
+      end
+
+      scan_app_folder
+      text = @fmenu.render
+      File.open(File.expand_path("~/.fluxbox/#{@filename}"), 'w') { |f| f.write(text) }
+    end
+
+    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
+          exit
+        end
+      end
+      FileUtils.copy(File.dirname(__FILE__) + '/fluxbox_apps_menu.yaml', File.expand_path('~/.fluxbox/'))
+    end
+
+    private 
+
+    def scan_app_folder
+      @cfg.app_paths.each do |d|
+
+        Dir.glob(d + '/*.desktop') do |f|
+
+          ini = DesktopFile.new(f, @cfg)
+
+          next if ini.banned_file?
+
+          name = ini.name
+
+          if ini.hidden? 
+            puts '[Hidden] '.bold.green + "The application #{name} is hidden" unless @silent
+            next
+          end
+
+          cat = ini.categories
+          if cat.nil?
+            puts '[No Category] '.bold.red + "The application #{name} doesn't have any category" unless @silent
+            next
+          end
+
+          submenu = @fmenu.assign_menu(cat, name)
+          unless submenu.nil?
+            icon = ini.icon
+            if icon.nil?
+              puts '[No Icon] '.bold.yellow + "#{name} doesn't have any icon" unless @silent
+            end
+
+            submenu[name] = @fmenu.item_exec(name, icon, ini.exec)
+          else
+            puts "[No mapped category] #{name} doesn't have any mapped category within the menu".bold.red unless @silent
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/fluxbox_apps_menu.yaml

@@ -0,0 +1,123 @@
+---
+# other options: kdesu and gnomesu
+:switch_user: 'xdg-su'
+:terminal: 'xdg-terminal'
+:icons: 
+  App Name: 'icon-name'
+:banned_files: 
+- 'qmmp_.*'
+- 'umplayer_.*'
+:icon_paths:
+- /usr/share/icons/gnome/16x16/apps
+- /usr/share/icons/oxygen/16x16/apps
+- /usr/share/icons/hicolor/16x16/apps
+- /usr/share/pixmaps
+- /usr/share/icons/hicolor/32x32/apps
+- /usr/share/icons/oxygen/16x16/categories
+- /usr/share/icons/hicolor/48x48/apps
+- /usr/share/icons/hicolor/128x128/apps
+:app_paths:
+- /usr/share/applications
+- /usr/share/applications/kde4
+- /usr/share/applications/YaST2
+:menu:
+  Development:
+    :icon: applications-development
+    :categories:
+    - Development
+  Educational:
+    :icon: applications-education-science
+    :categories:
+    - Science
+    - Astronomy
+    - Education
+    - Geography
+  Games:
+    :icon: applications-games
+    :categories:
+    - Game
+    - CardGame
+  Graphic:
+    :icon: applications-graphics
+    :categories:
+    - Graphics
+    - VectorGraphics
+  Internet:
+    :icon: applications-internet
+    :categories:
+    - Network
+  Multimedia:
+    :icon: applications-multimedia
+    :categories:
+    - Audio
+    - Video
+    - Player
+    - AudioVideoEditing
+    - Mixer
+    - Recorder
+    - DiscBurning
+  Office:
+    :icon: applications-office
+    :categories:
+    - Office
+    LibreOffice Draw: ''
+  System:
+    :icon: applications-system
+    :categories:
+    - Settings
+    - System
+    - DesktopSettings
+    - Documentation
+    '. / Yast /':
+      :icon: yast-mascot
+      :categories:
+      - Yast
+      Hardware:
+        :icon: package_yast_hardware
+        :categories:
+        - X-SuSE-YaST-Hardware
+      Miscellaneous:
+        :icon: package_yast_misc
+        :categories:
+        - X-SuSE-YaST-Misc
+      Network Devices:
+        :icon: yast-network_devices
+        :categories:
+        - X-SuSE-YaST-Network
+      Network Services:
+        :icon: yast-network_services
+        :categories:
+        - X-SuSE-YaST-Net_advanced
+      Security and Users:
+        :icon: yast-security
+        :categories:
+        - X-SuSE-YaST-Security
+      System:
+        :icon: package_yast_system
+        :categories:
+        - X-SuSE-YaST-System
+      Software:
+        :icon: yast-software
+        :categories:
+        - X-SuSE-YaST-Software
+      Support:
+        :icon: yast-support
+        :categories:
+        - X-SuSE-YaST-Support
+  Utility:
+    :icon: applications-utilities
+    :categories:
+    - Archiving
+    - Utility
+    '. / Text Files /':
+      :icon: accessories-text-editor
+      :categories:
+        - TextEditor
+    '. / File Managers /':
+      :icon: system-file-manager
+      :categories:
+      - FileManager
+    '. / Terminal Emulators /':
+      :icon: utilities-terminal
+      :categories:
+      - TerminalEmulator

data/lib/fluxbox_apps_menu/cli.rb

@@ -0,0 +1,50 @@
+require 'thor'
+require 'fluxbox_apps_menu'
+require 'fluxbox_apps_menu/version'
+
+module FluxboxAppsMenu
+
+  class CLI < Thor
+
+    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 :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.'
+    method_option :overwrite, :aliases => '-o', :default => false, :type => :boolean, :desc => 'Overwrite the config file if exists.'
+    def menuconfig
+      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.
+
+  Using the "menuconfig" task a copy of this file will be created
+  under the "~/.fluxbox" path.
+
+  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
+        super
+      else
+        super arg
+      end
+    end
+
+    default_task :build
+  end
+
+end 

data/lib/fluxbox_apps_menu/config.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+
+module FluxboxAppsMenu
+  class Config
+    attr_reader :lang, :icon_paths, :filename, :banned_files, :app_paths, :icons, :terminal
+    attr_accessor :menu
+
+    def initialize
+      if File.exists?(ENV['HOME'] + '/.fluxbox/fluxbox_apps_menu.yaml')
+        @filename = ENV['HOME'] + '/.fluxbox/fluxbox_apps_menu.yaml'
+      elsif File.exists?(ENV['HOME'] + '/.fluxbox_apps_menu.yaml')
+        @filename = ENV['HOME'] + '/.fluxbox_apps_menu.yaml'
+      elsif File.exists?('/etc/fluxbox_apps_menu.yaml')
+        @filename = '/etc/fluxbox_apps_menu.yaml'
+      else
+        @filename = File.expand_path(File.dirname(__FILE__) + '/../fluxbox_apps_menu.yaml')
+      end
+
+      yaml = YAML.load_file(@filename)
+
+      @banned_files = yaml[:banned_files]
+      @icon_paths = yaml[:icon_paths]
+      @app_paths = yaml[:app_paths] + [ ENV['HOME'] + '/.local/share/applications']
+      @menu = yaml[:menu]
+      @icons = yaml[:icons]
+      @terminal = yaml[:terminal]
+
+      @lang = ENV['LANG'].split('.')[0]
+      @lang = { :short => @lang.split('_')[0], :long => @lang }
+    end
+
+    def expand_icon(app_name, icon_name)
+      iname = @icons[app_name] unless app_name.nil?
+      iname = icon_name        if iname.nil?
+
+      return nil if iname.to_s.empty?
+      return iname if iname.to_s.match('/') && File.exists?(iname)
+
+      iname.gsub!(/\.png$/, '')
+
+      @icon_paths.each do |p|
+        return "#{p}/#{iname}.png" if File.exists?("#{p}/#{iname}.png")
+      end
+
+      return nil
+
+    end
+  end
+end
+

data/lib/fluxbox_apps_menu/desktop_file.rb

@@ -0,0 +1,69 @@
+require 'inifile'
+#require 'fluxbox_apps_menu/config'
+module FluxboxAppsMenu
+
+  class DesktopFile
+
+    def initialize(filename, cfg = nil)
+      @ini = IniFile.new(:filename => filename, :comment => '#', :encoding => 'UTF-8')
+      @cfg = cfg.nil? ? FluxboxAppsMenu::Config.new : cfg
+      @filename = filename
+    end
+
+    def name(lang = true)
+      if lang
+        name = @ini['Desktop Entry']["Name[#{@cfg.lang[:short]}]"]
+        name = @ini['Desktop Entry']["Name[#{@cfg.lang[:long]}]"] if name.nil?
+      end
+
+      name = @ini['Desktop Entry']['Name'] if name.nil?
+
+      name
+    end
+
+    def hidden?
+      @ini['Desktop Entry']['NoDisplay'] == true
+    end
+
+    def banned_file?
+      @cfg.banned_files.each { |r| return true if @filename =~ Regexp.new(r) }
+      false
+    end
+
+    def icon
+=begin      
+      iname = @cfg.icons[name(false)]
+      iname = @ini['Desktop Entry']['Icon'] if iname.nil?
+
+      return nil if iname.to_s.empty?
+      return iname if iname.to_s.match('/') && File.exists?(iname)
+
+      iname.gsub!(/\.png$/, '')
+
+      @cfg.icon_paths.each do |p|
+        return "#{p}/#{iname}.png" if File.exists?("#{p}/#{iname}.png")
+      end
+      return nil
+=end
+      @cfg.expand_icon(name(false), @ini['Desktop Entry']['Icon'])
+    end
+
+    def terminal?
+      @ini['Desktop Entry']['Terminal'] == 'true'
+    end
+
+    def categories
+      cat = @ini['Desktop Entry']['Categories']
+      cat.split(';') unless cat.nil?
+    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(/\ }/, '}')
+
+      terminal? ? @cfg.terminal + ' ' + com : com
+    end
+  end
+
+end