ferrets_on_fire 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e10279082200ad3c59578490354c5583b2d55053
+  data.tar.gz: e4270068759afb2b7d642330f99e72dfab844d8d
+SHA512:
+  metadata.gz: af775ab186a031447f7cba5e7ef4c488027c763387f825d0ada33380efbf88487fdcd1303dd4fda9b0a805396a5150cfe582e035d1de40dd6102ce17c8fb1cba
+  data.tar.gz: f827d326ee118b2743fcb4c185828df2481b7ae13712a9cc2f4e69f542317975069cf658320eb6b6c924a174b1b161ee83931a25b4a1bea31c64112b2551a5de

data/README.md

@@ -0,0 +1,73 @@
+# 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!
+
+**WARNING: This project is work in progress, use with care.**
+
+
+## Features
+
+- 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.
+- Support CLI switches, options, arguments and commands.
+- Supports Logging, colors, progress bars, questions and much more.
+- Builtin IoC container.
+- Ferrets.
+
+## TODO
+
+- Command API
+- Code formatting, refactoring, documentation
+- Project, usage & API documentation
+- Progress bars
+- Highline
+- DSL for IoC container
+- RSpecs
+- CI build
+
+
+## Installation
+
+```bash
+$ gem install ferrets_on_fire
+```
+
+or via `Gemfile`:
+
+```ruby
+gem 'ferrets_on_fire'
+```
+
+(Don't forget to run `bundle install`)
+
+
+## Usage
+
+Loading the Ferrets on Fire framework is made for lazy developers (like me) and requires nearly no code:
+
+```ruby
+require '_'
+```
+
+This is it. No verbose filenames. No `include`s. No setup.
+
+After that you can already you the fancy ferret DSL:
+
+```ruby
+require '_'
+
+# Some output
+info 'Running the test suit!'
+
+# Run `bundle exec rspec spec/`
+run 'rspec spec/', bundler: true
+```
+
+
+
+## Open Source
+
+MIT Licence. Feel free to contribute.

data/lib/_.rb

@@ -0,0 +1,14 @@
+# Enable `require '_'`
+
+require 'ferrets_on_fire'
+require 'ferrets_on_fire/option'
+require 'ferrets_on_fire/switch'
+require 'ferrets_on_fire/argument'
+require 'ferrets_on_fire/command'
+require 'ferrets_on_fire/gli_wrapper'
+
+module FoF
+  include FerretsOnFire
+end
+
+include FoF

data/lib/ferrets_on_fire/argument.rb

@@ -0,0 +1,9 @@
+class FerretsOnFire::Argument
+  attr_reader :name, :short, :default, :desc
+
+  public def initialize(name, default, desc)
+    @name = name.to_sym
+    @default = default
+    @desc = desc
+  end
+end

data/lib/ferrets_on_fire/command.rb

@@ -0,0 +1,25 @@
+require 'ferrets_on_fire/dsl'
+
+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
+    @default = default
+
+    define_singleton_method(:dispatch, block)
+    dispatch
+  end
+
+  public def action(&block)
+    @action_block = block
+  end
+
+  public def run
+    yield @block
+  end
+end

data/lib/ferrets_on_fire/dsl/declaration.rb

@@ -0,0 +1,44 @@
+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
+
+
+  public def description(desc)
+    @desc = desc
+  end
+  alias_method :desc, :description
+
+
+  public def option(name, short, param_name: 'PARAM', default: nil, desc: '')
+    @options ||= []
+    @options << Option.new(name, param_name, short, default, desc)
+  end
+  alias_method :opt, :option
+
+
+  public def switch(name, short, default: false, desc: '')
+    @switches ||= []
+    @switches << Switch.new(name, short, default, desc)
+  end
+
+
+  public def argument(name, desc: '', default: nil)
+    @arguments ||= []
+    @arguments << Argument.new(name, desc, default)
+  end
+  alias_method :arg, :argument
+
+
+  public def command(name, desc: '', default: false, &block)
+    @commands ||= []
+    @commands << Command.new(name, desc, default, &block)
+  end
+  alias_method :cmd, :command
+end

data/lib/ferrets_on_fire/dsl/git.rb

@@ -0,0 +1,25 @@
+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

data/lib/ferrets_on_fire/dsl/logger.rb

@@ -0,0 +1,117 @@
+require 'colorize'
+require 'benchmark'
+
+module FerretsOnFire::DSL::Logger
+  COLORS = {
+      info: :white,
+      warn: :yellow,
+      error: :red,
+      success: :green,
+      question: :magenta,
+      action: :light_blue
+  }.freeze
+
+  FANCY_PREFIXES = {
+      info: 'ℹ️️ ',
+      warn: '⚠️ ',
+      error: '‼️️ ',
+      success: '✨ ',
+      question: '❓ ',
+      action: '⚙️ '
+  }.freeze
+
+  DEFAULT_PREFIXES = {
+      info: '[i]',
+      warn: '[!]',
+      error: '[X]',
+      success: '[✔]',
+      question: '[?]',
+      action: '[$]'
+  }.freeze
+
+  SUFFIXES = {
+      info: '',
+      warn: '',
+      error: '',
+      success: '',
+      question: ' >',
+      action: ''
+  }.freeze
+
+  # Outputs a info message
+  # @param [String] msg The message
+  public def info(msg)
+    puts log(msg, :info)
+  end
+
+  # Outputs a warning message
+  # @param [String] msg The message
+  public def warn(msg)
+    puts log(msg, :warn)
+  end
+
+
+  # Outputs a error message
+  # @param [String] msg The message
+  public def error(msg)
+    puts log(msg, :error)
+  end
+
+
+
+  # Outputs a success message
+  # @param [String] msg The message
+  public def success(msg)
+    puts log(msg, :success)
+  end
+
+
+  # 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
+  end
+
+
+  public def linebreak
+    puts
+  end
+
+
+  public def crash(msg, output, command: nil, exit_on_failure: true)
+    error msg
+    puts
+    puts ' ============='
+    puts "COMMAND: #{command}" unless command.nil?
+    puts output
+    puts ' ============='
+    puts
+    exit 1 if exit_on_failure
+  end
+
+  # Logs that an action will happen. You have to call action_end after that
+  # @param [String] msg Message to display
+  public def action(msg, &block)
+    print log(msg, :action, '  ...  ')
+    cmd_output = ''
+    bm = ::Benchmark.measure { cmd_output = yield }
+    time = '%.2f' % bm.real.round(2)
+    info = "#{time.rjust(6)}s"
+    puts "\r#{log(msg, :success, info)}"
+
+    [cmd_output, $?.to_i]
+  end
+
+
+  private def log(msg, type, info = '')
+    prefix = (RUBY_PLATFORM.include?('darwin') && $stdout.tty? ? FANCY_PREFIXES : DEFAULT_PREFIXES)[type]
+    suffix = SUFFIXES[type]
+    color = COLORS[type]
+
+    info = info.empty? ? '' : "[#{info}] "
+
+    "#{prefix} #{info}#{msg}#{suffix}".send(color)
+  end
+end

data/lib/ferrets_on_fire/dsl/shell.rb

@@ -0,0 +1,60 @@
+module FerretsOnFire::DSL::Shell
+  # Runs a shell command. Stderr is redirected to Stdout
+  # @param [String]  cmd              Command to run
+  # @param [String]  dir              Directory to run the command in
+  # @param [Boolean] exit_on_failure  Optional (default: true). If true, the script will exited if the command fails
+  # @param [Boolean] quiet            Optional (default: true). If true, the command is not printed
+  # @param [Boolean] return_exit_code Optional (default: false). If true, the exit code is returned instead of
+  #                                   the output
+  # @param [String]  as               Optional. Label for the action output (instead of the command)
+  # @param [Boolean] bundler          Optional. Run with `bundle exec`?
+  # @param [Symbol]  rails_env        Optional. Set RAILS_ENV.
+  # @return [String] Stdout or exit code
+  public def run(cmd, dir: nil, exit_on_failure: true, quiet: false, return_exit_code: false, as: nil, bundler: false,
+                 rails_env: nil)
+
+    # Build complete command
+    cmd = build_command(cmd, dir, rails_env, bundler)
+
+    # Run the command and print the output if wished
+    output, status = exec(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
+    end
+
+    return_exit_code ? status : output
+  end
+
+
+  # Executes a shell command in the specified dir. Includes benchmarking and debug output.
+  # @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)
+    label ||= cmd
+
+    # Run the command
+    if quiet
+      cmd_output = `#{cmd} 2>&1`
+      status = $?.to_i
+    else
+      cmd_output, status = action(label) { `#{cmd} 2>&1` }
+    end
+
+    # Return exit code and output
+    [cmd_output, status]
+  end
+
+
+  def build_command(cmd, dir, rails_env, bundler)
+    result = ''
+    result += "cd #{dir} && " unless dir.nil?
+    result += "RAILS_ENV=#{rails_env} " unless rails_env.nil?
+    result += 'bundle exec ' if bundler
+
+    result + cmd
+  end
+end

data/lib/ferrets_on_fire/dsl.rb

@@ -0,0 +1,15 @@
+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'
+
+  include FerretsOnFire::DSL::Declaration
+  include FerretsOnFire::DSL::Shell
+  include FerretsOnFire::DSL::Logger
+  include FerretsOnFire::DSL::Git
+
+  public def get(name)
+    @options[name.to_sym] || @global_options[name.to_sym]
+  end
+end

data/lib/ferrets_on_fire/gli_wrapper.rb

@@ -0,0 +1,51 @@
+require 'gli'
+
+class FerretsOnFire::GliWrapper
+  include GLI::App
+
+  public def initialize(desc, commands, options, switches, arguments)
+    @_desc = desc
+    @_commands  = commands || []
+    @_options   = options || []
+    @_switches  = switches || []
+    @_arguments = arguments || []
+
+    _setup_basics
+    _setup_switches
+    _setup_options
+    _setup_commands
+  end
+
+  private def _setup_basics
+    program_desc @_desc
+  end
+
+  private def _setup_switches
+    @_switches.each do |s|
+      switch [s.short, s.name], default_value: s.default, desc: s.desc
+    end
+  end
+
+  private def _setup_options
+    @_options.each do |opt|
+      flag [opt.short, opt.name], arg_name: opt.param_name, default_value: opt.default,
+           desc: opt.desc, required: !opt.default.nil?
+    end
+  end
+
+  private def _setup_commands
+    @_commands.each do |cmd|
+      desc cmd.desc
+      command cmd.name do |api|
+        api.action do |global_options, options, args|
+          cmd.global_options = global_options
+          cmd.options = options
+          cmd.args = args
+          cmd.action_block.call
+        end
+      end
+
+      default_command(cmd.name) if cmd.default
+    end
+  end
+end

data/lib/ferrets_on_fire/option.rb

@@ -0,0 +1,11 @@
+class FerretsOnFire::Option
+  attr_reader :name, :short, :param_name, :default, :desc
+
+  public def initialize(name, short, param_name, default, desc)
+    @name = name.to_sym
+    @short = short.to_sym
+    @param_name = param_name
+    @default = default
+    @desc = desc
+  end
+end

data/lib/ferrets_on_fire/switch.rb

@@ -0,0 +1,10 @@
+class FerretsOnFire::Switch
+  attr_reader :name, :short, :default, :desc
+
+  public def initialize(name, short, default, desc)
+    @name = name.to_sym
+    @short = short.to_sym
+    @default = default
+    @desc = desc
+  end
+end

data/lib/ferrets_on_fire/version.rb

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

data/lib/ferrets_on_fire.rb

@@ -0,0 +1,15 @@
+module FerretsOnFire
+  require 'ferrets_on_fire/dsl'
+  include FerretsOnFire::DSL
+
+  public def execute
+    @gli = setup_gli
+    @gli.run(ARGV)
+    exit
+  end
+
+
+  public def setup_gli
+    GliWrapper.new(@desc, @commands, @options, @switches, @arguments)
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ferrets_on_fire
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- phortx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: micon
+  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.1'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+description: Supercharge your CLI tools. This gem helps you to write powerful CLI
+  tools without caring about the clutter
+email:
+- benny@itws.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/_.rb
+- lib/ferrets_on_fire.rb
+- 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/gli_wrapper.rb
+- lib/ferrets_on_fire/option.rb
+- lib/ferrets_on_fire/switch.rb
+- lib/ferrets_on_fire/version.rb
+homepage: https://github.com/phortx/ferrets-on-fire
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Supercharge your CLI
+test_files: []