codefumes 0.1.10 → 0.2.0

data/config/website.yml

@@ -0,0 +1,2 @@
+host: tomkersten@rubyforge.org
+remote_dir: /var/www/gforge-projects/codefumes

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --format pretty features
+html_report: --format progress --format html --out=features_report.html features

data/features/claiming_a_project.feature

@@ -0,0 +1,46 @@
+Feature: Claiming a project
+  As the owner of a project, if I have decided I want to use the CodeFumes
+  service, I don't want to have to remember the public key for my project(s).
+  The gem must provide a simple method of "claiming" a project and associating
+  it with an account.
+
+
+  Scenario: Specified project does not exist on CodeFumes.com
+    Given valid user credentials have been stored in the CodeFumes config file
+    When I run "#{@bin_path}/fumes claim -p bad-public-key"
+    Then the output should contain "Not Found"
+    And the exit status should be 0
+
+  Scenario: Attempting to claim a project without having an API key entry in the CodeFumes config file
+    Given I have cloned and synchronized 1 project
+    When I claim the project
+    Then the output should contain instructions about storing your API key
+    And the exit status should be 3
+
+  Scenario: Attempting to claim a project with an invalid API key entry in the user's CodeFumes config file
+    Given invalid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 1 project
+    When I claim the project
+    Then the output should contain "Denied"
+    And the exit status should be 0
+
+  Scenario: Claim a project using the key stored in a CodeFumes project directory
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 1 project
+    When I claim the project
+    Then the output should contain "Success"
+    And the exit status should be 0
+
+  Scenario: Claiming one of multiple projects in your CodeFumes config file
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 2 projects
+    When I claim the 1st project
+    Then the output should contain 1 successful claim message
+    And the exit status should be 0
+
+  Scenario: Claim all projects in your CodeFumes config file
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 2 projects
+    And I run "#{@bin_path}/fumes claim -a"
+    Then the output should contain 2 successful claim messages
+    And the exit status should be 0

data/features/deleting_a_project.feature

@@ -0,0 +1,32 @@
+Feature: Deleting a project
+  The process of deleting a project must be both
+  available and simple in order to reduce the number
+  of barriers to testing out the service.
+
+
+  Scenario: The specified project does not exist on CodeFumes.com
+    When I run "#{@bin_path}/fumes delete -p bad-public-key"
+    Then the output should contain "Not Found"
+    And the exit status should be 0
+
+  Scenario: Attempting to delete a project without having an API key entry in the CodeFumes config file
+    Given I have cloned and synchronized 1 project
+    And I have claimed the project
+    When I delete the project
+    Then the output should contain 1 successful delete messages
+    And the exit status should be 0
+
+  Scenario: Deleting one of multiple projects in your CodeFumes config file
+    Given I have cloned and synchronized 2 projects
+    And I have claimed the 1st project
+    When I delete the 1st project
+    Then the output should contain 1 successful delete messages
+    And the exit status should be 0
+
+  Scenario: Releasing all projects in your CodeFumes config file
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 2 projects
+    And I run "#{@bin_path}/fumes claim -a"
+    When I run "#{@bin_path}/fumes delete -a"
+    Then the output should contain 2 successful delete messages
+    And the exit status should be 0

data/features/releasing_a_project.feature

@@ -0,0 +1,50 @@
+Feature: Claiming a project
+  As the owner of a project, the process of relinquishing ownership
+  of a project must be both available and simple.
+
+
+  Scenario: Specified project does not exist on CodeFumes.com
+    Given valid user credentials have been stored in the CodeFumes config file
+    When I run "#{@bin_path}/fumes release -p bad-public-key"
+    Then the output should contain "Not Found"
+    And the exit status should be 0
+
+  Scenario: Attempting to claim a project without having an API key entry in the CodeFumes config file
+    And I have cloned and synchronized 1 project
+    And I have claimed the project
+    When I release the project
+    Then the output should contain instructions about storing your API key
+    And the exit status should be 3
+
+  Scenario: Attempting to release a project with an invalid API key entry in the user's CodeFumes config file
+    Given invalid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 1 project
+    And I have claimed the project
+    And invalid user credentials have been stored in the CodeFumes config file
+    When I release the project
+    Then the output should contain "Denied"
+    And the exit status should be 0
+
+  Scenario: Releasing a project using the key stored in a CodeFumes project directory
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 1 project
+    And I have claimed the project
+    When I release the project
+    Then the output should contain "Success"
+    And the exit status should be 0
+
+  Scenario: Releasing one of multiple projects in your CodeFumes config file
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 2 projects
+    And I have claimed the 1st project
+    When I release the 1st project
+    Then the output should contain 1 successful release message
+    And the exit status should be 0
+
+  Scenario: Releasing all projects in your CodeFumes config file
+    Given valid user credentials have been stored in the CodeFumes config file
+    And I have cloned and synchronized 2 projects
+    And I run "#{@bin_path}/fumes claim -a"
+    When I run "#{@bin_path}/fumes release -a"
+    Then the output should contain 2 successful release messages
+    And the exit status should be 0

data/features/step_definitions/cli_steps.rb

@@ -0,0 +1,98 @@
+# still a super-hack...but at least it's not duplicated, right?
+# ...
+# ...right?
+def output_message_qty(action)
+  combined_output.scan(/#{action}\.\.\.'.*': Success/).count
+end
+
+def clone_fixture_repo_into(dir_name)
+  Given "I run \"git clone git@github.com:cosyn/git_fixture_repository.git #{dir_name}\""
+end
+
+# TODO: Get a better way of testing this...output is horrible
+Then /^the output should contain (\d+) successful claim message[s]?$/ do |count|
+  output_message_qty("Claiming").should == count.to_i
+end
+
+# TODO: Get a better way of testing this...output is horrible
+Then /^the output should contain (\d+) successful release message[s]?$/ do |count|
+  output_message_qty("Releasing").should == count.to_i
+end
+
+# TODO: Get a better way of testing this...output is horrible
+Then /^the output should contain (\d+) successful delete message[s]?$/ do |count|
+  output_message_qty("Deleting").should == count.to_i
+end
+
+Then /^the output should contain instructions about storing your API key$/ do
+    Then "the output should contain \"fumes setup\""
+end
+
+Given /^I have cloned and synchronized (\d+) project[s]?$/ do |qty|
+  (1..qty.to_i).each do |index|
+    dir_name = "project_#{index}"
+    clone_fixture_repo_into(dir_name)
+    And "I synchronize project #{index}"
+  end
+end
+
+Given /^I have cloned (\d+) project[s]?$/ do |qty|
+  (1..qty.to_i).each do |index|
+    dir_name = "project_#{index}"
+    clone_fixture_repo_into(dir_name)
+  end
+end
+
+When /^I (?:have )?synchronize[d]? project (\d+)$/ do |index|
+  When "I cd to \"project_#{index}/\""
+  And "I run \"#{@bin_path}/fumes sync\""
+  And "I cd to \"../\""
+end
+
+# convenience step...assumes only one project
+When /^I (?:have)?synchronize[d]? the project$/ do
+  When "I synchronize project 1"
+end
+
+Given /^I (?:have )?claim(?:ed)? the (\d+)st project$/ do |index|
+  dir_name = "project_#{index}"
+  And "I cd to \"#{dir_name}/\""
+  And "I run \"#{@bin_path}/fumes claim\""
+  And "I cd to \"../\""
+end
+
+# convenience step...assumes only one project
+Given /^I (?:have )?claim(?:ed)? the project$/ do
+  Given "I have claimed the 1st project"
+end
+
+Given /^I (?:have )?release[d]? the (\d+)(?:st|nd|rd|th) project$/ do |index|
+  dir_name = "project_#{index}"
+  And "I cd to \"#{dir_name}/\""
+  And "I run \"#{@bin_path}/fumes release\""
+  And "I cd to \"../\""
+end
+
+# TODO: Refactor w/ other actions
+Given /^I (?:have )?delete[d]? the (\d+)(?:st|nd|rd|th) project$/ do |index|
+  dir_name = "project_#{index}"
+  And "I cd to \"#{dir_name}/\""
+  And "I run \"#{@bin_path}/fumes delete\""
+  And "I cd to \"../\""
+end
+
+# convenience step...assumes only one project
+Given /^I (?:have )?delete(?:ed)? the project$/ do
+  Given "I have deleted the 1st project"
+end
+
+
+# convenience step...assumes only one project
+Given /^I (?:have )?release[d]? the project$/ do
+  Given "I have released the 1st project"
+end
+
+Then /^the API key in the config file should be ("[^"]*"|cleared)$/ do |api_key_value|
+  expected_value = api_key_value == 'cleared' ? nil : api_key_value.gsub(/"/,'')
+  ConfigFile.api_key.should == expected_value
+end

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,168 @@
+Given /^this project is active project folder/ do
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
+  ENV[env_var] = value
+end
+
+Given /"(.*)" folder is deleted/ do |folder|
+  in_project_folder { FileUtils.rm_rf folder }
+end
+
+When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
+  @stdout = StringIO.new
+  in_project_folder do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I invoke task "rake (.*)"/ do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  in_project_folder do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then /^folder "(.*)" (is|is not) created/ do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file "(.*)" (is|is not) created/ do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file with name matching "(.*)" is created/ do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should not see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should_not contain(text)
+end
+
+Then /^I should see exactly$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should == text
+end
+
+Then /^I should see all (\d+) tests pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^I should see all (\d+) examples pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then /^Rakefile can display tasks successfully/ do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  in_project_folder do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then /^task "rake (.*)" is executed successfully/ do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end

data/features/step_definitions/filesystem_steps.rb

@@ -0,0 +1,19 @@
+Given /^I am in the CodeFumes gem's root directory$/ do
+  cd("/" + File.expand_path(__FILE__) + "/../")
+end
+
+Given /^(in)?valid user credentials have been stored in the CodeFumes config file$/ do |invalid_text|
+  # Fragile, as this user is not set up to be re-added after wiping test db on CodeFumes.com
+  # TODO: update deployment for test site to reload this information:
+  # login: test-user
+  # password: password
+  # email: test.user@codefumes.com
+  # api_key: eX2Kue_6YoEIWAvV1VCx
+
+  unless ConfigFile.path.match(/#{File.expand_path(@tmp_root)}/)
+    raise "###NOTE### ConfigFile path not set to use temp file. Check CODEFUMES_CONFIG_FILE settings!"
+  end
+
+  api_key = invalid_text.blank? ? 'eX2Kue_6YoEIWAvV1VCx' : 'invalid-key-here'
+  ConfigFile.save_credentials(api_key)
+end

data/features/storing_user_api_key.feature

@@ -0,0 +1,41 @@
+Feature: Storing a User's API key
+  Adding an API key to a user's CodeFumes config file allows
+  them to perform actions which require user-authentication,
+  such as associating a project with an account.
+
+
+  Scenario: Issuing 'api-key' without an argument
+    When I run "#{@bin_path}/fumes api-key"
+    Then it should fail with:
+      """
+      No API key specified
+      """
+    And the exit status should be 5
+
+  Scenario: Issuing 'api-key' with an argument
+    When I run "#{@bin_path}/fumes api-key userkey"
+    Then it should pass with:
+      """
+      Your API key has been saved to your CodeFumes config file
+      """
+    And the API key in the config file should be "userkey"
+    And the exit status should be 0
+
+  Scenario: Issuing 'api-key' with the --clear flag
+    When I run "#{@bin_path}/fumes api-key --clear"
+    Then it should pass with:
+      """
+      Your API key has been removed from your CodeFumes config file
+      """
+    And the API key in the config file should be cleared
+    And the exit status should be 0
+
+  Scenario: Issuing 'api-key' with the --clear flag and an argument
+    When I run "#{@bin_path}/fumes api-key userkey1"
+    And I run "#{@bin_path}/fumes api-key --clear userkey2"
+    Then it should pass with:
+      """
+      Your API key has been removed from your CodeFumes config file
+      """
+    And the API key in the config file should be cleared
+    And the exit status should be 0