runfile 0.12.0 → 1.0.0.rc1

data/lib/runfile/userfile.rb

@@ -0,0 +1,111 @@
+require 'shellwords'
+
+module Runfile
+  # Represents a single runfile.
+  class Userfile
+    include Renderable
+    include Inspectable
+    include DSL
+
+    attr_reader :code, :name, :path
+    attr_writer :context
+    alias action_prefix name
+
+    class << self
+      def load_file(path)
+        if masterfile? path
+          name = nil
+        else
+          name = File.basename path, '.runfile'
+          path = "#{path}.runfile" unless path.end_with? '.runfile'
+        end
+
+        code = File.read path
+        new code, name: name, path: path
+      end
+
+      def masterfile?(path)
+        Meta::MASTERFILE_NAMES.include? path
+      end
+    end
+
+    def initialize(code = nil, name: nil, path: nil)
+      @code = code
+      @name = name
+      @path = path
+
+      return unless @code
+
+      if path
+        instance_eval @code, @path
+      else
+        instance_eval @code
+      end
+    end
+
+    def inspectable
+      { name: name, path: path }
+    end
+
+    def run(argv = [])
+      found_delegate = delegate argv[0]
+      if found_delegate
+        found_delegate.run argv
+      else
+        run_local argv
+      end
+    end
+
+    def context
+      @context ||= {}
+    end
+
+    def implicit_title
+      title || name
+    end
+
+    # Returns an array of actions that have help defined
+    def commands
+      actions.values.select(&:help)
+    end
+
+    def delegates
+      @delegates ||= (name ? {} : meta.external_files)
+    end
+
+  private
+
+    def find_action(args)
+      acts = actions.values
+      acts.find { |a| args[a.name] } ||
+        acts.find { |a| args[a.shortcut] } ||
+        acts.find { |a| args[a.prefix] } ||
+        actions[:default]
+    end
+
+    def run_local(argv)
+      Runner.run docopt, argv: argv, version: version do |args|
+        action = find_action(args)
+        raise ActionNotFound, 'Cannot find action. Is it properly defined?' unless action
+
+        action.run args
+      end
+    end
+
+    def delegate(name)
+      return nil unless delegates.has_key? name
+
+      result = delegates[name]
+      result.context = contexts[name]
+      result
+    end
+
+    def meta
+      @meta ||= Meta.new
+    end
+
+    def docopt
+      @docopt ||= render 'userfile', context: self
+    end
+  end
+end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = "0.12.0"
-end
+  VERSION = '1.0.0.rc1'
+end

data/lib/runfile/views/initiator.gtx

@@ -0,0 +1,28 @@
+> Runfile
+>
+>   Local command line for your projects
+>
+> Usage:
+>   run new
+>   run example [NAME]
+>   run --help | -h
+>   run --version
+>
+> Commands:
+>   nb`new`
+>     Create a new runfile in the current directory
+>
+>   nb`example`
+>     Copy one of the examples to the current directory
+>     Run without arguments to see the list of examples
+>
+> Options:
+>   --help, -h
+>     Show this message
+>
+>   --version
+>     Show version number
+>
+> Documentation:
+>   bu`https://runfile.dannyb.co`
+>

data/lib/runfile/views/userfile.gtx

@@ -0,0 +1,93 @@
+if implicit_title
+  = implicit_title
+  >
+end
+
+if summary
+  = implicit_title ? word_wrap("  #{summary}") : word_wrap(summary)
+  >
+end
+
+> Usage:
+actions.each do |name, action|
+  action.implicit_usages.each do |usage|
+    = "  run #{usage}".rstrip
+  end
+end
+
+delegates.keys.each do |name|
+  = "  run #{name}"
+end
+
+if delegates.any?
+>   run [COMMAND] (--help | -h)
+elsif name
+>   run {{ name }} (--help | -h)
+else
+>   run (--help | -h)
+end
+
+if version
+>   run --version
+end
+>
+
+if commands.any? || delegates.any?
+  > Commands:
+  commands.each do |action|
+    = "  nb`#{action.names.join(', ')}`"
+    = word_wrap "    #{action.help}"
+    >
+  end
+
+  delegates.each do |name, userfile|
+    summary = userfile.summary || userfile.title ||
+      "Run nu`run #{name} --help` for more information"
+
+    = "  nb`#{name}`"
+    = word_wrap "    #{summary}"
+    >
+  end
+end
+
+if params.any?
+  > Parameters:
+  params.each do |name, help|
+    = "  #{name}"
+    = word_wrap "    #{help}"
+    >
+  end
+end
+
+> Options:
+options.each do |name, help|
+  = "  #{name}"
+  = word_wrap "    #{help}"
+  >
+end
+>   --help, -h
+>     Show this message
+>
+if version
+  >   --version
+  >     Show version number
+  >
+end
+
+if env_vars.any?
+  > Environment Variables:
+  env_vars.each do |name, help|
+    = "  #{name}"
+    = word_wrap "    #{help}"
+  end
+  >
+end
+
+
+if examples.any?
+  > Examples:
+  examples.each do |text|
+    = word_wrap "  #{text}"
+  end
+  >
+end

data/lib/runfile.rb

@@ -1,10 +1,13 @@
-require 'runfile/version'
-require 'runfile/terminal'
-require 'runfile/refinements'
-require 'runfile/settings'
-require 'runfile/setup'
-require 'runfile/docopt_helper'
-require 'runfile/runfile_helper'
-require 'runfile/action'
-require 'runfile/runner'
-require 'runfile/dsl'
+require 'gtx'
+require 'docopt'
+require 'colsole'
+require 'requires'
+
+requires 'runfile/exceptions'
+requires 'runfile/concerns'
+requires 'runfile'
+
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end

metadata

@@ -1,54 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: gtx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-description: Build command line applications per project with ease. Rake-inspired,
-  Docopt inside.
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Build expressive command line utilities for your projects.
 email: db@dannyben.com
 executables:
-- run
-- run!
+- runn
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- bin/run
-- bin/run!
+- bin/runn
+- examples/default-action-2/runfile
+- examples/default-action-2/server.runfile
+- examples/default-action/runfile
+- examples/different-name/runfile.rb
+- examples/example-multiline/runfile
+- examples/example/runfile
+- examples/execute/runfile
+- examples/execute/server.runfile
+- examples/full/runfile
+- examples/import/more_tasks/spec.runfile
+- examples/import/runfile
+- examples/import/tasks/server.runfile
+- examples/minimal/runfile
+- examples/multiple-runfiles/runfile
+- examples/multiple-runfiles/server.runfile
+- examples/named-only/deploy.runfile
+- examples/named-only/server.runfile
+- examples/naval-fate/runfile
+- examples/shortcut/runfile
 - lib/runfile.rb
 - lib/runfile/action.rb
-- lib/runfile/compatibility.rb
-- lib/runfile/docopt_helper.rb
-- lib/runfile/dsl.rb
-- lib/runfile/refinements.rb
-- lib/runfile/runfile_helper.rb
+- lib/runfile/concerns/dsl.rb
+- lib/runfile/concerns/inspectable.rb
+- lib/runfile/concerns/renderable.rb
+- lib/runfile/entrypoint.rb
+- lib/runfile/exceptions.rb
+- lib/runfile/gem_finder.rb
+- lib/runfile/initiator.rb
+- lib/runfile/meta.rb
 - lib/runfile/runner.rb
-- lib/runfile/settings.rb
-- lib/runfile/setup.rb
-- lib/runfile/templates/Runfile
-- lib/runfile/terminal.rb
+- lib/runfile/templates/runfile
+- lib/runfile/userfile.rb
 - lib/runfile/version.rb
+- lib/runfile/views/initiator.gtx
+- lib/runfile/views/userfile.gtx
 homepage: https://github.com/DannyBen/runfile
 licenses:
 - MIT
@@ -57,6 +130,7 @@ metadata:
   changelog_uri: https://github.com/DannyBen/runfile/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/DannyBen/runfile
   bug_tracker_uri: https://github.com/DannyBen/runfile/issues
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -65,15 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
-summary: If Rake and Docopt had a baby
+summary: Local command line for your projects
 test_files: []

data/bin/run

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'runfile'
-
-# for dev
-# require File.dirname(__FILE__) + "/../lib/runfile"
-
-include Runfile::DSL
-
-Runfile::Runner.instance.execute ARGV

data/bin/run!

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-# This is needed in cases when you are running "run!" from a folder
-# that contains a Gemfile on a machine with RVM.
-# It will disable attempting to run in the current context
-# Source: https://rvm.io/integration/bundler
-ENV['NOEXEC_DISABLE'] = '1'
-
-require 'runfile'
-
-# for dev
-# require File.dirname(__FILE__) + "/../lib/runfile"
-
-include Runfile::DSL
-
-Runfile::Runner.instance.execute ARGV, false

data/lib/runfile/compatibility.rb

@@ -1,84 +0,0 @@
-# This file provides a compatibility layer for version 0.12.0 so that
-# all the Colsole methods (say, resay...) and ExecHandler methods
-# (run, run_bg...) are still available
-# Simply require 'runfile/compatibility' to have the same functionality
-# as older versions.
-#
-# Notes:
-# - You need to have the colsole gem installed
-# - Requiring this file also includes it (see the end of the file).
-# - This functinality will be removed in future versions
-# - More info: https://github.com/DannyBen/runfile/pull/46
-require 'colsole'
-
-module Runfile
-  module Compatibilty
-    include Colsole
-
-    # Run a command, wait until it is done and continue
-    def run(cmd)
-      cmd = @before_run_block.call(cmd) if @before_run_block
-      return false unless cmd
-      say "!txtgrn!> #{cmd}" unless Runfile.quiet
-      system cmd
-      @after_run_block.call(cmd) if @after_run_block
-    end
-
-    # Run a command, wait until it is done, then exit
-    def run!(cmd)
-      cmd = @before_run_block.call(cmd) if @before_run_block
-      return false unless cmd
-      say "!txtgrn!> #{cmd}" unless Runfile.quiet
-      exec cmd
-    end
-
-    # Run a command in the background, optionally log to a log file and save
-    # the process ID in a pid file
-    def run_bg(cmd, pid: nil, log: '/dev/null')
-      cmd = @before_run_block.call(cmd) if @before_run_block
-      return false unless cmd
-      full_cmd = "exec #{cmd} >#{log} 2>&1"
-      say "!txtgrn!> #{full_cmd}" unless Runfile.quiet
-      process = IO.popen "exec #{cmd} >#{log} 2>&1"
-      File.write pidfile(pid), process.pid if pid
-      @after_run_block.call(cmd) if @after_run_block
-      return process.pid
-    end
-
-    # Stop a command started with 'run_bg'. Provide the name of he pid file you 
-    # used in 'run_bg'
-    def stop_bg(pid)
-      file = pidfile(pid)
-      if File.exist? file
-        pid = File.read file
-        File.delete file
-        run "kill -s TERM #{pid}"
-      else
-        say "!txtred!PID file not found." unless Runfile.quiet
-      end
-    end
-
-    # Set a block to be called before each run
-    def before_run(&block)
-      @before_run_block = block
-    end
-
-    # Set a block to be called after each run
-    def after_run(&block)
-      @after_run_block = block
-    end
-
-  private
-
-    def pid_dir
-      defined?(Runfile.pid_dir) ? Runfile.pid_dir : nil
-    end
-
-    def pidfile(pid)
-      pid_dir ? "#{pid_dir}/#{pid}.pid" : "#{pid}.pid"
-    end
-
-  end
-end
-
-include Runfile::Compatibilty

data/lib/runfile/docopt_helper.rb

@@ -1,128 +0,0 @@
-require 'docopt'
-
-module Runfile
-  # The DocoptHelper class handles the dynamic generation of the 
-  # docopt document and the docopt part of the execution (meaning,
-  # to call Docopt so it returns the parsed arguments or halts with
-  # usage message).
-  class DocoptHelper
-    using Refinements
-
-    # The constructor expects to an object that responds to all the 
-    # textual details needed to generate a docopt document (name, version, 
-    # summary, options) and an array of Action objects.
-    # The superspace argument will be the name of runfile, in case we
-    # are running a named.runfile. It is only needed to generate the 
-    # proper `run superspace (-h|--help|--version)` line
-    def initialize(options)
-      @superspace = options.superspace
-      @name       = options.name
-      @version    = options.version
-      @summary    = options.summary
-      @actions    = options.actions
-      @options    = options.options
-      @params     = options.params
-      @env_vars   = options.env_vars
-      @examples   = options.examples
-    end
-
-    # Generate a document based on all the actions, help messages
-    # and options we have collected from the Runfile DSL.
-    def docopt
-      width = Terminal.width
-      doc = []
-      doc << (@version ? "#{@name} #{@version}" : "#{@name}")
-      doc << "#{@summary}" if @summary
-      doc += docopt_usage
-      doc += docopt_commands width
-      doc += docopt_options width
-      doc += docopt_params width
-      doc += docopt_env_vars width
-      doc += docopt_examples width
-      doc.join "\n"
-    end
-
-    # Return all docopt lines for the 'Usage' section
-    def docopt_usage 
-      doc = ["\nUsage:"];
-      @actions.each do |_name, action|
-        doc << "  run #{action.usage}" unless action.usage == false
-      end
-      basic_flags = @version ? "(-h|--help|--version)" : "(-h|--help)"
-      if @superspace
-        doc << "  run #{@superspace} #{basic_flags}\n"
-      else
-        doc << "  run #{basic_flags}\n"
-      end
-      doc
-    end
-
-    # Return all docopt lines for the 'Commands' section
-    def docopt_commands(width)
-      doc = []
-      caption_printed = false
-      @actions.each do |_name, action|
-        action.help or next
-        doc << "Commands:" unless caption_printed
-        caption_printed = true
-        helpline = "      #{action.help}"
-        wrapped  = helpline.word_wrap width
-        doc << "  #{action.usage}\n#{wrapped}\n" unless action.usage == false
-      end
-      doc
-    end
-
-    # Return all docopt lines for the various 'Options' sections
-    def docopt_options(width)
-      @options['Options'] = {} unless @options['Options']
-      @options['Options']['-h --help'] = 'Show this screen'
-      @options['Options']['--version'] = 'Show version number' if @version
-      section_block @options, width
-    end
-
-    # Return all docopt params for 'Params' section
-    def docopt_params(width)
-      section_block @params, width
-    end
-
-    # Return all docopt params for 'Environment Variables' section
-    def docopt_env_vars(width)
-      section_block @env_vars, width
-    end
-
-    # Return all docopt lines for the 'Examples' section
-    def docopt_examples(width)
-      return [] if @examples.empty?
-
-      doc = ["Examples:"]
-      base_command = @superspace ? "run #{@superspace}" : "run"
-      @examples.each do |command|
-        helpline = "  #{base_command} #{command}"
-        wrapped  = helpline.word_wrap width
-        doc << "#{wrapped}"
-      end
-      doc
-    end
-
-    # Return a generic block containing scope section (e.g. "Options"), 
-    # followed by key value paragraphs.
-    def section_block(definitions, width)
-      doc = []
-      definitions.each do |scope, values|
-        doc << "#{scope}:"
-        values.each do |label, text|
-          helpline = "      #{text}"
-          wrapped  = helpline.word_wrap width
-          doc << "  #{label}\n#{wrapped}\n"
-        end
-      end
-      doc
-    end
-
-    # Call the docopt handler, which will either return a parsed
-    # arguments list, or halt execution and show usage.
-    def args(argv)
-      Docopt.docopt(docopt, version: @version, argv:argv)
-    end
-  end
-end