handle RSS feed

README.md

@@ -1,101 +1,126 @@
 # Papeer
 
-Papeer is a tool that lets you scrape content from the internet. It can scrape any web page, keeping only relevant content (formatted text and images) and removing ads and menus. You can export the content to Markdown, EPUB or MOBI files.
+Papeer is a powerful **ereader internet vacuum**. It can scrape any website, removing ads and keeping only the relevant content (formatted text and images). You can export the content to Markdown, EPUB or MOBI files.
+
+# Table of contents
+
+- [Usage](#usage)
+  * [Scrape a web page](#scrape-a-web-page)
+  * [Scrape a whole website](#scrape-a-whole-website)
+    + [`depth` option](#-depth--option)
+    + [`selector` option](#-selector--option)
+    + [Display the table of contents](#display-the-table-of-contents)
+    + [Scrape time](#scrape-time)
+- [Installation](#installation)
+  * [From source](#from-source)
+  * [From binary](#from-binary)
+    + [Linux / MacOS](#linux---macos)
+    + [Windows](#windows)
+  * [MOBI support](#mobi-support)
+- [Autocompletion](#autocompletion)
+- [Dependencies](#dependencies)
 
 # Usage
 
+## Scrape a web page
+
+The `get` command lets you retrieve the content of any web page or RSS feed.
+
 ```
-Browse the web in the eink era
+Scrape URL content
 
 Usage:
-  papeer [flags]
+  papeer get URL [flags]
-  papeer [command]
 
-Available Commands:
+Examples:
-  completion  generate the autocompletion script for the specified shell
+papeer get https://www.eff.org/cyberspace-independence
-  get         Scrape URL content
-  help        Help about any command
-  ls          Print table of content
-  version     Print the version number of papeer
 
 Flags:
-  -a, --author string     book author
+  -a, --author string      book author
-  -d, --delay int         time to wait before downloading next chapter, in milliseconds (default -1)
+      --delay int          time in milliseconds to wait before downloading next chapter, use with depth/selector (default -1)
-  -f, --format string     file format [stdout, md, epub, mobi] (default "stdout")
+  -d, --depth int          scraping depth
-  -h, --help              help for papeer
+  -f, --format string      file format [stdout, md, epub, mobi] (default "md")
-      --images            retrieve images only
+  -h, --help               help for get
-  -i, --include           include URL as first chapter, in resursive mode
+      --images             retrieve images only
-  -l, --limit int         limit number of chapters, in recursive mode (default -1)
+  -i, --include            include URL as first chapter, use with depth/selector
-  -n, --name string       book name (default: page title)
+  -l, --limit int          limit number of chapters, use with depth/selector (default -1)
-  -o, --offset int        skip first chapters, in recursive mode
+  -n, --name string        book name (default: page title)
-      --output string     file name (default: book name)
+  -o, --offset int         skip first chapters, use with depth/selector
-  -q, --quiet             hide progress bar
+      --output string      file name (default: book name)
-  -r, --recursive         create one chapter per natigation item
+  -q, --quiet              hide progress bar
-  -s, --selector string   table of content CSS selector, in resursive mode
+  -r, --reverse            reverse chapter order
-  -t, --threads int       download concurrency, in recursive mode (default -1)
+  -s, --selector strings   table of contents CSS selector
-
+  -t, --threads int        download concurrency, use with depth/selector (default -1)
-Use "papeer [command] --help" for more information about a command.
+      --use-link-name      use link name for chapter title
 ```
 
-# Examples
+## Scrape a whole website
 
-## Grab a single page
+If a navigation menu is present on a website, you can scrape the content of each page.
 
-The `get` command lets you retrieve the content of a web page.
+You can activate this mode by using the `depth` or `selector` options.
+
+### `depth` option
+
+This option defaults to 0, `papeer` will grab only the main page.
+
+If you specify a value greater than 0, `papeer` will grab pages as deep as the value you specify.
+
+> Using `include` option will include all intermediary levels into the book.
+
+### `selector` option
+
+If this option is not specified, `papeer` will grab only the one page.
+
+If this option is specified, `papeer` will select the links (a HTML tag) present on the main page, then grab each one of them.
+
+You can chain this option to grab several level of pages with diferent selectors for each level.
+
+### Display the table of contents
+
+Before actually scraping a whole website, it is a good idea to use the `list` command. This command is like a **dry run**, which lets you vizualize the content before actually retrieving it. You can use several options to customize the table of contents extraction, such as `selector`, `limit`, `offset`, `reverse` and `include`. Type `papeer list --help` for more information about those options.
 
 ```sh
-papeer get https://www.eff.org/cyberspace-independence
+papeer list https://12factor.net/ -s 'section.concrete>article>h2>a'
-# A Declaration of the Independence of Cyberspace
-# ===============================================
-
-# Governments of the Industrial World, you weary giants of flesh and steel, I come from Cyberspace, the new home of Mind. On behalf of the future, I ask you of the past to leave us alone. You are not welcome among us. You have no sovereignty where we gather...
 ```
-
+```
-## Grab several pages (recursive mode)
+ #  NAME                    URL                                    
-
+ 1  I. Codebase             https://12factor.net/codebase          
-The `recursive` option lets you extract the table of content of a website, then scrape the content of each one of its pages.
+ 2  II. Dependencies        https://12factor.net/dependencies      
-
+ 3  III. Config             https://12factor.net/config            
-### Display table of content
+ 4  IV. Backing services    https://12factor.net/backing-services  
-
+ 5  V. Build, release, run  https://12factor.net/build-release-run 
-Before trying the `recursive` option, it is a good idea to use the `ls` option, which lets you vizualize the content that will be retrieved. You can use several options to customize the table of content extraction, such as `selector`, `limit`, `offset` and `include`. Type `papeer help` for more information about those options.
+ 6  VI. Processes           https://12factor.net/processes         
-
+ 7  VII. Port binding       https://12factor.net/port-binding      
-```sh
+ 8  VIII. Concurrency       https://12factor.net/concurrency       
-papeer ls https://12factor.net/ -s 'section.concrete > article > h2 > a'
+ 9  IX. Disposability       https://12factor.net/disposability     
-#  #  NAME                    URL                                    
+10  X. Dev/prod parity      https://12factor.net/dev-prod-parity   
-#  1  I. Codebase             https://12factor.net/codebase          
+11  XI. Logs                https://12factor.net/logs              
-#  2  II. Dependencies        https://12factor.net/dependencies      
+12  XII. Admin processes    https://12factor.net/admin-processes
-#  3  III. Config             https://12factor.net/config            
-#  4  IV. Backing services    https://12factor.net/backing-services  
-#  5  V. Build, release, run  https://12factor.net/build-release-run 
-#  6  VI. Processes           https://12factor.net/processes         
-#  7  VII. Port binding       https://12factor.net/port-binding      
-#  8  VIII. Concurrency       https://12factor.net/concurrency       
-#  9  IX. Disposability       https://12factor.net/disposability     
-# 10  X. Dev/prod parity      https://12factor.net/dev-prod-parity   
-# 11  XI. Logs                https://12factor.net/logs              
-# 12  XII. Admin processes    https://12factor.net/admin-processes
 ```
 
 ### Scrape time
 
-Once you are satisfied with the table of content listed by the `ls` command, you can actually scrape the content of those pages. You can use the same options that you specified for the `ls` command. In recursive mode, you also have the possibility to use `delay` and `threads` options.
+Once you are satisfied with the table of contents listed by the `ls` command, you can actually scrape the content of those pages. You can use the same options that you specified for the `ls` command. You can specify `delay` and `threads` options when using `selector` or `depth` options.
 
 ```sh
-papeer get https://12factor.net/ --recursive -s 'section.concrete > article > h2 > a' --format=md
+papeer get https://12factor.net/ --selector='section.concrete>article>h2>a'
-# [======================================>-----------------------------] Chapters 7 / 12
+```
-# [====================================================================] 1. I. Codebase
+```
-# [====================================================================] 2. II. Dependencies
+[======================================>-----------------------------] Chapters 7 / 12
-# [====================================================================] 3. III. Config
+[====================================================================] 1. I. Codebase
-# [====================================================================] 4. IV. Backing services
+[====================================================================] 2. II. Dependencies
-# [====================================================================] 5. V. Build, release, run
+[====================================================================] 3. III. Config
-# [====================================================================] 6. VI. Processes
+[====================================================================] 4. IV. Backing services
-# [====================================================================] 7. VII. Port binding
+[====================================================================] 5. V. Build, release, run
-# [--------------------------------------------------------------------] 8. VIII. Concurrency
+[====================================================================] 6. VI. Processes
-# [--------------------------------------------------------------------] 9. IX. Disposability
+[====================================================================] 7. VII. Port binding
-# [--------------------------------------------------------------------] 10. X. Dev/prod parity
+[--------------------------------------------------------------------] 8. VIII. Concurrency
-# [--------------------------------------------------------------------] 11. XI. Logs
+[--------------------------------------------------------------------] 9. IX. Disposability
-# [--------------------------------------------------------------------] 12. XII. Admin processes
+[--------------------------------------------------------------------] 10. X. Dev/prod parity
-# Markdown saved to "The_Twelve-Factor_App.md"
+[--------------------------------------------------------------------] 11. XI. Logs
+[--------------------------------------------------------------------] 12. XII. Admin processes
+Markdown saved to "The_Twelve-Factor_App.md"
 ```
 
 # Installation
@@ -108,21 +133,29 @@ go get -u github.com/lapwat/papeer
 
 ## From binary
 
-### On Linux / MacOS
+### Linux / MacOS
 
 ```sh
-platform=linux # use platform=darwin for MacOS
+# use platform=darwin for MacOS
-release=0.3.3
+platform=linux
-curl -L https://github.com/lapwat/papeer/releases/download/v$release/papeer-v$release-$platform-amd64 > papeer
+release=0.5.0
-chmod +x papeer
+
+# download and extract
+curl -L https://github.com/lapwat/papeer/releases/download/v$release/papeer-v$release-$platform-amd64.tar.gz > papeer.tar.gz
+tar xzvf papeer.tar.gz
+rm papeer.tar.gz
+
+# move to user binaries
 sudo mv papeer /usr/local/bin
 ```
 
-### On Windows
+### Windows
 
-Download [latest release](https://github.com/lapwat/papeer/releases/download/3/papeer-v0.3.3-windows-amd64.exe).
+Download [latest release](https://github.com/lapwat/papeer/releases/download/v0.5.0/papeer-v0.5.0-windows-amd64.exe.zip).
 
-## Install kindlegen to export websites to MOBI (optional)
+## MOBI support
+
+Install kindlegen to convert websites, Linux only
 
 ```sh
 TMPDIR=$(mktemp -d -t papeer-XXXXX)
@@ -141,10 +174,10 @@ Execute this command in your current shell, or add it to your `.bashrc`.
 . <(papeer completion bash)
 ```
 
-Type `papeer completion bash -h` for more information.
-
 You can replace `bash` by your own shell (zsh, fish or powershell).
 
+Type `papeer completion bash -h` for more information.
+
 # Dependencies
 
 - `cobra` command line interface

book/format.go

@@ -21,10 +21,10 @@ func Filename(name string) string {
 	return filename
 }
 
-func ToMarkdown(c chapter) string {
+func ToMarkdownString(c chapter) string {
 	markdown := ""
 
-	if c.config.include {
+	if c.config.Include {
 		// title
 		markdown += fmt.Sprintf("%s\n", c.Name())
 		markdown += fmt.Sprintf("%s\n\n", strings.Repeat("=", len(c.Name())))
@@ -39,12 +39,33 @@ func ToMarkdown(c chapter) string {
 
 	for _, sc := range c.SubChapters() {
 		// subchapters content
-		markdown += fmt.Sprintf("%s\n\n\n", ToMarkdown(sc))
+		markdown += fmt.Sprintf("%s\n\n\n", ToMarkdownString(sc))
 	}
 
 	return markdown
 }
 
+func ToMarkdown(c chapter, filename string) string {
+	if len(filename) == 0 {
+		filename = fmt.Sprintf("%s.md", Filename(c.Name()))
+	}
+
+	markdown := ToMarkdownString(c)
+
+	// write to file
+	f, err := os.Create(filename)
+	if err != nil {
+		log.Fatal(err)
+	}
+	_, err2 := f.WriteString(markdown)
+	if err2 != nil {
+		log.Fatal(err2)
+	}
+	f.Close()
+
+	return filename
+}
+
 func ToEpub(c chapter, filename string) string {
 	if len(filename) == 0 {
 		filename = fmt.Sprintf("%s.epub", Filename(c.Name()))
@@ -67,9 +88,9 @@ func ToEpub(c chapter, filename string) string {
 func AppendToEpub(e *epub.Epub, c chapter) {
 	content := ""
 
-	if c.config.include {
+	if c.config.Include {
 
-		if c.config.imagesOnly == false {
+		if c.config.ImagesOnly == false {
 			content = c.Content()
 		}
 
@@ -85,7 +106,7 @@ func AppendToEpub(e *epub.Epub, c chapter) {
 			src = strings.Split(src, "?")[0] // remove query part
 			imagePath, _ := e.AddImage(src, "")
 
-			if c.config.imagesOnly {
+			if c.config.ImagesOnly {
 				imageTag, _ := goquery.OuterHtml(s)
 				content += strings.Replace(imageTag, src, imagePath, 1)
 			} else {
@@ -94,8 +115,8 @@ func AppendToEpub(e *epub.Epub, c chapter) {
 		})
 
 		html := ""
-		// add title only if imagesOnly = false
+		// add title only if ImagesOnly = false
-		if c.config.imagesOnly == false {
+		if c.config.ImagesOnly == false {
 			html += fmt.Sprintf("<h1>%s</h1>", c.Name())
 		}
 		html += content

book/format_test.go

@@ -17,11 +17,11 @@ func TestFilename(t *testing.T) {
 
 }
 
-func TestToMarkdown(t *testing.T) {
+func TestToMarkdownString(t *testing.T) {
 
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
 
-	got := ToMarkdown(c)
+	got := ToMarkdownString(c)
 	want := "Books\n=====\n\n- [Discours de la Méthode](https://books.lapw.at/posts/ren%C3%A9-descartes-discours-de-la-m%C3%A9thode/)clock 98 min read -\n1637\n\n- [The Twelve-Factor App](https://books.lapw.at/posts/adam-wiggins-the-twelve-factor-app/)clock 22 min read -\n2011\n\n\n"
 
 	if got != want {
@@ -30,12 +30,44 @@ func TestToMarkdown(t *testing.T) {
 
 }
 
+func TestToMarkdown(t *testing.T) {
+
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	ToMarkdown(c, "")
+
+	filename := "Books.md"
+	if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
+		t.Errorf("%s does not exist: %v", filename, err)
+	} else {
+		if err := os.Remove(filename); err != nil {
+			t.Errorf("cannot remove %v: %v", filename, err)
+		}
+	}
+
+}
+
+func TestToMarkdownFilename(t *testing.T) {
+
+	filename := "ebook.md"
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	ToMarkdown(c, filename)
+
+	if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
+		t.Errorf("%s does not exist: %v", filename, err)
+	} else {
+		if err := os.Remove(filename); err != nil {
+			t.Errorf("cannot remove %v: %v", filename, err)
+		}
+	}
+
+}
+
 func TestToEpub(t *testing.T) {
 
-	filename := "Books.epub"
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
 	ToEpub(c, "")
 
+	filename := "Books.epub"
 	if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
 		t.Errorf("%s does not exist: %v", filename, err)
 	} else {
@@ -49,7 +81,7 @@ func TestToEpub(t *testing.T) {
 func TestToEpubFilename(t *testing.T) {
 
 	filename := "ebook.epub"
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
 	ToEpub(c, filename)
 
 	if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
@@ -65,7 +97,23 @@ func TestToEpubFilename(t *testing.T) {
 func TestToMobi(t *testing.T) {
 
 	filename := "ebook.mobi"
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	ToMobi(c, filename)
+
+	if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
+		t.Errorf("%s does not exist: %v", filename, err)
+	} else {
+		if err := os.Remove(filename); err != nil {
+			t.Errorf("cannot remove %v: %v", filename, err)
+		}
+	}
+
+}
+
+func TestToMobiFilename(t *testing.T) {
+
+	filename := "ebook.mobi"
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
 	ToMobi(c, filename)
 
 	if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {

book/scraper.go

@@ -15,86 +15,105 @@ import (
 	"github.com/PuerkitoBio/goquery"
 	readability "github.com/go-shiori/go-readability"
 	colly "github.com/gocolly/colly/v2"
+	"github.com/mmcdole/gofeed"
 )
 
 type ScrapeConfig struct {
-	depth      int
+	Depth       int
-	selector   string
+	Selector    string
-	limit      int
+	Quiet       bool
-	offset     int
+	Limit       int
-	delay      int
+	Offset      int
-	threads    int
+	Reverse     bool
-	include    bool
+	Delay       int
-	imagesOnly bool
+	Threads     int
+	Include     bool
+	ImagesOnly  bool
+	UseLinkName bool
 }
 
 func NewScrapeConfig() *ScrapeConfig {
-	return &ScrapeConfig{0, "", -1, 0, -1, -1, true, false}
+	return &ScrapeConfig{0, "", false, -1, 0, false, -1, -1, true, false, false}
+}
+
+func NewScrapeConfigs(selectors []string) []*ScrapeConfig {
+	configs := []*ScrapeConfig{}
+
+	for _, s := range selectors {
+		config := NewScrapeConfig()
+		config.Selector = s
+
+		configs = append(configs, config)
+	}
+
+	return configs
 }
 
 func NewScrapeConfigsAjin() []*ScrapeConfig {
 	config0 := NewScrapeConfig()
-	config0.depth = 0
+	config0.Depth = 0
-	config0.selector = ".dt>a"
+	config0.Selector = ".dt>a"
-	config0.limit = 3
+	config0.Limit = 3
-	config0.offset = 0
+	config0.Offset = 0
-	config0.delay = 5000
+	config0.Delay = 5000
-	config0.include = false
+	config0.Include = false
 
 	config1 := NewScrapeConfig()
-	config1.depth = 1
+	config1.Depth = 1
-	config1.selector = ".nav_apb>a"
+	config1.Selector = ".nav_apb>a"
-	config1.limit = 3
+	config1.Limit = 3
-	config1.offset = 1
+	config1.Offset = 1
-	config1.delay = 5000
+	config1.Delay = 5000
-	config1.include = false
+	config1.Include = false
 
 	config2 := NewScrapeConfig()
-	config2.depth = 2
+	config2.Depth = 2
-	config2.imagesOnly = true
+	config2.ImagesOnly = true
 
 	return []*ScrapeConfig{config0, config1, config2}
 }
 
 func NewScrapeConfigsWikipedia() []*ScrapeConfig {
 	config0 := NewScrapeConfig()
-	config0.depth = 0
+	config0.Depth = 0
-	config0.threads = -1
+	config0.Threads = -1
-	config0.include = true
+	config0.Include = true
 
 	config1 := NewScrapeConfig()
-	config1.depth = 1
+	config1.Depth = 1
-	config1.include = true
+	config1.Include = true
 
 	return []*ScrapeConfig{config0, config1}
 }
 
 func NewScrapeConfigFake() *ScrapeConfig {
 	config := NewScrapeConfig()
-	config.include = false
+	config.Include = false
 
 	return config
 }
 
-func NewBookFromURL(url, selector, name, author string, recursive, include, imagesOnly, quiet bool, limit, offset, delay, threads int) book {
+func NewBookFromURL(url string, selector []string, name, author string, include, ImagesOnly, useLinkName, quiet bool, limit, offset, delay, threads int) book {
 	config1 := NewScrapeConfig()
-	config1.imagesOnly = imagesOnly
+	config1.ImagesOnly = ImagesOnly
+	config1.UseLinkName = useLinkName
 
 	var chapters []chapter
 	var home chapter
 
-	if recursive {
+	if len(selector) > 0 {
 		config2 := NewScrapeConfig()
-		config2.selector = selector
+		config2.Selector = selector[0]
-		config2.limit = limit
+		config2.Limit = limit
-		config2.offset = offset
+		config2.Offset = offset
-		config2.delay = delay
+		config2.Delay = delay
-		config2.threads = threads
+		config2.Threads = threads
-		config2.include = include
+		config2.Include = include
-		config2.imagesOnly = imagesOnly
+		config2.ImagesOnly = ImagesOnly
+		config2.UseLinkName = useLinkName
 		chapters, home = tableOfContent(url, config2, config1, quiet)
 	} else {
-		chapters = []chapter{NewChapterFromURL(url, []*ScrapeConfig{config1}, 0, func(index int, name string) {})}
+		chapters = []chapter{NewChapterFromURL(url, "", []*ScrapeConfig{config1}, 0, func(index int, name string) {})}
 		home = chapters[0]
 	}
 
@@ -114,7 +133,7 @@ func NewBookFromURL(url, selector, name, author string, recursive, include, imag
 	return b
 }
 
-func NewChapterFromURL(url string, configs []*ScrapeConfig, index int, updateProgressBarName func(index int, name string)) chapter {
+func NewChapterFromURL(url, linkName string, configs []*ScrapeConfig, index int, updateProgressBarName func(index int, name string)) chapter {
 	config := configs[0]
 
 	base, err := urllib.Parse(url)
@@ -141,24 +160,34 @@ func NewChapterFromURL(url string, configs []*ScrapeConfig, index int, updatePro
 	if err != nil {
 		log.Fatalf("failed to parse %s, %v\n", url, err)
 	}
-	name := article.Title
 
-	// notify progress bar with new name
+	name := linkName
-	updateProgressBarName(index, name)
+	if config.UseLinkName == false {
+		name = article.Title
 
-	subchapters := []chapter{}
+		// notify progressbar with new name
+		updateProgressBarName(index, name)
+	}
+
+	var subchapters []chapter
 	if len(configs) > 1 {
-		// add subchapters
 
-		links, _, err := GetLinks(base, config.selector, config.limit, config.offset, false)
+		// retrieve links on page
+		links, _, _, err := GetLinks(base, config.Selector, config.Limit, config.Offset, config.Reverse, false)
 		if err != nil {
 			log.Fatal(err)
 		}
 
-		subchapters = make([]chapter, len(links))
+		// init progess bar
-		progress := NewProgress(links, name, config.depth)
+		var p progress
+		if config.Quiet == false {
+			p = NewProgress(links, name, config.Depth)
+		}
 
-		if config.delay >= 0 {
+		// init chapters list
+		subchapters = make([]chapter, len(links))
+
+		if config.Delay >= 0 {
 
 			// synchronous mode
 			for index, link := range links {
@@ -168,18 +197,20 @@ func NewChapterFromURL(url string, configs []*ScrapeConfig, index int, updatePro
 					log.Fatal(err)
 				}
 
-				sc := NewChapterFromURL(u.String(), configs[1:], index, progress.UpdateName)
+				sc := NewChapterFromURL(u.String(), link.text, configs[1:], index, p.UpdateName)
 				subchapters[index] = sc
-				progress.Increment(index)
+				if config.Quiet == false {
+					p.Increment(index)
+				}
 
-				time.Sleep(time.Duration(config.delay) * time.Millisecond)
+				time.Sleep(time.Duration(config.Delay) * time.Millisecond)
 			}
 
 		} else {
 			// asynchronous mode
 			var wg sync.WaitGroup
 
-			threads := config.threads
+			threads := config.Threads
 			if threads == -1 {
 				threads = len(links)
 			}
@@ -199,9 +230,12 @@ func NewChapterFromURL(url string, configs []*ScrapeConfig, index int, updatePro
 						log.Fatal(err)
 					}
 
-					sc := NewChapterFromURL(u.String(), configs[1:], index, progress.UpdateName)
+					sc := NewChapterFromURL(u.String(), l.text, configs[1:], index, p.UpdateName)
 					subchapters[index] = sc
-					progress.Increment(index)
+
+					if config.Quiet == false {
+						p.Increment(index)
+					}
 
 					<-semaphore
 				}(index, l)
@@ -211,13 +245,15 @@ func NewChapterFromURL(url string, configs []*ScrapeConfig, index int, updatePro
 	}
 
 	content := ""
-	if config.include {
+	if config.Include {
 
-		// we care about the content only if we include this level
+		// we care about the content only if:
+		// - we include this level
+		// - we use the page name
 		content = article.Content
 
 		// extract images
-		if config.imagesOnly {
+		if config.ImagesOnly {
 
 			// parse HTML
 			doc, err := goquery.NewDocumentFromReader(strings.NewReader(content))
@@ -246,13 +282,13 @@ func tableOfContent(url string, config *ScrapeConfig, subConfig *ScrapeConfig, q
 		log.Fatal(err)
 	}
 
-	links, home, err := GetLinks(base, config.selector, config.limit, config.offset, config.include)
+	links, _, home, err := GetLinks(base, config.Selector, config.Limit, config.Offset, config.Reverse, config.Include)
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	chapters := make([]chapter, len(links))
-	delay := config.delay
+	delay := config.Delay
 
 	var p progress
 	if quiet == false {
@@ -262,14 +298,14 @@ func tableOfContent(url string, config *ScrapeConfig, subConfig *ScrapeConfig, q
 	if delay >= 0 {
 		// synchronous mode
 
-		for index, link := range links {
+		for index, l := range links {
 			// and then use it to parse relative URLs
-			u, err := base.Parse(link.href)
+			u, err := base.Parse(l.href)
 			if err != nil {
 				log.Fatal(err)
 			}
 
-			chapters[index] = NewChapterFromURL(u.String(), []*ScrapeConfig{subConfig}, 0, func(index int, name string) {})
+			chapters[index] = NewChapterFromURL(u.String(), l.text, []*ScrapeConfig{subConfig}, 0, func(index int, name string) {})
 
 			if quiet == false {
 				p.Increment(index)
@@ -287,7 +323,7 @@ func tableOfContent(url string, config *ScrapeConfig, subConfig *ScrapeConfig, q
 		// asynchronous mode
 		var wg sync.WaitGroup
 
-		threads := config.threads
+		threads := config.Threads
 		if threads == -1 {
 			threads = len(links)
 		}
@@ -307,7 +343,7 @@ func tableOfContent(url string, config *ScrapeConfig, subConfig *ScrapeConfig, q
 					log.Fatal(err)
 				}
 
-				chapters[index] = NewChapterFromURL(u.String(), []*ScrapeConfig{subConfig}, 0, func(index int, name string) {})
+				chapters[index] = NewChapterFromURL(u.String(), l.text, []*ScrapeConfig{subConfig}, 0, func(index int, name string) {})
 
 				if quiet == false {
 					p.Increment(index)
@@ -327,7 +363,7 @@ func GetPath(elm *goquery.Selection) string {
 
 	for {
 		selector := strings.ToLower(goquery.NodeName(elm))
-		if selector == "" {
+		if len(selector) == 0 {
 			break
 		}
 
@@ -339,45 +375,78 @@ func GetPath(elm *goquery.Selection) string {
 	return join
 }
 
-func GetLinks(url *urllib.URL, selector string, limit, offset int, include bool) ([]link, chapter, error) {
+func GetLinks(url *urllib.URL, selector string, limit, offset int, reverse, include bool) ([]link, string, chapter, error) {
-	selectorSet := true
+	var links []link
-	if selector == "" {
+	var pathMax string
-		selector = "a"
+
-		selectorSet = false
+	parser := gofeed.NewParser()
+	feed, err := parser.ParseURL(url.String())
+
+	if err == nil {
+		// RSS feed
+
+		for _, item := range feed.Items {
+			links = append(links, NewLink(item.Link, item.Title))
+		}
+
+		pathMax = "RSS"
+	} else {
+		// HTML website
+
+		selectorSet := true
+		if len(selector) == 0 {
+			selector = "a"
+			selectorSet = false
+		}
+	
+		pathLinks := map[string][]link{}
+		pathCount := map[string]int{}
+		pathMax = ""
+	
+		// visit and count link classes
+		c := colly.NewCollector()
+		c.OnHTML(selector, func(e *colly.HTMLElement) {
+			href := e.Attr("href")
+			text := strings.TrimSpace(e.Text)
+			path := GetPath(e.DOM)
+			key := path
+	
+			if selectorSet {
+	
+				// if selector is set, we use the selector specified by the user
+	
+				key = selector
+				pathLinks[key] = append(pathLinks[key], NewLink(href, text))
+				pathCount[key] += 1
+				pathMax = key
+	
+			} else {
+	
+				// if selector is not set, we compute the selector ourselves
+	
+				class := e.Attr("class")
+				// include the element class to make sure we have the same exact path for every link in the table of content
+				key = fmt.Sprintf("%s.%s", path, class)
+	
+				// we count this key if the link text is not empty
+				if text != "" {
+					pathLinks[key] = append(pathLinks[key], NewLink(href, text))
+					pathCount[key] += len(text)
+	
+					if pathCount[key] > pathCount[pathMax] {
+						pathMax = key
+					}
+				}
+	
+			}
+		})
+		c.Visit(url.String())
+
+		links = pathLinks[pathMax]
 	}
 
-	// visit and count link classes
-	pathLinks := map[string][]link{}
-	pathCount := map[string]int{}
-	pathMax := ""
-
-	c := colly.NewCollector()
-	c.OnHTML(selector, func(e *colly.HTMLElement) {
-		href := e.Attr("href")
-		text := strings.TrimSpace(e.Text)
-		path := GetPath(e.DOM)
-		key := path
-
-		// include element class in key if selector is set
-		if !selectorSet {
-			class := e.Attr("class")
-			key = fmt.Sprintf("%s.%s", path, class)
-		}
-
-		if selectorSet || text != "" {
-			pathLinks[key] = append(pathLinks[key], NewLink(href, text))
-			pathCount[key] += len(text)
-
-			if pathCount[key] > pathCount[pathMax] {
-				pathMax = key
-			}
-		}
-	})
-	c.Visit(url.String())
-
-	links := pathLinks[pathMax]
 	if len(links) == 0 {
-		return []link{}, chapter{}, fmt.Errorf("no link found for selector: %s", selector)
+		return []link{}, pathMax, chapter{}, fmt.Errorf("no link found for selector: %s", selector)
 	}
 
 	end := len(links)
@@ -387,12 +456,20 @@ func GetLinks(url *urllib.URL, selector string, limit, offset int, include bool)
 
 	links = links[offset:end]
 
-	home := NewChapterFromURL(url.String(), []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
+	home := NewChapterFromURL(url.String(), "", []*ScrapeConfig{NewScrapeConfig()}, 0, func(index int, name string) {})
 
+	// include home page
 	if include {
 		l := NewLink(url.String(), home.Name())
 		links = append([]link{l}, links...)
 	}
 
-	return links, home, nil
+	// reverse links
+	if reverse {
+		for i, j := 0, len(links)-1; i < j; i, j = i+1, j-1 {
+			links[i], links[j] = links[j], links[i]
+		}
+	}
+
+	return links, pathMax, home, nil
 }

book/scraper_test.go

@@ -8,7 +8,7 @@ import (
 func TestBody(t *testing.T) {
 
 	config := NewScrapeConfig()
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config}, 0, func(index int, name string) {})
 
 	got := c.Body()
 	want := "<!doctype html>\n<html lang=\"en-us\">\n  <head>\n    <title>Books</title>\n    <link rel=\"shortcut icon\" href=\"/favicon.ico\" />\n    <meta charset=\"utf-8\" />\n    <meta name=\"generator\" content=\"Hugo 0.59.1\" />\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n    <meta name=\"author\" content=\"John Doe\" />\n    <meta name=\"description\" content=\" \" />\n    <link rel=\"stylesheet\" href=\"https://books.lapw.at/css/main.min.88e7083eff65effb7485b6e6f38d10afbec25093a6fac42d734ce9024d3defbd.css\" />\n\n    \n    <meta name=\"twitter:card\" content=\"summary\"/>\n<meta name=\"twitter:title\" content=\"Books\"/>\n<meta name=\"twitter:description\" content=\" \"/>\n\n    <meta property=\"og:title\" content=\"Books\" />\n<meta property=\"og:description\" content=\" \" />\n<meta property=\"og:type\" content=\"website\" />\n<meta property=\"og:url\" content=\"https://books.lapw.at/\" />\n\n\n\n  </head>\n  <body>\n    <header class=\"app-header\">\n      <a href=\"https://books.lapw.at/\"><img class=\"app-header-avatar\" src=\"/book.svg\" alt=\"John Doe\" /></a>\n      <h1>Books</h1>\n      <p> </p>\n      <div class=\"app-header-social\">\n        \n      </div>\n    </header>\n    <main class=\"app-container\">\n      \n  <article>\n    <h1>Books</h1>\n    <ul class=\"posts-list\">\n      \n        <li class=\"posts-list-item\">\n          <a class=\"posts-list-item-title\" href=\"https://books.lapw.at/posts/ren%C3%A9-descartes-discours-de-la-m%C3%A9thode/\">Discours de la Méthode</a>\n          <span class=\"posts-list-item-description\">\n            <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"icon icon-clock\">\n  <title>clock</title>\n  <circle cx=\"12\" cy=\"12\" r=\"10\"></circle><polyline points=\"12 6 12 12 16 14\"></polyline>\n</svg> 98 min read -\n            1637\n          </span>\n        </li>\n      \n        <li class=\"posts-list-item\">\n          <a class=\"posts-list-item-title\" href=\"https://books.lapw.at/posts/adam-wiggins-the-twelve-factor-app/\">The Twelve-Factor App</a>\n          <span class=\"posts-list-item-description\">\n            <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"icon icon-clock\">\n  <title>clock</title>\n  <circle cx=\"12\" cy=\"12\" r=\"10\"></circle><polyline points=\"12 6 12 12 16 14\"></polyline>\n</svg> 22 min read -\n            2011\n          </span>\n        </li>\n      \n    </ul>\n    \n\n\n\n  </article>\n\n    </main>\n  </body>\n</html>\n"
@@ -22,7 +22,7 @@ func TestBody(t *testing.T) {
 func TestName(t *testing.T) {
 
 	config := NewScrapeConfig()
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config}, 0, func(index int, name string) {})
 
 	got := c.Name()
 	want := "Books"
@@ -33,10 +33,25 @@ func TestName(t *testing.T) {
 
 }
 
+func TestCustomName(t *testing.T) {
+
+	config := NewScrapeConfig()
+	config.UseLinkName = true
+	c := NewChapterFromURL("https://books.lapw.at/", "Custom Name", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+
+	got := c.Name()
+	want := "Custom Name"
+
+	if got != want {
+		t.Errorf("got %v, wanted %v", got, want)
+	}
+
+}
+
 func TestAuthor(t *testing.T) {
 
 	config := NewScrapeConfig()
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config}, 0, func(index int, name string) {})
 
 	got := c.Author()
 	want := "John Doe"
@@ -50,7 +65,7 @@ func TestAuthor(t *testing.T) {
 func TestContent(t *testing.T) {
 
 	config := NewScrapeConfig()
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config}, 0, func(index int, name string) {})
 
 	got := c.Content()
 	want := "<div id=\"readability-page-1\" class=\"page\">\n    \n    <main>\n      \n  <article>\n    \n    <ul>\n      \n        <li>\n          <a href=\"https://books.lapw.at/posts/ren%C3%A9-descartes-discours-de-la-m%C3%A9thode/\">Discours de la Méthode</a>\n          <span>\n            <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\">\n  <title>clock</title>\n  <circle cx=\"12\" cy=\"12\" r=\"10\"></circle><polyline points=\"12 6 12 12 16 14\"></polyline>\n</svg> 98 min read -\n            1637\n          </span>\n        </li>\n      \n        <li>\n          <a href=\"https://books.lapw.at/posts/adam-wiggins-the-twelve-factor-app/\">The Twelve-Factor App</a>\n          <span>\n            <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\">\n  <title>clock</title>\n  <circle cx=\"12\" cy=\"12\" r=\"10\"></circle><polyline points=\"12 6 12 12 16 14\"></polyline>\n</svg> 22 min read -\n            2011\n          </span>\n        </li>\n      \n    </ul>\n    \n\n\n\n  </article>\n\n    </main>\n  \n\n</div>"
@@ -64,12 +79,12 @@ func TestContent(t *testing.T) {
 func TestDelay(t *testing.T) {
 
 	config0 := NewScrapeConfig()
-	config0.delay = 500
+	config0.Delay = 500
 
 	config1 := NewScrapeConfig()
 
 	start := time.Now()
-	NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+	NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
 	elapsed := time.Since(start)
 
 	got := elapsed
@@ -84,9 +99,9 @@ func TestDelay(t *testing.T) {
 func TestContentImagesOnly(t *testing.T) {
 
 	config := NewScrapeConfig()
-	config.imagesOnly = true
+	config.ImagesOnly = true
 
-	c := NewChapterFromURL("https://books.lapw.at/posts/adam-wiggins-the-twelve-factor-app/", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/posts/adam-wiggins-the-twelve-factor-app/", "", []*ScrapeConfig{config}, 0, func(index int, name string) {})
 
 	got := c.Content()
 	want := "<img src=\"https://books.lapw.at/images/codebase-deploys.png\" alt=\"One codebase maps to many deploys\"/><img src=\"https://books.lapw.at/images/attached-resources.png\" alt=\"A production deploy attached to four backing services.\"/><img src=\"https://books.lapw.at/images/release.png\" alt=\"Code becomes a build, which is combined with config to create a release.\"/><img src=\"https://books.lapw.at/images/process-types.png\" alt=\"Scale is expressed as running processes, workload diversity is expressed as process types.\"/>"
@@ -102,7 +117,7 @@ func TestSubChapters(t *testing.T) {
 	config0 := NewScrapeConfig()
 	config1 := NewScrapeConfig()
 
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
 
 	got := len(c.SubChapters())
 	want := 2
@@ -113,14 +128,30 @@ func TestSubChapters(t *testing.T) {
 
 }
 
+func TestSubChaptersRSS(t *testing.T) {
+
+	config0 := NewScrapeConfig()
+	config1 := NewScrapeConfig()
+
+	c := NewChapterFromURL("https://blog.lapw.at/rss", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+
+	got := len(c.SubChapters())
+	want := 8
+
+	if got != want {
+		t.Errorf("got %v, wanted %v", got, want)
+	}
+
+}
+
 func TestSubChaptersSelector(t *testing.T) {
 
 	config0 := NewScrapeConfig()
-	config0.selector = "section.concrete > article > h2 > a"
+	config0.Selector = "section.concrete > article > h2 > a"
 
 	config1 := NewScrapeConfig()
 
-	c := NewChapterFromURL("https://12factor.net/", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://12factor.net/", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
 
 	got := len(c.SubChapters())
 	want := 12
@@ -134,11 +165,11 @@ func TestSubChaptersSelector(t *testing.T) {
 func TestSubChaptersLimit(t *testing.T) {
 
 	config0 := NewScrapeConfig()
-	config0.limit = 1
+	config0.Limit = 1
 
 	config1 := NewScrapeConfig()
 
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
 
 	got := len(c.SubChapters())
 	want := 1
@@ -152,11 +183,11 @@ func TestSubChaptersLimit(t *testing.T) {
 func TestSubChaptersLimitOver(t *testing.T) {
 
 	config0 := NewScrapeConfig()
-	config0.limit = 3
+	config0.Limit = 3
 
 	config1 := NewScrapeConfig()
 
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
 
 	got := len(c.SubChapters())
 	want := 2
@@ -167,12 +198,30 @@ func TestSubChaptersLimitOver(t *testing.T) {
 
 }
 
+func TestReverse(t *testing.T) {
+
+	config0 := NewScrapeConfig()
+	config0.Reverse = true
+
+	config1 := NewScrapeConfig()
+
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config0, config1}, 0, func(index int, name string) {})
+
+	got := c.SubChapters()[0].Name()
+	want := "The Twelve-Factor App"
+
+	if got != want {
+		t.Errorf("got %v, wanted %v", got, want)
+	}
+
+}
+
 func TestNotInclude(t *testing.T) {
 
 	config := NewScrapeConfig()
-	config.include = false
+	config.Include = false
 
-	c := NewChapterFromURL("https://books.lapw.at/", []*ScrapeConfig{config}, 0, func(index int, name string) {})
+	c := NewChapterFromURL("https://books.lapw.at/", "", []*ScrapeConfig{config}, 0, func(index int, name string) {})
 
 	got := c.Content()
 	want := ""

cmd/get.go

@@ -3,8 +3,6 @@ package cmd
 import (
 	"errors"
 	"fmt"
-	"log"
-	"os"
 	"strings"
 
 	"github.com/spf13/cobra"
@@ -12,13 +10,59 @@ import (
 	"github.com/lapwat/papeer/book"
 )
 
-var recursive, include, images, quiet bool
+type GetOptions struct {
-var format, output, selector, name, author string
+	// url string
-var limit, offset, delay, threads int
+
+	name   string
+	author string
+	Format string
+	output string
+	images bool
+	// ImagesOnly bool
+	quiet bool
+
+	Selector []string
+	depth    int
+	limit    int
+	offset   int
+	reverse  bool
+	delay    int
+	threads  int
+	// includeUrl bool
+	include     bool
+	useLinkName bool
+}
+
+var getOpts *GetOptions
+
+func init() {
+	getOpts = &GetOptions{}
+
+	getCmd.PersistentFlags().StringVarP(&getOpts.name, "name", "n", "", "book name (default: page title)")
+	getCmd.PersistentFlags().StringVarP(&getOpts.author, "author", "a", "", "book author")
+	getCmd.PersistentFlags().StringVarP(&getOpts.Format, "format", "f", "md", "file format [stdout, md, epub, mobi]")
+	getCmd.PersistentFlags().StringVarP(&getOpts.output, "output", "", "", "file name (default: book name)")
+	getCmd.PersistentFlags().BoolVarP(&getOpts.images, "images", "", false, "retrieve images only")
+	getCmd.PersistentFlags().BoolVarP(&getOpts.quiet, "quiet", "q", false, "hide progress bar")
+
+	// common with list command
+	getCmd.Flags().StringSliceVarP(&getOpts.Selector, "selector", "s", []string{}, "table of contents CSS selector")
+	getCmd.Flags().IntVarP(&getOpts.depth, "depth", "d", 0, "scraping depth")
+	getCmd.Flags().IntVarP(&getOpts.limit, "limit", "l", -1, "limit number of chapters, use with depth/selector")
+	getCmd.Flags().IntVarP(&getOpts.offset, "offset", "o", 0, "skip first chapters, use with depth/selector")
+	getCmd.Flags().BoolVarP(&getOpts.reverse, "reverse", "r", false, "reverse chapter order")
+	getCmd.Flags().IntVarP(&getOpts.delay, "delay", "", -1, "time in milliseconds to wait before downloading next chapter, use with depth/selector")
+	getCmd.Flags().IntVarP(&getOpts.threads, "threads", "t", -1, "download concurrency, use with depth/selector")
+	getCmd.Flags().BoolVarP(&getOpts.include, "include", "i", false, "include URL as first chapter, use with depth/selector")
+	getCmd.Flags().BoolVarP(&getOpts.useLinkName, "use-link-name", "", false, "use link name for chapter title")
+
+	rootCmd.AddCommand(getCmd)
+}
 
 var getCmd = &cobra.Command{
-	Use:   "get",
+	Use:     "get URL",
-	Short: "Scrape URL content",
+	Short:   "Scrape URL content",
+	Example: "papeer get https://www.eff.org/cyberspace-independence",
 	Args: func(cmd *cobra.Command, args []string) error {
 		if len(args) < 1 {
 			return errors.New("requires an URL argument")
@@ -30,39 +74,44 @@ var getCmd = &cobra.Command{
 			"epub":   true,
 			"mobi":   true,
 		}
-		if formatEnum[format] != true {
+
-			return fmt.Errorf("invalid format specified: %s", format)
+		if formatEnum[getOpts.Format] != true {
+			return fmt.Errorf("invalid format specified: %s", getOpts.Format)
 		}
 
 		// add .mobi to filename if not specified
-		if format == "mobi" {
+		if getOpts.Format == "mobi" {
-			if len(output) > 0 && strings.HasSuffix(output, ".mobi") == false {
+			if len(getOpts.output) > 0 && strings.HasSuffix(getOpts.output, ".mobi") == false {
-				output = fmt.Sprintf("%s.mobi", output)
+				getOpts.output = fmt.Sprintf("%s.mobi", getOpts.output)
 			}
 		}
 
-		if cmd.Flags().Changed("selector") && recursive == false {
+		if cmd.Flags().Changed("include") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
-			return errors.New("cannot use selector option if not in recursive mode")
+			return errors.New("cannot use include option if depth/selector is not specified")
 		}
 
-		if cmd.Flags().Changed("include") && recursive == false {
+		if cmd.Flags().Changed("limit") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
-			return errors.New("cannot use include option if not in recursive mode")
+			return errors.New("cannot use limit option if depth/selector is not specified")
 		}
 
-		if cmd.Flags().Changed("limit") && recursive == false {
+		if cmd.Flags().Changed("offset") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
-			return errors.New("cannot use limit option if not in recursive mode")
+			return errors.New("cannot use offset option if depth/selector is not specified")
 		}
 
-		if cmd.Flags().Changed("offset") && recursive == false {
+		if cmd.Flags().Changed("reverse") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
-			return errors.New("cannot use offset option if not in recursive mode")
+			return errors.New("cannot use reverse option if depth/selector is not specified")
 		}
 
-		if cmd.Flags().Changed("delay") && recursive == false {
+		if cmd.Flags().Changed("delay") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
-			return errors.New("cannot use delay option if not in recursive mode")
+			return errors.New("cannot use delay option if depth/selector is not specified")
 		}
 
-		if cmd.Flags().Changed("threads") && recursive == false {
+		if cmd.Flags().Changed("threads") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
-			return errors.New("cannot use threads option if not in recursive mode")
+			return errors.New("cannot use threads option if depth/selector is not specified")
+		}
+
+		if cmd.Flags().Changed("use-link-name") && getOpts.depth == 0 && len(getOpts.Selector) == 0 {
+			return errors.New("cannot use use-link-name option if depth/selector is not specified")
 		}
 
 		if cmd.Flags().Changed("delay") && cmd.Flags().Changed("threads") {
@@ -73,48 +122,61 @@ var getCmd = &cobra.Command{
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 		url := args[0]
-		b := book.NewBookFromURL(url, selector, name, author, recursive, include, images, quiet, limit, offset, delay, threads)
 
-		fakeConfig := book.NewScrapeConfigFake()
+		// fill selector array with empty selectors to match depth
-		fakeChapter := book.NewChapter("", b.Name(), b.Author(), "", b.Chapters(), fakeConfig)
+		getOpts.Selector = append(getOpts.Selector, "")
+		for len(getOpts.Selector) < getOpts.depth+1 {
+			getOpts.Selector = append(getOpts.Selector, "")
+		}
 
-		if format == "stdout" {
+		// generate config for each level
-			// TODO: ToMarkdownString
+		configs := make([]*book.ScrapeConfig, len(getOpts.Selector))
-			markdown := book.ToMarkdown(fakeChapter)
+		for index, s := range getOpts.Selector {
+			config := book.NewScrapeConfig()
+			config.Selector = s
+			config.Quiet = getOpts.quiet
+			config.Limit = getOpts.limit
+			config.Offset = getOpts.offset
+			config.Reverse = getOpts.reverse
+			config.Delay = getOpts.delay
+			config.Threads = getOpts.threads
+			config.ImagesOnly = getOpts.images
+			config.Include = getOpts.include
+			config.UseLinkName = getOpts.useLinkName
+
+			// do not use link name for root level as there is not parent link
+			if index == 0 {
+				config.UseLinkName = false
+			}
+
+			// always include last level by default
+			if index == len(getOpts.Selector)-1 {
+				config.Include = true
+			}
+
+			configs[index] = config
+		}
+
+		c := book.NewChapterFromURL(url, "", configs, 0, func(index int, name string) {})
+
+		if getOpts.Format == "stdout" {
+			markdown := book.ToMarkdownString(c)
 			fmt.Println(markdown)
 		}
 
-		if format == "md" {
+		if getOpts.Format == "md" {
-			// TODO: ToMarkdownFile
+			filename := book.ToMarkdown(c, getOpts.output)
-			markdown := book.ToMarkdown(fakeChapter)
+			fmt.Printf("Markdown saved to \"%s\"\n", filename)
-
-			if len(output) == 0 {
-				filename := book.Filename(fakeChapter.Name())
-				output = fmt.Sprintf("%s.md", filename)
-			}
-
-			// write to file
-			f, err := os.Create(output)
-			if err != nil {
-				log.Fatal(err)
-			}
-			_, err2 := f.WriteString(markdown)
-			if err2 != nil {
-				log.Fatal(err2)
-			}
-			f.Close()
-
-			fmt.Printf("Markdown saved to \"%s\"\n", output)
 		}
 
-		if format == "epub" {
+		if getOpts.Format == "epub" {
-			output = book.ToEpub(fakeChapter, output)
+			filename := book.ToEpub(c, getOpts.output)
-			fmt.Printf("Ebook saved to \"%s\"\n", output)
+			fmt.Printf("Ebook saved to \"%s\"\n", filename)
 		}
 
-		if format == "mobi" {
+		if getOpts.Format == "mobi" {
-			output = book.ToMobi(fakeChapter, output)
+			filename := book.ToMobi(c, getOpts.output)
-			fmt.Printf("Ebook saved to \"%s\"\n", output)
+			fmt.Printf("Ebook saved to \"%s\"\n", filename)
 		}
 	},
 }

cmd/list.go

@@ -2,9 +2,11 @@ package cmd
 
 import (
 	"errors"
+	"fmt"
 	"log"
 	urllib "net/url"
 	"os"
+	"strings"
 
 	"github.com/jedib0t/go-pretty/v6/table"
 	cobra "github.com/spf13/cobra"
@@ -12,9 +14,45 @@ import (
 	"github.com/lapwat/papeer/book"
 )
 
+type ListOptions struct {
+	// url string
+
+	Selector []string
+	depth    int
+	limit    int
+	offset   int
+	reverse  bool
+	delay    int
+	threads  int
+	// includeUrl bool
+	include     bool
+	useLinkName bool
+}
+
+var listOpts *ListOptions
+
+func init() {
+	listOpts = &ListOptions{}
+
+	// common with get command
+	listCmd.Flags().StringSliceVarP(&listOpts.Selector, "selector", "s", []string{}, "table of contents CSS selector")
+	listCmd.Flags().IntVarP(&listOpts.depth, "depth", "d", 0, "scraping depth")
+	listCmd.Flags().IntVarP(&listOpts.limit, "limit", "l", -1, "limit number of chapters, use with depth/selector")
+	listCmd.Flags().IntVarP(&listOpts.offset, "offset", "o", 0, "skip first chapters, use with depth/selector")
+	listCmd.Flags().BoolVarP(&listOpts.reverse, "reverse", "r", false, "reverse chapter order")
+	listCmd.Flags().IntVarP(&listOpts.delay, "delay", "", -1, "time in milliseconds to wait before downloading next chapter, use with depth/selector")
+	listCmd.Flags().IntVarP(&listOpts.threads, "threads", "t", -1, "download concurrency, use with depth/selector")
+	listCmd.Flags().BoolVarP(&listOpts.include, "include", "i", false, "include URL as first chapter, use with depth/selector")
+	listCmd.Flags().BoolVarP(&listOpts.useLinkName, "use-link-name", "", false, "use link name for chapter title")
+
+	rootCmd.AddCommand(listCmd)
+}
+
 var listCmd = &cobra.Command{
-	Use:   "ls",
+	Use:     "list URL",
-	Short: "Print table of content",
+	Aliases: []string{"ls"},
+	Short:   "Print URL table of contents",
+	Example: "papeer list https://12factor.net/ -s 'section.concrete>article>h2>a'",
 	Args: func(cmd *cobra.Command, args []string) error {
 		if len(args) < 1 {
 			return errors.New("requires an URL argument")
@@ -22,12 +60,16 @@ var listCmd = &cobra.Command{
 		return nil
 	},
 	Run: func(cmd *cobra.Command, args []string) {
+		if len(listOpts.Selector) == 0 {
+			listOpts.Selector = []string{""}
+		}
+
 		base, err := urllib.Parse(args[0])
 		if err != nil {
 			log.Fatal(err)
 		}
 
-		links, _, err := book.GetLinks(base, selector, limit, offset, include)
+		links, path, _, err := book.GetLinks(base, listOpts.Selector[0], listOpts.limit, listOpts.offset, listOpts.reverse, listOpts.include)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -37,7 +79,16 @@ var listCmd = &cobra.Command{
 		t.Style().Options.DrawBorder = false
 		t.Style().Options.SeparateColumns = false
 		t.Style().Options.SeparateHeader = false
-		t.AppendHeader(table.Row{"#", "Name", "Url"})
+
+		// format selector path
+		pathArray := strings.Split(path, "<")
+		// reverse path
+		for i, j := 0, len(pathArray)-1; i < j; i, j = i+1, j-1 {
+			pathArray[i], pathArray[j] = pathArray[j], pathArray[i]
+		}
+		pathFormatted := strings.Join(pathArray, ">")
+
+		t.AppendHeader(table.Row{"#", "Name", fmt.Sprintf("Url [%s]", pathFormatted)})
 
 		for index, link := range links {
 			u, err := base.Parse(link.Href())

cmd/root.go

@@ -21,22 +21,3 @@ func Execute() {
 		os.Exit(1)
 	}
 }
-
-func init() {
-	rootCmd.PersistentFlags().StringVarP(&name, "name", "n", "", "book name (default: page title)")
-	rootCmd.PersistentFlags().StringVarP(&author, "author", "a", "", "book author")
-	rootCmd.PersistentFlags().StringVarP(&format, "format", "f", "stdout", "file format [stdout, md, epub, mobi]")
-	rootCmd.PersistentFlags().StringVarP(&output, "output", "", "", "file name (default: book name)")
-	rootCmd.PersistentFlags().StringVarP(&selector, "selector", "s", "", "table of content CSS selector, in resursive mode")
-	rootCmd.PersistentFlags().BoolVarP(&recursive, "recursive", "r", false, "create one chapter per natigation item")
-	rootCmd.PersistentFlags().BoolVarP(&include, "include", "i", false, "include URL as first chapter, in resursive mode")
-	rootCmd.PersistentFlags().BoolVarP(&images, "images", "", false, "retrieve images only")
-	rootCmd.PersistentFlags().BoolVarP(&quiet, "quiet", "q", false, "hide progress bar")
-	rootCmd.PersistentFlags().IntVarP(&limit, "limit", "l", -1, "limit number of chapters, in recursive mode")
-	rootCmd.PersistentFlags().IntVarP(&offset, "offset", "o", 0, "skip first chapters, in recursive mode")
-	rootCmd.PersistentFlags().IntVarP(&delay, "delay", "d", -1, "time to wait before downloading next chapter, in milliseconds")
-	rootCmd.PersistentFlags().IntVarP(&threads, "threads", "t", -1, "download concurrency, in recursive mode")
-
-	rootCmd.AddCommand(getCmd)
-	rootCmd.AddCommand(listCmd)
-}

cmd/version.go

@@ -14,6 +14,6 @@ var versionCmd = &cobra.Command{
 	Use:   "version",
 	Short: "Print the version number of papeer",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("papeer v0.3.3")
+		fmt.Println("papeer v0.5.0")
 	},
 }

go.mod

@@ -29,10 +29,15 @@ require (
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/jedib0t/go-pretty/v6 v6.2.4 // indirect
+	github.com/json-iterator/go v1.1.11 // indirect
 	github.com/kennygrant/sanitize v1.2.4 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
 	github.com/mattn/go-runewidth v0.0.13 // indirect
 	github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db // indirect
+	github.com/mmcdole/gofeed v1.1.3 // indirect
+	github.com/mmcdole/goxpp v0.0.0-20181012175147-0068e33feabf // indirect
+	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
+	github.com/modern-go/reflect2 v1.0.1 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/saintfish/chardet v0.0.0-20120816061221-3af4cd4741ca // indirect
 	github.com/schollz/progressbar/v3 v3.8.3 // indirect

go.sum

@@ -87,6 +87,7 @@ github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3Ee
 github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
 github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -235,6 +236,8 @@ github.com/jawher/mow.cli v1.1.0/go.mod h1:aNaQlc7ozF3vw6IJ2dHjp2ZFiA4ozMIYY6Pyu
 github.com/jedib0t/go-pretty/v6 v6.2.4 h1:wdaj2KHD2W+mz8JgJ/Q6L/T5dB7kyqEFI16eLq7GEmk=
 github.com/jedib0t/go-pretty/v6 v6.2.4/go.mod h1:+nE9fyyHGil+PuISTCrp7avEdo6bqoMwqZnuiK2r2a0=
 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
+github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
+github.com/json-iterator/go v1.1.11 h1:uVUAXhF2To8cbw/3xN3pxj6kk7TYKs98NIrTqPlMWAQ=
 github.com/json-iterator/go v1.1.11/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
 github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=
 github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
@@ -275,8 +278,14 @@ github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0Qu
 github.com/mitchellh/mapstructure v0.0.0-20160808181253-ca63d7c062ee/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mitchellh/mapstructure v1.4.1/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/mmcdole/gofeed v1.1.3 h1:pdrvMb18jMSLidGp8j0pLvc9IGziX4vbmvVqmLH6z8o=
+github.com/mmcdole/gofeed v1.1.3/go.mod h1:QQO3maftbOu+hiVOGOZDRLymqGQCos4zxbA4j89gMrE=
+github.com/mmcdole/goxpp v0.0.0-20181012175147-0068e33feabf h1:sWGE2v+hO0Nd4yFU/S/mDBM5plIU8v/Qhfz41hkDIAI=
+github.com/mmcdole/goxpp v0.0.0-20181012175147-0068e33feabf/go.mod h1:pasqhqstspkosTneA62Nc+2p9SOBBYAPbnmRRWPQ0V8=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
+github.com/modern-go/reflect2 v1.0.1 h1:9f412s+6RmYXLWZSEzVVgPGK7C2PphHj5RJrvfx9AWI=
 github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
 github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
@@ -355,6 +364,7 @@ github.com/temoto/robotstxt v1.1.2 h1:W2pOjSJ6SWvldyEuiFXNxz3xZ8aiWX5LbfDiOFd7Fx
 github.com/temoto/robotstxt v1.1.2/go.mod h1:+1AmkuG3IYkh1kv0d2qEB9Le88ehNO0zwOr3ujewlOo=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
 github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc=
+github.com/urfave/cli v1.22.3/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
 github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU=
 github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
 github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=

release.sh

@@ -1,27 +1,28 @@
 #!/usr/bin/env bash
 
-version=$1
-platforms=("linux/amd64" "darwin/amd64" "windows/amd64")
-
 if [ "$#" -ne 1 ]; then
     echo "Illegal number of parameters"
     echo "Usage: ./release.sh X.X.X"
     exit 1
 fi
 
+version=$1
+platforms=("linux/amd64" "darwin/amd64" "windows/amd64")
+
 for platform in "${platforms[@]}"
 do
     platform_split=(${platform//\// })
     GOOS=${platform_split[0]}
     GOARCH=${platform_split[1]}
-    output_name='papeer-v'$version'-'$GOOS'-'$GOARCH
+    output_name=papeer
-    if [ $GOOS = "windows" ]; then
-        output_name+='.exe'
-    fi
 
-    env GOOS=$GOOS GOARCH=$GOARCH go build -o $output_name
+    if [ $GOOS = "windows" ]; then
-    if [ $? -ne 0 ]; then
+        env GOOS=$GOOS GOARCH=$GOARCH go build -o "$output_name.exe"
-        echo 'An error has occurred! Aborting the script execution...'
+        zip "$output_name-v$version-$GOOS-$GOARCH.exe.zip" "$output_name.exe"
-        exit 1
+        rm "$output_name.exe"
+    else
+        env GOOS=$GOOS GOARCH=$GOARCH go build -o "$output_name"
+        tar czvf "$output_name-v$version-$GOOS-$GOARCH.tar.gz" "$output_name"
+        rm "$output_name"
     fi
 done