yol_common 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec20ea2bc4315db90f207d91f183f9ed950166605ba547405716168f3f544d1a
-  data.tar.gz: 9731a41f9b1cb097c098d9c694d8d191a2b7b2d2995606998c6dac1d935d32ab
+  metadata.gz: 5f28f76dbd341a2dd3faad34d72370644ee5968a21139f4c30a6225a8b773e99
+  data.tar.gz: b08003df88f1a7bfb632031ca53658d86e5971ce7b2c4542574a086b47a698e7
 SHA512:
-  metadata.gz: 7bccd16b584d70f285d29e6073cba494bfcf371e7e2d22ed2c75ea6d067b1f37502fccfb87dd7000cdd09e73a378f5fc469a9da7ef37cd68fa8ef31e8eff1cc4
-  data.tar.gz: c69102883e0ed3a007e6d3443505b14d434c2d8a61760eee30c70452ed3372d9b0760b133ce98d0c77c8344a490e9e510fbcc965c63d9784ca33c409b76d3aee
+  metadata.gz: 3650db3c44f36d164c15423cf35141dbc6de9d500da05d71b1205cf5508e30bafbb09e97f446fc1522b6e9e07faa46bbc2ff21aabb13adb8dccd9f8356536f53
+  data.tar.gz: 1a0386f2619fca1b1839a46aa5eda93121ebd6ebc4ffd223fb32ad2f3c0236d2c9c379a4fb7cd644e7b083e069caffddf30333084b6731874415406fc5018aab

data/.gitignore

@@ -1,15 +1,11 @@
+.idea
+*.gem
 *.rbc
-capybara-*.html
-.rspec
-/db/*.sqlite3
-/db/*.sqlite3-journal
-/db/*.sqlite3-[0-9]*
-/public/system
-/coverage/
-/spec/tmp
-*.orig
-rerun.txt
-pickle-email-*.html
+*.DS_Store
+*.swp
+Gemfile.lock
+GemfileLocal
+GemfileLocal.lock
 
 # Ignore all logfiles and tempfiles.
 /log/*
@@ -65,3 +61,8 @@ yarn-debug.log*
 # Ignore uploaded files in development
 /storage/*
 !/storage/.keep
+
+# Ignore pkg
+/pkg/*
+
+

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    yol_common (0.0.2)
+    yol_common (0.0.3)
       oj
 
 GEM
   remote: https://gems.ruby-china.com/
   specs:
     diff-lcs (1.4.2)
-    oj (3.11.3)
+    oj (3.13.7)
     rake (13.0.3)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)

data/README.md

@@ -1,2 +1,295 @@
-# yol_common
-common_methods
+# YolCommon
+
+项目地址：http://oa.yolanda.hk:8002/server/yol_common
+
+[![Gem Version](https://badge.fury.io/rb/yol_common.svg)](http://badge.fury.io/rb/yol_common)
+
+# 简单介绍
+
+> YolCommon项目(公共方法集成)初衷是抽离公司ruby相关的公用代码块（如：邮箱/手机格式校验，节假日计算，七牛云上传下载等）
+
+其目的/好处主要两点:
+
+```ruby
+一是避免重复造轮问题；二是独智不抵群谋，集体评审优化，让每一个方法都异常精炼（除去杂质,提取精华）！
+```
+
+
+---
+
+
+- [如何使用](#如何使用)
+- - [安装依赖](#安装依赖)
+- - [简单使用](#简单使用)
+- [API文档](#api文档)
+- - [线上文档](#线上文档)
+- - [本地文档](#本地文档)
+- [上传代码](#上传代码)
+- - [目录介绍](#目录介绍)
+- - - [添加依赖](#添加依赖)
+- - - [更新版本](#更新版本)
+- - - [单个方法](#单个方法)
+- - - [系列方法](#系列方法)
+- - - [重写方法](#重写方法)
+- - [命名规则](#命名规则)
+- - - [归类命名](#归类命名)
+- - - [方法命名](#方法命名)
+- - - [常量命名](#常量命名)
+- [上传Gem](#上传Gem)
+
+# 如何使用
+
+##  安装依赖
+
+Add this line to your application's Gemfile:
+
+```ruby
+# http://oa.yolanda.hk:9292为公司内部Gem源
+source "http://oa.yolanda.hk:9292" do
+  gem 'yol_common', '~> 0.0.2'
+end
+```
+
+## 简单使用
+引用模块
+```ruby
+include YolCommon
+```
+使用方法
+```ruby
+# 校验邮箱格式
+Validator.email?("luojie@yolanda.hk")
+=> true
+```
+```ruby
+# 计算量两日期间的工作日
+end_at = Time.now
+begin_at = Time.now - 30.days
+business_days_between(begin_at, end_at)
+=> 22
+```
+# <span id="api文档">API文档</span>
+
+## 线上文档
+
+https://www.rubydoc.info/gems/yol_common/0.0.2
+
+`说明：此地址为测试地址，供大家参考看看效果，正式地址待内部开发`
+
+
+## 本地文档
+
+正式地址开发前，可本地生成api文档，步骤如下：
+
+```cmd
+# 1.本地拉取代码
+  git clone ssh://git@oa.yolanda.hk:22022/server/yol_common.git 
+
+# 2.同步最新代码
+  git pull
+
+# 3.进入lib目录
+  cd yol_common/lib 
+    
+# 4.利用rdoc命令生成文档
+  rdoc
+
+# 5.浏览器打开生成的index.html
+  file: yol_common/lib/doc/index.html
+```
+
+
+
+# 上传代码
+上传代码：指需要把一些新方法上传到yol_common或有更好的算法更新yol_common上的老方法；
+
+##  目录介绍
+
+### 添加依赖
+File: yol_common/yol_common.gemspec
+
+```ruby
+# 新方法依赖的gem需要使用“spec.add_dependency”添加
+Gem::Specification.new do |spec|
+  ...
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+    
+  spec.add_dependency 'oj'
+end
+```
+
+### 更新版本
+File: yolanda/yol_common/lib/yol_common/version.rb
+
+```ruby
+# 每次更新代码，记得手动更新版本号
+# 新版本号发布异常处理：及时删除源：http://oa.yolanda.hk:9292 上对应的版本；
+module YolCommon
+  VERSION = "0.0.2"
+end
+```
+
+### 单个方法
+File: yolanda/yol_common/lib/yol_common/helper.rb
+
+```ruby
+# help.rb为单个方法：非系列的，暂无归类的；
+# 当单个方法积累到一定量，再进行归类处理；
+
+module YolCommon
+
+  # 计算两日期间的工作日
+  ...
+  def business_days_between(date1, date2)
+    ...
+  end
+
+end
+```
+
+### 系列方法
+File: yolanda/yol_common/lib/yol_common/validator.rb
+
+```ruby
+# validator.rb为系列方法：校验器，用于校验一些数据格式；
+
+module YolCommon
+  ...
+  class Validator
+    # 邮箱
+    def self.email?(email)
+    end
+
+    # 手机
+    def self.mobile?(mobile)
+    end
+    ...
+  end
+end
+```
+
+### 重写方法
+File: yolanda/yol_common/lib/yol_common/range.rb
+
+```ruby
+# range.rb为重写基础类Class::Range, 其目的是为了让范围range支持&符号查询交集；
+# 重写前，&可用于 [1, 2] & [2, 3] = [2]
+# 重写后，&也可用于 (1..10) & (5..15)
+
+class Range
+  ...
+  alias_method :&,:intersection
+end
+```
+
+
+## 命名规则
+
+https://ruby-china.org/wiki/coding-style#%E5%91%BD%E5%90%8D
+
+### 归类命名
+
+
+使用CamelCase(駝峰式大小寫)的形式给类和模块命名。
+
+(保持使用缩略首字母大写的方式如 HTTP, RFC, XML)
+
+```ruby
+class SomeClass
+  ...
+end
+
+class SomeXML
+  ...
+end
+```
+
+
+##### 举例 校验器 
+
+直译：Validator
+
+```ruby
+# file: yolanda/yol_common/lib/yol_common/validator.rb
+module YolCommon
+  class Validator
+    ...
+  end
+end
+```
+
+
+##### 举例 七牛云
+
+参考三方文档：https://developer.qiniu.com/kodo/1304/ruby
+
+便于区分添加Yol：YolQiniu
+
+```ruby
+# file: yolanda/yol_common/lib/yol_common/yol_qiniu.rb
+module YolCommon
+  class YolQiniu
+    ...
+  end
+end
+```
+
+
+### 方法命名
+
+snake_case的形式给变量和方法命名
+
+
+```
+:some_symbol
+
+def some_method
+  ...
+end
+```
+
+
+
+mobile?
+
+"?"用于获取布尔型变量true/false
+
+```ruby
+def self.email?(email)
+    return false if email.length <= 3 || email.length >= 255
+    return true if email.to_s =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i rescue nil
+    false
+end
+```
+
+### 常量命名
+
+使用SCREAMING_SNAKE_CASE给常量命名。
+
+
+### 注释格式
+
+```
+  # 计算两日期间的工作日
+  ## @param   [Date] 日期 Thu, 22 Apr 2021
+  ## @return  [Int]  天数 5
+  ## @author  luojie
+  ## @date    2021-03-30
+  def business_days_between(date1, date2)
+    business_days = 0
+    date = date2
+    while date > date1
+     business_days = business_days + 1 unless date.saturday? or date.sunday?
+     date = date - 1.day
+    end
+    business_days
+  end
+```
+
+
+`说明：命名规范等遗漏处大家一起补充`
+
+# 上传Gem
+http://oa.yolanda.hk:9292

data/lib/yol_common/calc.rb

@@ -0,0 +1,28 @@
+module YolCommon
+ 
+	class Calc
+
+	  # 计算不同币别的价格
+	  ## @param   [Int]  total_amount 原始金额
+	  ## @param   [String]  currency_code 币别
+	  ## @param   [Int]  tax_flag 是否含税
+	  ## @return  [Int]  金额 2000
+	  ## @author  luojie
+	  ## @date    2021-09-22
+	  def self.total_amount_by_currency(total_amount, currency_code, tax_flag)
+	    total_amount = total_amount.to_f
+	    case currency_code
+	    when 'PRE007'
+	      # 美元
+	      total_amount =  total_amount * 6.8
+	    when 'PRE003'
+	      # 欧元
+	      total_amount =  total_amount * 8
+	    else
+	    end
+	    total_amount = total_amount/1.13 if tax_flag == 1
+	    total_amount
+	  end
+
+  end
+end

data/lib/yol_common/helper.rb

@@ -2,17 +2,18 @@ require 'cgi'
 require 'oj'
 module YolCommon
 
-  def test(name)
-    name
-  end 
-
   # 重复范围： 支持日期/数字等所有格式
+  ## @param   [Array] 数组 [1..20, 5..25]
+  ## @return  [Array] 数组 [5..20]
+  ## @author  luojie
+  ## @date    2021-03-30
   def duplicate_periods(periods)
+    # periods
     duplicate_periods = []
-    periods.each do |a|
+    periods.each do |a| 
       a_index = periods.index(a)
       temp_periods = periods.clone
-      temp_periods.delete_at(a_index)
+      temp_periods.delete_at(a_index) 
       temp_periods.each do |b|
         result = a & b
         duplicate_periods << result if result
@@ -21,7 +22,11 @@ module YolCommon
     duplicate_periods.uniq
   end
 
-  # 计算量日期间的工作日
+  # 计算两日期间的工作日
+  ## @param   [Date] 日期 Thu, 22 Apr 2021
+  ## @return  [Int]  天数 5
+  ## @author  luojie
+  ## @date    2021-03-30
   def business_days_between(date1, date2)
     business_days = 0
     date = date2

data/lib/yol_common/validator.rb

@@ -2,7 +2,7 @@ require 'uri'
 module YolCommon
  
   MOBILE_REGEX = Regexp.new('palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|webos|amoi|novarra|cdm|alcatel|pocket|iphone|mobileexplorer|mobile|zune')
-
+  
   class Validator
 
     # 手机

data/lib/yol_common/version.rb

@@ -1,3 +1,3 @@
 module YolCommon
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/yol_common.rb

@@ -2,6 +2,7 @@ require "yol_common/version"
 require "yol_common/helper"
 require "yol_common/validator"
 require "yol_common/range"
+require "yol_common/calc"
 
 
 module YolCommon

data/yol_common.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "yol_common"
   spec.version       = YolCommon::VERSION
   spec.authors       = ["luojie2019"]
-  spec.email         = ["luojie@yolanda.hk@yeezon.com"]
+  spec.email         = ["luojie@yolanda.hk"]
   spec.summary       = %q{common helpers}
   spec.description   = %q{private gem}
-  spec.homepage      = "https://github.com/luojie2019/yol_common"
+  spec.homepage      = ""
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yol_common
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - luojie2019
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,26 +68,25 @@ dependencies:
         version: '0'
 description: private gem
 email:
-- luojie@yolanda.hk@yeezon.com
+- luojie@yolanda.hk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/.DS_Store
 - lib/yol_common.rb
+- lib/yol_common/calc.rb
 - lib/yol_common/helper.rb
 - lib/yol_common/range.rb
 - lib/yol_common/validator.rb
 - lib/yol_common/version.rb
 - yol_common.gemspec
-homepage: https://github.com/luojie2019/yol_common
+homepage: ''
 licenses:
 - MIT
 metadata: {}