all_todo 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14a238fd842c1ed5bc0895777821fd9c55475f8f
-  data.tar.gz: 94883c7db7611aaf8d9b81437f4aa7792425e68c
+  metadata.gz: 3ed63196b9525d18dd25167a81bbf2b8987e97d0
+  data.tar.gz: 2039058b2ecbb269e92d050e2a0bec750740daea
 SHA512:
-  metadata.gz: 5d644983654f354f63ab409e03264b12dc15c7164cebfab9f1ee2aa9a78399f0776f44cb8103ca1d372ad4284ab8b0c9fe23338e13e9084b25cc5fc04fc25669
-  data.tar.gz: eea0a4e9fc9e82949dfa4b2b7b805ed0dcb790636978ef8c1e8bad97e7992652efc77a7131c6676e3656f54c68372b198e4bb0c74208fc6af35b5cba8925b7df
+  metadata.gz: d7789bf3507a20d0afe7db1dd1bbd77f26792db4de3ef1fdeda4fc45bfddb2178d51abeb97dabda046e1e82a9280bf60df45f1af0ea25532b53aad3678a537d2
+  data.tar.gz: c6bb3184a4ebc46ecf5156f4d7b253b0c0f876b0615d087ce60ca09ef472e702752d3471f6e5938f81000b8d3bae9eb7e5ba8455f7581ff8b386cc25a2dc05ea

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-�nB\>��]5���Z͑��/`��3��a:�W_Ǟ���a���++ H�].m
'4�:�{ܯȫ$��@jr�o�!�'�Rw䦧�|gNz��U%$�B��gS
;�,ICL�Mߞ@{	9�+�N	oS�Q�T<�W�8��~�U���8�VD0��ո��K�kɦ���E��*K�&�
+K59�U<�E?7CJ���-mp��������.^M�o1JK��!�"l2L��G~,o��2��v�*��1W�mT�
+J��R1�-��/��с�r��"�L�0��r~�Y?�<dc��Nk+8)Kc������$c�ʗ��Ӏ�e� ��]�AFj�oІd�jW.JQ��d|����a�\��	Z�I�j��1�)�)�H䯂�p�J�d�K��tK�[���oÆ�]����NtK}�kK]��&znD *w���7�

data/lib/all_todo.rb

@@ -7,6 +7,62 @@ require 'px_todo'
 require 'rexle-diff'
 
 
+=begin
+## start of code comments ######################################
+
+how it should work
+==================
+
+Basic usage
+-----------
+
+the user ...
+
+* creates the all_todo.txt (see the sample all_todo.txt file)
+* runs AllTodo#to_s to refresh the all_todo.txt file with checkboxes
+* identifies the todo items for that day by prefixing the item with an
+  asterisk (*)
+* runs AllTodo#export_today to generate the todo_daily.txt file
+* crosses a few todo item checkboxes in the todo_daily.txt file and 
+  saves the file
+* runs AllTodo#update_today to update the completed todo items from the 
+  todo_daily.txt into the all_todo.txt file
+  - all_todo_detail.txt and all_todo_detail.xml is automatically updated
+
+Syncing from all_todo_detail.txt 
+---------------------------------
+
+the user ...
+
+* updates a few *when* fields in all_todo_detail.txt file
+* runs AllTodo#sync_detail which updates the *when* fields in all_todo.xml
+
+--------------------------------------------------
+
+example file
+
+all_todo.txt
+------------
+
+# Projects
+
+## all_todo
+
+[ ] Implement the secret new feature
+[ ] Add a README file
+
+## liveblog
+
+Implement the saving of images from the web locally
+
+# volunteering
+
+* Meeting at Cafe X
+
+## end of code comments ########################################
+=end
+
+
 class AllTodo < PxTodo
 
   def initialize(raw_s=nil, filepath: '.')
@@ -68,29 +124,30 @@ class AllTodo < PxTodo
     
   end
   
+  # parses the all_todo_detail.txt file
+  #
   def parse_detail(s)
     
     lines = s.lines
     lines.shift 3
-    pr = PxRowX.new(lines.join)
+
+    pr = PxRowX.new(lines.join, record_name: 'todo')
     pr.to_xml pretty: true    
 
-  end  
+  end
 
-  # parses the all_todo_detail.txt file and updates the all_todo_detail.xml file
   
-  def update_detail()
-    
-    s = File.read File.join(@filepath, 'all_todo_detail.txt')
+  # synchronises the when field
+  #
+  def sync(px, px2)
     
-    px = Polyrex.new parse_detail(s)
     results = []
     
     px.each_recursive do |x, parent|
       
       if x.when.length > 0 then
 
-        basic_xpath = x.node.backtrack.to_xpath
+        basic_xpath = x.node.backtrack(use_attributes: false).to_xpath
 
         a = basic_xpath.split('/')
         a.shift # removes the root node reference
@@ -108,35 +165,45 @@ class AllTodo < PxTodo
         results << [xpath, x.when]
       end
     end
-
-    # open the all_todo_detail.xml file
-    
-    xmlfilepath = File.join(@filepath, 'all_todo_detail.xml')
-    
-    # if the file doesn't exist save it and return from the method
-    
-    unless File.exists? xmlfilepath then
-      File.write xmlfilepath, px.to_xml(pretty: true)
-    end
-
-    px2 = Polyrex.new xmlfilepath
-
+        
     results.each do |xpath, val|
 
       r = px2.element(xpath + '/summary/when')
       r2 = px.element(xpath + '/summary/when')
       next unless r
 
-      a1, a2 = [r.text, val].map {|x| x.split(';').map(&:strip) }
+      a1, a2 = [r.text, val].map {|x| x.to_s.split(';').map(&:strip) }
       
       # return values which in both a1 and a2
-      r2.text = (a1 | a2).join('; ')
+      r.text = (a1 | a2).join('; ')
 
     end
     
-    # update the all_todo_detail.xml file
+    
+  end
+
+  
+  def sync_all_todo()    
+  
+    # given all_todo.txt is loaded
+    # load the master copy (all_todo.xml)
 
-    File.write xmlfilepath, px.to_xml(pretty: true)
+    px = Polyrex.new File.join(@filepath, 'all_todo.xml')  
+    
+    sync px, @px
+    
+  end
+  
+  
+  # synchronises the all_todo_detail.txt file and updates the *when* field in 
+  # the all_todo.xml file
+  #
+  def sync_detail()
+    
+    s = File.read File.join(@filepath, 'all_todo_detail.txt')
+    
+    px = Polyrex.new parse_detail(s)
+    sync px, @px
 
   end
 
@@ -146,10 +213,9 @@ class AllTodo < PxTodo
     
     # also update the all_todo.txt  and all_todo_detail.txt
     
-    File.write File.join(@filepath, 'all_todo.txt'), self.to_s    
-    
-    #update_detail()
-    #File.write File.join(@filepath, 'all_todo_detail.txt'), self.detail
+    File.write File.join(@filepath, 'all_todo.txt'), self.to_s        
+    File.write File.join(@filepath, 'all_todo_detail.txt'), self.detail
+
     'saved'
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: all_todo
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - James Robertson
@@ -31,7 +31,7 @@ cert_chain:
   4IWTpx4UfuUB+a/n3zRd7tPzfsCnbjv0WeNaOLxPEdrqrbPxdMp0ULnHMi6/cuMX
   +/4csIEIHj2yLg==
   -----END CERTIFICATE-----
-date: 2016-12-03 00:00:00.000000000 Z
+date: 2016-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: px_todo
@@ -42,7 +42,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,27 +52,27 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: rexle-diff
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.6.1
 description: 
 email: james@r0bertson.co.uk
 executables: []