ferrets_on_fire 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e10279082200ad3c59578490354c5583b2d55053
-  data.tar.gz: e4270068759afb2b7d642330f99e72dfab844d8d
+  metadata.gz: bac851bccbedbc222f6d06b474250296ef76613b
+  data.tar.gz: 172a42f14e03ef71e07638b8ffd7c032c927a2d6
 SHA512:
-  metadata.gz: af775ab186a031447f7cba5e7ef4c488027c763387f825d0ada33380efbf88487fdcd1303dd4fda9b0a805396a5150cfe582e035d1de40dd6102ce17c8fb1cba
-  data.tar.gz: f827d326ee118b2743fcb4c185828df2481b7ae13712a9cc2f4e69f542317975069cf658320eb6b6c924a174b1b161ee83931a25b4a1bea31c64112b2551a5de
+  metadata.gz: 3a96c36a9e4c69e5a6fabb37d453bc681e6f14e013f5e85168ca64d9d7cc2782492b814cb08932a39ab208a722484c627d3c7a503d395be846614953f1646938
+  data.tar.gz: 659c558def859eb29631fd2a8bb314c754c91dd28d65beb7300f859a1b64f4850de06e0f9910eaa30b71aa721f34c39b56b7b13bfa193ba4941a8fdf5af45604

data/README.md

@@ -1,7 +1,7 @@
 # Ferrets on Fire
 
-Supercharge your CLI tools. This opinionated, burning gem helps you to write powerful CLI tools of all sizes without
-caring about the clutter!
+Supercharge your CLI tools. This opinionated, burning ruby gem helps you to write powerful CLI tools of all sizes
+without caring about the clutter!
 
 **WARNING: This project is work in progress, use with care.**
 
@@ -10,10 +10,10 @@ caring about the clutter!
 
 - Super simple and lightweight DSL.
 - Beautiful output (especially on OSX).
-- Builtin tasks for git, bundler, ...
-- Framework for system calls: Logging, benchmarking, error handling and more.
+- Builtin routines for git, bundler, ...
+- Framework for system calls: Logging, benchmarking, error handling, crash reporting and more.
 - Support CLI switches, options, arguments and commands.
-- Supports Logging, colors, progress bars, questions and much more.
+- Supports Logging, colors, progress bars, questions, yes/no and much more.
 - Builtin IoC container.
 - Ferrets.
 
@@ -21,9 +21,7 @@ caring about the clutter!
 
 - Command API
 - Code formatting, refactoring, documentation
-- Project, usage & API documentation
 - Progress bars
-- Highline
 - DSL for IoC container
 - RSpecs
 - CI build
@@ -41,7 +39,7 @@ or via `Gemfile`:
 gem 'ferrets_on_fire'
 ```
 
-(Don't forget to run `bundle install`)
+Don't forget to run `bundle install`.
 
 
 ## Usage
@@ -60,13 +58,114 @@ After that you can already you the fancy ferret DSL:
 require '_'
 
 # Some output
-info 'Running the test suit!'
+info 'Running the test suite!'
 
 # Run `bundle exec rspec spec/`
 run 'rspec spec/', bundler: true
 ```
 
 
+## DSL
+
+This is a complete documentation of the DSL containing all methods, theirs params etc.
+
+
+### General
+
+- `root()`: Returns the root path of the project, which uses this gem. Requires that the project uses bundler.
+- `load_lib()`: Adds the `lib` dir of the project, which uses this gem, to the LOAD_PATH.
+
+
+### Logging & Interaction
+
+- `banner(string, color: :white, background: :black)`: Prints a banner
+    - `string`: The banner.
+    - `color`: Optional. Text color.
+    - `background`: Optional. Background color.
+
+- `info(msg)`: Prints an information message. Color is white.
+    - `msg`: Message to print.
+
+- `action(msg)`: Prints an action message. Color is blue. If a block is given, it turns in a success message after the
+  block was yielded. Returns the return value of the block.
+    - `msg`: Message to print.
+
+- `warn(msg)`: Prints a warning message. Color is yellow.
+    - `msg`: Message to print.
+
+- `success(msg)`: Prints a success message. Color is green.
+    - `msg`: Message to print.
+    
+- `error(msg)`: Prints an error message. Color is red.
+    - `msg`: Message to print.
+    
+- `choose(msg, options, default: nil)`: Let's the user choose out of options. It returns the chosen option.
+    - `msg`: Prompt message.
+    - `options`: Array of options.
+    - `default`: Optional. Default option value.
+
+- `yes_no(msg, default = true)`: Asks the user a simple yes/no question, which can be answered with `y` or `n`. Returns
+  true if the user has answered with yes. false for no.
+    - `msg`: Prompt message
+    - `default`: true = yes is the default, false = no is the default
+
+- `linebreak()`: Prints a linebreak
+
+- `highlight(str)`: Highlights a string for the use with info like: `info("foo #{highlight(bar)}!")`
+
+- `crash(msg, output, command: nil, exit: true)`: Prints a crash report
+    - `msg`: Error message.
+    - `command`: Optional. Shell command if available.
+    - `exit`: Optional. If true the script will exit. 
+
+
+
+### Shell commands
+
+- `bundle(dir: nil)`: Runs `bundle install` in the specified dir. Bundler is configured for
+  optimal performance.
+    - `dir`: Optional. The directory to run in. If empty, the current working dir is used.
+
+- `run(cmd, dir: nil, exit_on_failure: true, quiet: false, return_exit_code: false, as: nil, bundler: false, rails_env: nil)`:
+  Executes a shell command. The command will be logged as an action (blue), which turns in a success message after the
+  command finished successful. A crash report is generated if the command fails. stderr is redirected to stdout. It
+  returns stdout. The command is benchmarked and the time is printed automatically.
+    - `cmd`: Command to run.
+    - `dir`: Optional. Working dir for the command. If empty, the current working dir is used.
+    - `exit_on_failure`: Optional. Exit if the command fails?
+    - `quiet`: Optional. Don't log anything if true. 
+    - `return_exit_code`: Optional. If true, the exit code is returned rather than the output. 
+    - `as`: Optional. Label to use for logging instead of the command.
+    - `bundler`: Optional. Run command with `bundle exec`?.
+    - `rails_env`: Optional. Set the `RAILS_ENV` variable.
+
+
+### git
+
+- `update_git_repo(path: nil, desired_branch: nil, skip_update: false)`: Runs a git pull in the specified directory and
+  runs the `bin/update` command within that directory, if it exists.
+    - `path`: Optional. The directory with the git repo. If not specified, the current working directory is used.
+    - `desired_branch`: Optional. Branch that should be checked out - if it's not checked out, a warning is printed.
+    - `skip_update`: Optional. Don't run `bin/update` if true.
+
+- `clone_git_repo(remote, target: '', checkout: nil, skip_setup: false)`: Clones a git repository to a local directory
+  and runs `bin/setup` if that exists
+    - `remote`: The git remote URL.
+    - `target`: Optional. Local directory to clone into. If empty, the repo name is used.
+    - `checkout`: Optional. Checkout a commit, branch, etc.
+    - `skip_setup`: Optional. Don't run `bin/setup` if true.
+
+- `git_checkout(dir, checkout)`: Checks out a specific commit, tag, branch etc.
+    - `dir`: Local dir with the repo
+    - `checkout`: Ref to checkout
+
+- `find_git_tags(dir)`: Returns all tags in a git repo
+    - `dir`: Local dir with the repo
+
+- `get_git_master_ref(dir)`: Returns a Rugged Ref object for the `origin/master` ref 
+    - `dir`: Local dir with the repo
+
+
 
 ## Open Source
 

data/lib/ferrets_on_fire/command.rb

@@ -4,8 +4,6 @@ class FerretsOnFire::Command
   attr_reader :name, :desc, :default, :action_block
   attr_accessor :global_options, :options, :args
 
-  include FerretsOnFire::DSL
-
   public def initialize(name, desc, default, &block)
     @name = name.to_sym
     @desc = desc
@@ -18,8 +16,4 @@ class FerretsOnFire::Command
   public def action(&block)
     @action_block = block
   end
-
-  public def run
-    yield @block
-  end
 end

data/lib/ferrets_on_fire/dsl/{declaration.rb → declaration_dsl.rb}

@@ -1,15 +1,4 @@
-module FerretsOnFire::DSL::Declaration
-  public def bundle(dir: nil)
-    # Set bundler parallel jobs count
-    if run('sysctl -n hw.ncpu', quiet: true, return_exit_code: true).zero?
-      number_of_cores = run('sysctl -n hw.ncpu', quiet: true).strip.to_i - 1
-      run("bundle config --global jobs #{number_of_cores}", quiet: true)
-    end
-
-    run 'bundle', dir: dir, as: 'bundler'
-  end
-
-
+module FerretsOnFire::DSL::DeclarationDSL
   public def description(desc)
     @desc = desc
   end

data/lib/ferrets_on_fire/dsl/git_dsl.rb

@@ -0,0 +1,50 @@
+module FerretsOnFire::DSL::GitDSL
+  # Updates the git repository in the current directory and runs bin/update
+  # @param [String] path The directory to use, default is the current one
+  public def update_git_repo(path: nil, desired_branch: nil, skip_update: false)
+    run 'git pull -r --autostash', dir: path, as: 'git pull'
+
+    # get current branch name
+    if desired_branch
+      current_branch = run('git branch | grep \*', dir: path, quiet: true).sub('*', '').strip
+
+      unless current_branch == desired_branch
+        warn "WARNING: Current branch is not #{desired_branch} (it's #{current_branch})"
+      end
+    end
+
+    run('bin/update', dir: path, as: 'bin/update', bundler: true) if !skip_update && File.exists?('bin/update')
+  end
+
+
+  public def clone_git_repo(remote, target: '', checkout: nil, skip_setup: false)
+    run "git clone #{remote} #{target}", as: 'clone git repo'
+    run "git checkout #{checkout}", as: "checkout #{checkout}", dir: target unless checkout.nil?
+    run('bin/setup', dir: target, as: 'bin/setup', bundler: true) if !skip_setup && File.exists?('bin/setup')
+  end
+
+  private def _git_setup(dir)
+    require 'rugged'
+    Rugged::Repository.new(dir)
+  end
+
+
+  public def git_checkout(dir, checkout)
+    repo = _git_setup(dir)
+    repo.checkout checkout, strategy: :force
+  end
+
+  public def find_git_tags(dir)
+    repo = _git_setup(dir)
+
+    # Find all tags
+    tags = []
+    repo.references.each('refs/tags/*') { |ref| tags << ref }
+    tags
+  end
+
+  public def get_git_master_ref(dir)
+    repo = _git_setup(dir)
+    repo.ref('refs/remotes/origin/master')
+  end
+end

data/lib/ferrets_on_fire/dsl/{logger.rb → logger_dsl.rb}

@@ -1,9 +1,10 @@
 require 'colorize'
 require 'benchmark'
+require 'highline'
 
-module FerretsOnFire::DSL::Logger
+module FerretsOnFire::DSL::LoggerDSL
   COLORS = {
-      info: :white,
+      info: nil,
       warn: :yellow,
       error: :red,
       success: :green,
@@ -16,7 +17,7 @@ module FerretsOnFire::DSL::Logger
       warn: '⚠️ ',
       error: '‼️️ ',
       success: '✨ ',
-      question: '❓ ',
+      question: "\n❓ ",
       action: '⚙️ '
   }.freeze
 
@@ -25,7 +26,7 @@ module FerretsOnFire::DSL::Logger
       warn: '[!]',
       error: '[X]',
       success: '[✔]',
-      question: '[?]',
+      question: "\n[?]",
       action: '[$]'
   }.freeze
 
@@ -34,10 +35,15 @@ module FerretsOnFire::DSL::Logger
       warn: '',
       error: '',
       success: '',
-      question: ' >',
+      question: ' > ',
       action: ''
   }.freeze
 
+
+  public def banner(string, color: :white, background: :black)
+    puts string.colorize(color: color, background: background)
+  end
+
   # Outputs a info message
   # @param [String] msg The message
   public def info(msg)
@@ -68,10 +74,34 @@ module FerretsOnFire::DSL::Logger
 
   # Generates a question with the specified msg. If output is true (default) it will be printed.
   # @param [String] msg The message
-  # @param [Boolean] output (Optional, default is true). Print the question?
-  # @return [String] The question
-  public def question(msg, output = true)
-    puts log(msg, :question) if output
+  # @param [Array<Object>] options Array of option
+  # @return [Object] The chosen option value
+  public def choose(msg, options, default: nil)
+    linebreak
+
+    HighLine.new.choose do |menu|
+      menu.prompt = log(msg + (default.nil? ? '' : " (Default: #{default})"), :question)
+      menu.flow = :columns_across
+      menu.default = default unless default.nil?
+      menu.index_suffix = ') '
+
+      options.each do |opt|
+        menu.choice(opt) { return opt }
+      end
+    end
+  end
+
+  public def yes_no(msg, default = true)
+    answer = nil
+
+    until answer == '' || answer =~ /^(y|n)$/i
+      y = default ? 'Y' : 'y'
+      n = default ? 'n' : 'N'
+      answer = HighLine.new.ask(log("#{msg} (#{y}/#{n})", :question))
+      answer = default ? 'y' : 'n' if answer == ''
+    end
+
+    answer.downcase == 'y'
   end
 
 
@@ -79,21 +109,44 @@ module FerretsOnFire::DSL::Logger
     puts
   end
 
+  public def highlight(str)
+    str.light_blue
+  end
 
-  public def crash(msg, output, command: nil, exit_on_failure: true)
+
+  public def crash(msg, output, command: nil, exit: true)
+    puts
     error msg
     puts
-    puts ' ============='
-    puts "COMMAND: #{command}" unless command.nil?
+    puts '=====================[ CRASH REPORT ]====================='.red
+
+    unless command.nil?
+      puts
+      puts 'COMMAND: '.red
+      puts command
+    end
+
+    puts
+    puts 'ERROR:'.red
     puts output
-    puts ' ============='
     puts
-    exit 1 if exit_on_failure
+    puts '=========================================================='.red
+    puts
+    exit 1 if exit
   end
 
-  # Logs that an action will happen. You have to call action_end after that
+  public def action(msg)
+    print log(msg, :action)
+
+    return_value = block_given? ? yield : nil
+
+    puts "\r#{log(msg, :success)}"
+    return_value
+  end
+
+
   # @param [String] msg Message to display
-  public def action(msg, &block)
+  private def _shell_action(msg)
     print log(msg, :action, '  ...  ')
     cmd_output = ''
     bm = ::Benchmark.measure { cmd_output = yield }
@@ -112,6 +165,7 @@ module FerretsOnFire::DSL::Logger
 
     info = info.empty? ? '' : "[#{info}] "
 
-    "#{prefix} #{info}#{msg}#{suffix}".send(color)
+    output = "#{prefix} #{info}#{msg}#{suffix}"
+    color.nil? ? output : output.send(color)
   end
 end

data/lib/ferrets_on_fire/dsl/{shell.rb → shell_dsl.rb}

@@ -1,4 +1,15 @@
-module FerretsOnFire::DSL::Shell
+module FerretsOnFire::DSL::ShellDSL
+  public def bundle(dir: nil)
+    # Set bundler parallel jobs count
+    if run('sysctl -n hw.ncpu', quiet: true, return_exit_code: true).zero?
+      number_of_cores = run('sysctl -n hw.ncpu', quiet: true).strip.to_i - 1
+      run("bundle config --global jobs #{number_of_cores}", quiet: true)
+    end
+
+    run 'bundle', dir: dir, as: 'bundler'
+  end
+
+
   # Runs a shell command. Stderr is redirected to Stdout
   # @param [String]  cmd              Command to run
   # @param [String]  dir              Directory to run the command in
@@ -17,23 +28,23 @@ module FerretsOnFire::DSL::Shell
     cmd = build_command(cmd, dir, rails_env, bundler)
 
     # Run the command and print the output if wished
-    output, status = exec(cmd, quiet, as)
+    output, status = execute_shell_cmd(cmd, quiet, as)
 
     # Error handling
     if status.nonzero? && return_exit_code == false
-      crash "COMMAND EXITED WITH #{status}!", output, command: cmd, exit_on_failure: exit_on_failure
+      crash "Shell command exited with status code #{status}!", output, command: cmd, exit_on_failure: exit_on_failure
     end
 
     return_exit_code ? status : output
   end
 
 
-  # Executes a shell command in the specified dir. Includes benchmarking and debug output.
+  # Executes a shell command in the specified dir. Includes benchmarking
   # @param [String] cmd        Command to run
   # @param [String] quiet      Optional. Suppress output
   # @param [String] label      Optional. Label
   # @return [Array] 0 => output, 1 => exit code
-  private def exec(cmd, quiet = false, label = nil)
+  private def execute_shell_cmd(cmd, quiet = false, label = nil)
     label ||= cmd
 
     # Run the command
@@ -41,7 +52,7 @@ module FerretsOnFire::DSL::Shell
       cmd_output = `#{cmd} 2>&1`
       status = $?.to_i
     else
-      cmd_output, status = action(label) { `#{cmd} 2>&1` }
+      cmd_output, status = _shell_action(label) { `#{cmd} 2>&1` }
     end
 
     # Return exit code and output
@@ -49,7 +60,7 @@ module FerretsOnFire::DSL::Shell
   end
 
 
-  def build_command(cmd, dir, rails_env, bundler)
+  private def build_command(cmd, dir, rails_env, bundler)
     result = ''
     result += "cd #{dir} && " unless dir.nil?
     result += "RAILS_ENV=#{rails_env} " unless rails_env.nil?

data/lib/ferrets_on_fire/dsl.rb

@@ -1,15 +1,23 @@
 module FerretsOnFire::DSL
-  require 'ferrets_on_fire/dsl/declaration'
-  require 'ferrets_on_fire/dsl/shell'
-  require 'ferrets_on_fire/dsl/logger'
-  require 'ferrets_on_fire/dsl/git'
+  require 'ferrets_on_fire/dsl/declaration_dsl'
+  require 'ferrets_on_fire/dsl/shell_dsl'
+  require 'ferrets_on_fire/dsl/logger_dsl'
+  require 'ferrets_on_fire/dsl/git_dsl'
 
-  include FerretsOnFire::DSL::Declaration
-  include FerretsOnFire::DSL::Shell
-  include FerretsOnFire::DSL::Logger
-  include FerretsOnFire::DSL::Git
+  include FerretsOnFire::DSL::DeclarationDSL
+  include FerretsOnFire::DSL::ShellDSL
+  include FerretsOnFire::DSL::LoggerDSL
+  include FerretsOnFire::DSL::GitDSL
 
   public def get(name)
     @options[name.to_sym] || @global_options[name.to_sym]
   end
+
+  public def root
+    Bundler.root
+  end
+
+  public def load_lib
+    $: << "#{root}/lib"
+  end
 end

data/lib/ferrets_on_fire/version.rb

@@ -1,3 +1,3 @@
 module FerretsOnFire
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/ferrets_on_fire.rb

@@ -2,14 +2,15 @@ module FerretsOnFire
   require 'ferrets_on_fire/dsl'
   include FerretsOnFire::DSL
 
-  public def execute
-    @gli = setup_gli
+  # FIXME does that work?
+  public def call
+    @gli = _setup_gli
     @gli.run(ARGV)
     exit
   end
 
 
-  public def setup_gli
+  private def _setup_gli
     GliWrapper.new(@desc, @commands, @options, @switches, @arguments)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrets_on_fire
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - phortx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: micon
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
 description: Supercharge your CLI tools. This gem helps you to write powerful CLI
   tools without caring about the clutter
 email:
@@ -80,10 +94,10 @@ files:
 - lib/ferrets_on_fire/argument.rb
 - lib/ferrets_on_fire/command.rb
 - lib/ferrets_on_fire/dsl.rb
-- lib/ferrets_on_fire/dsl/declaration.rb
-- lib/ferrets_on_fire/dsl/git.rb
-- lib/ferrets_on_fire/dsl/logger.rb
-- lib/ferrets_on_fire/dsl/shell.rb
+- lib/ferrets_on_fire/dsl/declaration_dsl.rb
+- lib/ferrets_on_fire/dsl/git_dsl.rb
+- lib/ferrets_on_fire/dsl/logger_dsl.rb
+- lib/ferrets_on_fire/dsl/shell_dsl.rb
 - lib/ferrets_on_fire/gli_wrapper.rb
 - lib/ferrets_on_fire/option.rb
 - lib/ferrets_on_fire/switch.rb

data/lib/ferrets_on_fire/dsl/git.rb

@@ -1,25 +0,0 @@
-module FerretsOnFire::DSL::Git
-  # Updates the git repository in the current directory and runs bin/update
-  # @param [String] path The directory to use, default is the current one
-  public def update_repo(path: nil, desired_branch: nil)
-    run 'git pull -r --autostash', dir: path, as: 'git pull'
-
-    # get current branch name
-    if desired_branch
-      current_branch = run('git branch | grep \*', dir: path, quiet: true).sub('*', '').strip
-
-      unless current_branch == desired_branch
-        warn "WARNING: Current branch is not #{desired_branch} (it's #{current_branch})"
-      end
-    end
-
-    run('bin/update', dir: path, as: 'bin/update', bundler: true) if File.exists?('bin/update')
-  end
-
-
-  public def clone_repo(remote, target: '', desired_branch: 'develop')
-    run "git clone #{remote} #{target}", as: 'clone'
-    run "git checkout #{desired_branch}", as: "checkout #{desired_branch}", dir: target
-    run('bin/setup', dir: target, as: 'bin/setup', bundler: true) if File.exists?('bin/setup')
-  end
-end