elf_manifesto 1.0.0

data/features/use_built_in_templates.feature

@@ -0,0 +1,78 @@
+Feature: Using built-in Templates
+
+  As a console user
+  I want to use a range of built in templates
+  So that I can create a range of manifests quickly
+
+	Scenario: listing available templates
+	  Given a library of templates: simple.mustache scorm.tmp simple.tmp example.tmp
+		When I run `manifesto list templates`
+		Then the output should contain "Available Templates:"
+		And the output should not contain "lib/templates" 
+		And the output should contain "scorm.tmp"
+		And the output should contain "simple.tmp"
+		And the output should contain "example.tmp"
+		
+	Scenario: 'list' command alias
+		Given a library of templates: simple.mustache scorm.tmp simple.tmp example.tmp
+		When I run `manifesto list`
+		Then the output should contain "Available Templates:"
+		And the output should not contain "lib/templates" 
+		And the output should contain "scorm.tmp"
+		And the output should contain "simple.tmp"
+		And the output should contain "example.tmp"
+		
+	Scenario: showing the contents of a built in template
+		Given a library of templates: test.tmp
+		When I run `manifesto show template test`
+		Then the output should contain "{{#groups}}"	
+		
+	Scenario: 'show' command alias
+		Given a library of templates: test.tmp
+		When I run `manifesto show test`
+		Then the output should contain "{{#groups}}"
+		
+	Scenario: requesting the contents of a non-existent template
+		Given a library of templates: test.tmp
+		When I run `manifesto show template duffer`
+		Then the exit status should not be 0
+		And the output should contain "Template does not exist: duffer"
+		
+		
+	Scenario: rendering with a built in template
+		Given a library of templates: tester.mustache
+		And a collection of files: page1.html page2.html page3.html
+		When I run `manifesto --sample_template tester '**/*.html'`
+		Then the output should contain "group1 (**/*.html):"
+		And the output should contain "page1.html"
+		And the output should contain "page2.html"
+		And the output should contain "page3.html"
+		And the exit status should be 0
+		
+	Scenario Outline: providing a bad sample template name
+		Given a library of templates: tester.mustache
+		When I run `<command>`
+		Then the exit status should not be 0
+		And the output should contain "<result>"
+		
+		Scenarios: Bad built in template selection
+		| command                                | result                       | 
+		| manifesto --sample_template duff '*.*' | Bad template selection: duff | 
+		
+		Scenarios: Bad template path
+		| command                         | result                       | 
+		| manifesto --template duff '*.*' | Bad template selection: duff | 
+		
+	Scenario: using an '_' prefix in the template name to load a built in template
+	  Given a library of templates: tester.mustache
+		And a collection of files: page1.html page2.html page3.html
+		When I run `manifesto --template _tester '**/*.html'`
+		Then the output should contain "group1 (**/*.html):"
+	
+	
+	
+		
+		
+		
+
+		

data/features/use_config_files.feature

@@ -0,0 +1,31 @@
+Feature: Using a config file with manifesto
+
+  As a manifesto user
+  I want to provide a config file
+  So that I can re-use a set of config options and I don't need to write horribly long commands in the terminal
+
+	Scenario: Using a config file to run a built in template
+	  Given a file named "manifesto.config" with:
+		"""
+		{
+			template: "_simple",
+			globs: ["learning_objects/**/*.html", "assets*/**/*.* ", "js/**/*.*"],
+			props: {
+				manifest_id:'com.hmeelearning.eh',
+				org_id: 'hmeeh',sco_id: 'ID72c02ada-df91-41ca-a440-15062a4683c0',
+				org_name: 'Experience Hyundai',
+				sco_name: 'Module 6 - Quiz',
+				sco_pass_score: 0.7
+			}
+		}
+		"""
+		And a library of templates: simple.mustache
+	  When I run `manifesto -c manifesto.config`
+	  Then the output should contain "group1"
+		And the output should contain "sco_name"
+		And the output should contain "Module 6"
+	
+	
+	
+
+  

data/lib/Elf_Manifesto/version.rb

@@ -0,0 +1,4 @@
+module ElfManifesto
+  # Tools for creating manifests from file collections and Mustache Templates
+  VERSION = "1.0.0"
+end

data/lib/Elf_Manifesto.rb

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

data/lib/elf_manifesto/manifest_maker.rb

@@ -0,0 +1,61 @@
+require 'mustache'
+
+module ElfManifesto
+  
+  class ManifestMaker
+    
+    attr_reader :file_groups, :result 
+    # *Args*
+    # * ops:: +Hash+ -> Hash of options
+		# 	
+		# 		ops = { 
+		# 			template: 'path/to/template.file',
+		# 			properties: { prop1: 'foobar' },
+		# 			globs: ['*.*', '*.jpg'], 	
+		# 		}
+		#
+		# 		ElfManifesto::ManifestMaker.new(ops)
+		# 	
+    # 	[+template+] +String+ -> template file to load
+    # 	[+properties+] +Hash+ -> arbitrary properties to supply to template
+    # 	[+globs+] +Array+ -> list of file globs to evaluate
+    def initialize(ops)
+      @file_groups = get_file_groups(ops[:globs]) # evaluate the globs and create the file groups
+      @file_groups[:props] = ops[:props] unless ops[:props].nil?
+      template_file = File.open ops[:template], 'rb'
+      @template = template_file.read
+      @result = Mustache.render @template, @file_groups
+      message = ""
+      pos = 1
+      # puts "#{message}\n\n\n"
+      puts @result
+    end
+
+		private
+ 		# get_file_groups
+		# Evaluate the globs array and populate the file_groups object.
+		# It's the file_groups object that is used to populate the template.
+ 		#
+ 		# * *Args*    :
+ 		#  globs - +Array+ -> list of strings to use as file searches
+ 		# * *Returns* :
+ 		#   - dictionary of file group arrays
+ 		def get_file_groups globs
+ 		  pos = 1
+ 		  file_groups = { groups: [] }
+ 		  
+      globs.each do |glob|
+        # e.g { group1: { path: '*.*', files: [file1, file2]} }
+        group_name = "group#{pos}"
+        files = Dir.glob(glob)
+        file_group_object = { name: group_name, path: glob, files: files }
+        file_groups[group_name.to_sym] = file_group_object
+        file_groups[:groups].push file_group_object
+        pos += 1    
+      end
+      file_groups
+ 		end
+ 		
+ 
+  end
+end

data/lib/templates/imsmanifest.xml.mustache

@@ -0,0 +1,55 @@
+<manifest identifier="{{props.manifest_id}}" version="1.0" xsi:schemaLocation="http://www.imsglobal.org/xsd/imscp_v1p1 imscp_v1p1.xsd http://www.imsglobal.org/xsd/imsss imsss_v1p0.xsd http://www.adlnet.org/xsd/adlcp_v1p3 adlcp_v1p3.xsd http://www.adlnet.org/xsd/adlseq_v1p3 adlseq_v1p3.xsd http://www.adlnet.org/xsd/adlnav_v1p3 adlnav_v1p3.xsd" xmlns="http://www.imsglobal.org/xsd/imscp_v1p1" xmlns:adlcp="http://www.adlnet.org/xsd/adlcp_v1p3" xmlns:adlseq="http://www.adlnet.org/xsd/adlseq_v1p3" xmlns:adlnav="http://www.adlnet.org/xsd/adlnav_v1p3" xmlns:imsss="http://www.imsglobal.org/xsd/imsss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <metadata>
+    <schema>ADL SCORM</schema>
+    <schemaversion>2004 3rd Edition</schemaversion>
+  </metadata>
+  <organizations default="{{props.org_id}}">
+    <organization identifier="{{props.org_id}}">
+      <title>{{props.org_name}}</title>
+	  <!-- identifier is a guid --> <!-- identifierref is "sco_" + guid -->
+      <item identifier="{{props.sco_id}}" identifierref="sco_{{props.sco_id}}">
+        <title>{{props.sco_name}}</title>
+        <imsss:sequencing>
+			<imsss:objectives>
+				<imsss:primaryObjective objectiveID="PRIMOBJ" satisfiedByMeasure="true">
+					<imsss:minNormalizedMeasure>{{props.sco_pass_score}}</imsss:minNormalizedMeasure>
+				</imsss:primaryObjective>
+			</imsss:objectives>
+			<imsss:deliveryControls completionSetByContent="true" objectiveSetByContent="true" />
+		</imsss:sequencing>
+      </item>
+	  <imsss:sequencing>
+		  <imsss:controlMode choiceExit="true" flow="true" />
+	  </imsss:sequencing>
+    </organization>
+  </organizations>
+  <resources>
+	<!-- identifier is "sco_" + guid (used on line10) -->
+    <resource identifier="sco_{{props.sco_id}}" adlcp:scormType="sco" href="index.html" type="webcontent">
+		<!-- include reference to the SCO file itself -->
+		<file href="index.html" />
+		<!-- group1: page files here. glob example "learning_objects/**/*.html" -->
+		{{#group1.files}}
+		<file href="{{.}}" />
+		{{/group1.files}}
+		<!-- group2: List all assets used in the SCO. glob "ASSETS_FOLDER*/**/*.* "-->
+		{{#group2.files}}
+		<file href="{{.}}" />
+		{{/group2.files}}
+	  <dependency identifierref="COMMON_ASSETS" />
+	  <dependency identifierref="THINQI_SYS" />
+    </resource>
+	<resource identifier="COMMON_ASSETS" type="webcontent" adlcp:scormType="asset">
+		<!-- group3: List all assets used in package. glob "COMMON_ASSETS*/**/*.* "-->
+		{{#group3.files}}
+		<file href="{{.}}" />
+		{{/group3.files}}
+    </resource>
+    <resource identifier="THINQI_SYS" type="webcontent" adlcp:scormType="asset">
+		<!-- group4: List all CI/Framework files here. glob example "js/**/*.*"-->
+		{{#group4.files}}
+		<file href="{{.}}" />
+		{{/group4.files}}
+    </resource>
+  </resources>
+</manifest>

data/lib/templates/simple.mustache

@@ -0,0 +1,15 @@
+Matched Groups:
+{{#groups}}
+{{name}} ({{path}}): {{#files}}{{.}} {{/files}}
+{{/groups}}
+
+Each file glob passed in creates a new file group. Each group has a name, path and files property. Reference specific file groups by their name which is 'group' followed by the group number. So 'group1' for the first group etc.
+
+So the first group's path glob is -> {{group1.path}}
+And the files matching it are:
+{{#group1.files}}
+	{{.}}
+{{/group1.files}}
+
+{{#props}}Properties{{/props}}
+{{props}}

data/readme.md

@@ -0,0 +1,110 @@
+# ELF Manifesto #
+
+A gem for creating file manifests from Mustache templates
+
+## Usage ##
+
+Run from the command line. Provide a template file and pass in a number of file globs ("*.jpg", or "images/*.*" for example). Each file collection returned from the each glob will be used to populate the given template. 
+
+e.g.
+
+`manifesto create template_file.mustache '*.*' '*.jpg' 'pages/*.html'`
+
+('create' is the default command so you can leave it out if you like. 'manifesto template_filed.mustache '*.*' '*.jpg' 'pages/*.html')
+		
+This will load the file 'template_file.mustache' and treat it as a [mustache][mustache] template. (Go [here][mustache] for more info). The file extension doesn't matter. I've used .mustache just to make the point.
+
+At the end of the command you can provide any number of space delimited strings that will be evaluated as file globs and used to search the file system from your current location. In this example 
+
+*		'*.*' returns paths to all files in the current directory
+*	  '*.jpg' returns paths to all jpgs in the current directory
+*	  'pages/*.html' returns paths to all html files in the pages directory
+
+I'm sure you get the idea...
+
+Each collection of paths are added to a numbered group and made available in the template. In our example, group1 corresponds to '*.*', group2 to '*.jpg' and so on. By referencing these groups in a mustache template you can build manifest files populated with all the file paths you need.
+
+## Saving the manifest ##
+
+The manifest is output to the console, so you can save it by copying or directing the output to a file.
+
+`manifesto create template_file.mustache '*.*' '*.jpg' 'pages/*.html' > manifest.json`
+will render the template and save it in manifest.json.
+
+---
+
+## Passing Arbitrary Properties ##
+
+Use the --properties or -p switch to pass in a string to be evaluated as a property hash
+ 
+`manifesto create template_file.mustache -p "{ :name => 'foo', :surname => 'bar' }" '*.*' '*.jpg' 'pages/*.html'`
+
+will make the {{props.name}} and {{props.surname}} available in the template. (N.B. Ruby syntax for the hash)
+
+
+---
+## Built in templates ##
+
+There are a few built in templates available. Use 
+
+`manifesto list`
+
+...to list them.
+
+* simple.mustache - simple template for playing around and getting your globs right
+* imsmanifest.xml.mustache - For creating SCORM manifests. If you don't know what they are then you don't need 'em :)
+
+### Displaying a template ###
+
+If you want to view a built in template you can use
+
+`manifesto show template_name`
+
+(you only need to use the start of the template name for the sake of brevity. So `manifesto show ims` would do the trick).
+
+If you want to base your own templates on one of the built in ones then you can pipe it out to a file and then edit it.
+
+`manifesto show template_name > my_template.mustache`
+
+To use a built in template use the -s switch with the template name 
+
+`manifesto -s ims "*.*"`
+
+or just prefix the template name with an underscore
+
+`manifesto -m ims "*.*"`
+
+---
+## Using config files ##
+
+Typing long string representations of property hashes into the command line is 'orrible. So you can use config files instead. Like this one...
+
+> {
+> 	template: "_imsmanifest",
+> 	globs: ["pages/**/*.html", "assets*/**/*.* ", "js/**/*.*"],
+> 	props: {
+> 		manifest_id:'com.learning.eh',
+> 		org_id: 'ID72c02ada-df91-41ca-a440-15062a4683c0',
+> 		package_name: 'Module 6',
+> 	}
+> }
+
+* template: path to a template relative to the current working directory
+* globs: array of file searches
+* props: arbitrary properties to reference in the templates
+
+To use a config file use the -c switch
+
+`manifesto -c path_to_config.file`
+
+N.B. Config files are evaluated as Ruby, just so you know
+
+---
+# TODO #
+
+*	Support registration of new templates
+*	Add some simple template helpers
+	*	GUID creator
+* Commander -h seems to fail on windows machines. Doh!
+
+[mustache]: http://mustache.github.com/mustache.5.html

data/spec/lib/elf_manifesto/manifest_maker_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require "elf_manifesto/manifest_maker"
+require 'mustache'
+
+all_files = ['file1.txt', 'file2.', 'file3.txt', 'image1.jpg', 'image2.jpg']
+image_files = ['image1.jpg', 'image2.jpg']
+txt_files = ['file1.txt', 'file2.', 'file3.txt']
+
+describe "Creating a manifest." do
+	before(:each) do
+	  
+	end
+	
+  describe "Evaluating file groups." do
+    it "should accept a single file group" do
+      Dir.should_receive(:glob).with('*.*').and_return(all_files)
+			mock_input_file_read "duff.template", simple_template()
+			# manifesto = ElfManifesto::ManifestMaker.new('duff.template', {}, ['*.*'])
+			ops = {
+				template: 'duff.template',
+				globs: ['*.*']
+			}
+			manifesto = ElfManifesto::ManifestMaker.new(ops)
+    end
+
+		describe "Gathering file collections." do
+		  it "should evaluate a single glob string" do
+		    Dir.should_receive(:glob).with('*.*').and_return(all_files)
+				mock_input_file_read "duff.template", simple_template()
+				ops = {
+					template: 'duff.template',
+					globs: ['*.*']
+				}
+				manifesto = ElfManifesto::ManifestMaker.new(ops)
+				manifesto.file_groups[:group1][:files].should eq all_files
+		  end
+		
+			it "should evaluate multiple glob strings" do
+				Dir.should_receive(:glob).with('*.jpg').and_return(image_files)
+				Dir.should_receive(:glob).with('*.*').and_return(all_files)
+				Dir.should_receive(:glob).with('*.txt').and_return(txt_files)
+				mock_input_file_read "duff.template", simple_template()
+				
+				ops = {
+					template: 'duff.template',
+					globs: ['*.*', '*.jpg', '*.txt']
+				}
+			  
+				manifesto = ElfManifesto::ManifestMaker.new(ops)
+				manifesto.file_groups[:group1][:files].should eq all_files
+				manifesto.file_groups[:group2][:files].should eq image_files
+				manifesto.file_groups[:group3][:files].should eq txt_files
+			end
+			
+			describe "gathering information about the groups" do
+				before(:each) do
+				  Dir.should_receive(:glob).with('*.jpg').and_return(image_files)
+					Dir.should_receive(:glob).with('*.*').and_return(all_files)
+					Dir.should_receive(:glob).with('*.txt').and_return(txt_files)
+					mock_input_file_read "duff.template", simple_template()
+
+					ops = {
+						template: 'duff.template',
+						globs: ['*.*', '*.jpg', '*.txt']
+					}
+					@subject = ElfManifesto::ManifestMaker.new(ops)
+				end
+				
+			  it "should store a list of the groups" do
+					@subject.file_groups[:groups].should have(3).items
+			  end
+			end
+			
+			describe "Storing arbitrary properties" do
+			  it "should make any property hashes provided available to the template" do
+					Dir.should_receive(:glob).with('*.*').and_return(all_files)
+					mock_input_file_read "duff.template", simple_template()
+					ops = {
+						template: 'duff.template',
+						globs: ['*.*'],
+						props: { name: 'foobar' }
+					}
+					manifesto = ElfManifesto::ManifestMaker.new(ops)
+					manifesto.file_groups[:props][:name].should eq 'foobar'
+			  end
+			end
+		end
+		
+		describe "Rendering the template" do
+			before(:each) do
+				# mock file expectations
+				Dir.should_receive(:glob).with('*.jpg').and_return(image_files)
+				Dir.should_receive(:glob).with('*.*').and_return(all_files)
+				Dir.should_receive(:glob).with('*.txt').and_return(txt_files)
+		  end
+			
+			it "should load a template" do
+				mock_input_file_read "simple.mustache", simple_template()
+				Mustache.stub(:render)	
+				ops = {
+					template: 'simple.mustache',
+					globs: ['*.*', '*.jpg', '*.txt']
+				}
+				manifesto = ElfManifesto::ManifestMaker.new(ops)			  
+			end
+			
+			describe "with Mustache" do
+				before(:each) do
+				 	mock_input_file_read "simple.mustache", simple_template()
+					Mustache.should_receive(:render).and_return("The Result")
+				end
+				
+				it "should use mustache to render the template" do
+					ops = {
+						template: 'simple.mustache',
+						globs: ['*.*', '*.jpg', '*.txt']
+					}
+					manifesto = ElfManifesto::ManifestMaker.new(ops)
+				end
+				
+				it "should store the result" do		
+					ops = {
+						template: 'simple.mustache',
+						globs: ['*.*', '*.jpg', '*.txt']
+					}
+					manifesto = ElfManifesto::ManifestMaker.new(ops)
+					manifesto.result.should eq 'The Result'
+				end
+			end
+		
+		end
+
+  end
+end
+
+private 
+
+def mock_input_file_read file_name, contents = ""
+	# Set expectations
+	@stuntfile = double()
+	@stuntfile.should_receive(:read).and_return(contents)
+	File.should_receive(:open).with(file_name,"rb").and_return(@stuntfile)
+end
+
+def simple_template
+	<<-eos
+	{{#.}}
+	Files Matching {{path}}
+		{{name}}
+	{{/.}}
+	eos
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start do
+	add_group "CLI", "bin"
+	add_group "Workers", "lib/elf_manifesto"
+end