histock-filter 0.2.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe636cff439c19edee8a99b5d7fd6193ca13ca75c3fbf811477e96fa11ecd78e
-  data.tar.gz: 40449e937af952c0ad38d220a16d9e842a467921898154014fd814e65f875077
+  metadata.gz: 8fe953be3755323081d13bff4178eebb148599d0f88a9faf48aa89b59295cb8b
+  data.tar.gz: d229157e246d008d9818803e234398fd079a17965f444a696dd90fbc574e52df
 SHA512:
-  metadata.gz: 5281ac2c58f71ada2be303b41110d06776d0ccb19ad6b49e67b156ffae19a98fd733fc2471f8c42f95ef61edb4276482478eb9c94b02d2a1190a191aed035383
-  data.tar.gz: b7f3f191f4594a72edeeb5a0dd718a4412918807900987c0af9e5a5be22caea4812992b8f37e2c34f323ea8161f128a1030190ea542990f3cb02a77a1c0f020a
+  metadata.gz: 6e7da0c6963a5b457084088d3295b86cd9c807b34b71f3bed501631e48435e630eac42785d4e7de9066a8de93991f4366ca80384a57cde6650b063c4f462d7ea
+  data.tar.gz: a1038892726671334f9b04cdc3660e10ee73765cef9040c2e8871dab45bef537bb37605aed73636ab21f88be2a3add8a1049eba327a710826a38ab6bc3edd762

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## v1.2.0
+[full changelog](http://github.com/ysato5654/histock-filter/compare/v1.1.0...v1.2.0)
+
+* support new request
+    - company profile
+
+## 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)
 

data/README.md

@@ -4,7 +4,10 @@
 
 # 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
 
@@ -28,29 +31,232 @@ $ gem install histock-filter
 
 ## Usage
 
-### Dividend policy
+### 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"},
-#   {"所屬年度" => "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"},
+#   {
+#     "所屬年度" => "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
+#   },
+#   {},
+#   :
 # ]
 ```
 
-### Financial statements
+##### Quarterly Data
+
+| key | type |
+|-----|------|
+| 年度/季別 | string |
+| 近四季ROE | float |
+| 近四季ROA | float |
 
 ```rb
-histock = Histock::Simplefilter.new
-histock.financial_statements('2330')
+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.price_book_ratio('2330')
 # [
-#   {"年度/月份" => "2020/04", "單月營收" => "96,001,568", "去年同月營收" => "74,693,616", "單月月增率" => "-15.4%", "單月年增率" => "28.5%", "累計營收" => "406,598,784", "去年累計營收" => "293,398,112", "累積年增率" => "38.6%"},
-#   {"年度/月份" => "2020/03", "單月營收" => "113,519,600", "去年同月營收" => "79,721,584", "單月月增率" => "21.5%", "單月年增率" => "42.4%", "累計營收" => "310,597,184", "去年累計營收" => "218,704,496", "累積年增率" => "42%"},
-#   {"年度/月份" => "2020/02", "單月營收" => "93,394,448", "去年同月營收" => "60,889,060", "單月月增率" => "-9.9%", "單月年增率" => "53.4%", "累計營收" => "197,077,600", "去年累計營收" => "138,982,896", "累積年增率" => "41.8%"},
-#   {"年度/月份" => "2020/01", "單月營收" => "103,683,104", "去年同月營收" => "78,093,824", "單月月增率" => "0.3%", "單月年增率" => "32.8%", "累計營收" => "103,683,104", "去年累計營收" => "78,093,824", "累積年增率" => "32.8%"},
-#   {"年度/月份" => "2019/12", "單月營收" => "103,313,104", "去年同月營收" => "89,830,600", "單月月增率" => "-4.2%", "單月年增率" => "15%", "累計營收" => "1,069,985,024", "去年累計營收" => "1,031,473,984", "累積年增率" => "3.7%"}
+#   {
+#     "年度/月份" => "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.2.0'
+    spec.add_runtime_dependency 'histock-simplefilter', '~> 0.6.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,71 @@
 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', 'financial_statements']
+        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
+
+        def company_profile(param)
+            histock = Histock::Simplefilter.new
+            table = histock.send(__method__, param)
+
+            table[0..1].transpose.to_h.merge(table[2..3].transpose.to_h)
+        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.2.0'
+      VERSION = '1.2.0'
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: histock-filter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuya Sato
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2020-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: histock-simplefilter
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.6.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
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.0
-description: 
+description:
 email:
 - ysato.5654@gmail.com
 executables: []
@@ -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:
@@ -107,7 +108,7 @@ metadata:
   homepage_uri: https://github.com/ysato5654/histock-filter
   source_code_uri: https://github.com/ysato5654/histock-filter
   changelog_uri: https://github.com/ysato5654/histock-filter/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,8 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: HiStock (https://histock.tw/) filter
 test_files: []