script_executor 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d6695b3e0e7450b4fcec663a84a49b085cc90f
-  data.tar.gz: b6fe05e4038b43b2e69778500b26a6eeb4935554
+  metadata.gz: e0a0de62f31cf6ee86a7d9ae383d1e28fa4edacd
+  data.tar.gz: 154c990b179af68c7dfd41697d2c8165a1e2df62
 SHA512:
-  metadata.gz: 14c40167ea6d3f4830ad6034ac47c46c952c787aa57c0dfedec7880c6e62dbf6692f6d0d6d5872b4061aa3cc2f6468ea135d8fb4ec66ddaf1b706e3f66fac077
-  data.tar.gz: bef48a0165ac5110a6a8032e1b477baf8b649dcf5a3385305035c6ab120c1a5b702c5f8df386e82fd5ce093ed6f59a8e3ee419f23bfabc3af9c57b40c1229911
+  metadata.gz: f362a894b9185ee0297885933e1db9aa5ede241635b717466fba2cf850228a2c07b006435f8ffe14aaf04a58b1bcb9d7cfd15f10db12c2ad7a5d67f10902ae64
+  data.tar.gz: 0e1a3bbfaceed66e2d7d2837deefd431ec40f2dce54449f96822f7c6cb4c68a6625cf26a0ac95f471ec7bdd03ed222a83307b760fdf6012ec59a2ca6a4ae8d29

data/CHANGES

@@ -106,6 +106,6 @@
 
 * Replace simple parsing with parslet-based parsing.
 
-== Version 1.7.1, 1.7.2
+== Version 1.7.1, 1.7.2,1.7.3
 
-* Bug fix.
+* Bug fixes.

data/README.md

@@ -95,11 +95,11 @@ require 'script_locator'
 
 include ScriptLocator
 
-puts scripts(__FILE__) # [command1, command2]
+scripts = scripts(__FILE__) # [command1, command2]
 
 name = "john"
 
-result = evaluate_script_body(result['command1'], binding)
+result = evaluate_script_body(scripts[:command1][:code], binding)
 
 puts result # john
 __END__
@@ -113,7 +113,69 @@ echo "<%= name %>"
 echo "test2"
 ```
 
+## Using BaseProvision
+
+- Create project configuration file:
+
+```json
+# base.conf.json
+{
+  "node": {
+    "domain": "22.22.22.22", // remote host, see "config.vm.synced_folder"
+    "port": "22",            // default ssh port
+    "user": "vagrant",       // vagrant user name
+    "password": "vagrant",   // vagrant user password
+    "home": "/home/vagrant",
+    "remote": true
+  },
+
+  "project": {
+    "home": "#{node.home}/acceptance_demo",
+    "ruby_version": "2.2.3",
+    "gemset": "acceptance_demo"
+  }
+}
+```
+
+- Create file with shell commands:
+
+```
+# script.sh
+
+
+[echo]
+
+echo "Hello world!"
+
+
+[ubuntu_update]
 
+sudo apt-get update
+```
+
+- Create provision based on thor and use it:
+
+```
+# install.thor
+
+class MyProvision < Thor
+  @provision = BaseProvision.new self, 'base.conf.json', ['script.sh']
+  @provision.create_thor_methods(self)
+  
+  desc "local_command", "local_command"
+  def local_command
+    invoke :echo
+    invoke :ubuntu_update
+  end
+end
+
+my_provision = MyProvision.new
+
+thor my_provision:echo
+thor my_provision:ubuntu_update
+
+thor my_provision:local_command
+```
 
 ## Contributing
 

data/lib/script_executor/base_provision.rb

@@ -10,7 +10,8 @@ class BaseProvision
 
   attr_reader :interpolator, :env, :script_list, :server_info
 
-  def initialize parent_class, config_file_name, scripts_file_names
+  def initialize config_file_name, scripts_file_names
+    @terminal = HighLine.new
     @interpolator = TextInterpolator.new
 
     @env = read_config(config_file_name)
@@ -21,18 +22,14 @@ class BaseProvision
       @script_list.merge!(scripts(name))
     end
 
-    create_script_methods
-
-    create_thor_methods(parent_class) if parent_class.ancestors.collect(&:to_s).include?('Thor')
-
     @server_info = env[:node] ? env[:node] : {}
 
-    @terminal ||= HighLine.new
+    create_script_methods
   end
 
   def run script_name, params={}, type=:string
-      execute(server_info) do
-      evaluate_script_body(script_list[script_name.to_sym][:codeLines].join("\n"), params, type)
+    execute(server_info) do
+      evaluate_script_body(script_list[script_name.to_sym][:code], params, type)
     end
   end
 
@@ -59,17 +56,19 @@ class BaseProvision
   end
 
   def create_thor_methods parent_class
-    provision = self
+    if parent_class.ancestors.collect(&:to_s).include?('Thor')
+      provision = self
 
-    provision.script_list.each do |name, value|
-      title = value[:comment]
+      provision.script_list.each do |name, value|
+        title = value[:comment]
 
-      title = title.nil? ? name : title
+        title = title.nil? ? name : title
 
-      parent_class.send(:desc, name, title) if parent_class.respond_to?(:desc)
+        parent_class.send(:desc, name, title) if parent_class.respond_to?(:desc)
 
-      parent_class.send(:define_method, name.to_sym) do
-        provision.send "#{name}".to_sym
+        parent_class.send(:define_method, name.to_sym) do
+          provision.send "#{name}".to_sym
+        end
       end
     end
   end

data/lib/script_executor/script_locator.rb

@@ -13,6 +13,8 @@ module ScriptLocator
   end
 
   def evaluate_script_body content, env, type=:erb
+    content = content.join("\n") if content.kind_of? Array
+
     case type
       when :erb
         template = ERB.new content

data/lib/script_executor/scripts_parser.rb

@@ -12,11 +12,11 @@ class ScriptsParser < Parslet::Parser
   rule(:ignored)    { comment.repeat }
   rule(:scripts)    { script.repeat }
 
-  rule(:script)     { emptyLines >> (name >> comment.maybe >> codeLines).as(:script) }
+  rule(:script)     { emptyLines >> (name >> comment.maybe >> code).as(:script) }
   rule(:comment)    { emptyLines >> spaces >> (str('#') >> spaces >> (newline.absent? >> any).repeat.as(:comment)) >> newline }
   rule(:name)       { spaces >> str('[') >> spaces >> spaces >> nameChars.as(:name) >> spaces >> str(']') >> spaces >> newline }
 
-  rule(:codeLines)  { (emptyLines >> codeLine.repeat.maybe >> emptyLines).as(:codeLines) }
+  rule(:code)  { (emptyLines >> codeLine.repeat.maybe >> emptyLines).as(:code) }
   rule(:codeLine)   { emptyLines >> codeChars.as(:codeLine) >> newline }
 
   rule(:nameChars)  { match['\w\d_'].repeat(1) }

data/lib/script_executor/scripts_transformer.rb

@@ -9,13 +9,13 @@ class ScriptsTransformer < Parslet::Transform
     language[:scripts].each do |script|
       name = script[:script][:name].to_sym
       comment = script[:script][:comment].to_s
-      code_lines = script[:script][:codeLines]
+      code = script[:script][:code]
 
-      code_lines.each_with_index do |codeLine, index|
-        code_lines[index] = codeLine[:codeLine].to_s
+      code.each_with_index do |codeLine, index|
+        code[index] = codeLine[:codeLine].to_s
       end
 
-      new_scripts[name] = {comment: comment, codeLines: code_lines}
+      new_scripts[name] = {comment: comment, code: code}
     end
 
     language[:scripts] = new_scripts

data/lib/script_executor/version.rb

@@ -1,3 +1,3 @@
 class ScriptExecutor
-  VERSION = "1.7.2"
+  VERSION = "1.7.3"
 end

data/spec/base_provision_spec.rb

@@ -3,14 +3,10 @@ require 'spec_helper'
 require 'thor'
 require 'script_executor/base_provision'
 
-class ThorClass < Thor
-
-end
+class ThorClass < Thor; end
 
 describe BaseProvision do
-  subject {
-    BaseProvision.new ThorClass, 'spec/support/base.conf.json', ['spec/support/big_script.sh']
-  }
+  subject { BaseProvision.new 'spec/support/base.conf.json', ['spec/support/script1.sh'] }
 
   describe "#initialize" do
     it "parses content from file" do

data/spec/script_locator_spec.rb

@@ -16,7 +16,7 @@ describe ScriptLocator do
     end
 
     it "reads from file completely if it does not have __END__ tag" do
-      file = File.expand_path('support/test.conf', File.dirname(__FILE__))
+      file = File.expand_path('support/script4.sh', File.dirname(__FILE__))
 
       scripts = subject.scripts(file)
 
@@ -30,23 +30,23 @@ describe ScriptLocator do
 
       name = "alisa"
 
-      result = subject.evaluate_script_body(scripts[:test1][:codeLines], binding)
+      result = subject.evaluate_script_body(scripts[:test1][:code], binding)
 
-      expect(result.first).to match /#{name}/
+      expect(result).to match /#{name}/
 
       expect(scripts[:test1][:comment]).to eq "Some description"
     end
 
     it "locates script inside external file and evaluates it as string" do
-      file = File.expand_path('support/test.conf', File.dirname(__FILE__))
+      file = File.expand_path('support/script4.sh', File.dirname(__FILE__))
 
       scripts = subject.scripts(file)
 
       env = {:name => "alisa"}
 
-      result = subject.evaluate_script_body(scripts[:test1][:codeLines], env, :string)
+      result = subject.evaluate_script_body(scripts[:test1][:code], env, :string)
 
-      expect(result.first).to match /#{env[:name]}/
+      expect(result).to match /#{env[:name]}/
     end
   end
 

data/spec/scripts_parser_spec.rb

@@ -5,9 +5,40 @@ require 'script_executor/scripts_transformer'
 
 describe ScriptsParser do
   describe "#parse" do
-    it "parses content from file" do
-      content = File.read('spec/support/big_script2.sh')
-      #content = File.read('spec/support/test.conf')
+    it "parses content from file 1" do
+      content = File.read('spec/support/script1.sh')
+
+      parsed_content = subject.parse(content)
+
+      ap parsed_content
+    end
+
+    it "parses content from file 2" do
+      content = File.read('spec/support/script2.sh')
+
+      parsed_content = subject.parse(content)
+
+      ap parsed_content
+    end
+
+    it "parses content from file 3" do
+      content = File.read('spec/support/script3.sh')
+
+      parsed_content = subject.parse(content)
+
+      ap parsed_content
+    end
+
+    it "parses content from file 4" do
+      content = File.read('spec/support/script4.sh')
+
+      parsed_content = subject.parse(content)
+
+      ap parsed_content
+    end
+
+    it "parses content from file 5" do
+      content = File.read('spec/support/script5.sh')
 
       parsed_content = subject.parse(content)
 

data/spec/support/base.conf.json

@@ -13,4 +13,4 @@
     "ruby_version": "2.2.3",
     "gemset": "acceptance_demo"
   }
-}
+}

data/spec/support/script3.sh

@@ -0,0 +1,24 @@
+
+[gen_key]
+
+echo "Generating ssh key..."
+
+cd ~/.ssh
+ssh-keygen
+
+[cp_key1]
+
+echo "Copying public key to remote server..."
+
+echo <%= user %>
+echo <%= host %>
+
+scp ~/.ssh/id_rsa.pub <%= user %>@<%= host %>:~/pubkey.txt
+
+[cp_key2]
+
+mkdir -p ~/.ssh
+chmod 700 .ssh
+cat pubkey.txt >> ~/.ssh/authorized_keys
+rm ~/pubkey.txt
+chmod 600 ~/.ssh/*

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: script_executor
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Alexander Shvets
@@ -172,10 +172,11 @@ files:
 - spec/scripts_parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/base.conf.json
-- spec/support/big_script.sh
-- spec/support/big_script2.sh
-- spec/support/test.conf
-- spec/support/test2.conf
+- spec/support/script1.sh
+- spec/support/script2.sh
+- spec/support/script3.sh
+- spec/support/script4.sh
+- spec/support/script5.sh
 homepage: http://github.com/shvets/script_executor
 licenses:
 - MIT
@@ -207,7 +208,8 @@ test_files:
 - spec/scripts_parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/base.conf.json
-- spec/support/big_script.sh
-- spec/support/big_script2.sh
-- spec/support/test.conf
-- spec/support/test2.conf
+- spec/support/script1.sh
+- spec/support/script2.sh
+- spec/support/script3.sh
+- spec/support/script4.sh
+- spec/support/script5.sh