woro 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75b1dc32f7678a48ddcf20ed57e8bca9a45720cd
-  data.tar.gz: 05f70abe96bb421cd6f7ff3475ee0330be4cc705
+  metadata.gz: b95b362f677b55672cbf3f6fd70ee7b1d66551af
+  data.tar.gz: 2be0c9ad7365d1c755d1d2b24dbfab13c2b88f50
 SHA512:
-  metadata.gz: cbd306d0f3705f4178739df38caccf4f0c534c6043c84662a6444d0ecbda0cb4a6e7d7f8897119bccaccbe3ba9a6cce5425fa77d53ef1178ad698120a875611e
-  data.tar.gz: dcad5e23785352f4fcf5a57a25e8b9ec2ef240fa940cda8fe26c5d47716b6908ddbb2e88bb18b32242f001cfa27d15cdb6b40f2b8fa7d1372b1cd6d1dd9eda9b
+  metadata.gz: db55fd8f7bbee3528608990b764da0d6747492087bc94fae475bd5f8cd4d5634913bd73658fc8a44289ad20d920bb6ea561de61e26a5fb33a231095b2cb4118e
+  data.tar.gz: 4aed67765b981c0f2ff6da55a2c06f8f2aadd33f8c935ac236920244ec605280e80ab749a9523b0d3f2668c9647c1f385d0a15403e5d106be09e4cce9e029773

data/README.md

@@ -38,7 +38,11 @@ Then run:
 $ woro init
 ```
 
-This will create `lib/woro_tasks/` folder and `lib/tasks/woro.rake`.
+This creates the `woro.yml` in the `config/` folder. This configuration
+stores the settings of the available remote collection adapters, eg the
+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.
 
 ### for use with Mina
@@ -115,6 +119,21 @@ And finally you can download an existing task to your local woro tasks directory
 $ woro pull gist:cleanup_users
 ```
 
+## Testing
+
+The project classes are tested through rspec.
+
+```shell
+$ rspec
+```
+
+The command line interface
+is tested through cucmber/aruba.
+
+```shell
+$ cucumber
+```
+
 ## Contributing
 
 1. Fork it

data/bin/woro

@@ -24,6 +24,31 @@ 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
+
+  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
+
 command :init do |c|
   c.syntax      = 'woro init [options]'
   c.description = 'Initialize Woro in the current Rails directory and setup Gist collection'
@@ -39,7 +64,12 @@ command :init do |c|
 
     # create Gist with welcome file
     # additional tasks will be added to this first gist
-    app_name = ask 'Application name: '
+    begin
+      require File.join(Dir.pwd, 'config', 'application.rb')
+      app_name = Rails.application.class.parent_name
+    rescue LoadError
+      app_name = ask('Application name: ')
+    end
     result = Woro::Adapters::Gist.create_initial_remote_task(app_name)
 
     # configure adapters
@@ -51,30 +81,23 @@ command :init do |c|
     unless File.exists? File.dirname(Woro::Configuration.config_file)
       FileUtils.mkdir_p File.dirname(Woro::Configuration.config_file)
     end
-    say 'Initialized at `./config/woro.yml`'
 
     options.default(adapters: { gist: gist_adapter } )
     config = Woro::Configuration.save(options.__hash__)
-
-    unless File.exists? config.woro_task_dir
-      FileUtils.mkdir_p config.woro_task_dir
-      say "Create #{config.woro_task_dir}"
-    end
-
-    say "Create woro.rake in #{config.rake_task_dir}"
-    FileUtils.mkdir_p config.rake_task_dir if !File.exists? config.rake_task_dir
-    FileUtils.cp(File.dirname(__FILE__) + '/../lib/woro/templates/woro.rake', config.rake_task_dir)
+    create_required_files
   end
 end
 
 command :new do |c|
-  c.syntax      = 'woro create <task> [options]'
+  c.syntax      = 'woro new <task> [options]'
   c.summary     = 'Create new tasks'
   c.description = 'Creates one or more new templated Rake tasks'
   c.example 'Create task called "cleanup"', 'woro new cleanup'
   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?
+
     config = Woro::Configuration.load
     force_overwrite = options.force
     args.each do |task_name|
@@ -93,6 +116,8 @@ 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 cleanup'
   c.action do |args, options|
+    abort 'Woro environment is not set up. Call `woro init` to do so.' unless woro_environment_setup?
+
     config = Woro::Configuration.load
     args.each do |arg|
       unless arg.include?(':')
@@ -120,6 +145,8 @@ command :pull do |c|
   c.example 'Pulls the task "cleanup" from the remote collection', 'woro pull gist: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?
+
     config = Woro::Configuration.load
     args.each do |arg|
       unless arg.include?(':')
@@ -145,6 +172,7 @@ 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.adapters.each do |adapter_config|

data/features/configuration.feature

@@ -0,0 +1,35 @@
+Feature: Configure woro
+  In order to use woro
+  As a user
+  I want a sane default configuration for my system
+  and a data file to store my tasks
+
+  # TODO Scenario: Initialize configuration with Rails environment
+
+  Scenario: Initialize configuration without Rails environment
+    When I run `woro init` interactively
+    And I type "n\n"
+    And I type "Rails-project\n"
+    Then the output should contain "Initialized config file in `config/woro.yml`"
+    And the following files should exist:
+      | config/woro.yml   |
+
+  Scenario: Initialize configuration (no clobber)
+    Given a file named "config/woro.yml" with:
+      """
+      hello world
+      """
+    When I run `woro init` interactively
+    And I type "n\n"
+    And I type "Rails-project\n"
+    Then the output should contain "Not overwriting existing config file"
+
+  Scenario: Force initialize configuration (clobber)
+    Given a file named "config/woro.yml" with:
+      """
+      hello world
+      """
+    When I run `woro init --force` interactively
+    And I type "n\n"
+    And I type "Rails-project\n"
+    Then the file "config/woro.yml" should not contain "hello world"

data/features/manage_tasks.feature

@@ -0,0 +1,53 @@
+Feature: Manage Woro task
+  In order to manage tasks
+  As a user
+  I want to create, push and list tasks
+
+  Scenario: Execute woro without parameters without environment
+    When I run `woro`
+    Then the output should contain "Woro environment is not set up. Call `woro init` to do so."
+
+  Scenario: Execute woro without parameters
+    Given the Woro environment is set up
+    And I run `woro`
+    Then the output should contain exactly:
+    """
+    local ---
+
+    """
+
+
+  Scenario: List tasks without environment setup
+    Given I run `woro list`
+    Then the output should contain "Woro environment is not set up. Call `woro init` to do so."
+
+   Scenario: List tasks
+    Given the Woro environment is set up
+    And a file named "config/woro.yml" with:
+      """
+      adapters:
+
+      """
+    And I run `woro list`
+    Then the output should contain exactly:
+    """
+    local ---
+
+    """
+
+  Scenario: Create local task without environment
+    When I run `woro new cleanup`
+    Then the output should contain "Woro environment is not set up. Call `woro init` to do so."
+
+  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"
+
+  Scenario: Push local task to remote without environment
+    When I run `woro push stub:cleanup`
+    Then the output should contain "Woro environment is not set up. Call `woro init` to do so."
+
+  Scenario: Pull local task to remote without environment
+    When I run `woro pull stub:cleanup`
+    Then the output should contain "Woro environment is not set up. Call `woro init` to do so."

data/features/step_definitions/woro_steps.rb

@@ -0,0 +1,20 @@
+require 'woro'
+
+Given /^the following tasks:$/ do |table|
+  data = table.raw
+  table.raw.each do |task|
+    steps %Q{
+      When I run `pomo add '#{task.first}'`
+    }
+  end
+end
+
+Given /^the Woro environment is set up$/ do
+  create_dir Woro::Configuration.woro_task_dir
+  create_dir Woro::Configuration.rake_task_dir
+
+  write_file(File.join(Woro::Configuration.rake_task_dir, 'woro.rake'),
+             File.read(File.dirname(__FILE__) + '/../../lib/woro/templates/woro.rake') )
+  write_file(File.join('config', 'woro.yml'),
+             { adapters: {} }.to_yaml)
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+require "aruba/cucumber"
+require 'cucumber/rspec/doubles'
+
+Before do
+  allow(Gist).to receive(:multi_gist).and_return({ 'id' => '1234'})
+end
+
+After do
+  restore_env
+end

data/lib/woro/configuration.rb

@@ -9,7 +9,7 @@ module Woro
     # Initialize configuration.
     def initialize(options = {})
       @woro_task_dir = Configuration.woro_task_dir
-      @adapters = options[:adapters]
+      @adapters = options[:adapters] || {}
       @app_name = options[:app_name]
     end
 
@@ -19,7 +19,7 @@ module Woro
 
       if !(File.exists? config_file)
         File.open(config_file, 'w') { |file| YAML.dump(default_options, file) }
-        say "Initialized default config file in #{config_file}. See 'woro help init' for options."
+        say "Initialized default config file in `#{config_file}`. See 'woro help init' for options."
       end
 
       config_file_options = YAML.load_file(config_file)
@@ -32,10 +32,12 @@ module Woro
       force_save = options.delete :force
 
       if !(File.exists? config_file) || force_save
-        File.open(config_file, 'w') { |file| YAML.dump(default_options.merge(user_options), file) }
-        say "Initialized config file in #{config_file}"
+        File.open(config_file, 'w') do |file|
+          YAML.dump(default_options.merge(user_options), file)
+        end
+        say "Initialized config file in `#{config_file}`"
       else
-        say_error "Not overwriting existing config file #{config_file}, use --force to override. See 'woro help init'."
+        say_error "Not overwriting existing config file `#{config_file}`, use --force to override. See 'woro help init'."
       end
       self
     end

data/lib/woro/task.rb

@@ -39,21 +39,16 @@ module Woro
       File.exist? file_path
     end
 
-    # Creates a new rake task file at the file path (see #file_path).
-    def create_from_task_template
+    def build_task_template
       b = binding
       template = ERB.new(Woro::TaskHelper.read_template_file).result(b)
-      File.open(file_path, 'w') do |f|
-        f.puts template
-      end
     end
 
-    # Requests the content of the task file within the Gist collection
-    # from the server.
-    # @return [String]
-    def retrieve_raw_file
-      response = Net::HTTP.get_response(raw_url)
-      response.body
+    # Creates a new rake task file at the file path (see #file_path).
+    def create_from_task_template
+      File.open(file_path, 'w') do |f|
+        f.puts build_task_template
+      end
     end
 
     # Read the content of the local rake task file on #file_path.

data/lib/woro/task_helper.rb

@@ -32,7 +32,7 @@ module Woro
       # Read the rake task template
       # @return [String]
       def read_template_file
-        File.read(File.join(File.dirname(__FILE__), 'templates','task.rake') )
+        File.read(File.join(File.dirname(__FILE__), 'templates','task.rake.erb') )
       end
     end
   end

data/lib/woro/version.rb

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

data/spec/fixtures/{fresh_template.yml → cleanup.rake}

@@ -1,6 +1,6 @@
 namespace :woro do
   desc 'Write your description here'
-  task <%= task_name %>: :environment do
+  task cleanup: :environment do
     # your code
   end
 end

data/spec/lib/woro/configuration_spec.rb

@@ -18,7 +18,7 @@ describe Woro::Configuration do
     context 'not given a configuration file' do
       it 'returns Configuration object with default options' do
         config = Woro::Configuration.load
-        expect(config.adapters).to be_falsy
+        expect(config.adapters).to eq({})
         expect(config.app_name).to be_falsy
       end
 

data/spec/lib/woro/task_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 describe Woro::Task do
-
   subject { Woro::Task.new('cleanup_task') }
 
   describe '#create_from_task_template' do
     it 'creates new file' do
       FakeFS.deactivate!
-      example_path = File.join('spec', 'fixtures','fresh_template.yml')
+      example_path = File.join('spec', 'fixtures', 'cleanup.rake')
       fresh_template_body = File.read example_path
+      allow(Woro::TaskHelper).to receive(:read_template_file).and_return fresh_template_body
       FakeFS.activate!
       subject.create_from_task_template
-      expect(File.read(Woro::Task.file_path)).to eq fresh_template_body
+      expect(File.read(subject.file_path)).to eq fresh_template_body
     end
   end
 

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'pry'
 require 'woro'
 require 'fakefs/safe'
-require 'aws-sdk-v1'
 
 Dir[('./spec/support/**/*.rb')].each {|f| require f}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woro
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Senff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gist
@@ -164,6 +164,10 @@ files:
 - README.md
 - Rakefile
 - bin/woro
+- features/configuration.feature
+- features/manage_tasks.feature
+- features/step_definitions/woro_steps.rb
+- features/support/env.rb
 - lib/capistrano/woro.rb
 - lib/mina/woro.rb
 - lib/woro.rb
@@ -173,10 +177,10 @@ files:
 - lib/woro/task_helper.rb
 - lib/woro/tasks/capistrano.rake
 - lib/woro/tasks/mina.rake
-- lib/woro/templates/task.rake
+- lib/woro/templates/task.rake.erb
 - lib/woro/templates/woro.rake
 - lib/woro/version.rb
-- spec/fixtures/fresh_template.yml
+- spec/fixtures/cleanup.rake
 - spec/fixtures/gist.json
 - spec/lib/woro/adapters/gist_spec.rb
 - spec/lib/woro/configuration_spec.rb
@@ -209,7 +213,11 @@ specification_version: 4
 summary: Write once, run once. One-time migration task management on remote servers
   through mina.
 test_files:
-- spec/fixtures/fresh_template.yml
+- features/configuration.feature
+- features/manage_tasks.feature
+- features/step_definitions/woro_steps.rb
+- features/support/env.rb
+- spec/fixtures/cleanup.rake
 - spec/fixtures/gist.json
 - spec/lib/woro/adapters/gist_spec.rb
 - spec/lib/woro/configuration_spec.rb