histock-filter 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 569130bd4a0fb4b411287aaf64663e66dbeb1d611f7e8232bf47ecb3a6409c99
-  data.tar.gz: a7041ef22c8b10cfbb7b673b746488446b71e84fd6c1db80ebb729ed2b331af3
+  metadata.gz: 88873eae7ffb99f849806fa79ab0b4ac67e5bf729f9ed2dff867d3a78f266c6c
+  data.tar.gz: cdb11409acbb672c4545ff8e5af195add6c68acdef301fd8d5e8bbd3fefd6b65
 SHA512:
-  metadata.gz: 2c6172344fc416e8be9a41b970a2fd7cc05957645558159c8d38f52bbfe5822049c53ce0ad196884eb2ae62c3f2945512ebdf439b0684280f02875ec74e971dc
-  data.tar.gz: e4e962073d339ca73803ffa80281d25a95db50b1d226ac569f3f2f9aff821be6c478c8d7c88c20f453646ed0c5866b3eb7d7bbddb165ef01d10b50dc79425af0
+  metadata.gz: 968f1e689116b47e3638f0ec920e7c80d4b53c17334a3593f165f66268c6985af54cf938baa78b84c3bd0bada415f5dff6aff574d75bf9004c33d6b89a27601f
+  data.tar.gz: d0a7c60edb131d9e4701b82bc14429335b94e98eef3af5828667dc617aaf9d1b924cbae91b0eddfbdc23692a61cb3bd6dbe4c0d991abdd0e8b6af9c805143d91

data/.rspec

@@ -1,2 +1,3 @@
+--require spec_helper
 --format documentation
 --color

data/.travis.yml

@@ -4,3 +4,5 @@ cache: bundler
 rvm:
   - 2.5.8
 before_install: gem install bundler -v 2.1.4
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## v1.1.0
+[full changelog](http://github.com/ysato5654/histock-filter/compare/v1.0.0...v1.1.0)
+
+* support new request
+    - price to earning ratio
+    - price book ratio
+
+## v1.0.0
+[full changelog](http://github.com/ysato5654/histock-filter/compare/v0.4.1...v1.0.0)
+
+* change class of output date
+    - String -> Integer / Float
+
+## v0.4.1
+[full changelog](http://github.com/ysato5654/histock-filter/compare/v0.4.0...v0.4.1)
+
+* 'month' option is not supported from this version
+
+## v0.4.0
+[full changelog](http://github.com/ysato5654/histock-filter/compare/v0.2.0...v0.4.0)
+
+* change request name
+    - before: financial statements  
+      after: monthly revenue
+* support new request
+    - profit ratio
+    - income rate
+
+## v0.2.0
+[full changelog](http://github.com/ysato5654/histock-filter/compare/v0.1.0...v0.2.0)
+
+* support new request
+    - financial statements
+
 ## v0.1.0
 
 * first beta release

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in histock-simplefilter.gemspec
 gemspec
+
+group :test do
+    gem 'coveralls', require: false
+end

data/README.md

@@ -1,9 +1,13 @@
 [![Gem Version](https://badge.fury.io/rb/histock-filter.svg)](https://badge.fury.io/rb/histock-filter)
 [![Build Status](https://travis-ci.org/ysato5654/histock-filter.svg?branch=master)](https://travis-ci.org/ysato5654/histock-filter)
+[![Coverage Status](https://coveralls.io/repos/github/ysato5654/histock-filter/badge.svg?branch=master)](https://coveralls.io/github/ysato5654/histock-filter?branch=master)
 
 # Histock::Filter
 
-[HiStock嗨投資理財社群](https://histock.tw/) filter by Ruby
+histock-filter is Ruby library to get the finance data of listed stock on the Taiwan stock exchange market from [HiStock嗨投資理財社群](https://histock.tw/).
+
+If you would like to get more basic data (row data), refer to [histock-simplefilter](https://github.com/ysato5654/histock-simplefilter).
+
 
 ## Installation
 
@@ -27,13 +31,232 @@ $ gem install histock-filter
 
 ## Usage
 
+### Dividend Policy
+
+```rb
+require 'histock/filter'
+
+histock = Histock::Filter.new
+histock.dividend_policy('2330')
+# [
+#   {
+#     "所屬年度" => "2019",
+#     "發放年度" => "2020",
+#     "除權日" => "",
+#     "除息日" => "06/18",
+#     "除權息前股價" => 297.5,
+#     "股票股利" => 0,
+#     "現金股利" => 2.5,
+#     "EPS" => 13.32,
+#     "配息率" => 18.77,
+#     "現金殖利率" => 0.84,
+#     "扣抵稅率" => 0.00,
+#     "增資配股率" => 0,
+#     "增資認購價" => 0
+#   },
+#   {},
+#   :
+# ]
+```
+
+### Basic Financial Statements
+
+#### Monthly Revenue
+
+| key | type |
+|-----|------|
+| 年度/月份 | string |
+| 單月營收 | integer |
+| 去年同月營收 | integer |
+| 單月月增率 | float |
+| 單月年增率 | float |
+| 累計營收 | integer |
+| 去年累計營收 | integer |
+| 累積年增率 | float |
+
+```rb
+require 'histock/filter'
+
+histock = Histock::Filter.new
+histock.monthly_revenue('2330')
+# [
+#   {
+#     "年度/月份" => "2020/04",
+#     "單月營收" => 96001568,
+#     "去年同月營收" => 74693616,
+#     "單月月增率" => -15.4,
+#     "單月年增率" => 28.5,
+#     "累計營收" => 406598784,
+#     "去年累計營收" => 293398112,
+#     "累積年增率" => 38.6
+#   },
+#   {},
+#   :
+# ]
+```
+
+#### Income Statement
+
+| key | type |
+|-----|------|
+| 年度/季別 | string |
+| 營收 | integer |
+| 毛利 | integer |
+| 營業利益 | integer |
+| 稅前淨利 | integer |
+| 稅後淨利 | integer |
+
+```rb
+histock = Histock::Filter.new
+histock.income_statement('2330')
+# [
+#   {
+#     "年度/季別"" => "2019Q4",
+#     "營收" => 317237065,
+#     "毛利" => 159240985,
+#     "營業利益" => 124243722,
+#     "稅前淨利" => 128781973,
+#     "稅後淨利" => 116078194
+#   },
+#   {},
+#   :
+# ]
+```
+
+### Profitability
+
+#### Profit Ratio
+
+| key | type |
+|-----|------|
+| 年度/季別 | string |
+| 毛利率 | float |
+| 營業利益率 | float |
+| 稅前淨利率 | float |
+| 稅後淨利率 | float |
+
+```rb
+histock = Histock::Filter.new
+histock.profit_ratio('2330')
+# [
+#   {
+#     "年度/季別" => "2019Q4",
+#     "毛利率" => 50.20,
+#     "營業利益率" => 39.16,
+#     "稅前淨利率" => 40.59,
+#     "稅後淨利率" => 36.59
+#   },
+#   {},
+#   :
+# ]
+```
+
+#### Income Rate
+
+##### Monthly Data
+
+| key | type |
+|-----|------|
+| 年度/季別 | string |
+| ROE | float |
+| ROA | float |
+
+```rb
+histock = Histock::Filter.new
+histock.income_rate('2330', 'month')
+# [
+#   {
+#     "年度/季別" => "2020Q1",
+#     "ROE" => 7.10,
+#     "ROA" => 5.08
+#   },
+#   {},
+#   :
+# ]
+```
+
+##### Quarterly Data
+
+| key | type |
+|-----|------|
+| 年度/季別 | string |
+| 近四季ROE | float |
+| 近四季ROA | float |
+
+```rb
+histock = Histock::Filter.new
+histock.income_rate('2330', 'quarter')
+# [
+#   {
+#     "年度/季別" => "2020Q1",
+#     "近四季ROE" => 23.45,
+#     "近四季ROA" => 17.70
+#   },
+#   {},
+#   :
+# ]
+```
+
+##### Yearly Data
+
+| key | type |
+|-----|------|
+| 年度 | string |
+| 年度ROE | float |
+| 年度ROA | float |
+
+```rb
+histock = Histock::Filter.new
+histock.income_rate('2330', 'year')
+# [
+#   {
+#     "年度" => "2019",
+#     "年度ROE" => 20.93,
+#     "年度ROA" => 15.86
+#   },
+#   {},
+#   :
+# ]
+```
+
+### Corporate Value
+
+#### PER
+
+| key | type |
+|-----|------|
+| 年度/月份 | string |
+| 本益比 | float |
+
+```rb
+histock = Histock::Filter.new
+histock.price_to_earning_ratio('2330')
+# [
+#   {
+#     "年度/月份" => "2020/06",
+#     "本益比" => 20.44
+#   },
+#   {},
+#   :
+# ]
+```
+
+#### PBR
+
+| key | type |
+|-----|------|
+| 年度/月份 | string |
+| 股價淨值比 | float |
+
 ```rb
 histock = Histock::Filter.new
-histock.dividend_policy('1234')
+histock.price_book_ratio('2330')
 # [
-#   {"所屬年度" => "2019", "發放年度" => "2020", "除權日" => "", "除息日" => "06/18", "除權息前股價" => "297.5", "股票股利" => "0", "現金股利" => "2.5", EPS" => "13.32", "配息率" => "18.77%", "現金殖利率" => "0.84%", "扣抵稅率" => "0.00%", "增資配股率" => "0", "增資認購價" => "0"},
-#   {"所屬年度" => "2019", "發放年度" => "2020", "除權日" => "", "除息日" => "03/19", "除權息前股價" => "260", "股票股利" => "0", "現金股利" => "2.5", "EPS" => "13.32", "配息率" => "18.77%", "現金殖利率" => "0.96%", "扣抵稅率" => "0.00%", "增資配股率" => "0", "增資認購價" => "0"},
-#   {"所屬年度" => "2018", "發放年度" => "2019", "除權日" => "", "除息日" => "12/19", "除權息前股價" => "344.5", "股票股利" => "0", "現金股利" => "2.5", "EPS" => "13.54", "配息率" => "18.46%", "現金殖利率" => "0.73%", "扣抵稅率" => "0.00%", "增資配股率" => "0", "增資認購價" => "0"},
-#   {"所屬年度" => "2018", "發放年度" => "2019", "除權日" => "", "除息日" => "09/19", "除權息前股價" => "267", "股票股利" => "0", "現金股利" => "2", "EPS" => "13.54", "配息率" => "14.77%", "現金殖利率" => "0.75%", "扣抵稅率" => "0.00%", "增資配股率" => "0", "增資認購價" => "0"},
+#   {
+#     "年度/月份" => "2020/06",
+#     "股價淨值比" => 4.89
+#   },
+#   {},
+#   :
 # ]
 ```

data/histock-filter.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |spec|
 
     spec.required_ruby_version = '~> 2.5'
 
-    spec.add_runtime_dependency 'histock-simplefilter', '= 0.1.2'
+    spec.add_runtime_dependency 'histock-simplefilter', '~> 0.5.0'
 
     spec.add_development_dependency 'bundler', '~> 2.0'
-    spec.add_development_dependency 'rake', '>= 12.3.3'
+    spec.add_development_dependency 'rake', '~> 13.0'
     spec.add_development_dependency 'rspec', '~> 3.0'
     spec.add_development_dependency 'travis', '>= 1.9.0'
 end

data/lib/histock/filter.rb

@@ -1,20 +1,64 @@
 require 'histock/simplefilter'
 require File.expand_path(File.dirname(__FILE__)) + '/filter/version'
+require File.expand_path(File.dirname(__FILE__)) + '/filter/helper'
 
 module Histock
     class Filter
-        CONFIG = ['dividend_policy']
+        CONFIG = [
+            # one argument
+            [
+                'monthly_revenue',
+                'income_statement',
+                'dividend_policy',
+                'profit_ratio',
+                'price_to_earning_ratio',
+                'price_book_ratio'
+            ],
+            # two arguments
+            [
+                'income_rate'
+            ]
+        ]
 
         def initialize
         end
 
-        CONFIG.each do |method_name|
+        CONFIG.first.each do |method_name|
             define_method method_name do |param|
                 histock = Histock::Simplefilter.new
                 table = histock.send(method_name, param)
 
-                table[1..-1].map { |e| table.first.zip(e).to_h }
+                parse(table)
             end
         end
+
+        CONFIG.last.each do |method_name|
+            define_method method_name do |param, param2|
+                histock = Histock::Simplefilter.new
+                table = histock.send(method_name, param, param2)
+
+                parse(table)
+            end
+        end
+
+        private
+
+        def parse(table)
+            list = table[1..-1].map { |e| table.first.zip(e).to_h }
+
+            list.each do |hash|
+                hash.each do |key, val|
+                    if Histock::Helper.is_persentage?(val)
+                        hash[key] = Histock::Helper.persentage_to_number(val)
+                    elsif Histock::Helper.is_currency?(val)
+                        hash[key] = Histock::Helper.currency_to_number(val)
+                    elsif Histock::Helper.is_float?(val)
+                        hash[key] = val.to_f
+                    end
+                end
+            end
+
+            list
+        end
     end
 end

data/lib/histock/filter/helper.rb

@@ -0,0 +1,27 @@
+module Histock
+    class Helper
+        class << self
+            def is_persentage?(str)
+                str.match(/^[+-]?([0-9]+(\.[0-9]*)?|\.[0-9]+)%$/).nil? ? false : true
+            end
+
+            def is_currency?(str)
+                str.match(/^[+-]?\d{1,3}(,\d{3})*$/).nil? ? false : true
+            end
+
+            def is_float?(str)
+                str.match(/^[+-]?([0-9]+(\.[0-9]*)?|\.[0-9]+)$/).nil? ? false : true
+            end
+
+            # should check str by 'is_persentage?' method before calling this method
+            def persentage_to_number(str)
+                str.to_s.gsub(/%/,'').to_f
+            end
+
+            # should check str by 'is_currency?' method before calling this method
+            def currency_to_number(str)
+                str.to_s.gsub(/[$,]/,'').to_i
+            end
+        end
+    end
+end

data/lib/histock/filter/version.rb

@@ -1,5 +1,5 @@
 module Histock
     class Filter
-      VERSION = '0.1.0'
+      VERSION = '1.1.0'
     end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: histock-filter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuya Sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: histock-simplefilter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
 - bin/setup
 - histock-filter.gemspec
 - lib/histock/filter.rb
+- lib/histock/filter/helper.rb
 - lib/histock/filter/version.rb
 homepage: https://github.com/ysato5654/histock-filter
 licenses:
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: HiStock (https://histock.tw/) filter