json-spec 0.1.0 → 0.1.1

data/cachivache/Rakefile

@@ -1,19 +1,28 @@
 require_relative 'lib/rake-helper'
 
-raise_validation_error "Please, define some Cachivache:stuff_to_install in './cachivache.rb' task and run 'vagrant provision' again" if Cachivache.stuff_to_install.empty?
+raise_validation_error "Please define the parameter Cachivache.git_user_email in './cachivache.rb' run 'vagrant provision' again" unless Cachivache.is_defined?(:git_user_email)
+raise_validation_error "Please define the parameter Cachivache.git_user_name in './cachivache.rb' run 'vagrant provision' again" unless Cachivache.is_defined?(:git_user_name)
+raise_validation_error "Please define some Cachivache.stuff_to_install in './cachivache.rb' run 'vagrant provision' again" if Cachivache.stuff_to_install.empty?
 
-task :provision do
-   Cachivache.stuff_to_install.each do |stuff_name|
-      show_info "Provisioning #{stuff_name}"
+def provision_stuff_to_install()
+	stuff_to_install do |stuff_name|
+    	show_info "Provisioning #{stuff_name}"
+		invoke stuff_name
+	end
+   	show_info "All done!!!"
+end
 
-      invoke stuff_name
-   end
+stuff :provision do
+	provision_stuff_to_install
+end
 
-   show_info "All done!!!"
+stuff :explain do
+	ShellContext.set_current ShellDebugger.new
+	provision_stuff_to_install
 end
 
-task default: :provision
+stuff default: :provision
 
 at_exit do 
-   show_reminders
+	show_reminders
 end

data/cachivache/Vagrantfile

@@ -22,11 +22,11 @@ Vagrant.configure(2) do |config|
   # backing providers for Vagrant. These expose provider-specific options.
 
   config.vm.provider "virtualbox" do |vb|
-  		# Display the VirtualBox GUI when booting the machine
+  	# Display the VirtualBox GUI when booting the machine
  		vb.gui = Cachivache.wants_gui?
   
-     	# Customize the amount of memory on the VM:
-    	vb.memory = Cachivache.wants_gui? ? "4096" : "1024"
+    # Customize the amount of memory on the VM:
+    vb.memory = Cachivache.wants_gui? ? "4096" : "1024"
   end
  
   # Enable provisioning with a shell script. Additional provisioners such as

data/cachivache/cachivache.rb

@@ -1,8 +1,6 @@
-require_relative 'lib/let-behaviour'
-
-class Cachivache
-   include LetBehaviour
+require_relative 'lib/stuff-configuration'
 
+class Cachivache < Stuff::Configuration
    # Vagrant params
 
    let(:vagrant_ip_address)      { '192.168.0.101' }
@@ -29,7 +27,7 @@ class Cachivache
 
    let(:stuff_to_install) {
       [
-         'stuff:ruby-json-spec'
+         'ruby-json-spec'
       ]
    }
 
@@ -56,4 +54,4 @@ host bitbucket.org
    User git    
 }
    }
-end
+end

data/cachivache/lib/rake-helper.rb

@@ -2,130 +2,52 @@ require 'rake'
 require 'colorize'
 require 'pathname'
 
-require_relative 'let-behaviour'
-require_relative 'sh-file-context'
-require_relative 'sh-if-context'
 require_relative '../cachivache'
 
-public
-
-# Require all .rb files in a folder
-def require_all_rb_files_in(folder)
+# Helper - Iterate all .rb files in a folder
+def all_rb_files_in(folder, &block)
 	Dir[Pathname.new(folder) + '**/*.rb'].each do |file| 
-		require file
+		block.call(file)
 	end
 end
 
-def invoke(task_name, *args)
-	Rake::Task[task_name].invoke(*args)
-end
-
-def execute(task_name, *args)
-	Rake::Task[task_name].execute(*args)
-end
-
-# Examples:
-#
-# sh_unless file_exists: '/bla.conf' do
-# 	sh %Q{
-# 		ls -la
-# 		rm -rf bla
-# 	}
-# end
-#
-# sh_unless folder_exists: '/bla' do
-# 	sh %Q{
-# 		ls -la
-# 		rm -rf bla
-# 	}
-# end
-#
-# sh_unless file: '/bla', contains: 'some regex' do
-# 	sh %Q{
-# 		ls -la
-# 		rm -rf bla
-# 	}
-# end
-#
-# sh_unless command: 'java -version', contains: 'java 1.8' do
-# 	sh %Q{
-# 		ls -la
-# 		rm -rf bla
-# 	}
-# end
-#
-def sh_unless(params, &block)
-	if params.key?(:file_exists)
-		sh unless_file_exists(params[:file_exists], &block)
-		return
-	end
-	if params.key?(:folder_exists)
-		sh unless_folder_exists(params[:folder_exists], &block)
-		return
-	end
-	if params.key?(:file) && params.key?(:contains)
-		sh unless_regex_in_file(params[:contains], params[:file], &block)
-		return
-	end
-	if params.key?(:command) && params.key?(:contains)
-		sh unless_regex_in_command(params[:contains], params[:command], &block)
-		return
+def stuff_to_install(&block)
+	Cachivache.stuff_to_install.each do |stuff_name|
+		block.call stuff_name
 	end
-	raise 'Invalid unless option'
 end
 
-def unless_file_exists(filename, &block)
-	ShIfContext.with(guard: "[ ! -e #{filename} ]", &block)
-end
+public
 
-def unless_folder_exists(folder, &block)
-	ShIfContext.with(guard: "[ ! -d #{folder} ]", &block)
-end
+######################################
+# require all the files in /lib first
+######################################
 
-def unless_regex_in_file(regex, filename, &block)
-	ShIfContext.with(guard: "! grep -q \"#{regex}\" \"#{filename}\"", &block)
+all_rb_files_in Cachivache.cachivache_folder + '/lib' do |file|
+	require file
 end
 
-def unless_regex_in_command(regex, command, &block)
-	ShIfContext.with(guard: "! #{command} | grep -q \"#{regex}\"", &block)
-end
+######################################
+# Stuff Api behaviour
+######################################
 
-# Examples:
-#
-# sh_in_file "/bla.conf" do
-# 	replace pattern: "%user%", with: "admin"
-#
-# 	append "[cachivache]"
-# 	append "path='/bla'"
-# end
-def sh_in_file(filename, &block)
-	sh ShFileContext.with(file: filename, &block)
+def stuff(task_definition, *args, &block)
+	task(task_definition, *args, &block)
 end
 
-def reminders()
-	@reminders ||= []
+def execute_shell_command(command)
+	sh command
 end
 
-# Examples:
-#
-# remind_to 'This is shown when the provision ends'
-def remind_to(text)
-	reminders << text
-end
+include Stuff::ApiBehaviour
+include Stuff::RemindersBehaviour
 
-def show_info(text)
-	puts '-----------------------------------------------'.red
-	puts text.green
-	puts '-----------------------------------------------'.red
-end
+ShellContext.set_current( ShellExec.new(self) )
 
-def show_reminders()
-	reminders.each { |alert| show_info(alert) }
-end
+######################################
+# Load the rest of the files
+######################################
 
-def raise_validation_error(message)
-	show_info(message)
-	exit
+all_rb_files_in Cachivache.cachivache_folder do |file|
+	require file
 end
-
-require_all_rb_files_in Cachivache.cachivache_folder

data/cachivache/lib/shell-contexts/shell-context.rb

@@ -0,0 +1,63 @@
+class ShellContext
+	@current = nil
+	@reminders = []
+
+	def self.current()
+		@current
+	end
+
+	def self.set_current(shell_context)
+		@current = shell_context
+	end
+
+	def self.during_shell_context(new_shell_context, &block)
+		current_shell_context = @current
+
+		@current = new_shell_context
+
+		block.call
+
+		@current = current_shell_context
+	end
+
+	def self.reminders()
+		@reminders
+	end
+
+	def self.show_info(text)
+		puts '-----------------------------------------------'.red
+		puts text.green
+		puts '-----------------------------------------------'.red
+	end
+
+	# Instance methods
+
+	def shell(command)
+		raise 'Subclass responsibility'
+	end
+
+	def shell!(command)
+		raise 'Subclass responsibility'
+	end
+
+	def invoke(task_name, *args)
+		Rake::Task[task_name].invoke(*args)
+	end
+
+	def execute(task_name, *args)
+		Rake::Task[task_name].execute(*args)
+	end
+
+	def remind_to(text)
+		ShellContext.reminders << text
+	end
+
+	def raise_validation_error(message)
+		show_info(message)
+		exit
+	end
+
+	def show_info(text)
+		ShellContext.show_info(text)
+	end
+end

data/cachivache/lib/shell-contexts/shell-exec.rb

@@ -0,0 +1,19 @@
+require_relative 'shell-context'
+
+class ShellExec < ShellContext
+	def initialize(scope)
+		@scope = scope
+	end
+
+	def scope()
+		@scope
+	end
+
+	def shell(command)
+		shell! command
+	end
+
+	def shell!(command)
+		scope.execute_shell_command(command)
+	end
+end

data/cachivache/lib/shell-contexts/shell_buffer.rb

@@ -0,0 +1,25 @@
+require_relative 'shell-context'
+
+class ShellBuffer < ShellContext
+	def initialize(underlaying_shell_context)
+		@underlaying_shell_context = underlaying_shell_context
+		@contents = ''
+	end
+
+	def underlaying_shell_context()
+		@underlaying_shell_context
+	end
+
+	def contents
+		@contents
+	end
+
+	def shell(command)
+		contents << "\n" unless contents.empty?
+		contents << command
+	end
+
+	def shell!(command)
+		underlaying_shell_context.shell! command
+	end
+end

data/cachivache/lib/shell-contexts/shell_debugger.rb

@@ -0,0 +1,11 @@
+require_relative 'shell-context'
+
+class ShellDebugger < ShellContext
+	def shell(command)
+		puts command.cyan
+	end
+
+	def shell!(command)
+		puts command.red
+	end
+end

data/cachivache/lib/{sh-file-context.rb → shell-file-context.rb}

@@ -1,39 +1,36 @@
-class ShFileContext
+require_relative 'stuff-api-behaviour'
+
+class ShellFileContext
+	include Stuff::ApiBehaviour
+
 	def self.with(args, &block)
 		new(args).evaluate_with block
 	end
 
 	def initialize(args)
 		@filename = args[:file]
-		@text = ''
-	end
-
-	def text
-		@text
 	end
 
 	def evaluate_with(block)
 		instance_eval(&block)
 	end
 
-	def <<(string)
-		text << "\n" unless @text.empty?
-		text << string
-	end
-
 	# replace pattern: "user: ''", with: "user: 'admin'"
 	def replace(params)
 		pattern = params[:pattern]
 		replacement = params[:with]
-		self << %Q{sudo sed -i 's|#{pattern}|#{replacement}|g' #{@filename}}
+		%Q{
+			sudo sed -i 's|#{pattern}|#{replacement}|g' #{@filename}
+		}
 	end
 
 	# append '[mongo]'
+	# append :new_line
 	def append(text)
-		self << %Q{echo "#{text}" | sudo tee -a #{@filename}}
-	end
+		text = "\n" if text == :new_line
 
-	def append_new_line
-		append "\n"
+		%Q{
+			echo "#{text}" | sudo tee -a #{@filename}
+		}
 	end
 end

data/cachivache/lib/shell-if-context.rb

@@ -0,0 +1,21 @@
+require_relative 'stuff-api-behaviour'
+
+class ShellIfContext
+	include Stuff::ApiBehaviour
+
+	def self.with(args, &block)
+		new(args).evaluate_with block
+	end
+
+	def initialize(args)
+		@guard = args[:guard]
+	end
+
+	def evaluate_with(block)
+		shell "if #{@guard}; then"
+
+		instance_eval(&block)
+
+		shell "fi"
+	end
+end

data/cachivache/lib/stuff-api-behaviour.rb

@@ -0,0 +1,145 @@
+module Stuff
+	module ApiBehaviour
+		def shell_context()
+			ShellContext.current
+		end
+
+		def invoke(task_name, *args)
+			shell_context.invoke(task_name, *args)
+		end
+
+		def execute(task_name, *args)
+			shell_context.execute(task_name, *args)
+		end
+
+		def shell(command)
+			shell_context.shell(command)
+		end
+
+		def shell!(command)
+			shell_context.shell!(command)
+		end
+
+		# Examples:
+		#
+		# shell_unless file_exists: '/bla.conf' do
+		# 	shell %Q{
+		# 		ls -la
+		# 		rm -rf bla
+		# 	}
+		# end
+		#
+		# shell_unless folder_exists: '/bla' do
+		# 	shell %Q{
+		# 		ls -la
+		# 		rm -rf bla
+		# 	}
+		# end
+		#
+		# shell_unless file: '/bla', contains: 'some regex' do
+		# 	shell %Q{
+		# 		ls -la
+		# 		rm -rf bla
+		# 	}
+		# end
+		#
+		# shell_unless command: 'java -version', contains: 'java 1.8' do
+		# 	shell %Q{
+		# 		ls -la
+		# 		rm -rf bla
+		# 	}
+		# end
+		#
+		def shell_unless(params, &block)
+			if params.key?(:file_exists)
+				shell unless_file_exists(params[:file_exists], &block)
+				return
+			end
+			if params.key?(:folder_exists)
+				shell unless_folder_exists(params[:folder_exists], &block)
+				return
+			end
+			if params.key?(:file) && params.key?(:contains)
+				shell unless_regex_in_file(params[:contains], params[:file], &block)
+				return
+			end
+			if params.key?(:command) && params.key?(:contains)
+				shell unless_regex_in_command(params[:contains], params[:command], &block)
+				return
+			end
+			raise 'Invalid unless option'
+		end
+
+		# Examples:
+		#
+		# in_file "/bla.conf" do
+		# 	shell replace pattern: "%user%", with: "admin"
+		#
+		# 	shell append "[cachivache]"
+		# 	shell append "path='/bla'"
+		# end
+		def in_file(filename, &block)
+			script = during_shell_buffer do
+				ShellFileContext.with(file: filename, &block)
+			end
+
+			shell script
+		end
+
+		# Examples:
+		#
+		# remind_to 'This is shown when the provision ends'
+		def remind_to(text)
+			shell_context.remind_to(text)
+		end
+
+		def raise_validation_error(message)
+			shell_context.raise_validation_error(message)
+		end
+
+		# Example:
+		#
+		# configure :Something do
+		# 	let(:bla)		{ '123' }
+		# 	let(:ble)		{ 'abc' }
+		# end
+		def configure(class_name, &block)
+			Stuff::Configuration.ensure_subclass_exists(class_name)
+			Stuff::Configuration.class_named(class_name).instance_eval(&block)
+		end
+
+		protected
+
+		def during_shell_buffer(&block)
+			temporary_shell_buffer = ShellBuffer.new(shell_context)
+
+			ShellContext.during_shell_context(temporary_shell_buffer, &block)
+
+			temporary_shell_buffer.contents
+		end
+
+		def unless_file_exists(filename, &block)
+			during_shell_buffer do
+				ShellIfContext.with(guard: "[ ! -e #{filename} ]", &block)
+			end
+		end
+
+		def unless_folder_exists(folder, &block)
+			during_shell_buffer do
+				ShellIfContext.with(guard: "[ ! -d #{folder} ]", &block)
+			end
+		end
+
+		def unless_regex_in_file(regex, filename, &block)
+			during_shell_buffer do
+				ShellIfContext.with(guard: "! grep -q \"#{regex}\" \"#{filename}\"", &block)
+			end
+		end
+
+		def unless_regex_in_command(regex, command, &block)
+			during_shell_buffer do
+				ShellIfContext.with(guard: "! #{command} | grep -q \"#{regex}\"", &block)
+			end
+		end
+	end
+end