nutella_framework 0.1.2 → 0.2.0

data/lib/config/runlist.rb

@@ -1,96 +1,32 @@
-# This handles the list of running instances of Nutella
-# The list is uniquely maintained inside a file
-require 'singleton'
-require 'json'
-require 'set'
+require 'config/persisted_hash'
 
 module Nutella
   
-  class RunList
-    
-    RUN_LIST_FILE=File.dirname(__FILE__)+"/../../runlist.json"
-    
-    include Singleton
-    
-    def add?(runid)
-      begin
-        result = JSON.parse(IO.read(RUN_LIST_FILE)).to_set.add? runid
-      rescue
-        # No file, create one
-        result = [runid].to_set
-      end
-      writeFile(result)
-    end
-
-    def delete?(runid)
-      begin
-        result = JSON.parse(IO.read(RUN_LIST_FILE)).to_set.delete? runid
-      rescue
-        removeRunListFile
-        result = nil # List is empty, so nil
-      end
-      writeFile(result)
-    end
+  class RunListHash < PersistedHash
 
-    def include?(runid)
-      begin
-        return JSON.parse(IO.read(RUN_LIST_FILE)).include? runid
-      rescue
-        false # There is no file so it doens't include runid
-      end
+    # Returns the +run_id+ names for a certain project
+    # If no project is specified, +run_id+s for all projects are returned
+    # @param [String] project_name the name of the project we want to find run names for
+    # @return [Array<String>] list of +run_id+s associated to the specified project
+    def runs_by_project( project_name=nil )
+      (project_name == nil) ? keys : keys.select { |run| run.start_with?(project_name) }
     end
 
-    def empty?
-      begin
-        return JSON.parse(IO.read(RUN_LIST_FILE)).empty?
-      rescue
-        true # There is no file so list is empty
-      end
-    end
-
-    def to_a(projectName=nil)
-      begin
-        list = JSON.parse(IO.read(RUN_LIST_FILE))
-        # filter by project
-        if projectName == nil
-          return list
-        else
-          return list.select { |run| run.start_with?(projectName) }
-        end
-      rescue
-        Array.new # There is no file or something went wrong
-      end
-    end
-
-    def length
-      to_a.length
-    end
-    
-    def extractRunId(run)
-      run.to_s.empty? ? Nutella.currentProject.config["name"] : Nutella.currentProject.config["name"] + "_" + run
-    end
-    
-    private 
-    
-    def removeRunListFile
-      File.delete(RUN_LIST_FILE) if File.exist?(RUN_LIST_FILE)
-    end
-    
-    def writeFile(result)
-      if result!=nil
-        File.open(RUN_LIST_FILE, "w+") do |f|
-          f.write(JSON.pretty_generate(result.to_a))
-        end
-        File.chmod(0777, RUN_LIST_FILE)
-      end
-      result
+    # Extracts the +run_id+ from the run name (specified at command line)
+    # @param [String] run_name
+    # @return [String] the +run_id+ which is either the +project_name+ (if no +run_name+
+    # was specified) or the concatenation of +project_name+ and +run_name+
+    def extract_run_id( run_name )
+      run_name.to_s.empty? ? Nutella.current_project.config['name'] : "#{Nutella.current_project.config['name']}_#{run_name}"
     end
     
+
   end
-  
-  
+
+  # Calling this method (Nutella.runlist) simply returns and instance of
+  # RunListHash linked to file runlist.json in the nutella home directory
   def Nutella.runlist
-    RunList.instance
+    RunListHash.new( "#{File.dirname(__FILE__)}/../../runlist.json" )
   end
   
 end

data/lib/core/command.rb

@@ -5,8 +5,8 @@ module Nutella
     class << self; attr_accessor :description end
   
     # Commands overload this method to execute
-    def run (args=nil)
-      console.error("Running a generic command! POOP!")
+    def run( args=nil )
+      console.error 'Running the generic command!!! WAT?'
     end
   end
 end

data/lib/core/commands/broker.rb

@@ -3,53 +3,52 @@ require 'socket'
 
 module Nutella
   class Broker < Command
-    @description = "Displays information about the current broker and allows us to change it"
+    @description = 'Displays information about the broker and allows to change it'
   
     def run(args=nil)
-      # If no argument then we jsut display info about the broker
+
+      # If no argument then we just display info about the broker
       if args==nil || args.empty?
-        getBrokerInfo
+        print_broker_info
         return
       end
       # If there are arguments we are doing manipulations
-      case args[0]
-      when "set"
-        changeBroker args[1]
-      # when "start"
-      #   startBroker
-      # when "stop"
-      #   stopBroker
+      sub_command = args[0]
+      sum_command_param = args[1]
+      if sub_command=='set'
+        change_broker sum_command_param
       else
-        console.warn "Unknown `nutella broker` option #{args[0]}. Try `nutell broker`, ` nutella broker set <broker> instead"
+        console.warn "Unknown 'nutella broker' option #{sub_command}. Try 'nutella broker' or 'nutella broker set <new_broker>' instead"
       end
-      
     end
     
     private
     
-    def getBrokerInfo
-      if Nutella.config["broker"].nil?
-        console.warn "No broker has been specified yet. Please, run `nutella broker set <broker>` to specify a broker."
+    def print_broker_info
+      if Nutella.config['broker'].nil?
+        console.warn 'No broker has been specified yet. Please, run `nutella broker set <broker>` to specify a broker'
       else
-        console.info"Currently using broker: #{Nutella.config["broker"]}"
+        console.info "Currently using broker: #{Nutella.config['broker']}"
       end
     end
     
     
-    def changeBroker(broker)
+    def change_broker( new_broker )
       # Check that there are no runs hinging on this broker
-      if !Nutella.runlist.empty?
-        console.warn "You are currently running some projects on this broker. You can't change the broker while running."
+      unless Nutella.runlist.empty?
+        console.warn 'You are currently running some projects on this broker. You can\'t change the broker while running.'
         return
       end
-      # Change it
+      # Try to parse the hostname and switch to the new broker
       begin
-        IPSocket.getaddress(broker)
+        IPSocket.getaddress new_broker
       rescue
-        console.warn "Not a valid hostname for a broker"
+        console.warn "#{new_broker} is not a valid hostname for a broker"
+        return
       end
-      Nutella.config["broker"] = broker
-      console.success "Now using broker: #{Nutella.config["broker"]}"
+      Nutella.config['broker'] = new_broker
+      # Print a confirmation message
+      console.success "Now using broker: #{Nutella.config['broker']}"
     end
     
   end

data/lib/core/commands/checkup.rb

@@ -3,51 +3,53 @@ require 'semantic'
 
 module Nutella
   class Checkup < Command
-    @description = "Checks that all the dependencies are installed and prepares nutella to run"
+    @description = 'Checks that all the dependencies are installed and prepares nutella to run'
   
-    def run(args=nil)
+    def run( args=nil )
+
       # First check that we have all the tools we need to run nutella
-      if !allDependenciesInstalled?
-        return
-      end
+      return unless all_dependencies_installed?
       
-      # Check if we have a broker and install one if not
-      if !File.directory? Nutella.config["broker_dir"]
-        console.warn "You don't seem to have a local broker installed so we are going to go ahead and install one for you. This might take some time..."
-        if !installBroker
-          console.error "Whoops...something went wrong while installing the broker. "
+      # Check if we have a local broker installed
+      # and install one if we don't
+      if File.directory? Nutella.config['broker_dir']
+        console.info 'You have a local broker installed. Yay!'
+      else
+        console.warn 'You don\'t seem to have a local broker installed so we are going to go ahead and install one for you. This might take some time...'
+        unless install_local_broker
+          console.error 'Whoops...something went wrong while installing the broker'
           return
         end
-      else
-        console.info "You have a local broker installed. Yay!"
       end
           
-      # Set config and output message
-      Nutella.config["ready"] = true
-      console.success("All systems go! You are ready to use nutella!")
+      # Set ready flag in config.json
+      Nutella.config['ready'] = true
+
+      # Output success message
+      console.success 'All systems go! You are ready to use nutella!'
     end
     
   
     private 
     
   
-    def installBroker    
+    def install_local_broker
       # Clone, cd and npm install
-      out1 = system "git clone git://github.com/mcollina/mosca.git #{Nutella.config["broker_dir"]} > /dev/null 2>&1"
-      Dir.chdir(Nutella.config["broker_dir"])
-      out2 = system "npm install > /dev/null 2>&1"
+      out1 = system "git clone git://github.com/mcollina/mosca.git #{Nutella.config['broker_dir']} > /dev/null 2>&1"
+      Dir.chdir(Nutella.config['broker_dir'])
+      out2 = system 'npm install > /dev/null 2>&1'
     
-      # Add startup script
-      File.open("startup", 'w') { |file| file.write("#!/bin/sh\n\nBASEDIR=$(dirname $0)\n$BASEDIR/bin/mosca --http-port 1884 &\necho $! > $BASEDIR/bin/.pid\n") }
-      File.chmod(0755, "startup")
+      # Add startup script and make it executable
+      File.open('startup', 'w') { |file| file.write("#!/bin/sh\n\nBASEDIR=$(dirname $0)\n$BASEDIR/bin/mosca --http-port 1884 &\necho $! > $BASEDIR/bin/.pid\n") }
+      File.chmod( 0755, 'startup' )
     
-      # Add configuration
-      Nutella.config["broker"] = "localhost"
-      return out1 && out2
+      # Write configuration into config.json
+      Nutella.config['broker'] = 'localhost'
+      out1 && out2
     end
     
     
-    def allDependenciesInstalled?
+    def all_dependencies_installed?
       # Node version lambda
       node_semver = lambda do
         out = `node --version`
@@ -67,34 +69,31 @@ module Nutella
         Semantic::Version.new "#{out[0..2]}.0"
       end
       # Check versions
-      if checkVersion?("node", "0.10.0", node_semver) \
-        and checkVersion?("git", "1.8.0", git_semver) \
-        and checkVersion?("tmux", "1.8.0", tmux_semver) 
-        return true
-      end
+      return true if check_version?('node', '0.10.0', node_semver) && check_version?('git', '1.8.0', git_semver) && check_version?('tmux', '1.8.0', tmux_semver)
+      # If even one of the checks fails, return false
       false
     end
     
     
-    def checkVersion?(dep, req_version, lambda)
+    def check_version?(dep, req_version, lambda)
       begin
         actual_version = lambda.call
       rescue
-        console.warn "Doesn't look like #{dep} is installed in your system. " + 
-          "Unfotunately nutella can't do much unless all the dependencies are installed :("
+        console.warn "Doesn't look like #{dep} is installed in your system. " +
+          "Unfortunately nutella can't do much unless all the dependencies are installed :("
           return
       end
       required_version = Semantic::Version.new req_version 
       if actual_version < required_version
         console.warn "Your version of #{dep} is a little old (#{actual_version}). Nutella requires #{required_version}. Please upgrade!"
-        return
+        false
       else
         console.info "Your #{dep} version is #{actual_version}. Yay!"
         true
       end
     end
-    
-    
+
   end
+
 end
 

data/lib/core/commands/help.rb

@@ -3,11 +3,11 @@ require 'core/command'
 module Nutella
     
   class Help < Command
-    @description = "Displays what every command does and how to use it"
+    @description = 'Displays what every command does and how to use it'
   
     def run(args=nil)
-      message=""
-      Dir[File.dirname(__FILE__)+"/*.rb"].each do |file|
+      message=''
+      Dir["#{File.dirname(__FILE__)}/*.rb"].each do |file|
         message += "#{File.basename(file, File.extname(file))}\t\t"
         message += Object::const_get("Nutella::#{File.basename(file, File.extname(file)).capitalize}").description
         message += "\n"

data/lib/core/commands/install.rb

@@ -10,7 +10,7 @@ module Nutella
   
     def run(args=nil)
       # Is current directory a nutella prj?
-      return unless Nutella.currentProject.exist?
+      return unless Nutella.current_project.exist?
     
       # Check args
       if args.empty?
@@ -21,7 +21,7 @@ module Nutella
       destination_dir = args.length==2 ? args[1] : nil
       
       # Extract project directory
-      prj_dir = Nutella.currentProject.dir
+      prj_dir = Nutella.current_project.dir
 
       # What kind of template are we handling?
       if is_template_a_local_dir? template
@@ -91,10 +91,9 @@ module Nutella
       # If all is good, copy the template to dest_dir...
       FileUtils.copy_entry template_dir, dest_dir
 
-      # ... and remove nutella.json, .git folder and .gitignore file if they exist
+      # ... and remove nutella.json and .git folder if they exist
       File.delete "#{dest_dir}/nutella.json" if File.exist? "#{dest_dir}/nutella.json"
       FileUtils.rm_rf "#{dest_dir}/.git"
-      File.delete "#{dest_dir}/.gitignore" if File.exist? "#{dest_dir}/.gitignore"
 
       # Make the user feel happy and accomplished! :)
       console.success("Installed template: #{template} as #{dest_dir_name}")

data/lib/core/commands/new.rb

@@ -3,60 +3,58 @@ require 'fileutils'
 
 module Nutella
   class New < Command
-    @description = "Creates a new project"
+    @description = 'Creates a new project'
   
     def run(args=nil)
-      @prj_dir = args[0]
+      cur_prj_dir = args[0]
     
       # If no other arguments, show help and quit here
       if args.empty?
-        console.warn "You need to specify a name for your new project. Can't create project."
+        console.warn 'You need to specify a name for your new project'
         return
       end
     
-      # Does a project/directory with the same name exist already?
-      if File.directory?(@prj_dir)
-        if File.exist?("#{@prj_dir}/conf/project.json")
-          console.warn "A project named #{@prj_dir} already exists. Can't create project."
+      # Check that a directory (i.e. project) with the same name doesn't already exist
+      # If it does it looks into it to see if there is a nutella.json file and displays
+      # the proper error message
+      if File.directory? cur_prj_dir
+        if File.exist? "#{cur_prj_dir}/nutella.json"
+          console.warn "A project named #{cur_prj_dir} already exists"
           return
         else
-          console.warn "A directory named #{@prj_dir} already exists. Can't create project."
+          console.warn "A directory named #{cur_prj_dir} already exists"
           return
         end
       end
     
-      # Generate project structure
-      @cur_dir = Dir.pwd  # Store current directory
-      createDirStructure  # Create project directory structure
-      Dir.chdir @prj_dir  # CD into the project
+      # If all seems good, generate the project structure
+      create_dir_structure cur_prj_dir
+
       # Display a nice success message and return
-      console.success "Your new project #{@prj_dir} is ready!" 
+      console.success "Your new project #{cur_prj_dir} is ready!"
     end
     
     
     private 
   
   
-    def createDirStructure
-      FileUtils.mkdir_p("#{@prj_dir}/bots")       # bots dir
-      FileUtils.mkdir_p("#{@prj_dir}/interfaces") # interfaces dir
-      FileUtils.mkdir_p("#{@prj_dir}/conf")       # conf dir
-      # create base configuration file
+    def create_dir_structure( cur_prj_dir )
+      # Create directories
+      FileUtils.mkdir_p("#{cur_prj_dir}/bots")
+      FileUtils.mkdir_p("#{cur_prj_dir}/interfaces")
+      # Create nutella.json hash
       config_file_hash = {
-        "nutella_version" => File.open(NUTELLA_HOME+"VERSION", "rb").read,
-        "name" => @prj_dir,
-        "version" => "0.1.0-SNAPSHOT"
+        :name => cur_prj_dir,
+        :version => '0.1.0',
+        :nutella_version => File.open("#{NUTELLA_HOME}VERSION", 'rb').read,
+        :type => 'project',
+        :description => 'A quick description of your project'
       }
-      File.open("#{@prj_dir}/conf/project.json","w") do |f|
+      # Write nutella.json hash
+      File.open("#{cur_prj_dir}/nutella.json", 'w') do |f|
         f.write(JSON.pretty_generate(config_file_hash))
       end
     end
   
-    def removeDirStructure
-      Dir.chdir @cur_dir
-      console.info "Removing project #{@prj_dir}"
-      FileUtils.rm_rf(@prj_dir)
-    end
-  
   end
 end

data/lib/core/commands/runs.rb

@@ -3,18 +3,18 @@ require 'core/command'
 
 module Nutella
   class Runs < Command
-    @description = "Displays list of all the runs, you can filter by passing a project id"
+    @description = 'Displays list of runs for current project or all projects'
   
     def run(args=nil)
-      # If invoked with "--all" it will show all the runs under this instance of nutella
-      if args[0]=="--all"
-        displayGlobalRuns
+
+      # If invoked with "all" it will show all the runs under this instance of nutella
+      if args[0]=='all'
+        display_all_runs
       else
-        # Is current directory a nutella prj?
-        if !Nutella.currentProject.exist?
-          return
-        end
-        displayProjectRuns     
+        # If current dir is not a nutella project, return
+        return unless Nutella.current_project.exist?
+        # Display list of runs for current nutella project
+        display_project_runs
       end
     end
     
@@ -22,35 +22,26 @@ module Nutella
     private 
     
     
-    def displayGlobalRuns
+    def display_all_runs
       if Nutella.runlist.empty?
-        console.info "You are not running any projects"
+        console.info 'You are not running any projects'
       else
-        console.info "Currently running:"
-        Nutella.runlist.to_a.each { |run| console.info " #{run}" }   
+        console.info 'Currently running:'
+        Nutella.runlist.runs_by_project.each { |run| console.info " #{run}" }
       end
     end
     
-    
-    def displayProjectRuns
-      project_name = Nutella.currentProject.config["name"]
-      runs = Nutella.runlist.to_a project_name
-      if runs.empty?
-        console.info "Currently running #{runs.length} instances of project #{project_name}"
-        return
-      end
-      printProjectRuns(project_name, runs)
-    end
-    
-    
-    def printProjectRuns(project_name, runs)
+    def display_project_runs
+      project_name = Nutella.current_project.config['name']
+      runs = Nutella.runlist.runs_by_project project_name
       console.info "Currently running #{runs.length} instances of project #{project_name}:"
-      runs.to_a.each do |run| 
-        run.slice! "#{project_name}_"
-        if run.empty? 
-          console.info "progetto (default)"
+      runs.each do |run|
+        run_id = run.dup
+        run_id.slice! "#{project_name}_"
+        if run_id.empty?
+          console.info " #{project_name}"
         else
-          console.info " #{run}" 
+          console.info " #{run}"
         end
       end
     end