scvcs 0.2.0

data/bin/utilities/output.rb

@@ -0,0 +1,38 @@
+module Output
+  class Pager
+    attr_reader :pager
+
+    def initialize(raw: false)
+      if raw or not $stdout.isatty
+        @pager = nil
+      elsif Shell.command_exist? 'less'
+        @pager = 'less -R -F -X'
+      elsif Shell.command_exist? 'more'
+        @pager = 'more'
+      end
+    end
+
+    def print_block
+      return yield($stdout) if pager.nil?
+
+      IO.popen(pager, 'w') do |stream|
+        begin
+          $stdout = stream
+          yield stream
+        ensure
+          $stdout = STDOUT
+        end
+      end
+    end
+  end
+
+  def output(raw: false, &block)
+    Pager.new(raw: raw).print_block &block
+  end
+
+  extend self
+end
+
+class Object
+  include Output
+end

data/bin/utilities/shell.rb

@@ -0,0 +1,15 @@
+module Shell
+  ##
+  # Detect if a command exists and can be executed using
+  # the OS shell.
+  #
+  # Based on http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby/5471032#5471032
+  #
+  def self.command_exist?(name)
+    extensions = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
+    ENV['PATH'].split(File::PATH_SEPARATOR).find do |path|
+      extensions.find { |ext| File.executable? File.join(path, "#{name}#{ext}") }
+    end
+  end
+end

data/lib/scv.rb

@@ -0,0 +1,13 @@
+require 'vcs_toolkit'
+
+require 'scv/version'
+require 'scv/objects'
+
+require 'scv/file_store'
+require 'scv/http_file_store'
+require 'scv/config'
+require 'scv/object_store'
+
+require 'scv/repository'
+
+require 'scv/server'

data/lib/scv/config.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+
+module SCV
+  class Config
+    attr_accessor :data
+
+    def initialize(file_store, file_name)
+      @file_store = file_store
+      @file_name  = file_name
+
+      @data = {}
+      load
+    end
+
+    def load
+      @data = YAML.load @file_store.fetch(@file_name) if @file_store.file? @file_name
+    end
+
+    def save
+      @file_store.store @file_name, @data.to_yaml
+    end
+
+    def [](key)
+      hash, key = resolve_key key
+      hash[key]
+    end
+
+    def []=(key, value)
+      hash, key = resolve_key key, create: true
+      hash[key] = value
+    end
+
+    def delete(key)
+      hash, key = resolve_key key, create: false
+      hash.delete key
+    end
+
+    private
+
+    def resolve_key(hash=@data, key, create: false)
+      key, rest = key.split '.', 2
+
+      if rest.nil?
+        [hash, key]
+      else
+        hash[key] = {} if create and not hash.key? key
+
+        resolve_key hash[key], rest, create: create
+      end
+    end
+  end
+end

data/lib/scv/file_store.rb

@@ -0,0 +1,81 @@
+require 'vcs_toolkit/file_store'
+
+module SCV
+
+  class FileStore < VCSToolkit::FileStore
+    def initialize(path)
+      raise 'The path is not a directory' unless File.directory? path
+
+      @base_path = path
+    end
+
+    def store(path, content)
+      path = path_for path
+
+      FileUtils.mkdir_p File.dirname(path)
+
+      File.open(path, 'wb') do |file|
+        file.write(content)
+      end
+    end
+
+    def fetch(path)
+      raise KeyError unless file? path
+
+      File.open(path_for(path), 'rb') do |file|
+        file.read
+      end
+    end
+
+    def delete_file(path)
+      File.unlink path_for(path)
+    end
+
+    def delete_dir(path)
+      Dir.unlink path_for(path)
+    end
+
+    def file?(path)
+      File.file? path_for(path)
+    end
+
+    def directory?(path)
+      File.directory? path_for(path)
+    end
+
+    def changed?(path, blob)
+      fetch(path) != blob.content
+    end
+
+    def each_file(path='', &block)
+      path = '.' if path.empty?
+
+      Dir.entries(path_for(path)).select do |file_name|
+        file? path_for(file_name, path)
+      end.each(&block)
+    end
+
+    def each_directory(path='', &block)
+      path = '.' if path.empty?
+
+      Dir.entries(path_for(path)).select do |name|
+        not %w(. ..).include? name and directory? path_for(name, path)
+      end.each(&block)
+    end
+
+    private
+
+    def path_for(path, base=@base_path)
+      if base.empty? or base == '.'
+        if path.empty?
+          '.'
+        else
+          path
+        end
+      else
+        File.join(base, path)
+      end
+    end
+  end
+
+end

data/lib/scv/http_file_store.rb

@@ -0,0 +1,69 @@
+require 'httparty'
+require 'vcs_toolkit/file_store'
+
+module SCV
+
+  class HTTPFileStore < VCSToolkit::FileStore
+    attr_reader :base_url
+
+    def initialize(url)
+      @base_url = url.sub(/\/$/, '')
+    end
+
+    def fetch(path)
+      http_response = HTTParty.get("#{base_url}/#{path}")
+
+      case http_response.code
+      when 200
+        http_response.body
+      when 404
+        raise KeyError, "The file #{base_url}/#{path} cannot be found"
+      else
+        raise "Invalid status code #{http_response.code} for #{base_url}/#{path}"
+      end
+    end
+
+    def store(path, content)
+      http_response = HTTParty.put("#{base_url}/#{path}", {body: content})
+
+      unless http_response.code == 200
+        raise "Invalid status code #{http_response.code} for #{base_url}/#{path} (put)"
+      end
+    end
+
+    def file?(path)
+      http_response = HTTParty.head("#{base_url}/#{path}")
+
+      case http_response.code
+      when 200
+        true
+      when 404
+        false
+      else
+        raise "Invalid status code #{http_response.code} for #{base_url}/#{path}"
+      end
+    end
+
+    # These methods should not be used currently as this class
+    # will only be used by the object_store.
+
+    # def delete_file(path)
+    # end
+
+    # def delete_dir(path)
+    # end
+
+    # def directory?(path)
+    # end
+
+    # def changed?(path, blob)
+    # end
+
+    # def each_file(path='', &block)
+    # end
+
+    # def each_directory(path='', &block)
+    # end
+  end
+
+end

data/lib/scv/object_store.rb

@@ -0,0 +1,125 @@
+require 'vcs_toolkit/exceptions'
+require 'scv/objects'
+
+require 'json'
+
+module SCV
+
+  ##
+  # Implements VCSToolkit::ObjectStore to store objects on the file system.
+  # The directory structure is as follows:
+  #
+  #   .scv/
+  #
+  #     objects/
+  #       59/
+  #         59873e99cef61a60b3826e1cbb9d4b089ae78c2b.json
+  #         ...
+  #       ...
+  #
+  #     refs/
+  #       HEAD.json
+  #       master.json
+  #       ...
+  #
+  #     blobs/
+  #       59/
+  #         59873e99cef61a60b3826e1cbb9d4b089ae78c2b
+  #         ...
+  #       ...
+  #
+  # Each object in `.scv/objects/` is stored in a directory with a name
+  # of the first two symbols of the object id.
+  # The file extension determines the object format. Possible formats
+  # are `json` and `json.gz` (`json.gz` will be supported in the future).
+  #
+  # For each blob object in `.scv/blobs/` there may be a file in
+  # `.scv/objects/`. These blobs follow the same naming scheme as the
+  # objects, but they are just binary files (not in `json` format).
+  #
+  # The refs are named objects (object.named? == true) and can be
+  # enumerated.
+  #
+  class ObjectStore < VCSToolkit::ObjectStore
+    def initialize(file_store)
+      @store = file_store
+    end
+
+    def store(object_id, object)
+      if object.named?
+        object_path = get_object_path object_id, named: true
+      else
+        object_path = get_object_path object_id
+      end
+
+      if object.is_a? VCSToolkit::Objects::Blob
+        @store.store(get_blob_path(object_id), object.content)
+      else
+        @store.store(object_path, JSON.generate(object.to_hash))
+      end
+    end
+
+    def fetch(object_id)
+      object_location = find_object object_id
+
+      return fetch_blob(object_id) if object_location[:type] == :blob
+
+      hash = JSON.parse(@store.fetch(object_location[:path]))
+      object_type = hash['object_type'].capitalize
+
+      raise 'Unknown object type' unless Objects.const_defined? object_type
+
+      Objects.const_get(object_type).from_hash hash
+    end
+
+    ##
+    # A method not required by VCSToolkit used to remove
+    # labels or possibly garbage collection.
+    #
+    def remove(object_id)
+      raise KeyError, 'The object does not exit' unless key? object_id
+
+      location = find_object object_id
+
+      @store.delete_file location[:path]
+    end
+
+    def key?(object_id)
+      not find_object(object_id).nil?
+    end
+
+    def each(&block)
+      return [] unless @store.directory? 'refs'
+
+      @store.files('refs').map { |name| name.sub /\..*$/, '' }.each &block
+    end
+
+    private
+
+    def fetch_blob(object_id)
+      content = @store.fetch get_blob_path(object_id)
+
+      SCV::Objects::Blob.new id: object_id, content: content
+    end
+
+    def get_object_path(object_id, named: false)
+      if named
+        File.join 'refs', "#{object_id}.json"
+      else
+        File.join 'objects', object_id[0...2], "#{object_id}.json"
+      end
+    end
+
+    def get_blob_path(object_id)
+      File.join 'blobs', object_id.to_s[0...2], object_id.to_s
+    end
+
+    def find_object(object_id)
+      [
+        {path: get_object_path(object_id),              type: :object},
+        {path: get_object_path(object_id, named: true), type: :label },
+        {path: get_blob_path(object_id),                type: :blob  },
+      ].find { |location| @store.file? location[:path] }
+    end
+  end
+end

data/lib/scv/objects.rb

@@ -0,0 +1,4 @@
+require 'scv/objects/blob'
+require 'scv/objects/commit'
+require 'scv/objects/label'
+require 'scv/objects/tree'

data/lib/scv/objects/blob.rb

@@ -0,0 +1,10 @@
+require 'vcs_toolkit/objects/blob'
+
+module SCV
+  module Objects
+
+    class Blob < VCSToolkit::Objects::Blob
+    end
+
+  end
+end

data/lib/scv/objects/commit.rb

@@ -0,0 +1,34 @@
+require 'vcs_toolkit/objects/commit'
+
+module SCV
+  module Objects
+
+    class Commit < VCSToolkit::Objects::Commit
+
+      def initialize(date:, **kwargs)
+        # Parse the date on deserialization
+        date = DateTime.parse date if date.is_a? String
+
+        super
+      end
+
+      def hash_objects
+        [@message, @tree, parents_for_hash, @author, @date.to_s]
+      end
+
+      private
+
+      def parents_for_hash
+        if parents.empty?
+          nil
+        elsif parents.size == 1
+          parents.first
+        else
+          parents
+        end
+      end
+
+    end
+
+  end
+end