qiita_matome 0.0.1

data/lib/validators/article_validator.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module QiitaMatome
+  #  QiitaMatome::Validators
+  module Validators
+    # ArticleValidator
+    class ArticleValidator
+      ARTICLE_CLASS_ERROR = "invalid argument class '%s'.article must be Array"
+
+      def self.validate(articles)
+        return if articles.empty?
+        articles.each do |article|
+          next if article.is_a?(Article)
+          fail ArgumentError, format(ARTICLE_CLASS_ERROR, article.class)
+        end
+      end
+    end
+  end
+end

data/lib/validators/articles_validator.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module QiitaMatome
+  #  QiitaMatome::Validators
+  module Validators
+    # ArticlesValidator
+    class ArticlesValidator
+      ARTICLES_CLASS_ERROR = "invalid argument class '%s'. articles must be Array" # rubocop:disable LineLength
+
+      def self.validate(articles)
+        return if articles.is_a?(Array)
+        fail ArgumentError, format(ARTICLES_CLASS_ERROR, articles.class)
+      end
+    end
+  end
+end

data/lib/validators/display_columns_validator.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'display/display_consts'
+
+module QiitaMatome
+  #  QiitaMatome::Validators
+  module Validators
+    # DisplayColumnsValidator
+    class DisplayColumnsValidator
+      # rubocop:disable LineLength
+      DISPLAY_COLUMNS_TO_SYM_ERROR = "Invalid display_columns. Display_columns's class must be implement 'to_sym' method."
+      DISPLAY_COLUMNS_ERROR = "Invalid display_columns '%s'. Display_columns must be :title, :created_at, :updated_at, :stock_count or :no"
+      # rubocop:enable LineLength
+      DCC = Display::Consts::COLUMNS
+
+      class << self
+        def validate(display_columns)
+          display_columns.each do |display_column|
+            validate_each(display_column)
+          end
+        end
+
+        private
+
+        def validate_each(display_column)
+          validate_to_sym(display_column)
+          validate_display_column(display_column.to_sym)
+        end
+
+        def validate_to_sym(display_column)
+          return if display_column.respond_to?(:to_sym)
+          fail ArgumentError, DISPLAY_COLUMNS_TO_SYM_ERROR
+        end
+
+        def validate_display_column(display_column)
+          return if DCC.include?(display_column)
+          fail ArgumentError, format(DISPLAY_COLUMNS_ERROR, display_column)
+        end
+      end
+    end
+  end
+end

data/lib/validators/sort_type_validator.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'sort/sort_consts'
+
+module QiitaMatome
+  #  QiitaMatome::Validators
+  module Validators
+    # SortTypeValidator
+    class SortTypeValidator
+      # rubocop:disable LineLength
+      SORT_TYPE_ERROR = "invalid sort_type '%s'. sort_type must be 'created_at_asc', 'created_at_desc', 'updated_at_asc', 'updated_at_desc', 'title_date_asc', 'title_date_desc', 'stock_count_asc' or 'stock_count_desc'"
+      # rubocop:enable LineLength
+
+      def self.validate(sort_type)
+        return if Sort::Consts::ALL_TYPES.include?(sort_type)
+        fail ArgumentError, format(SORT_TYPE_ERROR, sort_type)
+      end
+    end
+  end
+end

data/qiita_matome.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qiita_matome/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qiita_matome'
+  spec.version       = QiitaMatome::VERSION
+  spec.authors       = ['tbpgr']
+  spec.email         = ['tbpgr@tbpgr.jp']
+  spec.summary       = %q(Qiita article matome generator)
+  spec.description   = %q(Qiita article matome generator)
+  spec.homepage      = 'https://github.com/tbpgr/qiita_matome'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activemodel', '~> 4.0', '>= 4.0.2'
+  spec.add_runtime_dependency 'thor', '~> 0.18.1'
+
+  spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
+  spec.add_development_dependency 'simplecov', '~> 0.8', '>= 0.8.2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 0'
+end

data/samples/matome_title_asc.md

@@ -0,0 +1,25 @@
+# RuboCop まとめ タイトル昇順
+
+更新日: 2014/07/01 22:51:13
+
+|No.|タイトル|作成日|ストック数|
+|--:|:--|:--:|--:|
+|1|[RuboCop  Style/AccessModifierIndentation](http://qiita.com/tbpgr/items/706d2b93052154772f18)|2014/06/15 00:53:36|4|
+|2|[RuboCop  Style/AlignHash  EnforcedColonStyle](http://qiita.com/tbpgr/items/b23d30a3b6284e800b60)|2014/06/16 21:41:26|4|
+|3|[RuboCop  Style/AlignHash  EnforcedHashRocketStyle](http://qiita.com/tbpgr/items/36788d9da32e7a6d6f43)|2014/06/15 23:19:06|3|
+|4|[RuboCop  Style/AlignHash  EnforcedLastArgumentHashStyle](http://qiita.com/tbpgr/items/e07749ec716247f0a409)|2014/06/17 21:25:54|4|
+|5|[RuboCop  Style/AlignParameters  EnforcedStyle](http://qiita.com/tbpgr/items/414e3aad8c3b56d2ce04)|2014/06/18 22:44:12|4|
+|6|[RuboCop  Style/BlockNesting](http://qiita.com/tbpgr/items/21cca635527eb03e64f2)|2014/06/19 21:48:37|3|
+|7|[RuboCop  Style/BracesAroundHashParameters EnforcedStyle](http://qiita.com/tbpgr/items/8932a19d154fc3d7c142)|2014/06/20 21:27:07|3|
+|8|[RuboCop  Style/CaseIndentation Indent One Step](http://qiita.com/tbpgr/items/d14e825f6eb9c9175d6a)|2014/06/22 21:18:23|2|
+|9|[RuboCop  Style/CaseIndentation IndentWhenRelativeTo](http://qiita.com/tbpgr/items/7323c764e3ae046a0fde)|2014/06/21 13:31:37|2|
+|10|[RuboCop  Style/ClassAndModuleChildren EnforcedStyle](http://qiita.com/tbpgr/items/61b9da235701df919ae5)|2014/06/23 22:12:53|2|
+|11|[RuboCop  Style/ClassLength](http://qiita.com/tbpgr/items/44087a9f4c6548043ace)|2014/06/24 20:28:50|2|
+|12|[RuboCop  Style/CollectionMethods PreferredMethods](http://qiita.com/tbpgr/items/a982166bbd473fcd4e6e)|2014/06/26 00:06:37|1|
+|13|[RuboCop  Style/CommentAnnotation](http://qiita.com/tbpgr/items/5b0cee75305cef801851)|2014/06/26 21:29:33|2|
+|14|[RuboCop  Style/CyclomaticComplexity](http://qiita.com/tbpgr/items/693f37d763c6ea5f9e9b)|2014/06/27 21:55:52|2|
+|15|[RuboCop  Style/DotPosition](http://qiita.com/tbpgr/items/c53f86c876f73c1aa5a8)|2014/06/28 23:08:32|2|
+|16|[RuboCop  Style/EmptyLineBetweenDefs](http://qiita.com/tbpgr/items/2872f2a27430372d43e4)|2014/06/29 19:49:56|2|
+|17|[RuboCop  Style/FileName](http://qiita.com/tbpgr/items/97fc9186e59d607b1ecf)|2014/06/30 21:56:25|1|
+|18|[RuboCopの警告をコメントで無効化する方法](http://qiita.com/tbpgr/items/a9000c5c6fa92a46c206)|2014/06/08 21:27:21|6|
+

data/spec/display/displayer_spec.rb

@@ -0,0 +1,341 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'display/display_consts'
+require 'display/displayer'
+require 'models/article'
+require 'models/articles'
+
+# rubocop:disable LineLength, UnusedMethodArgument
+describe QiitaMatome::Display::Displayer do
+  context :new do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'valid args',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        display_columns: [:no, :title],
+        expected_display_columns: [:no, :title]
+      },
+      {
+        case_no: 2,
+        case_title: 'invalid articles class "String"',
+        articles: 'String',
+        display_columns: [:no, :title],
+        expect_error: true
+      },
+      {
+        case_no: 3,
+        case_title: 'invalid article class "String"',
+        articles: [QiitaMatome::Article.new, 'String'],
+        display_columns: [:no, :title],
+        expect_error: true
+      },
+      {
+        case_no: 4,
+        case_title: 'invalid display_columns "invalid"',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        display_columns: 'invalid',
+        expect_error: true
+      },
+      {
+        case_no: 5,
+        case_title: 'valid args(auto convert display_columns)',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        display_columns: 'title',
+        expected_display_columns: [:title]
+      },
+      {
+        case_no: 6,
+        case_title: 'invalid display_columns than haven\'t to_sym method.',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        display_columns: 1,
+        expect_error: true
+      },
+      {
+        case_no: 7,
+        case_title: 'valid args(updated_at)',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        display_columns: [:created_at, :updated_at],
+        expected_display_columns: [:created_at, :updated_at]
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          if c[:expect_error]
+            -> { QiitaMatome::Display::Displayer.new('title', c[:articles], c[:display_columns]) }.should raise_error(ArgumentError)
+            next
+          end
+          qdd = QiitaMatome::Display::Displayer.new('title', c[:articles], c[:display_columns])
+
+          # -- when --
+          actual_articles = qdd.articles
+          actual_display_columns = qdd.display_columns
+
+          # -- then --
+          expect(actual_articles).to eq(c[:articles])
+          expect(actual_display_columns).to eq(c[:expected_display_columns])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :display_title do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'valid args',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        title: 'title1',
+        expected: '# title1'
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          qdd = QiitaMatome::Display::Displayer.new(c[:title], c[:articles])
+
+          # -- when --
+          actual = qdd.display_title
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :table_header do
+    TABLE_HEADER_ARTICLE = QiitaMatome::Article.new(
+      'user' => { 'id' => 99_999, 'url_name' => 'tbpgr', 'profile_image_url' => '' },
+      'title' => 'title1',
+      'created_at' => '2014-06-18 22:37:54 +0900',
+      'updated_at' => '2014-06-26 02:25:11 +0900',
+      'tags' => [{ 'name' => 'Ruby', 'url_name' => 'ruby', 'icon_url' => '', 'versions' => [] }],
+      'stock_count' => 2
+    )
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'valid args',
+        articles: [TABLE_HEADER_ARTICLE, QiitaMatome::Article.new],
+        display_columns: [:no, :title],
+        expected: <<-EOS
+|No.|タイトル|
+|--:|:--|
+        EOS
+      },
+      {
+        case_no: 2,
+        case_title: 'full display args',
+        articles: [TABLE_HEADER_ARTICLE, QiitaMatome::Article.new],
+        display_columns: [:no, :title, :created_at, :stock_count],
+        expected: <<-EOS
+|No.|タイトル|作成日|ストック数|
+|--:|:--|:--:|--:|
+        EOS
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          qdd = QiitaMatome::Display::Displayer.new(c[:title], c[:articles], c[:display_columns])
+
+          # -- when --
+          actual = qdd.table_header
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :display_article do
+    DISPLAY_ARTICLE = QiitaMatome::Article.new(
+        'uuid' => 'd1ed617093609ccedbee',
+        'user' => { 'id' => 99_999, 'url_name' => 'tbpgr', 'profile_image_url' => '' },
+        'title' => 'title1',
+        'created_at' => '2014-06-18 22:37:54 +0900',
+        'updated_at' => '2014-06-26 02:25:11 +0900',
+        'tags' => [{ 'name' => 'Ruby', 'url_name' => 'ruby', 'icon_url' => '', 'versions' => [] }],
+        'stock_count' => 2
+      )
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'valid args',
+        articles: [DISPLAY_ARTICLE, QiitaMatome::Article.new],
+        article: DISPLAY_ARTICLE,
+        no: 1,
+        display_columns: [:no, :title],
+        expected: '|1|[title1](http://qiita.com/tbpgr/items/d1ed617093609ccedbee)|'
+      },
+      {
+        case_no: 2,
+        case_title: 'full display args',
+        articles: [DISPLAY_ARTICLE, QiitaMatome::Article.new],
+        article: DISPLAY_ARTICLE,
+        no: 1,
+        display_columns: [:no, :title, :created_at, :stock_count],
+        expected: '|1|[title1](http://qiita.com/tbpgr/items/d1ed617093609ccedbee)|2014/06/18 22:37:54|2|'
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          qdd = QiitaMatome::Display::Displayer.new('title', c[:articles], c[:display_columns])
+
+          # -- when --
+          actual = qdd.display_article(c[:no], c[:article])
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :display_articles do
+    DISPLAY_ARTICLES = [
+      QiitaMatome::Article.new(
+        'uuid' => 'd1ed617093609ccedbee',
+        'user' => { 'id' => 99_999, 'url_name' => 'tbpgr', 'profile_image_url' => '' },
+        'title' => 'title1',
+        'created_at' => '2014-06-18 22:37:54 +0900',
+        'updated_at' => '2014-06-26 02:25:11 +0900',
+        'tags' => [{ 'name' => 'Ruby', 'url_name' => 'ruby', 'icon_url' => '', 'versions' => [] }],
+        'stock_count' => 2
+      ),
+      QiitaMatome::Article.new(
+        'uuid' => 'd1ed617093609ccedbef',
+        'user' => { 'id' => 99_999, 'url_name' => 'tbpgr', 'profile_image_url' => '' },
+        'title' => 'title2',
+        'created_at' => '2014-06-18 22:37:53 +0900',
+        'updated_at' => '2014-06-26 02:25:09 +0900',
+        'tags' => [{ 'name' => 'Ruby', 'url_name' => 'ruby', 'icon_url' => '', 'versions' => [] }],
+        'stock_count' => 3
+      ),
+      QiitaMatome::Article.new(
+        'uuid' => 'd1ed617093609ccedbeg',
+        'user' => { 'id' => 99_999, 'url_name' => 'tbpgr', 'profile_image_url' => '' },
+        'title' => 'title3',
+        'created_at' => '2014-06-18 22:37:52 +0900',
+        'updated_at' => '2014-06-26 02:25:10 +0900',
+        'tags' => [{ 'name' => 'Ruby', 'url_name' => 'ruby', 'icon_url' => '', 'versions' => [] }],
+        'stock_count' => 10
+      )
+    ]
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'valid args',
+        articles: DISPLAY_ARTICLES,
+        display_columns: [:no, :title],
+        expected: <<-EOS
+|1|[title1](http://qiita.com/tbpgr/items/d1ed617093609ccedbee)|
+|2|[title2](http://qiita.com/tbpgr/items/d1ed617093609ccedbef)|
+|3|[title3](http://qiita.com/tbpgr/items/d1ed617093609ccedbeg)|
+        EOS
+      },
+      {
+        case_no: 2,
+        case_title: 'full display args',
+        articles: DISPLAY_ARTICLES,
+        display_columns: [:no, :title, :created_at, :updated_at, :stock_count],
+        expected: <<-EOS
+|1|[title1](http://qiita.com/tbpgr/items/d1ed617093609ccedbee)|2014/06/18 22:37:54|2014/06/26 02:25:11|2|
+|2|[title2](http://qiita.com/tbpgr/items/d1ed617093609ccedbef)|2014/06/18 22:37:53|2014/06/26 02:25:09|3|
+|3|[title3](http://qiita.com/tbpgr/items/d1ed617093609ccedbeg)|2014/06/18 22:37:52|2014/06/26 02:25:10|10|
+        EOS
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          qdd = QiitaMatome::Display::Displayer.new('title', c[:articles], c[:display_columns])
+
+          # -- when --
+          actual = qdd.display_articles
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+end
+# rubocop:enable LineLength, UnusedMethodArgument