jsearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9d3964c34e473b07233812a7003b4f15e8abef682cd269ab7bbde09f9508a10
+  data.tar.gz: 856a823533f589b7c7aa7915907930c4729f8e09a644b43bbe2ec6d0de597715
+SHA512:
+  metadata.gz: 3f4d4f0e4cad08d448292bb574642d16a8916565f28050a037251574654fd694f8a44d452e6ef47bc4ae1804dc7c04c10ebb75f6b7459b5d326017c47cf442fc
+  data.tar.gz: ab9a3f36ccd7f0490c1ff2c1c524d68dbe934687f0b70f2204ac2088d8ac00b5822ec0fc9955190744aa01c9e8ffda663d84062a388ee40a1b43446b49e84444

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/README.md

@@ -0,0 +1,66 @@
+# Jsearch
+
+Have you ever need to find what package a Java class belongs to *without* using
+an IDE? Let me tell a history.
+
+Back in 1999, when I started using Java with JDK 1.1.6 (not really sure about
+the date and version), we need to look for the package on the documentation.
+Again I'm not really sure there was online documentation as we have here (I live
+in Brazil, internet access was a bit late here) but what I'm really sure is that
+I used a big book ("The Java Class Libraries") with all the Java APIs to search
+for info.
+
+I also used some IDEs available back then, such as Symantec's Visual Café, Forté
+for Java (this one will become NetBeans) but I realized it was more complicated
+to maintain code on such tools than straight on my Vim editor (yes, I already
+use it back then), so I abandoned all IDEs and wrote my Java code using only the
+text editor, and trust me, I was life changing. The code size got 50% smaller
+and 50% faster.
+
+But in the coming years, when I saw Java code snippets, I never saw people
+mentioning the packages the classes used, so I needed to find them by myself
+again. What I didn't know is the current IDEs were smarter and with a simple
+`CTRL+ENTER` they find and import the packages for you. I kept years wondering
+why people never mentioned the packages on the snippets, and that was the cause.
+As I kept using my text editor, never realized that. Oh, ok, life goes on.
+
+Nowadays I keep using my Vim editor (Neovim most part of the time) to keep some
+of my Java code (for other languages, like Ruby, use it 100% of the time), while
+when developing Android apps I use Java and Kotlin inside Android Studio (and
+fry my CPUs), but finally I decided to make a tool to help me avoid going on the
+Oracle docs to find the correct package for a class, and then I created Jsearch
+on a weekend. Basically I use it to find the package of a class, and also gives
+me the import statement to copy and paste on my Java code file. No bells and
+whistles, just this.
+
+## Installation
+
+```
+gem install jsearch
+```
+
+## Usage
+
+```
+Use: jsearch [options]
+    -c, --class CLASS                Class to search
+    -p, --package                    Show package
+    -i, --import                     Show import statement
+    -s, --silent                     Don't show output
+        --cache-size                 Show cache size
+        --clear-cache                Clear cache
+    -b, --base URL                   URL to search for classes reference
+    -h, --help                       Show help
+```
+
+It can be used with a small and simple [Vim plugin I made](https://github.com/taq/vim-jsearch).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/taq/jsearch.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/jsearch

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/jsearch.rb"

data/lib/jsearch/cache.rb

@@ -0,0 +1,77 @@
+# typed: false
+# frozen_string_literal: true
+
+require "nokogiri"
+require "open-uri"
+require 'fileutils'
+
+module Jsearch
+  # Cache manager
+  #
+  class Cache
+    BASE_DIR = "#{Dir.home}/.cache/jsearch".freeze
+
+    def self.check
+      return if Dir.exist?(BASE_DIR)
+
+      FileUtils.mkdir_p(BASE_DIR)
+    end
+
+    def self.path(url)
+      tokens = url.sub(Configuration.instance.base, "").split("/")
+      dir    = tokens[1..-2].join("/")
+      file   = tokens.last
+      sep    = dir.empty? ? "" : "/"
+
+      "#{BASE_DIR}/#{dir}#{sep}#{file}"
+    end
+
+    def self.get(url)
+      check
+
+      file = path(url)
+      return { contents: File.read(file), cache: true } if File.exist?(file)
+
+      contents = URI.parse(url).open.read
+      dir      = File.dirname(file)
+      FileUtils.mkdir_p(dir)
+      File.write(file, contents)
+
+      { contents: contents, cache: false }
+    rescue StandardError => e
+      $stderr.puts "Error downloading: #{e}"
+    end
+
+    def self.files
+      Dir.glob("#{BASE_DIR}/**/*")
+    end
+
+    def self.clear
+      found_files, found_dirs = files.partition do |path|
+        File.file?(path)
+      end
+
+      files_total = found_files.reduce(0) do |total, path|
+        puts path
+        total += File.size(path)
+        File.unlink(path)
+        total
+      end
+
+      found_dirs.sort.reverse.each do |dir|
+        FileUtils.rmdir(dir)
+      end
+
+      files_total
+    end
+
+    def self.size
+      files.reduce(0) do |total, file|
+        next total unless File.file?(file)
+
+        total += File.size(file)
+        total
+      end
+    end
+  end
+end

data/lib/jsearch/color.rb

@@ -0,0 +1,22 @@
+# typed: false
+# frozen_string_literal: true
+
+# Inject colors on strings
+#
+class String
+  def bold
+    "\e[1m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+
+  def cyan
+    "\e[36m#{self}\e[0m"
+  end
+
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+end

data/lib/jsearch/configuration.rb

@@ -0,0 +1,71 @@
+# typed: false
+# frozen_string_literal: true
+
+require "singleton"
+require "optparse"
+
+module Jsearch
+  # General shared configurations
+  #
+  class Configuration
+    include Singleton
+
+    attr_accessor :cls, :silent, :package, :import, :methods, :base
+
+    def initialize
+      @cls     = nil
+      @silent  = false
+      @package = false
+      @import  = false
+      @methods = false
+      @base    = "https://docs.oracle.com/javase/8/docs/api"
+
+      parse
+    end
+
+    private
+
+    def parse
+      ARGV << "-h" if ARGV.empty?
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Use: jsearch [options]"
+        opts.on("-c", "--class CLASS", "Class to search") do |cls|
+          @cls = cls
+        end
+        opts.on("-p", "--package", "Show package") do
+          @package = true
+        end
+        opts.on("-i", "--import", "Show import statement") do
+          @import = true
+        end
+        opts.on("-s", "--silent", "Don't show output") do
+          @silent = true
+        end
+        opts.on("-m", "--methods", "List methods") do
+          @methods = true
+        end
+        opts.on("--cache-size", "Show cache size") do
+          puts Cache.size
+          exit
+        end
+        opts.on("--clear-cache", "Clear cache") do
+          puts "#{Cache.clear} bytes"
+          exit
+        end
+        opts.on("-b", "--base URL", "URL to search for classes reference") do |base|
+          @base = base
+        end
+        opts.on_tail("-h", "--help", "Show help") do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!
+    rescue StandardError => e
+      $stderr.puts "Error parsing: #{e}"
+      nil
+    end
+  end
+end

data/lib/jsearch/printer.rb

@@ -0,0 +1,28 @@
+# typed: false
+# frozen_string_literal: true
+
+module Jsearch
+  # Console printer
+  #
+  class Printer
+    attr_accessor :silent
+
+    def initialize(silent)
+      @silent = silent
+    end
+
+    def print(str)
+      return if @silent
+
+      $stdout.print str
+    end
+
+    def error(str)
+      $stderr.print str.red
+    end
+
+    def force(str)
+      $stderr.print str
+    end
+  end
+end

data/lib/jsearch/searcher.rb

@@ -0,0 +1,86 @@
+# typed: false
+# frozen_string_literal: true
+
+require "nokogiri"
+require "open-uri"
+
+module Jsearch
+  # Console printer
+  #
+  class Searcher
+    def initialize(config, printer)
+      @config    = config
+      @printer   = printer
+      @class_ref = class_ref
+      @class_doc = class_doc
+
+      @printer.force find_package if @config.package
+
+      @printer.force find_import  if @config.import
+
+      methods if @config.methods
+    rescue StandardError => e
+      @printer&.error e.message
+    end
+
+    private
+
+    def class_ref
+      @printer.print "Getting class reference ... "
+      page     = "allclasses-noframe.html"
+      url      = "#{@config.base}/#{page}"
+      contents = Cache.get(url)
+      raise "error.\n Could not download." unless contents
+
+      if contents[:cache]
+        @printer.print "got from cache.\n".green
+      else
+        @printer.print "done.\n".green
+      end
+
+      doc  = Nokogiri::HTML(contents[:contents])
+      ref  = doc.css("div.indexContainer > ul > li > a[text()='#{@config.cls}']")&.first
+      raise "error. \nCould not find class." unless ref
+
+      ref.attribute("href").to_s
+    end
+
+    def class_doc
+      @printer.print "Getting class info ... "
+      url      = "#{@config.base}/#{@class_ref}"
+      contents = Cache.get(url)
+      raise "error.\n Could not download." unless contents
+
+      if contents[:cache]
+        @printer.print "got from cache.\n".green
+      else
+        @printer.print "done.\n".green
+      end
+
+      Nokogiri::HTML(contents[:contents])
+    end
+
+    def find_package
+      @printer.print "Finding package ... "
+      package = @class_doc.css("div.header > div.subTitle").last
+      @printer.print "done.\n\n".green
+      package.text
+    end
+
+    def find_import
+      "import #{find_package}.#{@config.cls};"
+    end
+
+    def methods
+      @printer.print "\nMethods:\n\n"
+
+      @class_doc.css("span.memberNameLink").each do |meth|
+        str     = meth.css("a").first.parent.parent.text.chomp.gsub("\n", "").gsub(/\s{2,}/, "_")
+        matches = str.match(/(?<name>\w+)\((?<args>.*)\)/i)
+        name    = matches[:name]
+        args    = matches[:args]
+        @printer.force "- #{name.cyan}(#{args})\n" unless name == @config.cls
+      end
+    end
+  end
+end

data/lib/jsearch/version.rb

@@ -0,0 +1,3 @@
+module Jsearch
+  VERSION = "0.1.0"
+end

data/lib/jsearch.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "jsearch/configuration"
+require_relative "jsearch/printer"
+require_relative "jsearch/color"
+require_relative "jsearch/searcher"
+require_relative "jsearch/cache"
+
+module Jsearch
+  class Error < StandardError; end
+
+  # Main class
+  class Main
+    def initialize
+      @config   = Configuration.instance
+      @printer  = Printer.new(@config.silent)
+      header
+
+      @searcher = Searcher.new(@config, @printer)
+
+      raise "You need to specify a class to search!" unless @config.cls
+    rescue StandardError => e
+      @printer.error e.message
+    end
+
+    private
+
+    def header
+      @printer.print "Jsearch #{Jsearch::VERSION}\n\n".bold
+      @printer.print "Searching for class: #{@config.cls.cyan}\n"
+    rescue StandardError
+      nil
+    end
+  end
+end
+
+Jsearch::Main.new

data/sig/jsearch.rbs

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: jsearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eustaquio Rangel
+bindir: exe
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Search Java classes info, and return package and import statements
+email:
+- taq@eustaquiorangel.com
+executables:
+- jsearch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- exe/jsearch
+- lib/jsearch.rb
+- lib/jsearch/cache.rb
+- lib/jsearch/color.rb
+- lib/jsearch/configuration.rb
+- lib/jsearch/printer.rb
+- lib/jsearch/searcher.rb
+- lib/jsearch/version.rb
+- sig/jsearch.rbs
+homepage: https://github.com/taq/jsearch
+licenses: []
+metadata:
+  homepage_uri: https://github.com/taq/jsearch
+  source_code_uri: https://github.com/taq/jsearch
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Search Java classes info.
+test_files: []