tldr-cli 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a61855908c1a17de1bdf6c0eaeaa263698d2e3e0d581887b230e146c0e049078
-  data.tar.gz: ea63efc92bdec797db099fb7e7f20c1f56aec73eb168d131cce3cea4eeb35649
+  metadata.gz: 6bc8340ef090cdcfd533ff82ad775c7ede0266eb86f8e2339413c602e5e5d56f
+  data.tar.gz: f7876530905c3b140c1e0496545e2152a52ac02eb238015b6591097bdca829d6
 SHA512:
-  metadata.gz: 2ea75cddc8d4a70df210069b7fff660e9f1d748a7e094a1cc07e17a8aebcbd0ddabee7d050efe86eb8855565fa35e8cc793b5799b2d0f684ab77ba40fc290c3a
-  data.tar.gz: f6cb13f8c1ba4f4992e824db3d1d6c8322921b3fc1933ea830fc5976c7cc6a2b402cfee1e4821982542d7dd5cf1c329c8a3b6631eb32d0e35aea082b9e4ac28c
+  metadata.gz: 95ff5d7ceb347ce99837f9c03ac552082456daf00b59759d83fb64fa981d4c8c53b22f2329a8796f3b90b30f5acdfd7fa9e8d0d72573065995df66f04a15ff93
+  data.tar.gz: 2a65eec38bff5e22f050c240ea21512c6c8e112e1932f3b6b73e3e0a1c00abe0ad5c35c6f806606a0ed9eee1b2241e7307a36d18b5f87cb5de4037feb77c8558

data/CHANGELOG.md

@@ -1,5 +1,16 @@
+
 ## [Unreleased]
 
+## [0.3.0] - 2024-03-06
+
+- Added support to personal local pages created at ~/.config/tldr/pages
+
+## [0.2.0] - 2024-03-06
+
+- Added support to page languages
+
 ## [0.1.0] - 2023-05-18
 
 - Initial release
+
+

data/README.md

@@ -1,34 +1,28 @@
-# Tldr::Cli
+# tldr-cli
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tldr/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a simple and tiny tldr-pages client write using Ruby that works well.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'tldr-cli'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
     $ gem install tldr-cli
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ tldr [command]
+    
+Example:
+
+    $ tldr tar
 
-## Development
+## Roadmap
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- [x] basic cli interface
+- [x] tldr-pages markdown content fetch
+- [x] tldr-pages markdown parsing and presentation 
+- [ ] implement content caching 
+- [ ] content local cache update
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/tldr/cli/commands.rb

@@ -15,6 +15,9 @@ module TLDR
       URL_SUFFIX =
         ENV.fetch('TLDR_URL_SUFFIX', '.md')
 
+      LOCAL_BASE =
+        ENV.fetch('TLDR_LOCAL_BASE', "#{Dir.home}/.config/tldr/pages")
+
       usage do
         program 'tldr'
 
@@ -63,6 +66,16 @@ module TLDR
       #   desc 'list all entries in the local database'
       # end
 
+      option :lang do
+        optional
+        short '-l'
+        long '--lang=string'
+        default 'en'
+        permit %w[ar bn bs ca cs da de en es fa fi fr hi id it ja ko lo ml ne nl no pl pt_BR pt_PT ro ru sh sr sv ta th
+                  tr uk uz zh zh_TW]
+        desc 'select language of page to be displayed (default: en)'
+      end
+
       option :platform do
         optional
         short '-p'
@@ -72,6 +85,15 @@ module TLDR
         desc 'select platform, supported are linux / osx / sunos / windows / common'
       end
 
+      option :source do
+        optional
+        short '-s'
+        long '--source=string'
+        default 'local'
+        permit %w[local remote]
+        desc 'select page source to be local or remote (default: local)'
+      end
+
       argument :query do
         arity zero_or_more
       end
@@ -86,15 +108,21 @@ module TLDR
         elsif params[:version]
           version
         elsif params[:query]
-          query = params[:query]
-          platform = params[:platform]
+          query, lang, platform, source =
+            params.to_h.values_at(:query, :lang, :platform, :source)
+
+          page_path = "/#{platform}/#{query}"
 
-          response = Faraday.get("#{URL_BASE}/#{platform}/#{query}#{URL_SUFFIX}")
+          if source == 'local' && local_page?(local_path(page_path, lang: lang))
+            content = File.read(local_path(page_path, lang: lang))
+            render_markdown(content)
+            return
+          end
 
+          response = Faraday.get(remote_path(page_path, lang: lang))
           return not_found unless response.success?
 
-          markdown = TTY::Markdown.parse(response.body, symbols: { override: { bullet: '-' } })
-          puts markdown
+          render_markdown(response.body)
         else
           print help
         end
@@ -102,6 +130,10 @@ module TLDR
 
       private
 
+      def render_markdown(content)
+        puts TTY::Markdown.parse(content, symbols: { override: { bullet: '-' } })
+      end
+
       def version
         puts <<~MESSAGE
           tldr v#{TLDR::CLI::VERSION} (v#{TLDR::CLI::VERSION})
@@ -116,6 +148,20 @@ module TLDR
           Submit new pages here: https://github.com/tldr-pages/tldr
         MESSAGE
       end
+
+      def local_page?(page_path)
+        File.exist?(page_path)
+      end
+
+      def local_path(fragment, lang: 'en', relative: false)
+        lang = lang == 'en' ? '' : ".#{lang}"
+        "#{relative ? '' : LOCAL_BASE}#{lang}#{fragment}#{URL_SUFFIX}"
+      end
+
+      def remote_path(fragment, lang: 'en', relative: false)
+        lang = lang == 'en' ? '' : ".#{lang}"
+        "#{relative ? '' : URL_BASE}#{lang}#{fragment}#{URL_SUFFIX}"
+      end
     end
   end
 end

data/lib/tldr/cli/version.rb

@@ -2,6 +2,6 @@
 
 module TLDR
   module CLI
-    VERSION = "0.1.0"
+    VERSION = '0.3.0'
   end
 end

data/new.patch

@@ -0,0 +1,103 @@
+ lib/tldr/cli/commands.rb | 57 +++++++++++++++++++++++++++++++++++++++++++-----
+ 1 file changed, 52 insertions(+), 5 deletions(-)
+
+diff --git a/lib/tldr/cli/commands.rb b/lib/tldr/cli/commands.rb
+index c9aea38..8998696 100644
+--- a/lib/tldr/cli/commands.rb
++++ b/lib/tldr/cli/commands.rb
+@@ -15,6 +15,9 @@ module TLDR
+       URL_SUFFIX =
+         ENV.fetch('TLDR_URL_SUFFIX', '.md')
+ 
++      LOCAL_BASE =
++        ENV.fetch('TLDR_LOCAL_BASE', "#{Dir.home}/.config/tldr/pages")
++
+       usage do
+         program 'tldr'
+ 
+@@ -63,6 +66,25 @@ module TLDR
+       #   desc 'list all entries in the local database'
+       # end
+ 
++      option :lang do
++        optional
++        short '-l'
++        long '--lang=string'
++        default 'en'
++        permit %w[ar bn bs ca cs da de en es fa fi fr hi id it ja ko lo ml ne nl no pl pt_BR pt_PT ro ru sh sr sv ta th tr uk uz zh zh_TW]
++        desc 'select language of page to be displayed (default: en)'
++      end
++
++      option :source do
++        optional
++        short '-s'
++        long '--source=string'
++        default 'local'
++        permit %w[local remote]
++        desc 'select page source to be local or remote (default: local)'
++      end
++
++
+       option :platform do
+         optional
+         short '-p'
+@@ -86,15 +108,22 @@ module TLDR
+         elsif params[:version]
+           version
+         elsif params[:query]
+-          query = params[:query]
+-          platform = params[:platform]
++          query, lang, source, platform =
++            params.to_h.values_at(:query, :lang, :source, :platform)
++
++          page_path = "/#{platform}/#{query}"
+ 
+-          response = Faraday.get("#{URL_BASE}/#{platform}/#{query}#{URL_SUFFIX}")
++          if source == 'local' && local_page?(local_path(page_path, lang: lang))
++            content = File.read(local_path(page_path, lang: lang))
++            render_markdown(content)
++            return
++          end
+ 
++          puts "Fetching page from #{source} source..." if
++          response = Faraday.get(remote_path(page_path, lang: lang))
+           return not_found unless response.success?
+ 
+-          markdown = TTY::Markdown.parse(response.body, symbols: { override: { bullet: '-' } })
+-          puts markdown
++          render_markdown(response.body)
+         else
+           print help
+         end
+@@ -102,6 +131,10 @@ module TLDR
+ 
+       private
+ 
++      def render_markdown(content)
++        puts TTY::Markdown.parse(content, symbols: { override: { bullet: '-' } })
++      end
++
+       def version
+         puts <<~MESSAGE
+           tldr v#{TLDR::CLI::VERSION} (v#{TLDR::CLI::VERSION})
+@@ -116,6 +149,20 @@ module TLDR
+           Submit new pages here: https://github.com/tldr-pages/tldr
+         MESSAGE
+       end
++
++      def local_path(fragment, lang: 'en', relative: false)
++        lang = lang == 'en' ? '' : ".#{lang.to_s}"
++        "#{relative ? '' : LOCAL_BASE}#{lang}#{fragment}#{URL_SUFFIX}"
++      end
++
++      def remote_path(fragment, lang: 'en', relative: false)
++        lang = lang == 'en' ? '' : ".#{lang.to_s}"
++        "#{relative ? '' : URL_BASE}#{lang}#{fragment}#{URL_SUFFIX}"
++      end
++
++      def local_page?(page_path)
++        File.exist?(page_path)
++      end
+     end
+   end
+ end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tldr-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Vinciguerra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,6 +72,7 @@ files:
 - lib/tldr/cli.rb
 - lib/tldr/cli/commands.rb
 - lib/tldr/cli/version.rb
+- new.patch
 - sig/tldr/cli.rbs
 - tldr-cli.gemspec
 homepage: https://github.com/dvinciguerra/tldr-cli
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: A Ruby based command-line client for tldr