change_agent 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b77277230a8527bd86be1e4caa5500834b9aef1b
-  data.tar.gz: 43b6adf0ecc54612020d28b9050970cd3279b4c6
+  metadata.gz: 637bed85fb1871ec16e91eccd2e654cacc3718b1
+  data.tar.gz: ac8434e78322e91231c2b8d446df980eb8472a94
 SHA512:
-  metadata.gz: 308dc37a2ce06801aac82ee1bde0113ee23181bc40c3cf0093f72bf03b3c4c47a4f8672f53b4e032d25c596e217428b1590da20b530054ab35b36f2dbe73a3e0
-  data.tar.gz: 26a15963bff1938fdd7418169dfd9bdf0b7e731ba17b527032800e87a209e12340850cb96fe8bd7969071d1b53f69670c7e770344919d997db11b3ea9f3ff721
+  metadata.gz: 6b12aa9d46caeefcd917f72bf9a2ca4f514dcb55044a5a559d24031c83e8747680879a1873578e1d5875faa31b4a19831726af3dc5f4f6de0dd6de287355252a
+  data.tar.gz: 652be6634b377ccba3b04bcadeafae8dc314e5fa3ccced55377e3e53dc6dd46a4de6eb5c8c97a9ca448ab98912020d8404ec8bd89f2a3a807f9f71b70e403355

data/.travis.yml

@@ -0,0 +1,4 @@
+langauage: ruby
+script: "script/cibuild"
+sudo: false
+cache: bundler

data/README.md

@@ -2,6 +2,8 @@
 
 *A Git-backed key-value store, for tracking changes to documents and other files over time.*
 
+[![Gem Version](https://badge.fury.io/rb/change_agent.svg)](http://badge.fury.io/rb/change_agent) [![Build Status](https://travis-ci.org/benbalter/change_agent.svg)](https://travis-ci.org/benbalter/change_agent)
+
 ### A git-backed key value store sounds like a terrible idea. Why would you do that?
 
 Let's say you're building a scraper to see when Members of Congress post press releases to their websites and to track how those press releases change over time. You could build a purpose-built application, store each revision in a database, and then build an interface to view all the known press releases and compare their history. Stop the insanity!
@@ -41,6 +43,29 @@ change_agent.get "foo/bar"
 
 It's really up to you, but you'll get performance and usability bumps the more you namespace. I'd recommend thinking about what you want the Git repo to look like when browse, and work backwards from there.
 
+### Cloning an existing repo / datastore
+
+```ruby
+repo = "https://github.com/benbalter/some_repo"
+directory = "data"
+change_agent = ChangeAgent::Client.new(directory, repo)
+
+change_agent.get("foo")
+=> "bar"
+```
+
+### Pushing and pulling
+
+Ready to push your Git repo to a server? Assuming you've already got a remote set up, it's as simple as
+
+```ruby
+# pull in the latest data
+change_agent.git.pull
+
+# push the data
+change_agent.git.push
+```
+
 ## Project status
 
 Initial proof of concept

data/change_agent.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "git"
   spec.add_dependency "rugged"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/change_agent.rb

@@ -1,12 +1,13 @@
 require_relative "change_agent/version"
 require_relative "change_agent/document"
 require_relative "change_agent/client"
-require "git"
+require "rugged"
+require 'pathname'
 
 module ChangeAgent
 
-  def self.init(directory=nil)
-    Client.new(directory)
+  def self.init(directory=nil, remote=nil)
+    Client.new(directory, remote)
   end
 
 end

data/lib/change_agent/client.rb

@@ -3,12 +3,17 @@ module ChangeAgent
 
     attr_accessor :directory
 
-    def initialize(directory=nil)
+    def initialize(directory=nil, remote=nil)
       @directory = File.expand_path(directory || Dir.pwd)
+      @remote = remote
     end
 
-    def git
-      @git ||= Git.init directory
+    def repo
+      if @remote.nil?
+        @repo ||= Rugged::Repository.init_at directory
+      else
+        @repo ||= Rugged::Repository.clone_at @remote, directory
+      end
     end
 
     def set(key, value)

data/lib/change_agent/document.rb

@@ -1,11 +1,12 @@
 module ChangeAgent
   class Document
 
-    attr_accessor :key
     attr_writer :contents
+    attr_accessor :path
+    alias_method :key, :path
 
-    def initialize(key, client_or_directory=nil)
-      @key = key
+    def initialize(path, client_or_directory=nil)
+      @path = path
       if client_or_directory.class == ChangeAgent::Client
         @client = client_or_directory
       else
@@ -13,51 +14,58 @@ module ChangeAgent
       end
     end
 
-    def git
-      @client.git
-    end
-
-    # base dir for repo
-    def base_dir
-      @client.directory
-    end
-
-    # directory containing file
-    def directory
-      @directory ||= File.dirname(path)
-    end
-
-    def path
-      File.expand_path key, base_dir
-    end
-
-    def exists?
-      File.exists? path
+    def repo
+      @client.repo
     end
 
     def contents
-      @contents ||= File.open(path).read
-    rescue Errno::ENOENT
+      @contents ||= begin
+        tree = repo.head.target.tree
+        blob = repo.lookup tree.path(path)[:oid]
+        blob.content
+      end
+    rescue Rugged::ReferenceError, Rugged::TreeError
       nil
     end
 
     def write
-      FileUtils.mkdir_p directory unless Dir.exists? directory
-      File.write(path, contents)
-      commit
-    end
+      clean_path
+      oid = repo.write contents, :blob
+      repo.index.add(path: path, oid: oid, mode: 0100644)
 
-    def commit
-      git.add(path)
-      git.commit "Updating #{path}"
+      Rugged::Commit.create repo,
+        message: "Updating #{path}",
+        parents: repo.empty? ? [] : [ repo.head.target ],
+        tree: repo.index.write_tree(repo),
+        update_ref: 'HEAD'
     end
 
-    def delete
-      git.remove(path)
+    def delete(file=path)
+      repo.index.remove(file)
+
+      Rugged::Commit.create repo,
+        message: "Removing #{path}",
+        parents: [repo.head.target],
+        tree: repo.index.write_tree(repo),
+        update_ref: 'HEAD'
     end
 
     def inspect
-      "#<ChangeAgent::Document key=\"#{key}\">"
+      "#<ChangeAgent::Document path=\"#{path}\">"
+    end
+
+    private
+
+    def clean_path
+      return if repo.empty?
+      dirs = []
+      tree = repo.head.target.tree
+      path.split("/").each do |part|
+        file = dirs.push(part).join("/")
+        delete(file) if tree.path(file)
+      end
+    rescue Rugged::TreeError
+      nil
     end
   end
 end

data/lib/change_agent/version.rb

@@ -1,3 +1,3 @@
 module ChangeAgent
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/script/bootstrap

@@ -1 +1,3 @@
+#!/bin/sh
+
 bundle install

data/script/cibuild

@@ -1 +1,15 @@
+#!/bin/sh
+
+git config --get user.name > /dev/null
+if [ $? -eq 1 ]; then
+  git config --global user.name "Your Name"
+fi
+
+git config --get user.email > /dev/null
+if [ $? -eq 1 ]; then
+  git config --global user.email "you@example.com"
+fi
+
 bundle exec rake test
+
+rm -Rf tmp

data/script/console

@@ -1 +1,3 @@
+#!/bin/sh
+
 bundle exec rake console

data/test/test_change_agent_client.rb

@@ -7,53 +7,50 @@ class TestChangeAgentClient < Minitest::Test
     @client = ChangeAgent::Client.new(tempdir)
   end
 
+  def teardown
+    FileUtils.rm_rf tempdir
+  end
+
   should "set the directory on init" do
     assert_equal tempdir, @client.directory
   end
 
+  should "clone into existing repos" do
+    repo = "https://github.com/benbalter/change_agent"
+    agent = ChangeAgent::Client.new(tempdir, repo)
+    assert_equal repo, agent.repo.remotes.first.url
+    assert Dir.entries(tempdir).count > 5
+  end
+
   should "default to the pwd" do
     assert_equal Dir.pwd, ChangeAgent::Client.new.directory
   end
 
   should "init the git object" do
-    assert_equal Git::Base, @client.git.class
-    expected = File.expand_path ".git", tempdir
-    assert_equal expected, @client.git.repo.path
+    assert_equal Rugged::Repository, @client.repo.class
+    assert_equal tempdir + "/.git/", @client.repo.path
   end
 
   should "store a value" do
     @client.set "foo", "bar"
-    file = File.expand_path "foo", tempdir
-    assert File.exists? file
-    assert_equal "bar", File.open(file).read
+    tree = @client.repo.head.target.tree
+    blob = @client.repo.lookup tree["foo"][:oid]
+    assert_equal "bar", blob.content
   end
 
   should "store a namespaced value" do
     @client.set "foo/bar", "baz"
-    file = File.expand_path "foo/bar", tempdir
-    assert File.exists? file
-    assert_equal "baz", File.open(file).read
+    tree = @client.repo.head.target.tree
+    blob = @client.repo.lookup tree.path("foo/bar")[:oid]
+    assert_equal "baz", blob.content
   end
 
   should "retrieve a file's value" do
-    file = File.expand_path "foo", tempdir
-    File.write file, "bar"
-    assert_equal "bar", @client.get("foo")
-  end
-
-  should "retrive a namespaced file's value" do
-    file = File.expand_path "foo/bar", tempdir
-    FileUtils.mkdir_p File.dirname(file)
-    File.write file, "baz"
-    assert_equal "baz", @client.get("foo/bar")
-  end
-
-  should "round trip a value" do
     @client.set "foo", "bar"
     assert_equal "bar", @client.get("foo")
   end
 
-  should "round trip a namespaced value" do
+  should "retrive a namespaced file's value" do
     @client.set "foo/bar", "baz"
     assert_equal "baz", @client.get("foo/bar")
   end

data/test/test_change_agent_document.rb

@@ -4,12 +4,17 @@ class TestChangeAgentDocument < Minitest::Test
 
   def setup
     init_tempdir
-    @document = ChangeAgent::Document.new("foo", tempdir)
-    @namespaced_document = ChangeAgent::Document.new("bar/foo", tempdir)
+    @client = ChangeAgent::Client.new tempdir
+    @document = ChangeAgent::Document.new("foo", @client)
+    @namespaced_document = ChangeAgent::Document.new("bar/foo", @client)
   end
 
-  should "store the document key on init" do
-    assert_equal "foo", @document.key
+  def teardown
+    FileUtils.rm_rf tempdir
+  end
+
+  should "store the document path on init" do
+    assert_equal "foo", @document.path
   end
 
   should "accept a client if passed" do
@@ -22,58 +27,43 @@ class TestChangeAgentDocument < Minitest::Test
   end
 
   should "expose the git client" do
-    assert_equal Git::Base, @document.git.class
-  end
-
-  should "calcuate the base_dir" do
-    assert_equal tempdir, @document.base_dir
-  end
-
-  should "calcuate the directory" do
-    assert_equal tempdir, @document.directory
-
-    expected = File.expand_path "bar", tempdir
-    assert_equal expected, @namespaced_document.directory
-  end
-
-  should "know the file path" do
-    expected = File.expand_path "foo", tempdir
-    assert_equal expected, @document.path
-
-    expected = File.expand_path "bar/foo", tempdir
-    assert_equal expected, @namespaced_document.path
-  end
-
-  should "know if a file exists" do
-    refute @document.exists?
-    FileUtils.touch @document.path
-    assert @document.exists?
+    assert_equal Rugged::Repository, @document.repo.class
   end
 
   should "read a file's contents" do
-    File.write @document.path, "bar"
+    @document.contents = "bar"
+    @document.write
     assert_equal "bar", @document.contents
   end
 
   should "write a file's contents" do
     @document.contents = "bar"
-    assert_equal "bar", @document.contents
     @document.write
-    assert_equal "bar", File.open(@document.path).read
+    assert_equal "bar", @client.get("foo")
   end
 
   should "commit the document to the repo" do
     @document.contents = "bar"
     @document.write
-    assert_equal 1, @document.git.log.count
-    assert_equal "Updating #{@document.path}", @document.git.log.first.message
+    assert_equal "Updating #{@document.key}", @document.repo.last_commit.message
   end
 
   should "delete the document" do
     @document.contents = "bar"
     @document.write
-    assert File.exists? @document.path
+    assert @client.get "foo"
     @document.delete
-    refute File.exists? @document.path
+    refute @client.get "foo"
+    assert_equal "Removing #{@document.key}", @document.repo.last_commit.message
+  end
+
+  should "clobber conflicting namespace" do
+    @document.contents = "bar"
+    @document.write
+
+    doc = ChangeAgent::Document.new("foo/bar", @client)
+    doc.contents = "baz"
+    doc.write
+    assert_equal "baz", @client.get("foo/bar")
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: change_agent
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: git
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md