safedb 0.7.1001 → 0.10.5

data/lib/controller/db/model_git_service.rb

@@ -1,399 +0,0 @@
-#!/usr/bin/ruby
-
-  module SafeDb
-
-  module Store
-
-
-# -- ------------------------------------------------------------------- -- #
-# -- Provision the git branch involved in our present working directory. -- #
-# -- The [present directory] may not relate to version control at all or -- #
-# -- it may relate to the master or other branch in the source mgt tool. -- #
-# -- ------------------------------------------------------------------- -- #
-class GitFlow
-
-  @@url_postfix = ".git/"
-
-  # --
-  # -- Check in whatever has changed in the local repository
-  # -- at the path stated in the first parameter.
-  # --
-  # -- The text in the second parameter helps to distinguish
-  # -- what was to be pushed up and forms part of the git
-  # -- commit message.
-  # --
-  def self.push repo_root_dir, what_changed_string, time_stamp
-
-    dot_git_path = File.join repo_root_dir, ".git"
-    Throw.if_not_exists dot_git_path
-
-    Dir.chdir repo_root_dir
-
-    git_diff_cmd = "git status -vv; echo;"
-    git_diff_output = %x[#{git_diff_cmd}]
-    git_diff_output.log_lines
-
-    git_add_cmd = "git add -A; echo;"
-    git_add_output = %x[#{git_add_cmd}]
-    git_add_output.log_lines
-
-    git_commit_cmd = "git commit -m \"Writing #{what_changed_string} at #{time_stamp}.\";"
-    git_commit_output = %x[#{git_commit_cmd}]
-    git_commit_output.log_lines
-
-    # --
-    # -- This command may require input (username/password) from the
-    # -- user hence we don't wrap inside output trapping executors.
-    # --
-    system "git push origin master"
-
-  end
-
-
-  # -- ------------------------------------------------- -- #
-  # -- Return the branch name of a local git repository. -- #
-  # -- ------------------------------------------------- -- #
-  # -- Parameter                                         -- #
-  # --   path_to_dot_git : local path to the .git folder -- #
-  # --                                                   -- #
-  # -- Dependencies and Assumptions                      -- #
-  # --   git is installed on the machine                 -- #
-  # -- ------------------------------------------------- -- #
-  def self.wc_branch_name path_to_dot_git
-
-    cmd = "git --git-dir=#{path_to_dot_git} branch";
-    branch_names = %x[#{cmd}];
-    branch_names.each_line do |line|
-      return line[2, line.length].strip if line.start_with?('*')
-    end
-    raise ArgumentError.new "No branch name starts with asterix.\n#{cmd}\n#{branch_names}\n"
-
-  end
-
-
-  # -- ------------------------------------------------- -- #
-  # -- Get the remote origin url of a git working copy.  -- #
-  # -- ------------------------------------------------- -- #
-  # -- Parameter                                         -- #
-  # --   path_to_dot_git : local path to .git folder     -- #
-  # --                                                   -- #
-  # -- Dependencies and Assumptions                      -- #
-  # --   git is installed on the machine                 -- #
-  # --   working copy exists and has remote origin       -- #
-  # -- ------------------------------------------------- -- #
-  def self.wc_origin_url path_to_dot_git
-
-    cmd = "git --git-dir=#{path_to_dot_git} config --get remote.origin.url"
-    url = %x[#{cmd}];
-    raise ArgumentError.new "No remote origin url.\n#{cmd}\n" if url.nil?
-    
-    return url.strip
-
-  end
-
-
-  # -- -------------------------------------------------- -- #
-  # -- Get the uncut revision of a git repo working copy. -- #
-  # -- -------------------------------------------------- -- #
-  # -- Parameter                                          -- #
-  # --   path_to_dot_git : local path to .git folder      -- #
-  # --                                                    -- #
-  # -- Dependencies and Assumptions                       -- #
-  # --   git is installed on the machine                  -- #
-  # --   working copy exists and has remote origin        -- #
-  # -- -------------------------------------------------- -- #
-  def self.wc_revision_uncut path_to_dot_git
-
-    log.info(ere) { "##### GitFlow path to dot git is => #{path_to_dot_git}" }
-    repo_url = wc_origin_url path_to_dot_git
-    log.info(ere) { "##### The GitFlow repo url is => #{repo_url}" }
-
-    ## Bug HERE - On Ubuntu the branch name is like => (HEAD detached at 067f9a3)
-    ## Bug HERE - This creates a failure of => sh: 1: Syntax error: "(" unexpected
-    ## Bug HERE - The unexpected failure occurs in the ls-remote command below
-    ## Bug HERE - So hardcoding this to "master" for now
-    # branch_name = wc_branch_name path_to_dot_git
-    branch_name = "master"
-
-    log.info(ere) { "##### The GitFlow branch name is => #{branch_name}" }
-    cmd = "git ls-remote #{repo_url} ls-remote -b #{branch_name}"
-    log.info(ere) { "##### The GitFlow get dirty rev command is => #{cmd}" }
-    dirty_revision = %x[#{cmd}];
-    log.info(ere) { "##### The dirty revision is => #{dirty_revision}" }
-    return dirty_revision.partition("refs/heads").first.strip;
-
-  end
-
-
-  # -- -------------------------------------------------- -- #
-  # -- Get brief revision of repo from working copy path. -- #
-  # -- -------------------------------------------------- -- #
-  # -- Parameter                                          -- #
-  # --   path_to_dot_git : local path to .git folder      -- #
-  # --                                                    -- #
-  # -- Dependencies and Assumptions                       -- #
-  # --   we return the first 7 revision chars             -- #
-  # --   git is installed on the machine                  -- #
-  # --   working copy exists and has remote origin        -- #
-  # -- -------------------------------------------------- -- #
-  def self.wc_revision path_to_dot_git
-
-    log.info(ere) { "GitFlow path to dot git is => #{path_to_dot_git}" }
-    Throw.if_not_exists path_to_dot_git
-
-    uncut_revision = wc_revision_uncut path_to_dot_git
-    log.info(ere) { "GitFlow uncut full revision is => #{uncut_revision}" }
-
-    # -- --------------------------------------------------------------------- -- #
-    # -- Gits [short revision] hash has 7 chars. Note 4 is the usable minimum. -- #
-    # -- For usage in stamps where space comes at a premium - 6 chars will do. -- #
-    # -- --------------------------------------------------------------------- -- #
-    ref_length = 7
-    return "r" + uncut_revision[0..(ref_length - 1)];
-
-  end
-
-
-  # -- -------------------------------------------------- -- #
-  # -- Clone the branch of a local git repo working copy. -- #
-  # -- -------------------------------------------------- -- #
-  # -- Parameter                                          -- #
-  # --   src_gitpath : local path to .git folder          -- #
-  # --   new_wc_path : path to new non-existent dir       -- #
-  # --                                                    -- #
-  # -- Dependencies and Assumptions                       -- #
-  # --   git is installed on the machine                  -- #
-  # --   working copy exists and has remote origin        -- #
-  # -- -------------------------------------------------- -- #
-  def self.do_clone_wc path_to_dot_git, path_to_new_dir
-
-    # -- ----------------------------------------------------------- -- #
-    # -- Why clone from a working copy (instead of a remote url).    -- #
-    # -- ----------------------------------------------------------- -- #
-    # --                                                             -- #
-    # -- When actively [DEVELOPING] an eco plugin and you want to    -- #
-    # --                                                             -- #
-    # --   1 - [test] the behaviour without a git commit/git push    -- #
-    # --   2 - test whatever [branch] the working copy is now at     -- #
-    # --                                                             -- #
-    # -- This use case requires us to clone from a working copy.     -- #
-    # --                                                             -- #
-    # -- ----------------------------------------------------------- -- #
-
-###   Bug here - see getting branch name issue
-###   Bug here - see getting branch name issue
-###   Bug here - see getting branch name issue
-###   Bug here - see getting branch name issue
-###    branch_name = wc_branch_name path_to_dot_git
-    branch_name = "master"
-#####    cmd = "git clone #{path_to_dot_git} -b #{branch_name} #{path_to_new_dir}"
-#####    cmd = "git clone #{path_to_dot_git} -b #{branch_name} #{path_to_new_dir}"
-#####    cmd = "git clone #{path_to_dot_git} -b #{branch_name} #{path_to_new_dir}"
-    cmd = "git clone #{path_to_dot_git} #{path_to_new_dir}"
-    clone_output = %x[#{cmd}];
-
-    log.info(ere) { "[gitflow] cloning working copy" }
-    log.info(ere) { "[gitflow] repo branch name  : #{branch_name}" }
-    log.info(ere) { "[gitflow] src dot git path  : #{path_to_dot_git}" }
-    log.info(ere) { "[gitflow] new wc dir path   : #{path_to_new_dir}" }
-    log.info(ere) { "[gitflow] git clone command : #{cmd}" }
-    log.info(ere) { "[gitflow] git clone output  : #{clone_output}" }
-
-  end
-
-
-  # --
-  # -- Clone a remote repository at the specified [url] into
-  # -- a [NON-EXISTENT] folder path.
-  # --
-  # -- ---------------------------------
-  # -- What is a Non Existent Dir Path?
-  # -- ---------------------------------
-  # --
-  # -- The parent directory of a non existent folder path
-  # -- must [exist] whilst the full path itself does not.
-  # -- The clone operation will create the final folder in
-  # -- the path and then it [puts] the repository contents
-  # -- within it.
-  # --
-  # -- -----------
-  # -- Parameters
-  # -- -----------
-  # --
-  # --   repo_url  : url ends in dot git f-slash
-  # --   clone_dir : path to new non-existent dir
-  # --
-  # -- -----------------------------
-  # -- Dependencies and Assumptions
-  # -- -----------------------------
-  # --
-  # --   git is installed on the machine
-  # --   repo exists and is publicly readable
-  # --   the master branch is he one to clone
-  # --   the current Dir.pwd() is writeable
-  # --
-  def self.do_clone_repo repo_url, non_existent_path
-
-    cmd = "git clone #{repo_url} #{non_existent_path}"
-    clone_output = %x[#{cmd}];
-
-    log.info(ere) { "[gitflow] cloning remote repository" }
-    log.info(ere) { "[gitflow] git repository url : #{repo_url}" }
-    log.info(ere) { "[gitflow] git clone dir path : #{nickname non_existent_path}" }
-    log.info(ere) { "[gitflow] git clone command  : #{cmd}" }
-    log.info(ere) { "[gitflow] git clone output   : #{clone_output}" }
-
-  end
-
-
-  # -- ----------------------------------------------------- -- #
-  # -- Clone [many] git repositories given an array of urls  -- #
-  # -- along with a corresponding array of the working copy  -- #
-  # -- folder names and a [parental] base (offset) folder.   -- #
-  # -- ----------------------------------------------------- -- #
-  # -- Parameter                                             -- #
-  # --   repo_urls  : array of git repository urls           -- #
-  # --   base_names : array of cloned repo base names        -- #
-  # --   parent_dir : path to local [parent] folder          -- #
-  # --                                                       -- #
-  # -- Dependencies and Assumptions                          -- #
-  # --   arrays have equiv corresponding entries             -- #
-  # --   parent dir is created if not exists                 -- #
-  # --   repos exist and are publicly readable               -- #
-  # --   master branches are the ones to clone               -- #
-  # -- ----------------------------------------------------- -- #
-  def self.do_clone_repos repo_urls, base_names, parent_dir
-
-    Dir.mkdir parent_dir unless File.exists? parent_dir
-    Throw.if_not_found parent_dir, "clone repos"
-
-    repo_urls.each_with_index do | repo_url, repo_index |
-
-      git_url = repo_url if repo_url.end_with? @@url_postfix
-      git_url = "#{repo_url}#{@@url_postfix}" unless repo_url.end_with? @@url_postfix
-
-      proj_folder = File.join parent_dir, base_names[repo_index]
-
-      log.info(ere) { "[clone repos] proj [index] => #{repo_index}" }
-      log.info(ere) { "[clone repos] repo url 1st => #{repo_url}" }
-      log.info(ere) { "[clone repos] repo url 2nd => #{git_url}" }
-      log.info(ere) { "[clone repos] project name => #{base_names[repo_index]}" }
-      log.info(ere) { "[clone repos] project path => #{proj_folder}" }
-
-      GitFlow.do_clone_repo git_url, proj_folder
-
-    end
-
-  end
-
-
-  # -- ------------------------------------------------ -- #
-  # -- Move assets from a git repo to a local zip file. -- #
-  # -- ------------------------------------------------ -- #
-  # --                                                  -- #
-  # -- Parameter                                        -- #
-  # --   repo_url     : the url of the git repository   -- #
-  # --   path_offset  : FWD-SLASH ENDED PATH in repo    -- #
-  # --   target_dir   : the target folder for new zip   -- #
-  # --   zip_filename : extensionless name of the zip   -- #
-  # --                                                  -- #
-  # -- Return                                           -- #
-  # --   path to the zip file created in a tmp folder   -- #
-  # --                                                  -- #
-  # -- ------------------------------------------------ -- #
-  # -- Dependencies and Assumptions                     -- #
-  # -- ------------------------------------------------ -- #
-  # --                                                  -- #
-  # --   END PATH OFFSET WITH A FORWARD SLASH           -- #
-  # --   IF NO OFFSET SEND "/" for path_offset          -- #
-  # --   git is installed on the machine                -- #
-  # --   the repo exists with path offset               -- #
-  # --   the master branch is archived                  -- #
-  # --   name is unique as used to create a dir         -- #
-  # --                                                  -- #
-  # -- ------------------------------------------------ -- #
-  def self.git2zip repo_url, path_offset, target_dir, zip_basename
-
-    log.info(ere) { "[git2zip] ------------------------------------------- -- #" }
-    log.info(ere) { "[git2zip] archiving repo assets at path offset        -- #" }
-    log.info(ere) { "[git2zip] ------------------------------------------- -- #" }
-    log.info(ere) { "[git2zip] git repository url    : #{repo_url}" }
-    log.info(ere) { "[git2zip] slash tail dir offset : #{path_offset}" }
-    log.info(ere) { "[git2zip] target zip directory  : #{target_dir}" }
-    log.info(ere) { "[git2zip] zip file [base] name  : #{zip_basename}" }
-
-    clone_dir = File.join Dir.tmpdir(), zip_basename
-    do_clone_repo repo_url, clone_dir
-    dot_git_path = File.join clone_dir, ".git"
-    dst_zip_path = File.join target_dir, "#{zip_basename}.zip"
-
-    the_offset = path_offset
-    the_offset = "" if path_offset.length == 1
-    cmd = "git --git-dir=#{dot_git_path} archive -o #{dst_zip_path} HEAD:#{the_offset}"
-    clone_output = %x[#{cmd}];
-
-    log.info(ere) { "[git2zip] tmp clone src folder  : #{clone_dir}" }
-    log.info(ere) { "[git2zip] cloned dot git path   : #{dot_git_path}" }
-    log.info(ere) { "[git2zip] target zip full path  : #{dst_zip_path}" }
-    log.info(ere) { "[git2zip] git archive command   : #{cmd}" }
-    log.info(ere) { "[git2zip] ------------------------------------------- -- #" }
-    log.info(ere) { "#{clone_output}" }
-    log.info(ere) { "[git2zip] ------------------------------------------- -- #" }
-
-    return dst_zip_path
-
-  end
-
-
-  # -- ------------------------------------------------- -- #
-  # -- Return an array of simple file names in the repo. -- #
-  # -- ------------------------------------------------- -- #
-  # -- Parameter                                         -- #
-  # --   repo_url : the url of the repository to read    -- #
-  # --                                                   -- #
-  # -- Dependencies and Assumptions                      -- #
-  # --   we are not interested in folders                -- #
-  # --   trawl is recursive (infinite depth)             -- #
-  # --   git is installed on the machine                 -- #
-  # -- ------------------------------------------------- -- #
-  def self.file_names repo_url
-
-    random_text = SecureRandom.urlsafe_base64(12).delete("-_").downcase
-    cloned_name = "eco.repo.clone.#{random_text}"
-    cloned_path = File.join Dir.tmpdir(), cloned_name
-
-    do_clone_repo repo_url, cloned_path
-    dot_git_path = File.join cloned_path, ".git"
-
-    cmd = "git --git-dir=#{dot_git_path} ls-tree -r master --name-only"
-    filename_lines = %x[#{cmd}];
-    names_list = Array.new
-    filename_lines.each_line do |line|
-      names_list.push line.strip
-    end
-
-    log.info(ere) { "[git2files] ----------------------------------------------" }
-    log.info(ere) { "[git2files] [#{names_list.length}] files in [#{repo_url}]" }
-    log.info(ere) { "[git2files] ----------------------------------------------" }
-    log.info(ere) { "[git2files] Random Text : #{random_text}" }
-    log.info(ere) { "[git2files] Cloned Name : #{cloned_name}" }
-    log.info(ere) { "[git2files] Cloned Path : #{cloned_path}" }
-    log.info(ere) { "[git2files] Repo Folder : #{dot_git_path}" }
-    log.info(ere) { "[git2files] Reading Cmd : #{cmd}" }
-    log.info(ere) { "[git2files] ----------------------------------------------" }
-    pp names_list
-    log.info(ere) { "[git2files] ----------------------------------------------" }
-
-    return names_list
-
-  end
-
-
-
-  end
-
-
-  end
-
-end
-

data/lib/plugin/github.rb

@@ -1,53 +0,0 @@
-#!/usr/bin/ruby
-
-module SafeDb
-
-  # This class knows how to talk to Github and callers can delegate common
-  # github functionality like creating repositories, listing repositories,
-  # downloading repositories and the like.
-  #
-  class Github
-
-    # Initialize an instance of this safe database's master properties.
-    def initialize()
-
-
-
-
-      #
-      #
-      #  Test the Github api using curl
-      #
-      #
-      #       curl -H "Authorization: token OAUTH-TOKEN" https://api.github.com
-      #
-      #
-
-
-      @master = DataMap.new( Indices::MASTER_INDICES_FILEPATH )
-    end
-
-
-    # Get the coordinates (book, chapter and verse) of the verse that holds
-    # the remote backend properties. An exception will be thrown if no backend
-    # coordinates have been set.
-    # @return [String] the backend coordinates to set
-    def get_backend_coordinates()
-      @master.use( Indices::REMOTE_MIRROR_SECTION_NAME )
-      return @master.get( Indices::REMOTE_MIRROR_PAGE_NAME )
-    end
-
-
-    # Set the coordinates (book, chapter and verse) of the verse that holds
-    # the remote backend properties.
-    # @param backend_coordinates [String] the backend coordinates to set
-    def set_backend_coordinates( backend_coordinates )
-      @master.use( Indices::REMOTE_MIRROR_SECTION_NAME )
-      @master.set( Indices::REMOTE_MIRROR_PAGE_NAME, backend_coordinates )
-    end
-
-
-  end
-
-
-end

data/lib/utils/store/github.rb

@@ -1,27 +0,0 @@
-#!/usr/bin/ruby
-# coding: utf-8
-
-module SafeDb
-
-  # The Github class uses the REST API to talk to Github and create, query,
-  # change and delete assets within a specified hosted git repository.
-  class Github
-
-    # Initialize a Github repository given the parameter name.
-    # the parameter JSON string.
-    #
-    # @param repository_name [String] name of the Github repository
-    #
-    def initialize( repository_name )
-
-      data_db = DataStore.new()
-      data_db.merge!( JSON.parse( db_json_string ) )
-      return data_db
-
-    end
-
-
-  end
-
-
-end