build-tool 0.6.3 → 0.6.4

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    build-tool (0.6.2)
+    build-tool (0.6.4)
       activerecord (>= 3.2.1)
       ansi (>= 1.4.2)
       grit (>= 2.4.1)
+      inifile (>= 1.1.0)
       logging (>= 1.6.0)
       sqlite3 (>= 1.3.5)
 
@@ -26,22 +27,25 @@ GEM
     arel (3.0.2)
     builder (3.0.0)
     diff-lcs (1.1.3)
-    grit (2.4.1)
+    grit (2.5.0)
       diff-lcs (~> 1.1)
       mime-types (~> 1.15)
+      posix-spawn (~> 0.3.6)
     i18n (0.6.0)
+    inifile (1.1.0)
     little-plugger (1.1.3)
     logging (1.7.2)
       little-plugger (>= 1.1.3)
     mime-types (1.18)
-    multi_json (1.2.0)
+    multi_json (1.3.6)
+    posix-spawn (0.3.6)
     racc (1.4.7)
     rake (0.9.2.2)
     rexical (1.0.5)
-    sqlite3 (1.3.5)
+    sqlite3 (1.3.6)
     turn (0.9.3)
       ansi
-    tzinfo (0.3.32)
+    tzinfo (0.3.33)
     yard (0.7.5)
 
 PLATFORMS

data/History.rdoc

@@ -1,3 +1,16 @@
+== Version 0.6.4
+=== Enhancements
+- Check for xdg-open before using it and give error message if missing.
+- Give error message if opening the editor fails.
+- Changed file format for <tt>configuration edit</tt> from yaml to ini file. Easier to read for
+  humans.
+
+=== Bugfixes
+- Fix <tt>recipe install</tt> creating an invalid link on <tt>ruby19</tt> systems.
+- Set build directory as working directory for <tt>module shell</tt> as advertised.
+- Fix editor beeing hardcoded to <tt>gvim -f</tt>. Tries VISUAL, GUIEDITOR (both when DISPLAY set)
+  and EDITOR now.
+
 == Version 0.6.3
 === Enhancements
 - <tt>module shell<</tt>: Add <tt>--batch</tt> option.

data/build-tool.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency( 'sqlite3', '>= 1.3.5' ) # SQLite Database Support
   s.add_dependency( 'ansi', '>= 1.4.2' )    # ANSI Codes at your Fingertips
   s.add_dependency( 'grit', '>= 2.4.1' )    # Git Support
+  s.add_dependency( 'inifile', '>= 1.1.0' ) # INI File
 
   # Development Dependencies
   s.add_development_dependency( 'racc', '>= 1.4.7' )    # A LALR(1) parser generator.

data/lib/build-tool/commands/modules/shell.rb

@@ -73,7 +73,7 @@ def do_execute( args )
 
         def do_execute_module( mod )
             verbose "> #{@command}"
-            rc = mod.shell( @command, { detach: @detach } )
+            rc = mod.shell( @command, { detach: @detach, wd: mod.build_directory } )
             verbose "> #{rc}"              if not @detach
             verbose "> send to background" if @detach
 

data/lib/build-tool/commands/recipes/edit.rb

@@ -2,6 +2,7 @@
 
 require 'build-tool/commands'
 require 'build-tool/recipe'
+require 'mj/path'
 
 require 'fileutils'
 
@@ -47,15 +48,15 @@ def do_execute( args )
 
             if @global
                 if @browser
-                    system( 'xdg-open %s' % [ rec.global_path ] )
+                    MJ::Path::open( rec.global_path )
                 else
-                    system( 'xdg-open %s' % [ rec.global_config_file_path( 'recipe' ) ] )
+                    MJ::Path::open( rec.global_config_file_path( 'recipe' ) )
                 end
             else
                 if @browser
-                    system( 'xdg-open %s' % [ rec.local_path() ] )
+                    MJ::Path::open( rec.local_path() )
                 else
-                    system( 'xdg-open %s' % [ rec.local_config_file_path( 'recipe' ) ] )
+                    MJ::Path::open( rec.local_config_file_path( 'recipe' ) )
                 end
             end
             return 0

data/lib/build-tool/commands/recipes/install.rb

@@ -43,10 +43,9 @@ def do_execute(args)
             exename = "#{commandname}-build"
             conffile = Application::instance.local_configuration_dir.join("#{commandname}.yaml")
 
-            # Our executable
-            buildtool = Application::instance.application_root.join(
-                'bin', 
-                Pathname.new( $0 ).basename ).to_s
+            # Our executable. We use $0 directly here to pick up any rubygem wrapper that could
+            # exists. But we use realpath to skip any unnecessary link
+            buildtool = Pathname.new( $0 ).realpath()
 
             # Load the recipe
             recipe = Recipe.find_recipe(recipename)
@@ -98,7 +97,7 @@ def do_execute(args)
                     error( "a symbolic link in a directory that is part of $PATH yourself." )
                     error( "> ln -s #{buildtool} #{exename}" )
                 else
-                    File.symlink(buildtool, Pathname.new(dir).join(exename))
+                    File.symlink( buildtool, link )
                 end
             end
 

data/lib/build-tool/configuration.rb

@@ -21,6 +21,9 @@
 require 'build-tool/build-system/kdel10n'
 require 'build-tool/build-system/qmake'
 
+require 'stringio'
+require 'inifile'
+
 
 module BuildTool
 
@@ -32,15 +35,36 @@ def self.edit( only = [] )
                     BuildTool::Application.instance.configuration.settings,
                     only )
 
-            editor = MJ::Tools::TmpFileEditor.new( YAML::dump( settings ) )
+            text = StringIO.new
+            settings.each do |s|
+                text << '# ' << s[:description].gsub( /\n(?!\z)/, "\n# " )
+                text << s[:name] << ' = ' << s[:value]
+                text << "\n"
+                text << "\n"
+            end
+
+            editor = MJ::Tools::TmpFileEditor.new( text.string )
 
+            # Give the user the possibility to edit the file
             editor.edit()
             if not Pathname.new( editor.path() ).exist?
-                info( "File deleted!" )
+                logger.info( "File deleted!" )
                 return 0
             end
-            values = YAML::load( File.open( editor.path(), 'r:UTF-8' ) )
 
+            # Reparse it
+            values = Array.new
+            file = IniFile.new( editor.path() )
+            file.each do | section, param, value |
+                if section != 'global'
+                    logger.error( 'section is not global?' )
+                end
+                values << {
+                    name: param,
+                    value: value }
+            end
+
+            # Write it back
             BuildTool::Setting::import(
                     BuildTool::Application.instance.configuration.settings,
                     values )

data/lib/build-tool/model/setting.rb

@@ -2,6 +2,8 @@
 
 require 'active_record'
 
+# This class uses the active_record logger !!!!!!!!!!!!!!!!
+
 module BuildTool
 
     class Setting < ActiveRecord::Base
@@ -64,7 +66,7 @@ def import( settings, new )
                     s = settings[v[:name]]
                     if s.value != v[:value]
                         s.value = v[:value]
-                        logger.info( 'Setting %s to "%s"' % [ s.name, s.value ] )
+                        Logging.logger.root.info( 'Setting %s to "%s"' % [ s.name, s.value ] )
                         s.save!
                     end
                 end

data/lib/build-tool/version.rb

@@ -26,5 +26,5 @@ def recipe_version()
 
     end
 
-    VERSION = Version.new( 0, 6, 3 )
+    VERSION = Version.new( 0, 6, 4 )
 end

data/lib/mj/path.rb

@@ -0,0 +1,41 @@
+# -*- coding: UTF-8 -*-
+
+module MJ;
+
+#
+# Utility functions to work with PATH
+#
+module Path;
+
+    #
+    # Open the given +path+ in a file browser with +xdg-open+.
+    #
+    # Will print an error if xdg-open is not found.
+    #
+    # @param [#to_s] Pathname to open.
+    def Path.open( path )
+        if Path.which( 'xdg-open' ).nil?
+            logger.error( 'xdg-open is not available.' )
+        end
+        if system( 'xdg-open %s' % [ path ] ).nil?
+            logger.error( 'xdg-open failed to start' )
+        end
+    end
+
+
+    #
+    # Find +cmd+ in environment variable +$PATH+
+    #
+    def Path.which( cmd )
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = "#{path}/#{cmd}#{ext}"
+          return exe if File.executable? exe
+        }
+      end
+      return nil
+    end
+
+
+end; end # module MJ::Path

data/lib/mj/tools/editor.rb

@@ -1,9 +1,34 @@
 # -*- coding: UTF-8 -*-
 
+require 'mj/path'
 require 'tempfile'
 
 module MJ; module Tools
 
+    @@editor = nil
+
+    # Look for a suitable editor in the users environment.
+    #
+    # We check
+    # 1. +$VISUAL+ (if +$DISPLAY+ is set)
+    # 2. +$GUIEDITOR+ (if +$DISPLAY+ is set)
+    # 3. +$EDITOR+
+    # 4. Giving up
+    # The result is cached.
+    def Tools.editor()
+        return @@editor if @@editor
+        logger.debug( 'Looking for a editor.' )
+
+        if ENV.include?( 'DISPLAY' )
+            logger.debug( 'Checking $VISUAL' )
+            return @@editor = ENV['VISUAL'] if ENV.include?( 'VISUAL' )
+            logger.debug( 'Checking $GUIEDITOR' )
+            return @@editor = ENV['GUIEDITOR'] if ENV.include?( 'GUIEDITOR' )
+        end
+        logger.debug( 'Checking $EDITOR' )
+        return @@editor = ENV['EDITOR'] if ENV.include?( 'EDITOR' )
+    end
+
     # A class that puts the given content in a tmpfile, opens an editor for the user to play with
     # it. After the user closed the editor it will give back the new content.
     class TmpFileEditor
@@ -15,13 +40,19 @@ def initialize( content )
             @file.close()
         end
 
-        def editor()
-            "gvim -f"
-        end
-
         def edit()
-            system( "#{editor()} #{@file.path}" )
-            return $? == 0
+            # Check if there is a editor around here.
+            editor = Tools::editor()
+            if editor.nil?
+                logger.error( 'Could not find a editor to use (xdg-open, $VISUAL, $GUIEDITOR, $EDITOR).' )
+            end
+            # Execute the editor
+            cmd = "#{editor} #{@file.path}"
+            logger.trace( "> #{cmd}" )
+            if system( cmd ).nil?
+                logger.error( "Failed to start editor #{editor}" )
+            end
+            return 0
         end
 
         def path()

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: build-tool
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 6
-  - 3
-  version: 0.6.3
+  - 4
+  version: 0.6.4
 platform: ruby
 authors: 
 - Michael Jansen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-27 00:00:00 +02:00
+date: 2012-05-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,9 +99,25 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: racc
+  name: inifile
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: racc
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -113,11 +129,11 @@ dependencies:
         - 7
         version: 1.4.7
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rexical
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -129,11 +145,11 @@ dependencies:
         - 5
         version: 1.0.5
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -145,11 +161,11 @@ dependencies:
         - 2
         version: 0.9.2
   type: :development
-  version_requirements: *id008
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: yard
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -161,11 +177,11 @@ dependencies:
         - 5
         version: 0.7.5
   type: :development
-  version_requirements: *id009
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: turn
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -176,7 +192,7 @@ dependencies:
         - 9
         version: "0.9"
   type: :development
-  version_requirements: *id010
+  version_requirements: *id011
 description: "\n    The tool helps \n\n    ...\n  "
 email: 
 - info@michael-jansen.biz
@@ -282,6 +298,7 @@ files:
 - lib/mj/error.rb
 - lib/mj/logging.rb
 - lib/mj/mixins/inherited_attributes.rb
+- lib/mj/path.rb
 - lib/mj/tools/editor.rb
 - lib/mj/tools/ssh.rb
 - lib/mj/tools/subprocess.rb