qiita_matome 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c28828004e752e84cbc90e62ab95234f7a1ca99
+  data.tar.gz: 097cd2f62928e55f42ac75d500f3b2d7eba6982a
+SHA512:
+  metadata.gz: c4e1227e445a85e8ec077313791ddeaaa92abe213865a940811477733dba71da41dcad873cee2435543fa525967aa3f629ce5197b567243fa437648c69ab409e
+  data.tar.gz: b39fb658de739614ff5af2fd9e7fc1cbaf7577d6adb8c993a3933a59aa68da95fe4a7c7aaa2b0f4c836f9eb7dc841facb31add61dbe8c364e90805d5a5d7104d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# contributing 注意事項
+
+## ブランチに関して
+* *master* を直接編集せずにトピックブランチを作成して *pull request* を行うこと
+* トピックブランチは修正内容を表した、わかりやすい名前にすること
+
+## コーディング規約について
+
+* **Ruby Style Guide** に準じます
+
+    * [Ruby Style Guide 英語版](https://github.com/bbatsov/ruby-style-guide)
+    * [Ruby Style Guide 和訳版](https://github.com/fortissimo1997/ruby-style-guide/blob/japanese/README.ja.md)
+
+## RuboCopの利用に関して
+* *rubocop* の警告が1件も発生しない状態で *pull request* を行うこと
+
+~~~bash
+# プロジェクトルートへ移動
+$ cd qiita_matome
+# プロジェクト全体に対して rubocop のチェックを実行
+$ rubocop
+Inspecting 32 file
+.
+
+32 file inspected, no offenses detected
+
+# ※ no offenses detected になっていること
+~~~
+
+* *rubocop* の警告について、どうしても規約を守ることが難しい場合は警告除外用のコメントを利用してください
+
+    除外方法については [こちらの記事](http://qiita.com/tbpgr/items/a9000c5c6fa92a46c206) を参照
+
+## RSpecのテストに関して
+* RSpecの単体テストを一緒に作成してください。
+* 事情があって **例外的に** 単体テストの作成をしない場合は、手動テストの項目・手順を *manual_test_docs* に作成してください。
+
+    ※なぜ単体テストを作成しないのか、 **理由** を *pull request* 時のコメントに記述してください。  
+    例えば、 *lib / qiita_json_loader.rb* などは、Qiita のWeb API へのアクセスが主であるため、  
+    あえて単体テストを作成していません。  
+
+* テストの作成は [*rspec_piccolo gem*](https://github.com/tbpgr/rspec_piccolo) を利用していただけると体裁が整って嬉しいですが必須ではありません。
+
+    ※冗長なテストよりは **DRYなテストが好みです**

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "activemodel", "~> 4.0.2"
+gem "thor", "~> 0.18.1"
+
+gem "rspec", "~> 2.14.1"
+gem "simplecov", "~> 0.8.2"
+gem 'rubocop', '~> 0.23.0'
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tbpgr
+
+MIT License
+
+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/README.md

@@ -0,0 +1,210 @@
+# QiitaMatome
+
+[![Build Status](https://travis-ci.org/tbpgr/qiita_matome.png?branch=master)](https://travis-ci.org/tbpgr/qiita_matome)
+[![Coverage Status](https://coveralls.io/repos/tbpgr/qiita_matome/badge.png)](https://coveralls.io/r/tbpgr/qiita_matome)
+[![Code Climate](https://codeclimate.com/github/tbpgr/qiita_matome.png)](https://codeclimate.com/github/tbpgr/qiita_matome)
+
+Qiitaのまとめページジェネレーター  
+
+## 概要
+
+Qiitaの特定ユーザー、特定タグのリンクを一覧化したまとめ記事を生成する。
+
+## 前提
+* 認証不要(認証不要APIである、`GET /api/v1/users/:url_name/items` のみを利用する)
+* 任意のユーザーの任意の1つのタグに限定してまとめ記事を作成する
+
+    ※基本的には自分のユーザーのまとめを作ることを想定しています
+
+## 確認済み環境
+* ruby 2.0.0p451 環境にて動作確認済み
+
+## サブコマンド
+
+|コマンド|ショートカット|内容|
+|:--|:--|:--|
+|init|i|設定ファイル（ *Qiitamatome* ）を出力|
+|matome|m|まとめ記事の生成。実行するためには事前に *Qiitamatome* を生成、編集する必要がある|
+|help|h|ヘルプの表示|
+|version|v|バージョンの表示|
+
+## 設定ファイルについて
+
+RubyのDSLで作成されています。  
+
+ファイル名は *Qiitamatome*  
+
+~~~ruby
+qiitam init
+~~~
+
+もしくは
+
+~~~ruby
+qiitam i
+~~~
+
+でテンプレートを生成できます。  
+Gemfileのような感覚でご利用ください。  
+
+Rubyの内部DSLになっているので、Rubyのコードを利用することも可能です。  
+例えば、出力ファイルの名前に現在時刻を埋め込んだり、など。  
+
+### 設定ファイル自動生成時の内容
+
+~~~ruby
+# encoding: utf-8
+
+# Set your qiita user name
+# user is required
+# user allow only String
+user "your value"
+
+# Set your matome target tag name
+# tag is required
+# tag allow only String
+tag "your value"
+
+# Set your matome title
+# title is required
+# title allow only String
+title "your value"
+
+# Set your matome file's output path
+# output_file is required
+# output_file allow only String
+# output_file's default value => "matome.md"
+output_file "matome.md"
+
+# Set your matome sort type. you can choose created_at_asc/desc, updated_at_asc/desc, title_asc/desc, stock_count_asc/desc
+# sort_type allow only String
+# sort_type's default value => "created_at_desc"
+sort_type "created_at_desc"
+
+# Set your matome display columns. you can choose :title, :created_at, :updated_at, :stock_count and :no
+# display_columns allow only Array
+# display_columns's default value => [:no, :title, :created_at, :stock_count]
+display_columns [:no, :title, :created_at, :stock_count]
+
+# Set your matome exclude files
+# excludes allow only Array
+# excludes's default value => []
+excludes []
+~~~
+
+### 設定項目一覧
+
+|設定キー|必須|デフォルト|内容|
+|:--|:--|:--|:--|
+|user|○|なし|対象ユーザー|
+|tag|○|なし|対象タグ|
+|title|○|なし|まとめ記事タイトル|
+|output_file|○|matome.md|出力パス|
+|sort_type|×|created_at_desc|まとめ記事内のソート順。詳しくはソート種別参照|
+|display_columns|×|[:no, :title, :created_at, :stock_count]|まとめ記事の表示項目指定。指定順に並ぶ。詳しくは表示項目参照|
+|exclude|×|[id1, id2...]|除外記事ID（uuid）を配列で指定。例えば、まとめ記事自信を除外するために指定|
+
+### ソート種別
+
+|種別|内容|
+|:--|:--|
+|created_at_asc|初回投稿日昇順|
+|created_at_desc|初回投稿日降順|
+|updated_at_asc|更新日昇順|
+|updated_at_desc|更新日降順|
+|title_asc|記事タイトル昇順|
+|title_desc|記事タイトル降順|
+|stock_count_asc|ストック数昇順|
+|stock_count_desc|ストック数降順。つまり人気記事順|
+
+### 表示項目
+
+|項目名|内容|
+|:--|:--|
+|:title|記事タイトル。該当記事へのリンクになる|
+|:created_at|初回投稿日 「YYYY/MM/DD hh:mi:ss」 フォーマット|
+|:updated_at|更新日 「YYYY/MM/DD hh:mi:ss」 フォーマット|
+|:stock_count|ストック数|
+|:no|連番|
+
+## インストール
+
+Add this line to your application's Gemfile:
+
+    gem 'qiita_matome'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qiita_matome
+
+
+## 使用手順の例
+
+* 設定ファイル( *Qiitamatome* )の生成
+
+~~~bash
+$ qiitam init
+~~~
+
+または
+
+~~~bash
+$ qiitam i
+~~~
+
+* 設定ファイル( *Qiitamatome* )を編集
+
+ユーザー *tbpgr* の *rubocop* タグの記事をまとめ記事として出力します。  
+
+~~~bash
+user            "tbpgr"
+tag             "rubocop"
+title           "RuboCop まとめ タイトル昇順"
+output_file     "./matome_title_asc.md"
+sort_type       "title_asc"
+display_columns [:no, :title, :created_at, :stock_count]
+# まとめ記事を除外
+excludes        ['edbfecb6a6789dd54f47']
+~~~
+
+* まとめ記事作成を実行
+
+~~~bash
+$ qiitam matome
+~~~
+
+または
+
+~~~bash
+$ qiitam m
+~~~
+
+* 結果を確認
+
+~~~bash
+$ cat ./matome_title_asc.md
+# 内容が表示される
+~~~
+
+## 出力サンプル
+
+[matome_title_asc.md](./samples/matome_title_asc.md)
+
+## History
+* version 0.0.1 : 2014/07/03 : first release
+
+## Contributing
+
+1. Fork it ( https://github.com/tbpgr/qiita_matome/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 補足
+* この gem は [dslable gem](https://github.com/tbpgr/dslable) を利用して作成しています
+* この gem のテストクラスは [rspec_piccolo gem](https://github.com/tbpgr/rspec_piccolo) を利用してひな形を生成しています

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+task default: [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end

data/bin/qiitam

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'qiita_matome_core'
+require 'qiita_matome/version'
+require 'thor'
+
+module QiitaMatome
+  # = QiitaMatome CLI
+  class CLI < Thor
+    class_option :help, type: :boolean, aliases: '-h', desc: 'help message.'
+    class_option :version, type: :boolean, desc: 'version'
+
+    desc 'matome', 'Generate QiitaMatome markdown file.'
+    def matome
+      QiitaMatome::Core.new.matome
+    rescue => e
+      warn(e.message)
+      exit(false)
+    end
+
+    desc 'init', 'generate Qiitamatomefile'
+    def init
+      QiitaMatome::Core.new.init
+    end
+
+    desc 'version', 'version'
+    def version
+      p QiitaMatome::VERSION
+    end
+  end
+end
+
+QiitaMatome::CLI.start(ARGV)

data/lib/display.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'display/displayer'
+require 'display/display_consts'
+
+module QiitaMatome
+  #  QiitaMatome::Display
+  module Display
+  end
+end

data/lib/display/display_consts.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module QiitaMatome
+  #  QiitaMatome::Display
+  module Display
+    # QiitaMatome::Display::Consts
+    module Consts
+      TITLE = :title.freeze
+      CREATED_AT = :created_at.freeze
+      UPDATED_AT = :updated_at.freeze
+      STOCKED = :stock_count.freeze
+      NO = :no.freeze
+
+      ALIGN_RIGHT = :right
+      ALIGN_LEFT = :left
+      ALIGN_CENTER = :center
+
+      COLUMNS = [TITLE, CREATED_AT, UPDATED_AT, STOCKED, NO]
+      COLUMNS_ALIGN_MAP = {
+        TITLE => ALIGN_LEFT,
+        CREATED_AT => ALIGN_CENTER,
+        UPDATED_AT => ALIGN_CENTER,
+        STOCKED => ALIGN_RIGHT,
+        NO => ALIGN_RIGHT
+      }
+      COLUMNS_TITLE_MAP = {
+        TITLE => 'タイトル',
+        CREATED_AT => '作成日',
+        UPDATED_AT => '更新日',
+        STOCKED => 'ストック数',
+        NO => 'No.'
+      }
+    end
+  end
+end

data/lib/display/displayer.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+require 'validators/articles_validator'
+require 'validators/article_validator'
+require 'validators/display_columns_validator'
+
+module QiitaMatome
+  #  QiitaMatome::Display
+  module Display
+    # QiitaMatome::Display::Displayer
+    class Displayer
+      attr_reader :title, :articles, :display_columns
+
+      def initialize(title, articles,
+          display_columns = [:no, :title, :created_at, :stock_count])
+        Validators::ArticlesValidator.validate(articles)
+        Validators::ArticleValidator.validate(articles)
+        display_columns_list = Array(display_columns)
+        Validators::DisplayColumnsValidator.validate(display_columns_list)
+        symbolized_display_columns = display_columns_list.map(&:to_sym)
+        @title = title
+        @articles = articles
+        @display_columns = symbolized_display_columns
+      end
+
+      def display_title
+        "# #{@title}"
+      end
+
+      def table_header
+        title_header = table_title_header
+        title_align = table_align
+        "#{title_header}\n#{title_align}\n"
+      end
+
+      def matome_updated
+        "更新日: #{DateTime.now.strftime('%Y/%m/%d %H:%M:%S')}"
+      end
+
+      def display_article(no, article)
+        disp = @display_columns.each_with_object([]) do |item, memo|
+          memo << case item
+                  when :no then no
+                  when :title then article.title_link
+                  when :created_at then  article.created_at_ymdhms
+                  when :updated_at then  article.updated_at_ymdhms
+                  when :stock_count then article.stock_count
+          end
+        end
+        "|#{disp.join('|')}|"
+      end
+
+      def display_articles
+        display = []
+        @articles.each.with_index(1) do |article, no|
+          display << display_article(no, article)
+        end
+        display.join("\n") + "\n"
+      end
+
+      private
+
+      def table_title_header
+        header = @display_columns.each_with_object([]) do |item, memo|
+          memo << Consts::COLUMNS_TITLE_MAP[item]
+        end
+        "|#{header.join('|')}|"
+      end
+
+      def table_align
+        align = @display_columns.each_with_object([]) do |item, memo|
+          memo << case Consts::COLUMNS_ALIGN_MAP[item]
+                  when Consts::ALIGN_RIGHT then '--:'
+                  when Consts::ALIGN_LEFT then ':--'
+                  when Consts::ALIGN_CENTER then ':--:'
+          end
+        end
+        "|#{align.join('|')}|"
+      end
+    end
+  end
+end