copernicium 0.0.3 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dba707602c7f877affc0641be13bd03bcf0148da
-  data.tar.gz: 62c8ea960286bcf26035bc94fe437756efa88fdd
+  metadata.gz: 2f146d401e84291f4f694ae9beef84ad4ea96616
+  data.tar.gz: 4771750c664405faebaab54e82fba71988b22c98
 SHA512:
-  metadata.gz: 6c07b40b065382971669a01444f0204e1ddef79ada08fb599b56b6b04d1ef9c6433a392be840823d7ba2ed86e5d66669564d5b5dedad4ef4591e5739deb91575
-  data.tar.gz: e27a5d5060d7a074e031b44034a6ad735ee8a74c692f5a951d88d38eb5539fd3881fc8c9b6b9a5caf838e7bfb9949657e95c127c277e2423de9c4ce09e76e194
+  metadata.gz: 11a03dc13faefeebc2e6070b2fd08da6d83ef658b5e543c1fb5340e02da2f4fca8d54651686ee1e309d83c8234a7c7c9c4fbd9cf86a346e51681e457f7c11e44
+  data.tar.gz: dffba98e39a8189a75f4cfde1ae9fd998d209dd61e87f8c6af7bb94735b95ff60a82094551fec411b1991140b17fb4933dbd09ca16428bb5fc3b148e9d718ffa

data/bin/cn

@@ -6,6 +6,5 @@ require_relative "../lib/required.rb"
 
 include Copernicium::Driver
 
-Copernicium::Driver.setup
 Copernicium::Driver.run(ARGV)
 

data/lib/RevLog.rb

@@ -26,12 +26,29 @@
 
 module Copernicium
   module RevLog
+    # called when including RevLog
+    # dont make any new folders
     def RevLog.setup(root = Dir.pwd)
-      @@root = root
-      @@cop_path = File.join(@@root, '.cn')
+      @@cop_path = File.join(root, '.cn')
       @@rev_path = File.join(@@cop_path, 'revs')
-      @@log_path = File.join(@@cop_path, 'logmap.yaml')
-      @@hash_path = File.join(@@cop_path, 'hashmap.yaml')
+      @@log_path = File.join(@@cop_path, 'logmap')
+      @@hash_path = File.join(@@cop_path, 'hashmap')
+      if File.exist?(@@log_path) && File.exist?(@@hash_path)
+        @@logmap = hash_array.merge(YAML.load_file(@@log_path))
+        @@hashmap = hash_array.merge(YAML.load_file(@@hash_path))
+      else
+        @@logmap = hash_array
+        @@hashmap = hash_array
+      end
+    end
+
+    # called when running the unit tests
+    # create a new folder for testing
+    def RevLog.setup_tester(root = Dir.pwd)
+      @@cop_path = File.join(root, '.cn')
+      @@rev_path = File.join(@@cop_path, 'revs')
+      @@log_path = File.join(@@cop_path, 'logmap')
+      @@hash_path = File.join(@@cop_path, 'hashmap')
       Dir.mkdir(@@cop_path) unless Dir.exist?(@@cop_path)
       Dir.mkdir(@@rev_path) unless Dir.exist?(@@rev_path)
       if File.exist?(@@log_path) && File.exist?(@@hash_path)
@@ -74,11 +91,11 @@ module Copernicium
 
 
     def RevLog.get_file(id)
-      file_path = File.join(@@rev_path, id)
+      file_path = File.join(@@rev_path, id.to_s)
       if File.exist? file_path
         File.open(file_path, 'r') { |f| return f.read }
       else
-        raise Exception, 'Invalid id!'
+        raise Exception, 'RevLog: invalid file revision id!'.red
       end
     end
 

data/lib/banners.rb

@@ -7,6 +7,7 @@ class String
   end
 
   def reset() colorize(0,0) end
+  def ugn()  colorize(32,4) end
   def blu()  colorize(34,0) end
   def yel()  colorize(33,0) end
   def grn()  colorize(32,0) end
@@ -15,32 +16,35 @@ end
 
 # create large constant strings
 
+TOP_BANNER = 'Copernicium (cn) - simple DVCS'.ugn
+
 HELP_BANNER = <<-EOS
-Copernicium (cn) - simple DVCS
+#{TOP_BANNER}
 
-Starting out:
+#{'Starting out:'.grn}
     init - create a new repository
     status - check repo status
+    history - show repo commits
     help - show more commands
 EOS
 
 
 COMMAND_BANNER = <<-EOS
 #{HELP_BANNER}
-Commands:
-    clean [files]
+#{'Commands'.grn}
+    clean [files] [commit/branch]
     commit [files] -m <message>
-    checkout [files] <commit id>
-    branch [opt] [branchname]
+    checkout <commit id> [files]
+    branch [opt] [branch]
       -r | rename current branch
       -c | create a new branch
       -d | delete a branch
     merge <branch name>
     clone <remote url>
-    push [remote name]
-    pull [remote name]
+    push <remote user>
+    pull <remote user>
 
-Options:
+#{'Options'.grn}
     -v: print version
     -h: show help
 
@@ -48,6 +52,16 @@ Note: [optional] <required>
 
 EOS
 
-REPO_WARNING = <<-EOS
+
+IN_REPO_WARNING = <<-EOS
+You are currently in a Copernicium repo... `cn init` is not valid here!
+EOS
+
+NO_REPO_WARNING = <<-EOS
 You are not currently in a Copernicium repo... run `cn init` to create one!
 EOS
+
+AUTHOR_BANNER = <<-EOS
+  todo
+EOS
+

data/lib/pushpull.rb

@@ -2,47 +2,56 @@
 # CSC 253
 # PushPull Module
 # November 6, 2015
-require 'net/ssh'
-require 'net/scp'
 
 
 module Copernicium
-  class PushPull
+  # How to use for Push, Pull and Clone:
+  #   Push - cn push <user> <repo.host:/dir/of/repo> <branch-name>
+  #   Pull - cn pull <user> <repo.host:/dir/of/repo> <branch-name>
+  #   Clone - cn clone <user> <repo.host:/dir/of/repo>
+  class UIComm
+  end
 
+  module PushPull
+    include Repos # needed for calling their methods
     # Chris's edit
     # Takes in Ethan's UICommandCommunicator object and calls
     # a method based on the command
-    def UICommandParser(ui_comm)
+    #
+    # Fields in UIComm and what they are for me:
+    #   @opts - user
+    #   @repo - repo.host:/path/to/repo
+    #   @rev - branch name
+    def PushPull.UICommandParser(ui_comm)
       case ui_comm.command
       when "clone"
-        #clone()
-      when "merge"
-        # do merge stuff
+        clone(ui_comm.repo, ui_comm.opts.first)
       when "push"
-        #push(ui_comm.)
+        push(ui_comm.repo, ui_comm.rev, ui_comm.opts.first)
       when "pull"
-        #pull(ui_comm.branchname,)
+        pull(ui_comm.repo, ui_comm.rev, ui_comm.opts.first)
       else
-        print "Error: Invalid command supplied to PushPull!" # Bad error handling, will fix later
-        return nil
+        raise "Error: Invalid command supplied to PushPull".red
       end
     end
 
     # Function: connect()
     #
     # Description:
-    #   a net/ssh wrapper, if given a block will execute block on server, otherwise tests connection.
+    #   a net/ssh wrapper, if given a block will execute block on server,
+    #   otherwise tests connection.
     #
     # remote: the remote server, formatted "my.server"
     # user: the user to connect as
-    def connect(remote, user, &block)
+    def PushPull.connect(remote, user, &block)
       exit_code = false
+      puts 'inside PushPull connect'.blu
       if(block.nil?)
         begin
+          puts 'inside PushPull connect nil block path'.grn
           Net::SSH.start(remote, user) do |ssh|
-            result = ssh.exec!("echo Successful Connection!")
-            puts result
-            exit_code = true;
+            puts ssh.exec!("echo Successful Connection!")
+            exit_code = true
           end
         rescue
           begin
@@ -54,12 +63,11 @@ module Copernicium
             puts
 
             Net::SSH.start(remote, user, :password => passwd) do |ssh|
-              result = ssh.exec!("echo Successful Connection!")
-              puts result
-              exit_code = true;
+              puts ssh.exec!("echo Successful Connection!")
+              exit_code = true
             end
           rescue
-              puts "Unsuccessful Connection"
+            raise "Unsuccessful Connection".red
           end
         end
       else
@@ -67,7 +75,7 @@ module Copernicium
           Net::SSH.start(remote, user) do |ssh|
             yield ssh
           end
-          exit_code = true;
+          exit_code = true
         rescue
           begin
             print "Username for remote repo: "
@@ -80,9 +88,9 @@ module Copernicium
             Net::SSH.start(remote, user, :password => passwd) do |ssh|
               yield ssh
             end
-            exit_code = true;
+            exit_code = true
           rescue
-            puts "Unable to execute command!"
+            raise "Unable to execute command!".red
           end
         end
       end
@@ -94,9 +102,9 @@ module Copernicium
     # Description:
     #   a net/scp wrapper to copy to server
     #
-    # remote: the remote server and directory to pull from, formatted "my.server:/the/location/we/want"
+    # remote: the remote server and directory to pull from, formatted "my.server"
     # user: the user to connect as
-    def transfer(remote, user, &block)
+    def PushPull.transfer(remote, user, &block)
       exit_code = false
       begin
         Net::SCP.start(remote, user) do |scp|
@@ -117,7 +125,7 @@ module Copernicium
           end
           exit_code = true
         rescue
-          puts "Unable to upload file!"
+          raise "Unable to upload file!".red
         end
       end
     end
@@ -131,7 +139,7 @@ module Copernicium
     # dest: what we want of the branch, not needed for blocked calls
     # local: where we want to put the file, not needed for blocked calls
     # user: the user to connect as
-    def fetch(remote, dest, local, user, &block)
+    def PushPull.fetch(remote, dest, local, user, &block)
       exit_code = false
       if(block.nil?)
         begin
@@ -153,7 +161,7 @@ module Copernicium
             end
             exit_code = true
           rescue
-            puts "Unable to fetch file(s)!"
+            raise "Unable to fetch file(s)!".red
           end
         end
       else
@@ -176,7 +184,7 @@ module Copernicium
             end
             exit_code = true
           rescue
-            puts "Unable to fetch file(s)!"
+            raise "Unable to fetch file(s)!".red
           end
         end
       end
@@ -191,9 +199,12 @@ module Copernicium
     # remote: the remote server and directory to push to, formatted "my.server:/the/location/we/want"
     # branch: the branch that we are pushing to
     # user: the user to connect as
-    def push(remote, branch, user)
+    def PushPull.push(remote, branch, user)
       # check contents of folder for .cn, fail if not present and remove otherwise
-      dest = remote.split(':');
+      dest = remote.split(':')
+      if(dest.length != 2)
+        dest = dest.insert(0, "cycle3.csug.rochester.edu")
+      end
       contents = Dir.entries(Dir.pwd)
       if(!content.include? '.cn')
         puts 'failed to push to remote, not an initialized Copernicium repo'
@@ -202,6 +213,10 @@ module Copernicium
         contents = contents.delete_if{|x| (x.eql? '.cn') || (x.eql? '.') || (x.eql? '..')}
       end
 
+      # todo - check if branch exists on the remote server
+      # if so, dump contents and save a new commit saying pushed from user
+      # else, create branch and dump files, then make a new commit saying
+      # created branch
       connect(dest[0], user) do |session|
         session.exec!("cd #{dest[1]}")
         result = session.exec!('ls .cn')
@@ -222,9 +237,9 @@ module Copernicium
         # Commit the files and merge the branches
         session.exec!('cn add .')
         session.exec!('cn commit -m \'Temp commit for push\'')
-        session.exec!('cn checkout #{branch}')
+        session.exec!("cn checkout #{branch}")
         session.exec!("cn merge .temp_push_#{user}")
-        session.exec!("cn branch -r temp_push_#{user}")
+        session.exec!("cn branch -d .temp_push_#{user}")
       end
 
       puts "Successfully pushed to #{remote}"
@@ -238,10 +253,13 @@ module Copernicium
     # remote: the remote server and directory to push to, formatted "my.server:/the/location/we/want"
     # branch: the branch that we are pushing to
     # user: the user to connect as
-    def pull(remote, branch, user)
+    def PushPull.pull(remote, branch, user)
       # check contents of folder for .cn, fail if not present and remove otherwise
       crbr = Repos.new.current_branch() # assumed function
-      dest = remote.split(':');
+      dest = remote.split(':')
+      if(dest.length != 2)
+        dest = dest.insert(0, "cycle3.csug.rochester.edu")
+      end
       contents = Dir.entries(Dir.pwd)
       if(!content.include? '.cn')
         puts 'failed to pull from remote, not an initialized Copernicium repo'
@@ -262,6 +280,7 @@ module Copernicium
         session.exec!("cn checkout #{branch}")
         collection = session.exec!("ls | cat")
       end
+
       collection  = collection.split('\n')
       if(!collection.include? '.cn')
         puts 'failed to pull from remote, remote folder not an initialized Copernicium repo'
@@ -280,7 +299,7 @@ module Copernicium
       system "cn commit -m \'Temp commit for pull\'"
       system "cn checkout #{crbr}"
       system "cn merge .temp_pull_#{user}"
-      system "cn branch -r .temp_pull_#{user}"
+      system "cn branch -d .temp_pull_#{user}"
       puts "Successfully pulled from #{remote}"
     end
 
@@ -291,18 +310,21 @@ module Copernicium
     #
     # remote: the remote server and directory to push to, formatted "my.server:/the/location/we/want"
     # user: the user to connect as
-    def clone(remote, user = nil)
+    def PushPull.clone(remote, user = nil)
       exit_code = false
       dest = remote.split(':')
+      if(dest.length != 2)
+        dest = dest.insert(0, "cycle3.csug.rochester.edu")
+      end
       begin
-        fetch(dest[0], dest[1], Dir.pwd, user) 
-        exit_code = true;
+        fetch(dest[0], dest[1], Dir.pwd, user)
+        exit_code = true
       rescue
-        puts "Failed to clone the remote branch!"
+        puts "Failed to clone the remote branch!".red
       end
 
       return exit_code
     end
-
   end
 end
+

data/lib/repos.rb

@@ -28,104 +28,115 @@
 # delete_branch: delete a branch
 #   in - branch name
 #   out - exit status code
+# note: @@history is a hash array of snapshot ids, which is saved as
+# .cn/history to persist between calls to the copernicium tool
 
 module Copernicium
   class Snapshot
-    attr_accessor :id, :files
-    # id is computed after creation
-    def initialize(files = [])
-      @@files = files
-      @@id = id
+    attr_accessor :id, :files, :msg, :date
+    # todo - doesnt support merging. consider adding parents field
+    def initialize(files = [], msg = 'null', date = nil)
+      @date = (date.nil?? DateTime.now : date)
+      @files = files
+      @msg = msg
+
+      # hash self and assign as the id value
+      @id = Digest::SHA256.hexdigest Marshal.dump(self)
+    end
+
+    def time
+      @date.strftime("%m/%d/%Y %I:%M%p")
     end
   end
 
   module Repos
     include RevLog # needs diffing and merging
+    # read in file of snapshot ids (.cn/history)
     # check the current branch (.cn/branch)
-    # read in file of snapshots (.cn/history)
-    def Repos.setup(root = Dir.pwd, branch = 'master')
-      @@root = root
-      @@copn = File.join(@@root, '.cn')
-      @@repo = File.join(@@copn, 'repo')
-      @@bpath = File.join(@@repo, 'branch')
-      @@spath = File.join(@@repo, 'history')
-      Dir.mkdir(@@copn) unless Dir.exist?(@@copn)
-      Dir.mkdir(@@repo) unless Dir.exist?(@@repo)
-
-      # check if files exist, read them
-      if File.exist?(@@spath) && File.exist?(@@bpath)
-        @@branches = Marshal.load readFile(@@spath)
-        @@branch = readFile(@@bpath)
-      else # use defaults
-        @@branches = {branch => []}
-        @@branch = branch
-      end
-
-      # check if files exist, read them
-      if File.exist?(@@spath) && File.exist?(@@bpath)
-        @@branches = Marshal.load readFile(@@spath)
-        @@branch = readFile(@@bpath)
-      else # use defaults
-        @@branches = {branch => []}
-        @@branch = branch
-      end
+    def Repos.setup(root = Dir.pwd)
+      @@copn = File.join(root, '.cn')
+      @@snap = File.join(@@copn, 'snap')
+      @@head = File.join(@@copn, 'branch')
+      @@hist = File.join(@@copn, 'history')
+
+      # read history from disk
+      @@branch = File.read(@@head)
+      @@history = YAML.load File.read(@@hist)
+      @@brsnaps = Repos.get_branch @@branch
     end
 
-    # helper methods for file IO
-    def writeFile(path, content)
-      f = open(path, 'w')
-      f.write(content)
-      f.close
-    end
+    # unit testing version - create folders for this code
+    def Repos.setup_tester(root = Dir.pwd, branch = 'master')
+      @@copn = File.join(root, '.cn')
+      @@snap = File.join(@@copn, 'snap')
+      @@revs = File.join(@@copn, 'revs')
+      @@head = File.join(@@copn, 'branch')
+      @@hist = File.join(@@copn, 'history')
+
+      # create folders for testing this module
+      Dir.mkdir(@@copn) unless Dir.exist?(@@copn)
+      Dir.mkdir(@@snap) unless Dir.exist?(@@snap)
+      Dir.mkdir(@@revs) unless Dir.exist?(@@revs)
 
-    # helper methods for file IO
-    def readFile(path)
-      f = open(path, 'r')
-      txt = f.read
-      f.close
-      txt
+      # default new
+      @@branch = branch
+      @@history = {branch => []}
+      RevLog.setup
     end
 
-    # check if any snapshots exist, if not exit
-    def Repos.has_snapshots?
-      ! Repos.history(@@branch).empty?
+    # check whether a specific branch exists
+    def Repos.has_branch?(branch)
+      Repos.branches.include? branch
     end
 
-    def Repos.hash_array
-      Hash.new {[]}
+    # check if any snapshots exist for the current branch
+    def Repos.has_snapshots?
+      not Repos.history(@@branch).empty?
     end
 
-    # returns the hash of an object
+    # Return hash of an object
     def Repos.hasher(obj)
       Digest::SHA256.hexdigest Marshal.dump(obj)
     end
 
-    # Return string array of what branches we have
-    def Repos.branches
-      @@branches.keys
+    # helper to add snap to history
+    def Repos.update_history
+      File.write @@hist, YAML.dump(@@history) # write history
+    end
+
+    # Return array of snapshot IDs
+    def Repos.history(branch = nil)
+      if branch.nil? # return a list of unique all commits
+        (@@history.inject([]) { |o, x| o + x.last }).uniq
+      elsif Repos.has_branch? branch # just return the stored history
+        @@history[branch]
+      else # no commits yet
+        []
+      end
     end
 
-    # Create and return snapshot
-    def Repos.make_snapshot(files = [])
-      snap = Snapshot.new(files)
-      snap.id = hasher snap
-      @@branches[@@branch] << snap
+    # Create and return snapshot id
+    def Repos.make_snapshot(files = [], msg = 'nil')
+      snap = Snapshot.new(files, msg)
+      @@history[@@branch] << snap.id
 
       # Update snaps file
-      update_snap
+      update_snap snap
+      update_history
       snap.id
     end
 
     # helper to write a snapshot, saving a new commit
-    def Repos.update_snap
-      writeFile @@spath, Marshal.dump(@@branches)
+    # marshal serializes the class instance to a string
+    def Repos.update_snap(snap)
+      File.write File.join(@@snap, snap.id), YAML.dump(snap)
     end
 
-    # todo - Check to make sure id is from a different branch
     # Merge the target snapshot into HEAD snapshot of the current branch
+    # todo - Check to make sure id is from a different branch
     def Repos.merge_snapshot(id)
       # run diff to get conflicts
-      current = @@branches[@@branch].last
+      current = @@history[@@branch].last
       difference = diff_snapshots(current.id, id)
       conflicts = difference[1]
 
@@ -139,30 +150,20 @@ module Copernicium
 
     # Find snapshot and return snapshot from id
     def Repos.get_snapshot(id)
-      @@branches.keys.each do |br|
-        @@branches[br].each do |sn|
-          return sn if sn.id == id
+      @@history.each do |branch, snapids|
+        snapids.each do |snapid|
+          return YAML.load_file(File.join(@@snap, id)) if snapid == id
         end
       end
 
-      raise "Snapshot not found in this repo."
-    end
-
-    # Return array of snapshot IDs
-    def Repos.history(branch = nil)
-      snapids = []
-      if branch.nil?
-        @@branches[@@branch].each { |x| snapids << x.id }
-      elsif
-        @@branches[branch].each { |x| snapids << x.id }
-      end
-      snapids
+      raise "Repos: snapshot #{id} not found in this repo.".red
     end
 
     # Find snapshot, delete from snaps/memory
     def Repos.delete_snapshot(id)
-      @@branches[@@branch].delete_if { |x| x.id == id }
-      update_snap
+      @@history[@@branch].delete_if { |x| x == id }
+      File.delete File.join(@@snap, id)
+      update_history
     end
 
     #diff_snapshots needs to catch both files in snap1 that aren’t and snap2 and
@@ -190,8 +191,8 @@ module Copernicium
           id2 = files2[f2_index].last
 
           # get file contents
-          content1 = get_file(id1)
-          content2 = get_file(id2)
+          content1 = RevLog.get_file(id1)
+          content2 = RevLog.get_file(id2)
 
           # check if the file content for each path is the same
           if content1 == content2
@@ -214,23 +215,52 @@ module Copernicium
       array1.select { |x| !array2.any? { |y| x == y } }
     end
 
-    # BRANCHING
-    def current() @@branches end
 
-    # Return hash ID of new branch
+    # ADDITIONAL MODULE ACCESS INTERFACES
+    #
+    # return the current branch we are on now (string name)
+    def current() @@branch end
+
+    # return the snap id of branch head
+    def current_head() @@history[@@branch].last end
+
+    # return the array of our branches snapshots
+    def current_snaps() @@brsnaps end
+
+    # return the files in the latest snapshot
+    def current_files() Repos.has_snapshots?? @@brsnaps.last.files : [] end
+
+    # Return string array of what branches we have
+    def branches() @@history.keys end
+
+
+    # BRANCHING FUNCTIONALITY
+    #
+    # Create and return hash ID of new branch
     def Repos.make_branch(branch)
-      @@branches[branch] = @@branches[@@branch]
+      @@history[branch] = @@history[@@branch].inject([]) { |n, o| n << o }
       @@branch = branch
-      hasher @@branches[branch]
+      update_history
+      hasher @@history[branch]
     end
 
     def Repos.update_branch(branch)
-      writeFile(@@bpath, branch)
+      File.write(@@head, branch)
       @@branch = branch
     end
 
+    # From the branch names, get the history, ant build the array of snapshots
+    # This is different than the history branch which just contains ids
+    def Repos.get_branch(branch)
+      Repos.history(branch).inject([]) do |hist, snapid|
+        hist << Repos.get_snapshot(snapid)
+      end
+    end
+
+    # todo - also delete snapshots unique to this branch
     def Repos.delete_branch(branch)
-      @@branches.delete(branch)
+      @@history.delete(branch)
+      update_history
     end
   end # Repos
 end # Copernicium