rcnb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82d4a0468703176185dc596b3e2461063b47409158d69775b4e4691acad53992
-  data.tar.gz: ea815585427f99a094e58447d789b424187677767666d6a49cc6772aabe12ce6
+  metadata.gz: dc00399dbaaa07059d89706fcd1fd3da1879bbb1f9c7705ed2d3f3ae3ad303b8
+  data.tar.gz: cf1e4013967904175450ec6ca403222f513873aaf385c967726d31a218cd5a7e
 SHA512:
-  metadata.gz: e28c283e4c9b445e1f26958739632c8c58ef40e751733813c21af19ad7d206c4dfebaab8b8640addc5363d2837dc8bc36efbc3a4ba0783dbb9e23acdef42b678
-  data.tar.gz: 38e9dd00f4bde23241a7e09483e57d48b51c4ce354f6b9f3a2e7089c7c5874496ed7d9b8c31e572c7e9c21d4861115802fb95f9fcdf97b3c1a41a64c12796304
+  metadata.gz: f32bec5c338eeed5aea9bb335d9c89525d115224462a6aa2929ae617596907eabb99b0d020d0f1958aa682ce67d46399bfefec6c14743e19589913fbd5a8f75a
+  data.tar.gz: 39fb82d34ee859285180a5732047e2bed6f380209fd63512cd56489f9cc8ddcca25084cd0262be800c55250cb5b40df15a70f53650fc83bc97af4f3a2daa45f8

data/README.md

@@ -1,3 +1,43 @@
 # rcnb.rb
 
-A ruby implementation of RCNB
+[![gem_shield](https://img.shields.io/gem/v/rcnb?color=%23fa0000)](https://rubygems.org/gems/rcnb)
+
+A ruby implementation of [RCNB](https://github.com/rcnbapp/RCNB.js)
+
+### Install
+
+```bash
+gem install rcnb
+```
+
+### Usage
+**Basic**
+```ruby
+require 'rcnb'
+
+RCNB.encode('Who NB?')
+# => ȐȼŃƅȓčƞÞƦȻƝƃŖć
+RCNB.decode('ȐĉņþƦȻƝƃŔć')
+# => RCNB!
+```
+
+**String Enhancement**
+
+```ruby
+require 'rcnb/str'
+using RCNB::Str
+ 
+'Who NB?'.rcnb
+# => ȐȼŃƅȓčƞÞƦȻƝƃŖć
+'ȐĉņþƦȻƝƃŔć'.rcnb_decode
+# => RCNB!
+'ȐĉņþƦȻƝƃŔć'.rcnb?
+# => RCNB!
+'not rcnb'.rcnb?
+# => nil
+```
+
+### Reference
+
+[RCNB.js](https://github.com/rcnbapp/RCNB.js)   
+[RCNB.py](https://github.com/chr233/RCNB.python)

data/lib/rcnb.rb

@@ -1,23 +1,28 @@
 
-# = rcnb
+# # rcnb
 # A ruby implementation of RCNB
 # ---
 
 # RCNB模块
 # 
-# == Example
-#   require 'rcnb'
-#   
-#   RCNB.encode('Who NB?')
-#   => ȐȼŃƅȓčƞÞƦȻƝƃŖć
-#   
-#   RCNB.decode('ȐĉņþƦȻƝƃŔć')
-#   => RCNB!
+# ## Example
+# ```ruby
+# require 'rcnb'
+# 
+# RCNB.encode('Who NB?')
+# # => ȐȼŃƅȓčƞÞƦȻƝƃŖć
+# RCNB.decode('ȐĉņþƦȻƝƃŔć')
+# # => RCNB!
+# ```
 module RCNB
+  # @private
   # :stopdoc:
   CR=:rRŔŕŖŗŘřƦȐȑȒȓɌɍ
+  # @private
   CC=:cCĆćĈĉĊċČčƇƈÇȻȼ
+  # @private
   CN=:nNŃńŅņŇňƝƞÑǸǹȠȵ
+  # @private
   CB=:bBƀƁƃƄƅßÞþ
 
   def self.getIndexHash(s)
@@ -26,20 +31,32 @@ module RCNB
   end
 
   private_class_method :getIndexHash
+  # @private
   IR=getIndexHash(CR)
+  # @private
   IC=getIndexHash(CC)
+  # @private
   IN=getIndexHash(CN)
+  # @private
   IB=getIndexHash(CB)
 
+  # @private
   SR=CR.size
+  # @private
   SC=CC.size
+  # @private
   SN=CN.size
+  # @private
   SB=CB.size
 
+  # @private
   SRC=SR*SC
+  # @private
   SNB=SN*SB
+  # @private
   SCNB=SC*SNB
   # :startdoc:
+
   def self.encodeByte(i)
     raise ArgumentError,'rc/nb overflow' if i>0xFF
     if i>0x7F
@@ -107,10 +124,9 @@ module RCNB
   # end
 
   # 将文本编码为RCNB密文
-  # [str] 文本
-  # [encoding] 文本编码
-  # ---
-  # [return] 密文
+  # @param str [String] 文本
+  # @param encoding 文本编码
+  # @return [String] 密文
   def self.encode(str,encoding=nil)
     str=str.encode(encoding) if encoding
     arr=str.unpack('C*')
@@ -124,10 +140,9 @@ module RCNB
   end
 
   # 将RCNB密文解码为文本
-  # [str] 密文
-  # [encoding] 文本编码
-  # ---
-  # [return] 文本
+  # @param str [String] 密文
+  # @param encoding 文本编码
+  # @return [String] 文本
   def self.decode(str,encoding=nil)
     raise ArgumentError,'invalid length' unless (str.size & 1).zero?
     arr=[]

data/lib/rcnb/str.rb

@@ -0,0 +1,68 @@
+require File.expand_path("../../rcnb.rb",__FILE__)
+
+module RCNB
+
+  # 字符串增强
+  # ## Example
+  # ```ruby
+  # require 'rcnb/str'
+  # using RCNB::Str
+  # 
+  # 'Who NB?'.rcnb
+  # # => ȐȼŃƅȓčƞÞƦȻƝƃŖć
+  # 'ȐĉņþƦȻƝƃŔć'.rcnb_decode
+  # # => RCNB!
+  # 'ȐĉņþƦȻƝƃŔć'.rcnb?
+  # # => RCNB!
+  # 'not rcnb'.rcnb?
+  # # => nil
+  # ```
+  # @note 
+  #   使用`using RCNB::Str`来细化String类
+  # @since 0.2.0
+  module Str
+    # @!method rcnb(encoding=nil)
+    #   将字符串编码为RCNB密文
+    #   @!scope instance
+    #   @param encoding 文本编码
+    #   @return [String] 密文
+    #
+    # @!method rcnb_decode(encoding=nil)
+    #   将RCNB密文字符串解码
+    #   @!scope instance
+    #   @param encoding 文本编码
+    #   @return [String] 解码后的文本
+    #
+    # @!method rcnb?(encoding=nil)
+    #   判断字符串是否为RCNB密文
+    #   @!scope instance
+    #   @param encoding 文本编码
+    #   @return [String,nil] 若是RCNB密文，则返回解码结果，否则返回nil
+    refine String do
+      
+      # 将字符串编码为RCNB密文
+      # @param encoding 文本编码
+      def rcnb(encoding=nil)
+        RCNB.encode(self,encoding)
+      end
+
+      # 将RCNB密文字符串解码
+      # @param encoding 文本编码
+      def rcnb_decode(encoding=nil)
+        RCNB.decode(self,encoding)
+      end
+
+      # 判断字符串是否为RCNB密文
+      # @param encoding 文本编码
+      # @return [String,nil] 若是RCNB密文，则返回解码结果，否则返回nil
+      def rcnb?(encoding=nil)
+        begin
+          RCNB.decode(self,encoding)
+        rescue ArgumentError
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/rcnb/version.rb

@@ -1,3 +1,4 @@
 module RCNB
-  VERSION='0.1.0'
+  # @private
+  VERSION='0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcnb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - liggest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -19,6 +19,7 @@ files:
 - LICENSE
 - README.md
 - lib/rcnb.rb
+- lib/rcnb/str.rb
 - lib/rcnb/version.rb
 homepage: https://github.com/liggest/rcnb.rb
 licenses: