gnu-remind 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1711c6c47b91c7a5544e2ac2fa110e62e693275c682d587f172c0916cb09ed22
4
+ data.tar.gz: 7d8a4ea0d5f3893da004d4a0bbb11a787a93b2a5c41518bb2830d53dc195344a
5
+ SHA512:
6
+ metadata.gz: 24fb829caeeaa46364d31a8982375534d2e32d541014e75b1c83cc344e169a591260ca074f9a528f234843be99edd2eae7596ba42f9683b9215e181476b1b05a
7
+ data.tar.gz: 46418d4e3e331be5be5c93b1daa0f759aa505ca24f69c054a92e3f4b6c7c71a908b69b1fa318766536471c709415341ee32bc68f0d4f9540bcdc46f5d68ce367
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2024-02-18
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 TODO: Write your name
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # Remind
2
+ GNU remind is a fantastic utility for managing schedules, tasks, events, and reminders.
3
+
4
+ ## Installation
5
+
6
+ ### Bundle
7
+ ```
8
+ bundle add remind
9
+ ```
10
+
11
+ ### Gem
12
+ ```
13
+ gem install remind
14
+ ```
15
+
16
+ ### Build
17
+ ```
18
+ gem build remind.gemspec
19
+ ```
20
+
21
+
22
+ ## Usage
23
+ ```
24
+ require 'remind'
25
+ ```
26
+ ### Remind
27
+ Use as a generic reminder handler.
28
+
29
+ #### set
30
+ Create local reminders from url.
31
+ ```
32
+ Remind['key'] = %[https://example.ics]
33
+ ```
34
+
35
+ #### get
36
+ Extract agenda from local reminders.
37
+ ```
38
+ Remind['key']
39
+ ```
40
+
41
+ #### all
42
+ ```
43
+ Remind.all
44
+ ```
45
+
46
+
47
+ ### REM
48
+ Use as a task specific tool
49
+
50
+ #### collection
51
+ ```
52
+ REM['collection']
53
+ ```
54
+
55
+ #### entry
56
+ ```
57
+ REM['collection']['entry']
58
+ ```
59
+
60
+ #### entry attributes
61
+ ```
62
+ 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" }
63
+ ```
64
+
65
+ #### entry reminder
66
+ ```
67
+ REM['collection'].to_rem
68
+ ```
69
+
70
+ #### save collection
71
+ ```
72
+ REM['collection'].to_rem!
73
+ ```
74
+
75
+ #### collection agenda
76
+ ```
77
+ REM['collection'].agenda
78
+ ```
79
+
80
+
81
+ ## Development
82
+ You can also run `ruby bin/console` for an interactive prompt that will allow you to experiment.
data/Rakefile ADDED
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ task default: %i[]
@@ -0,0 +1,45 @@
1
+
2
+ module CAL
3
+ class C
4
+ def initialize f
5
+ @f = f
6
+ end
7
+ def each &b
8
+ @f.events.each { |e| b.call(E.new(e)) }
9
+ return nil
10
+ end
11
+ def map &b
12
+ a = []
13
+ @f.events.each { |e| a << b.call(E.new(e)) }
14
+ return a
15
+ end
16
+ end
17
+
18
+ class E
19
+ def initialize f
20
+ @f = f
21
+ end
22
+ def where
23
+ @f.location
24
+ end
25
+ def who
26
+ @f.summary
27
+ end
28
+ def what
29
+ @f.description
30
+ end
31
+ def when
32
+ { begin: @f.dtstart, end: @f.dtend }
33
+ end
34
+ end
35
+
36
+ def self.from_file f
37
+ x = File.read(f)
38
+ C.new(Icalendar::Calendar.parse(x).first)
39
+ end
40
+
41
+ def self.from_url u
42
+ x = Faraday.new().get(u).body
43
+ C.new(Icalendar::Calendar.parse(x).first)
44
+ end
45
+ end
@@ -0,0 +1,88 @@
1
+
2
+ class E
3
+ def initialize k
4
+ @id = k
5
+ @rem = []
6
+ @r = Hash.new { |h,k| h[k] = R.new(k) }
7
+ end
8
+ def id; @id; end
9
+
10
+ def [] k
11
+ @rem << k
12
+ @r[k]
13
+ end
14
+
15
+ def agenda
16
+ `remind -t1 rem/#{@id}.rem`.split("\n\n")
17
+ end
18
+
19
+ def to_rem
20
+ a = [];
21
+ @rem.each { |e| a << @r[e].to_rem }
22
+ return a.join("\n")
23
+ end
24
+
25
+ def to_rem!
26
+ if !Dir.exist? "rem"
27
+ Dir.mkdir("rem")
28
+ end
29
+ File.open("rem/#{@id}.rem",'w') { |f| f.write(to_rem); }
30
+ end
31
+ end
32
+
33
+
34
+ class R
35
+
36
+ attr_accessor :attr
37
+
38
+ def initialize k
39
+ @id = k
40
+ @attr = {}
41
+ end
42
+
43
+ def id; @id; end
44
+
45
+ def to_rem
46
+ a, i = [], [ @id ]
47
+ if @attr.has_key? :type
48
+ i << %[#{@attr[:type]}]
49
+ end
50
+ if @attr.has_key? :date
51
+ a << %[#{@attr[:date]}]
52
+ if @attr.has_key? :lead
53
+ a << %[++#{@attr[:lead]}]
54
+ end
55
+ if @attr.has_key? :repeat
56
+ a << %[*#{@attr[:repeat]}]
57
+ end
58
+ if @attr.has_key? :until
59
+ a << %[UNTIL #{@attr[:until]}]
60
+ end
61
+ end
62
+ if @attr.has_key? :hour
63
+ if @attr.has_key? :minute
64
+ a << %[AT #{@attr[:hour]}:#{@attr[:minute]}]
65
+ else
66
+ a << %[AT #{@attr[:hour]}:00]
67
+ end
68
+ end
69
+ if @attr.has_key? :duration
70
+ i << %[for #{@attr[:duration]} hours]
71
+ end
72
+ if @attr.has_key? :at
73
+ i << %[at #{@attr[:at]}]
74
+ end
75
+ return %[REM #{a.join(" ")} MSG %b %2 #{i.join(" ")}]
76
+ end
77
+ end
78
+
79
+ module REM
80
+ @@REM = Hash.new { |h,k| h[k] = E.new(k) }
81
+ def self.[] k
82
+ @@REM[k]
83
+ end
84
+ def self.keys
85
+ @@REM.keys
86
+ end
87
+ end
88
+
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Remind
4
+ VERSION = "0.1.0"
5
+ end
data/lib/remind.rb ADDED
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'faraday'
4
+
5
+ require 'icalendar'
6
+
7
+ require_relative "remind/version"
8
+
9
+ require_relative "remind/remind"
10
+
11
+ require_relative "remind/calendar"
12
+
13
+ module Remind
14
+ class Error < StandardError; end
15
+ @@REM = REM['reminders']
16
+ def self.[]= x, u
17
+ r = REM[x]
18
+ CAL.from_url(u).each do |e|
19
+ h = {
20
+ date: e.when[:begin].to_time.localtime.strftime("%-d %b %Y"),
21
+ hour: e.when[:begin].to_time.localtime.strftime("%k"),
22
+ minute: e.when[:begin].to_time.localtime.strftime("%M"),
23
+ at: e.where,
24
+ type: e.who
25
+ }
26
+ r[e.what].attr = h
27
+ @@REM[e.what].attr = h
28
+ end
29
+ r.to_rem!
30
+ @@REM.to_rem!
31
+ return nil
32
+ end
33
+ def self.[] k
34
+ REM[k].agenda[1..-1]
35
+ end
36
+ def self.all
37
+ @@REM.agenda[1..-1]
38
+ end
39
+ end
data/remind.gemspec ADDED
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/remind/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "gnu-remind"
7
+ spec.version = Remind::VERSION
8
+ spec.authors = ["Erik Olson"]
9
+ spec.email = ["xorgnak@gmail.com"]
10
+
11
+ spec.summary = "gnu remind + ics files = ( :-) )"
12
+ spec.description = "A wrapper around gnu remind leveraging ics files via url or locally."
13
+ spec.homepage = "https://github.com/xorgnak/remind"
14
+ spec.license = "MIT"
15
+ spec.required_ruby_version = ">= 2.6.0"
16
+
17
+ spec.metadata["homepage_uri"] = spec.homepage
18
+ spec.metadata["source_code_uri"] = spec.homepage
19
+ spec.metadata["changelog_uri"] = spec.homepage
20
+
21
+ # Specify which files should be added to the gem when it is released.
22
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
+ spec.files = Dir.chdir(__dir__) do
24
+ `git ls-files -z`.split("\x0").reject do |f|
25
+ (File.expand_path(f) == __FILE__) ||
26
+ f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
27
+ end
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ # Uncomment to register a new dependency of your gem
34
+ spec.add_dependency "faraday"
35
+ spec.add_dependency "icalendar"
36
+ # For more information and examples about making a new gem, check out our
37
+ # guide at: https://bundler.io/guides/creating_gem.html
38
+ end
data/sig/remind.rbs ADDED
@@ -0,0 +1,4 @@
1
+ module Remind
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,85 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: gnu-remind
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Erik Olson
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-02-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: icalendar
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ description: A wrapper around gnu remind leveraging ics files via url or locally.
42
+ email:
43
+ - xorgnak@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - CHANGELOG.md
49
+ - CODE_OF_CONDUCT.md
50
+ - LICENSE.txt
51
+ - README.md
52
+ - Rakefile
53
+ - lib/remind.rb
54
+ - lib/remind/calendar.rb
55
+ - lib/remind/remind.rb
56
+ - lib/remind/version.rb
57
+ - remind.gemspec
58
+ - sig/remind.rbs
59
+ homepage: https://github.com/xorgnak/remind
60
+ licenses:
61
+ - MIT
62
+ metadata:
63
+ homepage_uri: https://github.com/xorgnak/remind
64
+ source_code_uri: https://github.com/xorgnak/remind
65
+ changelog_uri: https://github.com/xorgnak/remind
66
+ post_install_message:
67
+ rdoc_options: []
68
+ require_paths:
69
+ - lib
70
+ required_ruby_version: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: 2.6.0
75
+ required_rubygems_version: !ruby/object:Gem::Requirement
76
+ requirements:
77
+ - - ">="
78
+ - !ruby/object:Gem::Version
79
+ version: '0'
80
+ requirements: []
81
+ rubygems_version: 3.3.15
82
+ signing_key:
83
+ specification_version: 4
84
+ summary: gnu remind + ics files = ( :-) )
85
+ test_files: []