marso 0.1.29059 → 0.1.47959

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a08f2eab4f5f38a5535d05665390b8347c14e6a
-  data.tar.gz: 4e149e94f8d799fba81e2110dd3e9a789f7cc8b4
+  metadata.gz: 5b15c69b1ea0796955f65f15d9d09947265e98eb
+  data.tar.gz: a0df6d7123bf9c574eddf135376c764527b5e6b5
 SHA512:
-  metadata.gz: 280f7dd08d67f994ec84f8cd3c5a158acd15e76bc1823e4f5d212fabf67a9ec213c132bc17ab7d43a4a7c77b2bbbb4bc76f18b7c2112f1d5fd8101b09fe0f569
-  data.tar.gz: f3119c5e80021f7e4a3d189879bb4e7ce8dae2088eb239544c2162eab0148fd6492bfbb3c419facfaa905964f6766ea01e95f44f03db370bf6e64cc832d034c7
+  metadata.gz: a43a302bfcd8b22af168d865d9c882979fdb5d92b1fe65769181ee6a73ed355e89eba35e543bc1ef6173016f075b66265927894d9a29c49d11aed68328c8e725
+  data.tar.gz: edae46912cfc7fd0b33452dd7f8f6e89361b05ba83b700dad47aad2d83caf79894e3539e5d011aeddd6f5ac3b704485f0d75c960e2fd8037ecb505e491c4321b

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = true
+end

data/bin/marso

@@ -0,0 +1,342 @@
+#!/usr/bin/env ruby
+
+require 'marso'
+require 'colorize'
+require 'pathname'
+require 'fileutils'
+
+LAUNCHER_OPTIONS_KEYS_MAP = {
+	"-p" => :rootpath,
+	"-f" => :select,
+	"-m" => :include_mode
+}
+
+def help
+	puts "Usage: No documentation yet"
+end
+
+def location_is_stories?(path=nil)
+	path = path || Dir.pwd
+	File.basename(path).casecmp("stories") == 0
+end
+
+def location_is_features?(path=nil)
+	path = path || Dir.pwd
+	File.basename(path).casecmp("features") == 0
+end
+
+def location_is_scenarios?(path=nil)
+	path = path || Dir.pwd
+	File.basename(path).casecmp("scenarios") == 0
+end
+
+def location_is_story?(path=nil)
+	path = path || Dir.pwd
+	parent_path = File.expand_path("../", path)
+	location_is_stories? parent_path
+end
+
+def location_is_feature?(path=nil)
+	path = path || Dir.pwd
+	parent_path = File.expand_path("../", path)
+	location_is_features? parent_path
+end
+
+def location_is_scenario?(path=nil)
+	path = path || Dir.pwd
+	parent_path = File.expand_path("../", path)
+	location_is_scenarios? parent_path
+end
+
+def location_is_stories_realm?(path=nil)
+	path = path || Dir.pwd
+	location_is_stories?(path) || location_is_story?(path)
+end
+
+def location_is_features_realm?(path=nil)
+	path = path || Dir.pwd
+	location_is_features?(path) || location_is_feature?(path)
+end
+
+def location_is_scenarios_realm?(path=nil)
+	path = path || Dir.pwd
+	location_is_scenarios?(path) || location_is_scenario?(path)
+end
+
+def create_feature(name)
+	if location_is_scenarios_realm?
+		puts "Impossible to create a feature under scenarios. Please browse to another location".colorize(:red)
+	elsif location_is_stories_realm?
+		puts "Impossible to create a feature under stories. Please browse to another location".colorize(:red)
+	else
+		feature_factory = Marso::FeatureFactory.new
+		unless name
+			print "Enter feature's name: ".colorize(:cyan)
+			name = $stdin.gets.chomp
+		end
+		print "Do you want to describe your feature now(y/n)? ".colorize(:cyan)
+		answer = $stdin.gets.chomp
+		feat_description = nil
+		if answer.casecmp("y") == 0
+			print "In order to: ".colorize(:cyan)
+			in_order_to = $stdin.gets.chomp
+			print "As a: ".colorize(:cyan)
+			as_a = $stdin.gets.chomp
+			print "I: ".colorize(:cyan)
+			i = $stdin.gets.chomp
+			feat_description = {
+				:name => name,
+	 			:in_order_to => in_order_to,
+	 			:as_a => as_a,
+	 			:i => i
+			}
+		else
+			feat_description = { :name => name }
+		end
+
+		fname = nil
+		feat_folder = name.downcase.gsub(' ','_')
+		cancel_operation = false
+		current_folder_is_features = File.basename(Dir.pwd).casecmp("features") == 0
+		if current_folder_is_features
+			fname = feature_factory.create_feature_file(feat_description)
+		else # the question now is whether or not we want to create the Features folder
+			features_folder_is_a_subfolder = Dir.entries(Dir.pwd)
+				.select{ |f| File.directory? File.join(Dir.pwd,f ) }
+				.any?{ |f| f == "Features"  }
+
+			unless features_folder_is_a_subfolder
+				print "The current folder is not the 'Features' folder and it doesn't contain it either. Do you want to create[y] it, or cancel[n] the operation(y/n)? ".colorize(:cyan)
+				create_answer = $stdin.gets.chomp
+				if create_answer.casecmp("y") == 0
+					FileUtils.mkdir "Features"
+				else
+					cancel_operation = true
+				end
+			end
+			feat_root = File.join(Dir.pwd, "Features", feat_folder)
+			fname = feature_factory.create_feature_file(feat_description, feat_root)
+		end
+
+		if cancel_operation
+			puts "Operation cancelled".colorize(:pink)
+		else
+			puts "Feature file #{feat_folder}/#{fname} successfully created".colorize(:green)
+		end
+	end
+end
+
+def create_story(name)
+	if location_is_scenarios_realm?
+		puts "Impossible to create a story under scenarios. Please browse to another location".colorize(:red)
+	elsif location_is_features?
+		puts "Impossible to create a story straight under the Features folder. Please browse to a specific feature or story".colorize(:red)
+	elsif !location_is_feature? && !location_is_stories?
+		puts "Impossible to create a story here. Please browse to specific a feature or story".colorize(:red)
+	else
+		story_factory = Marso::StoryFactory.new
+		unless name
+			print "Enter story's name: ".colorize(:cyan)
+			name = $stdin.gets.chomp
+		end
+		print "Do you want to describe your story now(y/n)? ".colorize(:cyan)
+		answer = $stdin.gets.chomp
+		story_description = nil
+		if answer.casecmp("y") == 0
+			print "In order to: ".colorize(:cyan)
+			in_order_to = $stdin.gets.chomp
+			print "As a: ".colorize(:cyan)
+			as_a = $stdin.gets.chomp
+			print "I: ".colorize(:cyan)
+			i = $stdin.gets.chomp
+			story_description = {
+				:name => name,
+	 			:in_order_to => in_order_to,
+	 			:as_a => as_a,
+	 			:i => i
+			}
+		else
+			story_description = { :name => name }
+		end
+
+		fname = nil
+		story_folder = name.downcase.gsub(' ','_')
+		cancel_operation = false
+		current_folder_is_stories = File.basename(Dir.pwd).casecmp("stories") == 0
+		if current_folder_is_stories
+			fname = story_factory.create_story_file(story_description)
+		else # the question now is whether or not we want to create the Stories folder
+			stories_folder_is_a_subfolder = Dir.entries(Dir.pwd)
+				.select{ |f| File.directory? File.join(Dir.pwd,f ) }
+				.any?{ |f| f == "Stories"  }
+
+			unless stories_folder_is_a_subfolder
+				print "The current folder is not the 'Stories' folder and it doesn't contain it either. Do you want to create[y] it, or cancel[n] the operation(y/n)? ".colorize(:cyan)
+				create_answer = $stdin.gets.chomp
+				if create_answer.casecmp("y") == 0
+					FileUtils.mkdir "Stories"
+				else
+					cancel_operation = true
+				end
+			end
+			feat_root = File.join(Dir.pwd, "Stories", story_folder)
+			fname = story_factory.create_story_file(story_description, feat_root)
+		end
+
+		if cancel_operation
+			puts "Operation cancelled".colorize(:pink)
+		else
+			puts "Story file #{story_folder}/#{fname} successfully created".colorize(:green)
+		end
+	end
+end
+
+def create_scenario(name)
+	if location_is_features?
+		puts "Impossible to create a scenario straight under the Features folder. Please browse to a specific feature or story".colorize(:red)
+	elsif location_is_stories?
+		puts "Impossible to create a scenario straight under the Stories folder. Please browse to a specific feature or story".colorize(:red)
+	elsif !location_is_feature? && !location_is_story?
+		puts "Impossible to create a scenario here. Please browse to specific a feature or story".colorize(:red)
+	else
+		scenario_factory = Marso::ScenarioFactory.new
+		unless name
+			print "Enter scenario's name: ".colorize(:cyan)
+			name = $stdin.gets.chomp
+		end
+		print "Do you want to describe your scenario now(y/n)? ".colorize(:cyan)
+		answer = $stdin.gets.chomp
+		scenario_description = nil
+		if answer.casecmp("y") == 0
+			print "Given: ".colorize(:cyan)
+			_given = $stdin.gets.chomp
+			print "When: ".colorize(:cyan)
+			_when = $stdin.gets.chomp
+			print "Then: ".colorize(:cyan)
+			_then = $stdin.gets.chomp
+			scenario_description = {
+				:name => name,
+	 			:given => _given,
+	 			:when => _when,
+	 			:then => _then
+			}
+		else
+			scenario_description = { :name => name }
+		end
+
+		fname = nil
+		cancel_operation = false
+		current_folder_is_scenarios = File.basename(Dir.pwd).casecmp("stories") == 0
+		if current_folder_is_scenarios
+			fname = scenario_factory.create_scenario_file(scenario_description)
+		else # the question now is whether or not we want to create the Scenarios folder
+			scenarios_folder_is_a_subfolder = Dir.entries(Dir.pwd)
+				.select{ |f| File.directory? File.join(Dir.pwd,f ) }
+				.any?{ |f| f == "Scenarios"  }
+
+			unless scenarios_folder_is_a_subfolder
+				print "The current folder is not the 'Scenarios' folder and it doesn't contain it either. Do you want to create[y] it, or cancel[n] the operation(y/n)? ".colorize(:cyan)
+				create_answer = $stdin.gets.chomp
+				if create_answer.casecmp("y") == 0
+					FileUtils.mkdir "Scenarios"
+				else
+					cancel_operation = true
+				end
+			end
+			feat_root = File.join(Dir.pwd, "Scenarios")
+			fname = scenario_factory.create_scenario_file(scenario_description, feat_root)
+		end
+
+		if cancel_operation
+			puts "Operation cancelled".colorize(:pink)
+		else
+			puts "Scenario file #{fname} successfully created".colorize(:green)
+		end
+	end
+end
+
+def get_options
+	options = {}
+	if ARGV.size > 1
+		args = ARGV.clone
+		args.shift(2)
+		args.each do |arg| 
+			puts arg
+			kv = arg.split('=') 
+			key = LAUNCHER_OPTIONS_KEYS_MAP[kv[0]]
+			puts key
+			case key
+			when :rootpath
+				options[:rootpath] = kv[1]
+			when :select
+				options[:select] = kv[1].split(',')
+			when :include_mode
+				modes = kv[1].split(',')
+				if modes.any? { |m| m == "all"}
+					options[:include_mode] = :with_all
+				elsif modes.any? { |m| m == "scenarios"} && modes.any? { |m| m == "stories"}
+					options[:include_mode] = :with_stories_scenarios
+				elsif modes.any? { |m| m == "scenarios"}
+					options[:include_mode] = :with_scenarios
+				elsif modes.any? { |m| m == "stories"}
+					options[:include_mode] = :with_stories
+				end
+			end
+		end
+	end
+	return options
+end
+
+def show_features
+	options = get_options
+	puts options
+	Marso.show_features_text options
+end
+
+if ARGV.size > 0
+	main_command = ARGV[0].downcase
+	case main_command
+	when "add"
+		if ARGV.size == 1
+			puts "Missing argument(0 for 1). Use 'marso help' to find out about the usage".colorize(:red)
+		else
+			gherkin_type = ARGV[1].downcase
+			case gherkin_type
+			when "feature"
+				create_feature ARGV[2]
+			when "f"
+				create_feature ARGV[2]
+			when "story"
+				create_story ARGV[2]
+			when "s"
+				create_story ARGV[2]
+			when "scenario"
+				create_scenario ARGV[2]
+			when "scn"
+				create_scenario ARGV[2]
+			else
+				puts "#{gherkin_type} is not a Gherkin type. Use 'marso help' to find out about the usage".colorize(:red)
+			end
+		end
+	when "show"
+		if ARGV.size == 1
+			puts "Missing argument(0 for 1). Use 'marso help' to find out about the usage".colorize(:red)
+		else
+			gherkin_type = ARGV[1].downcase
+			case gherkin_type
+			when "feature"
+				show_features
+			when "f"
+				show_features
+			else
+				puts "#{gherkin_type} is not a Gherkin type. Use 'marso help' to find out about the usage".colorize(:red)
+			end
+		end
+	when "help"
+		help
+	when "h"
+		help
+	else
+		puts "#{main_command} is an invalid command. Use 'marso help' to find out about the usage".colorize(:red)
+	end
+end

data/lib/marso.rb

@@ -6,12 +6,15 @@ require "marso/domain/step/step"
 require "marso/domain/step/step_publish"
 require "marso/domain/scenario/scenario"
 require "marso/domain/scenario/scenario_publish"
+require "marso/domain/scenario/scenario_factory"
 require "marso/domain/story/story"
 require "marso/domain/story/story_load"
 require "marso/domain/story/story_publish"
+require "marso/domain/story/story_factory"
 require "marso/domain/feature/feature"
 require "marso/domain/feature/feature_load"
 require "marso/domain/feature/feature_publish"
+require "marso/domain/feature/feature_factory"
 require "marso/helpers/texthelper"
 require "marso/helpers/statushelper"
 require "marso/helpers/componenthelper"

data/lib/marso/domain/base_factory.rb

@@ -0,0 +1,13 @@
+
+module Marso
+	module BaseFactory
+		private
+			def get_template(path)
+				template = nil
+				File.open(path, "rb") do |f|
+					template = f.read
+				end
+				return template
+			end
+	end
+end

data/lib/marso/domain/feature/feature.rb

@@ -10,12 +10,12 @@ module Marso
     include FeaturePublish
 
     attr_reader :id, :description, :status, :ctx, :stories, :scenario_contexts,
-    :rootpath, :header, :text, :tree_position, :color_theme
+    :rootpath, :header, :text, :tree_position, :color_theme, :name, :fname
 
     # description (optional): Hash defined as follow
     #   :id => Arbitrary number or string. Default is randomly generated
-    #          (hex string (length 8))
-    #   :name => Story's name
+    #          (hex string (length 6))
+    #   :name => Feature's name
     #   :in_order_to => String that describes the fundamental story's business
     #                   value
     #   :as_a => String that describes the user(s)
@@ -37,9 +37,11 @@ module Marso
 
       @description[:scenario_contexts] = [] if description[:scenario_contexts].nil?
       @description[:stories] = [] if description[:stories].nil?
-      @description[:id] = SecureRandom.hex(4) if description[:id].nil?
+      @description[:id] = SecureRandom.hex(3) if description[:id].nil?
       @description[:rootpath] = File.dirname(caller[0]) if description[:rootpath].nil?
 
+      @name = @description[:name]
+      @fname = @description[:name].downcase.gsub(' ', '_')
       @rootpath = @description[:rootpath]
       @id = @description[:id]
       @scenario_contexts = @description[:scenario_contexts]
@@ -73,6 +75,7 @@ module Marso
       def validate_arguments(description, ctx)
         raise ArgumentError, "Argument 'description' cannot be nil" if description.nil?
         raise ArgumentError, "Argument 'description' must be a Hash" unless description.is_a?(Hash)
+        raise ArgumentError, "Argument 'description[:name]' is required" if description[:name].nil?
         raise ArgumentError, "Argument 'ctx' must be a Hash" unless ctx.is_a?(Hash)
         unless description[:scenario_contexts].nil?
           unless description[:scenario_contexts].empty?

data/lib/marso/domain/feature/feature_factory.rb

@@ -0,0 +1,43 @@
+require 'pathname'
+require 'securerandom'
+require 'fileutils'
+require_relative 'feature'
+require_relative '../base_factory'
+
+module Marso
+
+	class FeatureFactory
+		include Marso::BaseFactory
+
+		def create_feature_file(description={}, root=nil)
+			raise ArgumentError, "Feature's name is required" unless description[:name]
+			id = description[:id] || SecureRandom.hex(3)
+			name = description[:name]
+			in_order_to = description[:in_order_to] || ""
+			as_a = description[:as_a] || ""
+			i = description[:i] || ""
+
+			template = get_template(Pathname("../feature_template.rb").expand_path(__FILE__))
+				.gsub(/#\{id\}/, id)
+				.gsub(/#\{name\}/, name)
+				.gsub(/#\{in_order_to\}/, in_order_to)
+				.gsub(/#\{as_a\}/, as_a)
+				.gsub(/#\{i\}/, i)
+
+			fname = name.downcase.gsub(' ', '_')
+			feature_file = "#{fname}.rb"
+			root = root || File.join(Dir.pwd, fname)
+
+			FileUtils.mkdir root unless File.directory? root
+			FileUtils.mkdir File.join(root, "Stories")
+			FileUtils.mkdir File.join(root, "Scenarios")
+
+			dest = File.join(root, feature_file)
+			File.open(dest, "w") do |f|
+				f.write(template)
+			end
+
+			return feature_file
+		end
+	end
+end

data/lib/marso/domain/feature/feature_template.rb

@@ -0,0 +1,13 @@
+require 'marso'
+
+module MarsoContext
+  def self.feature(ctx={})
+    Marso::Feature.new({
+      :id => "#{id}",
+      :name => "#{name}",
+      :in_order_to => "#{in_order_to}",
+      :as_a => "#{as_a}",
+      :i => "#{i}"
+    })
+  end
+end

data/lib/marso/domain/scenario/scenario.rb

@@ -1,4 +1,4 @@
-require 'colorize'
+     require 'colorize'
 require 'securerandom'
 require_relative '../../config'
 require_relative 'scenario_publish'
@@ -13,16 +13,16 @@ module Marso
       validate_arguments(description, ctx)
 
       @description = description.clone
+      @ctx=ctx.clone
 
-      @description[:id] = SecureRandom.hex(4) if description[:id].nil?
+      @description[:id] = SecureRandom.hex(3) if description[:id].nil?
       @description[:status] = :none if description[:status].nil?
-      @ctx=ctx.clone
 
       @id = @description[:id]
-      @before_run=@description[:before_run]
-      @get_scenario=@description[:get_scenario]
-      @after_run=@description[:after_run]
-      @status=@description[:status]
+      @before_run = @description[:before_run]
+      @get_scenario = @description[:get_scenario]
+      @after_run = @description[:after_run]
+      @status = @description[:status]
 
       @story_id = ctx[:story_id]
       @feature_id = ctx[:feature_id]
@@ -69,7 +69,7 @@ module Marso
 
     attr_reader :name, :steps, :id, :status, :color_theme,
     :cancel_steps_upon_issues, :realtime_step_stdout, :ctx, :story_id,
-    :feature_id, :header, :tree_position
+    :feature_id, :header, :tree_position, :fname
 
     # description: Hash defined as follow
     #   :id => Arbitrary number or string. Default is randomly generated
@@ -107,6 +107,7 @@ module Marso
       end
 
       @name = description[:name]
+      @fname = description[:name].downcase.gsub(' ', '_')
       @ctx = ctx.clone
 
       @tree_position = 0
@@ -226,8 +227,9 @@ module Marso
     private
 
       def validate_arguments(description, ctx)
-          raise ArgumentError, "Argument 'description' must be a Hash" unless description.is_a?(Hash)
-          raise ArgumentError, "Argument 'ctx' must be a Hash" unless ctx.is_a?(Hash)
+        raise ArgumentError, "Argument 'description' must be a Hash" unless description.is_a?(Hash)
+        raise ArgumentError, "Argument 'description[:name]' is required" if description[:name].nil?
+        raise ArgumentError, "Argument 'ctx' must be a Hash" unless ctx.is_a?(Hash)
       end
 
       def add_step(step_type, assumption_text, *args, &block)

data/lib/marso/domain/scenario/scenario_factory.rb

@@ -0,0 +1,39 @@
+require 'pathname'
+require 'securerandom'
+require 'fileutils'
+require_relative 'scenario'
+require_relative '../base_factory'
+
+module Marso
+
+	class ScenarioFactory
+		include Marso::BaseFactory
+
+		def create_scenario_file(description={}, root=nil)
+			raise ArgumentError, "Scenario's name is required" unless description[:name]
+			id = description[:id] || SecureRandom.hex(3)
+			name = description[:name]
+			given = description[:given] || ""
+			_when = description[:when] || ""
+			_then = description[:then] || ""
+
+			template = get_template(Pathname("../scenario_template.rb").expand_path(__FILE__))
+				.gsub(/#\{id\}/, id)
+				.gsub(/#\{name\}/, name)
+				.gsub(/#\{given\}/, given)
+				.gsub(/#\{_when\}/, _when)
+				.gsub(/#\{_then\}/, _then)
+
+			fname = name.downcase.gsub(' ', '_')
+			feature_file = "#{fname}.rb"
+			root = root || Dir.pwd
+
+			dest = File.join(root, feature_file)
+			File.open(dest, "w") do |f|
+				f.write(template)
+			end
+
+			return feature_file
+		end
+	end
+end

data/lib/marso/domain/scenario/scenario_template.rb

@@ -0,0 +1,31 @@
+require 'marso'
+
+module MarsoContext
+	def self.scenario_context(ctx={})
+		Marso::ScenarioContext.new({
+			:id => "#{id}",
+			:before_run => lambda { |id, ctx|
+				# Enter the code you want to execute before running the scenario.
+				# Uncomment the code below if you want to open a Firefox browser.
+				# ctx[:browser] = Marso.openNewBrowser()
+			},
+			:get_scenario => lambda { |id, ctx|
+				Marso::Scenario.new({:id => id, :name => "#{name}"}, ctx)
+					.given("#{given}") {
+						# TODO: Enter your code here
+					}
+					.when("#{_when}"){
+						# TODO: Enter your code here
+					}
+					.then("#{_then}"){
+						# TODO: Enter your code here
+					}
+			},
+			:after_run => lambda { |id, ctx|
+				# Enter the code you want to execute after the scenario is done running.
+				# Uncomment the code below if you want to close the Firefox browser.
+				# ctx[:browser].close
+			}
+		}, ctx)
+	end
+end

data/lib/marso/domain/story/story.rb

@@ -10,11 +10,11 @@ module Marso
     include StoryPublish
 
     attr_reader :id, :description, :status, :ctx, :scenario_contexts,
-    :feature_id, :tree_position, :header, :text, :color_theme, :rootpath
+    :feature_id, :tree_position, :header, :text, :color_theme, :rootpath, :name, :fname
 
     # description (optional): Hash defined as follow
     #   :id => Arbitrary number or string. Default is randomly generated
-    #          (hex string (length 8))
+    #          (hex string (length 6))
     #   :name => Story's name
     #   :in_order_to => String that describes the fundamental story's business
     #                   value
@@ -35,9 +35,11 @@ module Marso
       @ctx = ctx.clone
 
       @description[:scenario_contexts] = [] if description[:scenario_contexts].nil?
-      @description[:id] = SecureRandom.hex(4) if description[:id].nil?
+      @description[:id] = SecureRandom.hex(3) if description[:id].nil?
       @description[:rootpath] = File.dirname(caller[0]) if description[:rootpath].nil?
 
+      @name = @description[:name]
+      @fname = @description[:name].downcase.gsub(' ', '_')
       @rootpath = @description[:rootpath]
       @id = @description[:id]
       @scenario_contexts = @description[:scenario_contexts]
@@ -60,6 +62,7 @@ module Marso
 
       def validate_arguments(description, ctx)
         raise ArgumentError, "Argument 'description' cannot be nil" if description.nil?
+        raise ArgumentError, "Argument 'description[:name]' is required" if description[:name].nil?
         raise ArgumentError, "Argument 'description' must be a Hash" unless description.is_a?(Hash)
         raise ArgumentError, "Argument 'ctx' must be a Hash" unless ctx.is_a?(Hash)
         unless description[:scenario_contexts].nil?

data/lib/marso/domain/story/story_factory.rb

@@ -0,0 +1,42 @@
+require 'pathname'
+require 'securerandom'
+require 'fileutils'
+require_relative 'story'
+require_relative '../base_factory'
+
+module Marso
+
+	class StoryFactory
+		include Marso::BaseFactory
+
+		def create_story_file(description={}, root=nil)
+			raise ArgumentError, "Story's name is required" unless description[:name]
+			id = description[:id] || SecureRandom.hex(3)
+			name = description[:name]
+			in_order_to = description[:in_order_to] || ""
+			as_a = description[:as_a] || ""
+			i = description[:i] || ""
+
+			template = get_template(Pathname("../story_template.rb").expand_path(__FILE__))
+				.gsub(/#\{id\}/, id)
+				.gsub(/#\{name\}/, name)
+				.gsub(/#\{in_order_to\}/, in_order_to)
+				.gsub(/#\{as_a\}/, as_a)
+				.gsub(/#\{i\}/, i)
+
+			fname = name.downcase.gsub(' ', '_')
+			feature_file = "#{fname}.rb"
+			root = root || File.join(Dir.pwd, fname)
+
+			FileUtils.mkdir root unless File.directory? root
+			FileUtils.mkdir File.join(root, "Scenarios")
+
+			dest = File.join(root, feature_file)
+			File.open(dest, "w") do |f|
+				f.write(template)
+			end
+
+			return feature_file
+		end
+	end
+end

data/lib/marso/domain/story/story_template.rb

@@ -0,0 +1,14 @@
+require 'marso'
+
+module MarsoContext
+  def self.story(ctx={})
+    Marso::Story.new({
+      :id => "#{id}",
+      :name => "#{name}",
+      :in_order_to => "#{in_order_to}",
+      :as_a => "#{as_a}",
+      :i => "#{i}"
+    },
+    ctx)
+  end
+end

data/lib/marso/version.rb

@@ -1,3 +1,3 @@
 module Marso
-  VERSION ="0.1.29059"
+  VERSION ="0.1.47959"
 end

data/marso.gemspec

@@ -29,12 +29,14 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = ["marso"]
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency('mocha', '~> 1.0')
+  spec.add_development_dependency('turn', '~> 0.9')
   spec.add_runtime_dependency "colorize", "~> 0.7"
   spec.add_runtime_dependency "watir-webdriver", "~> 0.6"
   spec.add_runtime_dependency "eventmachine", "~> 1.0"

data/test/fixtures/create_new_feature_file.yml

@@ -0,0 +1,6 @@
+feature:
+ id: "8f943a"
+ name: "Add to shopping cart"
+ in_order_to: "buy more than one item in a single transaction"
+ as_a: "online consumer"
+ i: "want to add items to a shopping cart"

data/test/fixtures/create_new_scenario_file.yml

@@ -0,0 +1,6 @@
+scenario:
+ id: "8f943a"
+ name: "Add one item to my shopping cart"
+ given: "I'm currently browsing a product catalog"
+ when: "I click on the 'Add to cart' button of a product"
+ then: "a popup box appears saying that the product has been successfully added to my shopping cart"

data/test/fixtures/create_new_story_file.yml

@@ -0,0 +1,6 @@
+story:
+ id: "8f943a"
+ name: "Add to shopping cart"
+ in_order_to: "buy more than one item in a single transaction"
+ as_a: "online consumer"
+ i: "want to add items to a shopping cart"

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'marso'
+require 'toolbelt/fixture'
+require 'pathname'
+require 'fileutils'
+
+# Attempt to load turn to show formatted test results
+begin
+  require "turn"
+  Turn.config.format = :pretty
+  Turn.config.natural = true
+rescue LoadError
+end
+

data/test/toolbelt/Fixture.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+require 'erb'
+require 'pathname'
+
+fixture_root = Pathname("../../fixtures").expand_path(__FILE__)
+
+Fixtures = Hash.new do |hash, f_name|
+	filepath = fixture_root.join("#{f_name}.yml")
+	file_contents = open(filepath).read
+	YAML.load(ERB.new(file_contents).result).to_hash
+	hash[f_name] = YAML.load(ERB.new(file_contents).result).to_hash
+end

data/test/unit/feature/feature_factory_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe Marso::FeatureFactory do
+	subject { Marso::FeatureFactory.new }
+	let(:new_feature) { Fixtures['create_new_feature_file']['feature'] }
+	let(:features_root) { Pathname("../tmp").expand_path(__FILE__) }
+
+	before do
+		FileUtils.remove_dir features_root, true 	# Delete folder
+		FileUtils.mkdir features_root				# Create folder
+	end
+
+	after do
+		FileUtils.remove_dir features_root, true
+	end
+	
+	it "Creates a .rb feature file that contains the feature details" do
+		feature_file = subject.create_feature_file({
+			:id => new_feature['id'],
+ 			:name => new_feature['name'],
+ 			:in_order_to => new_feature['in_order_to'],
+ 			:as_a => new_feature['as_a'],
+ 			:i => new_feature['i']
+		}, features_root)
+
+		require File.join(features_root, feature_file)
+		f = MarsoContext.feature
+
+		f.id.must_equal new_feature['id']
+		f.name.must_equal new_feature['name']
+		f.description[:in_order_to].must_equal new_feature['in_order_to']
+		f.description[:as_a].must_equal new_feature['as_a']
+		f.description[:i].must_equal new_feature['i']
+	end
+
+end

data/test/unit/scenario/scenario_factory_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+describe Marso::ScenarioFactory do
+	subject { Marso::ScenarioFactory.new }
+	let(:new_scenario) { Fixtures['create_new_scenario_file']['scenario'] }
+	let(:scenario_root) { Pathname("../tmp").expand_path(__FILE__) }
+
+	before do
+		FileUtils.remove_dir scenario_root, true 	# Delete folder
+		FileUtils.mkdir scenario_root				# Create folder
+	end
+
+	after do
+		FileUtils.remove_dir scenario_root, true
+	end
+	
+	it "Creates a .rb scenario file that contains the scenario's details" do
+		file = subject.create_scenario_file({
+			:id => new_scenario['id'],
+ 			:name => new_scenario['name'],
+ 			:given => new_scenario['given'],
+ 			:when => new_scenario['when'],
+ 			:then => new_scenario['then']
+		}, scenario_root)
+
+		require File.join(scenario_root, file)
+		scn_ctx = MarsoContext.scenario_context
+		scn = scn_ctx.get_scenario.call(new_scenario['id'], {})
+
+		scn.id.must_equal new_scenario['id']
+		scn.name.must_equal new_scenario['name']
+		given_step = "Given #{new_scenario['given']}"
+		when_step = "When #{new_scenario['when']}"
+		then_step = "Then #{new_scenario['then']}"
+		scn.steps.any? { |s| s.description == given_step }.must_equal true
+		scn.steps.any? { |s| s.description == when_step }.must_equal true
+		scn.steps.any? { |s| s.description == then_step }.must_equal true
+	end
+
+end

data/test/unit/story/story_factory_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe Marso::StoryFactory do
+	subject { Marso::StoryFactory.new }
+	let(:new_story) { Fixtures['create_new_story_file']['story'] }
+	let(:stories_root) { Pathname("../tmp").expand_path(__FILE__) }
+
+	before do
+		FileUtils.remove_dir stories_root, true 	# Delete folder
+		FileUtils.mkdir stories_root				# Create folder
+	end
+
+	after do
+		FileUtils.remove_dir stories_root, true
+	end
+	
+	it "Creates a .rb story file that contains the story details" do
+		feature_file = subject.create_story_file({
+			:id => new_story['id'],
+ 			:name => new_story['name'],
+ 			:in_order_to => new_story['in_order_to'],
+ 			:as_a => new_story['as_a'],
+ 			:i => new_story['i']
+		}, stories_root)
+
+		require File.join(stories_root, feature_file)
+		s = MarsoContext.story
+
+		s.id.must_equal new_story['id']
+		s.name.must_equal new_story['name']
+		s.description[:in_order_to].must_equal new_story['in_order_to']
+		s.description[:as_a].must_equal new_story['as_a']
+		s.description[:i].must_equal new_story['i']
+	end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marso
 version: !ruby/object:Gem::Version
-  version: 0.1.29059
+  version: 0.1.47959
 platform: ruby
 authors:
 - Nicolas Dao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +113,8 @@ description: Marso is the beginning of a small lightweight BDD project. Currentl
   or in red depending on the value of a predicate.
 email:
 - nicolas@quivers.com
-executables: []
+executables:
+- marso
 extensions: []
 extra_rdoc_files: []
 files:
@@ -95,18 +124,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/marso
 - lib/marso.rb
 - lib/marso/config.rb
+- lib/marso/domain/base_factory.rb
 - lib/marso/domain/feature/feature.rb
+- lib/marso/domain/feature/feature_factory.rb
 - lib/marso/domain/feature/feature_load.rb
 - lib/marso/domain/feature/feature_publish.rb
+- lib/marso/domain/feature/feature_template.rb
 - lib/marso/domain/scenario/scenario.rb
+- lib/marso/domain/scenario/scenario_factory.rb
 - lib/marso/domain/scenario/scenario_publish.rb
+- lib/marso/domain/scenario/scenario_template.rb
 - lib/marso/domain/step/step.rb
 - lib/marso/domain/step/step_publish.rb
 - lib/marso/domain/story/story.rb
+- lib/marso/domain/story/story_factory.rb
 - lib/marso/domain/story/story_load.rb
 - lib/marso/domain/story/story_publish.rb
+- lib/marso/domain/story/story_template.rb
 - lib/marso/factories.rb
 - lib/marso/helpers/componenthelper.rb
 - lib/marso/helpers/statushelper.rb
@@ -117,6 +154,14 @@ files:
 - lib/marso/validation/symbol.rb
 - lib/marso/version.rb
 - marso.gemspec
+- test/fixtures/create_new_feature_file.yml
+- test/fixtures/create_new_scenario_file.yml
+- test/fixtures/create_new_story_file.yml
+- test/test_helper.rb
+- test/toolbelt/Fixture.rb
+- test/unit/feature/feature_factory_test.rb
+- test/unit/scenario/scenario_factory_test.rb
+- test/unit/story/story_factory_test.rb
 homepage: https://github.com/nicolasdao/marso
 licenses:
 - MIT
@@ -141,4 +186,12 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Marso is a lightweight BDD project
-test_files: []
+test_files:
+- test/fixtures/create_new_feature_file.yml
+- test/fixtures/create_new_scenario_file.yml
+- test/fixtures/create_new_story_file.yml
+- test/test_helper.rb
+- test/toolbelt/Fixture.rb
+- test/unit/feature/feature_factory_test.rb
+- test/unit/scenario/scenario_factory_test.rb
+- test/unit/story/story_factory_test.rb