dramaturg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e353b44eaeebb604d4445bfa5a91f8d4867d2da6
+  data.tar.gz: 3ca57c447212cd023858c8c68c7f3d40d2599ce6
+SHA512:
+  metadata.gz: fa8c32f4f351075b5c94cae0e9348849fa570a25f7cacb9b9a1e58f977f2067dd452587f971d132f07c6f4e4d1f98829f7fdab173fc1c3190a1189f9d16c3c62
+  data.tar.gz: 12895780db2b689eab7c06c5777c894b75cd5d951c47046aaaf4fbd5b29a17bd847c5d1fe09eecbc6b75d7246450014d3368d1603825ce109941828437688361

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dramaturg.gemspec
+gem 'pry'
+gem 'pry-byebug'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Donald Guy
+
+MIT License
+
+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,20 @@
+# Dramaturg: Optionally-interactive shell scripts
+
+In theater, a dramaturg (or "literary manager") is a behind-the-scenes individual who researches and advises in the development of dramatic scripts and productions.
+
+This library hopes to allow you to fulfill a similar role, but for shell scripts and cli workflows.
+
+In particular, in the spirit of devops and "learn by doing", it seeks to empower those in-the-know (e.g. ops-types or senior developers) to deliver a workflow to those-less-so (e.g. junior developers) that can be executed outright—or easily departed from as desired & appropriate for the user's level of familiarity with the tools & proccess.
+
+
+## Usage
+
+See [`./examples`](https://github.com/donaldguy/dramaturg/tree/master/examples) for example code
+
+## Contributing
+
+1. Fork it ( https://github.com/donaldguy/dramaturg/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/dramaturg.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dramaturg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dramaturg"
+  spec.version       = Dramaturg::VERSION
+  spec.authors       = ["Donald Guy"]
+  spec.email         = ["fawkes@mit.edu"]
+  spec.summary       = %q{A framework for optionally-interactive shell scripts}
+  spec.description   = %q{In theater, a dramaturg (or "literary manager") is a behind-the-scenes individual who
+researches and advises in the development of dramatic scripts and productions.
+
+This library hopes to allow you to fulfill a similar role, but for shell scripts and cli workflows.
+
+In particular, in the spirit of devops and "learn by doing", it seeks to empower those in-the-know (e.g. ops-types or
+senior developers) to deliver a workflow to those-less-so (e.g. junior developers) that can be executed outright—or
+easily departed from as desired & appropriate for the user's level of familiarity with the tools & proccess.}
+  spec.homepage      = "https://github.com/donaldguy/dramaturg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "madCLIbs", '~> 0.0.4'
+  spec.add_dependency "activesupport", '~> 4'
+
+
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  #spec.add_development_dependency "rspec"
+end

data/examples/git_feature_branch.rb

@@ -0,0 +1,24 @@
+require 'dramaturg'
+
+$i = Dramaturg::Script.new({
+    #we want to run in order - without this 'new branch' will run first
+    #cause of its output is used in next command; I might make ~promises later
+    run_previous_on_declare: true
+})
+def cmd(s,&b); $i.(s,&b) ; end
+
+#there are several supported syntaxes; this varies between them for
+#demonstration purposes
+
+$i.("git status ")
+
+$i["git commit {-v}"]
+  .name("commit")
+
+git = cmd("git checkout -b {branch:master}") do
+  name 'new branch'
+  fail_ok true
+end
+
+$i.cmd("git push -u origin {#{git[:branch]}}")
+  .run #unfortunately we still need to run the last manually with :run_previous_on_declare

data/examples/just_print.rb

@@ -0,0 +1,19 @@
+require 'dramaturg'
+
+$i = Dramaturg::Script.new({
+  prompter: {
+    class: Dramaturg::Prompter::UseDefaults
+  },
+  runner: {
+    class: Dramaturg::Runner::Print
+  },
+})
+at_exit { $i.run_all() }
+
+git = cmd("git checkout -b {branch:master}")
+  .name('new branch')
+  .fail_ok(true)
+
+$i["git push -u origin {#{git[:branch]}}"]
+
+$i["echo 'all up to date'"]

data/lib/dramaturg/command/hash_like.rb

@@ -0,0 +1,42 @@
+module Dramaturg
+  class Command
+    module HashLike
+      include Enumerable
+
+      #as part of the interface allowing eager evaluation.
+      #for internal/pre- or mid-run use, use #get
+      def [](k)
+        self.run if !ran?
+
+        if ran? == :aborted
+          "???" #all bets off
+        else
+          get(k)
+        end
+      end
+
+      def get(k)
+        @values ||= {}
+        if k.is_a? Symbol
+          @values[k]
+        elsif k.respond_to? :to_str
+          k.to_str
+        end
+      end
+
+      def []=(k,v)
+        @values ||= {}
+        @values[k] = v
+      end
+
+      def <<(v)
+        @line ||= []
+        @line << v
+      end
+
+      def each &b
+        @line.each &b
+      end
+    end
+  end
+end

data/lib/dramaturg/command/opt.rb

@@ -0,0 +1,27 @@
+require 'active_support/concern'
+
+
+module Dramaturg::Command::Opt
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def opt(name, default)
+      self.send(:define_method, name, ->(arg=nil) do
+        iv_symbol = "@opt_#{name.to_s}".to_sym
+
+        if arg.nil? && !self.instance_variable_defined?(iv_symbol)
+          default_value = default.respond_to?(:call)? default.(self) : default
+          self.instance_variable_set(iv_symbol, default_value)
+        end
+
+        if arg != nil
+          arg_value = arg.respond_to?(:call)? arg.(self) : arg
+          self.instance_variable_set(iv_symbol, arg_value)
+          return self #allow chaining
+        end
+
+        self.instance_variable_get(iv_symbol)
+      end)
+    end
+  end
+end

data/lib/dramaturg/command/parser.rb

@@ -0,0 +1,34 @@
+module Dramaturg
+  class Command
+    module Parser
+      def parse!
+        tokens = tokenize(self.to_s)
+
+        tokens.each do |t|
+          case t
+          when /^\{(\w+):(.+)\}$/
+            key = $1.to_sym
+            self[key] = Value::Default.new($2)
+            self << key
+          when /^\{(.+)\}$/
+            key = $1.to_sym
+            self[key] = Value::Default.new($1)
+            self << key
+          else
+            self << Value::Fixed.new(t)
+          end
+        end
+
+        if self.allow_suffix
+          self[:__suffix] = Value::Default.new("")
+          self << :__suffix
+        end
+      end
+
+      private
+      def tokenize(s)
+        s.split /\s+/
+      end
+    end
+  end
+end

data/lib/dramaturg/command.rb

@@ -0,0 +1,40 @@
+require_relative 'command/hash_like'
+require_relative 'command/parser'
+require_relative 'command/opt'
+
+module Dramaturg
+  class Command
+    include Command::HashLike
+    include Command::Parser
+    include Command::Opt
+
+    opt :name, ->(cmd) { cmd.program_name }
+    opt :program_name, ->(cmd){cmd.to_s[/^\S+/]}
+    opt :aborted, false
+
+    opt :allow_suffix, ->(cmd){!!(cmd.to_s =~ /\s+$/)}
+    opt :capture_output, false
+    opt :fail_ok, false
+
+    attr_accessor :ran
+    alias ran? ran
+
+    def initialize(cmd_str, script)
+      @cmd_str = cmd_str
+      @script = script
+      @ran = false
+    end
+
+    def run
+      @script.execute(self)
+    end
+
+    def default(v)
+      self.get(v).default
+    end
+
+    def to_s
+      @cmd_str
+    end
+  end
+end

data/lib/dramaturg/ctrl_c_handler/skip.rb

@@ -0,0 +1,10 @@
+module Dramaturg
+  class CtrlCHandler
+    class Skip
+      def self.call(prompter, cmd)
+        puts "\nSkipping #{cmd.name}"
+        prompter.abort!
+      end
+    end
+  end
+end

data/lib/dramaturg/ctrl_c_handler/skip_or_exit.rb

@@ -0,0 +1,19 @@
+module Dramaturg
+  class CtrlCHandler
+    class SkipOrExit
+      def self.call(prompter, cmd)
+        puts "\n^C again to exit; Enter to skip '#{cmd.name}'"
+
+        require 'mad_clibs/util/iohelper'
+        key = IOHelper.read_key(false)
+
+        if key == 'ctrl-c'
+          puts "Okay, bye!"
+          exit!
+        else
+          prompter.abort!
+        end
+      end
+    end
+  end
+end

data/lib/dramaturg/ctrl_c_handler.rb

@@ -0,0 +1,8 @@
+module Dramaturg
+  class CtrlCHandler
+    extend ActiveSupport::Autoload
+
+    autoload :Skip
+    autoload :SkipOrExit
+  end
+end

data/lib/dramaturg/prompter/base.rb

@@ -0,0 +1,34 @@
+module Dramaturg
+  module Prompter
+    class Base
+      attr_reader :current_command
+
+      def initialize(script,config)
+        @script = script
+        @prompt = config[:prompt]
+        @formatters = config[:format]
+        @current_command = nil
+        @abort = false
+      end
+
+      def prompt
+        if @prompt.respond_to? :call
+          @prompt.()
+        else
+          @prompt
+        end
+      end
+
+      def call(cmd)
+        @current_command = cmd
+        _call(cmd)
+      end
+
+      def abort!
+        @abort = true
+        self.current_command.aborted(true)
+        return false
+      end
+    end
+  end
+end

data/lib/dramaturg/prompter/madCLIbs.rb

@@ -0,0 +1,57 @@
+require_relative 'base'
+require 'madCLIbs'
+
+module Dramaturg
+  module Prompter
+    class MadCLIbs < Base
+      def initialize(script,config)
+        super
+        @cli = ::MadCLIbs.new
+        @cli.interrupt_handler = ->() { config[:ctrlc].(self, self.current_command) }
+      end
+
+      def _call(cmd)
+        @current_command = cmd
+        @cli.prompt(prompt, *values_to_madclib_tokens(cmd))
+
+        return if @abort
+
+        @values.each do |key, entered|
+          cmd[key] = entered.value
+        end
+      end
+
+    private
+      def value_type_to_token_type(t)
+        @type_map ||=
+        {
+          Value::Default => ::MadCLIbs::Blanks::String,
+          Value::Fixed => Value::Fixed #i.e. ::String
+        }
+        @type_map[t]
+      end
+
+      def token_type_to_value_type(t)
+        value_type_to_token_type(t)
+        @reverse_type_map ||= Hash[@type_map.to_a.map(&:reverse)]
+        @reverse_type_map[t]
+      end
+
+      def values_to_madclib_tokens(cmd)
+        @values = {}
+
+        unfmt = cmd.map do |value|
+          if value.is_a? Symbol
+            @values[value] = @cli.string(cmd.default(value))
+          else
+            value
+          end
+        end
+
+        unfmt.map do |v|
+          @formatters[token_type_to_value_type(v.class)].(v)
+        end
+      end
+    end
+  end
+end

data/lib/dramaturg/prompter/use_defaults.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+
+module Dramaturg
+  module Prompter
+    class UseDefaults < Base
+      def initialize(script,config)
+        super
+      end
+
+      def _call(cmd)
+        print(prompt, " ", values_to_strings(cmd).join(" "), "\n")
+
+        return if @abort
+
+        @values.each do |key,value|
+          cmd[key] = cmd.get(cmd.default(key))
+        end
+      end
+
+    private
+      def values_to_strings(cmd)
+        @values = {}
+
+        unfmt = cmd.map do |value|
+          if value.is_a? Symbol
+            @values[value] = cmd.get(value)
+          else
+            value
+          end
+        end
+
+        unfmt.map do |v|
+          @formatters[v.class].(v)
+        end
+      end
+    end
+  end
+end

data/lib/dramaturg/prompter.rb

@@ -0,0 +1,6 @@
+module Dramaturg
+  module Prompter
+    autoload :MadCLIbs, 'dramaturg/prompter/madCLIbs'
+    autoload :UseDefaults, 'dramaturg/prompter/use_defaults'
+  end
+end

data/lib/dramaturg/runner/base.rb

@@ -0,0 +1,36 @@
+module Dramaturg
+  class Runner::Base
+    def initialize(script,config={})
+      @script = script
+      @last_success = true
+    end
+
+    def call(cmd)
+      if !cmd.aborted
+        line = cmd.map { |v| cmd.get(v) }.join(' ')
+
+        ok = _call(line, cmd)
+
+        cmd.ran = line
+
+        if !ok && !cmd.fail_ok
+          handle_fail(cmd)
+        end
+      else
+        cmd.ran = :aborted
+        ok = false
+      end
+
+      @last_success = ok
+    end
+
+    def last_success?
+      @last_success
+    end
+
+
+    def handle_fail(cmd)
+      raise RuntimeError, "#{cmd.ran} failed"
+    end
+  end
+end

data/lib/dramaturg/runner/print.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+
+module Dramaturg
+  class Runner::Print < Runner::Base
+    def initialize(script,config={})
+      super
+    end
+
+    def _call(line,cmd)
+      print "Would run: #{line}"
+      cmd.ran = line
+
+      puts ""
+      return true
+    end
+  end
+end

data/lib/dramaturg/runner/shell.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module Dramaturg
+  class Runner::Shell < Runner::Base
+    def initialize(script, config={})
+      super
+    end
+
+    def _call(line,cmd)
+      if cmd.capture_output
+        cmd[:output] = `#{line}`
+        ok = !cmd[:output].empty?
+      else
+        ok = system(line)
+      end
+    end
+  end
+end

data/lib/dramaturg/runner.rb

@@ -0,0 +1,8 @@
+module Dramaturg
+  module Runner
+    extend ActiveSupport::Autoload
+
+    autoload :Print
+    autoload :Shell
+  end
+end

data/lib/dramaturg/script.rb

@@ -0,0 +1,77 @@
+require 'term/ansicolor'
+
+
+module Dramaturg
+  class Script
+    include Term::ANSIColor
+
+    def initialize(config = {})
+      defaults = {
+        prompter: {
+          class: Prompter::MadCLIbs,
+          prompt: ->() {
+            if self.runner.last_success?
+              bold(green("$"))
+            else
+              bold(red("$"))
+            end
+          },
+          format: {
+            Value::Default => ->(s){ bold(cyan(s)) },
+            Value::Fixed => -> (s) { s }
+          },
+          ctrlc: CtrlCHandler::SkipOrExit
+        },
+        runner: {
+          class: Runner::Shell
+        },
+      }
+
+      @config = defaults.deep_merge(config)
+
+      @commands = []
+    end
+
+    def cmd(command_str, &opts)
+      run_all if @config[:run_previous_on_declare]
+      c = Command.new(command_str, self)
+      @commands << c
+
+      if opts
+        c.instance_eval &opts
+      end
+
+      c
+    end
+    alias call cmd
+    alias [] cmd
+
+    def prompter
+      @prompter ||= @config[:prompter][:class].new(
+        self,
+        @config[:prompter]
+      )
+    end
+
+    def runner
+      @runner ||= @config[:runner][:class].new(
+        self,
+        @config[:runner]
+      )
+    end
+
+    def execute(cmd)
+      cmd.parse!
+      prompter.(cmd)
+      runner.(cmd)
+    end
+
+    def run_all
+      @commands.each do |cmd|
+        unless cmd.ran?
+          execute(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/dramaturg/value/default.rb

@@ -0,0 +1,11 @@
+module Dramaturg
+  class Value::Default
+    def initialize(val)
+      @val = val
+    end
+
+    def default
+      @val
+    end
+  end
+end

data/lib/dramaturg/value/fixed.rb

@@ -0,0 +1,4 @@
+module Dramaturg
+  class Value::Fixed < String
+  end
+end

data/lib/dramaturg/value.rb

@@ -0,0 +1,8 @@
+module Dramaturg
+  module Value
+    extend ActiveSupport::Autoload
+
+    autoload :Fixed
+    autoload :Default
+  end
+end

data/lib/dramaturg/version.rb

@@ -0,0 +1,3 @@
+module Dramaturg
+  VERSION = "0.0.1"
+end

data/lib/dramaturg.rb

@@ -0,0 +1,13 @@
+require 'dramaturg/version'
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext/hash/deep_merge'
+
+module Dramaturg
+  extend ActiveSupport::Autoload
+    autoload :Script
+    autoload :Command
+    autoload :Value
+    autoload :Prompter
+    autoload :Runner
+    autoload :CtrlCHandler
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: dramaturg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Donald Guy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: madCLIbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: |-
+  In theater, a dramaturg (or "literary manager") is a behind-the-scenes individual who
+  researches and advises in the development of dramatic scripts and productions.
+
+  This library hopes to allow you to fulfill a similar role, but for shell scripts and cli workflows.
+
+  In particular, in the spirit of devops and "learn by doing", it seeks to empower those in-the-know (e.g. ops-types or
+  senior developers) to deliver a workflow to those-less-so (e.g. junior developers) that can be executed outright—or
+  easily departed from as desired & appropriate for the user's level of familiarity with the tools & proccess.
+email:
+- fawkes@mit.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dramaturg.gemspec
+- examples/git_feature_branch.rb
+- examples/just_print.rb
+- lib/dramaturg.rb
+- lib/dramaturg/command.rb
+- lib/dramaturg/command/hash_like.rb
+- lib/dramaturg/command/opt.rb
+- lib/dramaturg/command/parser.rb
+- lib/dramaturg/ctrl_c_handler.rb
+- lib/dramaturg/ctrl_c_handler/skip.rb
+- lib/dramaturg/ctrl_c_handler/skip_or_exit.rb
+- lib/dramaturg/prompter.rb
+- lib/dramaturg/prompter/base.rb
+- lib/dramaturg/prompter/madCLIbs.rb
+- lib/dramaturg/prompter/use_defaults.rb
+- lib/dramaturg/runner.rb
+- lib/dramaturg/runner/base.rb
+- lib/dramaturg/runner/print.rb
+- lib/dramaturg/runner/shell.rb
+- lib/dramaturg/script.rb
+- lib/dramaturg/value.rb
+- lib/dramaturg/value/default.rb
+- lib/dramaturg/value/fixed.rb
+- lib/dramaturg/version.rb
+homepage: https://github.com/donaldguy/dramaturg
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A framework for optionally-interactive shell scripts
+test_files: []