easy_app_helper 4.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2eb32cf29808bc04cc5f4e6ffbc7973631068bb
-  data.tar.gz: 6b580342994df7d9bcfb68596dd7cd4ef936f9ae
+  metadata.gz: 0912cd94af9f37ef5c11dfd40e433d8930a2e125
+  data.tar.gz: 9dba102908c0ffb16315c684e8157381d774d972
 SHA512:
-  metadata.gz: 006b0fa47d732de40c9e8522f55a22850cf614accf45f69a21f22f445e4458bb10516eb40ee5aedb35ca3ec1fd47518b28512939df15d03d3d63d3ffde9873aa
-  data.tar.gz: 39264bf4170be1071a639cabc93d5d49acc4c6a8ba4e43bc4187fc1f1e8e3cdd85e888f4801ba1ef820bb3c15f591c7f653cbff3f5c6c05fd217f9a13b6dda8b
+  metadata.gz: ce04f5275a44c191214583c5d4a03dc4ef51a797d235eefa282b2a1763151bb927853ff6548f707d7091c25147509fd38fb130ee6e5c0eada818c3b4addb7566
+  data.tar.gz: 8f0e96f694852be154b10167ab73e0def6ef633f067dc1f51b78310c1c430851f6b3c524ea9dce324e0389a1edb2094b6019197118d398a4ef488990a3554176

data/lib/easy_app_helper/scripts/common.rb

@@ -0,0 +1,40 @@
+module EasyAppHelper
+  module Scripts
+
+    module Common
+
+      def extra_parameters
+        EasyAppHelper.config.command_line_layer.extra_parameters
+      end
+
+      def pre_process(object=self)
+        safe_execution {add_script_options} if object.respond_to? :add_script_options
+
+        # logging startup configuration
+        logger.debug "Config layers ->\n#{config.detailed_layers_info}"
+        logger.debug "Merged config -> #{config[].to_yaml}"
+        # Displaying (and exiting) command line help
+        if config[:help]
+          puts display_help
+          exit 0
+        end
+        object.check_config if object.respond_to? :check_config
+        logger.info 'Application is starting...'
+      end
+
+      def safe_execution
+        yield if block_given?
+      rescue => e
+        puts "Program ended with message: '#{e.message}'."
+        if config[:debug]
+          logger.fatal "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+        else
+          STDERR.puts '  Use --debug option for more detail (see --help).'
+        end
+        exit 1
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/scripts/completion.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+require 'digest/sha1'
+
+module EasyAppHelper
+  module Scripts
+
+    module Completion
+
+      def deploy_zsh_completion_script(script, target)
+        FileUtils.mkpath target
+        puts <<EOM
+
+------------------------------------------------------------------------------------------
+INFORMATION:
+    A new version of the zsh completion for '#{EasyAppHelper.config.app_name} #{EasyAppHelper.config.app_version}' has been installed.
+    You may want to restart a terminal to take it account.
+------------------------------------------------------------------------------------------
+
+EOM
+        FileUtils.copy script, target
+
+      end
+
+      def completion_script_changed?(script, target)
+        script_name = File.basename script
+        target_script = File.join target, script_name
+        return true unless File.exists? target_script
+        sha1_source = Digest::SHA1.hexdigest File.read script
+        sha1_target = Digest::SHA1.hexdigest File.read target_script
+        sha1_source != sha1_target
+      end
+
+      def install_or_update_completion(script, target)
+        unless ENV['IGNORE_COMPLETION_UPDATE']
+          if File.exists?(script)
+            deploy_zsh_completion_script script, target if completion_script_changed? script, target
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/scripts/master.rb

@@ -0,0 +1,66 @@
+module EasyAppHelper
+  module Scripts
+
+    class Master
+
+      include EasyAppHelper
+      include EasyAppHelper::Scripts::Common
+      include EasyAppHelper::Scripts::Completion
+
+      attr_reader :script_name
+
+      def initialize(app_name, app_version, app_description, config_file_base_name=nil)
+        @script_name = File.basename $0
+        config.config_file_base_name = config_file_base_name.nil? ? script_name : config_file_base_name
+        config.describes_application app_name: app_name,
+                                     app_version: app_version,
+                                     app_description: app_description
+      end
+
+      def run
+        safe_execution do
+          if sub_command_mode?
+            if ARGV.length == 1
+              %w(--help -h --version).each do |option|
+                if ARGV.include? option
+                  if option == '--version'
+                    puts DeploymentManager::VERSION
+                  else
+                    puts display_help
+                  end
+                  exit 0
+                end
+              end
+            end
+            if ARGV.empty?
+              puts display_help
+              exit 0
+            end
+            delegate_to_sub_command
+          else
+            pre_process
+            do_process
+          end
+          logger.info 'Application terminates successfully...'
+          exit 0
+        end
+      end
+
+      def display_help
+        config.command_line_help
+      end
+
+      def do_process
+        raise 'Please implement do_process in your action !'
+      end
+
+      private
+
+      def sub_command_mode?
+        self.class.included_modules.include? EasyAppHelper::Scripts::SubCommandManager
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/scripts/parameters_helper.rb

@@ -0,0 +1,22 @@
+module EasyAppHelper
+  module Scripts
+
+    module ParametersHelper
+
+      # Allows to specify a Ruby Symbol as a string. Supposed to be used to pass
+      # symbols from the command line.
+      # @param [String] param A string coming normally from the command line.
+      # @return [String or Symbol] if param starts with a colon, then it the
+      #        returns a symbol, ie: ':foo' returns :foo (the Symbol)
+      #        Else it will return the param itself. 'bar' returns 'bar' (the String)
+      def normalize_param(param)
+        param.match(/^:(?<param>.+)$/) do |md|
+          param = md['param'].to_sym
+        end
+        param
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/scripts/sub_command_base.rb

@@ -0,0 +1,51 @@
+module EasyAppHelper
+  module Scripts
+
+    module SubCommandBase
+
+      include EasyAppHelper
+      include EasyAppHelper::Scripts::Common
+
+      PROVIDER = 'Core'
+      NAME = ''
+      DESCRIPTION = ''
+      CATEGORY = ''
+      ALIASES = []
+
+      def self.included(base)
+        EasyAppHelper::Scripts::SubCommandManager.register base
+        base.extend ClassMethods
+      end
+
+      def command_parameters
+        params = extra_parameters
+        command = params.shift
+        raise 'Something weird happened !!' unless command == self.class::NAME or self.class::ALIASES.include? command
+        params
+      end
+
+      def do_process
+        raise "Process for '#{name}' in '#{self::PROVIDER}' not implemented !"
+      end
+
+      def display_help
+        config.app_description = self.class::DESCRIPTION
+        config.command_line_help
+      end
+
+      module ClassMethods
+
+        def help_line
+          line = ' * %-10s : %s' % [self::NAME, self::DESCRIPTION]
+          unless self::ALIASES.nil? or self::ALIASES.empty?
+            line += ' (aliases: %s).' % [ self::ALIASES.join(', ') ]
+          end
+          line
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/scripts/sub_command_manager.rb

@@ -0,0 +1,94 @@
+module EasyAppHelper
+  module Scripts
+
+    module SubCommandManager
+
+      def self.register(sub_command_class)
+        raise 'Please specify a sub_command class when registering' if sub_command_class.nil?
+        raise "Already registered sub_command '#{sub_command_class.to_s}' !" if sub_command_classes.include? sub_command_class
+        EasyAppHelper.logger.debug "Registering handler '#{sub_command_class.to_s}' for sub-command '#{sub_command_class::NAME}'"
+        sub_command_classes << sub_command_class
+        by_provider[sub_command_class::PROVIDER] ||= []
+        raise 'A provider cannot provide the same sub-command multiple times' if by_provider[sub_command_class::PROVIDER].include?(sub_command_class)
+        by_provider[sub_command_class::PROVIDER] << sub_command_class
+        by_name[sub_command_class::NAME] ||= []
+        by_name[sub_command_class::NAME] << sub_command_class
+        sub_command_class::ALIASES.each do |command_alias|
+          by_name[command_alias] ||= []
+          by_name[command_alias] << sub_command_class
+        end
+      end
+
+      def self.sub_command_classes
+        @sub_command_classes ||= []
+      end
+
+      def self.by_provider
+        @by_provider ||= {}
+      end
+
+      def self.by_name
+        @by_name ||= {}
+      end
+
+      def self.sub_command_class(command_name_or_alias, provider=EasyAppHelper::Scripts::SubCommandBase::PROVIDER)
+        candidates = by_provider[provider]
+        raise "There is no provider declared for command '#{command_name_or_alias}'" if candidates.nil?
+        candidates.select! do |sub_command_class|
+          command_classes_for_command = by_name[command_name_or_alias]
+          raise "There is no provider declared for command '#{command_name_or_alias}'" if command_classes_for_command.nil?
+          command_classes_for_command.include? sub_command_class
+        end
+        raise "Cannot determine provider to use for '#{command_name_or_alias}'. Multiple providers exist !" unless candidates.size == 1
+        candidates.first
+      end
+
+      def delegate_to_sub_command(provider = EasyAppHelper::Scripts::SubCommandBase::PROVIDER)
+        sub_command_name = extra_parameters.shift
+        sub_command = EasyAppHelper::Scripts::SubCommandManager.sub_command_class(sub_command_name, provider).new
+        sub_command.pre_process
+        raise 'You have to implement \'do_process\'' unless sub_command.respond_to? :do_process
+        sub_command.do_process
+      end
+
+
+      def display_help
+        result = [default_header]
+
+        EasyAppHelper::Scripts::SubCommandManager.sub_command_classes.group_by do |sub_command_classes|
+          sub_command_classes::CATEGORY
+        end .each_pair do |category, sub_command_classes_for_category|
+          result << ('  %s:' % category)
+          result << ''
+          sub_command_classes_for_category.each do |sub_command_class|
+            result << sub_command_class.help_line
+          end
+          result << ''
+        end
+        result
+      end
+
+      def default_header
+        <<EOF
+
+This is the '#{script_name}' tool version #{config.app_version} (AKA '#{self.class::NAME}').
+#{self.class::DESCRIPTION}
+
+It has some sub-commands, each taking its own options.
+
+You can do '#{script_name} <sub-command> --help' for more information on sub-modules.
+
+Options
+
+  --help/-h    : This help.
+  --version    : Echoes dm version
+
+Sub-commands:
+
+EOF
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/scripts.rb

@@ -0,0 +1,6 @@
+require 'easy_app_helper/scripts/common'
+require 'easy_app_helper/scripts/completion'
+require 'easy_app_helper/scripts/parameters_helper'
+require 'easy_app_helper/scripts/sub_command_base'
+require 'easy_app_helper/scripts/sub_command_manager'
+require 'easy_app_helper/scripts/master'

data/lib/easy_app_helper/version.rb

@@ -1,3 +1,3 @@
 module EasyAppHelper
-  VERSION = '4.0.3'
+  VERSION = '4.1.0'
 end

data/lib/tasks/template.rb.erb

@@ -7,65 +7,40 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'easy_app_helper'
+require 'easy_app_helper/scripts'
 require '<%= gem_name %>'
 
 module <%= gem_module %>
-  class <%= script_class %>
+  class <%= script_class %> < EasyAppHelper::Scripts::Master
+
+    # If you want to manage sub-commands a-la-git, include following
+    # include EasyAppHelper::Scripts::SubCommandManager
 
     # Inserted here, but you may probably have already defined this somewhere else...
     NAME = '<%= executable_name.titleize %>'
     DESCRIPTION = 'Description of <%= executable_name %>'
 
-    include EasyAppHelper
-
     def initialize
-      <% unless executable_name == gem_name -%>config.config_file_base_name = '<%= executable_name %>'
-      <% end -%>config.describes_application app_name: NAME,
-                                   app_version: <%= gem_module %>::VERSION,
-                                   app_description: DESCRIPTION
-      add_script_options
-    end
-
-    def run
-      # logging startup configuration
-      logger.debug "Config layers ->\n#{config.detailed_layers_info}"
-      logger.debug "Merged config -> #{config[].to_yaml}"
-      # Displaying (and exiting) command line help
-      if config[:help]
-        puts config.command_line_help
-        exit 0
-      end
-      check_config
-      logger.info 'Application is starting...'
-      do_process
-    rescue => e
-      puts "Program aborted with message: '#{e.message}'."
-      if config[:debug]
-        logger.fatal "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
-      else
-        puts '  Use --debug option for more detail (see --help).'
-      end
-    end
-
-    private
-
-    def add_script_options
-      ## Create here your extra command-line options
-      ## Here under are examples using potentially gem config layer to display default option value...
-      ## Check Slop documentation for further info.
-      # config.add_command_line_section do |slop|
-        # slop.on :p, :port, "Specify port to bind to. Default #{config.executable_gem_layer[:port]}.", argument: true, as: Integer
-        # slop.on :b, :bind, "Specify address to bind to. Default #{config.executable_gem_layer[:bind]}.", argument: true, as: String
-      # end
+      super(NAME, <%= gem_module %>::VERSION, DESCRIPTION<% unless executable_name == gem_name -%>, '<%= executable_name %>'<% end -%>)
     end
 
-    def do_process
-      # Your code here.
-    end
-
-    def check_config
-      # Check the config and raise an exception if incorrect.
-    end
+    # def add_script_options
+    #   ## Create here your extra command-line options
+    #   ## Here under are examples using potentially gem config layer to display default option value...
+    #   ## Check Slop documentation for further info.
+    #   # config.add_command_line_section do |slop|
+    #     # slop.on :p, :port, "Specify port to bind to. Default #{config.executable_gem_layer[:port]}.", argument: true, as: Integer
+    #     # slop.on :b, :bind, "Specify address to bind to. Default #{config.executable_gem_layer[:bind]}.", argument: true, as: String
+    #   # end
+    # end
+
+    # def do_process
+    #   # Your code here.
+    # end
+
+    # def check_config
+    #   # Check the config and raise an exception if incorrect.
+    # end
 
   end
 end

data/lib/tasks/template_manager.rb

@@ -29,7 +29,7 @@ module EasyAppHelper
         @gem_module = @gem_name.camelize
         @current_date = Time.now.strftime('%c')
         @script_class = executable_name == current_gem_spec.name ? '' : executable_name.camelize
-        @script_class << 'Script'
+        @script_class << 'MasterScript'
         renderer = ERB.new(File.read(TEMPLATE), nil, '-')
         renderer.result binding
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,13 @@ files:
 - lib/easy_app_helper/processes/command.rb
 - lib/easy_app_helper/processes/synchronous.rb
 - lib/easy_app_helper/processes/time_management.rb
+- lib/easy_app_helper/scripts.rb
+- lib/easy_app_helper/scripts/common.rb
+- lib/easy_app_helper/scripts/completion.rb
+- lib/easy_app_helper/scripts/master.rb
+- lib/easy_app_helper/scripts/parameters_helper.rb
+- lib/easy_app_helper/scripts/sub_command_base.rb
+- lib/easy_app_helper/scripts/sub_command_manager.rb
 - lib/easy_app_helper/tasks.rb
 - lib/easy_app_helper/version.rb
 - lib/tasks/easy_app_helper_tasks.rake