Rudisco

Description

Gems local database (based on Rubygems). Includes information about ~ 126000 gems.

Table gems consist of next columns: name, description, authors, version, license, sha, source_code_url and more. Full table structure described in gem.rb file.

Installation

  $ gem install rudisco

Usage

Database usage example

  gems = Rudisco::Gem # Sequel::Model
  
  top = gems.where{ total_downloads > 50000000 }
            .select(:name, :description, :source_code_url)
  
  top.each do |record|
    puts record[:name]
    puts record[:description]
    puts record[:source_code_url] if record[:source_code_url]
    puts
  end

Simple search gems by selected phrase

  phrase = 'rails'
  gems = Rudisco::Gem.find_phrase(phrase)
                     .select(:name, :description)
  
  gems.each do |record|
    puts record[:name]
    puts record[:description]
    puts
  end

Open documentation and download gems

  path_to_load = File.join(__dir__, '..', 'tmp')
  
  sample = Rudisco::Gem.exclude(source_code_url: '').first
  sample.action(:open_sources)
        .action(:git_clone, path: path_to_load)
        
  sample2 = Rudisco::Gem.limit(2)
  sample2.action(:download, path: path_to_load)

Update database

Through CLI

  $ gem install rudisco
  $ rudisco update

By #deep_scanning call

  require 'rudisco'
  
  Rudisco::Gem.deep_scanning

CLI

Commands list

  $ rudisco clone GEM_NAME     # Clones gem sources from git
  $ rudisco download GEM_NAME  # Downloads a gem
  $ rudisco find PHRASE        # Searches phrase in gem name or description
  $ rudisco open GEM_NAME      # Opens gem page on rubygems.org
  $ rudisco show GEM_NAME      # Shows detailed information about single gem
  $ rudisco update             # Updates database

Todo

CLI statistic (database&program statistic) commands.
Tests coverage.

Dependencies

Ruby 2.1.0 or higher
sqlite3 ~> 1.3.13
sequel ~> 4.42.1

License

Released under the MIT License. See the LICENSE file for further details.

rudisco

Runtime