voog-kit 0.1.8

data/lib/voog/dtk/guard.rb

@@ -0,0 +1,147 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/plugin'
+
+module Guard
+  class Shell < Guard
+    VERSION = '0.5.2'
+
+    # Calls #run_all if the :all_on_start option is present.
+    def start
+      run_all if options[:all_on_start]
+    end
+
+    # Call #run_on_change for all files which match this guard.
+    def run_all
+      run_on_modifications(Watcher.match_files(self, Dir.glob('{,**/}*{,.*}').uniq))
+    end
+
+    # Print the result of the command(s), if there are results to be printed.
+    def run_on_modifications(res)
+      puts res if res
+    end
+  end
+end
+
+module Voog::Dtk
+  class ::Guard::Watchman < ::Guard::Plugin
+    attr_accessor :options, :filemanager
+
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    #
+    def initialize(options = {})
+      super
+      @options = options
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+      ::Guard::UI.info 'Guard::Voog is running'
+      # run_all
+    end
+
+    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+    #
+    # @raise [:task_has_failed] when stop has failed
+    # @return [Object] the task result
+    #
+    def stop
+      ::Guard::UI.info 'Guard::Voog stopped'
+    end
+
+    # Called when `reload|r|z + enter` is pressed.
+    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
+    #
+    # @raise [:task_has_failed] when reload has failed
+    # @return [Object] the task result
+    #
+    # def reload
+    # end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    # def run_all
+    # end
+
+    # Default behaviour on file(s) changes that the Guard plugin watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    # @return [Object] the task result
+    #
+    # def run_on_changes(paths)
+    # end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    #
+    def run_on_additions(paths)
+      @filemanager.add_to_manifest paths
+      @filemanager.upload_files paths
+    rescue => e
+      @filemanager.notifier.newline
+      Voog::Dtk.handle_exception e, @filemanager.notifier
+    end
+
+    # Called on file(s) removals that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_removals has failed
+    # @return [Object] the task result
+    #
+    def run_on_removals(paths)
+      @filemanager.remove_from_manifest paths
+      # @filemanager.delete_remote_files paths
+    rescue => e
+      @filemanager.notifier.newline
+      Voog::Dtk.handle_exception e, @filemanager.notifier
+    end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    #
+    def run_on_modifications(paths)
+      @filemanager.upload_files paths
+      @filemanager.notifier.newline
+    rescue => e
+      @filemanager.notifier.newline
+      Voog::Dtk.handle_exception e, @filemanager.notifier
+    end
+  end
+
+  class Guuard
+    def initialize(filemanager)
+      @filemanager = filemanager
+    end
+
+    def run
+      guardfile = <<-EOF
+        guard 'watchman' do
+          watch(%r{^(layout|component|image|asset|javascript|stylesheet)s/.*})
+        end
+      EOF
+
+      ::Guard.start(guardfile_contents: guardfile)
+      ::Guard.guards('watchman').first.filemanager = @filemanager
+    end
+  end
+end

data/lib/voog/dtk/notifier.rb

@@ -0,0 +1,34 @@
+require 'colorize'
+
+module Voog::Dtk
+  class Notifier
+    def initialize(output=$stderr, silent=false)
+      @output = output
+      @silent = silent
+    end
+
+    def normal(message)
+      @output.print(message) unless @silent
+    end
+
+    def info(message)
+      @output.print(message.white + ' ') unless @silent
+    end
+
+    def success(message)
+      @output.print(message.green) unless @silent
+    end
+
+    def error(message)
+      @output.print(message.red) unless @silent
+    end
+
+    def warning(message)
+      @output.print(message.yellow) unless @silent
+    end
+
+    def newline
+      @output.print("\n") unless @silent
+    end
+  end
+end

data/lib/voog/dtk/version.rb

@@ -0,0 +1,5 @@
+module Voog
+  module Dtk
+    VERSION = '0.1.8'
+  end
+end

data/lib/voog/dtk.rb

@@ -0,0 +1,131 @@
+require 'voog/dtk/version'
+require 'parseconfig'
+require 'prettyprint'
+
+module Voog
+  module Dtk
+
+    CONFIG_FILENAME = '.voog'
+
+    class << self
+      def config_exists?(filename=CONFIG_FILENAME)
+        filename && !filename.empty? && File.exists?(filename)
+      end
+
+      def global_config_exists?(filename=CONFIG_FILENAME)
+        filename && !filename.empty? && File.exists?([ENV['HOME'], filename].join('/'))
+      end
+
+      def read_config(block = nil, file = CONFIG_FILENAME)
+        config = {
+          :host => nil,
+          :api_token => nil
+        }
+        local_config = config_exists?(file) ? ParseConfig.new(File.expand_path(file)).params : {}
+        global_config = global_config_exists?(file) ? ParseConfig.new(File.expand_path([ENV['HOME'], file].join('/'))).params : {}
+
+        options = global_config.merge(local_config)
+
+        unless options.empty?
+          @block = if block.nil?
+            options.keys.first
+          else
+            if options.key?(block)
+              block
+            else
+              fail "Site '#{block}' not found in the configuration file!".red
+            end
+          end
+
+          config[:host] = options[@block].fetch("host")
+          config[:api_token] = options[@block].fetch("api_token")
+        end
+        config
+      end
+
+      def write_config(host, api_token, block, silent=false)
+        @file = if config_exists?
+          CONFIG_FILENAME
+        elsif global_config_exists?
+          [ENV['HOME'], CONFIG_FILENAME].join('/')
+        else
+          File.new(CONFIG_FILENAME)
+          CONFIG_FILENAME
+        end
+
+        options = ParseConfig.new(File.expand_path(@file))
+
+        if options.params.key?(block)
+          puts "Writing new configuration options to existing config block.".white unless silent
+          options.params[block]['host'] = host unless host.empty?
+          options.params[block]['api_token'] = api_token unless api_token.empty?
+        else
+          puts "Writing configuration options to new config block.".white unless silent
+          options.params[block] = {
+            'host' => host,
+            'api_token' => api_token
+          }
+        end
+
+        File.open(@file, 'w+') do |file|
+          file.truncate(0)
+          file << "\n"
+          options.params.each do |param|
+            file << "[#{param[0]}]\n"
+            param[1].keys.each do |key|
+              file << "  #{key}=#{param[1][key]}\n"
+            end
+            file << "\n"
+          end
+        end
+      end
+
+      def is_api_error?(exception)
+        [
+          Faraday::ClientError,
+          Faraday::ConnectionFailed,
+          Faraday::ParsingError,
+          Faraday::TimeoutError,
+          Faraday::ResourceNotFound
+        ].include? exception.class
+      end
+
+      def print_debug_info(exception)
+        puts
+        puts "Exception: #{exception.class}"
+        if is_api_error?(exception) && exception.respond_to?(:response) && exception.response
+          pp exception.response
+        end
+        puts exception.backtrace
+      end
+
+      def handle_exception(exception, debug, notifier=nil)
+        error_msg = if is_api_error?(exception)
+          if exception.respond_to?(:response) && exception.response
+            if exception.response.fetch(:headers, {}).fetch(:content_type, '') =~ /application\/json/
+              body = JSON.parse(exception.response.fetch(:body))
+              "#{body.fetch('message', '')} #{("Errors: " + body.fetch('errors', '').inspect) if body.fetch('errors', nil)}".red
+            else
+              exception.response.fetch(:body)
+            end + "(error code #{exception.response[:status]})".red
+          else
+            "#{exception}"
+          end
+        else
+          "#{exception}"
+        end
+
+        if notifier
+          notifier.newline
+          notifier.error error_msg
+          notifier.newline
+        else
+          puts error_msg
+        end
+        print_debug_info(exception) if debug
+      rescue => e
+        handle_exception e, debug, notifier
+      end
+    end
+  end
+end

data/spec/fixtures/.voog

@@ -0,0 +1,3 @@
+[OPTIONS]
+  host=voog.local
+  api_token=afcf30182aecfc8155d390d7d4552d14

data/spec/fixtures/.voog2

@@ -0,0 +1,7 @@
+[default]
+  host=voog.local
+  api_token=afcf30182aecfc8155d390d7d4552d14
+
+[testblock]
+  host=test.host
+  api_token=123

data/spec/fixtures/layout.json

@@ -0,0 +1,12 @@
+{
+  "id": 14, 
+  "parent_id": null, 
+  "title": "Test", 
+  "layout_name": "component", 
+  "content_type": "component", 
+  "component": true, 
+  "url": "http://voog.local/admin/api/layouts/14", 
+  "created_at": "2010-09-09 14:24:43 UTC", 
+  "updated_at": "2010-09-14 14:49:51 UTC", 
+  "body": "test body"
+}

data/spec/fixtures/layout_asset.json

@@ -0,0 +1,15 @@
+{
+  "id": 22, 
+  "filename": "test.css", 
+  "asset_type": "stylesheet", 
+  "content_type": "text/css", 
+  "size": 180, 
+  "width": null, 
+  "height": null, 
+  "editable": true, 
+  "url": "http://voog.local/admin/api/layout_assets/22", 
+  "public_url": "http://localhost/stylesheets/test.css", 
+  "created_at": "2010-09-09 15:03:06 UTC", 
+  "updated_at": "2010-09-16 14:19:28 UTC", 
+  "data": "test data"
+}

data/spec/fixtures/layout_assets.json

@@ -0,0 +1,7 @@
+[
+  {
+    "asset_type": "image",
+    "content_type": "image/png",
+    "filename": "bullet.png"
+  }
+]

data/spec/fixtures/layouts.json

@@ -0,0 +1,9 @@
+[
+  {
+    "title": "test layout",
+    "layout_name": "",
+    "component": "true",
+    "content_type": "component",
+    "file": "components/test_layout.tpl"
+  }
+]

data/spec/fixtures/manifest.json

@@ -0,0 +1,17 @@
+{
+  "layouts": [
+    {
+      "component": true,
+      "content_type": "component",
+      "file": "test_component.tpl",
+      "layout_name": "test_component",
+      "title": "test_component"
+    }
+  ],
+  "assets": [{
+    "content_type": "application/javascript",
+    "kind": "javascripts",
+    "file": "javascripts/test.js",
+    "filename": "test.js"
+  }]
+}

data/spec/models/dtk/config_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Voog::Dtk do
+
+  describe '.read_config' do
+
+    context 'when a config file is provided' do
+
+      let(:config) { Voog::Dtk.read_config nil, 'spec/fixtures/.voog' }
+
+      it 'api_token should be exactly as configured' do
+        expect(config[:api_token]).to eq('afcf30182aecfc8155d390d7d4552d14')
+      end
+
+      it 'host should be exactly as configured' do
+        expect(config[:host]).to eq('voog.local')
+      end
+
+      context 'when there are multiple blocks' do
+        let(:block1) { Voog::Dtk.read_config nil, 'spec/fixtures/.voog2' }
+        let(:block2) { Voog::Dtk.read_config 'testblock', 'spec/fixtures/.voog2' }
+
+        it 'should default to the first one if block is not provided' do
+          expect(block1[:host]).to eq('voog.local')
+        end
+
+        it 'should read the correct options when a block is provided' do
+          expect(block2[:api_token]).to eq('123')
+        end
+
+        it 'should fail when a non-existant block is provided' do
+          expect{
+            block3 = Voog::Dtk.read_config 'wrongname', 'spec/fixtures/.voog2'
+          }.to raise_error
+        end
+      end
+
+    end
+
+    context 'when the provided filename is empty' do
+
+      let(:config) { Voog::Dtk.read_config nil, '' }
+
+      it 'api_token should be nil' do
+        expect(config[:api_token]).to eq(nil)
+      end
+
+      it 'host should be nil' do
+        expect(config[:host]).to eq(nil)
+      end
+
+    end
+
+    context 'when a filename is not provided' do
+
+      let(:config) { Voog::Dtk.read_config nil, nil }
+
+      it 'api_token should be nil' do
+        expect(config[:api_token]).to eq(nil)
+      end
+
+      it 'host should be nil' do
+        expect(config[:host]).to eq(nil)
+      end
+
+    end
+
+    context 'when the provided filename is invalid' do
+
+      let(:config) { Voog::Dtk.read_config nil, 'foo.bar' }
+
+      it 'api_token should be nil' do
+        expect(config[:api_token]).to eq(nil)
+      end
+
+      it 'host should be nil' do
+        expect(config[:host]).to eq(nil)
+      end
+
+    end
+  end
+end