lslinks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcaf27dbf9771119d244c77f11a2c8c635c21579390cf8871b2131eb4b4e514d
+  data.tar.gz: 2c5e76d18208a9a582077d83662c34110d002533849ea23e2edf7e967854ff74
+SHA512:
+  metadata.gz: 91de13c8881a9daf128e1e1bc4e16232453501c90791337bbad074c1041f58ea444be450f2fc068690b5cb8f8b97a3e4cf7d28b3e850bee04a0da5fd43d06c2a
+  data.tar.gz: 44910da85da36eb115f348830976aef77c6c29cf97c04899a3894ec26ba1d1fdcd033c1b67b0dda2929c932a252aacb07bc8124f944a31da2591f5460207e809

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Yuya.Nishida.
+
+X11 License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# lslinks
+
+A command line tool to list links.
+
+## Installation
+
+```console
+$ gem install lslinks
+```
+
+## Usage
+
+### list links
+
+```console
+$ lslinks https://www.ruby-lang.org/
+/en/
+```
+
+### list links with text
+
+```console
+$ lslinks -l https://www.ruby-lang.org/
+/en/	Click here
+```
+
+### list links as Full URL
+
+```console
+$ lslinks -k https://www.ruby-lang.org/
+https://www.ruby-lang.org/en/
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nishidayuya/lslinks .

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/lslinks

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "lslinks"
+
+Lslinks::Cli.run(ARGV)

data/lib/lslinks/cli.rb

@@ -0,0 +1,18 @@
+require "lslinks"
+
+module Lslinks::Cli
+  class << self
+    def run(argv)
+      options, resource_name = *Lslinks::OptionParser.(argv)
+      Lslinks::Reader.open(resource_name, **options) do |resource_stream|
+        Lslinks::Parser.each_link(resource_stream, **options) do |link|
+          Lslinks::Formatter.output(resource_name, link, **options)
+        end
+      end
+    rescue => e
+      raise if Lslinks.debug?
+
+      $stderr.puts(e.message)
+    end
+  end
+end

data/lib/lslinks/error/unsupported_resource.rb

@@ -0,0 +1,4 @@
+require "lslinks"
+
+class Lslinks::Error::UnsupportedResource < Lslinks::Error
+end

data/lib/lslinks/error.rb

@@ -0,0 +1,4 @@
+require "lslinks"
+
+class Lslinks::Error < StandardError
+end

data/lib/lslinks/formatter.rb

@@ -0,0 +1,22 @@
+require "lslinks"
+
+module Lslinks::Formatter
+  class << self
+    def output(resource_name, link, stdout: $stdout, **options)
+      link_uri = if options[:convert_links]
+                   URI(resource_name) + link.url
+                 else
+                   link.uri
+                 end
+
+      output_record = [link_uri]
+      output_record << squeeze_text(link.text) if options[:list_mode]
+
+      stdout.puts(output_record.join("\t"))
+    end
+
+    private
+
+    def squeeze_text(text) = text.gsub(/\s+/, " ").strip
+  end
+end

data/lib/lslinks/link.rb

@@ -0,0 +1,11 @@
+require "lslinks"
+
+class Lslinks::Link < Data.define(:url, :text)
+  class << self
+    def from_nokogiri_element(element)
+      return new(url: element.attr("href"), text: element.text)
+    end
+  end
+
+  def uri = URI(url)
+end

data/lib/lslinks/option_parser.rb

@@ -0,0 +1,50 @@
+require "lslinks"
+
+class Lslinks::OptionParser < OptionParser
+  class << self
+    def call(argv)
+      parser = new
+      parser.banner = "Usage: #{File.basename(Process.argv0)} [OPTIONS] URI_or_path"
+      parser.version = Lslinks::VERSION
+      parser.separator("")
+      parser.separator("Basic options:")
+      parser.on("-l", "list links with text")
+      parser.on("-k", "--convert-links", "convert links to full URL")
+      parser.separator("")
+      parser.separator("HTTP input options:")
+      parser.on("--user-agent=USER_AGENT") # from curl wget
+      parser.on("--referer=REFERER") # from curl wget
+      parser.on("--header=HEADER") # from curl wget
+      options = {
+        http_headers: {},
+      }
+      rest_args = parser.order(argv, into: options)
+      resource_name = rest_args.shift
+      if !resource_name
+        $stderr.puts(parser.help)
+        exit(1)
+      end
+      return options, resource_name
+    end
+  end
+
+  def order!(argv, into:, &nonopt)
+    setter = ->(name, val) do
+      symbolized_name = name.gsub("-", "_").to_sym
+      case symbolized_name
+      when :l
+        into[:list_mode] = true
+      when :user_agent
+        into[:http_headers]["User-Agent"] = val
+      when :referer
+        into[:http_headers]["Referer"] = val
+      when :header
+        key, value = *val.split(/:\s*/, 2)
+        into[:http_headers][key] = value
+      else
+        into[symbolized_name] = val
+      end
+    end
+    parse_in_order(argv, setter, &nonopt)
+  end
+end

data/lib/lslinks/parser.rb

@@ -0,0 +1,13 @@
+require "lslinks"
+
+module Lslinks::Parser
+  class << self
+    def each_link(resource_stream, **)
+      document = Nokogiri::HTML(resource_stream.read) # TODO: to stream reading
+      document.css("a[href]").each do |element|
+        link = Lslinks::Link.from_nokogiri_element(element)
+        yield(link)
+      end
+    end
+  end
+end

data/lib/lslinks/reader/file.rb

@@ -0,0 +1,9 @@
+require "lslinks"
+
+module Lslinks::Reader::File
+  class << self
+    def open(resource_name, **, &block)
+      return File.open(resource_name, &block)
+    end
+  end
+end

data/lib/lslinks/reader/http.rb

@@ -0,0 +1,21 @@
+require "lslinks"
+
+module Lslinks::Reader::Http
+  class << self
+    DEFAULT_HTTP_HEADERS = {
+      "User-Agent" => "Ruby/#{RUBY_VERSION} lslinks/#{Lslinks::VERSION}",
+    }
+
+    def open(resource_name, **options, &block)
+      begin
+        uri = URI(resource_name)
+      rescue URI::InvalidURIError
+        raise Lslinks::Error::UnsupportedResource
+      end
+      raise Lslinks::Error::UnsupportedResource if !uri.is_a?(URI::HTTP)
+
+      http_headers = DEFAULT_HTTP_HEADERS.merge(options[:http_headers])
+      return uri.open(http_headers, &block)
+    end
+  end
+end

data/lib/lslinks/reader/stdin.rb

@@ -0,0 +1,11 @@
+require "lslinks"
+
+module Lslinks::Reader::Stdin
+  class << self
+    def open(resource_name, stdin: $stdin, **, &block)
+      raise Lslinks::Error::UnsupportedResource if "-" != resource_name
+
+      return block.(stdin)
+    end
+  end
+end

data/lib/lslinks/reader.rb

@@ -0,0 +1,22 @@
+require "lslinks"
+
+module Lslinks::Reader
+  class << self
+    def open(resource_name, **options, &block)
+      READER_CLASSES.each do |reader_class|
+        return reader_class.open(resource_name, **options, &block)
+      rescue Lslinks::Error::UnsupportedResource
+        # nop
+      end
+    end
+  end
+
+  require "lslinks/reader/file"
+  require "lslinks/reader/http"
+  require "lslinks/reader/stdin"
+  READER_CLASSES = [
+    Lslinks::Reader::Http,
+    Lslinks::Reader::Stdin,
+    Lslinks::Reader::File,
+  ]
+end

data/lib/lslinks.rb

@@ -0,0 +1,22 @@
+require "open-uri"
+require "optparse"
+require "pathname"
+require "uri"
+
+require "nokogiri"
+
+module Lslinks
+  VERSION = "0.1.0"
+
+  class << self
+    def debug?
+      return "1" == ENV["LSLINKS_DEBUG"]
+    end
+  end
+end
+
+Pathname(__dir__).glob("**/*.rb").map { |path|
+  path.sub_ext("")
+}.sort.each do |path|
+  require(path.relative_path_from(__dir__))
+end

data/sig/lslinks.rbs

@@ -0,0 +1,4 @@
+module Lslinks
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: lslinks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuya.Nishida.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables:
+- lslinks
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/lslinks
+- lib/lslinks.rb
+- lib/lslinks/cli.rb
+- lib/lslinks/error.rb
+- lib/lslinks/error/unsupported_resource.rb
+- lib/lslinks/formatter.rb
+- lib/lslinks/link.rb
+- lib/lslinks/option_parser.rb
+- lib/lslinks/parser.rb
+- lib/lslinks/reader.rb
+- lib/lslinks/reader/file.rb
+- lib/lslinks/reader/http.rb
+- lib/lslinks/reader/stdin.rb
+- sig/lslinks.rbs
+homepage: https://github.com/nishidayuya/lslinks
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nishidayuya/lslinks
+  source_code_uri: https://github.com/nishidayuya/lslinks
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A command line tool to list links.
+test_files: []