scvcs 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eefc4bffd875b5d3790a245d07af5d33c806bdd1
+  data.tar.gz: bc962cb8cbd75e9315f5ca9cbad99a0faaee8a45
+SHA512:
+  metadata.gz: 3fa4eb7036475bd632ff4e01928fd34815e86fa534d12e27ab28a1f1aaf19e36e1c5da461f15dd6444994a117e6dd068715ec98267c91a57f18339e13b289688
+  data.tar.gz: 02e00f9e40d47ac26016c98f079aac6a6c67fd09e00bd336576e16fc660603bbe4d0c49092dcac1b1f12dfba8b2c45ad63a9e4373615bbb3aa6ca6938939732b

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Georgy Angelov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+SCV
+===
+The SCV is a tool that every terran player absolutely must use to have a stable and well-organized (code)base.
+
+Seriously though...
+===================
+This project was inspired by [the Git lecture](http://fmi.ruby.bg/lectures/15-git#1) I made for [this year's Ruby course](http://fmi.ruby.bg) at my university. It is also my course project.
+
+The name SCV has two different meanings:
+
+1. It is `VCS` (Version Control System) in reverse
+2. It is the name of a StarCraft unit (a worker) which can gather resources and can also build and repair stuff.
+
+Overview
+========
+The goal is to create a working (you don't say) version control system in Ruby.
+
+The project itself is split into two parts: [**VCSToolkit**](https://github.com/stormbreakerbg/vcs-toolkit) and **SCV**.
+**VCSToolkit** is a Ruby gem that is supposed to provide the platform and common tools, upon which a VCS tool can be built. This is where most of the common operations for such a tool are (being) implemented. **SCV** only implements some of **VCSToolkit**'s interfaces, extends (minimally) its classes and provides a user-friendly command-line interface to its methods.
+
+Features
+========
+*Note: The examples below use the form `scv <command>`, but if you want to test it right now, follow the 3 steps in the **Try it!** section and use `./run_scv <command>`.*
+
+Currently implemented features:
+
+---
+`scv init`
+
+Initializes an empty repository.
+
+Actually creates a `.scv` directory in the current folder and the default `head` label (pointer to a `nil` commit).
+
+---
+`scv status`
+
+Shows the list of created, modified and deleted files since the last commit.
+
+---
+`scv diff`
+
+Shows the actual differences between the files in the last commit and the working directory.
+
+---
+`scv commit`
+
+Commits the current state of the working directory. All changed, new and deleted files are commited.
+You can explicitly set the commit author on every commit using the `--author` option or set it once with `scv config author "Your Name <your@email.com>"`.
+
+You can also set the date (`--date`), set the commit message (`-m` or `--message`) or amend the last commit (`--amend`). If the `-m` flag is not set the default terminal editor will be opened (as in Git).
+
+Example: `scv commit --author "Georgy Angelov <test@test.test>"`
+
+---
+`scv history` or `scv log`
+
+Lists all commits, in reverse-chronological order with their **id**, **date**, **author** and **message**.
+
+---
+`scv restore <paths>...`
+
+Restores files to the state they were in the `head` commit. `paths` can be files or directories. New files will not be removed, only changed and deleted files are restored.
+
+You can optionally specify the source commit with `-s` or `--source` by giving its object_id, a label name that references it or an object_id and a relative offset (for example `head~3`).
+
+---
+`scv branch new <branch_name>` or `scv branch create <branch_name>`
+
+Creates a new branch based on the current branch head.
+
+---
+`scv branch delete <branch_name>` or `scv branch remove <branch_name>`
+
+Deletes the specified branch. The commits are not lost, only the label is deleted.
+
+---
+`scv branch switch <branch_name>`
+
+Switches the current directory to the specified branch head. It works as follows:
+  - Detects the changes that should be made to switch from the current branch to the other
+  - If you have modified files that would have to be overrwriten (modified) fails with an error
+  - Keeps all of your new or modified files and only overwrites unmodified ones
+  - May restore any deleted files that are present in the other branch
+  - Switches the current branch to `branch_name` (the following commits will be on branch `branch_name`)
+
+---
+`scv config`
+
+Lists all configuration properties and values. The output is similar to the output of the `tree` tool, because the configuration options can be nested:
+
+    level_0
+      ├─ level_1_one
+      │  ├─ level_2_one: value
+      │  └─ level_2_two: true
+      └─ level_1_two: value
+
+This configuration is stored in `.scv/config.yml` and is relative only to the current scv repository.
+
+---
+`scv config <key>`
+
+Shows the current value of `<key>`. A key of the form `one.two.three` can be used to reference nested properties.
+
+---
+`scv config <key> <value>`
+
+Sets the option `key` to `value`. As in the previous command, you can use the `one.two.three` form to reference nested properties. If the key doesn't exist it is created.
+
+
+Try it!
+=======
+Since there are a lot of features currently missing, SCV is not yet available on RubyGems.
+
+1. Clone this repository
+2. `bundle install`
+3. `./run_scv help`
+
+.scv structure
+================
+
+	.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 blob objects follow the same naming scheme as the regular ones, but they are just a copy of the original user files (not in `json` format).
+
+The refs are named objects (object.named? == true) and can be enumerated. Currently the only named objects are labels which are used as pointers to unnamed ones.
+
+Other
+=====
+Contributions are most welcome, but I doubt there will be any :)
+
+If you are interested in learning more about this you can ask me on Twitter [@stormbreakerbg](https://twitter.com/stormbreakerbg).
+
+![SCV](http://static3.wikia.nocookie.net/__cb20080906211455/starcraft/images/2/24/SCV_SC2_Cncpt1.jpg)

data/bin/commands/branch.rb

@@ -0,0 +1,86 @@
+desc 'A set of commands to manage branches.'
+arg_name ''
+command :branch do |c|
+
+  c.desc 'Create a branch'
+  c.arg_name '<branch name>'
+  c.command [:new, :create] do |create|
+    create.desc          'Specifies the commit/label that will be used as the branch head'
+    create.arg_name      'head'
+    create.default_value 'head'
+    create.flag          [:b, :head]
+
+    create.action do |global_options, options, args|
+      branch_name = args.first
+      branch_head = options[:head]
+
+      raise 'No branch name specified' if branch_name.nil?
+
+      repository = global_options[:repository]
+
+      raise 'There is already a label with this name' if repository[branch_name]
+
+      repository.set_label branch_name, repository[branch_head, :commit].id
+    end
+  end
+
+  c.desc 'Delete a branch'
+  c.arg_name '<branch name>'
+  c.command [:delete, :remove] do |remove|
+    remove.action do |global_options, options, args|
+      branch_name = args.first
+
+      raise 'No branch name specified' if branch_name.nil?
+
+      repository = global_options[:repository]
+      branch     = repository[branch_name]
+
+      raise 'The specified branch does not exits'      if branch.nil?
+      raise 'The specified name is not a branch/label' if branch.object_type != :label
+
+      repository.delete_label branch_name
+    end
+  end
+
+  c.desc 'Switch head to another branch. Does not change any files'
+  c.arg_name '<branch name>'
+  c.command :switch do |switch|
+    switch.action do |global_options, options, args|
+      branch_name = args.first
+
+      raise 'No branch name specified' if branch_name.nil?
+
+      repository = global_options[:repository]
+      branch     = repository[branch_name]
+
+      raise 'This is the current branch already' if repository.head == branch_name
+      raise 'There is no branch with this name'  if branch.nil? or branch.object_type != :label
+
+      changes = repository.commit_status repository['head',      :commit],
+                                         repository[branch_name, :commit]
+
+      status  = repository.status repository['head', :commit],
+                                  ignore: [/^\.|\/\./]
+
+      # Check for conflicts
+      branch_changes      = changes[:created] | changes[:changed] | changes[:deleted]
+      working_dir_changes = status[:created]  | status[:changed]  | status[:deleted]
+      conflicts           = branch_changes & working_dir_changes
+
+      unless conflicts.empty?
+        raise 'Branch switch aborted due to conflics. Please commit or reset local changes'
+      end
+
+      repository.set_label :head, branch_name
+
+      # Reset unchanged files to their state in the new branch
+      commit = repository['head', :commit]
+      tree   = repository[commit.tree]
+
+      tree.all_files(repository.object_store, ignore: working_dir_changes).each do |file, _|
+        repository.restore file, commit
+      end
+    end
+  end
+
+end

data/bin/commands/commit.rb

@@ -0,0 +1,88 @@
+desc 'Commits the current state of the working directory.'
+arg_name ''
+command :commit do |c|
+  c.desc          'The commit message'
+  c.arg_name      'message'
+  c.flag          [:m, :message]
+
+  c.desc          'The commit author name and email.'
+  c.arg_name      'author'
+  c.flag          :author
+
+  c.desc          'Use this to override the timestamp of the commit.'
+  c.arg_name      'date'
+  c.default_value DateTime.now
+  c.flag          :date
+
+  c.desc          'Use this to replace the last commit'
+  c.arg_name      'amend'
+  c.switch        :amend
+
+  c.action do |global_options, options, args|
+    repository = global_options[:repository]
+    repository_path  = "#{global_options[:dir]}/.scv"
+
+    unless options[:amend]
+      status = repository.status repository[:head, :commit], ignore: [/^\.|\/\./]
+
+      if status.none? { |_, files| files.any? }
+        raise 'No changes since last commit'
+      end
+    end
+
+    if options[:author]
+      author = options[:author]
+    elsif repository.config['author']
+      author = repository.config['author']
+    else
+      raise 'Please provide an author with --author="..." or set it globally with `scv config author ...`'
+    end
+
+    if options[:amend] and repository.head.nil?
+      raise 'Amend requested but there are no commits'
+    end
+
+    if options[:message]
+      commit_message = options[:message].strip
+    else
+      commit_message_file = "#{repository_path}/COMMIT_MESSAGE"
+
+      if options[:amend]
+        File.write commit_message_file, repository[:head, :commit].message
+      end
+
+      system "$EDITOR #{commit_message_file}"
+      File.open(commit_message_file, 'r') do |file|
+        commit_message = file.read.strip
+      end
+      FileUtils.rm commit_message_file
+    end
+
+    if commit_message.empty?
+      raise 'The commit message cannot be empty'
+    end
+
+    date = options[:date].is_a?(String) ? DateTime.parse(options[:date]) : options[:date]
+
+    parents = nil
+
+    if options[:amend]
+      parents = repository[:head, :commit].parents
+    elsif repository.config['merge'] and repository.config['merge']['parents']
+      # There is a merge waiting for a commit creation
+      parents = repository.config['merge']['parents']
+
+      repository.config['merge'] = {}
+    end
+
+    repository.commit commit_message,
+                      author,
+                      date,
+                      parents: parents,
+                      ignore:  [/^\.|\/\./]
+
+    if parents
+      repository.config.save
+    end
+  end
+end

data/bin/commands/config.rb

@@ -0,0 +1,35 @@
+desc 'Sets/changes config parameters for this repository'
+arg_name '[<option> [<value>]]'
+command :config do |c|
+  c.desc          'Delete the specified key'
+  c.arg_name      'delete'
+  c.switch        [:d, :delete]
+
+  c.action do |global_options, options, args|
+    repository = global_options[:repository]
+
+    if args.empty?
+      # List all config options in a `tree`-like hierarchy
+      output { SCV::Formatters::Hierarchy.print(repository.config.data) }
+    elsif args.size == 1
+      if options[:delete]
+        repository.config.delete args.first
+        repository.config.save
+      else
+        # Print the specified option value
+        value = repository.config[args.first]
+
+        if value.is_a? Hash
+          SCV::Formatters::Hierarchy.print(value)
+        elsif not value.nil?
+          puts value
+        end
+      end
+    else
+      # Set the specified option
+      repository.config[args.first] = args[1..args.size].join(' ')
+      repository.config.save
+    end
+  end
+
+end

data/bin/commands/diff.rb

@@ -0,0 +1,19 @@
+desc 'Displays the file changes in the working directory'
+arg_name ''
+command :diff do |c|
+  c.action do |global_options, options, args|
+    repository = global_options[:repository]
+    commit     = repository[:head, :commit]
+    status     = repository.status commit,
+                                   ignore: [/^\.|\/\./]
+
+    output do
+      status.each do |_, file_list|
+        file_list.each do |file_path|
+          changeset = repository.file_difference file_path, commit
+          SCV::Formatters::Changeset.print file_path, changeset
+        end
+      end
+    end
+  end
+end

data/bin/commands/history.rb

@@ -0,0 +1,19 @@
+desc 'Displays the commit history'
+arg_name ''
+command [:history, :log] do |c|
+  c.action do |global_options, options, args|
+    repository = global_options[:repository]
+
+    output do
+      repository.history.each do |commit|
+        puts "Commit #{commit.id.yellow}"
+        puts "Author #{commit.author.blue}"
+        puts "Date   #{commit.date.strftime "%A %Y-%m-%d %H:%M:%S %z".green}"
+
+        puts
+        puts commit.message.lines.map { |line| "    #{line}" }.join ''
+        puts
+      end
+    end
+  end
+end

data/bin/commands/init.rb

@@ -0,0 +1,17 @@
+desc 'Initialize an empty repository.'
+command :init do |c|
+
+  c.action do |global_options, options, args|
+    path = global_options[:dir]
+
+    if File.directory? File.join(path, '.scv')
+      raise "There is already an SCV repository #{path == '.' ? 'here' : 'at ' + path}"
+    end
+
+    SCV::Repository.create_at path
+
+    puts "Job's finished!"
+    puts "You can now use `scv commit` to create your first commit!"
+  end
+
+end