gh-trending 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 808ee3a7194a4284ee546f7ab167c69ac24439e7
-  data.tar.gz: 0422c8cea905cce431bffcf2ee90df020667725f
+  metadata.gz: 461ee5d745b9d3b316bd3cb709efbcdeeb7507ea
+  data.tar.gz: 2d2a4630245ab5e3bae4f35f64091fa8896fe942
 SHA512:
-  metadata.gz: d9b0d3524ea69290beeef5ec6125ae3b63887e1b4f6089af804f8013f023adf0829a9f2ab22b41f6c07a11e67dcc14cd2880e3a9a2c5bef36c542d54f91d65ca
-  data.tar.gz: 8f7e52cc4977c77222b65fed750cefb0344716c9c3105dedd66481a4ba210bcb3a7bd504e46630f543472ed8721d4392f3e6cc944bea53f0542b2c472c523d08
+  metadata.gz: 3b09330b0ae4a00ab8941a18e21e330a719ac0477dc7741e8c7e2b0b8ed78b867c6b331fd73ab92048b9aaef9843b2fa96efb995de6d43cba9ed95ac539b5aef
+  data.tar.gz: 66225f25a11535bca3c1004927cf28f87733fd5d51336a10841e830dd76ddca1349adbc8b1e4b8647b846b041468a7c3c68dcf18c25d4d23c7d5c7bce3e0aa36

data/lib/gh_trending/developer.rb

@@ -5,7 +5,11 @@ module Gh
     class Developer
       attr_reader :full_name, :user_profile_url, :hot_repository_url
 
-      def initialize(full_name: nil, user_profile_url: nil, hot_repository_url: nil)
+      def initialize(
+        full_name: nil,
+        user_profile_url: nil,
+        hot_repository_url: nil
+      )
         @full_name = full_name || ''
         @user_profile_url = user_profile_url || ''
         @hot_repository_url = hot_repository_url || ''

data/lib/gh_trending/developers.rb

@@ -5,6 +5,8 @@ require 'gh_trending/developer'
 
 module Gh
   module Trending
+    # Returns an array of representation of the trending developers in github.
+    # Usage example: Gh::Trending::Developers.new.get(language: 'ruby')
     class Developers
       attr_reader :developers_list
 

data/lib/gh_trending/parsers/developers_parser.rb

@@ -4,17 +4,21 @@ module Gh
       # Parses the trending developers page
       class DevelopersParser < Parser
         LIST_WITH_DEVS_NODES_HTML_CLASS = 'ol.leaderboard-list'.freeze
-        H2_WITH_DEVELOPER_NAME  = 'h2.user-leaderboard-list-name'.freeze
-        ANCHOR_WITH_HOT_REPOSITORY      = 'a.repo-snipit'.freeze
+        H2_WITH_DEVELOPER_NAME = 'h2.user-leaderboard-list-name'.freeze
+        ANCHOR_WITH_HOT_REPOSITORY = 'a.repo-snipit'.freeze
         SPAN_WITH_FULL_NAME = 'span.full-name'.freeze
-        REGEXP_FOR_FULLNAME = /\((.+)\)/.freeze
+        REGEXP_FOR_FULLNAME = /\((.+)\)/
 
         def parse(parser_args)
           url = build_request_url_with(parser_args)
           page = agent.get(url)
           parsed_page = page.at(LIST_WITH_DEVS_NODES_HTML_CLASS)
 
-          raise Gh::Trending::Parsers::HtmlChangedError.new(:front_page_with_devs) if parsed_page.nil?
+          if parsed_page.nil?
+            changed_page = :front_page_with_devs
+            raise Gh::Trending::Parsers::HtmlChangedError.new(changed_page)
+          end
+
           devs = parsed_page.search('li')
           build_developers_from_node devs
         end
@@ -25,11 +29,13 @@ module Gh
 
         private
 
-        def build_developers_from_node developers_node
-          developers_node.map { |dev_node| Developer.new extract_developer_info dev_node }
+        def build_developers_from_node(developers_node)
+          developers_node.map do |dev_node|
+            Developer.new extract_developer_info dev_node
+          end
         end
 
-        def extract_developer_info developer_node
+        def extract_developer_info(developer_node)
           {
             full_name: get_full_name(developer_node),
             hot_repository_url: get_hot_repository_url(developer_node),
@@ -37,21 +43,22 @@ module Gh
           }
         end
 
-        def get_profile_url dev_node
+        def get_profile_url(dev_node)
           parsed_url = dev_node.search(H2_WITH_DEVELOPER_NAME)
-                  .children
-                  .search('a')[0]
-                  .attributes['href']
-                  .value
+                               .children
+                               .search('a')[0]
+                               .attributes['href']
+                               .value
           build_github_url(parsed_url)
         end
 
-        def get_hot_repository_url dev_node
-          parsed_url = dev_node.search(ANCHOR_WITH_HOT_REPOSITORY)[0].attributes['href'].value
+        def get_hot_repository_url(dev_node)
+          parsed_url = dev_node.search(ANCHOR_WITH_HOT_REPOSITORY)[0]
+                               .attributes['href'].value
           build_github_url(parsed_url)
         end
 
-        def get_full_name dev_node
+        def get_full_name(dev_node)
           span_with_full_name = dev_node.search(SPAN_WITH_FULL_NAME)
           return nil if span_with_full_name.empty?
 

data/lib/gh_trending/parsers/html_changed_error.rb

@@ -12,7 +12,9 @@ module Gh
           @page_that_changed = page_that_changed
           page_changed_human_format = build_human_format_page_changed
 
-          msg ||= "The page can't be crawled anymore because #{page_changed_human_format} changed its HTML format. Submit a PR to fix it!"
+          msg ||= 'The page can\'t be crawled anymore because' \
+                  "#{page_changed_human_format} changed its HTML format." \
+                  'Submit a PR to fix it!'
           super(msg)
         end
 
@@ -21,11 +23,12 @@ module Gh
         def build_human_format_page_changed
           case page_that_changed
           when :front_page_with_repos
-            "the front page that lists all trending repositories"
+            'the front page that lists all trending repositories'
           when :front_page_with_devs
-            "the front page that lists all trending developers"
+            'the front page that lists all trending developers'
           else
-            raise ArgumentError, "Unknown page_that_changed symbol: #{page_that_changed}"
+            error = "Unknown page_that_changed symbol: #{page_that_changed}"
+            raise ArgumentError, error
           end
         end
       end

data/lib/gh_trending/parsers/parser.rb

@@ -3,6 +3,7 @@ require 'mechanize'
 module Gh
   module Trending
     module Parsers
+      # Abstract parser of the trending page.
       class Parser
         attr_reader :agent
 

data/lib/gh_trending/parsers/parser_arguments.rb

@@ -18,7 +18,7 @@ module Gh
         TIME_PERIOD_ARG = :time_period
         LANGUAGE_ARG    = :language
 
-        KNOWN_TIME_PERIODS = %i(daily weekly monthly)
+        KNOWN_TIME_PERIODS = %i[daily weekly monthly].freeze
         DEFAULT_TIME_PERIOD = KNOWN_TIME_PERIODS.first
 
         def initialize(**args)
@@ -42,7 +42,12 @@ module Gh
 
         def sanitize_time_period(time_period)
           return nil if time_period.nil?
-          raise UnknownTimePeriod.new("The time period '#{time_period}' is invalid. Supported: #{KNOWN_TIME_PERIODS}") unless KNOWN_TIME_PERIODS.include? time_period
+
+          unless KNOWN_TIME_PERIODS.include? time_period
+            error_msg = "The time period '#{time_period}' is invalid. " \
+                        "Supported: #{KNOWN_TIME_PERIODS}"
+            raise UnknownTimePeriod.new(error_msg)
+          end
 
           time_period
         end

data/lib/gh_trending/parsers/repos_parser.rb

@@ -13,7 +13,12 @@ module Gh
           page = agent.get(url)
           parsed_page = page.at(LIST_WITH_REPO_NODES_HTML_CLASS)
 
-          raise Gh::Trending::Parsers::HtmlChangedError.new(:front_page_with_repos) if parsed_page.nil?
+          if parsed_page.nil?
+            changed_page = :front_page_with_repos
+            error = Gh::Trending::Parsers::HtmlChangedError.new(changed_page)
+            raise error
+          end
+
           repositories = parsed_page.search('li')
           build_repositories_from_node(repositories)
         end
@@ -24,11 +29,13 @@ module Gh
 
         private
 
-        def build_repositories_from_node repositories_node
-          repositories_node.map { |repo_node| Repository.new extract_repo_data repo_node }
+        def build_repositories_from_node(repositories_node)
+          repositories_node.map do |repo_node|
+            Repository.new extract_repo_data repo_node
+          end
         end
 
-        def extract_repo_data repo_node
+        def extract_repo_data(repo_node)
           {
             name:         get_name(repo_node),
             description:  get_description(repo_node),
@@ -38,19 +45,19 @@ module Gh
           }
         end
 
-        def get_name repo_node
+        def get_name(repo_node)
           repo_node.search('h3')[0].children[1].attributes['href'].value
         end
 
-        def get_description repo_node
+        def get_description(repo_node)
           repo_node.search(DIV_WITH_DESCRIPTION).text.strip
         end
 
-        def get_language repo_node
+        def get_language(repo_node)
           repo_node.search(SPAN_WITH_LANGUAGE).text.strip
         end
 
-        def get_stars repo_node
+        def get_stars(repo_node)
           string_with_stars = repo_node.search(SPAN_WITH_STARS).text.strip
           # Github shows the string "1,263 stars this week"
           # Lets strip only the number.
@@ -65,7 +72,11 @@ module Gh
         end
 
         def get_repo_url(repo_node)
-          parsed_url = repo_node.search('h3').children.search('a')[0].attributes['href'].value
+          parsed_url = repo_node.search('h3')
+                                .children
+                                .search('a')[0]
+                                .attributes['href']
+                                .value
           build_github_url(parsed_url)
         end
       end

data/lib/gh_trending/repositories.rb

@@ -6,6 +6,8 @@ require 'gh_trending/parsers/html_changed_error'
 
 module Gh
   module Trending
+    # Returns an array of representation of the trending repositories in github.
+    # Usage example: Gh::Trending::Repositories.new.get(language: 'ruby')
     class Repositories
       attr_reader :repos_list
 

data/lib/gh_trending/repository.rb

@@ -4,9 +4,15 @@ module Gh
     # repositories page.
     class Repository
       attr_reader :name, :description, :language, :period_stars, :url
-      # Period stars correspond to the stars that the repository has in the current
-      # period being considered, for example: 283 stars THIS WEEK.
-      def initialize(name: nil, description: nil, language: nil, period_stars: nil, url: nil)
+      # Period stars correspond to the stars that the repository has in the
+      # current period being considered, for example: 283 stars THIS WEEK.
+      def initialize(
+        name: nil,
+        description: nil,
+        language: nil,
+        period_stars: nil,
+        url: nil
+      )
         @name = name                  || ''
         @description = description    || ''
         @language = language          || ''

data/lib/gh_trending/version.rb

@@ -1,5 +1,5 @@
 module Gh
   module Trending
-    VERSION = "1.0.0"
+    VERSION = '1.0.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh-trending
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - luispcosta