copernicium 0.0.3 → 0.1

data/lib/required.rb

@@ -12,10 +12,10 @@ require 'net/scp'       # Needed for file transfer between servers
 
 # coperncicium files
 
-require_relative "banners"
-require_relative "RevLog"
-require_relative "repos"
-require_relative "pushpull"
-require_relative "workspace"
-require_relative "ui"
+require_relative 'banners'
+require_relative 'RevLog'
+require_relative 'repos'
+require_relative 'pushpull'
+require_relative 'workspace'
+require_relative 'ui'
 

data/lib/ui.rb

@@ -1,7 +1,7 @@
 # user interface module - parse and execute commands
 # integrates all modules, central module
 
-VERSION = "0.0.3"
+VERSION = "0.1"
 
 module Copernicium
   # Communication object that will pass commands to backend modules
@@ -9,7 +9,7 @@ module Copernicium
   # rev - revision indicator (commit #, branch name, HEAD, etc.)
   # repo - URL/path to a remote repository
   class UIComm
-    attr_reader :command, :files, :rev, :cmt_msg, :repo, :opts
+    attr_accessor :command, :files, :rev, :cmt_msg, :repo, :opts
     def initialize(command: nil, files: nil, rev: nil,
                    cmt_msg: nil, repo: nil, opts: nil)
       @cmt_msg = cmt_msg
@@ -21,16 +21,11 @@ module Copernicium
     end
   end
 
+  # todo - consider refactoring some UIComm usage
   # main driver for the command line user interface
   module Driver
     include Repos # needed to get branch and history info
     include Workspace # needed for most high level commands
-    def setup
-      Repos.setup
-      RevLog.setup
-      Workspace.setup
-    end
-
     # Executes the required action for a given user command.
     #
     # Parameters:
@@ -55,36 +50,42 @@ module Copernicium
       # if no arguments given show help information
       pexit COMMAND_BANNER, 0 if (cmd == '-h' || cmd == 'help')
 
-      # if not in a repo, warn them, tell how to create
-      puts REPO_WARNING.yel if (noroot? && cmd != 'init')
-
-      # Handle standard commands
-      case cmd
-      when 'init'
-        init args
-      when 'status'
-        status args
-      when 'history'
-        history args
-      when 'branch'
-        branch args
-      when 'clean'
-        clean args
-      when 'clone'
-        clone args
-      when 'commit'
-        commit args
-      when 'checkout'
-        checkout args
-      when 'merge'
-        merge args
-      when 'push'
-        push args
-      when 'pull'
-        pull args
-      else # handle an unrecognized argument, show help and exit
-        pexit "Unrecognized command #{cmd}\n" + COMMAND_BANNER, 1
-      end
+      # create the cn project, else already in one
+      if cmd == 'init'
+        noroot?? init(args) : puts(IN_REPO_WARNING.yel, getroot)
+      elsif noroot? # if not in a repo, warn them, tell how to create
+        puts NO_REPO_WARNING.yel
+      else # now, assume we are in a copernicum project
+        Workspace.setup
+
+        # Handle all other commands
+        case cmd
+        when 'status'
+          status args
+        when 'history'
+          history args
+        when 'branch'
+          branch args
+        when 'clean'
+          clean args
+        when 'clone'
+          clone args
+        when 'commit'
+          commit args
+        when 'checkout'
+          checkout args
+        when 'merge'
+          merge args
+        when 'push'
+          push args
+        when 'pull'
+          pull args
+        when 'init'
+          # fall through - init handled above, before case statement
+        else # handle an unrecognized argument, show help and exit
+          pexit "Unrecognized command #{cmd}\n" + COMMAND_BANNER, 1
+        end
+      end # case
     end # run
 
     # Print and exit with a specific code
@@ -95,114 +96,152 @@ module Copernicium
 
     # Get some info from the user when they dont specify it
     def get(info)
-      puts "Note: #{info} not specified. Enter #{info} to continue."
+      puts "Note: #{info} not specified. Enter #{info} to continue.".yel
       gets.chomp # read a line from user, and return it
     end
 
     # create a new copernicium repository
     def init(args)
       if args.empty?
-        Workspace.create_project
+        root = Workspace.create_project
       else # init into a folder
-        Workspace.create_project args.first
+        root = Workspace.create_project args.first
       end
-      puts "Created Copernicium repo in " + Dir.pwd.grn
+      puts "Created Copernicium repo: ".grn + root
       UIComm.new(command: 'init', opts: args)
     end
 
     # show the current repos status
     def status(args)
-      ui = UIComm.new(command: 'status', opts: args)
       st = Workspace.status
-      st[0].each { |f| puts "Added:\t".grn + f }
-      st[1].each { |f| puts "Edited:\t".yel + f }
-      st[2].each { |f| puts "Removed:\t".red + f }
-      ui
-    end
-
-    # check whether a specific branch exists
-    def isbranch?(branch)
-      Repos.branches.include? branch
+      if st.all?(&:empty?)
+        puts "No changes since last commit | ".grn +
+          (Repos.current_snaps.last.time + ' | ').yel +
+          Repos.current_snaps.last.msg
+      else
+        st[0].each { |f| puts "Added:   ".grn + f }
+        st[1].each { |f| puts "Edited:  ".yel + f }
+        st[2].each { |f| puts "Removed: ".red + f }
+      end
     end
 
     # create and switch to a new branch
     def create_branch(branch)
       new_branch_hash = Repos.make_branch branch
       Repos.update_branch branch
-      puts "Created new branch '#{branch}' with head #{new_branch_hash}".grn
+      puts "Created branch #{branch} ".grn + " with head #{new_branch_hash}"
     end
 
     def branch(args)
-      branch = args.first
+      branch = args.shift
       if branch.nil? # show all branches
+        puts "Current: ".grn + Repos.current
         puts "Branches: ".grn + Repos.branches.join(' ')
+
       elsif branch == '-c' # try to create a new branch
-        # If branch name not specified, get it from the user
-        branch = args[1]
+        branch = args.first # get from the user
         branch = get "new branch name" if branch.nil?
-
-        # Create and switch to the new branch
         create_branch branch
+
       elsif branch == '-r' # rename the current branch
-        # If branch name not specified, get it from the user
-        newname = args[1]
+        newname = args.first # get if not specified
         newname = get "new name for current branch" if newname.nil?
-
-        oldname = Repos.branch
-
-        # Create and switch to a new branch with the given name
+        oldname = Repos.current
         create_branch newname
-
-        # Delete the branch with the old name
         Repos.delete_branch oldname
         puts "Deleted branch '#{oldname}'".grn
         puts "Renamed branch '#{oldname}' to '#{newname}'".grn
+
       elsif branch == '-d' # Delete the specified branch
-        # If branch name not specified, get it from the user
-        branch = args[1]
+        branch = args.first # If not specified, get
         branch = get "branch to delete" if branch.nil?
-
-        # Do not delete the current branch
-        if branch == Repos.branch
-          pexit "Cannot delete the current branch!".red, 1
+        if branch == Repos.current
+          puts "Cannot delete the current branch!".red
+        else # Delete the specified branch
+          Repos.delete_branch branch
+          puts "Deleted branch '#{branch}'".grn
         end
 
-        # Delete the specified branch
-        Repos.delete_branch branch
-        puts "Deleted branch '#{branch}'".grn
-      elsif isbranch? branch # switch branch
-        Repos.update_branch  branch
-      else # branch does not exist, create it, switch to it
+      elsif Repos.has_branch? branch # switch branch (branch <branch name>)
+        Repos.update_branch branch
+        puts "Current: ".grn + Repos.current
+
+      else # create it, switch to it
         Repos.create_branch branch
       end
     end
 
     def push(args)
-      UIComm.new(command: 'push', opts: args)
-      # todo - make call to pushpull, push remote
+      # Command usage is:
+      #   cn push <user> <repo.host:/dir/of/repo> <branch-name>
+      #
+      # If username not given, get it from the user.
+      user = args[0]
+      if user.nil?
+        user = get "username for push"
+        # Make sure username is the first arg, since PushPull is expecting this.
+        args << user
+      end
+
+      remote = args[1]
+      remote = get "remote path to push to (format: <repo.host:/dir/of/repo>)" if remote.nil?
+
+      branchname = args[2]
+      branchname = get "remote branch to push to" if branchname.nil?
+
+      comm = UIComm.new(command: 'push', opts: args, repo: remote, rev: branchname)
+      # Do the push
+      PushPull.UICommandParser(comm)
+
+      comm
     end
 
     def pull(args)
-      UIComm.new(command: 'pull', opts: args)
-      #def pull(remote, branch', remote_dir)
-      # todo - make call to pushpull, pull remote
+      # Command usage is:
+      #   cn pull <user> <repo.host:/dir/of/repo> <branch-name>
+      #
+      # If username not given, get it from the user.
+      user = args[0]
+      if user.nil?
+        user = get "username for pull"
+        # Make sure username is the first arg, since PushPull is expecting this.
+        args << user
+      end
+
+      remote = args[1]
+      remote = get "remote path to pull from (format: <repo.host:/dir/of/repo>)" if remote.nil?
+
+      branchname = args[2]
+      branchname = get "remote branch to pull from" if branchname.nil?
+
+      comm = UIComm.new(command: 'pull', opts: args, repo: remote, rev: branchname)
+      # Do the pull
+      PushPull.UICommandParser(comm)
+
+      comm
     end
 
+    # Take in a revision (snaptshot) id or branch
+    # Doesnt support file checkouts at this time
     def checkout(args)
       if args.empty?
-        rev = get 'branch or revision'
+        rev = get 'branch or commit id'
       else
         rev = args.shift
         files = args
       end
 
-      # if it is a branch, get the last head of it
-      rev = Repos.history(rev).last.id if isbranch? rev
+      # if 'head' keyword, grab the head
+      if rev == 'head'
+        rev = Repos.current_head
+      elsif Repos.has_branch? rev
+        branch = rev
+        rev = Repos.history(rev).last
+      end
 
       # call workspace checkout the given / branch
-      ui = UIComm.new(command: 'checkout', rev: rev, files: files)
-      Workspace.checkout(ui)
-      ui
+      Workspace.checkout(UIComm.new(rev: rev, files: files))
+      Repos.update_branch branch unless branch.nil?
     end
 
     def clean(args = [])
@@ -212,15 +251,23 @@ module Copernicium
     end
 
     def clone(args)
-      if args.empty?
-        repo = get 'repo url to clone'
-      else
-        repo = args.first
+      # Command usage is:
+      #   cn clone <user> <repo.host:/dir/of/repo>
+      user = args.first
+      if user.nil?
+        user = get "username for clone"
+        # Make sure username is first arg, since PushPull is expecting this.
+        args << user
       end
 
-      # todo - actually clone remote locally
+      repo = args[1]
+      repo = get "repo url to clone (format: <repo.host:/dir/of/repo>)" if repo.nil?
+
+      comm = UIComm.new(command: 'clone', opts: args, repo: repo)
+      # Do the clone
+      PushPull.UICommandParser(comm)
 
-      UIComm.new(command: 'clone', repo: repo)
+      comm
     end
 
     def commit(args)
@@ -239,27 +286,40 @@ module Copernicium
 
       # perform the commit, with workspace
       ui = UIComm.new(command: 'commit', files: files, cmt_msg: message)
-      Workspace.commit(ui)
+      puts "New commit: ".grn + Workspace.commit(ui)
       ui
     end
 
     def history(args)
-      puts Repos.history
+      Repos.current_snaps.reverse_each do |snap|
+        puts (snap.time + ' | ') .grn + (snap.id + ' | ').yel + snap.msg
+      end
     end
 
     def merge(args)
       if args.empty?
-        puts 'I need a commit or branch to merge.'
         rev = get 'single commit or branch to merge'
-      else # use given
+      else
         rev = args.first
-        # get all branchs, see if arg is in it.
-        # if so, look up snapshot of <branch> head
-        # TODO - parse whether given arg is a branch name, else assume snap id
-        # todo - call repos merge command
-        # todo show conflicting files
-        UIComm.new(command: 'merge', rev: rev)
       end
+
+      # If rev is a branch name, resolve it to a rev ID.
+      if Repos.has_branch? rev
+        rev = (Repos.history rev).last
+      end
+
+      conflicts = Workspace.merge(rev)
+
+      # If there were any conflicts, display them to the user.
+      if not conflicts.nil?
+
+        conflicts.each do |conflict|
+          puts "   #{conflict}".red
+        end
+      end
+
+      # Don't return a UIComm object, since we didn't use one for any of the
+      # backend calls.
     end
   end # Driver
 end

data/lib/workspace.rb

@@ -18,49 +18,58 @@ module Copernicium
     end
 
     # returns most recent file id in the snapshot it was saved in
-    def last
-      @history.last
-    end
-  end
-
-  # helper methods for file IO
-  def writeFile(path, content)
-    f = open(path, 'w')
-    f.write(content)
-    f.close
-  end
-
-  # helper methods for file IO
-  def readFile(path)
-    f = open(path, 'r')
-    txt = f.read
-    f.close
-    txt
-  end
+    def last() @history.last end
+  end # FileObj
+
 
+  # todo - @@files really should be a Hash, with paths as keys, then rather than
+  # using indices.
   module Workspace
     include Repos # needed for keeping track of history
-    def Workspace.setup(bname = 'master')
-      @@files = []
+    def Workspace.setup
       @@cwd = Dir.pwd
       @@root = (noroot?? @@cwd : getroot)
+      @@root.sub!(@@cwd, '.')
       @@copn = File.join(@@root, '.cn')
-      Dir.mkdir(@@copn) unless Dir.exist?(@@copn)
-      @@cwd.sub!(@@root, '.')
-      @@branch = bname
+      @@snap = File.join(@@copn, 'snap')
+      @@revs = File.join(@@copn, 'revs')
       RevLog.setup @@root
       Repos.setup @@root
+      @@files = Repos.current_files
+      @@branch = Repos.current
     end
 
     # create a new copernicium project
-    def Workspace.create_project(location = Dir.pwd)
-      Dir.mkdir location if !File.exists? location
+    def Workspace.create_project(location = Dir.pwd, branch = 'master')
+      Dir.mkdir location unless Dir.exist? location
       Dir.chdir location
-      errmsg = 'Copernicium folder (.cn) not found, could not create.'.red
-      pexit errmsg, 1 if noroot?
+
+      # create our copernicium folders
+      @@copn = File.join('.', '.cn')
+      @@snap = File.join(@@copn, 'snap')
+      @@revs = File.join(@@copn, 'revs')
+      @@head = File.join(@@copn, 'branch')
+      @@hist = File.join(@@copn, 'history')
+      Dir.mkdir(@@copn) unless Dir.exist?(@@copn)
+      Dir.mkdir(@@snap) unless Dir.exist?(@@snap)
+      Dir.mkdir(@@revs) unless Dir.exist?(@@revs)
+
+      # make default branch, history
+      hist = YAML.dump({branch => []})
+      File.write @@head, branch
+      File.write @@hist, hist
+
+      if Dir.exist?(@@copn)
+        location # return where we made the repo
+      else # something has gone horribly wrong
+        raise 'Could not create or find a Copernicium folder (.cn).'.red
+      end
     end
 
-    # find  the root .cn folder
+
+    # PROJECT HELPERS
+    #
+    # find  the root .cn folder, or return nil if it doesnt exist
     def getroot
       cwd = Dir.pwd
       max = 0
@@ -82,174 +91,136 @@ module Copernicium
     end
 
     # tells us whether we are in a cn project or not
-    def noroot?
-      getroot.nil?
-    end
+    def noroot?() getroot.nil? end
 
-    # workspace management
+
+    # WORKSPACE MANAGEMENT
+    #
     def Workspace.indexOf(x)
-      index = -1
-      @@files.each_with_index do |e,i|
-        if e.path == x
-          index = i
-          break
-        end
+      @@files.each_with_index do |f, i|
+        return i if f.path == x
       end
-      index
-    end
-
-    # if include all the elements in list_files
-    def Workspace.include?(files)
-      files.each { |x| return false if indexOf(x) == -1 }
-      true
+      nil # x is not included in @@files
     end
 
-    # get all files currently in workspace, except folders and .cn/*
-    def Workspace.ws_files
-      Dir[ File.join(@@root, '**', '*') ].reject do |p|
-        File.directory? p || File.join(@@root,'.cn').include?(p) == false
+    # get array of filenamess currently in workspace, except folders and .cn/*
+    # todo - include files and files that start with a dot (.)
+    def Workspace.working_files
+      (Dir[ File.join(@@root, '**', '*') ].reject do |p|
+        File.directory? p || p.include?(@@copn)
+      end).map do |p|
+        p.sub!(/^\.\//, '') # delete leading './'
       end
     end
 
-    # Clear the current workspace
+    # Clear the workspace
     def Workspace.clear
       @@files.each{ |x| File.delete(x.path) }
       @@files = []
     end
 
-    # reset first: delete them from disk and reset @@files
-    # restore it with checkout() if we have had a branch name
-    # or it is the initial state, no commit and no checkout
-    # if list_files is nil, then rollback the list of files from the branch
-    # or rollback to the entire branch head pointed
-    def Workspace.clean(comm)
-      if comm.files.empty? # reset, checkout last commit
-        Workspace.clear
-        Workspace.checkout
-      else # files are not nil
+    # take in file object, restore
+    def Workspace.checkout_file(file)
+      idx = indexOf(file.path)
+      idx.nil?? @@files << file : @@files[idx] = file
+      File.write(file.path, RevLog.get_file(file.last))
+    end
 
-        # exit if the specified file is not in the workspace
-        return -1 if (self.include? comm.files) == false
+    # takes in a snapshot id, sets workspace to that snapshot
+    def Workspace.checkout(comm = UIComm.new)
+      comm.rev = Repos.current_head if comm.rev.nil?
+      if ! Repos.has_snapshots? # dont checkout
+        puts 'No snapshots yet! Commit something before checkout.'.red
+      elsif comm.files.nil? # checkout everything
+        Repos.get_snapshot(comm.rev).files.each do |file|
+          Workspace.checkout_file file
+        end
+      else # just checkout given files
+        Repos.get_snapshot(comm.rev).files.select { |f|
+          comm.files.include? f.path }.each do |file|
+          Workspace.checkout_file file
+        end
+      end
+    end
 
-        # the actual action, delete all of them from the workspace first
+    # reset repo back to a given state
+    def Workspace.clean(comm = UIComm.new)
+      if comm.files.nil? # reset everything
+        Workspace.clear
+      else # files are not nil
         comm.files.each do |x|
-          File.delete(x)
           idx = indexOf(x)
-          @@files.delete_at(idx) if !idx == -1
+          if idx.nil?
+            puts "Cannot clean #{x}:".yel + " does not exist in snapshot"
+          else
+            @@files.delete_at(idx)
+            File.delete(x)
+          end
         end
-
-        # if we have had a branch, first we get the latest snapshot of it
-        # and then checkout with the restored version of them
-        checkout
+      end
+      Workspace.checkout comm # cleanse state
+    end
+
+    def Workspace.commit_file(x)
+      puts 'Committing: '.grn + x
+      added, edits, remov = Workspace.status
+      if added.include? x
+        hash = RevLog.add_file(x, File.read(x))
+        @@files.push(FileObj.new x, [hash])
+      elsif edits.include? x
+        hash = RevLog.add_file(x, File.read(x))
+        @@files[indexOf x].history << hash
+      elsif remov.include? x
+        @@files.delete_at(indexOf x)
+      else
+        puts 'Failed, no changes: '.yel + x
       end
     end
 
     # commit a list of files or the entire workspace to make a new snapshot
-    def Workspace.commit(comm)
+    def Workspace.commit(comm = UIComm.new)
       if comm.files.nil? # commit everything
-        Workspace.ws_files.each do |x|
-          if indexOf(x) == -1
-            content = readFile(x)
-            hash = RevLog.add_file(x, content)
-            fobj = FileObj.new(x, [hash,])
-            @@files.push(fobj)
-          else # file exists
-            content = readFile(x)
-            hash = RevLog.add_file(x, content)
-            if @@files[indexOf(x)].history[-1] != hash
-              @@files[indexOf(x)].history << hash
-            end
-          end
+        Workspace.status.each do |st|
+          st.each { |x| Workspace.commit_file x }
         end
-      else # just commit certain files
-      end
-      Repos.make_snapshot(@@files) # return snapshot id
-    end
-
-    def Workspace.checkout(comm)
-=begin
-      # just support revisions for now
-      # if argu is an Array Object, we assume it is a list of files to be added
-      # # to the workspace # we add the list of files to @@files regardless
-      # whether it has been in # it. that means there may be multiple versions
-      # of a file.
-      unless comm.files.nil?
-        list_files = comm.files
-        returned_snapshot = Repos.get_snapshot(Repos.history.last)
-        list_files_last_commit = returned_snapshot.files
-        list_files_last_commit.each do |x|
-          if list_files.include? x.path
-            content = RevLog.get_file(x.history.last)
-            idx = indexOf(x.path)
-            if  idx == -1
-              @@files << x
-            else
-              @@files[idx] = x
-            end
-            writeFile(x.path, content)
+      else comm.files.each do |x|
+          if File.exist? x
+            Workspace.commit_file(x)
+          else
+            puts "Cannot commit #{x}:".yel + " file does not exist"
           end
         end
-      else # if argu is not an Array, we assume it is a String, representing the
-      end
-=end
-
-      clear # reset workspace
-
-      # Dec. 3th, 2015 by Linfeng,
-      # for this command, the comm.rev should be a string representing the branch name
-      @@branch = comm.rev
-      Repos.update_branch(@@branch)
-
-      # if not snapshots exist, dont checkout
-      return -1 unless Repos.has_snapshots?
-
-      # if no snapshot files, dont checkout
-      snap = Repos.get_snapshot(comm.rev)
-      return -1 if snap.files.nil?
-
-      # object and finally push all files of it to the # workspace
-      snap.files.each do |file|
-        idx = indexOf(file.path)
-        puts file
-        if  idx == -1
-          @@files << file
-        else
-          @@files[idx] = file
-        end
-        content = RevLog.get_file(file.history.last)
-        writeFile(file.path, content)
       end
+      # todo - handle case of no changes, dont make a snapshot
+      Repos.make_snapshot(@@files, comm.cmt_msg) # return snapshot id
     end
 
     # wrapper for Repos merge_snapshot, update workspace with result
+    # returns [{path => content}, [conflicting paths]]
+    # todo update workspace with result
+    # todo return any conflicting files
     def Workspace.merge(id)
-      # returns [{path => content}, [conflicting paths]]
       Repos.merge_snapshot(id)
-
-      # todo update workspace with result
-      # todo return any conflicting files
     end
 
     def Workspace.status
       added = []
       edits = []
       remov = []
-      ws_files.each do |f|
+      working_files.each do |f|
         idx = indexOf(f)
-        if idx == -1 # new file
+        if idx.nil? # new file
           added << f
-        else # changed file?
-          x2 = readFile(f) # get the current version
-          x1 = RevLog.get_file(@@files[idx].history.last)
-          edits << f if x1 != x2
+        else # changed file
+          edits << f if File.read(f) != RevLog.get_file(@@files[idx].last)
         end
       end
 
       # any deleted files from the last commit?
-      @@files.each { |f| remov << f.path unless (ws_files.include? f.path) }
+      remov = @@files.map(&:path) - working_files
 
       [added, edits, remov]
     end
-  end
-end
+  end # Workspace
+end # Copernicium