woro 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42dbfd98f066a125d3bc205a86f3502eadf25a7f
-  data.tar.gz: 3811dd916fa5057318865c3041d0dd78d413f599
+  metadata.gz: e496d238bdfd9af7ef5e6efb03bf657c0ea32467
+  data.tar.gz: 5285f1b393d35dc22a4f3b3365beaae5a3fddb31
 SHA512:
-  metadata.gz: a15ac0d9e69de09d860ad57b45d1abc12383a015b109d7290196cd0fb0d64ffb9c347ffef2bd188ffc59cc8ae798ff4038b4131c7d61c76a1204ea2d666a5c08
-  data.tar.gz: b089931039ce9ea2f9c3f7a19921c6f3f5787458d82f67db4ef9fdad6bcb5e5960d57b0ce8c1a15ed2887c2e282141167ffb56345ea7b70bd3e08da4eeb31fcc
+  metadata.gz: 290e81096f82aae9ecb49ab2a134e01d89efb4b8b8f08558684f00dd8032d0ba0861801884b06e2df4a9d4f4e32e0c05d7ab3a3c86872f319f7f97dd6f93cdd2
+  data.tar.gz: f1737428a46edf86bfad5d033c552ce52ae87d73c89b4b359011de6d276a9890339f82d2345918559a2d00abe55d16c43b9496ef86160e10559a5bfe23643b8d

data/README.md

@@ -2,8 +2,12 @@
 
 Write once, run once.
 
+[![Gem Version](https://img.shields.io/gem/v/woro.svg)](https://rubygems.org/gems/woro)
+[![Gem Downloads](https://img.shields.io/gem/dt/woro.svg)](https://rubygems.org/gems/woro)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/dahie/woro)
+
 Manage one-time remote tasks in your Rails project.
-Plugins with Mina and Capistrano to add support for rake tasks hosted in remote collection, such as Gist.
+Plugins with Mina and Capistrano to add support for rake tasks hosted in remote collection, such as FTP, Gist or S3.
 
 Say you have a data migration to perform on a remote server. The procedure is too complex to just do it in the remote console and using database migrations would be evil. A rake task would be nice, but checking this in with the source code repository adds clutter, as you know you will only run this once.
 Woro offers a quick way of pushing rake tasks onto the remote server, execute them and delete them instantly.
@@ -19,6 +23,8 @@ By default Woro comes with support for FTP, but additional adapters are availabl
 * [woro-gist](https://github.com/github/woro-gist)
 * [woro-s3](https://github.com/github/woro-s3)
 
+Add them as dependency to your `Gemfile` and they become available in woro.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -52,6 +58,12 @@ Gist id.
 It also creates the `lib/woro_tasks/` folder and `lib/tasks/woro.rake`.
 Here the Woro task files are stored, edited locally and run using rake.
 
+_The idea of the Woro tasks is, that these are a one time thing and are
+not required to be checked in with the repository. Therefore,
+`lib/woro_tasks/` includes a `.gitignore` file to ignore rake tasks in
+this directory._
+
+
 ### for use with Mina
 
 Require `mina/woro` in your `config/deploy.rb`:
@@ -80,6 +92,7 @@ require 'capistrano/woro'
 
 ```shell
 $ woro new cleanup_users
+$ woro create cleanup_users
 ```
 
 Can be used to create the template for a new task in `lib/woro_tasks/`.
@@ -134,8 +147,7 @@ The project classes are tested through rspec.
 $ rspec
 ```
 
-The command line interface
-is tested through cucmber/aruba.
+The command line interface is tested through cucmber/aruba.
 
 ```shell
 $ cucumber

data/bin/woro

@@ -23,47 +23,6 @@ executed by rake and cleaned up afterwards.'
 
 default_command :list
 
-def create_directory_unless_existing(directory)
-  unless File.exists? directory
-    FileUtils.mkdir_p directory
-    say "Created `#{directory}`"
-  end
-end
-
-def create_required_files
-  create_directory_unless_existing Woro::Configuration.woro_task_dir
-  create_directory_unless_existing Woro::Configuration.rake_task_dir
-  create_directory_unless_existing File.dirname(Woro::Configuration.config_file)
-
-  unless File.exists? File.join(Woro::Configuration.rake_task_dir, 'woro.rake')
-    FileUtils.cp(File.dirname(__FILE__) + '/../lib/woro/templates/woro.rake',
-                 Woro::Configuration.rake_task_dir)
-    say "Created `woro.rake` in `#{Woro::Configuration.rake_task_dir}`"
-  end
-end
-
-def woro_environment_setup?
-  File.exists?(Woro::Configuration.woro_task_dir) &&
-    File.exists?(File.join('config', 'woro.yml')) &&
-    File.exists?(Woro::Configuration.rake_task_dir) &&
-    File.exists?(File.join(Woro::Configuration.rake_task_dir, 'woro.rake'))
-end
-
-def select_choice(choices)
-  choose do |menu|
-    menu.prompt = 'Please choose a service to use with Woro:'
-    menu.choices(*choices) do |choice|
-      return choice.to_s.strip
-    end
-  end
-end
-
-def choose_and_build_adapter_config(available_adapters)
-  adapter_name = select_choice available_adapters
-  adapter = Object.const_get "Woro::Adapters::#{adapter_name}"
-  { adapter_name.downcase => adapter.setup }
-end
-
 command :init do |c|
   c.syntax      = 'woro init [options]'
   c.description = 'Initialize Woro in the current Rails directory and setup Gist collection'
@@ -72,13 +31,12 @@ command :init do |c|
     available_adapters = Woro::Adapters.constants.reject { |name| name == :Base }
     adapters = {}
     begin
-      adapters.merge! choose_and_build_adapter_config(available_adapters)
+      adapters.merge! Woro::TaskHelper.choose_and_build_adapter_config(available_adapters)
     end while agree('Do you want to configure another service?')
     options.default('adapters' => adapters )
 
-    create_required_files
-
-    config = Woro::Configuration.save(options.__hash__)
+    Woro::TaskHelper.create_required_files
+    Woro::Configuration.save(options.__hash__)
   end
 end
 
@@ -90,15 +48,15 @@ command :new do |c|
   c.example 'Creates tasks called "cleanup", "fix1" and "fix2"', 'woro new cleanup fix1 fix2'
   c.option '--[no-]force', 'force overwrite of existing task file'
   c.action do |args, options|
-    abort 'Woro environment is not set up. Call `woro init` to do so.' unless woro_environment_setup?
+    Woro::TaskHelper.check_environment
 
-    config = Woro::Configuration.load
+    Woro::Configuration.load
     force_overwrite = options.force
     args.each do |task_name|
       task = Woro::Task.new(task_name)
       if !task.exists? || force_overwrite || agree("Overwrite existing #{task.file_path}?")
         task.create_from_task_template
-        say "Created #{task.file_path}"
+        say "Created `#{task.file_path}`"
       end
     end
   end
@@ -111,7 +69,7 @@ command :push do |c|
   c.description = 'Pushes one or more local tasks to the remote collection. Existing tasks by this name in the remote connection will be updated.'
   c.example 'Pushes the task "cleanup" to the remote collection', 'woro push ftp:cleanup'
   c.action do |args, options|
-    abort 'Woro environment is not set up. Call `woro init` to do so.' unless woro_environment_setup?
+    Woro::TaskHelper.check_environment
 
     config = Woro::Configuration.load
     args.each do |arg|
@@ -125,9 +83,9 @@ command :push do |c|
       if task.exists?
         adapter = config.adapter adapter_name
         result = adapter.push(task)
-        say "Uploaded `#{task.file_path} to #{result['url']}"
+        say "Uploaded `#{task.file_path}` to #{result['url']}"
       else
-        say "Task `#{task.task_name}` not found at `#{task.file_path}`"
+        say_error "Task `#{task.task_name}` not found at `#{task.file_path}`"
       end
     end
   end
@@ -140,7 +98,7 @@ command :pull do |c|
   c.example 'Pulls the task "cleanup" from the remote collection', 'woro pull ftp:cleanup'
   c.option '--[no-]force', 'force overwrite of existing task file'
   c.action do |args, options|
-    abort 'Woro environment is not set up. Call `woro init` to do so.' unless woro_environment_setup?
+    Woro::TaskHelper.check_environment
 
     config = Woro::Configuration.load
     args.each do |arg|
@@ -153,8 +111,8 @@ command :pull do |c|
       task = Woro::Task.new(task_name)
       force_overwrite = options.force
       if !task.exists? || force_overwrite || agree("Overwrite existing #{task.file_path}?")
-        system "cd '#{config.woro_task_dir}' && curl -O -# #{adapter.raw_url(task.file_name)}"
-        say "Downloaded #{task.task_name} to #{task.file_path}"
+        system "cd '#{config.woro_task_dir}' && curl -sSO #{adapter.raw_url(task.file_name)}" # > #{task.file_path}"
+        say "Downloaded `#{task.task_name}` to `#{task.file_path}`"
       end
     end
   end
@@ -167,29 +125,8 @@ command :list do |c|
   #c.example 'List all tasks', 'woro list --all'
   #c.option '-a', '--all', 'List all tasks'
   c.action do |args, options|
-    abort 'Woro environment is not set up. Call `woro init` to do so.' unless woro_environment_setup?
-    abort "invalid command. See 'woro help' for more information" unless args.empty?
-    config = Woro::Configuration.load
-    config.adapter_settings.each do |adapter_setting|
-      say "#{adapter_setting[0]} ---"
-      adapter = config.adapter(adapter_setting[0])
-      files = adapter.list_contents || {}
-      tasks = files.map do |file_name, data|
-        if file_name.include? '.rake'
-          OpenStruct.new(name_with_args: file_name.split('.rake').first,
-                         comment: adapter.extract_description(data[:data]))
-        end
-      end
-      tasks.compact!
-      Woro::TaskHelper.print_task_list(tasks)
-    end
-    say "local ---"
-    tasks = Woro::TaskHelper.woro_task_files(config.woro_task_dir) do |file_name, data|
-      OpenStruct.new(name_with_args: file_name.split('.rake').first,
-                     comment: Woro::TaskHelper.extract_description(data))
-    end
-    Woro::TaskHelper.print_task_list(tasks)
+    Woro::TaskHelper.check_environment
+    Woro::TaskList.new(Woro::Configuration.load).fill.print
   end
 end
 alias_command :ls, :list
-

data/features/configuration.feature

@@ -20,6 +20,7 @@ Feature: Configure woro
     Please choose a service to use with Woro:
     FTP Host: FTP User: FTP Passwod: FTP Folder: |/| Do you want to configure another service?
     Created `lib/woro_tasks`
+    Created `lib/woro_tasks/.gitignore`
     Created `lib/tasks`
     Created `config`
     Created `woro.rake` in `lib/tasks`
@@ -31,6 +32,7 @@ Feature: Configure woro
       | lib/tasks           |
     And the following files should exist:
       | lib/tasks/woro.rake |
+    And the file "lib/woro_tasks/.gitignore" should contain "*.rake"
 
   Scenario: Initialize configuration (no clobber)
     Given a file named "config/woro.yml" with:

data/features/manage_tasks.feature

@@ -41,7 +41,7 @@ Feature: Manage Woro task
   Scenario: Create local task
     Given the Woro environment is set up
     When I run `woro new cleanup`
-    And the output should contain "Created lib/woro_tasks/cleanup.rake"
+    And the output should contain "Created `lib/woro_tasks/cleanup.rake`"
 
   Scenario: Push local task to remote without environment
     When I run `woro push stub:cleanup`

data/lib/woro.rb

@@ -1,6 +1,7 @@
 require 'woro/version'
 require 'woro/task_helper'
 require 'woro/task'
+require 'woro/task_list'
 require 'woro/adapters/base'
 require 'woro/adapters/ftp'
 require 'woro/configuration'

data/lib/woro/adapters/base.rb

@@ -8,7 +8,7 @@ module Woro
       # @param content [String] content of task file
       # [String] description string
       def extract_description(content)
-        Woro::TaskHelper.extract_description content
+        Woro::TaskList.extract_description content
       end
 
       # Returns the list of files included in the Gist

data/lib/woro/task.rb

@@ -10,6 +10,8 @@ module Woro
       @task_name = Woro::Task.sanitize_task_name task_name
     end
 
+    # Create new Task, creates vanilla task file in the woro
+    # task directory.
     # @param task_name [String] sanitized name of the task, used
     # throughout the further processing
     # @return [Task] the created task
@@ -24,25 +26,28 @@ module Woro
     end
 
     # File name based on the task's name.
-    # @return [String]
+    # @return [String] taskname with extension
     def file_name
       "#{task_name}.rake"
     end
 
     # File name based on the task's filename (see #file_name).
-    # @return [String]
+    # @return [String] taskname with extension and relative path
     def file_path
       File.join 'lib', 'woro_tasks', file_name
     end
 
-    # Returns true if a task of this name exists locally
+    # Returns true, if a task of this name exists locally
+    # @return [boolean] task file exists locally
     def exists?
       File.exist? file_path
     end
 
+    # Read template and inject new name
+    # @return [String] source code for new task
     def build_task_template
       b = binding
-      template = ERB.new(Woro::TaskHelper.read_template_file).result(b)
+      ERB.new(Woro::TaskHelper.read_template_file).result(b)
     end
 
     # Creates a new rake task file at the file path (see #file_path).

data/lib/woro/task_helper.rb

@@ -1,14 +1,84 @@
+require 'commander'
+
 module Woro
+  # Set of helper methods used in the woro executable
   class TaskHelper
+    include Commander::UI
     class << self
-      def print_task_list(tasks)
-        width ||= tasks.map { |t| t.name_with_args.length }.max || 10
-        tasks.each do |t|
-          puts "  %-#{width}s   # %s" % [ t.name_with_args, t.comment ]
+      # Check if woro environment is available in project
+      def check_environment
+        return if woro_environment_setup?
+        abort 'Woro environment is not set up. Call `woro init` to do so.'
+      end
+
+      # Create the given directory, unless it already exists.
+      # @param directory [String] directory to create
+      def create_directory_unless_existing(directory)
+        return if File.exist? directory
+        FileUtils.mkdir_p directory
+        say "Created `#{directory}`"
+      end
+
+      # Write a file at a given path with the given content, unless
+      # it already exists.
+      # @param file_path [String] save the new file here
+      # @param content [String] write this into the file
+      def create_file_unless_existing(file_path, content)
+        return if File.exist? file_path
+        File.open(file_path, 'w') do |f|
+          f.puts content
         end
+        say "Created `#{file_path}`"
+      end
+
+      # Creates all files required for a setup woro environment.
+      def create_required_files
+        create_directory_unless_existing Woro::Configuration.woro_task_dir
+        create_file_unless_existing File.join(Woro::Configuration.woro_task_dir, '.gitignore'), '*.rake'
+        create_directory_unless_existing Woro::Configuration.rake_task_dir
+        create_directory_unless_existing File.dirname(Woro::Configuration.config_file)
+
+        return if File.exist? File.join(Woro::Configuration.rake_task_dir, 'woro.rake')
+
+        woro_task_file = File.join(File.dirname(__FILE__),
+                                   'templates', 'woro.rake')
+        FileUtils.cp(woro_task_file, Woro::Configuration.rake_task_dir)
+        say "Created `woro.rake` in `#{Woro::Configuration.rake_task_dir}`"
+      end
+
+      # Returns true, if all requirements of a woro setup are met.
+      # @return [boolean] all configurations, all directories exist
+      def woro_environment_setup?
+        File.exist?(Woro::Configuration.woro_task_dir) &&
+          File.exist?(File.join('config', 'woro.yml')) &&
+          File.exist?(Woro::Configuration.rake_task_dir) &&
+          File.exist?(File.join(Woro::Configuration.rake_task_dir, 'woro.rake'))
+      end
+
+      # Display choice of adapter and return name of the chosen one.
+      # @param choices [Array] list of choices
+      # @return [String] Name of chosen adapter
+      def select_choice(choices, message)
+        choose do |menu|
+          menu.prompt = message
+          menu.choices(*choices) do |choice|
+            return choice.to_s.strip
+          end
+        end
+      end
+
+      # Choose adapter and return its settings.
+      # @param task_name [String] sanitized name of the task, used
+      # @return [Hash] Hash with adapter name and its settings
+      def choose_and_build_adapter_config(available_adapters)
+        adapter_name = select_choice available_adapters, 'Please choose a service to use with Woro:'
+        adapter = Object.const_get "Woro::Adapters::#{adapter_name}"
+        { adapter_name.downcase => adapter.setup }
       end
 
       # Perform an action over all files within the woro task directory
+      # @param directory [String] directory
+      # @return [Array] List of rake tasks in the directory
       def woro_task_files(directory)
         tasks = []
         Dir.foreach(directory) do |file_name|
@@ -20,19 +90,10 @@ module Woro
         tasks
       end
 
-      # Extract description from gist's data content string.
-      # @param data [Hash] gist data hash
-      # [String] description string
-      def extract_description(task_content)
-        # regex from http://stackoverflow.com/questions/171480/regex-grabbing-values-between-quotation-marks
-        match = task_content.match(/desc (["'])((?:(?!\1)[^\\]|(?:\\\\)*\\[^\\])*)\1/)
-        match && match[2] || 'No description'
-      end
-
       # Read the rake task template
-      # @return [String]
+      # @return [String] Content of template file
       def read_template_file
-        File.read(File.join(File.dirname(__FILE__), 'templates','task.rake.erb') )
+        File.read File.join(File.dirname(__FILE__), 'templates', 'task.rake.erb')
       end
     end
   end

data/lib/woro/task_list.rb

@@ -0,0 +1,82 @@
+require 'ostruct'
+require 'commander'
+include Commander::UI
+
+module Woro
+  # Generates the list of all tasks for printout to console.
+  class TaskList
+    attr_reader :config, :list
+
+    def initialize(config)
+      @config = config
+      @list = []
+    end
+
+    # Determine the max count of characters for all task names.
+    # @return [integer] count of characters
+    def width
+      @width ||= list.map { |t| t.name_with_args ? t.name_with_args.length : 0 }.max || 10
+    end
+
+    # Fill task list by loading tasks from the configured adapters and locally.
+    # @return [Object] task_list
+    def fill
+      fill_list_from_adapters
+      fill_list_from_local
+      self
+    end
+
+    # Print the current task list to console.
+    def print
+      list.each do |entry|
+        entry.headline ? print_headline(entry) : print_task_description(entry)
+      end
+    end
+
+    # Extract description from gist's data content string.
+    # @param data [Hash] gist data hash
+    # [String] description string
+    def self.extract_description(task_content)
+      # regex from http://stackoverflow.com/questions/171480/regex-grabbing-values-between-quotation-marks
+      match = task_content.match(/desc (["'])((?:(?!\1)[^\\]|(?:\\\\)*\\[^\\])*)\1/)
+      match && match[2] || 'No description'
+    end
+
+    protected
+
+    def fill_list_from_local
+      list << OpenStruct.new(headline: 'local')
+      Woro::TaskHelper.woro_task_files(config.woro_task_dir) do |file_name, data|
+        list << OpenStruct.new(name_with_args: file_name.split('.rake').first,
+                       comment: Woro::TaskList.extract_description(data))
+      end
+    end
+
+    def fill_list_from_adapters
+      adapter_settings.each do |adapter_setting|
+        list << OpenStruct.new(headline: adapter_setting[0])
+        adapter = config.adapter(adapter_setting[0])
+        files = adapter.list_contents || {}
+        files.map do |file_name, data|
+          if file_name.include? '.rake'
+            list << OpenStruct.new(name_with_args: file_name.split('.rake').first,
+                           comment: adapter.extract_description(data[:data]))
+          end
+        end
+        list.compact!
+      end
+    end
+
+    def adapter_settings
+      config.adapter_settings
+    end
+
+    def print_headline(headline)
+      say "#{headline.headline} ---"
+    end
+
+    def print_task_description(task)
+      say "  %-#{width}s   # %s" % [task.name_with_args, task.comment]
+    end
+  end
+end

data/lib/woro/tasks/capistrano.rake

@@ -17,7 +17,7 @@ namespace :woro do
 
         info "Execute #{task.task_name} remotely"
         within File.join(release_path, 'lib', 'tasks') do
-          execute :curl, "'#{adapter.raw_url(task.file_name)}'",  '-o', "woro_#{task.file_name}"
+          execute :curl, '-sS', "'#{adapter.raw_url(task.file_name)}'",  '-o', "woro_#{task.file_name}"
         end
         within release_path do
           with rails_env: fetch(:rails_env) do

data/lib/woro/tasks/mina.rake

@@ -15,7 +15,7 @@ namespace :woro do
     task = Woro::Task.new(task_name)
     print_status "Execute #{task.task_name} remotely"
     in_directory "#{app_path}" do
-      queue! "curl '#{adapter.raw_url(task.file_name)}' -o lib/tasks/woro_#{task.file_name}"
+      queue! "curl -sS '#{adapter.raw_url(task.file_name)}' -o lib/tasks/woro_#{task.file_name}"
       queue! "#{bundle_prefix} rake woro:#{task.task_name}"
       queue! "rm lib/tasks/woro_#{task.file_name}"
     end

data/lib/woro/version.rb

@@ -1,4 +1,4 @@
 module Woro
   # Look shiny!
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woro
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Senff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -162,6 +162,7 @@ files:
 - lib/woro/configuration.rb
 - lib/woro/task.rb
 - lib/woro/task_helper.rb
+- lib/woro/task_list.rb
 - lib/woro/tasks/capistrano.rake
 - lib/woro/tasks/mina.rake
 - lib/woro/templates/task.rake.erb
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Write once, run once. One-time migration task management on remote servers