rudisco 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96a8153da4c9000bc97fd6002722c56ab8b6a43b
+  data.tar.gz: 1f82e722e9ed26c5eb72457eca89e3a326b43842
+SHA512:
+  metadata.gz: 266e7f221800b475a8af008b75556460f496b90c6579e04144cc37fa4e4a516c0695fea0b9622e5f9cbea67cb32e2a95162d0a0aeb1f0fb286aa1831cbb8a69d
+  data.tar.gz: 77fa868a5cdf7497bc4d4cdc93732ccacf683185215a7007ee2c5c41dcebc697b97b6c354d82fc6f942a0de94fb1549afd47d5c8fdf13eb983b103100db4adf0

data/Gemfile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'webmock',                        '~> 2.3.1', require: false
+  gem 'rspec',                          '~> 3.5.0', require: false
+end

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'bundler'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+task default: :spec
+
+path_to_rakes = File.join __dir__, 'rakefiles'
+Dir.glob(File.join(path_to_rakes, '**/*')).each do |file|
+  import file if File.extname(file) == '.rake'
+end

data/bin/rudisco

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require File.join(__dir__, '..', 'sources', 'rudisco')
+
+Rudisco::CLI::Application.start ARGV

data/license.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) <2016> Kuzichev Michael
+
+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/rakefiles/rudisco.rake

@@ -0,0 +1,21 @@
+# encoding: utf-8
+namespace 'Rudisco' do
+  desc "(long-term task) Starts multithread Rudisco::Gem table update"
+  task 'update' do
+    require File.join(__dir__, '..', 'sources', 'rudisco.rb')
+
+    puts "task Rudisco:update launched!"
+
+    Rudisco::Gem.surface_scanning
+    totally_updated, outdated =
+      0, Rudisco::Gem.where(need_update: true).count
+
+    Rudisco::Gem.deep_scanning do |updated_count|
+      totally_updated += updated_count
+      print "Updated: #{totally_updated}/#{outdated}\r"
+      $stdout.flush
+    end
+
+    puts "task Rudisco:update completed the job."
+  end # task 'update'
+end # namespace 'Rudisco'

data/readme.md

@@ -0,0 +1,106 @@
+# Rudisco [![Build Status](https://travis-ci.org/Medvedu/rudisco.svg?branch=master)](https://travis-ci.org/Medvedu/rudisco)
+
+## Description
+ 
+Gems local database (based on [Rubygems](https://rubygems.org)). 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
+
+```shell
+  $ gem install rudisco
+```
+
+## Usage
+
+### Database usage example
+
+```ruby
+  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
+
+```ruby
+  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
+
+```ruby
+  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
+
+#### Throw CLI
+
+```shell
+  $ gem install rudisco
+  $ rudisco update
+```
+
+#### By #deep_scanning call
+
+```ruby
+  require 'rudisco'
+  
+  Rudisco::Gem.deep_scanning
+```
+
+## CLI
+
+![Alt text](./docs/images/image.jpg)
+
+### commands list
+
+```shell
+  $ 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
+
+  * Integrate with Github for better search results.
+  * Add CLI open (opens any url associated with gem in browser) & 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](./license.md) file for further details.

data/sources/rudisco/cli/cli.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Application < Thor
+    desc "find PHRASE", "Searches phrase in gem name or description"
+    method_option :limit,
+                  :aliases  => "-l",
+                  :type     => :numeric,
+                  :default  => 75,
+                  :desc     => "Limits search result. By default it shows 75 most popular gems",
+                  :banner   => "Search result limit (75 gems by default)"
+
+    def find(phrase)
+      records = Gem.find_phrase(phrase)
+                   .order_by(Sequel.desc(:total_downloads))
+                   .limit options[:limit]
+
+      Presentation::Find.new(records: records).show
+    end
+
+
+
+    desc "show GEM_NAME", "Shows detailed information about single gem"
+    def show(gem_name)
+      record = Gem.where(name: gem_name)
+                  .first
+
+      Presentation::Show.new(record: record).show
+    end
+
+
+
+    desc "download GEM_NAME", "Downloads a gem"
+    method_option :path,
+                  :aliases  => "-p",
+                  :type     => :string,
+                  :default  => nil,
+                  :desc     => "Path where gem gonna be saved (default: ENV['HOME'])"
+
+    def download(gem_name)
+      record = Gem.where(name: gem_name).first
+
+      if record
+        path = File.expand_path(options[:path] || ENV['HOME'])
+
+        record.action :download, path: path
+        Presentation::Download.new(success: true, path: path).show
+      else
+        raise GemNotFound, gem_name
+      end
+
+    rescue Rudisco::Error => exception
+      Presentation::Download.new(success: false, exception: exception).show
+    end
+
+
+
+    desc "clone GEM_NAME", "Clones gem sources from git"
+    method_option :path,
+              :aliases  => "-p",
+              :type     => :string,
+              :default  => nil,
+              :desc     => "Path where gem gonna be saved (default: ENV['HOME'])"
+
+    def clone(gem_name)
+      record = Gem.where(name: gem_name).first
+
+      if record
+        path = File.expand_path(options[:path] || ENV['HOME'])
+
+        record.action :git_clone, path: path
+        Presentation::GitClone.new(success: true, path: path).show
+      else
+        raise GemNotFound, gem_name
+      end
+
+    rescue Rudisco::Helpers::NotAUrl
+      exception = GemWithoutGitSources.new gem_name
+      Presentation::GitClone.new(success: false, exception: exception).show
+
+    rescue Rudisco::Error => exception
+      Presentation::GitClone.new(success: false, exception: exception).show
+    end
+
+
+
+    desc "update", "Updates database"
+    def update
+      Rudisco::Gem.surface_scanning
+      outdated = Rudisco::Gem.where(need_update: true).count
+      cli_view = Presentation::Update.new(outdated: outdated)
+
+      summary = 0 and cli_view.show
+      if outdated > 0
+        Gem.deep_scanning do |updated|
+          summary += updated
+          cli_view.update(updated: summary)
+        end
+        cli_view.finished
+      end
+    end
+
+    desc "open GEM_NAME", "Opens gem page on rubygems.org"
+    def open(gem_name)
+      record = Gem.where(name: gem_name).first
+
+      if record
+        record.action :open_rubygems
+      else
+        raise GemNotFound, gem_name
+      end
+
+    rescue Rudisco::Error => exception
+      Presentation::Open.new(exception: exception).show
+    end
+
+    class GemNotFound < Error # no-doc
+      def initialize(name); super "Gem '#{name}' not found!" end; end
+
+    class GemWithoutGitSources < Error # no-doc
+      def initialize(name); super "Gem '#{name}' without git sources!" end; end
+  end # class Application
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation/download.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation::Download < Presentation
+    # @param [HASH] params
+    # @option params  [String, NilClass] :path
+    # @option params [TrueClass, FalseClass] :success
+    # @option params [Exception, NilClass] :exception
+
+    def initialize(**params)
+      @success   = params[:success]
+      @path      = params[:path]
+      @exception = params[:exception]
+    end
+
+    def show # no-doc
+      report message: '', complete: '' do
+        if success
+          download_done
+        else
+          download_failed
+        end
+      end # report
+    end
+
+    private
+
+    def download_done # no-doc
+      header title: 'Download success', width: 80, align: 'center', bold: true
+
+      aligned "Gem was downloaded to #{path}", bold: true, width: 80,
+                                               align: 'center'
+    end
+
+    def download_failed # no-doc
+      header title: 'Download failed', width: 80, align: 'center', bold: true
+
+      aligned "Error message: #{exception.message}", bold: true, width: 80,
+                                                     align: 'center'
+    end
+
+    # @return [String, NilClass]
+
+    attr_reader :path
+
+    # @return [TrueClass, FalseClass]
+
+    attr_reader :success
+
+    # @return [Exception, NilClass]
+
+    attr_reader :exception
+  end # class Presentation::Download
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation/find.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation::Find < Presentation
+    def initialize(**params) # no-doc
+      @records = params[:records]
+    end
+
+    def show # no-doc
+      report message: '', complete: '' do
+        if records.count.zero?
+          nothing_was_found
+        else
+          show_results
+        end
+      end # report
+    end
+
+    private
+
+    # @return Array<Rudisco::Gem>
+
+    attr_reader :records
+
+    def nothing_was_found # no-doc
+      header title: 'Rudisco search results',
+             width: 80, align: 'center',
+             bold: true, timestamp: true
+
+      aligned "Nothing was found. Sorry.", bold: true, width: 80,
+                                           align: 'center'
+    end
+
+    def show_results # no-doc
+      header title: 'Rudisco search results',
+             width: 80, align: 'center',
+             bold: true, timestamp: true
+
+      table(border: true) do
+        row do
+          column '№',            width: 3,  align: 'center'
+          column 'Name',         width: 17, align: 'center'
+          column 'Git',          width: 3,  align: 'center'
+          column 'Description',  width: 46, align: 'center'
+          column 'DW (total)',   width: 10, align: 'center'
+        end
+        records.each_with_index do |rec, index|
+          row do
+            column index
+            column rec.name
+            column source_code_helper(rec.source_code_url)
+            column clear_desc_helper(rec.description)
+            column rec.total_downloads
+          end
+        end
+      end # table
+    end
+
+    ##
+    # Returns copy of +description+ string, but without
+    # special symbols.
+    #
+    # @param [String] description
+    #   Original string.
+    #
+    # @return [String]
+
+    def clear_desc_helper(description)
+      return "N/A" if description.nil? || description.empty?
+
+      tmp = description.dup
+      tmp = tmp.delete "#{1.chr}-#{31.chr}".split.join ' '
+
+      return tmp
+    end
+
+    def source_code_helper(source_code_url) # no-doc
+      if source_code_url.nil? || source_code_url.empty?
+        return "-"
+      else
+        return "+"
+      end
+    end
+  end # class Presentation::Find
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation/git_clone.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation::GitClone < Presentation
+    # @param [HASH] params
+    # @option params  [String, NilClass] :path
+    # @option params [TrueClass, FalseClass] :success
+    # @option params [Exception, NilClass] :exception
+
+    def initialize(**params)
+      @success   = params[:success]
+      @path      = params[:path]
+      @exception = params[:exception]
+    end
+
+    def show # no-doc
+      report message: '', complete: '' do
+        if success
+          git_clone_done
+        else
+          git_clone_failed
+        end
+      end # report
+    end
+
+    def git_clone_done # no-doc
+      header title: 'Gem was cloned!', width: 80, align: 'center',
+                                                  bold: true
+
+      aligned "Path to folder #{path}", bold: true, width: 80, align: 'center'
+    end
+
+    def git_clone_failed # no-doc
+      header title: 'Gem clone failed.', width: 80, align: 'center',
+                                                    bold: true
+
+      aligned "Error message: #{exception.message}", bold: true, width: 80,
+                                                     align: 'center'
+    end
+
+    # @return [String, NilClass]
+
+    attr_reader :path
+
+    # @return [TrueClass, FalseClass]
+
+    attr_reader :success
+
+    # @return [Exception, NilClass]
+
+    attr_reader :exception
+
+  end # class Presentation::GitClone
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation/open.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation::Open < Presentation
+    def initialize(**params) # no-doc
+      @exception = params[:exception]
+    end
+
+    def show # no-doc
+      aligned "Error! Exception: #{exception.message}",
+              bold: true, width: 80, align: 'center'
+    end
+
+    private
+
+    # @return [Exception]
+
+    attr_reader :exception
+  end # Presentation::Open
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation/show.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation::Show < Presentation
+    def initialize(**params) # no-doc
+      @record = params[:record]
+    end
+
+    def show # no-doc
+      report message: '', complete: '' do
+        if record
+          show_detailed_gem_description
+        else
+          gem_not_found
+        end
+      end # report message
+    end
+
+    private
+
+    def gem_not_found # no-doc
+      aligned ""
+      aligned "Gem not found. Sorry.", bold: true, width: 80,
+                                                   align: 'center'
+      aligned ""
+    end
+
+    def show_detailed_gem_description # no-doc
+      table(border: true,  width: 80) do
+        row { column 'Description', width: 80, align: 'center' }
+        row { column record.description }
+      end
+
+      aligned ""
+
+      table(border: false,  width: 80) do
+        row do
+          column 'Total downloads',   width: 18, align: 'center'
+          column 'Version downloads', width: 18, align: 'center'
+          column 'Version',           width: 18, align: 'center'
+          column 'License',           width: 17, align: 'center'
+        end
+        row do
+          column record.total_downloads
+          column record.version_downloads
+          column record.version
+          column record.license
+        end
+      end # table
+
+      aligned ""
+
+      table(border: false,  width: 80) do
+        row do
+          column 'wiki_url',          width: 18, align: 'center'
+          column 'documentation_url', width: 18, align: 'center'
+          column 'mailing_list_url',  width: 18, align: 'center'
+          column 'bug_tracker_url',   width: 17, align: 'center'
+        end
+        row do
+          column url_helper(record.wiki_url)
+          column url_helper(record.documentation_url)
+          column url_helper(record.mailing_list_url)
+          column url_helper(record.bug_tracker_url)
+        end
+      end # table
+
+      aligned ""
+
+      table(border: false,  width: 80) do
+        row do
+          column 'Authors', width: 20, align: 'center', padding: 2
+          column 'Sha',     width: 57, align: 'center', padding: 10
+        end
+        row do
+          column record.authors
+          column record.sha
+        end
+      end # table
+    end
+
+    def url_helper(url) # no-doc
+      if url.nil? || url.empty?
+        return "no"
+      else
+        return "yes"
+      end
+    end
+
+    # @return [Rudisco::Gem]
+
+    attr_reader :record
+  end # class Presentation::Show
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation/update.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation::Update < Presentation
+    def initialize(**params) # no-doc
+      @outdated = params[:outdated]
+
+      self.formatter = 'progress'
+    end
+
+    def show # no-doc
+      header title: 'Update starting...', width: 80, align: 'center',
+             bold: true, timestamp: true
+
+      if outdated.zero?
+        aligned "Nothing to do!", width: 80, align: 'center'
+      else
+        aligned "#{outdated} records going to be added/updated.", width: 80,
+                 align: 'center'
+      end
+    end
+
+    def update(**params) # no-doc
+      print "Updating...#{params[:updated]}/#{outdated}\r"
+      $stdout.flush
+    end
+
+    def finished  # no-doc
+      aligned "Update finished! All records updated!", width: 80,
+                                                       align: 'center'
+    end
+
+    private
+
+    # @return [Integer]
+
+    attr_reader :outdated
+  end # class Presentation::Update
+end # module CLI
+end # module Rudisco

data/sources/rudisco/cli/presentation.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module Rudisco
+module CLI
+  class Presentation # no-doc
+    include CommandLineReporter
+
+    def initialize(**params) # no-doc
+      raise NotImplementedError, "Abstract class called!"
+    end
+
+    def show # no-doc
+      raise NotImplementedError, "Abstract method called!"
+    end
+  end # class Presentation
+end # module CLI
+end # module Rudisco