caracara 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22d2f961067ed99bd7e85d8c20a16393acbe22b7
-  data.tar.gz: 9f06a43d93e8d4898b4a605b785b99d1c9762daa
+  metadata.gz: d50c26f77f84e931ddaebccefcf04be5719db1d2
+  data.tar.gz: a47824aa31549922404bbf7e8db756d1a5863d0b
 SHA512:
-  metadata.gz: 43907c32b6f1dc51c42eb41172ea48276187c8706c8246998aa47d9099fbf1df79238c5ac0c6406e98440c090a6a46c4e985e220e06b5bf036071cd7abf5d37a
-  data.tar.gz: 4cd556a08df8ddd5d86a2b201569be30faf25bb2a17ad4a66f0af98031d69c403902ea8538119b4cea8574cf15b2cfc64892d514d69f12788d992cfccf1c6c20
+  metadata.gz: 99d8b2ca1a4dbf51238c9afab8bac90975cf56acb54be4c8c2de8d8c8a8b7207ec16b47f14352a73443cf0482a32b377e797e1badba2f7c273f8c884519d252c
+  data.tar.gz: becec1267fed45c615b97e4c0f65b213d96bee7d89ee415d84063bf11b3d39e7a4b2bfccb5f1e39ee75b078cbf2b4834ee9ad037c74fd653d24edf9013abc247

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.0
+env:
+  - "travis=true"
+script:
+  - bundle exec rspec

data/README.md

@@ -1,4 +1,4 @@
-# Caracara
+# Caracara [![Build Status](https://travis-ci.org/gabrielcorado/caracara.svg)](https://travis-ci.org/gabrielcorado/caracara)
 Task runner based on [Envoy](http://laravel.com/docs/5.1/envoy) and [Mina](http://mina-deploy.github.io/mina/)
 
 # Concepts
@@ -44,21 +44,15 @@ end
 ```ruby
 class DeployGroup < Caracara::Group
   # Clone it
-  task GitCloneTask
+  task :clone, GitCloneTask
 
   # Dockernize it
-  task DockerTask
+  task :docker, DockerTask
 end
 ```
 
 **Intialize the group**
 ```ruby
-# Initialize the group
-deploy = DeployGroup.init
-```
-
-**Generate the command**
-```ruby
 # Set the options
 options = {
   repository: 'git@github.com:gabrielcorado/caracara.git',
@@ -68,13 +62,19 @@ options = {
   container: 'caracara_app'
 }
 
-# Generate the SSH command
-command = deploy.command options
+# Initialize the group
+deploy = DeployGroup.init options
+```
+
+**Generate the commands**
+```ruby
+# Compile the group commands
+commands = deploy.compile_all
 ```
 
 **Run the command in your server**
 ```ruby
-Caracara::SSH.exec 'user', 'localhost', command
+Caracara::SSH.exec 'user', 'localhost', commands
 ```
 
 # Development

data/caracara.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.strip.split("\n")
   s.executables = Dir["bin/*"].map { |f| File.basename(f) }
 
-  s.add_dependency 'rake'
   s.add_dependency 'mustache', '~> 1.0'
 
   s.add_development_dependency 'rspec', '~> 3.0.0'

data/lib/caracara/group.rb

@@ -6,32 +6,53 @@ module Caracara
     attr_reader :tasks
 
     # Initialize
-    def initialize(tasks = [])
+    def initialize(tasks = [], options = {})
       @tasks = tasks
+      @options = options
     end
 
-    # Tasks access
-    def tasks
-      # Map the tasks
-      @tasks.map do |task|
-        task
-      end
+    # Compile the tasks
+    def compile(name, options = {})
+      # Set options
+      options = @options.merge options
+
+      # Get the tasks
+      task = @tasks[name]
+
+      # Compile the task
+      task.compile options
     end
 
-    # Compile the tasks
-    def compile(args = {})
-      # Each the steps
-      @tasks.map do |task|
+    # Compile all the tasks
+    def compile_all(options = {})
+      # Each tasks
+      @tasks.keys.map do |name|
         # Compile the task
-        task.compile args
+        compile name, options
       end
     end
 
     # Generate the SSH command
-    def command(args = {}, escape = true)
+    def command(name, options = {}, ssh_command = true, escape = true)
+      # Set options
+      options = @options.merge options
+
+      # Generate task command
+      task = @tasks[name].command options, false
+
+      # Do not return the SSH command
+      return task unless ssh_command
+
+      # Generate the full command
+      SSH.command task, escape
+    end
+
+    # Generate all tasks commands
+    def command_all(options = {}, escape = true)
       # Each tasks
-      tasks = @tasks.map do |task|
-        task.command args, false
+      tasks = @tasks.keys.map do |name|
+        # Compile the task
+        command name, options, false
       end
 
       # Generate the full command
@@ -44,7 +65,9 @@ module Caracara
       attr_reader :tasks
 
       # Set a new task to the group
-      def task(command)
+      # @param {Symbol} name The task name
+      # @param {Caracara::Task/String} task The task itself
+      def task(name, command)
         # Check the type of the command
         if command.is_a? String
           task = Task.new [command]
@@ -53,15 +76,15 @@ module Caracara
         end
 
         # Init the tasks
-        @tasks = [] if @tasks.nil?
+        @tasks = {} if @tasks.nil?
 
-        # Push it to the tasks
-        @tasks.push task
+        # Set the task
+        @tasks[name] = task
       end
 
       # Init
-      def init
-        new @tasks
+      def init(options = {})
+        new @tasks, options
       end
 
     end

data/lib/caracara/task.rb

@@ -6,8 +6,9 @@ module Caracara
     @steps = []
 
     # Initialize
-    def initialize(steps)
+    def initialize(steps, args = {})
       @steps = steps
+      @options = args
     end
 
     # Steps
@@ -17,10 +18,13 @@ module Caracara
 
     # Compile the tasks
     def compile(args = {})
+      # Merge args with defult options
+      options = @options.merge args
+
       # Each the steps
       @steps.map do |step|
         # Compile the mustache template
-        Mustache.render step, args
+        Mustache.render step, options
       end
     end
 
@@ -58,9 +62,10 @@ module Caracara
         @steps.push cmd
       end
 
-      def init
+      # Initialize a task
+      def init(args = {})
         # Create a new instance
-        new @steps
+        new @steps, args
       end
     end
   end

data/lib/caracara/version.rb

@@ -1,5 +1,5 @@
 module Caracara
   def self.version
-    '0.1.0'
+    '0.2.0'
   end
 end

data/spec/caracara/group_spec.rb

@@ -10,29 +10,31 @@ end
 # Define a new group
 class GroupSpec < Caracara::Group
   # Define a task from a class
-  task FolderTask
+  task :folder, FolderTask
 
   # Simple task
-  task 'mv anotherFolder/file.txt {{folder}}/movedFile.txt'
+  task :move, 'mv anotherFolder/file.txt {{folder}}/movedFile.txt'
 end
 
 # Kickstart with the tests
 describe 'Groups' do
   # Initialize the group
-  let(:group) { GroupSpec.init }
+  let(:group) {
+    GroupSpec.init folder: 'niceFolder'
+  }
 
   it 'should return the right tasks from GroupSpec' do
     # Get the tasks
     tasks = group.tasks
 
     # Assertions
-    expect(tasks[0]).to be_an_instance_of(FolderTask)
-    expect(tasks[1]).to be_an_instance_of(Caracara::Task)
+    expect(tasks[:folder]).to be_an_instance_of(FolderTask)
+    expect(tasks[:move]).to be_an_instance_of(Caracara::Task)
   end
 
-  it 'should return the compiled tasks' do
+  it 'should compile all the tasks' do
     # Get the compile tasks
-    tasks = group.compile folder: 'niceFolder'
+    tasks = group.compile_all
 
     # Assertions
     expect(tasks[0][0]).to eq('mkdir niceFolder/')
@@ -40,11 +42,45 @@ describe 'Groups' do
     expect(tasks[1][0]).to eq('mv anotherFolder/file.txt niceFolder/movedFile.txt')
   end
 
-  it 'should return the group command' do
+  it 'should compile just one task' do
+    # Compile it
+    task = group.compile :move
+
+    # Assertions
+    expect(task[0]).to eq('mv anotherFolder/file.txt niceFolder/movedFile.txt')
+  end
+
+  it 'should compile all the tasks using the defined args' do
+    # Get the compiled tasks
+    tasks = group.compile_all folder: 'argsFolder'
+
+    # Assertions
+    expect(tasks[0][0]).to eq('mkdir argsFolder/')
+    expect(tasks[0][1]).to eq('chmod -R 775 argsFolder/')
+    expect(tasks[1][0]).to eq('mv anotherFolder/file.txt argsFolder/movedFile.txt')
+  end
+
+  it 'should compile one task using the defined args' do
+    # Get the compiled tasks
+    task = group.compile :move, folder: 'argsFolder'
+
+    # Assertions
+    expect(task[0]).to eq('mv anotherFolder/file.txt argsFolder/movedFile.txt')
+  end
+
+  it 'should generate the group command' do
     # Get the command
-    command = group.command folder: 'niceFolder'
+    command = group.command_all
 
     # Assertions
     expect(command).to eq("mkdir\\ niceFolder/'\n'chmod\\ -R\\ 775\\ niceFolder/'\n'mv\\ anotherFolder/file.txt\\ niceFolder/movedFile.txt")
   end
+
+  it 'should generate one task command' do
+    # Get the command
+    command = group.command :move
+
+    # Assertions
+    expect(command).to eq("mv\\ anotherFolder/file.txt\\ niceFolder/movedFile.txt")
+  end
 end

data/spec/caracara/ssh_spec.rb

@@ -55,11 +55,13 @@ describe 'SSH' do
     # Generate command
     command = Caracara::SSH.generate 'ubuntu', 'localhost', %{ls -la}
 
-    # Run the command
-    result = Caracara::SSH.exec command
+    # Check if travis is not running this
+    if ENV['travis'] != 'true'
+      # Run the command
+      result = Caracara::SSH.exec command
 
-    # Assertions
-    # it should return false because ssh localhost it not enable
-    expect(result[:status]).to eq(false)
+      # it should return false because ssh localhost it not enable
+      expect(result[:status]).to eq(false)
+    end
   end
 end

data/spec/caracara/task_spec.rb

@@ -21,18 +21,13 @@ end
 # Tests
 describe 'Task' do
   # Initialize the task
-  let(:task) { TaskSpec.init }
-
-  # Define the task options
-  let(:options) {
-    {
-      user: 'ubuntu',
-      folder: {
-        name: 'niceFolder',
-        permission: 755
-      },
-      text: 'Some nice text!'
-    }
+  let(:task) {
+    TaskSpec.init user: 'ubuntu',
+                  folder: {
+                    name: 'niceFolder',
+                    permission: 755
+                  },
+                  text: 'Some nice text!'
   }
 
   it 'should return the steps' do
@@ -48,7 +43,7 @@ describe 'Task' do
 
   it 'should compile the steps' do
     # Get the steps
-    steps = task.compile options
+    steps = task.compile
 
     # Assertions
     expect(steps[0]).to eq('mkdir niceFolder/')
@@ -57,9 +52,24 @@ describe 'Task' do
     expect(steps[3]).to eq('(cd niceFolder && (echo "Some nice text!" > file.txt))')
   end
 
+  it 'should compile the steps using specific args' do
+    # Get the steps
+    steps = task.compile user: 'root',
+                         folder: {
+                           name: 'argsFolder',
+                           permission: 655
+                         }
+
+    # Assertions
+    expect(steps[0]).to eq('mkdir argsFolder/')
+    expect(steps[1]).to eq('chown -R root argsFolder')
+    expect(steps[2]).to eq('chmod -R 655 argsFolder/')
+    expect(steps[3]).to eq('(cd argsFolder && (echo "Some nice text!" > file.txt))')
+  end
+
   it 'should generate the SSH command' do
     # Command
-    command = task.command options
+    command = task.command
 
     # Assertions
     expect(command).to eq("mkdir\\ niceFolder/'\n'chown\\ -R\\ ubuntu\\ niceFolder'\n'chmod\\ -R\\ 755\\ niceFolder/'\n'\\(cd\\ niceFolder\\ \\&\\&\\ \\(echo\\ \\\"Some\\ nice\\ text\\!\\\"\\ \\>\\ file.txt\\)\\)")

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: caracara
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabriel Corado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Dockerfile
 - Gemfile
 - Gemfile.lock