manamana 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+ruby_string="ruby-1.9.3"
+gemset_name="manamana"
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+
+  # Load or create the specified gemset
+  rvm use "${ruby_string}@${gemset_name}" --create
+
+else
+
+  # Notify the user to install the desired interpreter before proceeding.
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
+
+fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in manamana.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Maglana
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# ManaMana Framework
+
+Organize your project's requirements and their associated test cases in a way that makes sense to your organization. Then keep track of the status of each as your project progresses.
+
+## Installation
+
+Install the gem:
+
+    $ gem install manamana
+
+Use the `mana` command to generate a new project:
+
+    $ mana create my_project
+
+This will create a directory named `my_project` containing the following items:
+
+ * `requirements/` - Contains your project's requirements
+ * `test_cases/` - Contains your project's test cases
+ * `lib/stepdefs/` - Contains definitions for steps that are used by test  cases
+ * `lib/helpers/` - Contains helper methods that can be used in test cases and stepdefs
+
+## Usage
+
+**Step 1: Write Requirements**
+
+Writes a requirements file using the Requirements Syntax and save it under the `requirements/` directory. For example:
+
+```
+Create Tickets
+==============
+As a member of a software development team
+I want to create tickets
+So that I can track the bugs in our project
+
+  * Newly created tickets have a status of 'Open'
+
+  * A <Role> <Can or Cannot Create> support tickets
+
+    Examples:
+      | Role    | Can or Cannot Create |
+      |---------|----------------------|
+      | Manager | Can Create           |
+      | Member  | Can Create           |
+      | Guest   | Cannot Create        |
+
+    Notes:
+      Arbitrary text that the business analyst or domain expert
+      thinks might help the development team understand the
+      problem much better. Blah blah blah.
+```
+
+Notes about the syntax:
+
+ * Text underlined by `=` characters serve as the 'group name' for the requirements that follow it
+ * Text that begin with an asterisk `*` are considered requirements
+ * Requirements can wrap to the next line. The end of a requirement spec is marked by two newline characters.
+ * The keywords `Examples:` and `Notes:` are not really keywords. They're just optional arbitrary text that the writer can add for clarity. The compiler will ignore them.
+ * Tables may or may not have borders. In the above, the border below the header row may be safely ommitted.
+ * Notice that there are no word-like keywords in the above syntax making it il8n-ready at the onset.
+ * The requirements file can be any text file but the convention is to use the .requirements file extension
+
+**Step 2: Write Test Cases**
+
+Write test cases for each requirement using the Test Case Syntax and save each as a file under the `test_cases/` directory. For example:
+
+```
+Test Case:
+  A (.+) can create support tickets
+
+  Variables:
+    * Role Name   = $1
+    * My Username = "norm"
+    * My Password = "123qwe"
+
+  Setup:
+    * An account with username <My Username> and password <My Password> exists
+    * The account with username <My Username> has a role of <Role Name>
+    * I am logged out
+
+  Teardown:
+    * Delete the account with username <My Username> at exit
+
+  Script:
+    * Visit the Login page
+    * Fill in the Username field with <My Username>
+    * Fill in the Password field with <My Password>
+    * Click the Login button
+    * The New Ticket button should be enabled
+```
+
+Notes:
+
+  * The test case name can be a string or a regexp pattern
+  * The test case file can be any text file but the convention is to use the .test_case file extension
+  * Organizing test cases into subfolders under the `test_cases/` directory is recommended. (e.g. `test_cases/create_tickets/`)
+
+**Step 3: Define re-usable steps**
+
+Writes the equivalent Ruby code for the steps used in the test cases. For example:
+
+```
+step /^Visit the (.+) page$/i do |page_name|
+  # Add Ruby code here
+end
+
+step /^Fill in the (.+) field with (.+)$/i do |field_name, value|
+  # Add Ruby code here
+end
+
+step /^Click the (.+) button$/i do |button_name|
+  # Add Ruby code here
+end
+```
+
+**Step 4: Run it!**
+
+Run `mana start` to execute the tests and validate the requirements:
+
+```
+$ mana start
+Run options: --seed 51346
+# Running tests:
+
+Create Tickets
+==============
+As a member of a software development team
+I want to create tickets
+So that I can track the bugs in our project
+
+  * Newly created tickets have a status of 'Open'             PASSED
+
+  * A <Role> <Can or Cannot Create> support tickets
+
+    Examples:
+      | Role    | Can or Cannot Create |
+      |---------|----------------------|
+      | Manager | Can Create           |                      PASSED
+      | Member  | Can Create           |                      PASSED
+      | Guest   | Cannot Create        |                      FAILED
+
+    Notes:
+      Arbitrary text that the business analyst or domain expert
+      thinks might help the development team understand the
+      problem much better. Blah blah blah.
+
+
+Finished tests in 0.004842s, 1445.6836 tests/s, 826.1049 assertions/s.
+
+7 tests, 4 assertions, 0 failures, 0 errors, 0 skips
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/manamana.rb

@@ -0,0 +1,5 @@
+require "manamana/version"
+
+module Manamana
+  # Your code goes here...
+end

data/lib/manamana/version.rb

@@ -0,0 +1,3 @@
+module Manamana
+  VERSION = "0.0.1"
+end

data/manamana.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/manamana/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Maglana"]
+  gem.email         = ["mmaglana@gmail.com"]
+  gem.description   = %q{Capture project requirements better}
+  gem.summary       = %q{Organize your project's requirements and their associated test cases in a way that makes sense to your organization. Then keep track of the status of each as your project progresses.}
+  gem.homepage      = "https://github.com/relaxdiego/manamana"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "manamana"
+  gem.require_paths = ["lib"]
+  gem.version       = Manamana::VERSION
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: manamana
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Maglana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies: []
+description: Capture project requirements better
+email:
+- mmaglana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/manamana.rb
+- lib/manamana/version.rb
+- manamana.gemspec
+homepage: https://github.com/relaxdiego/manamana
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Organize your project's requirements and their associated test cases in a
+  way that makes sense to your organization. Then keep track of the status of each
+  as your project progresses.
+test_files: []