branston 0.4.2 → 0.4.3

data/README.rdoc

@@ -1,4 +1,4 @@
-= Branston =
+= Branston
 
 A user story tracker that generates gherkin files and step
 definitions for use with the cucumber testing framework.
@@ -12,7 +12,7 @@ Once a user story has been given acceptance conditions, it's possible to write a
 cucumber test for it.  On a developer machine, the Branston client allows a
 developer to auto-generate cucumber tests from the user stories on the server.
 
-== Installation ==
+== Installation
 
 There's a bit of a dependency chain needed to get things running.  Cucumber has
 a dependency on Nokogiri, which itself has some libxml related dependencies
@@ -23,18 +23,41 @@ including a dependency on a C compiler. On a clean Debian/Ubuntu box, this...
 
 ...currently does the trick.
 
-= Example Usage =
+= Example Usage
 
-rails test
-cd test
-rake db:migrate
-ruby script/generate cucumber
-branston -i
-branston -s
-(write some stories)
-branston -g -f your-story-name
-rake cucumber:all
-(implement the steps and code to make it pass)
+First, initialize a branston server:
+
+ branston -i
+
+Initialization will make a hidden folder in the present working directory (called
+".branston") and make a sqlite3 database and necessary config files.
+
+Then, start the server:
+
+ branston -s
+
+This will start the Branston server on port 3970.  By default, the server binds
+to the IP 0.0.0.0, so don't do this on a public-facing box unless you want to
+make your Branston server available to the entire internet.
+
+Once you've got some stories with acceptance conditions, you can make your
+Rails app and start generating cucumber test code.  Try this:
+
+ rails test
+ cd test
+ rake db:migrate
+ ruby script/generate cucumber
+
+Now, let's assume you've got a story called "add video".  You want to turn the
+scenarios for that story into executable cucumber test code, so here's what you
+do:
+
+ branston -g -f add-video
+ rake cucumber:all
+
+Branston will
+
+Then, you implement the steps and code to make it pass.
 
 == Note on Patches/Pull Requests
 
@@ -42,11 +65,16 @@ rake cucumber:all
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2009 dave@boomer. See LICENSE for details.sudo apt-get install libxml2 libxml2-ruby
+Copyright (c) 2010 Headlondon - http://www.headlondon.com
+
+See LICENSE for details.
+
+== Credits
+
+Dan Garland, Dave Hrycyszyn, Steve Laing
 

data/bin/branston

@@ -1,4 +1,19 @@
 #!/usr/bin/env ruby
+
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 require File.dirname(__FILE__) + '/../lib/branston/lib/branston'
 Branston.new(ARGV)
 

data/lib/branston/app/controllers/application_controller.rb

@@ -1,13 +1,28 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 # Filters added to this controller apply to all controllers in the application.
 # Likewise, all the methods added will be available for all controllers.
-
+#
 class ApplicationController < ActionController::Base
   helper :all # include all helpers, all the time
   protect_from_forgery # See ActionController::RequestForgeryProtection for details
 
   # Scrub sensitive parameters from your log
   # filter_parameter_logging :password
-  
+
   # RESTful authentication system
   include AuthenticatedSystem
 end
+

data/lib/branston/app/controllers/iterations_controller.rb

@@ -1,3 +1,18 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
+
 class IterationsController < ApplicationController
 
   layout 'main'

data/lib/branston/app/controllers/outcomes_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class OutcomesController < ApplicationController
 
   before_filter :login_required

data/lib/branston/app/controllers/preconditions_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class PreconditionsController < ApplicationController
 
   layout 'main'

data/lib/branston/app/controllers/releases_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class ReleasesController < ApplicationController
 
   layout 'main'

data/lib/branston/app/controllers/scenarios_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class ScenariosController < ApplicationController
 
   layout 'main'

data/lib/branston/app/controllers/sessions_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 # This controller handles the login/logout function of the site.
 class SessionsController < ApplicationController
 

data/lib/branston/app/controllers/stories_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class StoriesController < ApplicationController
 
   layout 'main'
@@ -46,54 +60,11 @@ class StoriesController < ApplicationController
           render :xml => (@story.to_xml :include => { :scenarios => {
         :include => [:preconditions, :outcomes] } } ) }
           format.js { @active = true }
-<<<<<<< HEAD:lib/branston/app/controllers/stories_controller.rb
-        else
-          format.html {
-            @iteration = load_iteration
-            render_optional_error_file 404
-          }
-=======
       else
           format.html { render_optional_error_file 404 }
->>>>>>> steventux/master:lib/branston/app/controllers/stories_controller.rb
           format.all  { render :nothing => true, :status => 404 }
       end
     end
-<<<<<<< HEAD:lib/branston/app/controllers/stories_controller.rb
-
-    # GET /stories/new
-    # GET /stories/new.xml
-    def new
-      @story = Story.new(:iteration => @iteration)
-
-      respond_to do |format|
-        format.html # new.html.erb
-        format.xml  { render :xml => @story }
-      end
-    end
-
-    # GET /stories/1/edit
-    def edit
-      @story = Story.find_by_slug(params[:id])
-    end
-
-    # POST /stories
-    # POST /stories.xml
-    def create
-      @story = Story.new(params[:story])
-      @story.author = current_user
-
-      respond_to do |format|
-        if @story.save
-          flash[:notice] = 'Story was successfully created.'
-          format.html { redirect_to iteration_stories_url(@iteration) }
-          format.xml  { render :xml => @story, :status => :created, :location => @story }
-        else
-          format.html { render :action => "new" }
-          format.xml  { render :xml => @story.errors, :status => :unprocessable_entity }
-        end
-      end
-=======
   end
 
   # GET /stories/new
@@ -104,7 +75,6 @@ class StoriesController < ApplicationController
     respond_to do |format|
       format.html # new.html.erb
       format.xml  { render :xml => @story }
->>>>>>> steventux/master:lib/branston/app/controllers/stories_controller.rb
     end
   end
 
@@ -118,6 +88,7 @@ class StoriesController < ApplicationController
   def create
     @story = Story.new(params[:story])
     @story.author = current_user
+    @story.iteration = @iteration
 
     respond_to do |format|
       if @story.save

data/lib/branston/app/controllers/user_roles_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class UserRolesController < ApplicationController
 
   layout 'main'

data/lib/branston/app/controllers/users_controller.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class UsersController < ApplicationController
 
   layout 'main'

data/lib/branston/app/models/iteration.rb

@@ -1,3 +1,19 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
+
+
 class Iteration < ActiveRecord::Base
 
   # Validations

data/lib/branston/app/models/outcome.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class Outcome < ActiveRecord::Base
 
   # Assocations

data/lib/branston/app/models/participation.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class Participation < ActiveRecord::Base
 
   belongs_to :user

data/lib/branston/app/models/precondition.rb

@@ -1,3 +1,17 @@
+#    This file is part of Branston.
+#
+#    Branston is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as published by
+#    the Free Software Foundation.
+#
+#    Branston is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with Branston.  If not, see <http://www.gnu.org/licenses/>.
+
 class Precondition < ActiveRecord::Base
 
   # Assocations