qiita_matome 0.0.1

data/lib/file_writer.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+
+module QiitaMatome
+  #  QiitaMatome FileWriter
+  class FileWriter
+    attr_reader :output_file, :contents
+
+    def initialize(output_file, contents)
+      @output_file = output_file
+      @contents = contents
+    end
+
+    def write
+      dir = File.dirname(@output_file)
+      FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+      File.open(@output_file, 'w:UTF-8') { |f|f.print @contents }
+    end
+  end
+end

data/lib/models/article.rb

@@ -0,0 +1,38 @@
+require 'date'
+
+module QiitaMatome
+  # QiitaMatome::Article
+  class Article
+    YMDHMS_DATETIME_FORMAT = '%Y/%m/%d %H:%M:%S'.freeze
+    attr_accessor :user, :title, :uuid, :created_at, :updated_at, :tags, :stock_count # rubocop:disable LineLength
+
+    # rubocop:disable MethodLength
+    def initialize(options = {})
+      @uuid = options['uuid']
+      @user = options['user']
+      @title = options['title']
+      @uuid = options['uuid']
+      c_at = options['created_at']
+      u_at = options['updated_at']
+      @created_at = DateTime.parse(c_at) unless c_at.nil?
+      @updated_at = DateTime.parse(u_at) unless u_at.nil?
+      @tags = options['tags']
+      @stock_count = options['stock_count']
+      yield(self) if block_given?
+    end
+    # rubocop:enable MethodLength
+
+    def created_at_ymdhms
+      @created_at.strftime(YMDHMS_DATETIME_FORMAT)
+    end
+
+    def updated_at_ymdhms
+      @updated_at.strftime(YMDHMS_DATETIME_FORMAT)
+    end
+
+    def title_link
+      url_name = user['url_name']
+      "[#{title.gsub('|', '')}](http://qiita.com/#{url_name}/items/#{uuid})"
+    end
+  end
+end

data/lib/models/articles.rb

@@ -0,0 +1,40 @@
+require 'models/article'
+
+module QiitaMatome
+  # QiitaMatome::Articles
+  class Articles
+    include Enumerable
+    attr_accessor :articles
+
+    def self.exclude_uuid(target_articles, uuids)
+      uuids_list = Array(uuids)
+      target_articles.delete_if { |e|uuids_list.include?(e.uuid) }
+      target_articles
+    end
+
+    def initialize(articles = [])
+      @articles = articles
+    end
+
+    def <<(article)
+      @articles << article
+    end
+
+    def +(other)
+      @articles += other.articles
+      self
+    end
+
+    def size
+      @articles.size
+    end
+
+    def each
+      @articles.each { |article|yield(article) }
+    end
+
+    def filter_by_tag(tag)
+      @articles.select { |e|e.tags.map { |t|t['name'] }.include?(tag) }
+    end
+  end
+end

data/lib/qiita_json_loader.rb

@@ -0,0 +1,43 @@
+require 'open-uri'
+require 'openssl'
+require 'json'
+require 'models/article'
+require 'models/articles'
+
+module QiitaMatome
+  # QiitaMatome::QiitaJsonLoader
+  class QiitaJsonLoader
+    attr_reader :user, :articles
+    QIITA_URL = 'https://qiita.com/api/v1/users/%s/items?page=%s&per_page=%s'
+    PER_PAGE = 25
+    PAGE_LIMIT = 100
+
+    def initialize
+      @articles = Articles.new
+    end
+
+    def load(user)
+      @user = user
+      tmp_verbose = $VERBOSE
+      $VERBOSE = nil
+      OpenSSL::SSL.const_set('VERIFY_PEER', OpenSSL::SSL::VERIFY_NONE)
+      $VERBOSE = tmp_verbose
+      (1..PAGE_LIMIT).each do |page|
+        before_size = @articles.size
+        load_page(user, page)
+        break if before_size == @articles.size
+      end
+    end
+
+    private
+
+    def load_page(user, page)
+      json = open(format(QIITA_URL, user, page, PER_PAGE)).read
+      json_articles = JSON.parser.new(json).parse
+      @articles += json_articles.each_with_object(Articles.new) do |item, memo|
+        memo << Article.new(item)
+        memo
+      end
+    end
+  end
+end

data/lib/qiita_matome/version.rb

@@ -0,0 +1,4 @@
+# QiitaMatome
+module QiitaMatome
+  VERSION = '0.0.1'
+end

data/lib/qiita_matome_core.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+require 'display/displayer'
+require 'file_writer'
+require 'models/article'
+require 'models/articles'
+require 'qiita_json_loader'
+require 'qiita_matome_dsl'
+require 'sort/sorter'
+
+module QiitaMatome
+  #  QiitaMatome Core
+  class Core
+    QIITA_MATOME_FILE = 'Qiitamatomefile'
+
+    # rubocop:disable LineLength
+    QIITA_MATOME_TEMPLATE = <<-EOS
+# 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[String, String ...]
+# String is uuid. For example, 'edbfecb6a6789dd54f47'
+# excludes's default value => []
+excludes []
+    EOS
+    # rubocop:enable LineLength
+
+    # Generate Qiitamatomefile to current directory.
+    def init
+      File.open(QIITA_MATOME_FILE, 'w') { |f|f.puts QIITA_MATOME_TEMPLATE }
+    end
+
+    # Generate QiitaMatome markdown file.
+    def matome
+      dsl = read_dsl
+      articles = read_articles(dsl)
+      excluded_articles = read_excluded_articles(dsl, articles)
+      sorted_articles = read_sorted_articles(dsl, excluded_articles)
+      title = dsl.qiita_matome.title
+      display_columns = dsl.qiita_matome.display_columns
+      markdown = read_markdown(sorted_articles, title, display_columns)
+      output_file = dsl.qiita_matome.output_file
+      fw = QiitaMatome::FileWriter.new(output_file, markdown)
+      fw.write
+    end
+
+    private
+
+    def read_dsl
+      src = File.open(QIITA_MATOME_FILE) { |f|f.read }
+      dsl = QiitaMatome::Dsl.new
+      dsl.instance_eval src
+      dsl
+    end
+
+    def read_articles(dsl)
+      user = dsl.qiita_matome.user
+      qjl = QiitaJsonLoader.new
+      qjl.load(user)
+      qjl.articles
+    end
+
+    def read_excluded_articles(dsl, articles)
+      tag = dsl.qiita_matome.tag
+      filterd_articles = articles.filter_by_tag(tag)
+      uuids = dsl.qiita_matome.excludes
+      Articles.exclude_uuid(filterd_articles, uuids)
+    end
+
+    def read_sorted_articles(dsl, articles)
+      sort_type = dsl.qiita_matome.sort_type
+      sorter = Sort::Sorter.new(articles, sort_type)
+      sorter.sort
+    end
+
+    def read_markdown(articles, title, display_columns)
+      dd = Display::Displayer.new(title, articles, display_columns)
+      display_title = dd.display_title
+      matome_updated = dd.matome_updated
+      table_header = dd.table_header
+      display_articles = dd.display_articles
+      <<-EOS
+#{display_title}
+
+#{matome_updated}
+
+#{table_header}#{display_articles}
+      EOS
+    end
+  end
+end

data/lib/qiita_matome_dsl.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'qiita_matome_dsl_model'
+
+module QiitaMatome
+  # Dsl
+  class Dsl
+    attr_accessor :qiita_matome
+
+    # String Define
+    [:user, :tag, :title, :output_file, :sort_type].each do |f|
+      define_method f do |value|
+        @qiita_matome.send("#{f}=", value)
+      end
+    end
+
+    # Array/Hash/Boolean Define
+    [:display_columns, :excludes].each do |f|
+      define_method f do |value|
+        @qiita_matome.send("#{f}=", value)
+      end
+    end
+
+    def initialize
+      @qiita_matome = QiitaMatome::DslModel.new
+      @qiita_matome.output_file = 'matome.md'
+      @qiita_matome.sort_type = 'created_at_desc'
+      @qiita_matome.display_columns = [:no, :title, :create_date, :stocked]
+      @qiita_matome.excludes = []
+    end
+  end
+end

data/lib/qiita_matome_dsl_model.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'active_model'
+
+module QiitaMatome
+  # DslModel
+  class DslModel
+    include ActiveModel::Model
+
+    # Set your qiita user name
+    attr_accessor :user
+    validates :user, presence: true
+
+    # Set your matome target tag name
+    attr_accessor :tag
+    validates :tag, presence: true
+
+    # Set your matome title
+    attr_accessor :title
+    validates :title, presence: true
+
+    # Set your matome file's output path
+    attr_accessor :output_file
+    validates :output_file, presence: true
+
+    # Set your matome sort type.
+    # you can choose created_at_asc/desc, updated_at_asc/desc,
+    # title_asc/desc, stock_count_asc/desc
+    attr_accessor :sort_type
+
+    # Set your matome display columns.
+    # you can choose :title, :create_date, :update_date, :stocked and :no
+    attr_accessor :display_columns
+
+    # Set your matome exclude files
+    attr_accessor :excludes
+  end
+end

data/lib/sort.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'sort/sorter'
+require 'sort/sort_consts'
+
+module QiitaMatome
+  #  QiitaMatome::Sort
+  module Sort
+  end
+end

data/lib/sort/sort_consts.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module QiitaMatome
+  #  QiitaMatome::Sort
+  module Sort
+    # QiitaMatome::Sort::Consts
+    module Consts
+      CREATED_AT_ASC = 'created_at_asc'.freeze
+      CREATED_AT_DESC = 'created_at_desc'.freeze
+      UPDATED_AT_ASC = 'updated_at_asc'.freeze
+      UPDATED_AT_DESC = 'updated_at_desc'.freeze
+      TITLE_ASC = 'title_asc'.freeze
+      TITLE_DESC = 'title_desc'.freeze
+      STOCK_COUNT_ASC = 'stock_count_asc'.freeze
+      STOCK_COUNT_DESC = 'stock_count_desc'.freeze
+      ALL_TYPES = [
+        CREATED_AT_ASC,
+        CREATED_AT_DESC,
+        UPDATED_AT_ASC,
+        UPDATED_AT_DESC,
+        TITLE_ASC,
+        TITLE_DESC,
+        STOCK_COUNT_ASC,
+        STOCK_COUNT_DESC
+      ]
+    end
+  end
+end

data/lib/sort/sorter.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'sort/sort_consts'
+require 'validators/article_validator'
+require 'validators/articles_validator'
+require 'validators/sort_type_validator'
+
+module QiitaMatome
+  #  QiitaMatome::Sort
+  module Sort
+    # QiitaMatome::Sort::Sorter
+    class Sorter
+      attr_reader :articles, :sort_type
+
+      # rubocop:disable LineLength
+      SORT_PATTERNS = {
+        Consts::CREATED_AT_ASC => { send_method: :sort_asc, sort_key: :created_at },
+        Consts::CREATED_AT_DESC => { send_method: :sort_desc, sort_key: :created_at },
+        Consts::UPDATED_AT_ASC => { send_method: :sort_asc, sort_key: :updated_at },
+        Consts::UPDATED_AT_DESC => { send_method: :sort_desc, sort_key: :updated_at },
+        Consts::TITLE_ASC => { send_method: :sort_asc, sort_key: :title },
+        Consts::TITLE_DESC => { send_method: :sort_desc, sort_key: :title },
+        Consts::STOCK_COUNT_ASC => { send_method: :sort_asc, sort_key: :stock_count },
+        Consts::STOCK_COUNT_DESC => { send_method: :sort_desc, sort_key: :stock_count }
+      }
+      # rubocop:enable LineLength
+
+      def initialize(articles, sort_type = Consts::UPDATED_AT_DESC)
+        Validators::ArticlesValidator.validate(articles)
+        Validators::ArticleValidator.validate(articles)
+        Validators::SortTypeValidator.validate(sort_type)
+        @articles = articles
+        @sort_type = sort_type
+      end
+
+      def sort
+        sort_pattern = SORT_PATTERNS[@sort_type]
+        send(sort_pattern[:send_method], sort_pattern[:sort_key])
+      end
+
+      private
+
+      def sort_asc(asc_key)
+        @articles.sort_by! { |e|e.send(asc_key) }
+      end
+
+      def sort_desc(desc_key)
+        @articles = @articles.sort_by { |e|e.send(desc_key) }.reverse
+      end
+    end
+  end
+end

data/lib/validators.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'validators/article_validator'
+require 'validators/articles_validator'
+require 'validators/display_columns_validator'
+require 'validators/sort_type_validator'
+require 'validators/sort_type_validator'
+
+module QiitaMatome
+  #  QiitaMatome::Validators
+  module Validators
+  end
+end