nutella_framework 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b06d936ef60bf41dac3eb872609ba9906a50cecd
-  data.tar.gz: e7a51bdbff02a0fa306eaf5267f80168c3563e30
+  metadata.gz: 2e2c581262282b014fb5dc0911616b442534da8c
+  data.tar.gz: 3908173709fc9ee02ba4cd339615dde180e4776c
 SHA512:
-  metadata.gz: 23c35cb1768d1469bd29bd27b3eb4b8686c911082ec233556e9526188b544beee945bc2ff8005f588d64f0ed25f97fb41a4e3bafbd8b8c2be22a71f97003f67b
-  data.tar.gz: 23aa14c916de0d105faf807bf548ea9f6c1249868609a80756d4ba7a53b578a77f330c08080408a6bda34eaccaf920a8687514a052462ea5d8cd593ddaa351a6
+  metadata.gz: 5715373d4edeac20b922d507261b496bb961bc71c3d812e3d5ffd74ddf5ed0904cf096b8929e10788bdae78750e39b40427af224ca65bf46386e3956c8aa0872
+  data.tar.gz: d7e8d4b278eb8df7275f209cc21828bad2e678ee0116c3d45556245713b8d835256285df2522ded4487607ec0cbf14f22ff95409b2270c4b04bb343861728d11

data/Gemfile

@@ -6,11 +6,12 @@ gem 'logging', '~> 1.8', '>=1.8.2'
 gem 'git', '~> 1.2', '>=1.2.8'
 gem 'thin', '~> 1.6.3', '>= 1.6.3'
 gem 'sinatra', '~>1.4.5', '>=1.4.5'
-gem 'erubis', '~>2.7.0', '>=2.7.0'
+gem 'nokogiri', '~>1.6.3', '>=1.6.3'
+
 
 group :development do
   gem 'shoulda', '~> 3', '>= 3'
-  gem "yard", '~> 0.8', '>= 0.8.7'
+  gem 'yard', '~> 0.8', '>= 0.8.7'
   gem 'rdoc', '~> 4.0', '>= 4.0'
   gem 'bundler', '~> 1.0', '>= 1.0'
   gem 'jeweler', '~> 2.0.1', '>= 2.0.1'
@@ -18,5 +19,5 @@ group :development do
 end
 
 group :test do
-  gem "rake"
+  gem 'rake'
 end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/actors/main_interface/main_interface_bot.rb

@@ -0,0 +1,148 @@
+require 'json'
+require 'sinatra'
+require 'nokogiri'
+
+# Configuration file and runlist (runlist as global)
+config_file = ARGV[0]
+$runlist_file = ARGV[1]
+
+# Try to parse the both config file and runlist and terminate if we can't
+begin
+  config_h = JSON.parse(IO.read(config_file))
+  JSON.parse(IO.read($runlist_file))
+rescue
+  # something went wrong
+  abort 'Impossible to parse configuration and/or runlist files!'
+end
+
+# Set Sinatra's port to nutella's main_interface_port
+set :port, config_h['main_interface_port']
+
+
+# Display the form to input the run_id
+get '/' do
+  send_file File.join("#{config_h['nutella_home']}/actors/main_interface/public", 'index.html')
+end
+
+
+# Renders the run template
+get '/:run_id' do
+
+  # Parse the run_id from URL and extract the run path from runlist.json
+  @run_id = params[:run_id]
+  @run_path = get_run_path @run_id
+  @project_name = @run_path[@run_path.rindex('/')+1..@run_path.length] unless @run_path.nil?
+
+  # If there is no run with this name, render error page
+  return erb( :not_found_404, :locals => {:not_found_type => 'run'} ) if @run_path.nil?
+
+  # If there is an 'index.erb' file inside the 'interfaces' folder, render it
+  custom_index_file = "#{@run_path}/interfaces/index.erb"
+  return erb(File.read( custom_index_file )) if File.exist? custom_index_file
+
+  # If no 'index.erb' is provided we need to generate one
+  # In order to do so we need to load a bunch of details
+  # (folder, title/name, description) for each interface
+  @interfaces = load_interfaces_details
+
+  # Finally render the interfaces summary page
+  erb :index
+end
+
+
+# Serves the index.html file for each individual interface augmented with nutella query string parameters
+get '/:run_id/:interface' do
+
+  # Parse the run_id and the interface name from URL
+  run_id = params[:run_id]
+  interface = params[:interface]
+
+  # Extract the run path from runlist.json
+  run_path = get_run_path run_id
+
+  # Compose the path of interface index file
+  index_file_path = "#{run_path}/interfaces/#{interface}/index.html"
+
+  # If the index file doesn't exist, render error page
+  return erb( :not_found_404, :locals => {:not_found_type => 'idx'} ) unless File.exist? index_file_path
+
+  # If the index file exists, compose query string and redirect
+  index_with_query_url = "#{request.path}/index.html?run_id=#{run_id}&broker=#{config_h['broker']}"
+  redirect index_with_query_url
+end
+
+
+# Serves the files contained in each interface folder
+get '/:run_id/:interface/*' do
+
+  # Parse the run_id, the interface name and the file_path from URL
+  run_id = params[:run_id]
+  interface = params[:interface]
+  relative_file_path = params[:splat][0]
+
+  # Extract the run path from runlist.json
+  run_path = get_run_path run_id
+
+  # Compose the path of the file we are trying to serve
+  file_path = "#{run_path}/interfaces/#{interface}/#{relative_file_path}"
+
+  # If the file we are trying to serve doesn't exist, render error page
+  return erb( :not_found_404, :locals => {:not_found_type => 'file'} ) unless File.exist? file_path
+
+  # If the file exists, render it
+  send_file file_path
+end
+
+
+# Utility function:
+# Gets the path associated with a certain run
+def get_run_path (run_id)
+  begin
+    runs_h = JSON.parse(IO.read($runlist_file))
+    runs_h[run_id]
+  rescue
+    nil
+  end
+end
+
+# Utility function:
+# Loads all the details for all interfaces and stores them into an array of hashes
+def load_interfaces_details
+  interfaces = Array.new
+  interfaces_path = "#{@run_path}/interfaces/"
+  Dir.entries(interfaces_path).select {|entry| File.directory?(File.join(interfaces_path, entry)) && !(entry =='.' || entry == '..') }.each do |iface_dir|
+    interfaces.push extract_interface_info( interfaces_path, iface_dir )
+  end
+  interfaces
+end
+
+# Utility function:
+# Extracts name, description and folder for a single interface
+def extract_interface_info( interfaces_path, iface_dir )
+  iface_props = Hash.new
+
+  index_path = "#{interfaces_path}#{iface_dir}/index.html"
+
+  unless File.exist? index_path
+    iface_props[:name] = iface_dir
+    iface_props[:description] = 'My designer was a lazy ass and didn\'t include an index.html file in the main interface directory'
+    return iface_props
+  end
+
+  # If file exists, parse it and extract info
+  f = File.open index_path
+  doc = Nokogiri::HTML f
+  f.close
+  iface_props[:name] = doc.css('title').empty? ? iface_dir : doc.css('title').text
+  if doc.css("meta[name='description']").empty?
+    iface_props[:description] = 'My designer was a lazy ass and didn\'t include a <meta name="description" content="Description of this interface"> tag in the index.html file'
+  else
+    if doc.css("meta[name='description']").attribute('content').nil?
+      iface_props[:description] = 'There was no attribute content in <meta name="description" content="Description of this interface"> tag in the index.html file'
+    else
+      iface_props[:description] = doc.css("meta[name='description']").attribute('content').text
+    end
+  end
+  iface_props[:url] = "#{@run_id}/#{iface_dir}"
+  iface_props
+end

data/actors/main_interface/public/index.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Welcome to nutella</title>
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
+    
+		<style type="text/css">
+				div {		
+					margin-top: 4em;
+					text-align: center;
+					font-size: 3em;
+				}
+				.form-control {
+					height: 50px;
+					width: 40%;
+					text-align: center;
+					font-size: .7em;
+					display: inline-block;
+				}
+				.center {
+				    text-align:center;
+				}
+				.center form {
+				    display:inline-block;
+				}
+		</style>
+    </head>
+    <body>
+			
+<!-- Content -->
+			<div>
+        <p>What is your run id?</p>
+				<input id="run_id_input" type="text" value="" class="form-control" autofocus>
+			</div>
+			
+<!-- Scripts -->
+        <script>
+					el = document.getElementById('run_id_input');
+					el.addEventListener('change', function() {
+						window.location = '/' + this.value
+					});
+        </script>
+    </body>
+</html>

data/actors/main_interface/startup

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+BASEDIR=$(dirname $0)
+ruby $BASEDIR/main_interface_bot.rb $1 $2 &>/dev/null &
+echo $! > $BASEDIR/.pid

data/actors/main_interface/views/index.erb

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title><%= @run_id %> interfaces</title>
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
+    
+		<style type="text/css">
+			.row {
+				margin-bottom: 20px;
+			}
+		</style>
+    </head>
+    <body>
+			
+<!-- Content -->
+			<div class="container">
+				<div class="page-header">
+				  <% if @run_id == @project_name %>
+					  <h1>Welcome to <em><%= @project_name %></em></h1>
+				  <% else %>
+					  <h1>Welcome to <em><%= @project_name %></em>, run <em><%= @run_id %></em></h1>
+				  <% end %>
+				  <p class="lead">Click on the buttons to launch the intereface</p>
+				</div>
+				
+				<% @interfaces.each do |i| %>
+				<div class="row">
+					<div class="col-xs-1 col-sm-1 col-lg-1"><a href="<%= i[:url] %>" target="_blank" type="button" class="btn btn-danger">Launch!</a></div>
+					<div class="col-xs-2 col-sm-2 col-lg-2 text-center"><strong><%= i[:name] %></strong></div>
+					<div class="col-xs-9 col-sm-9 col-lg-9"><%= i[:description] %></div>
+				</div>
+				
+				<% end %>
+						
+			</div>
+			
+<!-- Scripts -->
+        <script>
+					
+        </script>
+    </body>
+</html>

data/actors/main_interface/views/not_found_404.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Run not found</title>
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
+
+  <style type="text/css">
+	  div {
+		  margin-top: 4em;
+		  text-align: center;
+		  font-size: 3em;
+	  }
+  </style>
+</head>
+<body>
+
+<!-- Content -->
+<div>
+  <% if locals[:not_found_type] == 'run' %>
+      <p>Sorry, we don't have that run ID!</p>
+      <p>(?_?)</p>
+  <% elsif locals[:not_found_type] == 'idx' %>
+      <p>Sorry, this interface doesn't seem to exist for this application</p>
+      <p>(゜_゜)</p>
+  <% elsif locals[:not_found_type] == 'file' %>
+      <p>The page you are looking for doesn't seem to exist</p>
+      <p>(;_;)</p>
+  <% end %>
+
+
+</div>
+
+</body>
+</html>

data/lib/cli/nutella_cli.rb

@@ -10,33 +10,42 @@ module Nutella
       |_| |_|\\__,_|\\__\\___|_|_|\\__,_|
       "
     
-    # Reads the parameters and executes commands
+    # Nutella entry point. Every time the "nutella" command is invoked this is
+    # the method that gets called.
+    # It reads the command line parameters and it invokes the right sub-command
     def self.run
       # Read parameters
       args = ARGV.dup
       args.shift
-      # Check that the command is not empty, if so, print the prompt
+
+      # Check that the command is not empty, if so, simply print the nutella logo
       command = ARGV.first
       if command == nil
-        printPrompt
+        print_nutella_logo
         exit 0
       end
-      # Prepend warning if nutella is not ready
-      if (Nutella.config["ready"].nil? && command!="checkup")
-        console.warn "Looks like this is a fresh installation of nutella. Please run `nutella checkup` to check all dependencies are installed."
+
+      # If nutella is not ready to be used (i.e. nobody has invoked the "nutella checkup" command yet),
+      # append warning/reminder message
+      if Nutella.config['ready'].nil? && command!='checkup'
+        console.warn 'Looks like this is a fresh installation of nutella. Please run \'nutella checkup\' to check all dependencies are installed.'
       end
-      Nutella.executeCommand command, args
+
+      # Execute the appropriate command
+      Nutella.execute_command command, args
       exit 0
     end
-  
-    # Print Nutella logo
-    def self.printPrompt
+
+
+    # Print nutella logo
+    def self.print_nutella_logo
       console.info(NUTELLA_LOGO)
-      nutella_version = File.open(NUTELLA_HOME+"VERSION", "rb").read
-      console.info("Welcome to nutella version #{nutella_version}! For a complete lists of available commands type `nutella help`\n")
-      # Append warning if nutella is not ready
-      if (Nutella.config["ready"].nil?)
-        console.warn "Looks like this is a fresh installation of nutella. Please run `nutella checkup` to check all dependencies are installed."
+      nutella_version = File.open("#{Nutella.config['nutella_home']}VERSION", 'rb').read
+      console.info("Welcome to nutella version #{nutella_version}! For a complete lists of available commands type 'nutella help'\n")
+      # If nutella is not ready to be used (i.e. nobody has invoked the "nutella checkup" command yet),
+      # append warning/reminder message
+      if  Nutella.config['ready'].nil?
+        console.warn 'Looks like this is a fresh installation of nutella. Please run \'nutella checkup\' to check all dependencies are installed.'
       end
     end
   end

data/lib/config/config.rb

@@ -1,73 +1,11 @@
-# This handles the configuration files of Nutella
-# It's basically a hash overload that stores into a file
-require 'json'
+require 'config/persisted_hash'
 
 module Nutella
-  
-  class ConfigHash
-    
-    def initialize(file)
-      @config_file=file
-    end
-    
-    
-    def []=(key,val)
-      hash = loadConfig
-      hash[key]=val
-      storeConfig hash
-    end
-    
-    def [](key)
-      hash = loadConfig
-      hash[key]
-    end
-    
-    def empty?
-      hash = loadConfig
-      hash.empty?
-    end
-    
-    def has_key?(key)
-      hash = loadConfig
-      hash.has_key? key
-    end
-    
-    def to_s
-      hash = loadConfig
-      hash.to_s
-    end
-    
-    def to_h
-      hash = loadConfig
-      hash
-    end
-    
-    private
-    
-    def storeConfig(hash)
-      File.open(@config_file, "w+") do |f|
-        f.write(JSON.pretty_generate(hash))
-      end
-      File.chmod(0777,@config_file)
-    end
-    
-    def loadConfig   
-      begin
-        return JSON.parse IO.read @config_file
-      rescue
-        # File doesn't exist... do nothing
-        Hash.new
-      end
-    end
-    
-    def removeConfigFile
-      File.delete(@config_file) if File.exist?(@config_file)
-    end
-    
-  end
-  
+
+  # Calling this method (Nutella.config) simply returns and instance of
+  # PersistedHash linked to file config.json in nutella home directory
   def Nutella.config
-    ConfigHash.new(File.dirname(__FILE__)+"/../../config.json")
+    PersistedHash.new("#{File.dirname(__FILE__)}/../../config.json")
   end
   
 end

data/lib/config/current_project.rb

@@ -0,0 +1,58 @@
+# handles current project files
+require 'json'
+
+module Nutella
+  
+  module CurrentProjectUtils
+    
+    # Checks that the current directory is actually a nutella project
+    # @return [Boolean] true if the current directory is a nutella project, false otherwise
+    def CurrentProjectUtils.exist?
+      cur_prj_dir = Dir.pwd
+      nutella_json_file = "#{cur_prj_dir}/nutella.json"
+      # Check that there is a nutella.json file in the main directory of the project
+      if File.exist? nutella_json_file
+        conf = JSON.parse( IO.read(nutella_json_file) )
+        if conf['nutella_version'].nil?
+          console.warn 'The current directory is not a nutella project: nutella_version unspecified in nutella.json file'
+          return false
+        end
+      else
+        console.warn 'The current directory is not a nutella project: impossible to read nutella.json file'
+        return false
+      end
+      true
+    end
+
+    # Builds a PersistedHash of the project nutella.json file and returns it.
+    # This method is used to ease access to the project nutella.json file.
+    # @return [PersistedHash] the PersistedHash of the project nutella.json file
+    def CurrentProjectUtils.config
+      cur_prj_dir = Dir.pwd
+      nutella_json_file = "#{cur_prj_dir}/nutella.json"
+      if File.exist? nutella_json_file
+        return PersistedHash.new nutella_json_file
+        else
+          console.error 'The current directory is not a nutella project: impossible to read nutella.json file'
+        end
+    end
+
+    # Retrieves the current project directory
+    # @return [String] the current project home
+    def CurrentProjectUtils.dir
+      Dir.pwd
+    end
+    
+  end
+
+
+  # Calling this method (Nutella.current_project) simply returns
+  # a reference to the CurrentProjectUtils module
+  def Nutella.current_project
+    CurrentProjectUtils
+  end
+  
+end
+
+
+

data/lib/config/persisted_hash.rb

@@ -0,0 +1,114 @@
+require 'json'
+
+module Nutella
+
+  # This class behaves *similarly* to a regular Hash but it persists every operation
+  # to the json file passed in the constructor. Not all Hash operations are supported
+  # and we added some of our own.
+  class PersistedHash
+
+    def initialize(file)
+      @config_file=file
+    end
+
+    def []( key )
+      hash = load_hash
+      hash[key]
+    end
+
+    def []=( key, val )
+      hash = load_hash
+      hash[key]=val
+      store_hash hash
+    end
+
+    def delete( key )
+      hash = load_hash
+      return_value = hash.delete key
+      store_hash hash
+      return_value
+    end
+
+    def empty?
+      hash = load_hash
+      hash.empty?
+    end
+
+    def has_key?( key )
+      hash = load_hash
+      hash.has_key? key
+    end
+
+    def include?( key )
+      has_key? key
+    end
+
+    def to_s
+      hash = load_hash
+      hash.to_s
+    end
+
+    def to_h
+      load_hash
+    end
+
+    def keys
+      hash = load_hash
+      hash.keys
+    end
+
+    def length
+      hash = load_hash
+      hash.length
+    end
+
+    # PersistedHash-only public methods
+
+    # Adds a <key, value> pair to the PersistedHash _only if_
+    # there is currently no value associated with the specified key.
+    # @return [Boolean] false if the key already exists, true if the
+    # <key, value> pair was added successfully
+    def add?(key, val)
+      hash = load_hash
+      return false if hash.key? key
+      hash[key] = val
+      store_hash hash
+      true
+    end
+
+    # Removes a <key, value> pair from the PersistedHash _only if_
+    # there is currently a value associated with the specified key.
+    # @return [Boolean] false if there is no value associated with
+    # the specified key, true otherwise
+    def delete?( key )
+      hash = load_hash
+      return false if hash.delete(key).nil?
+      store_hash hash
+      true
+    end
+
+    private
+
+    def store_hash(hash)
+      File.open(@config_file, 'w+') do |f|
+        f.write(JSON.pretty_generate(hash))
+      end
+      File.chmod(0777, @config_file)
+    end
+
+    def load_hash
+      begin
+        return JSON.parse IO.read @config_file
+      rescue
+        # File doesn't exist, return new empty Hash
+        Hash.new
+      end
+    end
+
+    def remove_file
+      File.delete(@config_file) if File.exist?(@config_file)
+    end
+
+  end
+
+end