git-ged 0.0.3 → 0.0.4

data/LICENSE

@@ -1,5 +1,4 @@
 Copyright (c) 2011, John Sumsion
-All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

data/README.md

@@ -9,20 +9,26 @@ GEDCOM plugin for Git.  As a `git` subcommand, git-ged lets you import and
 manage GEDCOM files in a versioned, shareable way in a Git repository.
 
 It is also possible to attach to other repositories and fetch related
-genealogy from others who have imported it into their own repository.
+genealogy data from others who have imported it into their own repository.
 
 As a library, git-ged lets you write programs that communicate genealogical
 data in the git-ged repository layout.
 
 As a repository implementation, git-ged also defines a repository
 specification that, if adhered to by alternate implementations will render
-all implementations data-compatible with each other.
+all implementations to share repositories with each other.
 
 The genealogical data format for persons and relationships is yet to be
 decided.  The first cut will be one that is largely one-to-one compatible
 with GEDCOM 5.5.  I fully expect to change the format before this
 solidifies, and I'll use whatever is the commonly-accepted format.
 
+NOTE: Although I started git-ged and have worked on it while being employed
+by FamilySearch, this project is not endorsed and is not supported in any
+way by FamilySearch.  I work on it outside of work hours, and do not use
+internal FamilySearch servers or data privileges.  It is a personal endeavor
+to enrich the genealogy data sharing ecosystem.
+
 
 ## Requirements
 

data/TODO

@@ -4,17 +4,24 @@ Structure
 - commands
 
 Bootstrapping
-- integrate OptionParser (stdlib) and subcommand (gem) into git-ged commands
-- patch gem-man to read README{,.md} in lieu of any explicit manpage (gem man rib)
+-------------
+- use commandable for subcommand running
+- hook up --verbose option => GitGed.debug
+- move init's optparse initialization into init.rb
+
+- use pwd and arg in init.rb to get full pathname to new git-ged repo and print in output
+- make init.rb use grit to initialize (note: .../.git is what it expects for non-bare)
+- add --bare option
+
+- move layout.txt => LAYOUT down under lib/git-ged/data (leaving a symlink behind at root)
+- create data/licenses subdir with licenses by short-name (see git-bup's SIGNED-OFF-BY for EULA ideas)
+- populate LAYOUT under refs/heads/master during "init"
+- add -l --license option to "init" that populates DEFAULT_LICENSE under refs/heads/master
 
-- create licenses subdir with data licenses by short-name
-- create templates area that refs/heads/master can be populated from during "git ged init"
-- create git-ged command that invokes git-ged-*
-- create lib/git-ged/init.rb that invokes git init + template population (normal or bare)
 - create lib/git-ged/ingest.rb that copies a GEDCOM in and assigns permaname (refs/local/gedcoms)
+- copy DEFAULT_LICENSE => ged1.LICENSE or allow -l --license option to specify
 - ingest one of Hannah's small GEDCOMs
 - ingest one of Hannah's full GEDCOMs
-- get rib-git-ged plugin working
 
 - create living filter pipe for filtering GEDCOMs
 - create lib/git-ged/import.rb that copies a GEDCOM from refs/{local=>heads}/gedcoms with living filter
@@ -29,6 +36,15 @@ Bootstrapping
   - pick default person/family permaname generation logic based on whether the _UUIDs match up
   - create local/gedcoms history based on 
 
+- allow "init" to reinitialize an already-initialized repo and copy new DEFAULT_LICENSE/new LAYOUT
+
+- pull living calculations and hash calculations out into json-select code (semver) under refs/heads/code
+- put code version (semver + sha) into each entity on import/commit where a function was used (gedcom, person, family)
+
+Ideas
+-----
+- patch gem-man to read README{,.md} in lieu of any explicit manpage (gem man rib)
+- get rib-git-ged plugin working
 
 GUI:
   shoes

data/git-ged.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
 
   s.name              = 'git-ged'
   s.version           = GitGed::VERSION
-  s.date              = '2012-01-09'
+  s.date              = '2012-01-25'
 
   s.summary     = "GEDCOM plugin for Git"
   s.description = "git-ged is a Ruby toolset for managing genealogical data (GEDCOM) inside a Git repository."
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = %w[README.md LICENSE LICENSE.grit TODO layout.txt]
 
   s.add_dependency('grit', "~> 2.4.1")
-  s.add_dependency('subcommand', "~> 1.0.6")
+  s.add_dependency('cli', "~> 1.1.0")
 
   s.add_development_dependency('mocha')
 

data/layout.txt

@@ -3,22 +3,24 @@ GIT-GED CONCEPTS
 
 1) Git-ged commands
 [repo-level]
-- Init: populates refs/heads/{master,content,intent} with README, LICENSE_DEFAULT, etc. as specified by user
+- Init: populates refs/heads/{master,content,intent/master} with README, LICENSE_DEFAULT, etc. as specified by user
 - Clone: same as git clone
 - Attach: same as git remote add, except that it allows the user to define the set of permanames of interest in the remote repo
 - Fetch: same as git fetch, except that only permanames that the user currently has are fetched (along with refs/heads/master)
 - Push: same as git push, except that only permanames that the remote repo has are updated
 [entity-state]
-- Intent: captures one-line user intent (separate from commit message)
+- Intent: captures one-line user intent to capture large-scale project (separate from commit message on a single entity)
 - Ingest: populates refs/local/gedcoms/{permaname(s)} with a raw gedcom, adding new gedN files for permaname collisions
 - Filter: performs living filter and populates refs/heads/gedcoms/{permaname}
 - Import: creates any new persons/families and records import flag & new person/family permaname+state links in gedX.IMPORT
+- Resolve: deals with multiple-record histories in a smart way (gedcoms/persons/families)
+- Owner: establishes identity of the owner of the repo in refs/heads/content:/OWNER,
+  adds person for the user and allows specification of 'mpmmp' ancestor links to deceased horizon
 [interactive-use]
 - Workspace: (subcommands: checkout, update, reset)
   - checkout: grabs every specified person/family/gedcom permaname and puts it under the path repo/[persons|families|gedcoms]/{permaname} in a transient commit
   - update: grabs the head of every specified person/family/gedcom permaname and puts it under a new refs/heads/workspace commit
   - reset: warns if un-git-ged-committed refs/heads/workspace history, then nukes it and recreates a refs/heads/workspace commit with the same permanames as it had before
-- Resolve: deals with multiple-record histories in a smart way (gedcoms/persons/families)
 - Commit: creates commits on every separate permaname that has changed, using current intent as default commit subject plus details of all entities that changed
 
 2) Data Licenses
@@ -54,10 +56,10 @@ GIT-GED CONCEPTS
   - import is responsible for initially segmenting living vs. deceased, but after import the app is responsible for calculating living after edit and moving the record if necessary
   - the same living check & segmentation logic that import uses will be available on-demand for apps to use after edit
   - when a deceased record is made living, the deceased record's permaname gets a new commit that marks it as no-longer-visible (so that on subsequent fetch, other repositories can delete their records)
-- includes optional "supersedes", "superseded-by", "derived-from", "same-as", and "not-same-as" link attributes
-  - see 
-  - the "derived-from", "supersedes", and "superseded-by" link attributes allow for proper history-aware
+- includes optional "supersedes", "superseded-by", "derived-from", "descendant-of", "same-as", and "not-same-as" link attributes
+  - the "supersedes", "superseded-by", and "derived-from" link attributes allow for proper history-aware
     linkage across permanames for tracing merge or other complicated person record derivation
+  - the "descendant-of" attribute is for attaching non-descript living persons to their deceased horizon via "mpmmp" links
   - the "same-as" attribute is a loose identity link to an alternate history of a person
     determined to be the same historical person, it is a hint that a merge or other record derivation may be useful in the future
   - if the "not-same-as" attribute refers to a disconnected history of a *different* person under the same permaname,
@@ -123,28 +125,36 @@ GIT-GED REFS LAYOUT
 ===================
 
 refs/heads/*:
-- stuff that can be cloned/forked
+- stuff that can be cloned/fetched
+refs/heads/{gedcoms,persons,families/intents}/*
+- data that can be cloned/fetched/forked piecemeal
 refs/local/*:
 - dispensible stuff that is used for local import actions (not needed for collaboration)
 - hidden stuff that should not be published on a clone/fork
 
 refs/heads/master (fetchable, but non-mergeable):
 - README: simple documentation of git-ged, with pointer to software to parse/use
+- LAYOUT: this file containing details of git-ged structure
 
 refs/heads/content (fetchable, but non-mergeable):
 - META: last version of git-ged that wrote
-- INTENT: link to last intent
-- ROOTS: links to various person roots
-- ENTITIES: list of gedcom/person/family permaname+state links, may end up needing to be sharded for very large repos
+- OWNER: the identity of the owner of this repo + OpenID URLs, blog URLs and/or email(s)
 - LICENSE_DEFAULT: default license for any new records added or imported into to this repository, defaults to Creative Commons Share-alike
-- [non-versioned] CHANGELOG: contains up to last 100 edits performed, updated by git-ged commit
-
-refs/heads/intent (fetchable, but non-mergeable):
-- INTENT: stores the user's identity, single-line intent message, and date in the tree itself to capture "why"
+- ROOTS: links to various person permaname roots, to start tree navigation from
+- ENTITIES: list of gedcom/person/family/intent permaname+state links, may end up needing to be sharded for very large repos
+- INTENTS: list of last N intents & date & author
+- CHANGELOG: contains up to last 100 edits performed, including list of entities changed, updated by git-ged commit
+- LIMITS: maximum number of intents, etc.
+
+refs/heads/intents/master (fetchable, but non-mergeable):
+- INTENT: stores the user's git identity, date, and, single-line 140-char intent message in the tree itself to capture "why"
 - MUST exist: if no intent is explicitly stored, init/import/edit must stub one in that describes the largest-scope action being taken
-- able to be as fine-grained and meticulous as the user wants to be, while allowing the user
-  the convenience of keeping the same intent over several small actions moving toward a large-time-scale goal
+- able to cherry-pick an intent from some other user to show you're working toward the same goal as someone else
 - able to generate a feed of intents from here
+- capped at 100 or so max commits (large limit)
+
+refs/heads/intents/{permanames}:
+- selective intents used to document why a certain change is made (linked from entities at commit)
 
 refs/heads/workspace (fetchable, but non-mergeable):
 - non-history-preserving workspace tree for pulling a subset of records into a filesystem for edit
@@ -158,8 +168,8 @@ refs/heads/gedcoms/{permanames}:
 
 refs/local/gedcoms/{permanames}:
 - *may* contain living data, populated without filtering by "ingest"
-- ged1.ged: the raw gedcom file renamed to a standard filename
-- gedN.ged: the raw gedcom file renamed to a standard filename
+- ged1: the raw gedcom file renamed to a standard filename
+- gedN: the raw gedcom file renamed to a standard filename
 - pre-existing permanames get forwarded up to the new tree (collisions, yay!)
 - new permanames get created, non-colliding permanames don't get forwarded (gc'd by some other mechanism)
 - if the gedcom contains no living data, "import" can delete the refs/local refs

data/lib/git-ged.rb

@@ -23,7 +23,7 @@ require 'git-ged/init'
 # internal support classes
 
 module GitGed
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   class << self
 

data/lib/git-ged/cli.rb

@@ -1,52 +1,50 @@
 #!/usr/bin/env ruby
 
 require 'git-ged'
-require 'optparse'
-require 'subcommand'
 
 module GitGed
   class CLI
 
-    include Subcommands
-
-    # patch until subcommand 1.0.7 comes out
-    attr_accessor :appname
-    def print_actions
-      super.sub(/See '.* help COMMAND'/, "See '#{appname} help COMMAND'")
-    end
-
-    def initialize
-      @options = {}
-
-      self.appname = "git ged"
-      global_options do |opts|
-        opts.banner = "Usage: #{appname} [options] [subcommand [options]]"
-        opts.separator ""
-        opts.separator "Global options are:"
-        opts.on("-v", "--[no-]verbose", "Show git-ged & grit debug") do |v|
-          GitGed.debug = v
-        end
-      end
-      add_help_option
-
-      command :init do |opts|
-        opts.banner = "Usage: #{appname} init [-m msg] [repo]"
-        opts.description = "Initializes a new git-ged repo"
-        opts.separator ""
-        opts.separator "Options:"
-        opts.on "-m MESSAGE", "--message MESSAGE" do |msg|
-          @options[:message] = msg
-        end
-      end
-    end
+#    include Subcommands
+#
+#    # patch until subcommand 1.0.7 comes out
+#    attr_accessor :appname
+#    def print_actions
+#      super.sub(/See '.* help COMMAND'/, "See '#{appname} help COMMAND'")
+#    end
+
+#    def initialize
+#      @options = {}
+#
+#      self.appname = "git ged"
+#      global_options do |opts|
+#        opts.banner = "Usage: #{appname} [options] [subcommand [options]]"
+#        opts.separator ""
+#        opts.separator "Global options are:"
+#        opts.on("-v", "--[no-]verbose", "Show git-ged & grit debug") do |v|
+#          GitGed.debug = v
+#        end
+#      end
+#      add_help_option
+#
+#      command :init do |opts|
+#        opts.banner = "Usage: #{appname} init -m msg [repo]"
+#        opts.description = "Initializes a new git-ged repo"
+#        opts.separator ""
+#        opts.separator "Options:"
+#        opts.on "-m INTENT", "--message INTENT" do |intent|
+#          @options[:intent] = intent
+#        end
+#      end
+#    end
 
     def run
-      cmd = opt_parse()
-      if cmd
-        Repo.new.send cmd, ARGV, @options
-      else
-        puts global_options { |opts| opts }
-      end
+#      cmd = opt_parse()
+#      if cmd
+#        Repo.new.send cmd, ARGV, @options
+#      else
+#        puts global_options { |opts| opts }
+#      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-ged
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000 Z
+date: 2012-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &23602420 !ruby/object:Gem::Requirement
+  requirement: &18492800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: 2.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *23602420
+  version_requirements: *18492800
 - !ruby/object:Gem::Dependency
-  name: subcommand
-  requirement: &23601940 !ruby/object:Gem::Requirement
+  name: cli
+  requirement: &18491340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *23601940
+  version_requirements: *18491340
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &23601560 !ruby/object:Gem::Requirement
+  requirement: &18488740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23601560
+  version_requirements: *18488740
 description: git-ged is a Ruby toolset for managing genealogical data (GEDCOM) inside
   a Git repository.
 email: jdsumsion@gmail.com
@@ -95,3 +95,4 @@ signing_key:
 specification_version: 2
 summary: GEDCOM plugin for Git
 test_files: []
+has_rdoc: