rake_script 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa2e617b398ab4bc774b5f411ebfc81fee8116ffb04f0c18d9e5b7b0ac0bd4b2
+  data.tar.gz: 34879e6fc7b6025cc95b512627d4cdb39da85aff70ee9eaeeaa6276e42befc25
+SHA512:
+  metadata.gz: 9dc81afecb3c9480da8733b167305da5804cfd9d9572a857bda00142c819a01fe2ce1fcaf2a14ebf2f550622e90ee3259a8868bc5ae459a063dfe44cc86cf6dd
+  data.tar.gz: a1547b8dc64dae71194c8bd50da819f0205cbd9d0b35173ed634985afe11dbf83644178455b4505fd4a22a4bb438f15d0d300175318108e7ef75cdae4db72a5c

data/.gitignore

@@ -0,0 +1,12 @@
+### Ruby template
+pkg/*.gem
+Gemfile.lock
+
+# Ignore rvm files
+.ruby-version
+.ruby-gemset
+.rvmrc
+
+# Ignore Byebug command history file.
+.byebug_history
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rake_script.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Denis Talakevich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# RakeScript
+
+RakeScript is a scripts helper for rake tasks that allows easy managing file system and shell commands.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake_script', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake_script
+
+## Usage
+
+add rake file `something.rake` to your project with following code 
+
+```ruby
+require 'rake_script'
+
+namespace :something do
+  include RakeScript::RakeMethods
+  
+  desc 'Task that do something useful'
+  task :some_task do
+    with_puts_benchmark('Some task') do
+      cmd 'foo --bar', env: { BAZ: 'boo' }
+      abort('fail') unless folder_exist?('/path/to/created/folder')
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/senid231/rake_script.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+task default: :test

data/lib/rake_script.rb

@@ -0,0 +1,9 @@
+require 'rake_script/version'
+require 'rake_script/file_system'
+require 'rake_script/logging'
+require 'rake_script/shell'
+require 'rake_script/rake_methods'
+
+module RakeScript
+  #
+end

data/lib/rake_script/file_system.rb

@@ -0,0 +1,12 @@
+module RakeScript
+  module FileSystem
+    # RakeScript::FileSystem helper allows easy file system manipulations.
+
+    # Check if folder exists.
+    # @param path [String] folder path.
+    # @return [TruClass,FalseClass] boolean
+    def folder_exist?(path)
+      File.directory?(path)
+    end
+  end
+end

data/lib/rake_script/logging.rb

@@ -0,0 +1,81 @@
+module RakeScript
+  module Logging
+    # RakeScript::Logging helper allows to print useful and colorized output.
+    # @see https://misc.flogisoft.com/bash/tip_colors_and_formatting
+
+    PROMPT_STYLES = {
+        normal: 0,
+        bold: 1,
+        dim: 2,
+        underlined: 4,
+        blink: 5,
+        inverted: 7,
+        hidden: 8
+    }
+
+    PROMPT_COLORS = {
+        default: 39,
+        black: 30,
+        red: 31,
+        green: 32,
+        yellow: 33,
+        blue: 34,
+        magenta: 35,
+        cyan: 36,
+        light_grey: 37,
+        dark_grey: 90,
+        light_red: 91,
+        light_green: 92,
+        light_yellow: 93,
+        light_blue: 94,
+        light_magenta: 95,
+        light_cyan: 96,
+        white: 97
+    }
+
+    RESET_PROMPT = "\e[0m".freeze
+
+    def format_text(text, color: :default, background: :default, style: :normal)
+      fg = PROMPT_COLORS.fetch(color)
+      bg = PROMPT_COLORS.fetch(background) + 10
+      fmt = PROMPT_STYLES.fetch(style)
+      format = "\e[#{fmt};#{fg};#{bg}m"
+      "#{format}#{text}#{RESET_PROMPT}"
+    end
+
+    def puts_colored(*lines)
+      options = lines.pop
+      raise ArgumentError, 'last argument must be options hash'.freeze unless options.is_a?(Hash)
+      raise ArgumentError, 'provide at least one line'.freeze if lines.empty?
+
+      formatted_lines = lines.map { |line| format_text(line, options) }
+      puts(*formatted_lines)
+    end
+
+    def puts_time(prefix: nil, color: :yellow, style: :bold)
+      time = Time.now.utc.strftime('%F %T %Z'.freeze)
+      puts_colored("#{prefix}[#{time}]", color: color, style: style)
+    end
+
+    def puts_info(text, color: :blue, style: :bold)
+      puts_colored(">>> #{text}", color: color, style: style)
+    end
+
+    def with_puts_benchmark(title, show_time: true)
+      puts_info title
+      puts_time(prefix: "[#{title} begin]") if show_time
+      time = Time.now.to_i
+      begin
+        yield
+        took = Time.now.to_i - time
+        puts_time(prefix: "[#{title} completed]") if show_time
+        puts_colored("[#{title}] took #{took} seconds.", color: :yellow, style: :bold)
+      rescue StandardError => e
+        took = Time.now.to_i - time
+        puts_time(prefix: "[#{title} failed]") if show_time
+        puts_colored("[#{title}] failed after #{took} seconds.", color: :yellow, style: :bold)
+        raise e
+      end
+    end
+  end
+end

data/lib/rake_script/rake_methods.rb

@@ -0,0 +1,13 @@
+require 'rake_script/logging'
+require 'rake_script/shell'
+require 'rake_script/file_system'
+
+module RakeScript
+  module RakeMethods
+    # RakeScript::RakeMethods aggregate al helper modules from this gem to single mixin.
+
+    include RakeScript::Logging
+    include RakeScript::Shell
+    include RakeScript::FileSystem
+  end
+end

data/lib/rake_script/shell.rb

@@ -0,0 +1,84 @@
+require 'open3'
+
+module RakeScript
+  module Shell
+    # RakeScript::Shell helper allows easy shell commands execution.
+
+    # Wrapper around #execute which raise RuntimeError when command was exited unsuccessfully.
+    # Prefer to use this method unless you allow some command to fail.
+    # @param command [String] shell command.
+    # @param arguments [Array<String, Hash>] command arguments with optional last hash.
+    def cmd(command, *arguments)
+      result = execute(command, *arguments)
+      if result[:code] != 0
+        raise RuntimeError, "command #{result[:command].inspect} failed with code: #{result[:code]}"
+      end
+    end
+
+    # Executes shell command and stream it's output.
+    # @param command [String] shell command.
+    # @param arguments [Array<String, Hash>] command arguments with optional last hash,
+    #   last arguments hash keys:
+    #   :stdout [Proc<String>] each command output line will be passed to this proc (print to STDOUT by default),
+    #   :stderr [Proc<String>] each command error output line will be passed to this proc (print to STDERR by default),
+    #   :env [Hash] optional environment hash,
+    #   :debug [TruClass,FalseClass] prints command before execution (true by default),
+    #   :debug_color [Symbol] color of debug print (@see RakeScript::Formatting::PROMPT_COLORS),
+    #   :debug_style [Symbol] style of debug print (@see RakeScript::Formatting::PROMPT_STYLES).
+    # @return [Hash] hash with keys:
+    #   :code [Integer] exit code status of command,
+    #   :command [String] command line without environment.
+    def execute(command, *arguments)
+      # extracting options
+      options = arguments.last.is_a?(Hash) ? arguments.pop : {}
+
+      # extract option keys
+      stdout = options[:stdout] || proc { |raw_line| STDOUT.puts(raw_line) }
+      stderr = options[:stderr] || proc { |raw_line| STDERR.puts(raw_line) }
+      env = options[:env] || {}
+      debug = options.fetch(:debug, true)
+      debug_color = options[:debug_color] || :light_cyan
+      debug_style = options[:debug_style] || :underlined
+
+      # calculating command line
+      env_str = env.map { |k, v| "#{k}=#{v}" }.join(' ')
+      command_line = ([env_str, command] + arguments).reject(&:empty?).join(' ')
+
+      # debugging
+      if debug
+        if respond_to?(:puts_colored, true)
+          puts_colored(command_line, color: debug_color, style: debug_style)
+        else
+          puts command_line
+        end
+      end
+
+      # execution
+      status = raw_execute(command_line, stdout: stdout, stderr: stderr)
+
+      # response
+      { code: status.exitstatus, command: command_line }
+    end
+
+    # Executes shell command and stream it's output.
+    # @param command_line [String] command line to execute.
+    # @param stdout [Proc] each command output line will be passed to this proc.
+    # @param stderr [Proc] each command error output line will be passed to this proc.
+    # @return [Process::Status] status object for command.
+    def raw_execute(command_line, stdout:, stderr:)
+      Open3.popen3(command_line) do |_stdin_io, stdout_io, stderr_io, wait_thread|
+        Thread.new do
+          until (raw_line = stdout_io.gets).nil? do
+            stdout.call(raw_line)
+          end
+        end
+        Thread.new do
+          until (raw_line = stderr_io.gets).nil? do
+            stderr.call(raw_line)
+          end
+        end
+        wait_thread.value
+      end
+    end
+  end
+end

data/lib/rake_script/version.rb

@@ -0,0 +1,3 @@
+module RakeScript
+  VERSION = '0.1.0'.freeze
+end

data/rake_script.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake_script/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rake_script'
+  spec.version = RakeScript::VERSION
+  spec.authors = ['Denis Talakevich']
+  spec.email = 'senid231@gmail.com'
+  spec.date = '2019-11-29'
+
+  spec.summary = 'Rake scripts helper for file system and shell commands.'
+  spec.description = "Rake scripts helper for file system and shell commands."
+  spec.homepage = 'https://github.com/senid231/rake_script'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.gitignore|test)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rake'
+
+  spec.add_development_dependency 'minitest', '~> 5.13'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rake_script
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+description: Rake scripts helper for file system and shell commands.
+email: senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rake_script.rb
+- lib/rake_script/file_system.rb
+- lib/rake_script/logging.rb
+- lib/rake_script/rake_methods.rb
+- lib/rake_script/shell.rb
+- lib/rake_script/version.rb
+- rake_script.gemspec
+homepage: https://github.com/senid231/rake_script
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Rake scripts helper for file system and shell commands.
+test_files: []