cachivache-helpers 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ce5c412d212a96f20530c73d3cff9dc867b2da0
+  data.tar.gz: 24ef8bf696245a4d14fd31363d2e8f204f53c9d7
+SHA512:
+  metadata.gz: e0515419f44a6c0b89dc4295d9351185dc67d6da8bde92a3fd535596a5b92037ba3f25cfee834778a9c90011fab0e4aa1a673dfbecdacdae0eb49394906f16cb
+  data.tar.gz: 248e9915873a495336a34b6fc25be909d0dc961867e01b17550d2e4cd8a622ef2462f1e01c82280abfbe69ce4316098008376379dafa5e64d70be3dca0426075

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require 'spec-helper'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+   - "1.9.3"
+   - "2.0"
+   - "2.1"
+   - "2.2"
+
+before_install: gem install bundler
+
+script: bundle exec rspec
+
+git:
+   submodules: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cachivache-helpers.gemspec
+gemspec
+
+gem 'rspec', require: false
+gem 'simplecov', require: false
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Martin Rubi
+
+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,38 @@
+# Cachivache::Helpers
+
+[Cachivache](https://github.com/cabeza-de-termo/cachivache) is a provisioner for Vagrant machines with Ubuntu images.
+
+This gem provides helpers to use when defining Cachivache stuffs.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/cachivache-helpers.svg)](https://badge.fury.io/rb/cachivache-helpers)
+[![Build Status](https://travis-ci.org/cabeza-de-termo/cachivache-helpers.svg?branch=master)](https://travis-ci.org/cabeza-de-termo/cachivache-helpers)
+[![Coverage Status](https://coveralls.io/repos/cabeza-de-termo/cachivache-helpers/badge.svg?branch=master&service=github)](https://coveralls.io/github/cabeza-de-termo/cachivache-helpers?branch=master)
+
+## Installation
+
+In your [Cachivache](https://github.com/cabeza-de-termo/cachivache) folder, edit the `Gemfile` file add or update the line
+
+```ruby
+gem 'cachivache-helpers', "~> 0.1"
+```
+
+## Usage
+
+Please read the [Cachivache](https://github.com/cabeza-de-termo/cachivache) documentation.
+
+## Running the tests
+
+- `bundle install`
+- `bundle exec rspec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cabeza-de-termo/cachivache-helpers.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/cachivache-helpers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cabeza-de-termo/cachivache-helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cachivache-helpers"
+  spec.version       = CachivacheHelpers::VERSION
+  spec.authors       = ["Martin Rubi"]
+  spec.email         = ["martinrubi@gmail.com"]
+
+  spec.summary       = %q{Helpers to use in Cachivache stuffs.}
+  spec.description   = %q{Helpers to use in Cachivache stuffs.}
+  spec.homepage      = "https://github.com/cabeza-de-termo/cachivache-helpers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cabeza-de-termo/cachivache-helpers/helpers.rb

@@ -0,0 +1 @@
+require_relative 'version'

data/lib/cabeza-de-termo/cachivache-helpers/utilities/helpers.rb

@@ -0,0 +1,32 @@
+require 'colorize'
+require 'pathname'
+
+# Helper - Iterate all .rb files in a folder
+def all_rb_files_in(folder, &block)
+	Dir[Pathname.new(folder) + '**/*.rb'].each do |file| 
+		block.call(file)
+	end
+end
+
+def stuff_to_install(&block)
+	Cachivache.stuff_to_install.each do |stuff_name|
+		block.call stuff_name
+	end
+end
+
+public
+
+######################################
+# require cachivache-helpers
+######################################
+
+require 'cachivache-helpers'
+
+######################################
+# Stuff Api behaviour
+######################################
+
+include Stuff::ApiBehaviour
+include Stuff::RemindersBehaviour
+
+ShellContext.set_current( ShellExec.new(self) )

data/lib/cabeza-de-termo/cachivache-helpers/utilities/rake-adaptor.rb

@@ -0,0 +1,17 @@
+module RakeAdaptor
+	def stuff(task_definition, *args, &block)
+		task(task_definition, *args, &block)
+	end
+
+	def execute_shell_command(command)
+		sh command
+	end
+
+	def invoke_stuff(task_name, *args)
+		Rake::Task[task_name].invoke(*args)
+	end
+
+	def execute_stuff(task_name, *args)
+		Rake::Task[task_name].execute(*args)
+	end
+end

data/lib/cabeza-de-termo/cachivache-helpers/utilities/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)
+		raise 'Subclass responsibility'
+	end
+
+	def execute(task_name, *args)
+		raise 'Subclass responsibility'
+	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/lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell-exec.rb

@@ -0,0 +1,27 @@
+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
+
+	def invoke(task_name, *args)
+		scope.invoke_stuff(task_name, *args)
+	end
+
+	def execute(task_name, *args)
+		scope.execute_stuff(task_name, *args)
+	end
+end

data/lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell_buffer.rb

@@ -0,0 +1,33 @@
+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
+
+	def invoke(task_name, *args)
+		underlaying_shell_context.invoke(task_name, *args)
+	end
+
+	def execute(task_name, *args)
+		underlaying_shell_context.execute(task_name, *args)
+	end
+end

data/lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell_debugger.rb

@@ -0,0 +1,27 @@
+require_relative 'shell-context'
+
+class ShellDebugger < ShellContext
+	def initialize(scope)
+		@scope = scope
+	end
+
+	def scope()
+		@scope
+	end
+
+	def shell(command)
+		puts command.cyan
+	end
+
+	def shell!(command)
+		puts command.red
+	end
+
+	def invoke(task_name, *args)
+		scope.invoke_stuff(task_name, *args)
+	end
+
+	def execute(task_name, *args)
+		scope.execute_stuff(task_name, *args)
+	end
+end

data/lib/cabeza-de-termo/cachivache-helpers/utilities/shell-file-context.rb

@@ -0,0 +1,36 @@
+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]
+	end
+
+	def evaluate_with(block)
+		instance_eval(&block)
+	end
+
+	# replace pattern: "user: ''", with: "user: 'admin'"
+	def replace(params)
+		pattern = params[:pattern]
+		replacement = params[:with]
+		%Q{
+			sudo sed -i 's|#{pattern}|#{replacement}|g' #{@filename}
+		}
+	end
+
+	# append '[mongo]'
+	# append :new_line
+	def append(text)
+		text = "\n" if text == :new_line
+
+		%Q{
+			echo "#{text}" | sudo tee -a #{@filename}
+		}
+	end
+end

data/lib/cabeza-de-termo/cachivache-helpers/utilities/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/lib/cabeza-de-termo/cachivache-helpers/utilities/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

data/lib/cabeza-de-termo/cachivache-helpers/utilities/stuff-reminders-behaviour.rb

@@ -0,0 +1,11 @@
+module Stuff
+	module RemindersBehaviour
+		def show_reminders()
+			ShellContext.reminders.each { |alert| show_info(alert) }
+		end
+
+		def show_info(text)
+			ShellContext.show_info(text)
+		end
+	end
+end

data/lib/cabeza-de-termo/cachivache-helpers/version.rb

@@ -0,0 +1,3 @@
+module CachivacheHelpers
+	VERSION = "0.0.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: cachivache-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Martin Rubi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Helpers to use in Cachivache stuffs.
+email:
+- martinrubi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cachivache-helpers.gemspec
+- lib/cabeza-de-termo/cachivache-helpers/helpers.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/helpers.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/rake-adaptor.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell-context.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell-exec.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell_buffer.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/shell-contexts/shell_debugger.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/shell-file-context.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/shell-if-context.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/stuff-api-behaviour.rb
+- lib/cabeza-de-termo/cachivache-helpers/utilities/stuff-reminders-behaviour.rb
+- lib/cabeza-de-termo/cachivache-helpers/version.rb
+homepage: https://github.com/cabeza-de-termo/cachivache-helpers
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Helpers to use in Cachivache stuffs.
+test_files: []