feat: linuxdo kit domain -- hot, latest, top

go.mod

@@ -20,6 +20,8 @@ require (
 	github.com/clipperhouse/displaywidth v0.4.1 // indirect
 	github.com/clipperhouse/stringish v0.1.1 // indirect
 	github.com/clipperhouse/uax29/v2 v2.3.0 // indirect
+	github.com/dustin/go-humanize v1.0.1 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.3.0 // indirect
 	github.com/mattn/go-runewidth v0.0.19 // indirect
@@ -28,10 +30,17 @@ require (
 	github.com/muesli/mango-cobra v1.2.0 // indirect
 	github.com/muesli/mango-pflag v0.1.0 // indirect
 	github.com/muesli/roff v0.1.0 // indirect
+	github.com/ncruces/go-strftime v1.0.0 // indirect
+	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/spf13/pflag v1.0.9 // indirect
+	github.com/tamnd/any-cli v0.4.0 // indirect
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
-	golang.org/x/sync v0.17.0 // indirect
-	golang.org/x/sys v0.37.0 // indirect
+	golang.org/x/sync v0.20.0 // indirect
+	golang.org/x/sys v0.42.0 // indirect
 	golang.org/x/text v0.24.0 // indirect
+	modernc.org/libc v1.72.3 // indirect
+	modernc.org/mathutil v1.7.1 // indirect
+	modernc.org/memory v1.11.0 // indirect
+	modernc.org/sqlite v1.52.0 // indirect
 )

go.sum

@@ -29,6 +29,10 @@ github.com/clipperhouse/uax29/v2 v2.3.0/go.mod h1:Wn1g7MK6OoeDT0vL+Q0SQLDz/KpfsV
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
+github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/lucasb-eyer/go-colorful v1.3.0 h1:2/yBRLdWBZKrf7gB40FoiKfAWYQ0lqNcbuQwVHXptag=
@@ -47,8 +51,12 @@ github.com/muesli/mango-pflag v0.1.0 h1:UADqbYgpUyRoBja3g6LUL+3LErjpsOwaC9ywvBWe
 github.com/muesli/mango-pflag v0.1.0/go.mod h1:YEQomTxaCUp8PrbhFh10UfbhbQrM/xJ4i2PB8VTLLW0=
 github.com/muesli/roff v0.1.0 h1:YD0lalCotmYuF5HhZliKWlIx7IEhiXeSfq7hNjFqGF8=
 github.com/muesli/roff v0.1.0/go.mod h1:pjAHQM9hdUUwm/krAfrLGgJkXJ+YuhtsfZ42kieB2Ig=
+github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w=
+github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
+github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
 github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
@@ -58,17 +66,31 @@ github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
 github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/tamnd/any-cli v0.4.0 h1:ngyRJBvjZ2X1iBlwlmDLvY2S9aQWlDjVE7CiOwxtt5Y=
+github.com/tamnd/any-cli v0.4.0/go.mod h1:lns3VfQVrC9hMy7YKBzIQoYpobnfSDIzJ8c27H2ILmk=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
 go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
 golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
 golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
+golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4=
+golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
 golang.org/x/sys v0.37.0 h1:fdNQudmxPjkdUTPnLn5mdQv7Zwvbvpaxqs831goi9kQ=
 golang.org/x/sys v0.37.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
+golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
 golang.org/x/text v0.24.0 h1:dd5Bzh4yt5KYA8f9CJHCP4FB4D51c2c6JvN37xJJkJ0=
 golang.org/x/text v0.24.0/go.mod h1:L8rBsPeo2pSS+xqN0d5u2ikmjtmoJbDBT1b7nHvFCdU=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+modernc.org/libc v1.72.3 h1:ZnDF4tXn4NBXFutMMQC4vtbTFSXhhKzR73fv0beZEAU=
+modernc.org/libc v1.72.3/go.mod h1:dn0dZNnnn1clLyvRxLxYExxiKRZIRENOfqQ8XEeg4Qs=
+modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU=
+modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg=
+modernc.org/memory v1.11.0 h1:o4QC8aMQzmcwCK3t3Ux/ZHmwFPzE6hf2Y5LbkRs+hbI=
+modernc.org/memory v1.11.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw=
+modernc.org/sqlite v1.52.0 h1:p4dhYh2tXZCiyaqHwRVJDjIGKWyXayiQpThxgDzJaxo=
+modernc.org/sqlite v1.52.0/go.mod h1:tcNzv5p84E0skkmJn038y+hWJbLQXQqEnQfeh5r2JLM=

linuxdo/domain.go

@@ -0,0 +1,146 @@
+package linuxdo
+
+import (
+	"context"
+
+	"github.com/tamnd/any-cli/kit"
+	"github.com/tamnd/any-cli/kit/errs"
+)
+
+func init() { kit.Register(Domain{}) }
+
+// Domain is the linux.do kit driver. It exposes hot, latest, and top topics
+// from the Discourse-based linux.do forum. No API key is required.
+type Domain struct{}
+
+// Info returns the scheme, hostnames, and identity for the linuxdo domain.
+func (Domain) Info() kit.DomainInfo {
+	return kit.DomainInfo{
+		Scheme: "linuxdo",
+		Hosts:  []string{Host},
+		Identity: kit.Identity{
+			Binary: "linuxdo",
+			Short:  "A command line for Linux.do.",
+			Long: `A command line for Linux.do.
+
+Fetches hot, latest, and top topics from the Linux.do Discourse community.
+No API key required.`,
+			Site: "https://" + Host,
+			Repo: "https://github.com/tamnd/linuxdo-cli",
+		},
+	}
+}
+
+// Register installs the client factory and the hot, latest, and top operations.
+func (Domain) Register(app *kit.App) {
+	app.SetClient(newClient)
+
+	kit.Handle(app, kit.OpMeta{
+		Name: "hot", Group: "topics", List: true,
+		URIType: "topic", Summary: "Hot topics on linux.do",
+	}, hotTopics)
+
+	kit.Handle(app, kit.OpMeta{
+		Name: "latest", Group: "topics", List: true,
+		URIType: "topic", Summary: "Latest topics on linux.do",
+	}, latestTopics)
+
+	kit.Handle(app, kit.OpMeta{
+		Name: "top", Group: "topics", List: true,
+		URIType: "topic", Summary: "Top topics by period (all, daily, weekly, monthly, quarterly, yearly)",
+		Args: []kit.Arg{{Name: "period", Help: "time period: all, daily, weekly, monthly, quarterly, yearly", Optional: true}},
+	}, topTopics)
+}
+
+// newClient builds a linuxdo.Client from the resolved kit.Config.
+func newClient(_ context.Context, cfg kit.Config) (any, error) {
+	dcfg := DefaultConfig()
+	if cfg.UserAgent != "" {
+		dcfg.UserAgent = cfg.UserAgent
+	}
+	if cfg.Rate > 0 {
+		dcfg.Rate = cfg.Rate
+	}
+	if cfg.Retries > 0 {
+		dcfg.Retries = cfg.Retries
+	}
+	if cfg.Timeout > 0 {
+		dcfg.Timeout = cfg.Timeout
+	}
+	return NewClient(dcfg), nil
+}
+
+// --- inputs ---
+
+type listIn struct {
+	Limit  int     `kit:"flag,inherit" help:"max results (0 = all)"`
+	Client *Client `kit:"inject"`
+}
+
+type topIn struct {
+	Period string  `kit:"arg" help:"time period: all, daily, weekly, monthly, quarterly, yearly"`
+	Limit  int     `kit:"flag,inherit" help:"max results (0 = all)"`
+	Client *Client `kit:"inject"`
+}
+
+// --- handlers ---
+
+func hotTopics(ctx context.Context, in listIn, emit func(*TopicRecord) error) error {
+	topics, err := in.Client.Topics(ctx, "/hot.json")
+	if err != nil {
+		return err
+	}
+	if in.Limit > 0 && len(topics) > in.Limit {
+		topics = topics[:in.Limit]
+	}
+	for i := range topics {
+		if err := emit(&topics[i]); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func latestTopics(ctx context.Context, in listIn, emit func(*TopicRecord) error) error {
+	topics, err := in.Client.Topics(ctx, "/latest.json")
+	if err != nil {
+		return err
+	}
+	if in.Limit > 0 && len(topics) > in.Limit {
+		topics = topics[:in.Limit]
+	}
+	for i := range topics {
+		if err := emit(&topics[i]); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+var validPeriods = map[string]bool{
+	"all": true, "daily": true, "weekly": true,
+	"monthly": true, "quarterly": true, "yearly": true,
+}
+
+func topTopics(ctx context.Context, in topIn, emit func(*TopicRecord) error) error {
+	period := in.Period
+	if period == "" {
+		period = "weekly"
+	}
+	if !validPeriods[period] {
+		return errs.Usage("invalid period %q: choose from all, daily, weekly, monthly, quarterly, yearly", period)
+	}
+	topics, err := in.Client.Topics(ctx, "/top/"+period+".json")
+	if err != nil {
+		return err
+	}
+	if in.Limit > 0 && len(topics) > in.Limit {
+		topics = topics[:in.Limit]
+	}
+	for i := range topics {
+		if err := emit(&topics[i]); err != nil {
+			return err
+		}
+	}
+	return nil
+}

linuxdo/domain_test.go

@@ -0,0 +1,53 @@
+package linuxdo_test
+
+import (
+	"testing"
+
+	"github.com/tamnd/any-cli/kit"
+	"github.com/tamnd/linuxdo-cli/linuxdo"
+)
+
+func TestDomainInfo(t *testing.T) {
+	d := linuxdo.Domain{}
+	info := d.Info()
+
+	if info.Scheme != "linuxdo" {
+		t.Errorf("scheme = %q, want linuxdo", info.Scheme)
+	}
+	if len(info.Hosts) == 0 || info.Hosts[0] != "linux.do" {
+		t.Errorf("hosts = %v, want [linux.do]", info.Hosts)
+	}
+	if info.Identity.Binary != "linuxdo" {
+		t.Errorf("binary = %q, want linuxdo", info.Identity.Binary)
+	}
+	if info.Identity.Short == "" {
+		t.Error("short description is empty")
+	}
+}
+
+func TestDomainRegistered(t *testing.T) {
+	found := false
+	for _, s := range kit.Domains() {
+		if s == "linuxdo" {
+			found = true
+			break
+		}
+	}
+	if !found {
+		t.Error("linuxdo domain not found in kit.Domains()")
+	}
+}
+
+func TestDomainLookup(t *testing.T) {
+	d, ok := kit.Lookup("linuxdo")
+	if !ok {
+		t.Fatal("kit.Lookup(linuxdo) returned false")
+	}
+	if d == nil {
+		t.Fatal("kit.Lookup(linuxdo) returned nil domain")
+	}
+	info := d.Info()
+	if info.Scheme != "linuxdo" {
+		t.Errorf("scheme = %q, want linuxdo", info.Scheme)
+	}
+}

linuxdo/linuxdo.go

@@ -16,6 +16,9 @@ import (
 	"time"
 )
 
+// Host is the hostname this client talks to.
+const Host = "linux.do"
+
 // DefaultUserAgent identifies the client to linux.do.
 const DefaultUserAgent = "linuxdo/dev (+https://github.com/tamnd/linuxdo-cli)"