RubyGems - qiita_matome - Versions diffs - 0.0.1 - Mend

qiita_matome 0.0.1

Files changed (46) hide show

checksums.yaml +7 -0
data/.coveralls.yml +1 -0
data/.gitignore +22 -0
data/.rspec +2 -0
data/.rubocop.yml +0 -0
data/.travis.yml +8 -0
data/CONTRIBUTING.md +44 -0
data/Gemfile +13 -0
data/LICENSE.txt +22 -0
data/README.md +210 -0
data/Rakefile +8 -0
data/bin/qiitam +34 -0
data/lib/display.rb +10 -0
data/lib/display/display_consts.rb +35 -0
data/lib/display/displayer.rb +81 -0
data/lib/file_writer.rb +19 -0
data/lib/models/article.rb +38 -0
data/lib/models/articles.rb +40 -0
data/lib/qiita_json_loader.rb +43 -0
data/lib/qiita_matome/version.rb +4 -0
data/lib/qiita_matome_core.rb +121 -0
data/lib/qiita_matome_dsl.rb +31 -0
data/lib/qiita_matome_dsl_model.rb +37 -0
data/lib/sort.rb +10 -0
data/lib/sort/sort_consts.rb +28 -0
data/lib/sort/sorter.rb +51 -0
data/lib/validators.rb +13 -0
data/lib/validators/article_validator.rb +19 -0
data/lib/validators/articles_validator.rb +16 -0
data/lib/validators/display_columns_validator.rb +41 -0
data/lib/validators/sort_type_validator.rb +19 -0
data/manual_test_docs/.gitkeep +0 -0
data/qiita_matome.gemspec +28 -0
data/samples/matome_title_asc.md +25 -0
data/spec/display/displayer_spec.rb +341 -0
data/spec/file_writer_spec.rb +92 -0
data/spec/models/article_spec.rb +131 -0
data/spec/models/articles_spec.rb +305 -0
data/spec/qiita_matome_core_spec.rb +46 -0
data/spec/sort/sorter_spec.rb +392 -0
data/spec/spec_helper.rb +16 -0
data/spec/validators/article_validator_spec.rb +53 -0
data/spec/validators/articles_validator_spec.rb +54 -0
data/spec/validators/display_columns_validator_spec.rb +58 -0
data/spec/validators/sort_type_validator_spec.rb +54 -0
metadata +202 -0

data/spec/qiita_matome_core_spec.rb ADDED

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'qiita_matome_core'
+# rubocop:disable LineLength, UnusedMethodArgument, UselessAssignment
+describe QiitaMatome::Core do
+  context :execute do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'case_title',
+        expected: 'expected'
+      }
+    ]
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+          # -- given --
+          qiita_matome_core = QiitaMatome::Core.new
+          # -- when --
+          # TODO: implement execute code
+          # actual = qiita_matome_core.execute
+          # -- then --
+          # TODO: implement assertion code
+          # 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, UselessAssignment

data/spec/sort/sorter_spec.rb ADDED

@@ -0,0 +1,392 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'sort/sort_consts'
+require 'sort/sorter'
+require 'models/article'
+require 'models/articles'
+# rubocop:disable LineLength, UnusedMethodArgument
+describe QiitaMatome::Sort::Sorter do
+  context :new do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'valid args',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        sort_type: QiitaMatome::Sort::Consts::CREATED_AT_ASC
+      },
+      {
+        case_no: 2,
+        case_title: 'invalid articles class "String"',
+        articles: 'String',
+        sort_type: QiitaMatome::Sort::Consts::CREATED_AT_ASC,
+        expect_error: true
+      },
+      {
+        case_no: 3,
+        case_title: 'invalid article class "String"',
+        articles: [QiitaMatome::Article.new, 'String'],
+        sort_type: QiitaMatome::Sort::Consts::CREATED_AT_ASC,
+        expect_error: true
+      },
+      {
+        case_no: 4,
+        case_title: 'invalid sort_type "invalid"',
+        articles: [QiitaMatome::Article.new, QiitaMatome::Article.new],
+        sort_type: 'invalid',
+        expect_error: true
+      }
+    ]
+    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::Sort::Sorter.new(c[:articles], c[:sort_type]) }.should raise_error(ArgumentError)
+            next
+          end
+          qss = QiitaMatome::Sort::Sorter.new(c[:articles], c[:sort_type])
+          # -- when --
+          actual_articles = qss.articles
+          actual_sort_type = qss.sort_type
+          # -- then --
+          expect(actual_articles).to eq(c[:articles])
+          expect(actual_sort_type).to eq(c[:sort_type])
+        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 :sort do
+    ARTICLES = [
+      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
+      ),
+      QiitaMatome::Article.new(
+        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(
+        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: 'create date asc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::CREATED_AT_ASC,
+        expected: [
+          QiitaMatome::Article.new(
+            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
+          ),
+          QiitaMatome::Article.new(
+            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(
+            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
+          )
+        ]
+      },
+      {
+        case_no: 2,
+        case_title: 'create date desc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::CREATED_AT_DESC,
+        expected: [
+          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
+          ),
+          QiitaMatome::Article.new(
+            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(
+            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
+          )
+        ]
+      },
+      {
+        case_no: 3,
+        case_title: 'update date asc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::UPDATED_AT_ASC,
+        expected: [
+          QiitaMatome::Article.new(
+            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(
+            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
+          ),
+          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
+          )
+        ]
+      },
+      {
+        case_no: 4,
+        case_title: 'update date desc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::UPDATED_AT_DESC,
+        expected: [
+          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
+          ),
+          QiitaMatome::Article.new(
+            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
+          ),
+          QiitaMatome::Article.new(
+            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
+          )
+        ]
+      },
+      {
+        case_no: 5,
+        case_title: 'title asc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::TITLE_ASC,
+        expected: [
+          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
+          ),
+          QiitaMatome::Article.new(
+            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(
+            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
+          )
+        ]
+      },
+      {
+        case_no: 6,
+        case_title: 'title desc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::TITLE_DESC,
+        expected: [
+          QiitaMatome::Article.new(
+            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
+          ),
+          QiitaMatome::Article.new(
+            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(
+            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
+          )
+        ]
+      },
+      {
+        case_no: 7,
+        case_title: 'stock_count asc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::STOCK_COUNT_ASC,
+        expected: [
+          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
+          ),
+          QiitaMatome::Article.new(
+            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(
+            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
+          )
+        ]
+      },
+      {
+        case_no: 8,
+        case_title: 'stock_count desc',
+        articles: ARTICLES,
+        sort_type: QiitaMatome::Sort::Consts::STOCK_COUNT_DESC,
+        expected: [
+          QiitaMatome::Article.new(
+            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
+          ),
+          QiitaMatome::Article.new(
+            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(
+            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.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+          # -- given --
+          qss = QiitaMatome::Sort::Sorter.new(c[:articles], c[:sort_type])
+          # -- when --
+          qss.sort
+          actual_list = qss.articles
+          # -- then --
+          actual_list.each_with_index do |actual_article, i|
+            expect(actual_article.title).to eq(c[:expected][i].title)
+          end
+        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

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec/'
+end
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end