char_size 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c15bd99804447ed34ade8c76051223166feeec5
-  data.tar.gz: 7149b10a8e4b952272887ab83b306a75e45c6620
+  metadata.gz: deb464d4821edb234ea24d84c4e988eec0406ad1
+  data.tar.gz: 9f8c6ddf01450debbb369e16685802c8509c2ea5
 SHA512:
-  metadata.gz: 1f827beef09e6fde3f5d74a1fa61f31408b7d2b1f329e925265dca04f1b55650d6113ed65ad4090291610c92d22d744bbc816bf0adf520494c6eca924c13214b
-  data.tar.gz: 2117d8af213214aeccc65138bd30b594982f3739cd02ec203810bfee61b8c8e367bdaa0a7b64a81ff9911af50ad40966c35044c4a57ffbb95fee4f00de71e73a
+  metadata.gz: e5800463806ea30caa0520a4d8f63a18920b43ec03dd821751a0bc0969a62fc69c09dd4f5aba335c328c9286668c5f832fb4c63531b232a02caa6679fbf05ebb
+  data.tar.gz: 9f0fe4db8706c3484d97e9f74fc90b6665c4f2f3a4b5934282f404f2a62dccf9cf13656ec2ac32d58326210d5c044e0e92e1f381ec3f4e13b3fe0815b4cd57d0

data/README.md

@@ -1,10 +1,12 @@
 # CharSize
 
+[![Gem Version](https://badge.fury.io/rb/char_size.svg)](http://github.com/haines/char_size/releases)
 [![Build Status](https://travis-ci.org/haines/char_size.svg?branch=master)](https://travis-ci.org/haines/char_size)
 [![Code Climate](https://codeclimate.com/github/haines/char_size/badges/gpa.svg)](https://codeclimate.com/github/haines/char_size)
 
 Find an encoding's minimum and maximum character size.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,15 +17,27 @@ gem "char_size"
 
 And then execute:
 
-    $ bundle
+```console
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install char_size
+```console
+$ gem install char_size
+```
+
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+CharSize.min("UTF-8")    # => 1
+CharSize.max("UTF-8")    # => 6
+CharSize.minmax("UTF-8") # => [1, 6]
+```
+
+Like `Encoding.find`, methods take a string encoding name, or an instance of `Encoding`.
+
 
 ## Development
 
@@ -31,6 +45,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/haines/char_size. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rake/extensiontask"
 require "rake/testtask"
+require "yard"
 
 CLEAN.include "lib/char_size/char_size.bundle"
 
@@ -15,4 +16,6 @@ Rake::TestTask.new :test do |t|
   t.warning = true
 end
 
+YARD::Rake::YardocTask.new
+
 task :default => [:compile, :test]

data/char_size.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rake-compiler", "~> 1.0"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

data/ext/char_size/char_size.c

@@ -6,10 +6,26 @@ static rb_encoding* find_encoding(VALUE encoding_or_name) {
   return encoding;
 }
 
+/*
+ * Gets the minimum character size (in bytes) for an encoding.
+ * @param encoding_or_name [Encoding, String] the encoding or its name
+ * @return [Integer] the minimum character size
+ * @example
+ *   CharSize.min("UTF-8")         # => 1
+ *   CharSize.min(Encoding::UTF_8) # => 1
+ */
 static VALUE min(VALUE class, VALUE encoding_or_name) {
   return INT2NUM(find_encoding(encoding_or_name)->min_enc_len);
 }
 
+/*
+ * Gets the maximum character size (in bytes) for an encoding.
+ * @param encoding_or_name [Encoding, String] the encoding or its name
+ * @return [Integer] the minimum character size
+ * @example
+ *   CharSize.max("UTF-8")         # => 6
+ *   CharSize.max(Encoding::UTF_8) # => 6
+ */
 static VALUE max(VALUE class, VALUE encoding_or_name) {
   return INT2NUM(find_encoding(encoding_or_name)->max_enc_len);
 }

data/lib/char_size/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CharSize
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/char_size.rb

@@ -3,7 +3,15 @@
 require "char_size/char_size"
 require "char_size/version"
 
+# The +CharSize+ module provides functions that return the character size limits
+# of encodings.
 module CharSize
+  # Gets the minimum and maximum character size (in bytes) for an encoding.
+  # @param encoding_or_name [Encoding, String] the encoding or its name
+  # @return [Array<(Integer, Integer)>] the minimum and maximum character size
+  # @example
+  #   CharSize.minmax("UTF-8")         # => [1, 6]
+  #   CharSize.minmax(Encoding::UTF_8) # => [1, 6]
   def self.minmax(encoding_or_name)
     [min(encoding_or_name), max(encoding_or_name)]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: char_size
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Haines
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: 
 email:
 - andrew@haines.org.nz