factorio-mod 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eab89026d714d5fe2035918a550368313b0d4f03214e0df9bfa87c9689891b51
-  data.tar.gz: 8bdf056b0f5b5435ac4d4207c06172e835d4c1767c9464af988dfaec2a6c90bf
+  metadata.gz: adcb31d23a6438f33528e0690b06f8134759979b6d4fc7fbce2f9fb25f3cbc13
+  data.tar.gz: 07df7cc9b6882fe8248f123b9f88896041099c6cc2d55964473a8d5aebf71b44
 SHA512:
-  metadata.gz: 19ba0055879c601bda30be33d49064ee947e84d37da76a75ee480fb285f85f61b5da82b0d1ad2d755633c1e263902af6bba735de443a6ec1e62de9f8a6525936
-  data.tar.gz: e8fd3a9596712a8d580eeb38046d995bd66db2a400f9b80bd4356e33a2f8182cc6a01a562c969d1fc6033ff6532506a298d5229670497157ab955937525a8712
+  metadata.gz: 8039d46e1b26cc7241af59ad447ed76b10e9975e72875da517d1d24342dbebf9c866af9a9aaa287393892b1cc62b3a9b6b97531be2620934d97f7ac611482632
+  data.tar.gz: a3860020ad29e8e513c02b30a1e77ce6829ffab221f35a7d142c0ded64bc15001fa252ee4ac9c8a7a0326d1992447ba2c2f67fb703661bf65542e3fea5b4640d

data/.gitlab-ci.yml

@@ -5,11 +5,11 @@ before_script:
   - ruby -v
   - which ruby
   - gem install bundler --no-ri --no-rdoc
-  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+  - bin/setup
 
 rspec:
   script:
-    - bundle exec rspec
+    - bundle exec rake spec
 
 rubocop:
   script:

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factorio-mod (0.2.2)
+    factorio-mod (0.3.0)
       nokogiri (~> 1.8)
 
 GEM

data/README.md

@@ -21,13 +21,13 @@ Or install it yourself as:
 
 ## Usage
 
-See `spec` directory
+See `spec` directory or https://www.rubydoc.info/gems/factorio-mod
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` 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 by `rake bump`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version by `bundle exec rake bump`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/factorio/mod.rb

@@ -1,6 +1,7 @@
 require 'factorio/mod/version'
 
 require 'factorio/mod/mod'
+require 'factorio/mod/download'
 require 'factorio/mod/exception'
 require 'factorio/mod/cache'
 

data/lib/factorio/mod/cache.rb

@@ -1,43 +1,48 @@
 module Factorio
-  # cache mod info
+  # Cache mod info
   class Cache
-    attr_reader :gotten
+    attr_reader :cache
 
+    # @param uri [String] Mod URI like `https://mods.factorio.com/mod/LTN-easier`
     def initialize(uri, cookie = '')
       @uri = uri
       @cookie = cookie
-      @gotten = {}
-      @gotten.default = false
+      @cache = {}
     end
 
-    def mod
-      get :mod, @uri
+    # Get the `Information` page.
+    # @return [Nokogiri::HTML]
+    def information
+      get :information, @uri
     end
 
-    def download
-      get :download, "#{@uri}/downloads"
+    # Get the `Downloads` page.
+    # @return [Nokogiri::HTML]
+    def downloads
+      get :downloads, "#{@uri}/downloads"
     end
 
-    def any
-      if gotten[:mod]
-        mod
-      elsif gotten[:download]
-        download
+    # Get any page that already downloads.
+    # Get _better_(default information) mod page if none of the pages exist.
+    # @param better [Symbol] get which page if none of the pages exist.
+    # @return [Nokogiri::HTML]
+    def any(better = :information)
+      if @cache.key? :information
+        information
+      elsif @cache.key? :downloads
+        downloads
       else
-        send %i[mod download][rand(2)]
+        send better
       end
     end
 
     private
 
+    # Get from cache or download page
     def get(symbol, uri)
       symbol = symbol.to_sym
-      return instance_variable_get "@#{symbol}" if @gotten[symbol]
-      instance_variable_set "@#{symbol}", Nokogiri::HTML(
-        URI.open(uri, 'Cookie' => @cookie)
-      )
-      @gotten[symbol] = true
-      instance_variable_get "@#{symbol}"
+      return @cache[symbol] if @cache.key? symbol
+      @cache[symbol] = Nokogiri::HTML(URI.open(uri, 'Cookie' => @cookie))
     rescue OpenURI::HTTPError => e
       raise NoMODError.new @name, e.io
     end

data/lib/factorio/mod/download.rb

@@ -0,0 +1,20 @@
+module Factorio
+  class Mod
+    # store the entry of the _download_
+    Download = Struct.new(:version, :game_version, :uri, :date, :times) do
+      # `Download` page table header to attribute symbol
+      TABLE_HEADER_TO_SYM = {
+        'Version'      => :version,
+        'Game Version' => :game_version,
+        'Download'     => :uri,
+        'Release Date' => :date,
+        'Downloads'    => :times
+      }.freeze
+
+      # set value by String name
+      def set(name, value)
+        self[TABLE_HEADER_TO_SYM[name]] = value
+      end
+    end
+  end
+end

data/lib/factorio/mod/exception.rb

@@ -1,5 +1,5 @@
 module Factorio
-  # The Exception for can't find MOD
+  # The Exception that can't find MOD
   class NoMODError < StandardError
     attr_reader :io
     def initialize(msg, io)
@@ -8,14 +8,14 @@ module Factorio
     end
   end
 
-  # The Exception for not logged in
+  # The Exception that not logged in
   class NotLoginError < StandardError
     def initialize(msg = 'Not logged in')
       super
     end
   end
 
-  # The Exception for can't find download
+  # The Exception that can't find download
   class NoDownloadError < StandardError
     def initialize(msg)
       super

data/lib/factorio/mod/mod.rb

@@ -1,22 +1,25 @@
 module Factorio
-  # Main class
+  # Info interface
+  #
+  # example:
+  #
+  # ```
+  # mod = Factorio::Mod.new 'LTN-easier'
+  # puts "The author of #{mod.title} is #{mod.author}"
+  # puts "The #{mod.title} is under #{mod.license}"
+  # puts "It latest version can download at #{mod.latest_download[:uri]}"
+  # puts "It latest version for factorio 0.16 can download at " \
+  #   "#{mod.latest_download('0.16')[:uri]}"
+  # ```
   class Mod
+    # factorio Mod portal website URI
     MOD_URI = 'https://mods.factorio.com'.freeze
 
-    TABLE_HEAD_TO_GOOD_NAME = {
-      'Version'      => :version,
-      'Game Version' => :game_version,
-      'Release Date' => :date,
-      'Downloads'    => :download_times
-    }.freeze
-    private_constant :TABLE_HEAD_TO_GOOD_NAME
-
-    # Get the mod name
     attr_reader :name
     alias id name
     alias string_id name
 
-    # @param name [String] name of mod
+    # @param name [String] name of the Mod
     # @param cookie [String] logged in cookie
     def initialize(name, cookie = '')
       @name = name
@@ -25,14 +28,15 @@ module Factorio
 
     private
 
+    # Get the meta table from Information page.
     def data_table(key = '')
-      table = @mod.mod.xpath("//div[@class='mod-page-data-table']")
+      table = @mod.information.xpath("//div[@class='mod-page-data-table']")
       return table if key == ''
       xpath = "//td[../td[@class='data-name'][.='#{key}:']]"
       table.xpath xpath
     end
 
-    # @return [String, String] csrf_token and cookie
+    # @return [String, String] `csrf_token` and cookie
     def self.csrf_and_cookie
       resp = open 'https://mods.factorio.com/login'
       cookie = resp.meta['set-cookie'].split('; ')[0]
@@ -44,25 +48,31 @@ module Factorio
     public
 
     # rubocop:disable MethodLength
-    def self.bind_td_to_th(table_head, line)
-      line.css('td').each_with_index.each_with_object({}) \
+
+    # Map each value with table header.
+    # @param table_header [Array] table header in order
+    # @param line [Nokogiri::HTML] `<tr>`
+    # @return [Hash] table with the table header as key
+    def self.bind_td_to_th(table_header, line)
+      line.css('td').each_with_index.each_with_object(Download.new) \
         do |(item, index), obj|
-        key = table_head[index]
+        key = table_header[index]
         if key == 'Download'
           href = item.xpath('a/@href').to_s
           raise NotLoginError if href =~ %r{^/login}
-          obj[:uri] = MOD_URI + href
+          obj.uri = MOD_URI + href
         else
-          obj[TABLE_HEAD_TO_GOOD_NAME[key]] = item.text
+          obj.set(key, item.text)
         end
       end
     end
+
     # rubocop:enable MethodLength
 
-    # Get logged in cookie
+    # Get the logged in cookie.
     # @param username [String]
     # @param password [String]
-    # @return [String] cookie
+    # @return [String] The logged in cookie
     def self.login_cookie(username, password)
       csrf_token, cookie = csrf_and_cookie
       data = URI.encode_www_form(
@@ -74,74 +84,74 @@ module Factorio
       resp.response['set-cookie'].split('; ')[0]
     end
 
-    # Get the title (or display name) of MOD
-    # @return [String] mod title
+    # Get the title (also known as _display name_) of the Mod
+    # @return [String] title
     def title
       @mod.any.css('.mod-card-title *').text
     end
     alias display_name title
 
-    # Get the summary of MOD
-    # @return [String] mod summary
+    # Get the summary of the Mod
+    # @return [String] summary
     def summary
       @mod.any.css('.mod-card-summary').text
     end
 
-    # Get github uri
-    # @return [String] github uri
+    # Get the GitHub URI.
+    # @return [String] GitHub URI
     def github
       uri = data_table('Source').xpath('a/@href').to_s
       return if uri.empty?
       uri
     end
 
-    # Get git repo uri
-    # @return [String] git uri
+    # Get the git repo URI that can be cloned.
+    # @return [String] git URI
     def git
       return if github.nil?
       github + '.git'
     end
 
-    # Get license
+    # Get the license that the Mod use.
     # @return [String] license name
     def license
       data_table('License').xpath('a').text
     end
 
-    # Get license uri
-    # @return [String] license uri
+    # Get the license URI.
+    # @return [String] license URI
     def license_uri
       data_table('License').xpath('a/@href').to_s
     end
 
-    # Get author
+    # Get the author of the Mod.
     # @return [String] author
     def author
       data_table('Owner').xpath('a').text
     end
 
-    # Get download times
-    # @return [Integer] download times
+    # Get the totle number of downloads of Mod.
+    # @return [Integer] number of downloads
     def download_times
       xpath = "//span[@class='mod-card-info-tag'][@title='Downloads']/div"
       @mod.any.xpath(xpath).text.to_i
     end
 
-    # Ge latest download
+    # Get the latest _download_ of the Mod.
     # @param version [String] factorio version
-    # @return [Hash] with version game_version date download_times uri
+    # @return [Download]
     def latest_download(version = '')
       return download_list.last if version == ''
       download_list.each do |download|
-        return download if download[:game_version] == version.to_s
+        return download if download.game_version == version.to_s
       end
       raise NoDownloadError, "Can't found #{name} for factorio #{version}"
     end
 
-    # Get all version info
-    # @return [Array<Hash>] with version game_version date download_times uri
+    # Get the _download_ for all of version.
+    # @return [Array<Download>]
     def download_list
-      table = @mod.download.css 'table.mod-page-downloads-table'
+      table = @mod.downloads.css 'table.mod-page-downloads-table'
       head = table.css('thead tr th').map(&:text)
       table.css('tbody tr').map do |line|
         Mod.bind_td_to_th head, line

data/lib/factorio/mod/version.rb

@@ -1,5 +1,5 @@
 module Factorio
   class Mod
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factorio-mod
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - 71e6fd52
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-03 00:00:00.000000000 Z
+date: 2018-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -129,6 +130,7 @@ files:
 - factorio-mod.gemspec
 - lib/factorio/mod.rb
 - lib/factorio/mod/cache.rb
+- lib/factorio/mod/download.rb
 - lib/factorio/mod/exception.rb
 - lib/factorio/mod/mod.rb
 - lib/factorio/mod/version.rb