merb_stories 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Daniel Neighman
+
+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

@@ -0,0 +1,55 @@
+merb_stories
+=================
+
+A plugin for the Merb framework that provides generators for rSpec Text Stories.
+
+This is currently only very basic support.  It supports the same helper methods that are available
+in Merbs current spec helpers.
+
+SETUP:
+in config/dependencies.rb include this line
+
+dependency "merb_stories"
+
+USAGE:
+
+-- Generating Stories
+
+ruby script/generate story my_story
+
+OR for more organised stories
+
+ruby script/generate story group/sub_group/my_story
+
+This allows you to divide your stories up into different directories.  You can have as many or few
+sub directories as you like
+
+-- Running the stories
+
+merb_stories includes a rake file that allows you to run you stories
+
+EXAMPLE
+rake story[my_story]
+
+or 
+
+rake story[group/sub_group/my_story]
+
+or to run all stories
+
+rake story[all]
+
+EXTENDING THE FUNCTIONALITY
+
+To make your own custom modules available to the stories you write you need to include them in the MerbStory class.
+Any methods you define on your MerbStory class will be available.
+
+EXAMPLE
+In stories/helper.rb
+
+class MerbStory
+  include MyExtraHelper
+end
+
+
+

data/Rakefile

@@ -0,0 +1,58 @@
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+require "rake/testtask"
+require "spec/rake/spectask"
+require "fileutils"
+include FileUtils
+
+PLUGIN = "merb_stories"
+NAME = "merb_stories"
+VERSION = "0.1.0"
+AUTHOR = "Daniel Neighman"
+EMAIL = "has.sox@gmail.com"
+HOMEPAGE = "http://merb-plugins.rubyforge.org/merb_stories/"
+SUMMARY = "Merb plugin that provides basic support for rSpec text stories"
+
+CLEAN.include ["**/.*.sw?", "*.gem", ".config"]
+
+windows = (PLATFORM =~ /win32|cygwin/)
+SUDO = windows ? "" : "sudo"
+
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 0.4.0')
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs,rspec_generators}/**/*")
+end
+
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package, :uninstall] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end
+
+desc "Run :clean and uninstall the .gem"
+task :uninstall => :clean do
+  begin
+    sh %{#{SUDO} gem uninstall #{NAME}}
+  rescue
+    puts "#{NAME} gem not found"
+  end
+end

data/TODO

@@ -0,0 +1,2 @@
+TODO:
+Get tasks inclusion fixed in Merb so that you don't need to have this as a dependency

data/lib/merb_stories.rb

@@ -0,0 +1,12 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.add_rakefiles "merb_stories/merbtasks"
+end
+
+# Don't inlcude anything if we're not in the test environment
+if Merb.environment == "test"
+  Merb::BootLoader.after_app_loads do
+    require  File.join(File.dirname(__FILE__), "merb_stories", "merb_story" )
+  end
+end

data/lib/merb_stories/merb_story.rb

@@ -0,0 +1,4 @@
+class MerbStory
+  include Merb::Test::Helper
+  include Merb::Test::RspecMatchers
+end

data/lib/merb_stories/merbtasks.rb

@@ -0,0 +1,4 @@
+desc "Run the given story.  rake story[story_name]"
+task :story, :story_name do |t,args|
+    sh %{ruby stories/stories/#{args.story_name}.rb}
+end

data/rspec_generators/story/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rspec_generators/story/story_generator.rb

@@ -0,0 +1,64 @@
+class StoryGenerator < RubiGen::Base
+  
+  attr_reader :story_name, :story_path, :step_name, :path_levels
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    name = args.shift.split "/"
+    @story_name = name.pop
+    @story_path = name.empty? ? nil : name.join("/")
+    @step_name = @story_path.nil? ? @story_name : (@story_path.gsub("/", "_") + "_" + @story_name)
+    @path_levels = @story_path.nil? ? 0 : @story_path.split("/").size
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'stories'
+    
+      m.template "helper.rb", File.join("stories", "helper.rb")
+      
+      m.directory 'stories/steps'
+      m.directory File.join('stories/stories', "#{@story_path}")
+      
+      if( !File.exists?('stories/stories/all.rb') ) # So it doesn't get destroyed when you do a destroy script
+        m.template 'all.rb', "stories/stories/all.rb"
+      end
+      m.template 'step.rb',   File.join('stories', 'steps', "#{@step_name}.rb")
+      m.template 'story.rb',  File.join('stories/stories', "#{@story_path}", "#{@story_name}.rb")
+      m.template 'story',     File.join('stories/stories', "#{@story_path}", "#{@story_name}")
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a stub for a rSpec text story spec in merb.
+
+USAGE: #{$0} #{spec.name} my_story"
+
+EXAMPLE:
+#{$0} #{spec.name} my_story
+#{$0} #{spec.name} story_group/specific_story
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/rspec_generators/story/templates/all.rb

@@ -0,0 +1,4 @@
+dir = File.dirname(__FILE__)
+Dir[File.expand_path("#{dir}/**/*.rb")].uniq.each do |file|
+  require file
+end

data/rspec_generators/story/templates/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+require File.join(File.dirname(__FILE__), "..", "spec", "spec_helper")
+require 'spec/mocks'
+require 'spec/story'
+
+require 'merb_stories'
+
+class MerbStory
+  # Include your custom helpers here
+end
+
+Dir['stories/steps/**/*.rb'].each do |steps_file|
+  require steps_file
+end

data/rspec_generators/story/templates/step.rb

@@ -0,0 +1,3 @@
+steps_for(:<%= step_name %>) do
+  
+end

data/rspec_generators/story/templates/story

@@ -0,0 +1,7 @@
+Story: Some story about <%= story_name %>
+
+  As a ...
+  I want to ...
+  So that ...
+  
+  Scenario: ...

data/rspec_generators/story/templates/story.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), "../<%= "../" * path_levels %>helper")
+
+with_steps_for :<%= step_name %> do
+  run File.expand_path(__FILE__).gsub(".rb",""), :type => MerbStory
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: merb_stories
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Neighman
+autorequire: merb_stories
+bindir: bin
+cert_chain: []
+
+date: 2008-01-28 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+description: Merb plugin that provides basic support for rSpec text stories
+email: has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_stories
+- lib/merb_stories/merb_story.rb
+- lib/merb_stories/merbtasks.rb
+- lib/merb_stories.rb
+- rspec_generators/story
+- rspec_generators/story/story_generator.rb
+- rspec_generators/story/templates
+- rspec_generators/story/templates/all.rb
+- rspec_generators/story/templates/helper.rb
+- rspec_generators/story/templates/step.rb
+- rspec_generators/story/templates/story
+- rspec_generators/story/templates/story.rb
+- rspec_generators/story/USAGE
+has_rdoc: true
+homepage: http://merb-plugins.rubyforge.org/merb_stories/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides basic support for rSpec text stories
+test_files: []
+