gnu-remind 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e19a29ab03bfa83dfcb3fcf0e55a656a46d3bc5a208f13e4328208603ff89d2
-  data.tar.gz: 2f28f2c9cbb5f6be6f651b237eee7388fd0ccc8ec6fcc7fc18c61796c2ecbd81
+  metadata.gz: 21529ecd1aa56da32a0cef066ad2439f4662c48323a7f1c78b3a3c15d93846c0
+  data.tar.gz: de27928dad2b75db75dc3fda5d66340d0c5b9c8aebb9c13b33da0cb9cd4724de
 SHA512:
-  metadata.gz: 0f01038165073462f41b21fa90f2c8d7cd04c9930aedc4b75d7da3e7ecf26a11fe92303f762a13488276aecf4943fd15615b4e79edb80e899ffa218b35eb4b7f
-  data.tar.gz: 48deb1c49d4524cc6abd9b2e22a2fc802fdadf7b799a48adf2bc7ecc0edbbdd5f645386171fa3b19507a69e1739946f23d6cd706dac6e240e4f5e3ee5d62d317
+  metadata.gz: ed69e87f261df62e70e7e7fc1b2f604f859c1bc3a23189407d648003c3106c9dea183fee848f70a1fa5562c811791eed271f8c5c789307bd054f54cf07bd267a
+  data.tar.gz: 9660e7feb1de77993b54e82cf64a0af16d951d0135afa0dc555d2bd05c3e75b248cf4bf0b5e66f920d2e451407e7f522033ef793b9faa65856b1f02922dac4ce

data/README.md

@@ -24,59 +24,24 @@ gem build remind.gemspec
 require 'remind'
 ```
 ### Remind
-Use as a generic reminder handler.
+A wapper around gnu remind.
 
-#### set
+#### Set Reminders Collection
 Create local reminders from url.
 ```
-Remind['key'] = %[https://example.ics]
+Remind.set(collection, "Binner at 8 tonight.")
 ```
 
-#### get
+#### Get Reminders Collection
 Extract agenda from local reminders.
 ```
-Remind['key']
+Remind.get(collection)
 ```
 
-#### all
+#### Get System Reminders
 ```
-Remind.all
+Remind.get!
 ```
 
-
-### REM
-Use as a task specific tool
-
-#### collection
-```
-REM['collection']
-```
-
-#### entry
-```
-REM['collection']['entry']
-```
-
-#### entry attributes
-```
-REM['collection']['entry'].attr = { type: "event type", date: "1 Jan 1970", lead: 7, repeat: 4, hour: "22", minute: "45", duration: "1:45", at: "Place Name" }
-```
-
-#### entry reminder
-```
-REM['collection'].to_rem
-```
-
-#### save collection
-```
-REM['collection'].to_rem!
-```
-
-#### collection agenda
-```
-REM['collection'].agenda
-```
-
-
 ## Development
 You can also run `ruby bin/console` for an interactive prompt that will allow you to experiment.

data/lib/remind/calendar.rb

@@ -1,43 +1,54 @@
-
+# Icalendar wrapper.
 module CAL
+
+  # Calendar object.
   class C
+    # Calendar +f+
     def initialize f
       @f = f
     end
+    # each calendar event
     def each &b
       @f.events.each { |e| b.call(E.new(e)) }
       return nil
     end
+    # map each calendar event
     def map &b
       a = []
       @f.events.each { |e| a << b.call(E.new(e)) }
       return a
     end
   end
-  
+
+  # Calendar Event object
   class E
+    # Calendar Event +f+.
     def initialize f
       @f = f
     end
+    # Calendar Event location
     def where
       @f.location
     end
+    # Calendar Event focus
     def who
       @f.summary
     end
+    # Calendar Event details
     def what
       @f.description
     end
+    # Calendar Event scheduling
     def when
       { begin: @f.dtstart, end: @f.dtend }
     end
   end
-  
+  # Load Calendar Event Collection from file +f+.
   def self.from_file f
     x = File.read(f)
     C.new(Icalendar::Calendar.parse(x).first)
   end
-  
+  # Load Calendar Event Collection from url +u+.
   def self.from_url u
     x = Faraday.new().get(u).body
     C.new(Icalendar::Calendar.parse(x).first)

data/lib/remind/event.rb

@@ -1,5 +1,9 @@
+# Event Processor
 module EVENT
+
+  # Event object.
   class E
+    # Event +i+.
     def initialize i
       @event = Nickel.parse i
       puts %[EVENT::E: #{@event}]
@@ -10,6 +14,7 @@ module EVENT
         @message = i
       end
     end
+    # is event?
     def event?
       if %[#{@event.message}].length > 0 && @event.occurrences.length > 0
         return true
@@ -17,6 +22,7 @@ module EVENT
         return false
       end
     end
+    # each event occourence 
     def each &b
       @event.occurrences.each { |e|
         h = {
@@ -31,6 +37,7 @@ module EVENT
       return nil
     end
   end
+  # Process event.
   def self.[] k
     E.new(k)
   end

data/lib/remind/remind.rb

@@ -1,32 +1,42 @@
+# The Reminder wrapper.
 module REM
-  class E 
+  # The Reminder collection object.
+  class E
+    # Reminder collection +k+.
     def initialize k
       @id = k
       @r = Hash.new { |h,k| h[k] = R.new(k) }
       clear!
     end
+    # Reminder collection id.
     def id; @id; end
-    
+
+    # get Reminder from collection.
     def [] k
       @rem << k
       @rem.uniq
       @r[k]
     end
-    
+
+    # get Reminder collection with arguments +a+.
     def get a 
       `remind #{a} rem/#{@id}.rem`.split("\n\n")
     end
-    
+
+    # Clear Reminder collection.
     def clear!
       @rem = []
     end
-    
+
+    # Reminder collection to string.
     def to_rem
       a = [];
       @rem.each { |e| a << @r[e].to_rem }
       return a.join("\n")
     end
     
+    # Write Reminder collection to file.
+    # +h[:append]+ append. (default: write)
     def to_rem! h={}
       if !Dir.exist? "rem"
         Dir.mkdir("rem")
@@ -39,18 +49,18 @@ module REM
     end
   end
   
-  
+  # The Reminder object.
   class R
-    
+    # high level event hash
     attr_accessor :attr
-    
+    # Reminder +k+
     def initialize k
       @id = k
       @attr = {}
     end
-    
+    # Reminder event id.
     def id; @id; end
-    
+    # Reminder event hash to reminder string.
     def to_rem
       puts %[R[#{@id}] #{@attr}]
       a, i = [], [ @id ]
@@ -72,9 +82,11 @@ module REM
   end
   
   @@REM = Hash.new { |h,k| h[k] = E.new(k) }
+  # Get Reminder collection +k+.
   def self.[] k
     @@REM[k]
   end
+  # All Reminder collections
   def self.keys
     @@REM.keys
   end

data/lib/remind/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Remind
-  VERSION = "0.1.7"
+  # version.
+  VERSION = "0.1.8"
 end

data/lib/remind.rb

@@ -16,27 +16,32 @@ require_relative "remind/calendar"
 
 require_relative "remind/event"
 
+# The Remind wrapper.
 module Remind
+  # generic errors
   class Error < StandardError; end
 
   @@REM = REM['reminders']
   
   @@INIT = []
-  def self.init h={}
+  # Add system event.
+  # +h+ event hash
+  #  Remind.reminder what: "Sports ball vs. the other team.", when: "15 March 2024 AT 19:00"
+  def self.reminder h={}
     @@INIT << h
   end
   
   @@URL = []
+  # Add system ics url.
+  # +u+ the ics url
+  #  Remind.url "https://your_domain.ics"
   def self.url u
     @@URL << u
   end
-  
-  @@SRC = []
-  def self.src k
-    @@SRC << k
-  end
-  
-  def self.rebuild!
+
+  # Set system reminders
+  #  Remind.build!
+  def self.build!
     @@REM.clear!
     
     [@@INIT].flatten.each do |x|
@@ -56,8 +61,11 @@ module Remind
     
     @@REM.to_rem!
   end  
-  
-  def self.remind k, *src
+
+  # Set collection +k+ reminders.
+  # +src+ one or more input string to be processed.
+  #  Remind.set("collection", "Dinner tonight at 8.", ...)
+  def self.set k, *src
     REM[k].clear!
     [src].flatten.each do |e|
       EVENT[e].each do |ee|
@@ -67,10 +75,16 @@ module Remind
     REM[k].to_rem! append: true
   end
 
+  # Get reminders container +k+                                                                                                                                                                                          
+  # +h[:args]+ can be set to get other filters.
+  #  Remind.get("collection")
   def self.get k, h={}
     REM[k].get(h[:args] || '-t1')[1..-1]
   end
-  
+  # Get system reminders
+  # Gets one week's agenda by default. 
+  # +h[:args]+ can be set to get other filters.
+  #  Remind.get!
   def self.get! h={}
     @@REM.get(h[:args] || '-t1')[1..-1]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnu-remind
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Erik Olson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-24 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday