jump-starter 1.1.17 → 1.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9706f9216827451fb3e6506ba998c7a5c234bb7423074c078d533fa9e35aff7
-  data.tar.gz: 006744101b01ed63fc394d5ae554e3fe503393fffb55c02c66d426032a1e5dc3
+  metadata.gz: dc8d7d5e98f4cea4e608e6693b79c0f42d4e67c65c7624ad2278002a8d69c150
+  data.tar.gz: 2541ab72bdd98f7e9470db1ad80be08daed7a2f977718b235a4fec17b00372c7
 SHA512:
-  metadata.gz: c0a6fc532b81d6cbaa6f41a168703b1c779641fbf59a590cbc1737f71de076f18f9292d00b7248acdd1cb9d204b1694076b32a0943806f67ac5131b0502509aa
-  data.tar.gz: ddbf25c072b29ebf4dd6d279463642ba8e30c11db59b91632d1b8d8a5c7e8cb80cf649f66648dfe878fcafdd868d8b5159992adf138e239f8aeb0b04813cadc0
+  metadata.gz: 85871148c91c0c29b7a81aa4051af822e594dc387f0c738d25028f2bba59dddd2175b23337c48463abccf8a694f9f40e088a1c059e5067545639f5a879ab3169
+  data.tar.gz: 0fefffadf4bbee4407331625afabc5052d1bb9e7d2e047e910dcd1e17fc0a1b1377d261d8a75e4d114669a3f953534ab7e0163eeb44417cecdb8a7d1b9f3cf28

data/Gemfile.lock

@@ -1,18 +1,25 @@
 PATH
   remote: .
   specs:
-    jump-starter (1.1.16)
+    jump-starter (1.1.18)
       colorize
       commander
+      terminal-table
+      xcodeproj
 
 GEM
   remote: https://rubygems.org/
   specs:
+    CFPropertyList (3.0.0)
+    atomos (0.1.3)
+    claide (1.0.2)
+    colored2 (3.1.2)
     colorize (0.8.1)
     commander (4.4.6)
       highline (~> 1.7.2)
     diff-lcs (1.3)
     highline (1.7.10)
+    nanaimo (0.2.6)
     rake (12.3.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -27,6 +34,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.4.0)
+    xcodeproj (1.7.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.2.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,36 @@
-# Jumpstarter
+
+# Welcome! 👋 to Jumpstarter ⚡️
+
+
+## What is Jumpstarter?
+
+We're glad you asked! 
+
+Barrier to entry is always something we as open source developers are trying to lower. Afterall open source projects are as powerful as its maintainers so wouldn't you want to make becoming a contributor/maintainer easier?
+
+From personal experience i've noticed that as hard as a developer tries to write a good contributing guide, getting setup can be a drag. You have to read and re-read each instruction, download additional dependencies and not to mention these instructions are different depending on your OS. Instead of wasting time writing up a guide and then answering and helping people afterwards we have decided to offer the ability to write up a Start file. 
+
+A start file makes getting setup a breeze for the contributor because they have to do... well... nothing. WHAT?!?!. Here's an example:
+
+```bash
+git fork Huddie/Grade-Notifier
+git clone Grade-Notifier
+cd Grade-Notifier
+bash run ./Depfiles/depinstall.sh
+```
+
+So what does this do? 
+
+1. Forks the repository 
+2. Clones it
+3. Installs all the dependencies
+
+This is a fairly simply Start file.
+
+Notice how the creator of the Start file didn't have to write instructions for a specific OS. Notice how you can make use of powerful instructions like `git fork`. 
+
+We hope that Start files will lower the barrier to entry so developers can focus on developing.
+
 
 ## License
 

data/jumpstarter.gemspec

@@ -11,6 +11,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'commander'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'xcodeproj'
+  spec.add_dependency 'terminal-table'
+
 
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/lib/jumpstarter_core/bash.rb

@@ -0,0 +1,37 @@
+module Jumpstarter
+    class Bash
+        #******************#
+        #   Instructions   #
+        #******************#
+        class Run < I_Instructions
+            def run!()
+                system(@cmd)
+                return true
+            end
+        end
+
+        class CD < I_Instructions
+            def run!()
+                Dir.chdir "#{@path}"
+                return true
+            end
+        end
+        class << self
+            #*****************#
+            #  Class Methods  #
+            #*****************#
+            def self.installed!()
+                # Run version
+                version = CommandRunner.execute(
+                    command: Commands::Pip::Version, 
+                    error: nil
+                )
+                return (/pip (\d+)(.\d+)?(.\d+)?/ =~ version) 
+            end
+                    
+            def required_imports
+                ['instructions', 'writer.rb', 'commandRunner.rb']
+            end
+        end
+    end
+end

data/lib/jumpstarter_core/commandRunner.rb

@@ -1,19 +1,19 @@
 class StandardError
     def exit_status
-      return -1
+    return -1
     end
 end
-  
+
 module Jumpstarter
     class JumpstarterPtyError < StandardError
-      attr_reader :exit_status
-      def initialize(e, exit_status)
+    attr_reader :exit_status
+    def initialize(e, exit_status)
         super(e)
         set_backtrace(e.backtrace) if e
         @exit_status = exit_status
-      end
     end
-  
+    end
+
     class JumpstarterPty
         def self.spawn(command)
             require 'pty'
@@ -35,7 +35,7 @@ module Jumpstarter
         require 'open3'
         Open3.popen2e(command) do |command_stdin, command_stdout, p| # note the inversion
             yield(command_stdout, command_stdin, p.value.pid)
-  
+
             command_stdin.close
             command_stdout.close
             p.value.exitstatus

data/lib/jumpstarter_core/commands.rb

@@ -1,5 +1,3 @@
-require_relative './OS'
-
 module Jumpstarter
     class Commands
         class Pip
@@ -155,6 +153,5 @@ module Jumpstarter
                 end
             end
         end
-
     end
 end

data/lib/jumpstarter_core/git.rb

@@ -0,0 +1,91 @@
+module Jumpstarter
+    class Git
+        #******************#
+        #   Instructions   #
+        #******************#
+        class Install < Jumpstarter::I_Instructions
+            def run!()
+                # install pip
+                CommandRunner.execute(
+                        command: Commands::Git::Install,
+                        error: nil
+                )
+                return true
+            end
+        end
+
+        class Fork < I_Instructions
+            def run!()
+                # Check if git is installed
+                if not Jumpstarter::Git.installed!
+                    # Install git
+                    CommandRunner.execute(
+                        command: Commands::Git::Install,
+                        error: nil
+                    )
+                end
+                # clone
+                CommandRunner.execute(
+                    command: "curl -u #{@username}:#{@password} https://api.github.com/repos/#{@remote}/forks -d ''",
+                    error: nil
+                )
+                return true
+            end
+        end
+
+        class Pull < I_Instructions
+            def run!()
+                # Check if git is installed
+                if not Jumpstarter::Git.installed!
+                    # Install git
+                    CommandRunner.execute(
+                        command: Commands::Git::Install,
+                        error: nil
+                    )
+                end
+                # clone
+                CommandRunner.execute(
+                    command: "git pull #{@remote} #{@branch}",
+                    error: nil
+                )
+                return true
+            end
+        end
+
+        class Clone < I_Instructions
+            def run!()
+                # Check if git is installed
+                if not Jumpstarter::Git.installed!
+                    # Install git
+                    CommandRunner.execute(
+                        command: Commands::Git::Install,
+                        error: nil
+                    )
+                end
+                # clone
+                CommandRunner.execute(
+                    command: "git clone https://github.com/#{@username}/#{@remote}.git",
+                    error: nil
+                )
+                return true
+            end
+        end
+        class << self
+            #*****************#
+            #  Class Methods  #
+            #*****************#
+            def installed!()
+                # Run version
+                version = CommandRunner.execute(
+                    command: Commands::Git::Version, 
+                    error: nil
+                )
+                return (/git version (\d+)(.\d+)?(.\d+)?/ =~ version) 
+            end
+
+            def required_imports
+                ['instructions', 'writer.rb', 'commandRunner.rb']
+            end
+        end
+    end
+end

data/lib/jumpstarter_core/instructions.rb

@@ -1,429 +1,86 @@
-require_relative './commandRunner'
-require_relative './commands'
 require 'io/console'
-
+require 'xcodeproj'
+require 'plist'
+require 'terminal-table'
 module Jumpstarter
 
+    DEFAULTS = {
+        msg_success: 'Success',
+        msg_error:  'Error',
+        should_crash: false,
+    }
+
+    # I_Instrcutions
+    # This is an abstract class. And should not be init.
+    # This lays out the blueprint for all instructions
+    # The only method that must be overwritten is the run!
+    # method.
     class I_Instructions
-
-        def initialize(msg_success, msg_error, should_crash)
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
-        end
-
-        def run!()
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-
-        def success_message!()
-            if not @msg_success or @msg_success.empty?
-                return "[Success]"
-            end
-            return "#{@msg_success}"
-        end
-
-        def error_message!()
-            if  not @msg_error or @msg_error.empty?
-                return "[Error]"
+        def initialize(opts = {})
+            @dec = nil
+            options = DEFAULTS.merge(opts)
+            options.each do |k, v|
+                v = self.clean_value(v)
+                @dec = "#{@dec}\n\t#{k}: #{v},"
+                instance_variable_set("@#{k}", v)
+                self.class.send(:attr_reader, k)
             end
-            return "#{@msg_error}"
-        end
-
-    end
-
-    class PIPInstall < I_Instructions
-
-        def initialize(pkg, msg_success, msg_error, should_crash)
-            @package = pkg
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
         end
 
         def run!()
-            # Check if pip is installed
-            if not InstallPIP.installed!
-                # Install PIP
-                CommandRunner.execute(
-                    command: Commands::Pip::Install,
-                    error: nil
-                )
-            end
-            # pip is installed
-            CommandRunner.execute(
-                command: "pip3 install #{@package}",
-                error: nil
-            )
             return true
         end
 
         def crash_on_error!()
-            return false
+            return @should_crash
         end
 
         def success_message!()
+            message = ""
             if not @msg_success or @msg_success.empty?
-                return "[Installed] #{@package}"
+                message = "[Success]"
             end
-            return "#{@msg_success}"
+            message = @msg_success
+            return message       
         end
 
         def error_message!()
+            message = ""
             if  not @msg_error or @msg_error.empty?
-                return "[Error] #{@package}"
-            end
-            return "#{@msg_error}"
-        end
-    end
-
-    
-    class InstallPIP < I_Instructions
-
-        def self.installed!()
-
-            # Run version
-            version = CommandRunner.execute(
-                command: Commands::Pip::Version, 
-                error: nil
-            )
-            return (/pip (\d+)(.\d+)?(.\d+)?/ =~ version) 
-        end
-
-        def run!()
-            # install pip
-            CommandRunner.execute(
-                    command: Commands::Pip::Install,
-                    error: nil
-            )
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-    end
-
-    class InstallGIT < I_Instructions
-
-        def self.installed!()
-
-            # Run version
-            version = CommandRunner.execute(
-                command: Commands::Git::Version, 
-                error: nil
-            )
-            return (/git version (\d+)(.\d+)?(.\d+)?/ =~ version) 
-        end
-
-        def run!()
-            # install pip
-            CommandRunner.execute(
-                    command: Commands::Git::Install,
-                    error: nil
-            )
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-    end
-
-    class GITFork < I_Instructions
-
-        def initialize(remote, username, password, msg_success, msg_error, should_crash)
-            @remote = remote
-            @username = username
-            @password = password
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
-        end
-
-        def run!()
-            # Check if git is installed
-            if not InstallGIT.installed!
-                # Install git
-                CommandRunner.execute(
-                    command: Commands::Git::Install,
-                    error: nil
-                )
+                message "[Error]"
             end
-
-            # clone
-            CommandRunner.execute(
-                command: "curl -u #{@username}:#{@password} https://api.github.com/repos/#{@remote}/forks -d ''",
-                error: nil
-            )
-            return true
+            message = @msg_success
+            return message
         end
 
-        def crash_on_error!()
-            return false
-        end
-
-        def success_message!()
-            if not @msg_success or @msg_success.empty?
-                return "[Successfully forked] #{@remote}"
+        def clean_value(arg)
+            if arg == nil
+                return "''"
+            elsif !!arg == arg or (not "#{arg}".match(" "))
+                return arg
             end
-            return "#{@msg_success}"
+            return "#{arg}"
         end
 
-        def error_message!()
-            if  not @msg_error or @msg_error.empty?
-                return "[Error] #{@remote}"
-            end
-            return "#{@msg_error}"
+        def compose!()
+            str = "_inst_ret = #{self.class}.new(#{@dec.chomp(',')}".chomp()
+            str = "#{str}\n).run!"
+            str = "#{str}\nif _inst_ret"
+            str = "#{str}\n\tJumpstarter::Writer.show_success(message: #{self.success_message!})"
+            str = "#{str}\nelse"
+            str = "#{str}\n\tJumpstarter::Writer.show_error(message: #{self.error_message!})"
+            str = "#{str}\nend"
+            return str
         end
-    end
-
-    class GITPull < I_Instructions
-
-        def initialize(remote, branch, msg_success, msg_error, should_crash)
-            @remote = remote
-            @branch = branch
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
-        end
-
-        def run!()
-            # Check if git is installed
-            if not InstallGIT.installed!
-                # Install git
-                CommandRunner.execute(
-                    command: Commands::Git::Install,
-                    error: nil
-                )
-            end
-
-            # clone
-            CommandRunner.execute(
-                command: "git pull #{@remote} #{@branch}",
-                error: nil
-            )
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-
-        def success_message!()
-            if not @msg_success or @msg_success.empty?
-                return "[Successfully pulled] #{@remote}/#{@branch}"
-            end
-            return "#{@msg_success}"
-        end
-
-        def error_message!()
-            if  not @msg_error or @msg_error.empty?
-                return "[Error] #{@remote}"
-            end
-            return "#{@msg_error}"
-        end
-    end
-
-    class GITClone < I_Instructions
-
-        def initialize(remote, username, msg_success, msg_error, should_crash)
-            @remote = remote
-            @username = username
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
-        end
-
-        def run!()
-            # Check if git is installed
-            if not InstallGIT.installed!
-                # Install git
-                CommandRunner.execute(
-                    command: Commands::Git::Install,
-                    error: nil
-                )
-            end
-
-            # clone
-            CommandRunner.execute(
-                command: "git clone https://github.com/#{@username}/#{@remote}.git",
-                error: nil
-            )
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-
-        def success_message!()
-            if not @msg_success or @msg_success.empty?
-                return "[Successfully pulled] #{@username}/#{@remote}"
-            end
-            return "#{@msg_success}"
-        end
-
-        def error_message!()
-            if  not @msg_error or @msg_error.empty?
-                return "[Error] #{@username}/#{@remote}"
-            end
-            return "#{@msg_error}"
-        end
-    end
-
-    class BashRun < I_Instructions
-
-        def initialize(path, msg_success, msg_error, should_crash)
-            @path = path
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
-        end
-
-        def run!()
-            CommandRunner.execute(
-                command: "bash #{@path}",
-                error: nil
-            )
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-
-        def success_message!()
-            if not @msg_success or @msg_success.empty?
-                return "[Successfully Exec] #{@path}"
-            end
-            return "#{@msg_success}"
-        end
-
-        def error_message!()
-            if  not @msg_error or @msg_error.empty?
-                return "[Error exec] #{@path}"
-            end
-            return "#{@msg_error}"
-        end
-    end
-
-    class CDInst < I_Instructions
-
-        def initialize(path, msg_success, msg_error, should_crash)
-            @path = path
-            @msg_success = msg_success
-            @msg_error = msg_error
-            @should_crash = should_crash
-        end
-
-        def run!()
-            Dir.chdir "#{@path}"
-            return true
-        end
-
-        def crash_on_error!()
-            return false
-        end
-
-        def success_message!()
-            if not @msg_success or @msg_success.empty?
-                return "[Successfully moved to] #{@path}"
-            end
-            return "#{@msg_success}"
-        end
-
-        def error_message!()
-            if  not @msg_error or @msg_error.empty?
-                return "[Error moving to] #{@path}"
-            end
-            return "#{@msg_error}"
-        end
-    end
 
-    class InstructionParser
-        class << self
-            def parse(line)
-                inst_elm = line.split
-                cmd = inst_elm[0]
-                case cmd
-                when "pip"
-                    package = inst_elm[1]
-                    msg_success = inst_elm[2] if inst_elm[2]
-                    msg_error =  inst_elm[3] if inst_elm[3]
-                    should_crash = inst_elm[4] == "true" if inst_elm[4]
-                    return PIPInstall.new(
-                        package, 
-                        msg_success, 
-                        msg_error, 
-                        should_crash
-                    )
-                when "git"
-                    subcmd = inst_elm[1]
-                    remote = inst_elm[2]
-                    branch = inst_elm[3] if inst_elm[3]
-                    case subcmd
-                    when "fork"
-                        puts "github username: "
-                        username = STDIN.gets.chomp
-                        password = STDIN.getpass("Password: ")
-                        return GITFork.new(
-                            remote, 
-                            username, 
-                            password, 
-                            msg_success, 
-                            msg_error, 
-                            should_crash
-                        )
-                    when "pull"
-                        return GITPull.new(
-                            remote, 
-                            branch, 
-                            msg_success, 
-                            msg_error, 
-                            should_crash
-                        )
-                    when "clone"
-                        puts "github username: "
-                        username = STDIN.gets.chomp
-                        return GITClone.new(
-                            remote, 
-                            username, 
-                            msg_success, 
-                            msg_error, 
-                            should_crash
-                        )
-                    else
-                    end
-                when "bash"
-                    subcmd = inst_elm[1]
-                    path = inst_elm[2]
-                    case subcmd
-                    when "run"
-                        return BashRun.new(
-                            path, 
-                            msg_success, 
-                            msg_error, 
-                            should_crash
-                        )
-                    else
-                    end
-                when "cd"
-                    path = inst_elm[1]
-                    return CDInst.new(
-                        path, 
-                        msg_success, 
-                        msg_error, 
-                        should_crash
-                    )
-                else
-                    puts "The command #{cmd} is not supported"
-                end
+        def options(ops)
+            rows = []
+            c = 0
+            ops.each do |v|
+                rows << [v, c]
+                c = c + 1
             end
+            return Terminal::Table.new :rows => rows
         end
     end
 end