caracara 0.0.0.alpha → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73d2514d4beb7b3e72836421a49f74d86609d536
-  data.tar.gz: 1d53094514ab617caa62cbad1e4b87c484a1c98e
+  metadata.gz: 22d2f961067ed99bd7e85d8c20a16393acbe22b7
+  data.tar.gz: 9f06a43d93e8d4898b4a605b785b99d1c9762daa
 SHA512:
-  metadata.gz: d6398fc70be01d80e5447c901f6341f1bcdb1c720fc29c230de3c9d3f3b6e4636c5405c9190746d1694aeac33ee7709f18ea17f3fcafdc279ce13d235459ca2b
-  data.tar.gz: f4d348856521c22e484c5ff44d68facc86f60f57c63f971528cbe30fed0ac63f73cd120a147878943d6bbefdeded841735f2b5ff3845c2bac65d749a179d80a4
+  metadata.gz: 43907c32b6f1dc51c42eb41172ea48276187c8706c8246998aa47d9099fbf1df79238c5ac0c6406e98440c090a6a46c4e985e220e06b5bf036071cd7abf5d37a
+  data.tar.gz: 4cd556a08df8ddd5d86a2b201569be30faf25bb2a17ad4a66f0af98031d69c403902ea8538119b4cea8574cf15b2cfc64892d514d69f12788d992cfccf1c6c20

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    caracara (0.0.0.pre.alpha)
+    caracara (0.1.0)
       mustache (~> 1.0)
       rake
 

data/README.md

@@ -2,29 +2,81 @@
 Task runner based on [Envoy](http://laravel.com/docs/5.1/envoy) and [Mina](http://mina-deploy.github.io/mina/)
 
 # Concepts
-**Task**: Everything is based on this entity, it has steps that are the commands that will be performed somewhere. ~~Ex: git-clone~~
-**Group**: Group of tasks that represents an business operation. ~~Ex: deploy~~
+**Task**: Everything is based on this entity, it has steps that are the commands that will be performed somewhere. *Ex: git clone*
+
+**Group**: Group of tasks that represents an business operation. *Ex: deploy*
 
 # Usage
 How to use this crazy gem.
 
-**Define a task**
+**Define some tasks**
 ```ruby
 class GitCloneTask < Caracara::Task
   # Clone the repository
-  step 'git clone {{repository}} {{dest}} --recursive'
+  step 'git clone {{repository}} {{dest}}/scm/{{version}} --recursive'
 
   # Run commands inside the repo folder
-  dir '{{dest}}' do
+  dir '{{dest}}/scm/{{version}}' do
     # Checkout to the lastest tag
     step 'git checkout {{version}}'
 
     # Remove .git/ folder
-    step ''
+    step 'rm -rf .git/'
+  end
+end
+
+class DockerTask < Caracara::Task
+  # Access new app folder
+  dir '{{dest}}/scm/{{version}}' do
+    # Build the image
+    step 'docker build -t {{image}} .'
+
+    # Remove  the current container
+    step 'docker rm -f {{container}}'
+
+    # Start it again
+    step 'docker run -d --name {{container}} {{image}}'
   end
 end
 ```
 
+**Group these tasks**
+```ruby
+class DeployGroup < Caracara::Group
+  # Clone it
+  task GitCloneTask
+
+  # Dockernize it
+  task 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',
+  dest: '/home/user/apps',
+  version: '0.0.0.alpha',
+  image: 'caracara',
+  container: 'caracara_app'
+}
+
+# Generate the SSH command
+command = deploy.command options
+```
+
+**Run the command in your server**
+```ruby
+Caracara::SSH.exec 'user', 'localhost', command
+```
+
 # Development
 * **Generating docker image**
   * `docker build -t caracara .`

data/lib/caracara/task.rb

@@ -34,9 +34,19 @@ module Caracara
       # Task steps
       attr_reader :steps
 
-      # Run commands inside a dir
-      # @TODO
-      def dir(name)
+      # Run steps inside a dir
+      def dir(name, &blk)
+        # Store the current steps and set a blank steps
+        old, @steps = @steps, nil
+
+        # Generate the block steps
+        result = yield
+
+        # Restore the old steps
+        @steps = old
+
+        # Put dir commands in the steps
+        @steps.push "(cd #{name} && (#{result.join('\n')}))"
       end
 
       # Add a step

data/lib/caracara/version.rb

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

data/spec/caracara/task_spec.rb

@@ -6,6 +6,10 @@ class TaskSpec < Caracara::Task
   step 'mkdir {{folder.name}}/'
   step 'chown -R {{user}} {{folder.name}}'
   step 'chmod -R {{folder.permission}} {{folder.name}}/'
+
+  dir '{{folder.name}}' do
+    step 'echo "{{text}}" > file.txt'
+  end
 end
 
 class TaskTwoSpec < Caracara::Task
@@ -19,6 +23,18 @@ 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!'
+    }
+  }
+
   it 'should return the steps' do
     # Get the steps
     steps = task.steps
@@ -27,23 +43,25 @@ describe 'Task' do
     expect(steps[0]).to eq('mkdir {{folder.name}}/')
     expect(steps[1]).to eq('chown -R {{user}} {{folder.name}}')
     expect(steps[2]).to eq('chmod -R {{folder.permission}} {{folder.name}}/')
+    expect(steps[3]).to eq('(cd {{folder.name}} && (echo "{{text}}" > file.txt))')
   end
 
   it 'should compile the steps' do
     # Get the steps
-    steps = task.compile user: 'ubuntu', folder: { name: 'niceFolder', permission: 755 }
+    steps = task.compile options
 
     # Assertions
     expect(steps[0]).to eq('mkdir niceFolder/')
     expect(steps[1]).to eq('chown -R ubuntu niceFolder')
     expect(steps[2]).to eq('chmod -R 755 niceFolder/')
+    expect(steps[3]).to eq('(cd niceFolder && (echo "Some nice text!" > file.txt))')
   end
 
   it 'should generate the SSH command' do
     # Command
-    command = task.command user: 'ubuntu', folder: { name: 'niceFolder', permission: 755 }
+    command = task.command options
 
     # Assertions
-    expect(command).to eq("mkdir\\ niceFolder/'\n'chown\\ -R\\ ubuntu\\ niceFolder'\n'chmod\\ -R\\ 755\\ niceFolder/")
+    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\\)\\)")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracara
 version: !ruby/object:Gem::Version
-  version: 0.0.0.alpha
+  version: 0.1.0
 platform: ruby
 authors:
 - Gabriel Corado
@@ -58,6 +58,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Dockerfile
 - Gemfile
 - Gemfile.lock
@@ -86,9 +87,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14