mdn_query 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80ea4f6f65d473f50f9f4c14a06137c4c8a33231
-  data.tar.gz: 893ee7f7c9439f46f84e27de7c44f2958b276f3b
+  metadata.gz: 755325c7f45bdc963b9c6aa60fdddd23be5a73f4
+  data.tar.gz: 103295f249a9cdb8daa01dccbcb24de5b18ffb0d
 SHA512:
-  metadata.gz: 156b7420731927a3c003014c4fdba0628cb24ffcdb5660ae6f1bab2844b2f3228b4aa40dcd5066fdfa3c7885a92d720961c69b7db989ea0508232ad6d9d56e2d
-  data.tar.gz: 487e05bf5a4968c63f512ec86393f8b4a8b43069d0a87f8bef4dfca6fab986cc01f0a111717044d06d57fd962ee20f43d360660ebc0442c33bad6e93e4322c45
+  metadata.gz: 678e20a9c3157a4a9ec72fba31d5442cfd440021cc8e9a3e37f7ec5f46ae53f81c6ccfdf429858ee415bee5e0df52d9b5eec8c83ae0bcfb9e461294c553e1483
+  data.tar.gz: f3742027b799b16b8971bb9c1fda599e803296cce71c3a28663c0ac90aab5772f203db0d44a79ca7fb61b7f20002ede96a362c3d241504a4a842f4e4df7f18af

data/.codeclimate.yml

@@ -0,0 +1,10 @@
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- test/

data/.travis.yml

@@ -12,5 +12,7 @@ matrix:
   allow_failures:
     - rvm: ruby-head
   fast_finish: true
+after_success:
+  - bundle exec codeclimate-test-reporter
 notifications:
   email: false

data/README.md

@@ -1,6 +1,9 @@
 # MdnQuery
 
+[![Gem Version][gem-badge]][gem]
 [![Build Status][travis-img]][travis]
+[![Code Climate][codeclimate-badge]][codeclimate]
+[![Test Coverage][coverage-badge]][coverage]
 
 Query the [Mozilla Developer Network][mdn] documentation. Unfortunately they do
 not provide an API to fetch the documentation entries, which means that all
@@ -10,6 +13,8 @@ retrieve a single entry based on a search term, which is frequently desired as
 a precise search term almost always yields the concrete entry as the first
 result.
 
+[Documentation][docs]
+
 ## CLI
 
 The binary `mdn-query` provides an interactive command line interface to easily
@@ -142,7 +147,14 @@ Bug reports and pull requests are welcome on [GitHub][github-repo].
 
 The gem is available as open source under the terms of the [MIT License][mit].
 
+[codeclimate]: https://codeclimate.com/github/jungomi/mdn_query
+[codeclimate-badge]: https://codeclimate.com/github/jungomi/mdn_query/badges/gpa.svg
+[coverage]: https://codeclimate.com/github/jungomi/mdn_query/coverage
+[coverage-badge]: https://codeclimate.com/github/jungomi/mdn_query/badges/coverage.svg
 [demo]: screenshots/demo.gif
+[docs]: http://www.rubydoc.info/gems/mdn_query
+[gem]: https://badge.fury.io/rb/mdn_query
+[gem-badge]: https://badge.fury.io/rb/mdn_query.svg
 [github-repo]: https://github.com/jungomi/mdn-query
 [mdn]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
 [mit]: http://opensource.org/licenses/MIT

data/lib/mdn_query/document.rb

@@ -7,6 +7,26 @@ module MdnQuery
     # @return [MdnQuery::Section] the top level section
     attr_reader :section
 
+    # Creates a document filled with the content of the URL.
+    #
+    # @param url [String] the URL to the document on the web
+    # @return [MdnQuery::Document]
+    def self.from_url(url)
+      begin
+        response = RestClient::Request.execute(method: :get, url: url,
+                                               headers: { accept: 'text/html' })
+      rescue RestClient::Exception, SocketError => e
+        raise MdnQuery::HttpRequestFailed.new(url, e),
+              'Could not retrieve entry'
+      end
+      dom = Nokogiri::HTML(response.body)
+      title = dom.css('h1').text
+      article = dom.css('article')
+      document = new(title, url)
+      MdnQuery::TraverseDom.fill_document(article, document)
+      document
+    end
+
     # Creates a new document with an initial top level section.
     #
     # @param title [String] the titel of the top level section

data/lib/mdn_query/entry.rb

@@ -14,6 +14,7 @@ module MdnQuery
       @title = title
       @description = description
       @url = url
+      @content = nil
     end
 
     # Returns the string representation of the entry.
@@ -40,23 +41,7 @@ module MdnQuery
     # @return [MdnQuery::Document] the content of the entry
     def content
       return @content unless @content.nil?
-      @content = retrieve(url)
-    end
-
-    private
-
-    def retrieve(url)
-      begin
-        response = RestClient::Request.execute(method: :get, url: url,
-                                               headers: { accept: 'text/html' })
-      rescue RestClient::Exception, SocketError => e
-        raise MdnQuery::HttpRequestFailed.new(url, e),
-              'Could not retrieve entry'
-      end
-      dom = Nokogiri::HTML(response.body)
-      title = dom.css('h1').text
-      article = dom.css('article')
-      MdnQuery::TraverseDom.create_document(article, title, url)
+      @content = MdnQuery::Document.from_url(url)
     end
   end
 end

data/lib/mdn_query/search.rb

@@ -28,6 +28,7 @@ module MdnQuery
       @highlight = options[:highlight] || false
       @html_attributes = options[:html_attributes]
       @topics = options[:topics] || ['js']
+      @result = nil
     end
     # rubocop:enable Metrics/LineLength
 
@@ -51,7 +52,7 @@ module MdnQuery
     #
     # @return [MdnQuery::SearchResult] the search result
     def execute
-      @result = retrieve(url, @query)
+      @result = MdnQuery::SearchResult.from_url(url)
     end
 
     # Fetches the next page of the search result.
@@ -66,7 +67,7 @@ module MdnQuery
       elsif @result.next?
         query_url = url
         query_url << "&page=#{@result.current_page + 1}"
-        @result = retrieve(query_url, @query)
+        @result = MdnQuery::SearchResult.from_url(query_url)
       end
     end
 
@@ -82,7 +83,7 @@ module MdnQuery
       elsif @result.previous?
         query_url = url
         query_url << "&page=#{@result.current_page - 1}"
-        @result = retrieve(query_url, @query)
+        @result = MdnQuery::SearchResult.from_url(query_url)
       end
     end
 
@@ -93,19 +94,5 @@ module MdnQuery
       html_url = url.sub('.json?', '?')
       Launchy.open(html_url)
     end
-
-    private
-
-    def retrieve(url, query)
-      begin
-        response = RestClient::Request.execute(method: :get, url: url,
-                                               headers: { accept: 'json' })
-      rescue RestClient::Exception, SocketError => e
-        raise MdnQuery::HttpRequestFailed.new(url, e),
-              'Could not retrieve search result'
-      end
-      json = JSON.parse(response.body, symbolize_names: true)
-      MdnQuery::SearchResult.new(query, json)
-    end
   end
 end

data/lib/mdn_query/search_result.rb

@@ -13,13 +13,28 @@ module MdnQuery
     # @return [Fixnum] the total number of entries
     attr_reader :total
 
+    # Creates a search result with the results from the URL.
+    #
+    # @param url [String] the URL to the search result on the web
+    # @return [MdnQuery::SearchResult]
+    def self.from_url(url)
+      begin
+        response = RestClient::Request.execute(method: :get, url: url,
+                                               headers: { accept: 'json' })
+      rescue RestClient::Exception, SocketError => e
+        raise MdnQuery::HttpRequestFailed.new(url, e),
+              'Could not retrieve search result'
+      end
+      json = JSON.parse(response.body, symbolize_names: true)
+      new(json)
+    end
+
     # Creates a new search result.
     #
-    # @param query [String] the query that was searched for
     # @param json [Hash] the hash version of the JSON response
     # @return [MdnQuery::SearchResult]
-    def initialize(query, json)
-      @query = query
+    def initialize(json)
+      @query = json[:query]
       @pages = {
         count: json[:pages] || 0,
         current: json[:page]

data/lib/mdn_query/version.rb

@@ -1,4 +1,4 @@
 module MdnQuery
   # The version of the gem
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/mdn_query.gemspec

@@ -29,9 +29,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tty-prompt', '~> 0.7'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 11.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'rubocop', '~> 0.43'
   spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdn_query
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Jungo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-05 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Query the MDN docs
 email:
 - michaeljungo92@gmail.com
@@ -186,6 +200,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"