gitdb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b759526ad3c7265b6ac63d0c3b9eb71ce5daa8e0
-  data.tar.gz: 50bec8e6486e92c06b570236510c5637683c2b64
+  metadata.gz: f7a1bc21909ffaeca6f702432301c0d394401eba
+  data.tar.gz: ae4fd5a9480cc5d4be7e3907fbf289fcfe733242
 SHA512:
-  metadata.gz: 4a368ef5bd7a21994a7ba199015eaa943a9fdd0098e3218781839e129d8c87b673407bbe0ade5719912494b0d1e80f84f3189d17a3727ca0646e0c144f94c8ee
-  data.tar.gz: dee8285fb119dc87f3c5d22c7767976cfd91de9e2ab26fa7af87998c3b9385894a915b87a219c2a7652cee1d825767c80e47a409ab0f90ffc12fe4b538a518a1
+  metadata.gz: 0fe76feada56a5c5fd80ff8eca7782620cfd42c3a9bf7c5635abeaaeec57c3d2b88575fd1174cf1a2625f71b0f65e6a56d171ca9b1bdba60a2395f0cbb49d047
+  data.tar.gz: 35bcf802052c086c85ff8ae009009115b9675c88437d22294113bbcf566e1fab9d25b7d8146b0d0220739158b62fa58f246113e4efbdf0e0e86706d2371370d0

data/.gitignore

@@ -11,4 +11,6 @@
 *.so
 *.o
 *.a
-mkmf.log
+storage/
+.*
+*.log

data/README.md

@@ -1,6 +1,7 @@
 # Gitdb
 
-TODO: Write a gem description
+**Git-Contacts** backend data engine  
+a simple data storage based on git, designed for Git-Contacts
 
 ## Installation
 
@@ -20,12 +21,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Module: `Gitdb`
 
-## Contributing
++ constant: `Gitdb::STORAGE_PATH`
++ class method: `setup_storage`
 
-1. Fork it ( https://github.com/[my-github-username]/gitdb/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+#### Class: `Gitdb::Contacts`
+
++ class method: `exist?(gid)`
+
+##### instance: `Gitdb::Contacts.new(uid)`
+
++ property: `repo`
++ method: `exist?(gid)`
++ method: `create(gid)`
++ method: `access(gid)`
++ method: `getmeta`
++ method: `setmeta(Hash)`
++ method: `get_all_cards`
++ method: `get_card_by_id(id)`
++ method: `read_change_history`
++ method: `revert_to(sha, authorhash, message)`
++ method: `make_a_commit(optionhash)`
+
+#### Class: `Gitdb::Card`
+
++ class method: `exist?(repo, id)`
+
+##### instance: `Gitdb::Card.new(repo)`
+
++ method: `create(uid)`
++ method: `access(id)`
++ method: `format_card(id, uid)`
++ method: `getdata`
++ method: `setdata(Hash)`
++ method: `getmeta`
++ method: `setmeta(Hash)`
++ method: `delete`
++ method: `add_to_stage(id, content)`

data/lib/gitdb/Card.rb

@@ -93,7 +93,7 @@ module Gitdb
         @content[sym_key] = hash[sym_key]
       end
       # 每次对数据的修改会触发一次"写入暂存区"
-      write_to_stage @id, JSON.pretty_generate(@content)
+      add_to_stage @id, JSON.pretty_generate(@content)
     end
 
     def getmeta
@@ -104,13 +104,13 @@ module Gitdb
       @content[:meta] = hash
     end
     
-    # Notice: 调用delete之后需要先commit, 然后才能继续调用write_to_stage
+    # Notice: 调用delete之后需要先commit, 然后才能继续调用add_to_stage
     def delete
       @repo.index.read_tree @repo.head.target.tree unless @repo.branches.count == 0
       @repo.index.find { |blob| @repo.index.remove blob[:path] if blob[:path] == @id }
     end
 
-    def write_to_stage id, content
+    def add_to_stage id, content
       oid = @repo.write content, :blob
       @repo.index.read_tree @repo.head.target.tree unless @repo.branches.count == 0
       @repo.index.add :path => id, :oid => oid, :mode => 0100644

data/lib/gitdb/version.rb

@@ -1,3 +1,3 @@
 module Gitdb
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/gitdb.rb

@@ -9,7 +9,7 @@ require_relative 'gitdb/Contacts'
 module Gitdb
   
   # 主存储目录
-  STORAGE_PATH = File::expand_path '../../../storage', __FILE__
+  STORAGE_PATH = "#{Dir::pwd}/storage"
 
   # 检查并创建主存储目录
   def self::setup_storage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitdb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ran