qiita_trend 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf7e7382a8f459992a654a95bdc666c79fe7bff6379e6e3961d7d2e626c9896
-  data.tar.gz: 3ffc14309f8af1ff9a18f3036d354ff38a80ee6c94c2d74502a82ee71b521c5c
+  metadata.gz: 8557280f29f19f12c0b2f4231de327a2434fde8d00a851d2c32b4e1e6e3f654d
+  data.tar.gz: 673102ee7ada1e88546afa02d69d0b3bf74d905d0cdeef8f489e0f9b0e5d8fc7
 SHA512:
-  metadata.gz: 2419645c6a853799de3391d7e7c56a912eaa836869a99334d82dd3a9667d0732a4e9a191d71459d9c4b88d6d3cdda6c72ab39974a0c181f7fe8d4b51141fb3e0
-  data.tar.gz: 5d221ad820a123c3e18caec9c2a1a40fcc35a10837a61dbce3dc8d9efbcd8133b23829847e3aa11bf3e7f93a60e1b3c57c6258d3028dafd19f02f10722856a6d
+  metadata.gz: 61a8dcc3e28f98f7c4d4c1379f902a9a62c004e692b8a7f77bc0e3ff55cdd932d06276059a87650a7a4c0920e7faa78ab836c06bcfc215b523eb29a9e02732b8
+  data.tar.gz: fbcbb3787ffe7b8394fb2651507255d652f358b36493abc2d6c6bf0e20a1ba8d30c993b3f656ffc8e2495da75a0906e20d41f63e08b468645aa09744c35934da

data/.circleci/config.yml

@@ -62,6 +62,11 @@ jobs:
               --out test_results/rspec.xml \
               --format progress \
               $TEST_FILES
+      # create document
+      - run:
+          name: create document
+          command: |
+            bundle exec yard
       # collect reports
       - store_test_results:
           path: test_results
@@ -73,6 +78,10 @@ jobs:
           # カバレッジの結果をcoverage-resultsディレクトリに吐き出す
           path: coverage
           destination: coverage-results
+      - store_artifacts:
+          # ドキュメントの結果をyard-resultsディレクトリに吐き出す
+          path: ./doc
+          destination: yard-results
       # deploy RubyGems
       - deploy:
           command: |

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qiita_trend (0.2.8)
+    qiita_trend (0.2.9)
       mechanize
       nokogiri (~> 1.9)
 
@@ -89,6 +89,7 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrobots (0.1.2)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -104,6 +105,7 @@ DEPENDENCIES
   simplecov
   vcr
   webmock
+  yard
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -14,37 +14,23 @@ Qiitaのトレンドを10秒で取得することができます
 - 過去のトレンドを取得することができます（**あくまでもキャッシュファイルから復元するためキャッシュファイルの無い過去のトレンドは取得することができません**）
 - いいね数は性質上取得した時の時間に依存します。どうしても現在時刻のいいね数が欲しい場合はキャシュファイルを手動で削除してもう一度実行してください
 
-## インストール
+## ドキュメント
 
-Add this line to your application's Gemfile:
+[RubyDoc.info](https://rubydoc.info/github/dodonki1223/qiita_trend)
 
-```ruby
-gem 'qiita_trend'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+## 使用方法
 
-    $ gem install qiita_trend
+`gem install qiita_trend`を実行する
 
-## 使用方法
+```shell
+$ gem install qiita_trend
+```
 
 ### QiitaのDailyのトレンドを10秒で取得する
 
-ターミナルでコマンド`gem install qiita_trend`、`ruby -r qiita_trend -e "pp QiitaTrend::Trend.new.items"`を実行することでQiitaのトレンドを10秒で取得できます  
+ターミナルで`ruby -r qiita_trend -e "pp QiitaTrend::Trend.new.items"`を実行することでQiitaのトレンドを10秒（**gem install qiita_trendも含めて**）で取得できます  
 
 ```shell
-$ gem install qiita_trend
-Fetching qiita_trend-0.2.3.gem
-Successfully installed qiita_trend-0.2.3
-Parsing documentation for qiita_trend-0.2.3
-Installing ri documentation for qiita_trend-0.2.3
-Done installing documentation for qiita_trend after 0 seconds
-1 gem installed
-
 $ ruby -r qiita_trend -e "pp QiitaTrend::Trend.new.items"
 [{"title"=>"2行でwebpack.config.jsで補完を効かせる方法",
   "user_name"=>"akameco",
@@ -66,11 +52,7 @@ $ ruby -r qiita_trend -e "pp QiitaTrend::Trend.new.items"
   ...
 ```
 
-### ワンライナーで使ってみる
-
-先に`gem install qiita_trend`を実行しておくこと
-
-#### Dailyのトレンドの簡易表示
+### Dailyのトレンドの簡易表示
 
 index + タイトル名 + いいね数 + ユーザー名
 
@@ -85,7 +67,7 @@ $ ruby -r qiita_trend -e "QiitaTrend::Trend.new.items.each_with_index {|t, i| pu
 [5]畳み込みニューラルネットワークは何を見ているか(69) - okn-yu
 ```
 
-#### Dailyのトレンドのタイトル一覧
+### Dailyのトレンドのタイトル一覧
 
 ```shell
 $ ruby -r qiita_trend -e "QiitaTrend::Trend.new.items.each {|t| puts t['title']}"
@@ -98,7 +80,7 @@ KAGGLEでどこから手を付けていいか分からず学ぶことが多す
 畳み込みニューラルネットワークは何を見ているか
 ```
 
-#### Dailyのトレンドのうち`new`がついているものをブラウザで一括で開く
+### Dailyのトレンドのうち`new`がついているものをブラウザで一括で開く
 
 ```shell
 $ ruby -r qiita_trend -e "QiitaTrend::Trend.new.new_items.each {|t| system('open ' + t['article'])}"
@@ -129,6 +111,7 @@ p daily_trend.new_items
 ### Weekly、Monthlyのトレンドを取得する
 
 WeeklyとMonthlyのトレンドを取得する時はQiitaにログインしている必要があるため、ログイン出来るユーザーとパスワードの設定が必要です
+ログインできないユーザー名とパスワードを指定している時は`LoginFailureError`の例外が発生します
 
 ```ruby
 # Qiitaにログインするためのユーザーとパスワードの設定をする
@@ -148,6 +131,25 @@ p monthly_trend.items
 p monthly_trend.new_items
 ```
 
+### キャッシュファイルからトレンドを取得する
+
+キャッシュファイルが存在しない場合は`NotExistsCacheError`の例外が発生します
+WeeklyもMonthlyの取得方法もDailyと同様です
+
+```ruby
+# 2019年8月8日5時更新分のDailyのトレンドを取得する
+daily_trend_05 = QiitaTrend::Trend.new(QiitaTrend::TrendType::DAILY, '2019080805')
+
+p daily_trend_05.items
+p daily_trend_05.new_items
+
+# 2019年8月8日17時更新分のDailyのトレンドを取得する
+daily_trend_17 = QiitaTrend::Trend.new(QiitaTrend::TrendType::DAILY, '2019080817')
+
+p daily_trend_17.items
+p daily_trend_17.new_items
+```
+
 ### itemsメソッド、new_itemsメソッドについて
 
 itemsメソッド、new_itemsメソッドは`Array`を返します
@@ -175,16 +177,57 @@ irb(main):001:0> pp QiitaTrend::Trend.new.items[0]
  "is_new_arrival"=>false}
 ```
 
-| key            |  内容                     | 備考                  |
-|:--------------:|:-------------------------:|:---------------------:|
-| title          | 記事タイトル              |                       |
-| user_name      | ユーザー名                |                       |
-| user_image     | ユーザー画像URL           |                       |
-| user_page      | ユーザーページ            |                       |
-| article        | 記事のURL                 |                       |
-| created_at     | 記事作成日                |                       |
-| likes_count    | いいね数                  | 数値が入ります        |
-| is_new_arrival | 「NEW」のついている記事か | TrueかFalseが入ります |
+<table>
+  <thead>
+    <tr>
+      <th>key</th>
+      <th>内容</th>
+      <th>備考</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>title</td>
+      <td>記事タイトル</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>user_name</td>
+      <td>ユーザー名</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>user_image</td>
+      <td>ユーザー画像URL</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>user_page</td>
+      <td>ユーザーページ</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>article</td>
+      <td>記事のURL</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>created_at</td>
+      <td>記事作成日</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>likes_count</td>
+      <td>いいね数</td>
+      <td>数値が入ります</td>
+    </tr>
+    <tr>
+      <td>is_new_arrival</td>
+      <td>「NEW」のついている記事か</td>
+      <td>TrueかFalseが入ります</td>
+    </tr>
+  </tbody>
+</table>
 
 ### キャシュファイルの出力先を変更する
 

data/lib/qiita_trend/cache.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
 module QiitaTrend
+  # Qiitaのトレンドをキャッシュする機能を提供する
   class Cache
-    attr_reader :file_name, :directory, :full_path
+    # @return [String] ファイル名
+    attr_reader :file_name
+    # @return [String] キャッシュファイルを格納するディレクトリ（デフォルト値はDEFAULT_CACHE_DIRECTORYになります）
+    attr_reader :directory
+    # @return [String] キャッシュファイルへのフルパス
+    attr_reader :full_path
 
     # キャッシュファイルが格納されるデフォルトのディレクトリ
     DEFAULT_CACHE_DIRECTORY = Dir.home + '/qiita_cache/'
 
     # コンストラクタ
-    #   クラス内で使用するインスタンス変数をセットする
+    # Cacheクラスのインスタンスを返します
+    #
+    # @param [String] file_name ファイル名
+    # @param [String] directory キャッシュが格納する・されているディレクトリ
     def initialize(file_name, directory = DEFAULT_CACHE_DIRECTORY)
       @file_name = file_name
       @directory = directory
@@ -16,7 +25,9 @@ module QiitaTrend
     end
 
     # キャッシュファイルを作成する
-    #   キャッシュフォルダが存在しない時は作成する
+    # ※キャッシュフォルダが存在しない場合は作成します
+    #
+    # @param [String] content 書き込む内容
     def create_cache(content)
       Dir.mkdir(@directory) unless Dir.exist?(@directory)
       File.open(@full_path, 'wb') do |file|
@@ -25,11 +36,16 @@ module QiitaTrend
     end
 
     # キャッシュファイルを読み込む
+    # File.openを使用しファイルを読み込みます
+    #
+    # @return [Object]
     def load_cache
       File.open(@full_path, 'r', &:read)
     end
 
-    # キャッシュファイルが存在するか？
+    # キャッシュファイルが存在するかどうかを判定します
+    #
+    # @return [Boolean]
     def cached?
       File.exist?(@full_path)
     end

data/lib/qiita_trend/configuration.rb

@@ -11,9 +11,17 @@ module QiitaTrend
     end
   end
 
+  # QiitaTrendのConfigの設定する機能を提供する
   class Configuration
-    attr_accessor :user_name, :password, :cache_directory
+    # @return [String] Qiitaにログインするためのユーザー名
+    attr_accessor :user_name
+    # @return [String] Qiitaにログインするためのパスワード
+    attr_accessor :password
+    # @return [String] キャッシュファイルを保存するディレクトリ
+    attr_accessor :cache_directory
 
+    # コンストラクタ
+    # Configurationクラスのインスタンスを返します
     def initialize
       @user_name = nil
       @password = nil

data/lib/qiita_trend/error/login_failure_error.rb

@@ -2,15 +2,26 @@
 
 module QiitaTrend
   module Error
+    # Qiitaへログイン失敗時に発生するエラークラス
     class LoginFailureError < ::QiitaTrend::Error::SyntaxError
+      # エラーメッセージを返します
+      # ログインに失敗した時のユーザー名とパスワードを含んだ形でメッセージを返します
+      #
+      # @return [String] エラーメッセージ
       def message
         "Login failed, Please confilm user_name and password(user:#{user_name},password:#{password})"
       end
 
+      # ログインに失敗した時のユーザー名を返します
+      #
+      # @return [String] ユーザー名(Configの設定したユーザー名)
       def user_name
         QiitaTrend.configuration.user_name
       end
 
+      # ログインに失敗した時のパスワードを返します
+      #
+      # @return [String] パスワード(Configの設定したパスワード)
       def password
         QiitaTrend.configuration.password
       end

data/lib/qiita_trend/error/not_exists_cache_error.rb

@@ -2,13 +2,23 @@
 
 module QiitaTrend
   module Error
+    # キャッシュファイルが存在しない時に発生するエラークラス
+    # キャッシュファイルからトレンドを取得する時、存在しないキャッシュファイルを指定した時に発生する
     class NotExistsCacheError < ::QiitaTrend::Error::SyntaxError
+      # @return [Cache] Cacheクラス
       attr_reader :cache
 
+      # コンストラクタ
+      #
+      # @param [Cache] cache キャッシュクラス
       def initialize(cache)
         @cache = cache
       end
 
+      # エラーメッセージを返します
+      # 読み込もうとしたキャッシュファイルのフルパス含んだ形でメッセージを返します
+      #
+      # @return [String] エラーメッセージ
       def message
         "Does not exist cache file #{@cache.full_path}"
       end

data/lib/qiita_trend/error/syntax_error.rb

@@ -2,6 +2,7 @@
 
 module QiitaTrend
   module Error
+    # qiita_trendのエラーの機能を提供する
     class SyntaxError < ::StandardError
     end
   end

data/lib/qiita_trend/page.rb

@@ -3,12 +3,26 @@
 require 'mechanize'
 
 module QiitaTrend
+  # Qiitaのページをスクレイピングしページ情報を取得する機能を提供する
   class Page
-    attr_reader :target, :html, :cache
+    # @return [TrendType] トレンドタイプ（TrendType::DAILY,TrendType::WEEKLY,TrendType::MONTHLY）
+    attr_reader :target
+    # @return [String] Qiitaページのスクレイピング結果
+    attr_reader :html
+    # @return [Cache] Cacheクラス
+    attr_reader :cache
 
+    # QiitaのTOPページURL
     QIITA_URI = 'https://qiita.com/'
+    # QiitaのログインページURL
     QIITA_LOGIN_URI = 'https://qiita.com/login'
 
+    # コンストラクタ
+    #
+    # @param [TrendType] trend_type トレンドタイプ
+    # @param [String] date 「YYYYMMDD05」,「YYYYMMDD17」形式のどちらか
+    # @raise [LoginFailureError] ログインに失敗した時に発生する
+    # @raise [NotExistsCacheError] 存在しないキャッシュファイルを指定した時に発生する
     def initialize(trend_type = TrendType::DAILY, date = nil)
       @target = Target.new(trend_type, date)
       save_cache_directory = QiitaTrend.configuration.cache_directory.nil? ? Cache::DEFAULT_CACHE_DIRECTORY : QiitaTrend.configuration.cache_directory
@@ -28,6 +42,11 @@ module QiitaTrend
 
     private
 
+    # Qiitaのページをスクレイピングした結果を取得します
+    #
+    # @param [Target] target Targetクラス
+    # @raise [LoginFailureError] ログインに失敗した時に発生する
+    # @return [String] Qiitaをスクレイピングした結果
     def create_html(target)
       agent = Mechanize.new
       agent.user_agent_alias = 'Mac Safari'
@@ -35,6 +54,10 @@ module QiitaTrend
       agent.get(target.url).body
     end
 
+    # Qiitaへログインする
+    #
+    # @param [Mechanize] agent Mechanizeクラス
+    # @raise [LoginFailureError] ログインに失敗した時に発生する
     def login_qiita(agent)
       form = agent.get(QIITA_LOGIN_URI).forms.first
       form['identity'] = QiitaTrend.configuration.user_name

data/lib/qiita_trend/target.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
 
 module QiitaTrend
+  # Qiitaの対象のトレンドの機能を提供する
   class Target
-    attr_reader :type, :url, :need_login, :cache
+    # @return [TrendType] トレンドタイプ（TrendType::DAILY,TrendType::WEEKLY,TrendType::MONTHLY）
+    attr_reader :type
+    # @return [String] トレンドを取得するQiitaのページURL
+    attr_reader :url
+    # @return [Boolean] Qiitaへのログインが必要かどうか
+    attr_reader :need_login
+    # @return [String] キャッシュファイル名
+    attr_reader :cache
 
+    # コンストラクタ
+    #
+    # @param [TrendType] trend_type トレンドタイプ
+    # @param [String] date 「YYYYMMDD05」,「YYYYMMDD17」形式のどちらか
     def initialize(trend_type = TrendType::DAILY, date = nil)
       @type = trend_type
       @url = trend_url(trend_type)
@@ -13,6 +25,10 @@ module QiitaTrend
 
     private
 
+    # トレンドのURLを取得する
+    #
+    # @param [TrendType] type トレンドタイプ
+    # @return [String] トレンドを取得するQiitaのページURL
     def trend_url(type)
       case type
       when TrendType::DAILY then 'https://qiita.com/'
@@ -21,6 +37,12 @@ module QiitaTrend
       end
     end
 
+    # キャッシュ名を取得する
+    # キャシュ名はYYYYMMDD05_daily.html,YYYYMMDD17_weekly.htmlなどの形式になります
+    # dateが指定されていなかったら現在時刻からキャッシュファイル名を作成し指定されていたらそのdateからキャッシュ名を取得する
+    #
+    # @param [TrendType] type トレンドタイプ
+    # @param [String] date 「YYYYMMDD05」,「YYYYMMDD17」形式のどちらか
     def cache_name(type, date)
       return "#{date}_#{type}.html" unless date.nil?
 

data/lib/qiita_trend/trend.rb

@@ -5,9 +5,17 @@ require 'open-uri'
 require 'json'
 
 module QiitaTrend
+  # Qiitaのトレンドの機能を提供する
   class Trend
+    # @return [Array] トレンドデータ
     attr_reader :data
 
+    # コンストラクタ
+    #
+    # @param [TrendType] trend_type トレンドタイプ
+    # @param [String] date 「YYYYMMDD05」,「YYYYMMDD17」形式のどちらか
+    # @raise [LoginFailureError] ログインに失敗した時に発生する
+    # @raise [NotExistsCacheError] 存在しないキャッシュファイルを指定した時に発生する
     def initialize(trend_type = TrendType::DAILY, date = nil)
       page = Page.new(trend_type, date)
       parsed_html = Nokogiri::HTML.parse(page.html)
@@ -16,6 +24,9 @@ module QiitaTrend
       @data = trends_data['trend']['edges']
     end
 
+    # Qiitaの対象のトレンドをすべて取得
+    #
+    # @return [Array] Qiitaの対象のトレンドすべて
     def items
       @data.each_with_object([]) do |trend, value|
         result = {}
@@ -31,6 +42,9 @@ module QiitaTrend
       end
     end
 
+    # Qiitaの対象のトレンドからNEWのものだけ取得
+    #
+    # @return [Array] Qiitaの対象のトレンドからNEWのものだけ
     def new_items
       items.select do |trend|
         trend['is_new_arrival'] == true

data/lib/qiita_trend/trend_type.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module QiitaTrend
+  # トレンドタイプの機能を提供する
   class TrendType
+    # トレンドタイプ：Daily
     DAILY = 'daily'
+    # トレンドタイプ：Weekly
     WEEKLY = 'weekly'
+    # トレンドタイプ：Monthly
     MONTHLY = 'monthly'
   end
 end

data/lib/qiita_trend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QiitaTrend
-  VERSION = '0.2.8'
+  VERSION = '0.2.9'
 end

data/qiita_trend.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['dodonki1223']
   spec.email         = ['make.an.effort.wish.come.true@gmail.com']
 
-  spec.summary       = 'Get Qiita Trend'
-  spec.description   = 'Get Qiita Trend'
+  spec.summary       = 'Easy to get trend for Qiita in 10 seconds'
+  spec.description   = 'Easy to get trend for Qiita in 10 seconds'
   spec.homepage      = 'https://github.com/dodonki1223/qiita_trend'
   spec.license       = 'MIT'
 
@@ -50,4 +50,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita_trend
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - dodonki1223
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -164,7 +164,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Get Qiita Trend
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy to get trend for Qiita in 10 seconds
 email:
 - make.an.effort.wish.come.true@gmail.com
 executables: []
@@ -218,5 +232,5 @@ requirements: []
 rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Get Qiita Trend
+summary: Easy to get trend for Qiita in 10 seconds
 test_files: []