script 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3939afb4f888f22488699801765c07eda67ecf7
-  data.tar.gz: ee9c375907906fee314aa7168f46e3018647f7ef
+  metadata.gz: 2dfd5efe6e5e7710e5d007dc9d46719bd6bc0edf
+  data.tar.gz: 0788cf8cc9e1d05310cb6e081b75124ade1889ed
 SHA512:
-  metadata.gz: b47b155a3b3c62af4e71393364dfcb059822e198f0f0d16100409a6ba4dfc4d858596dc0417e15514ab0388082bb863382819518d2258e7ad165002fde4bfa7b
-  data.tar.gz: e4f428b6477e984e4e8552aeedb41b1f7e0feee7cfef34d703999d2ccc32c318d9c240f8cafb783d16e0ee1845ecf3a06fc3204094014f83d5525f0cd636430b
+  metadata.gz: 561c94cffb4cd771696370f588219e8a33c3e2eb52adf093eb9f63610237de733c258ba524addd3bb1e51e73571a28e6d1669a49a91d92ab96cc3bc7ed2bf1f9
+  data.tar.gz: 0b1632aa572f972228dd530f705e2a11ae86842d25f7386724ee82e9d39ffb06aad86c2a847dcf89cb37074d69f59facda65d4ceadeb7e693f5af70b2234fcf0

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    script (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.6)
+    diff-lcs (1.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  script!
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -1,43 +1,91 @@
-# Script
+# Script<img width="40" align="left" src="https://cdn.codementor.io/assets/topic/category_header/ruby-on-rails-bc9ab2af8d92eb4e7eb3211d548a09ad.png"> 
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/script`. To experiment with that code, run `bin/console` for an interactive prompt.
+The Script is everything you need to make the most of Ruby as fabulous scripting language.
 
-TODO: Delete this and the text above, and describe your gem
+   * [Script](#script)
+      * [Setup](#setup)
+      * [Usage](#usage)
+      * [Contributing](#contributing)
+      * [License](#license)
+      * [Code of Conduct](#code-of-conduct)
 
-## Installation
+## Setup
 
-Add this line to your application's Gemfile:
+Install gem:
 
-```ruby
-gem 'script'
+```
+gem install script
 ```
 
-And then execute:
+And require it in your script file:
 
-    $ bundle
+```
+require 'script'
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install script
+### Steps
 
-## Usage
+Reason about the step as a logical group of commands. Lets take for instance, the deploy script which builds a docker image, pushes it to Dockerhub and eventually creates the deployment on Kubernetes.
+
+```ruby
+#!/usr/local/bin/ruby
+
+require "script"
+
+deploy = Script.new
+
+deploy.step("Setup tools") do
+
+  `sudo apt-get install -y google-cloud-sdk kubectl`
+  `gcloud auth activate-service-account $GCLOUD_SERVICE_ACCOUNT_NAME`
+  `gcloud config set project dummy-project`
+  `gcloud container clusters get-credentials default --zone us-east`
+  
+end
+
+deploy.step("Deploy docker image") do
 
-TODO: Write usage instructions here
+  `docker pull dummy`
+  `docker build --cache-from dummy -t dummy`
+  `docker build -t scripter/script .`
+  `docker push dummy`
+  
+end
 
-## Development
+deploy.step("Deploy to Kubernetes cluster") do
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  `kubectl apply -f k8s.yml --record`
+  
+end
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Finally, run the script
+
+deploy.run
+```
+
+The steps are run in order in which they are registered.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/script. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```
+# Clone the repo
+git clone git@github.com:bmarkons/script.git
 
-## License
+# Install
+bundle install
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Run tests
+bundle exec rspec
+```
+
+Pull requests are always welcome. In case you notice any bug or simply want to propose an improvement, please feel free to open an issue.
 
 ## Code of Conduct
 
-Everyone interacting in the Script project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/script/blob/master/CODE_OF_CONDUCT.md).
+Please [be nice](https://github.com/bmarkons/script/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/script.rb

@@ -1,5 +1,21 @@
 require "script/version"
+require "script/engine"
+require "script/step"
 
-module Script
-  # Your code goes here...
+class Script
+  def initialize
+    @engine = Script::Engine.new
+  end
+
+  def engine
+    @engine
+  end
+
+  def step(headline, &block)
+    @engine.register_step(headline, block)
+  end
+
+  def run
+    @engine.run
+  end
 end

data/lib/script/engine.rb

@@ -0,0 +1,19 @@
+class Script::Engine
+  def initialize
+    @steps = []
+  end
+
+  def steps
+    @steps
+  end
+
+  def register_step(headline, block)
+    @steps << Script::Step.new(headline, block)
+  end
+
+  def run
+    @steps.each do |step|
+      step.run
+    end
+  end
+end

data/lib/script/step.rb

@@ -0,0 +1,10 @@
+class Script::Step
+  def initialize(headline, block)
+    @headline = headline
+    @block = block
+  end
+
+  def run
+    @block.call
+  end
+end

data/lib/script/version.rb

@@ -1,3 +1,3 @@
-module Script
-  VERSION = "0.0.1"
+class Script
+  VERSION = "0.0.2"
 end

data/script.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
 end

data/scripts/gh-md-toc

@@ -0,0 +1,189 @@
+#!/usr/bin/env bash
+
+#
+# Steps:
+#
+#  1. Download corresponding html file for some README.md:
+#       curl -s $1
+#
+#  2. Discard rows where no substring 'user-content-' (github's markup):
+#       awk '/user-content-/ { ...
+#
+#  3.1 Get last number in each row like ' ... </span></a>sitemap.js</h1'.
+#      It's a level of the current header:
+#       substr($0, length($0), 1)
+#
+#  3.2 Get level from 3.1 and insert corresponding number of spaces before '*':
+#       sprintf("%*s", substr($0, length($0), 1)*3, " ")
+#
+#  4. Find head's text and insert it inside "* [ ... ]":
+#       substr($0, match($0, /a>.*<\/h/)+2, RLENGTH-5)
+#
+#  5. Find anchor and insert it inside "(...)":
+#       substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8)
+#
+
+gh_toc_version="0.4.9"
+
+gh_user_agent="gh-md-toc v$gh_toc_version"
+
+#
+# Download rendered into html README.md by its url.
+#
+#
+gh_toc_load() {
+    local gh_url=$1
+
+    if type curl &>/dev/null; then
+        curl --user-agent "$gh_user_agent" -s "$gh_url"
+    elif type wget &>/dev/null; then
+        wget --user-agent="$gh_user_agent" -qO- "$gh_url"
+    else
+        echo "Please, install 'curl' or 'wget' and try again."
+        exit 1
+    fi
+}
+
+#
+# Converts local md file into html by GitHub
+#
+# ➥ curl -X POST --data '{"text": "Hello world github/linguist#1 **cool**, and #1!"}' https://api.github.com/markdown
+# <p>Hello world github/linguist#1 <strong>cool</strong>, and #1!</p>'"
+gh_toc_md2html() {
+    local gh_file_md=$1
+    URL=https://api.github.com/markdown/raw
+    TOKEN="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt"
+    if [ -f "$TOKEN" ]; then
+        URL="$URL?access_token=$(cat $TOKEN)"
+    fi
+    curl -s --user-agent "$gh_user_agent" \
+        --data-binary @"$gh_file_md" -H "Content-Type:text/plain" \
+        $URL
+}
+
+#
+# Is passed string url
+#
+gh_is_url() {
+    case $1 in
+        https* | http*)
+            echo "yes";;
+        *)
+            echo "no";;
+    esac
+}
+
+#
+# TOC generator
+#
+gh_toc(){
+    local gh_src=$1
+    local gh_src_copy=$1
+    local gh_ttl_docs=$2
+
+    if [ "$gh_src" = "" ]; then
+        echo "Please, enter URL or local path for a README.md"
+        exit 1
+    fi
+
+
+    # Show "TOC" string only if working with one document
+    if [ "$gh_ttl_docs" = "1" ]; then
+
+        echo "Table of Contents"
+        echo "================="
+        echo ""
+        gh_src_copy=""
+
+    fi
+
+    if [ "$(gh_is_url "$gh_src")" == "yes" ]; then
+        gh_toc_load "$gh_src" | gh_toc_grab "$gh_src_copy"
+    else
+        gh_toc_md2html "$gh_src" | gh_toc_grab "$gh_src_copy"
+    fi
+}
+
+#
+# Grabber of the TOC from rendered html
+#
+# $1 — a source url of document.
+# It's need if TOC is generated for multiple documents.
+#
+gh_toc_grab() {
+	# if closed <h[1-6]> is on the new line, then move it on the prev line
+	# for example:
+	# 	was: The command <code>foo1</code>
+	# 		 </h1>
+	# 	became: The command <code>foo1</code></h1>
+    sed -e ':a' -e 'N' -e '$!ba' -e 's/\n<\/h/<\/h/g' |
+    # find strings that corresponds to template
+    grep -E -o '<a.*id="user-content-[^"]*".*</h[1-6]' |
+    # remove code tags
+    sed 's/<code>//' | sed 's/<\/code>//' |
+    # now all rows are like:
+    #   <a id="user-content-..." href="..."><span ...></span></a> ... </h1
+    # format result line
+    #   * $0 — whole string
+    echo -e "$(awk -v "gh_url=$1" '{
+    print sprintf("%*s", substr($0, length($0), 1)*3, " ") "* [" substr($0, match($0, /a>.*<\/h/)+2, RLENGTH-5)"](" gh_url substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8) ")"}' | sed 'y/+/ /; s/%/\\x/g')"
+}
+
+#
+# Returns filename only from full path or url
+#
+gh_toc_get_filename() {
+    echo "${1##*/}"
+}
+
+#
+# Options hendlers
+#
+gh_toc_app() {
+    local app_name="gh-md-toc"
+
+    if [ "$1" = '--help' ] || [ $# -eq 0 ] ; then
+        echo "GitHub TOC generator ($app_name): $gh_toc_version"
+        echo ""
+        echo "Usage:"
+        echo "  $app_name src [src]     Create TOC for a README file (url or local path)"
+        echo "  $app_name -             Create TOC for markdown from STDIN"
+        echo "  $app_name --help        Show help"
+        echo "  $app_name --version     Show version"
+        return
+    fi
+
+    if [ "$1" = '--version' ]; then
+        echo "$gh_toc_version"
+        return
+    fi
+
+    if [ "$1" = "-" ]; then
+        if [ -z "$TMPDIR" ]; then
+            TMPDIR="/tmp"
+        elif [ -n "$TMPDIR" -a ! -d "$TMPDIR" ]; then
+            mkdir -p "$TMPDIR"
+        fi
+        local gh_tmp_md
+        gh_tmp_md=$(mktemp $TMPDIR/tmp.XXXXXX)
+        while read input; do
+            echo "$input" >> "$gh_tmp_md"
+        done
+        gh_toc_md2html "$gh_tmp_md" | gh_toc_grab ""
+        return
+    fi
+
+    for md in "$@"
+    do
+        echo ""
+        gh_toc "$md" "$#"
+    done
+
+    echo ""
+    echo "Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)"
+}
+
+#
+# Entry point
+#
+gh_toc_app "$@"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: script
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - bmarkons
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: '"Gives you a hand with composing neat Ruby scripts."'
 email:
 - mamaveb@gmail.com
@@ -64,14 +78,18 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/script.rb
+- lib/script/engine.rb
+- lib/script/step.rb
 - lib/script/version.rb
 - script.gemspec
+- scripts/gh-md-toc
 homepage: https://github.com/bmarkons/script
 licenses:
 - MIT